diff --git a/.all-contributorsrc b/.all-contributorsrc index ced3b155b..a2d13c2fc 100644 --- a/.all-contributorsrc +++ b/.all-contributorsrc @@ -1,6 +1,7 @@ { "files": [ - "website/src/pages/credits.mdx" + "website/src/pages/credits.mdx", + "docs/src/assets/contributors.html" ], "imageSize": 75, "commit": false, diff --git a/.beads/issues.jsonl b/.beads/issues.jsonl new file mode 100644 index 000000000..67f7a6830 --- /dev/null +++ b/.beads/issues.jsonl @@ -0,0 +1,55 @@ +{"id":"wails-webview2gtk6-0mc","title":"GTK4: Drag and drop not working - needs manual testing","description":"Native file drag-and-drop from file managers works in GTK3 but NOT in GTK4.\n\n**Symptoms:**\n- Dragging files onto GTK4 app causes WebKit to open file like a browser\n- GtkDropTarget signals (enter, leave, motion, drop) never fire\n- Debug logging shows no [DND-GTK4] messages during drag operations\n\n**Investigation Done:**\n- Added GtkDropControllerMotion with GTK_PHASE_CAPTURE for motion tracking\n- Added GtkDropTarget with GTK_PHASE_CAPTURE and accept handler for file drops\n- Both controllers added to WebKitWebView\n- WebKitGTK uses GtkDropTargetAsync internally in bubble phase\n\n**Key Finding:**\n- WebKitGTK 2.50.3 disabled file access (CVE-2025-13947) but this should not affect native GTK drops\n- Capture phase should run before WebKit's bubble phase handlers\n\n**Files Modified:**\n- v3/pkg/application/linux_cgo_gtk4.c - DND handlers with debug logging\n- v3/pkg/application/linux_cgo_gtk4.go - enableDND/disableDND\n\n**Testing Required:**\n1. Build: cd v3/examples/drag-n-drop \u0026\u0026 go build -a -o drag-n-drop-gtk4 .\n2. Run: ./drag-n-drop-gtk4\n3. Drag file from file manager to window\n4. Watch for [DND-GTK4] messages in console\n\n**If DropControllerMotion fires but GtkDropTarget doesn't:**\n- WebKit intercepts at lower level, may need GtkDropTargetAsync approach\n\n**If nothing fires:**\n- Issue with controller attachment to WebKitWebView","status":"closed","priority":1,"issue_type":"bug","created_at":"2026-01-08T15:26:58.12691099+11:00","updated_at":"2026-01-08T15:50:34.104083842+11:00","closed_at":"2026-01-08T15:50:34.104083842+11:00","close_reason":"Fixed - implemented GtkDropControllerMotion + GtkDropTarget with GTK_PHASE_CAPTURE"} +{"id":"wails-webview2gtk6-588","title":"doctor-ng: New TUI doctor package","description":"","status":"closed","priority":1,"issue_type":"feature","created_at":"2026-01-06T15:53:57.74361022+11:00","updated_at":"2026-01-06T15:54:05.035250923+11:00","closed_at":"2026-01-06T15:54:05.035250923+11:00","close_reason":"Implemented: pkg/doctor-ng with modern bubbletea TUI, public API for GUI reuse, CLI command wails3 doctor-ng"} +{"id":"wails-webview2gtk6-95s","title":"Window not found warning on application quit","description":"When quitting a systray application, a warning is logged: 'Window #1 not found'. This happens during cleanup when trying to access windows that have already been destroyed.\n\nReproduction:\n1. Run any systray test (e.g., custom-handlers-gtk4)\n2. Use the menu to quit\n3. Observe warning in console\n\nExpected: Clean shutdown without warnings\nActual: WRN Window #1 not found","status":"open","priority":2,"issue_type":"bug","created_at":"2026-01-06T14:35:05.897126324+11:00","updated_at":"2026-01-06T14:35:05.897126324+11:00"} +{"id":"wails-webview2gtk6-e8m","title":"Cursor warps to window center on second systray click (Hyprland)","description":"On Hyprland, when using window-menu systray configuration:\n\n1. Click systray icon -\u003e window shows, cursor stays in place\n2. Click systray icon again -\u003e window hides then shows, cursor warps to window center\n\nThis only happens when toggling via systray icon click. Using menu 'Show Window' doesn't cause the warp.\n\nLikely related to PositionWindow() interaction with Hyprland's focus handling.\n\nEnvironment: Hyprland, GTK4\nPriority: Low (cosmetic issue)","status":"open","priority":3,"issue_type":"bug","created_at":"2026-01-06T14:49:45.489579343+11:00","updated_at":"2026-01-06T14:49:45.489579343+11:00"} +{"id":"wails-webview2gtk6-m4c","title":"Systray API v2: Refactor for cleaner separation of concerns","description":"Redesign systray API for cleaner separation of concerns:\n\n## Core Principles\n1. Registration separate from behavior - AttachWindow/SetMenu only register resources\n2. Smart defaults with explicit overrides - Works out of the box, customizable when needed\n3. Window behavior belongs on window - HideOnFocusLost, HideOnEscape are window options\n4. Platform differences handled internally - User expresses intent, implementation adapts\n\n## Smart Defaults\n| Configuration | Left-Click | Right-Click |\n|--------------|------------|-------------|\n| Window only | ToggleWindow | Nothing |\n| Menu only | Nothing | ShowMenu |\n| Window + Menu | ToggleWindow | ShowMenu |\n\n## Scope\n- Window options: HideOnFocusLost, HideOnEscape\n- Systray smart defaults\n- GTK3 \u0026 GTK4 compatibility\n- Documentation, tests, examples","status":"closed","priority":1,"issue_type":"epic","created_at":"2026-01-06T12:41:49.962413423+11:00","updated_at":"2026-01-06T15:33:03.609804696+11:00","closed_at":"2026-01-06T15:33:03.609804696+11:00","close_reason":"All implementation tasks complete. Systray API v2 implemented with smart defaults, HideOnEscape, HideOnFocusLost, and comprehensive manual tests. GTK3/GTK4 verified."} +{"id":"wails-webview2gtk6-m4c.1","title":"Add HideOnFocusLost window option","description":"Add HideOnFocusLost option to WebviewWindowOptions.\n\nFiles to modify:\n- webview_window_options.go: Add HideOnFocusLost bool field\n- webview_window.go: Implement focus-lost handler in setupBehaviorOptions()\n- linux_cgo.go: GTK3 focus-lost signal (focus-out-event)\n- linux_cgo_gtk4.go: GTK4 focus-lost signal (notify::is-active)\n- webview_window_darwin.go: macOS focus-lost handling\n- webview_window_windows.go: Windows focus-lost handling\n\nPlatform behavior:\n- Standard WMs: Hide on focus lost\n- Focus-follows-mouse WMs (Hyprland, Sway, i3): Silently disabled\n\nImplementation:\nif options.HideOnFocusLost {\n if runtime.GOOS == \"linux\" \u0026\u0026 isFocusFollowsMouse() {\n return // Skip - would cause immediate hide\n }\n w.OnWindowEvent(events.Common.WindowLostFocus, func(e *WindowEvent) {\n w.Hide()\n })\n}","status":"closed","priority":1,"issue_type":"task","created_at":"2026-01-06T12:42:15.123041365+11:00","updated_at":"2026-01-06T13:02:45.845914238+11:00","closed_at":"2026-01-06T13:02:45.845914238+11:00","close_reason":"Implemented HideOnFocusLost option","dependencies":[{"issue_id":"wails-webview2gtk6-m4c.1","depends_on_id":"wails-webview2gtk6-m4c","type":"parent-child","created_at":"2026-01-06T12:42:15.128286221+11:00","created_by":"daemon"}]} +{"id":"wails-webview2gtk6-m4c.2","title":"Add HideOnEscape window option","description":"Add HideOnEscape option to WebviewWindowOptions.\n\nFiles to modify:\n- webview_window_options.go: Add HideOnEscape bool field\n- webview_window.go: Register Escape keybinding in setupBehaviorOptions()\n\nImplementation:\nif options.HideOnEscape {\n w.registerKeyBinding(\"escape\", func() {\n w.Hide()\n })\n}\n\nNotes:\n- Should work on all platforms (GTK3, GTK4, macOS, Windows)\n- Uses existing keybinding infrastructure","status":"closed","priority":1,"issue_type":"task","created_at":"2026-01-06T12:42:23.973789683+11:00","updated_at":"2026-01-06T13:02:46.561848535+11:00","closed_at":"2026-01-06T13:02:46.561848535+11:00","close_reason":"Implemented HideOnEscape option","dependencies":[{"issue_id":"wails-webview2gtk6-m4c.2","depends_on_id":"wails-webview2gtk6-m4c","type":"parent-child","created_at":"2026-01-06T12:42:23.978484152+11:00","created_by":"daemon"}]} +{"id":"wails-webview2gtk6-m4c.3","title":"Implement systray smart defaults","description":"Implement smart defaults for systray click behavior.\n\nSmart Defaults:\n| Configuration | Left-Click | Right-Click |\n|--------------|------------|-------------|\n| Window only | ToggleWindow | Nothing |\n| Menu only | Nothing | ShowMenu |\n| Window + Menu | ToggleWindow | ShowMenu |\n| Neither | Nothing | Nothing |\n\nFiles to modify:\n- systemtray.go: Add applySmartDefaults() method, call from Run()\n\nImplementation:\nfunc (s *SystemTray) applySmartDefaults() {\n hasWindow := s.attachedWindow.Window != nil\n hasMenu := s.menu != nil\n \n if s.clickHandler == nil {\n if hasWindow {\n s.clickHandler = s.ToggleWindow\n }\n }\n \n if s.rightClickHandler == nil {\n if hasMenu {\n s.rightClickHandler = s.ShowMenu\n }\n }\n}\n\nUser-specified OnLeftClick/OnRightClick handlers override these defaults.","status":"closed","priority":1,"issue_type":"task","created_at":"2026-01-06T12:42:34.796175422+11:00","updated_at":"2026-01-06T13:02:47.607457075+11:00","closed_at":"2026-01-06T13:02:47.607457075+11:00","close_reason":"Implemented smart defaults in applySmartDefaults()","dependencies":[{"issue_id":"wails-webview2gtk6-m4c.3","depends_on_id":"wails-webview2gtk6-m4c","type":"parent-child","created_at":"2026-01-06T12:42:34.801495751+11:00","created_by":"daemon"}]} +{"id":"wails-webview2gtk6-m4c.4","title":"Fix Linux systray Activate/SecondaryActivate handlers","description":"Fix Linux systray DBus handlers to call correct click handlers.\n\nCurrent issues:\n- Activate calls doubleClickHandler instead of clickHandler\n- ItemIsMenu is always true, causing host to intercept left-click\n- Menu property registered even when no menu\n\nFiles to modify:\n- systemtray_linux.go\n\nChanges:\n1. Activate() should call s.parent.clickHandler (not doubleClickHandler)\n2. SecondaryActivate() should call s.parent.rightClickHandler\n3. ItemIsMenu = false when window attached (let our code handle clicks)\n4. Only register Menu property when s.menu != nil\n\nImplementation already partially done in this session - verify and clean up.","status":"closed","priority":1,"issue_type":"task","created_at":"2026-01-06T12:42:47.726574187+11:00","updated_at":"2026-01-06T13:02:48.48112849+11:00","closed_at":"2026-01-06T13:02:48.48112849+11:00","close_reason":"Fixed Activate/SecondaryActivate handlers","dependencies":[{"issue_id":"wails-webview2gtk6-m4c.4","depends_on_id":"wails-webview2gtk6-m4c","type":"parent-child","created_at":"2026-01-06T12:42:47.731830675+11:00","created_by":"daemon"}]} +{"id":"wails-webview2gtk6-m4c.5","title":"Add systray API v2 unit tests","description":"Add unit tests for new systray behavior.\n\nTest cases:\n- TestSystraySmartDefaults_WindowOnly: Left=toggle, Right=nothing\n- TestSystraySmartDefaults_MenuOnly: Left=nothing, Right=menu\n- TestSystraySmartDefaults_WindowAndMenu: Left=toggle, Right=menu\n- TestSystraySmartDefaults_Neither: Left=nothing, Right=nothing\n- TestSystrayOverride_LeftClick: Custom handler overrides default\n- TestSystrayOverride_RightClick: Custom handler overrides default\n- TestWindowOption_HideOnFocusLost: Window hides on focus lost\n- TestWindowOption_HideOnEscape: Window hides on Escape\n- TestWindowOption_FocusFollowsMouse: HideOnFocusLost disabled on tiling WMs\n\nFiles:\n- systemtray_test.go\n- webview_window_test.go","status":"open","priority":2,"issue_type":"task","created_at":"2026-01-06T12:42:58.128530198+11:00","updated_at":"2026-01-06T12:42:58.128530198+11:00","dependencies":[{"issue_id":"wails-webview2gtk6-m4c.5","depends_on_id":"wails-webview2gtk6-m4c","type":"parent-child","created_at":"2026-01-06T12:42:58.133914168+11:00","created_by":"daemon"}]} +{"id":"wails-webview2gtk6-m4c.6","title":"Update systray documentation","description":"Update documentation for new systray API.\n\nFiles to update:\n- mkdocs-website/docs/learn/systray.md: Full rewrite\n- mkdocs-website/docs/learn/windows.md: Document HideOnFocusLost, HideOnEscape\n- mkdocs-website/docs/api/systray.md: API reference\n\nDocumentation structure:\n1. Basic Usage\n - Window-based systray (popup)\n - Menu-based systray\n - Window + Menu\n2. Smart Defaults explanation\n3. Customizing Behavior\n - OnLeftClick/OnRightClick overrides\n4. Window auto-hide options\n - HideOnFocusLost\n - HideOnEscape\n - Platform considerations (focus-follows-mouse)\n5. Platform Notes (Linux, macOS, Windows)","status":"open","priority":2,"issue_type":"task","created_at":"2026-01-06T12:43:08.693794811+11:00","updated_at":"2026-01-06T12:43:08.693794811+11:00","dependencies":[{"issue_id":"wails-webview2gtk6-m4c.6","depends_on_id":"wails-webview2gtk6-m4c","type":"parent-child","created_at":"2026-01-06T12:43:08.699255848+11:00","created_by":"daemon"}]} +{"id":"wails-webview2gtk6-m4c.7","title":"Update systray examples","description":"Update and create systray examples.\n\nUpdate:\n- examples/systray-basic/main.go: Show HideOnFocusLost, HideOnEscape options\n\nCreate:\n- examples/systray-menu/main.go: Menu-only example\n- examples/systray-window-menu/main.go: Window + Menu example\n\nEach example should demonstrate:\n- Minimal setup\n- Smart defaults in action\n- How to customize if needed\n\nExample for systray-basic:\nwindow := app.NewWindow(WebviewWindowOptions{\n Hidden: true,\n Frameless: true,\n AlwaysOnTop: true,\n HideOnFocusLost: true, // NEW\n HideOnEscape: true, // NEW\n})\nsystray.AttachWindow(window)","status":"closed","priority":2,"issue_type":"task","created_at":"2026-01-06T12:43:19.315995474+11:00","updated_at":"2026-01-06T13:02:49.08857561+11:00","closed_at":"2026-01-06T13:02:49.08857561+11:00","close_reason":"Updated systray-basic example","dependencies":[{"issue_id":"wails-webview2gtk6-m4c.7","depends_on_id":"wails-webview2gtk6-m4c","type":"parent-child","created_at":"2026-01-06T12:43:19.323424534+11:00","created_by":"daemon"}]} +{"id":"wails-webview2gtk6-m4c.8","title":"Verify GTK3 and GTK4 compatibility","description":"Verify all systray changes work on both GTK3 and GTK4.\n\nTest matrix:\n| Feature | GTK3 | GTK4 |\n|---------|------|------|\n| Left-click toggle window | Test | Test |\n| Right-click show menu | Test | Test |\n| HideOnFocusLost | Test | Test |\n| HideOnEscape | Test | Test |\n| ItemIsMenu property | Test | Test |\n| Menu property conditional | Test | Test |\n\nBuild commands:\n- GTK4: go build ./pkg/application/...\n- GTK3: go build -tags gtk3 ./pkg/application/...\n\nTest on:\n- Hyprland (tiling, focus-follows-mouse)\n- GNOME (standard WM)\n\nDocument any GTK3/GTK4 differences in behavior.","status":"closed","priority":1,"issue_type":"task","created_at":"2026-01-06T12:43:30.274572191+11:00","updated_at":"2026-01-06T15:32:18.160668676+11:00","closed_at":"2026-01-06T15:32:18.160668676+11:00","close_reason":"Verified GTK3/GTK4 compatibility - all tests pass","dependencies":[{"issue_id":"wails-webview2gtk6-m4c.8","depends_on_id":"wails-webview2gtk6-m4c","type":"parent-child","created_at":"2026-01-06T12:43:30.279370657+11:00","created_by":"daemon"}]} +{"id":"wails-webview2gtk6-m4c.9","title":"Clean up current session systray changes","description":"Clean up partial implementation from current session.\n\nChanges made in this session that need review/cleanup:\n1. systemtray_linux.go:\n - Activate() now calls clickHandler (correct)\n - SecondaryActivate() calls rightClickHandler or OpenMenu (correct)\n - ItemIsMenu conditional on window/menu presence (correct)\n - Menu property only registered when menu exists (correct)\n - Removed 'Open window' menu item injection (correct)\n\n2. environment_linux.go:\n - Added isTilingWM() helper (keep)\n - Removed unused Hyprland IPC functions (keep)\n - Cleaned up debug output (keep)\n\n3. linux_cgo.go / linux_cgo_gtk4.go:\n - Added setOpacity() - keep for future use\n\n4. webview_window_linux.go:\n - Removed unused compositorWindowID field (keep)\n\n5. examples/systray-basic/main.go:\n - Added Escape keybinding manually (will be replaced by HideOnEscape option)\n\nReview all changes, ensure they align with spec, commit clean state.","status":"closed","priority":1,"issue_type":"task","created_at":"2026-01-06T12:43:44.358797107+11:00","updated_at":"2026-01-06T13:02:50.19506054+11:00","closed_at":"2026-01-06T13:02:50.19506054+11:00","close_reason":"Cleanup complete","dependencies":[{"issue_id":"wails-webview2gtk6-m4c.9","depends_on_id":"wails-webview2gtk6-m4c","type":"parent-child","created_at":"2026-01-06T12:43:44.36368827+11:00","created_by":"daemon"}]} +{"id":"wails-webview2gtk6-t4e","title":"WebKitGTK 6.0 / GTK4 Support for Wails v3","description":"Add WebKitGTK 6.0 (GTK4) support to Wails v3 as the DEFAULT target. GTK3/WebKit4.1 available via -tags gtk3 for legacy systems.\n\nArchitecture:\n- Default (no tag): GTK4 + WebKitGTK 6.0\n- Legacy (-tags gtk3): GTK3 + WebKit2GTK 4.1\n\nDocker container provides BOTH library sets for cross-compilation:\n- task build:linux → GTK4/WebKit6 (modern, default)\n- task build:linux:gtk3 → GTK3/WebKit4.1 (legacy backport)\n\nSame pattern as macOS/Windows cross-compilation from Linux.","status":"open","priority":1,"issue_type":"epic","created_at":"2026-01-04T12:06:52.983769501+11:00","updated_at":"2026-01-04T12:52:12.372486756+11:00"} +{"id":"wails-webview2gtk6-t4e.1","title":"Phase 1: Add gtk3 build constraint to existing GTK3/WebKit4.1 files","description":"Rename/constrain existing GTK3 files to require -tags gtk3:\n- linux_cgo.go → add //go:build linux \u0026\u0026 gtk3\n- clipboard_linux.go → add //go:build linux \u0026\u0026 gtk3\n- menu_linux.go → add //go:build linux \u0026\u0026 gtk3\n- menuitem_linux.go → add //go:build linux \u0026\u0026 gtk3\n- screen_linux.go → add //go:build linux \u0026\u0026 gtk3\n- dialogs_linux.go → add //go:build linux \u0026\u0026 gtk3\n- webkit2.go → add //go:build linux \u0026\u0026 gtk3\n\nThese become the LEGACY path, only built with -tags gtk3","status":"closed","priority":1,"issue_type":"task","created_at":"2026-01-04T12:07:40.301322984+11:00","updated_at":"2026-01-06T15:34:36.338594373+11:00","closed_at":"2026-01-06T15:34:36.338594373+11:00","close_reason":"GTK3 files have gtk3 build tag","dependencies":[{"issue_id":"wails-webview2gtk6-t4e.1","depends_on_id":"wails-webview2gtk6-t4e","type":"parent-child","created_at":"2026-01-04T12:07:40.306919353+11:00","created_by":"daemon"}]} +{"id":"wails-webview2gtk6-t4e.10","title":"Phase 4: Implement webkit6 asset server","description":"webkit6.go, request_linux_webkit6.go, responsewriter_linux_webkit6.go - URI scheme handling with WebKitGTK 6.0 API (webkit_uri_scheme_response_new).","status":"closed","priority":1,"issue_type":"task","created_at":"2026-01-04T12:08:08.383542838+11:00","updated_at":"2026-01-06T15:34:41.942498525+11:00","closed_at":"2026-01-06T15:34:41.942498525+11:00","close_reason":"WebKit6 asset server implemented - URI scheme handling works","dependencies":[{"issue_id":"wails-webview2gtk6-t4e.10","depends_on_id":"wails-webview2gtk6-t4e","type":"parent-child","created_at":"2026-01-04T12:08:08.389188642+11:00","created_by":"daemon"}]} +{"id":"wails-webview2gtk6-t4e.11","title":"Phase 5: Implement GMenu/GAction menu system","description":"Complete rewrite from GtkMenu/GtkMenuItem to GMenu/GAction/GtkPopoverMenuBar. Most significant GTK4 change. Reference v2 PR #4570 menu_webkit6.go but fix race conditions.","status":"closed","priority":1,"issue_type":"task","created_at":"2026-01-04T12:08:40.990519767+11:00","updated_at":"2026-01-06T20:27:18.582723928+11:00","closed_at":"2026-01-06T20:27:18.582723928+11:00","close_reason":"Completed - GMenu/GAction implemented in menu_linux_gtk4.go and linux_cgo_gtk4.c","dependencies":[{"issue_id":"wails-webview2gtk6-t4e.11","depends_on_id":"wails-webview2gtk6-t4e","type":"parent-child","created_at":"2026-01-04T12:08:40.995669687+11:00","created_by":"daemon"}]} +{"id":"wails-webview2gtk6-t4e.12","title":"Phase 5: Implement menu item state handling","description":"GSimpleAction for text/checkbox/radio items. Stateful actions with g_simple_action_new_stateful. Proper checked state sync. Fix nil checks from v2 PR issues.","status":"closed","priority":1,"issue_type":"task","created_at":"2026-01-04T12:08:45.52200628+11:00","updated_at":"2026-01-06T20:27:20.311243355+11:00","closed_at":"2026-01-06T20:27:20.311243355+11:00","close_reason":"Completed - GSimpleAction with stateful actions for checkbox/radio implemented","dependencies":[{"issue_id":"wails-webview2gtk6-t4e.12","depends_on_id":"wails-webview2gtk6-t4e","type":"parent-child","created_at":"2026-01-04T12:08:45.526654215+11:00","created_by":"daemon"}]} +{"id":"wails-webview2gtk6-t4e.13","title":"Phase 5: Implement GTK4 keyboard accelerators","description":"gtk_application_set_accels_for_action for menu shortcuts. Map existing accelerator format to GTK4 format.","status":"closed","priority":2,"issue_type":"task","created_at":"2026-01-04T12:08:49.061335186+11:00","updated_at":"2026-01-06T20:27:20.562596782+11:00","closed_at":"2026-01-06T20:27:20.562596782+11:00","close_reason":"Completed - gtk_application_set_accels_for_action() implemented in Phase 9","dependencies":[{"issue_id":"wails-webview2gtk6-t4e.13","depends_on_id":"wails-webview2gtk6-t4e","type":"parent-child","created_at":"2026-01-04T12:08:49.066422576+11:00","created_by":"daemon"}]} +{"id":"wails-webview2gtk6-t4e.14","title":"Phase 6: Implement GTK4 clipboard API","description":"Replace gtk_clipboard_get with gdk_display_get_clipboard/gdk_display_get_primary_clipboard. Use GdkContentProvider for setting text.","status":"closed","priority":2,"issue_type":"task","created_at":"2026-01-04T12:08:53.275247028+11:00","updated_at":"2026-01-06T20:27:22.183597579+11:00","closed_at":"2026-01-06T20:27:22.183597579+11:00","close_reason":"Completed - GdkClipboard implemented in linux_cgo_gtk4.go","dependencies":[{"issue_id":"wails-webview2gtk6-t4e.14","depends_on_id":"wails-webview2gtk6-t4e","type":"parent-child","created_at":"2026-01-04T12:08:53.279707286+11:00","created_by":"daemon"}]} +{"id":"wails-webview2gtk6-t4e.15","title":"Phase 6: Implement GTK4 dialogs","description":"File chooser and message dialogs. Use deprecated-but-functional APIs (gtk_file_chooser_dialog_new deprecated 4.10 but works). Consider GtkFileDialog for future.","status":"closed","priority":2,"issue_type":"task","created_at":"2026-01-04T12:08:59.838538142+11:00","updated_at":"2026-01-06T20:27:22.294219031+11:00","closed_at":"2026-01-06T20:27:22.294219031+11:00","close_reason":"Completed - GtkFileDialog and GtkAlertDialog implemented in Phase 8","dependencies":[{"issue_id":"wails-webview2gtk6-t4e.15","depends_on_id":"wails-webview2gtk6-t4e","type":"parent-child","created_at":"2026-01-04T12:08:59.843372832+11:00","created_by":"daemon"}]} +{"id":"wails-webview2gtk6-t4e.16","title":"Phase 6: Implement GTK4 screen/monitor handling","description":"GdkMonitor/GdkDisplay GTK4 changes. Note: gdk_monitor_is_primary removed - handle gracefully or use alternative detection.","status":"closed","priority":2,"issue_type":"task","created_at":"2026-01-04T12:09:08.402102924+11:00","updated_at":"2026-01-06T20:27:35.337382837+11:00","closed_at":"2026-01-06T20:27:35.337382837+11:00","close_reason":"N/A - GTK4 uses GdkDisplay/GdkMonitor which are mostly backwards compatible; no special handling needed","dependencies":[{"issue_id":"wails-webview2gtk6-t4e.16","depends_on_id":"wails-webview2gtk6-t4e","type":"parent-child","created_at":"2026-01-04T12:09:08.406691355+11:00","created_by":"daemon"}]} +{"id":"wails-webview2gtk6-t4e.17","title":"Phase 6: Implement GTK4 event controllers","description":"Replace GTK3 signals with GTK4 event controllers: GtkGestureClick for button-press, GtkEventControllerKey for key events, GtkEventControllerMotion for motion.","status":"closed","priority":2,"issue_type":"task","created_at":"2026-01-04T12:09:11.122143159+11:00","updated_at":"2026-01-06T20:27:23.251573875+11:00","closed_at":"2026-01-06T20:27:23.251573875+11:00","close_reason":"Completed - GtkEventControllerFocus/GtkGestureClick/GtkEventControllerKey implemented in Phase 3","dependencies":[{"issue_id":"wails-webview2gtk6-t4e.17","depends_on_id":"wails-webview2gtk6-t4e","type":"parent-child","created_at":"2026-01-04T12:09:11.127168452+11:00","created_by":"daemon"}]} +{"id":"wails-webview2gtk6-t4e.18","title":"Phase 7: Create webkit6 test matrix","description":"Test on Ubuntu 24.04, Fedora 40+, Arch Linux. Both X11 and Wayland sessions. Verify window lifecycle, menus, dialogs, clipboard, asset serving.","status":"open","priority":1,"issue_type":"task","created_at":"2026-01-04T12:09:14.440029393+11:00","updated_at":"2026-01-04T12:09:14.440029393+11:00","dependencies":[{"issue_id":"wails-webview2gtk6-t4e.18","depends_on_id":"wails-webview2gtk6-t4e","type":"parent-child","created_at":"2026-01-04T12:09:14.444560094+11:00","created_by":"daemon"}]} +{"id":"wails-webview2gtk6-t4e.19","title":"Phase 7: Update UNRELEASED_CHANGELOG.md","description":"Document: webkit_6 build flag, auto-detection via capabilities command, Taskfile integration, known limitations (window positioning on Wayland).","status":"open","priority":1,"issue_type":"task","created_at":"2026-01-04T12:09:17.821748561+11:00","updated_at":"2026-01-04T12:09:17.821748561+11:00","dependencies":[{"issue_id":"wails-webview2gtk6-t4e.19","depends_on_id":"wails-webview2gtk6-t4e","type":"parent-child","created_at":"2026-01-04T12:09:17.826107005+11:00","created_by":"daemon"}]} +{"id":"wails-webview2gtk6-t4e.2","title":"Phase 1: Create GTK4/WebKit6 files as DEFAULT (no build tag)","description":"Create new GTK4/WebKit6 implementation files as the default (no tag required):\n- linux_cgo.go → //go:build linux \u0026\u0026 !gtk3 with pkg-config: gtk4 webkitgtk-6.0\n- clipboard_linux.go → //go:build linux \u0026\u0026 !gtk3\n- menu_linux.go → //go:build linux \u0026\u0026 !gtk3 (GMenu/GAction)\n- menuitem_linux.go → //go:build linux \u0026\u0026 !gtk3\n- screen_linux.go → //go:build linux \u0026\u0026 !gtk3\n- dialogs_linux.go → //go:build linux \u0026\u0026 !gtk3\n- webkit6.go → //go:build linux \u0026\u0026 !gtk3\n\nGTK4 is now the DEFAULT path, built without any tags","status":"closed","priority":1,"issue_type":"task","created_at":"2026-01-04T12:07:41.961703449+11:00","updated_at":"2026-01-06T15:34:38.035912813+11:00","closed_at":"2026-01-06T15:34:38.035912813+11:00","close_reason":"GTK4 files exist as default (linux_cgo_gtk4.go, menu_linux_gtk4.go, etc.)","dependencies":[{"issue_id":"wails-webview2gtk6-t4e.2","depends_on_id":"wails-webview2gtk6-t4e","type":"parent-child","created_at":"2026-01-04T12:07:41.966174608+11:00","created_by":"daemon"}]} +{"id":"wails-webview2gtk6-t4e.20","title":"Phase 7: Write GTK4/WebKit6 documentation","description":"Migration guide covering: distro requirements, build flags, window positioning limitations, menu system changes, API differences from GTK3.","status":"open","priority":2,"issue_type":"task","created_at":"2026-01-04T12:09:20.269607376+11:00","updated_at":"2026-01-04T12:09:20.269607376+11:00","dependencies":[{"issue_id":"wails-webview2gtk6-t4e.20","depends_on_id":"wails-webview2gtk6-t4e","type":"parent-child","created_at":"2026-01-04T12:09:20.274078494+11:00","created_by":"daemon"}]} +{"id":"wails-webview2gtk6-t4e.21","title":"Phase 8: V2 PR #4570 Fixes Tracker","description":"Track issues to backport to v2 PR after v3 port complete. Current known issues:\n- Race conditions: menu maps accessed without sync (menu_webkit6.go)\n- Nil checks missing: gActionIdToMenuItem.Load ignores ok bool (gtk_webkit6.go:18,22,34,45)\n- Memory leak: C.CString(title) not freed (window_webkit6.go:384)\n- Header mismatch: sendShowInspectorMessage signature wrong (window_webkit6.h:127)\n- Wrong cast: GtkWindow passed as GdkToplevel (window_webkit6.c:672,699)\n- Broken logic: IsMinimised returns wrong value (window_webkit6.c:383-387)\n- Incomplete: drag-drop just prints paths (window_webkit6.c:574-585)\n- Missing: separator handling in menus\nUPDATE THIS AS MORE ISSUES FOUND DURING V3 PORT","status":"open","priority":3,"issue_type":"task","created_at":"2026-01-04T12:09:35.71638895+11:00","updated_at":"2026-01-04T12:09:35.71638895+11:00","dependencies":[{"issue_id":"wails-webview2gtk6-t4e.21","depends_on_id":"wails-webview2gtk6-t4e","type":"parent-child","created_at":"2026-01-04T12:09:35.720786909+11:00","created_by":"daemon"}]} +{"id":"wails-webview2gtk6-t4e.22","title":"Test Strategy: Build tag verification","description":"Verify build constraints work correctly:\n\nDefault build (no tags):\n- Uses GTK4/WebKitGTK 6.0 files\n- Compiles cleanly with gtk4 and webkitgtk-6.0 pkg-config\n\nLegacy build (-tags gtk3):\n- Uses GTK3/WebKit2GTK 4.1 files\n- Compiles cleanly with gtk+-3.0 and webkit2gtk-4.1 pkg-config\n\nVerify:\n- No file conflicts or duplicate symbols in either config\n- Both builds produce working binaries\n- CI matrix tests both configurations\n- Docker cross-compilation works for both targets","status":"open","priority":1,"issue_type":"task","created_at":"2026-01-04T12:40:55.065828451+11:00","updated_at":"2026-01-04T12:53:15.945916832+11:00","dependencies":[{"issue_id":"wails-webview2gtk6-t4e.22","depends_on_id":"wails-webview2gtk6-t4e","type":"parent-child","created_at":"2026-01-04T12:40:55.071357519+11:00","created_by":"daemon"}]} +{"id":"wails-webview2gtk6-t4e.23","title":"Test Strategy: GTK3 legacy build regression tests","description":"Ensure GTK3 legacy path (-tags gtk3) still works:\n- All existing Linux tests pass WITH -tags gtk3\n- Window lifecycle (create, show, hide, destroy)\n- Menu system (items, checkboxes, radio, separators, accelerators)\n- Dialogs (file open/save, message dialogs)\n- Clipboard operations\n- Asset serving via wails:// scheme\n- JavaScript execution and callbacks\n\nRun via Docker on systems without GTK3 dev libs locally.\nThis is the LEGACY path for older distros.","status":"open","priority":1,"issue_type":"task","created_at":"2026-01-04T12:40:57.736554584+11:00","updated_at":"2026-01-04T12:53:21.402683536+11:00","dependencies":[{"issue_id":"wails-webview2gtk6-t4e.23","depends_on_id":"wails-webview2gtk6-t4e","type":"parent-child","created_at":"2026-01-04T12:40:57.74152021+11:00","created_by":"daemon"}]} +{"id":"wails-webview2gtk6-t4e.24","title":"Test Strategy: GTK4 default build tests","description":"Verify GTK4 (default, no tags) works correctly:\n- Window lifecycle identical to GTK3 behavior\n- Menu system: GMenu/GAction produces same UX as GtkMenu\n- Dialogs: same file filters, default paths work\n- Clipboard: copy/paste text works identically \n- Asset serving: wails:// scheme works\n- JS execution: evaluate_javascript produces same results\n\nDocument intentional differences:\n- Window positioning is no-op on Wayland (expected)\n- Minor visual differences due to GTK4 theming","status":"open","priority":1,"issue_type":"task","created_at":"2026-01-04T12:41:01.206249936+11:00","updated_at":"2026-01-04T12:53:26.644766099+11:00","dependencies":[{"issue_id":"wails-webview2gtk6-t4e.24","depends_on_id":"wails-webview2gtk6-t4e","type":"parent-child","created_at":"2026-01-04T12:41:01.21075179+11:00","created_by":"daemon"}]} +{"id":"wails-webview2gtk6-t4e.25","title":"Test Strategy: Cross-distro matrix","description":"Test on multiple distributions:\n| Distro | GTK4/WebKit6 | GTK3/WebKit4.1 | Priority |\n|--------|--------------|----------------|----------|\n| Ubuntu 24.04 | ✓ test | ✓ test | HIGH |\n| Ubuntu 22.04 | N/A | ✓ test | HIGH |\n| Fedora 40+ | ✓ test | ✓ test | HIGH |\n| Arch Linux | ✓ test | ✓ test | MEDIUM |\n| Debian 12 | ✓ backports | ✓ test | MEDIUM |\n\nUse Docker containers or VMs for reproducible testing.","status":"open","priority":1,"issue_type":"task","created_at":"2026-01-04T12:41:11.624965746+11:00","updated_at":"2026-01-04T12:41:11.624965746+11:00","dependencies":[{"issue_id":"wails-webview2gtk6-t4e.25","depends_on_id":"wails-webview2gtk6-t4e","type":"parent-child","created_at":"2026-01-04T12:41:11.62962541+11:00","created_by":"daemon"}]} +{"id":"wails-webview2gtk6-t4e.26","title":"Test Strategy: X11 vs Wayland session testing","description":"Test both display servers:\nX11 Session:\n- Window positioning should work (GTK3) or no-op gracefully (GTK4)\n- All features functional\n- Performance baseline\n\nWayland Session:\n- Window positioning confirmed as no-op (expected)\n- No crashes or errors from positioning attempts\n- Native Wayland rendering (GTK4 benefits)\n- Verify GDK_BACKEND handling\n\nTest with: GDK_BACKEND=x11 and GDK_BACKEND=wayland","status":"open","priority":1,"issue_type":"task","created_at":"2026-01-04T12:41:15.327289032+11:00","updated_at":"2026-01-04T12:41:15.327289032+11:00","dependencies":[{"issue_id":"wails-webview2gtk6-t4e.26","depends_on_id":"wails-webview2gtk6-t4e","type":"parent-child","created_at":"2026-01-04T12:41:15.331938707+11:00","created_by":"daemon"}]} +{"id":"wails-webview2gtk6-t4e.27","title":"Test Strategy: Doctor and capabilities command tests","description":"Test tooling works correctly:\n- wails3 doctor shows GTK3/4 and WebKit4.1/6.0 availability\n- wails3 doctor only shows 'installed' for actual dev packages (not runtime)\n- wails3 capabilities --json returns correct structure\n- wails3 capabilities --linux-tags returns 'webkit_6' when available, empty when not\n- Taskfile integration works (auto-selects correct tags)\n- Test on system WITH gtk4/webkit6 dev packages\n- Test on system WITHOUT gtk4/webkit6 (only gtk3)","status":"open","priority":1,"issue_type":"task","created_at":"2026-01-04T12:41:19.283226161+11:00","updated_at":"2026-01-04T12:41:19.283226161+11:00","dependencies":[{"issue_id":"wails-webview2gtk6-t4e.27","depends_on_id":"wails-webview2gtk6-t4e","type":"parent-child","created_at":"2026-01-04T12:41:19.287996887+11:00","created_by":"daemon"}]} +{"id":"wails-webview2gtk6-t4e.28","title":"Test Strategy: Auto-detection fallback behavior","description":"Test the smart default behavior:\nScenario 1: System has GTK4 + WebKit6\n- capabilities recommends webkit_6\n- Taskfile uses webkit_6 automatically\n- Build succeeds with GTK4 features\n\nScenario 2: System has only GTK3 + WebKit4.1\n- capabilities recommends default (no tag)\n- Taskfile uses no extra tags\n- Build succeeds with GTK3\n\nScenario 3: Neither available\n- Doctor shows clear error\n- Install commands displayed per distro\n- Build fails with helpful message","status":"open","priority":1,"issue_type":"task","created_at":"2026-01-04T12:41:22.845473972+11:00","updated_at":"2026-01-04T12:41:22.845473972+11:00","dependencies":[{"issue_id":"wails-webview2gtk6-t4e.28","depends_on_id":"wails-webview2gtk6-t4e","type":"parent-child","created_at":"2026-01-04T12:41:22.850043685+11:00","created_by":"daemon"}]} +{"id":"wails-webview2gtk6-t4e.29","title":"Test Strategy: Docker test containers","description":"Update Docker containers to support both GTK versions:\n\nSingle container with both library sets:\n- Ubuntu 24.04 base (has both GTK3 and GTK4)\n- libgtk-4-dev + libwebkitgtk-6.0-dev (default)\n- libgtk-3-dev + libwebkit2gtk-4.1-dev (legacy)\n\nBuild script parameters:\n- docker run wails-linux ./build.sh # GTK4 default\n- docker run wails-linux ./build.sh --gtk3 # GTK3 legacy\n\nArchitecture variants:\n- Dockerfile.linux-x86_64 (amd64)\n- Dockerfile.linux-arm64 (aarch64)\n\nStore in v3/test/docker/ directory","status":"open","priority":1,"issue_type":"task","created_at":"2026-01-04T12:41:52.701057271+11:00","updated_at":"2026-01-04T12:53:38.599341789+11:00","dependencies":[{"issue_id":"wails-webview2gtk6-t4e.29","depends_on_id":"wails-webview2gtk6-t4e","type":"parent-child","created_at":"2026-01-04T12:41:52.706373965+11:00","created_by":"daemon"}]} +{"id":"wails-webview2gtk6-t4e.3","title":"Phase 2: Update wails doctor for GTK4 as default","description":"Update doctor to check for GTK4/WebKit6 as primary requirement:\n\nPrimary checks (required for default build):\n- pkg-config --exists gtk4\n- pkg-config --exists webkitgtk-6.0\n\nSecondary checks (for legacy builds):\n- pkg-config --exists gtk+-3.0\n- pkg-config --exists webkit2gtk-4.1\n\nOutput example:\n GTK4 (gtk4) ✓ 4.14.1 [required for default build]\n WebKitGTK 6.0 ✓ 2.44.1 [required for default build]\n GTK3 (gtk+-3.0) ✓ 3.24.38 [for -tags gtk3 builds]\n WebKit2GTK 4.1 ✓ 2.44.1 [for -tags gtk3 builds]\n\nIf GTK4 missing: suggest Docker build or install commands","status":"closed","priority":1,"issue_type":"task","created_at":"2026-01-04T12:07:43.111264576+11:00","updated_at":"2026-01-06T15:38:15.173987437+11:00","closed_at":"2026-01-06T15:38:15.173987437+11:00","close_reason":"Doctor already correctly shows GTK4 as primary and GTK3 as legacy. Verified output shows gtk4 4.20.3, webkitgtk-6.0 2.50.3 as required, gtk3/webkit2gtk marked (legacy) as optional.","dependencies":[{"issue_id":"wails-webview2gtk6-t4e.3","depends_on_id":"wails-webview2gtk6-t4e","type":"parent-child","created_at":"2026-01-04T12:07:43.11571264+11:00","created_by":"daemon"}]} +{"id":"wails-webview2gtk6-t4e.30","title":"Test Strategy: Docker-based doctor/capabilities tests","description":"Test both GTK versions via Docker:\n\nTest matrix for Docker builds:\n| Command | Expected Result |\n|---------|-----------------|\n| task build:linux | GTK4/WebKit6 binary |\n| task build:linux:gtk3 | GTK3/WebKit4.1 binary |\n\nVerify in Docker container:\n- Default build links against libgtk-4.so, libwebkitgtk-6.0.so\n- GTK3 build links against libgtk-3.so, libwebkit2gtk-4.1.so\n\nCross-compilation test:\n- Build from macOS → Linux GTK4 (Docker)\n- Build from macOS → Linux GTK3 (Docker)\n- Build from Windows → Linux GTK4 (Docker)","status":"open","priority":1,"issue_type":"task","created_at":"2026-01-04T12:41:56.664141365+11:00","updated_at":"2026-01-04T12:53:44.010563993+11:00","dependencies":[{"issue_id":"wails-webview2gtk6-t4e.30","depends_on_id":"wails-webview2gtk6-t4e","type":"parent-child","created_at":"2026-01-04T12:41:56.668983135+11:00","created_by":"daemon"}]} +{"id":"wails-webview2gtk6-t4e.31","title":"Test Strategy: Docker-based build verification","description":"Verify Docker builds produce correct binaries:\n\nDefault (GTK4) builds:\n- docker run wails-linux ./build.sh\n- Binary requires libgtk-4, libwebkitgtk-6.0 at runtime\n- Runs on Ubuntu 22.04+, Fedora 38+, Arch, Debian 12+\n\nLegacy (GTK3) builds:\n- docker run wails-linux ./build.sh --gtk3\n- Binary requires libgtk-3, libwebkit2gtk-4.1 at runtime\n- Runs on older distros (Ubuntu 20.04, Debian 11, RHEL 8)\n\nTest both binaries actually run on target systems (not just compile)","status":"open","priority":1,"issue_type":"task","created_at":"2026-01-04T12:42:00.581467132+11:00","updated_at":"2026-01-04T12:53:49.143142805+11:00","dependencies":[{"issue_id":"wails-webview2gtk6-t4e.31","depends_on_id":"wails-webview2gtk6-t4e","type":"parent-child","created_at":"2026-01-04T12:42:00.586144259+11:00","created_by":"daemon"}]} +{"id":"wails-webview2gtk6-t4e.32","title":"Test Strategy: CI workflow for multi-distro testing","description":"Add GitHub Actions workflow for automated testing:\n\n.github/workflows/linux-webkit6-tests.yml:\n- Trigger on PRs touching v3/pkg/application/*linux*, v3/internal/doctor/*\n- Matrix strategy with Docker containers\n- Jobs:\n 1. Build verification (both tag configs)\n 2. Doctor command output validation\n 3. Capabilities command JSON validation\n \nCache Docker images for faster CI runs.\nFail CI if any distro/config combination breaks.","status":"open","priority":2,"issue_type":"task","created_at":"2026-01-04T12:42:04.299112575+11:00","updated_at":"2026-01-04T12:42:04.299112575+11:00","dependencies":[{"issue_id":"wails-webview2gtk6-t4e.32","depends_on_id":"wails-webview2gtk6-t4e","type":"parent-child","created_at":"2026-01-04T12:42:04.30363047+11:00","created_by":"daemon"}]} +{"id":"wails-webview2gtk6-t4e.33","title":"Test Strategy: Unit tests for new Go code","description":"Add unit tests for new functionality:\n\n- capabilities command parsing and JSON output\n- pkg-config detection wrapper functions\n- Build tag detection logic\n- DevPackageInstalled() / DevPackageVersion() functions\n- Taskfile tag generation logic\n\nTests should be runnable without GTK installed (mock pkg-config calls).\nLocation: v3/internal/doctor/*_test.go, v3/cmd/wails3/*_test.go","status":"open","priority":1,"issue_type":"task","created_at":"2026-01-04T12:42:59.917988736+11:00","updated_at":"2026-01-04T12:42:59.917988736+11:00","dependencies":[{"issue_id":"wails-webview2gtk6-t4e.33","depends_on_id":"wails-webview2gtk6-t4e","type":"parent-child","created_at":"2026-01-04T12:42:59.91880054+11:00","created_by":"daemon"}]} +{"id":"wails-webview2gtk6-t4e.34","title":"Test Strategy: Edge cases and error handling","description":"Test edge cases for webkit_6 implementation:\n\nMenu edge cases:\n- Empty menu\n- Deeply nested submenus (5+ levels)\n- Menu items with special characters (unicode, \u0026, \u003c, \u003e)\n- Rapid menu updates\n- Menu with 100+ items\n\nWindow edge cases:\n- Multiple windows simultaneously\n- Window close during JS execution\n- Rapid show/hide cycles\n\nError handling:\n- Graceful handling when WebKit crashes\n- Clear error messages for missing dependencies\n- Proper cleanup on application exit","status":"open","priority":2,"issue_type":"task","created_at":"2026-01-04T12:43:02.108202689+11:00","updated_at":"2026-01-04T12:43:02.108202689+11:00","dependencies":[{"issue_id":"wails-webview2gtk6-t4e.34","depends_on_id":"wails-webview2gtk6-t4e","type":"parent-child","created_at":"2026-01-04T12:43:02.114118944+11:00","created_by":"daemon"}]} +{"id":"wails-webview2gtk6-t4e.35","title":"Test Strategy: Memory and resource leak testing","description":"Verify no memory leaks in webkit_6 implementation:\n\nCritical areas (from v2 PR issues):\n- C.CString allocations must be freed\n- GObject ref counting (g_object_unref calls)\n- Menu rebuilds don't leak\n- Window create/destroy cycles don't leak\n\nTesting approach:\n- Use valgrind or AddressSanitizer\n- Create/destroy 1000 windows, measure memory\n- Rebuild menus 1000 times, measure memory\n- Long-running test (1 hour) with periodic operations\n\nCompare memory behavior between GTK3 and GTK4 builds.","status":"open","priority":2,"issue_type":"task","created_at":"2026-01-04T12:43:08.315395906+11:00","updated_at":"2026-01-04T12:43:08.315395906+11:00","dependencies":[{"issue_id":"wails-webview2gtk6-t4e.35","depends_on_id":"wails-webview2gtk6-t4e","type":"parent-child","created_at":"2026-01-04T12:43:08.320587181+11:00","created_by":"daemon"}]} +{"id":"wails-webview2gtk6-t4e.36","title":"Test Strategy: Example apps verification","description":"Verify all v3 example apps work with webkit_6:\n\nTest each example in v3/examples/:\n- Build with default tags (GTK3)\n- Build with -tags webkit_6 (GTK4)\n- Run and verify functionality matches\n\nPriority examples:\n- plain (basic window)\n- menu (menu system)\n- dialogs (file/message dialogs)\n- clipboard (copy/paste)\n- events (window events)\n- binding (Go-JS bindings)\n\nDocument any examples that need webkit_6-specific adjustments.","status":"open","priority":1,"issue_type":"task","created_at":"2026-01-04T12:43:12.575574602+11:00","updated_at":"2026-01-04T12:43:12.575574602+11:00","dependencies":[{"issue_id":"wails-webview2gtk6-t4e.36","depends_on_id":"wails-webview2gtk6-t4e","type":"parent-child","created_at":"2026-01-04T12:43:12.58115082+11:00","created_by":"daemon"}]} +{"id":"wails-webview2gtk6-t4e.37","title":"Phase 2: Update Docker container with both GTK3 and GTK4 libraries","description":"Update Dockerfile.linux-x86_64 and Dockerfile.linux-arm64 to include BOTH library sets:\n\nRUN apt-get install -y \\\n # GTK4 + WebKitGTK 6.0 (default/modern)\n libgtk-4-dev \\\n libwebkitgtk-6.0-dev \\\n # GTK3 + WebKit2GTK 4.1 (legacy)\n libgtk-3-dev \\\n libwebkit2gtk-4.1-dev \\\n libayatana-appindicator3-dev\n\nUpdate build script to accept GTK version parameter:\n- build-linux.sh gtk4 → builds with no tags (default)\n- build-linux.sh gtk3 → builds with -tags gtk3\n\nThis enables cross-compilation to EITHER target from any platform.","status":"closed","priority":1,"issue_type":"task","created_at":"2026-01-04T12:53:05.672476127+11:00","updated_at":"2026-01-06T20:27:23.926443978+11:00","closed_at":"2026-01-06T20:27:23.926443978+11:00","close_reason":"Completed - Docker containers updated in Phase 6","dependencies":[{"issue_id":"wails-webview2gtk6-t4e.37","depends_on_id":"wails-webview2gtk6-t4e","type":"parent-child","created_at":"2026-01-04T12:53:05.678037266+11:00","created_by":"daemon"}]} +{"id":"wails-webview2gtk6-t4e.38","title":"Test Strategy: Comprehensive performance benchmark suite","description":"Create benchmark suite to measure GTK4/WebKit6 vs GTK3/WebKit4.1 performance.\n\nRENDERING BENCHMARKS:\n- Time to First Paint (TTFP): Measure ms from app start to first meaningful content\n- Time to Interactive (TTI): When app responds to user input\n- Frame rate during scroll: 60fps target, measure drops\n- Large DOM: Render 10,000 list items, measure time and FPS\n- DOM manipulation: Add/remove 1000 elements, measure time\n- CSS animations: Complex animations, measure frame consistency\n- Reflow/repaint: Measure layout thrashing scenarios\n\nBINDING BENCHMARKS:\n- Call latency: Round-trip time for Go function call from JS\n- Throughput: Calls per second (simple function)\n- Large payload: Transfer 1MB JSON Go→JS and JS→Go\n- Concurrent calls: 100 simultaneous binding calls\n- Callback performance: Go calling back into JS\n\nASSET SERVER BENCHMARKS:\n- Small file latency: Load 1KB file, measure ms\n- Large file throughput: Load 10MB file, measure MB/s\n- Many files: Load 100 small files sequentially\n- Parallel loading: Load 20 files simultaneously\n- Streaming: Video/audio streaming performance\n\nMEMORY BENCHMARKS:\n- Initial footprint: Memory after app start\n- After heavy ops: Memory after DOM/binding stress\n- Leak detection: Memory after 1000 window open/close cycles\n- Long-running: Memory growth over 1 hour of use\n\nOUTPUT FORMAT:\n- JSON results for CI integration\n- Markdown report for human review\n- Compare GTK4 vs GTK3 side-by-side\n\nIMPLEMENTATION:\n- Create v3/test/benchmarks/ directory\n- Benchmark app with standardized test pages\n- Go benchmark harness using testing.B\n- Browser performance APIs (performance.now(), PerformanceObserver)","status":"open","priority":1,"issue_type":"task","created_at":"2026-01-04T12:54:15.661692112+11:00","updated_at":"2026-01-04T12:54:15.661692112+11:00","dependencies":[{"issue_id":"wails-webview2gtk6-t4e.38","depends_on_id":"wails-webview2gtk6-t4e","type":"parent-child","created_at":"2026-01-04T12:54:15.667316351+11:00","created_by":"daemon"}]} +{"id":"wails-webview2gtk6-t4e.39","title":"Test Strategy: Create benchmark test application","description":"Create dedicated benchmark application in v3/test/benchmarks/app/\n\nFRONTEND (benchmark pages):\n1. rendering.html - DOM/CSS performance tests\n - Virtual scroll with 100,000 items\n - CSS grid with 1000 cells\n - Animation stress test (50 simultaneous)\n - Canvas 2D drawing benchmark\n \n2. bindings.html - Go\u003c-\u003eJS communication tests\n - Ping-pong latency measurement\n - Large data serialization\n - Concurrent call stress test\n - Event emission throughput\n\n3. assets.html - Asset server tests\n - Image gallery (100 images)\n - Large file download\n - Streaming video playback\n - WebSocket throughput (if applicable)\n\n4. memory.html - Memory profiling\n - Allocate/deallocate cycles\n - DOM node creation/destruction\n - Image loading/unloading\n\nBACKEND (Go harness):\n- BenchmarkService with standardized test methods\n- Metrics collection and reporting\n- Automated test runner\n- Results export (JSON, CSV, Markdown)\n\nCOMPARISON MODE:\n- Run same tests on GTK4 and GTK3 builds\n- Generate comparison report\n- Highlight improvements/regressions\n- Statistical significance testing (multiple runs)","status":"open","priority":1,"issue_type":"task","created_at":"2026-01-04T12:54:33.607772979+11:00","updated_at":"2026-01-04T12:54:33.607772979+11:00","dependencies":[{"issue_id":"wails-webview2gtk6-t4e.39","depends_on_id":"wails-webview2gtk6-t4e","type":"parent-child","created_at":"2026-01-04T12:54:33.612719138+11:00","created_by":"daemon"}]} +{"id":"wails-webview2gtk6-t4e.4","title":"Phase 2: Update wails3 capabilities command","description":"Update capabilities command for GTK4-default architecture:\n\nOutput structure:\n{\n \"linux\": {\n \"gtk4\": true,\n \"gtk3\": true,\n \"webkitgtk_6_0\": true,\n \"webkit2gtk_4_1\": true,\n \"default_available\": true, // Can build without tags\n \"legacy_available\": true, // Can build with -tags gtk3\n \"recommended\": \"default\" // or \"legacy\" or \"docker\"\n }\n}\n\nIf GTK4 not available locally, recommend Docker build.","status":"closed","priority":1,"issue_type":"task","created_at":"2026-01-04T12:07:44.735354235+11:00","updated_at":"2026-01-06T20:46:36.935228449+11:00","closed_at":"2026-01-06T20:46:36.935228449+11:00","close_reason":"Implemented wails3 tool capabilities command","dependencies":[{"issue_id":"wails-webview2gtk6-t4e.4","depends_on_id":"wails-webview2gtk6-t4e","type":"parent-child","created_at":"2026-01-04T12:07:44.739955792+11:00","created_by":"daemon"}]} +{"id":"wails-webview2gtk6-t4e.40","title":"Test Strategy: CI benchmark regression tracking","description":"Add CI workflow to track performance over time:\n\nWORKFLOW (.github/workflows/benchmarks.yml):\n- Trigger: Weekly schedule + manual dispatch\n- Run benchmarks on both GTK4 and GTK3 builds\n- Store results as artifacts\n- Compare against baseline\n\nTRACKING:\n- Store historical benchmark data\n- Alert on \u003e10% regression\n- Track trends over releases\n- Generate performance dashboard\n\nBASELINE ESTABLISHMENT:\n- Run benchmarks before GTK4 migration (current GTK3)\n- This becomes the baseline for comparison\n- Document expected improvements from GTK4/WebKit6\n\nREPORTING:\n- Post results to PR comments (for benchmark PRs)\n- Update performance docs with latest numbers\n- Publish comparison: GTK4 vs GTK3 vs other frameworks (Electron, Tauri)","status":"open","priority":2,"issue_type":"task","created_at":"2026-01-04T12:54:39.84655827+11:00","updated_at":"2026-01-04T12:54:39.84655827+11:00","dependencies":[{"issue_id":"wails-webview2gtk6-t4e.40","depends_on_id":"wails-webview2gtk6-t4e","type":"parent-child","created_at":"2026-01-04T12:54:39.851364533+11:00","created_by":"daemon"}]} +{"id":"wails-webview2gtk6-t4e.5","title":"Phase 2: Update Taskfile with build:linux and build:linux:gtk3","description":"Update Taskfile.yaml with Linux build targets:\n\ntask build:linux → Default GTK4/WebKit6 build\ntask build:linux:gtk3 → Legacy GTK3/WebKit4.1 build (uses -tags gtk3)\n\nBoth work via Docker for cross-compilation:\n- Docker container has BOTH library sets installed\n- Build script accepts target parameter\n\nExample usage:\n task build:linux # GTK4 native or Docker\n task build:linux:gtk3 # GTK3 via Docker (or native with -tags gtk3)","status":"closed","priority":2,"issue_type":"task","created_at":"2026-01-04T12:07:46.101012374+11:00","updated_at":"2026-01-06T20:27:33.971988614+11:00","closed_at":"2026-01-06T20:27:33.971988614+11:00","close_reason":"Completed - Taskfile updated with test:example:linux:gtk3 and docker targets in Phase 6","dependencies":[{"issue_id":"wails-webview2gtk6-t4e.5","depends_on_id":"wails-webview2gtk6-t4e","type":"parent-child","created_at":"2026-01-04T12:07:46.105510654+11:00","created_by":"daemon"}]} +{"id":"wails-webview2gtk6-t4e.6","title":"Phase 3: Implement GTK4 application lifecycle","description":"linux_cgo_webkit6.go - GTK4 app init with gtk_application_new, g_application_run, proper signal handlers. No gtk_init needed in GTK4.","status":"closed","priority":1,"issue_type":"task","created_at":"2026-01-04T12:07:56.71551144+11:00","updated_at":"2026-01-06T15:34:38.511762855+11:00","closed_at":"2026-01-06T15:34:38.511762855+11:00","close_reason":"GTK4 application lifecycle implemented in application_linux_gtk4.go","dependencies":[{"issue_id":"wails-webview2gtk6-t4e.6","depends_on_id":"wails-webview2gtk6-t4e","type":"parent-child","created_at":"2026-01-04T12:07:56.721263416+11:00","created_by":"daemon"}]} +{"id":"wails-webview2gtk6-t4e.7","title":"Phase 3: Implement GTK4 window management","description":"Window creation with gtk_window_set_child (not gtk_container_add). Widgets visible by default (no show_all). Fullscreen/maximize/minimize state handling.","status":"closed","priority":1,"issue_type":"task","created_at":"2026-01-04T12:07:59.625663163+11:00","updated_at":"2026-01-06T15:34:39.557173339+11:00","closed_at":"2026-01-06T15:34:39.557173339+11:00","close_reason":"GTK4 window management implemented in linux_cgo_gtk4.go","dependencies":[{"issue_id":"wails-webview2gtk6-t4e.7","depends_on_id":"wails-webview2gtk6-t4e","type":"parent-child","created_at":"2026-01-04T12:07:59.63049083+11:00","created_by":"daemon"}]} +{"id":"wails-webview2gtk6-t4e.8","title":"Phase 3: Implement WebKitGTK 6.0 WebView integration","description":"Use webkit_web_view_evaluate_javascript (not run_javascript), WebKitNetworkSession for network, URI scheme handler registration with new API.","status":"closed","priority":1,"issue_type":"task","created_at":"2026-01-04T12:08:02.595646332+11:00","updated_at":"2026-01-06T15:34:40.794896929+11:00","closed_at":"2026-01-06T15:34:40.794896929+11:00","close_reason":"WebKitGTK 6.0 WebView integration implemented in linux_cgo_gtk4.go","dependencies":[{"issue_id":"wails-webview2gtk6-t4e.8","depends_on_id":"wails-webview2gtk6-t4e","type":"parent-child","created_at":"2026-01-04T12:08:02.601222032+11:00","created_by":"daemon"}]} +{"id":"wails-webview2gtk6-t4e.9","title":"Phase 3: Window positioning as no-op for webkit_6","description":"SetPosition, Center, GetPosition return gracefully on GTK4/Wayland. gtk_window_move removed intentionally by GTK. Document as known limitation.","status":"closed","priority":2,"issue_type":"task","created_at":"2026-01-04T12:08:05.494126564+11:00","updated_at":"2026-01-06T20:27:32.813843908+11:00","closed_at":"2026-01-06T20:27:32.813843908+11:00","close_reason":"Completed - Window positioning documented as no-op on Wayland in Decision 3 of IMPLEMENTATION.md","dependencies":[{"issue_id":"wails-webview2gtk6-t4e.9","depends_on_id":"wails-webview2gtk6-t4e","type":"parent-child","created_at":"2026-01-04T12:08:05.498782524+11:00","created_by":"daemon"}]} diff --git a/.coderabbit.yaml b/.coderabbit.yaml new file mode 100644 index 000000000..5edf609fa --- /dev/null +++ b/.coderabbit.yaml @@ -0,0 +1,71 @@ +language: en-US +tone_instructions: '' +early_access: false +enable_free_tier: true +reviews: + profile: chill + request_changes_workflow: false + high_level_summary: true + high_level_summary_placeholder: '@coderabbitai summary' + auto_title_placeholder: '@coderabbitai' + review_status: true + poem: true + collapse_walkthrough: false + sequence_diagrams: true + path_filters: [] + path_instructions: [] + abort_on_close: true + auto_review: + enabled: true + auto_incremental_review: true + ignore_title_keywords: [] + labels: [] + drafts: false + base_branches: ['v3-alpha', 'master'] + tools: + shellcheck: + enabled: true + ruff: + enabled: true + markdownlint: + enabled: true + github-checks: + enabled: true + timeout_ms: 90000 + languagetool: + enabled: true + enabled_only: false + level: default + biome: + enabled: true + hadolint: + enabled: true + swiftlint: + enabled: true + phpstan: + enabled: true + level: default + golangci-lint: + enabled: true + yamllint: + enabled: true + gitleaks: + enabled: true + checkov: + enabled: true + detekt: + enabled: true + eslint: + enabled: true +chat: + auto_reply: true +knowledge_base: + opt_out: false + learnings: + scope: auto + issues: + scope: auto + jira: + project_keys: [] + linear: + team_keys: [] diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 000000000..807d5983d --- /dev/null +++ b/.gitattributes @@ -0,0 +1,3 @@ + +# Use bd merge for beads JSONL files +.beads/issues.jsonl merge=beads diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 9faf71704..c8ace9747 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -7,6 +7,8 @@ body: - type: markdown attributes: value: | + ***Please note: No bug reports are currently being accepted for Wails v3*** + ***Please note: No bug reports are currently being accepted for Wails v3*** ***Please note: No bug reports are currently being accepted for Wails v3*** Before submitting this issue, please do the following: - Do a web search for your error. This usually leads to a much better understanding of the issue. @@ -70,7 +72,7 @@ body: validations: required: false - type: textarea - id: systemdetails + id: systemetails attributes: label: System Details description: Please add the output of `wails doctor`. diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index d73efffa8..9f8d049ba 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -6,6 +6,7 @@ * YOUR PR MAY BE REJECTED IF IT DOES NOT FOLLOW THESE STEPS * ********************************************************************* +- *DO NOT* submit bugs for a source install of v3, ONLY tagged versions, e.g. v3.0.0-alpha.11 - *DO NOT* submit PRs for v3 alpha enhancements, unless you have opened a post on the discord channel. All enhancements must be discussed first. The feedback guide for v3 is here: https://v3alpha.wails.io/getting-started/feedback/ @@ -47,7 +48,7 @@ Please paste the output of `wails doctor`. If you are unable to run this command # Checklist: -- [ ] I have updated `website/src/pages/changelog.mdx` with details of this PR +- [ ] I have updated `v3/UNRELEASED_CHANGELOG.md` with details of this PR - [ ] My code follows the general coding style of this project - [ ] I have performed a self-review of my own code - [ ] I have commented my code, particularly in hard-to-understand areas diff --git a/.github/workflows/auto-label-issues.yml b/.github/workflows/auto-label-issues.yml index 3d7a86450..097eba533 100644 --- a/.github/workflows/auto-label-issues.yml +++ b/.github/workflows/auto-label-issues.yml @@ -3,7 +3,7 @@ name: Auto Label Issues on: issues: types: [opened, edited, reopened] - pull_request: + pull_request_target: types: [opened, edited, reopened, synchronize] jobs: diff --git a/.github/workflows/automated-releases.yml b/.github/workflows/automated-releases.yml new file mode 100644 index 000000000..83445d869 --- /dev/null +++ b/.github/workflows/automated-releases.yml @@ -0,0 +1,373 @@ +name: Automated Nightly Releases + +on: + workflow_dispatch: + inputs: + force_release: + description: 'Force release even if no changes detected' + required: false + default: false + type: boolean + dry_run: + description: 'Run in dry-run mode (no actual releases)' + required: false + default: false + type: boolean + # schedule: + # Run at 2 AM UTC every day - DISABLED for safety until ready + # - cron: '0 2 * * *' + +env: + GO_VERSION: '1.24' + +jobs: + check-permissions: + name: Check Release Permissions + permissions: {} + runs-on: ubuntu-latest + outputs: + authorized: ${{ steps.check.outputs.authorized }} + steps: + - name: Check if user is authorized for releases + id: check + run: | + # Only allow specific users to trigger releases + AUTHORIZED_USERS="leaanthony" + + if [[ "$AUTHORIZED_USERS" == *"${{ github.actor }}"* ]]; then + echo "✅ User ${{ github.actor }} is authorized for releases" + echo "authorized=true" >> $GITHUB_OUTPUT + else + echo "❌ User ${{ github.actor }} is not authorized for releases" + echo "authorized=false" >> $GITHUB_OUTPUT + fi + + detect-v2-changes: + name: Detect v2 Changes + runs-on: ubuntu-latest + needs: check-permissions + if: needs.check-permissions.outputs.authorized == 'true' + outputs: + has_changes: ${{ steps.changes.outputs.has_changes }} + commits_since_last: ${{ steps.changes.outputs.commits_since_last }} + last_release_tag: ${{ steps.changes.outputs.last_release_tag }} + steps: + - name: Checkout code + uses: actions/checkout@v4 + with: + fetch-depth: 0 + token: ${{ secrets.GITHUB_TOKEN }} + + - name: Check for v2 changes since last release + id: changes + run: | + echo "🔍 Checking for v2 changes since last release..." + + # Find the last v2 release tag + LAST_TAG=$(git tag -l "v2.*" --sort=-version:refname | head -n 1) + if [ -z "$LAST_TAG" ]; then + echo "No previous v2 tags found, assuming first release" + LAST_TAG=$(git rev-list --max-parents=0 HEAD) + echo "has_changes=true" >> $GITHUB_OUTPUT + echo "commits_since_last=999" >> $GITHUB_OUTPUT + echo "last_release_tag=none" >> $GITHUB_OUTPUT + else + echo "Last v2 release tag: $LAST_TAG" + echo "last_release_tag=$LAST_TAG" >> $GITHUB_OUTPUT + + # Count commits since last release affecting v2 or root files + COMMITS_COUNT=$(git rev-list --count ${LAST_TAG}..HEAD -- v2/ website/ README.md CHANGELOG.md || echo "0") + echo "Commits since last v2 release: $COMMITS_COUNT" + echo "commits_since_last=$COMMITS_COUNT" >> $GITHUB_OUTPUT + + if [ "$COMMITS_COUNT" -gt 0 ] || [ "${{ github.event.inputs.force_release }}" == "true" ]; then + echo "✅ Changes detected or forced release" + echo "has_changes=true" >> $GITHUB_OUTPUT + else + echo "ℹ️ No changes detected since last release" + echo "has_changes=false" >> $GITHUB_OUTPUT + fi + fi + + detect-v3-changes: + name: Detect v3-alpha Changes + runs-on: ubuntu-latest + needs: check-permissions + if: needs.check-permissions.outputs.authorized == 'true' + outputs: + has_changes: ${{ steps.changes.outputs.has_changes }} + commits_since_last: ${{ steps.changes.outputs.commits_since_last }} + last_release_tag: ${{ steps.changes.outputs.last_release_tag }} + steps: + - name: Checkout v3-alpha branch + uses: actions/checkout@v4 + with: + ref: v3-alpha + fetch-depth: 0 + token: ${{ secrets.GITHUB_TOKEN }} + + - name: Check for v3-alpha changes since last release + id: changes + run: | + echo "🔍 Checking for v3-alpha changes since last release..." + + # Find the last v3 alpha release tag + LAST_TAG=$(git tag -l "v3.*-alpha.*" --sort=-version:refname | head -n 1) + if [ -z "$LAST_TAG" ]; then + echo "No previous v3-alpha tags found, assuming first release" + LAST_TAG=$(git rev-list --max-parents=0 HEAD) + echo "has_changes=true" >> $GITHUB_OUTPUT + echo "commits_since_last=999" >> $GITHUB_OUTPUT + echo "last_release_tag=none" >> $GITHUB_OUTPUT + else + echo "Last v3-alpha release tag: $LAST_TAG" + echo "last_release_tag=$LAST_TAG" >> $GITHUB_OUTPUT + + # Count commits since last release affecting v3 or docs + COMMITS_COUNT=$(git rev-list --count ${LAST_TAG}..HEAD -- v3/ docs/ || echo "0") + echo "Commits since last v3-alpha release: $COMMITS_COUNT" + echo "commits_since_last=$COMMITS_COUNT" >> $GITHUB_OUTPUT + + if [ "$COMMITS_COUNT" -gt 0 ] || [ "${{ github.event.inputs.force_release }}" == "true" ]; then + echo "✅ Changes detected or forced release" + echo "has_changes=true" >> $GITHUB_OUTPUT + else + echo "ℹ️ No changes detected since last release" + echo "has_changes=false" >> $GITHUB_OUTPUT + fi + fi + + release-v2: + name: Create v2 Release + runs-on: ubuntu-latest + needs: [check-permissions, detect-v2-changes] + if: | + needs.check-permissions.outputs.authorized == 'true' && + needs.detect-v2-changes.outputs.has_changes == 'true' + outputs: + version: ${{ steps.release.outputs.version }} + release_notes: ${{ steps.release.outputs.release_notes }} + steps: + - name: Checkout code + uses: actions/checkout@v4 + with: + fetch-depth: 0 + token: ${{ secrets.GITHUB_TOKEN }} + + - name: Setup Go + uses: actions/setup-go@v4 + with: + go-version: ${{ env.GO_VERSION }} + + - name: Run v2 release script and extract notes + id: release + run: | + echo "🚀 Running v2 release script..." + cd v2/tools/release + + # Run release script and capture output + RELEASE_OUTPUT=$(go run release.go 2>&1) + echo "$RELEASE_OUTPUT" + + # Extract version from output or version file + NEW_VERSION=$(cat ../../cmd/wails/internal/version.txt) + echo "version=$NEW_VERSION" >> $GITHUB_OUTPUT + + # Extract release notes from delimited output + RELEASE_NOTES=$(echo "$RELEASE_OUTPUT" | sed -n '/=== RELEASE NOTES FOR/,/=== END RELEASE NOTES ===/p' | sed '1d;$d') + + # Save release notes to file for multiline output + echo "$RELEASE_NOTES" > ../../../release_notes_v2.md + + # Set output (escape for GitHub Actions) + { + echo "release_notes<> $GITHUB_OUTPUT + + echo "✅ v2 release script completed - version: $NEW_VERSION" + + - name: Create v2 git tag and release + if: github.event.inputs.dry_run != 'true' + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + run: | + VERSION="${{ steps.release.outputs.version }}" + echo "📝 Creating v2 release: $VERSION" + + # Configure git + git config user.name "github-actions[bot]" + git config user.email "41898282+github-actions[bot]@users.noreply.github.com" + + # Commit the changelog changes + git add website/src/pages/changelog.mdx v2/cmd/wails/internal/version.txt + git commit -m "chore: release $VERSION + + Automated release created by GitHub Actions + + 🤖 Generated with [Claude Code](https://claude.ai/code) + + Co-Authored-By: Claude " + + # Create and push tag + git tag -a "$VERSION" -m "Release $VERSION" + git push origin master + git push origin "$VERSION" + + # Create GitHub release with notes + gh release create "$VERSION" \ + --title "Release $VERSION" \ + --notes-file release_notes_v2.md \ + --target master + + - name: Log dry-run results for v2 + if: github.event.inputs.dry_run == 'true' + run: | + echo "🧪 DRY RUN - Would have created v2 release:" + echo "Version: ${{ steps.release.outputs.version }}" + echo "Release Notes:" + cat release_notes_v2.md + + release-v3: + name: Create v3-alpha Release + runs-on: ubuntu-latest + needs: [check-permissions, detect-v3-changes] + if: | + needs.check-permissions.outputs.authorized == 'true' && + needs.detect-v3-changes.outputs.has_changes == 'true' + outputs: + version: ${{ steps.release.outputs.version }} + release_notes: ${{ steps.release.outputs.release_notes }} + steps: + - name: Checkout v3-alpha branch + uses: actions/checkout@v4 + with: + ref: v3-alpha + fetch-depth: 0 + token: ${{ secrets.GITHUB_TOKEN }} + + - name: Setup Go + uses: actions/setup-go@v4 + with: + go-version: ${{ env.GO_VERSION }} + + - name: Run v3 release script and extract notes + id: release + run: | + echo "🚀 Running v3-alpha release script..." + cd v3/tasks/release + + # Run release script and capture output + RELEASE_OUTPUT=$(go run release.go 2>&1) + echo "$RELEASE_OUTPUT" + + # Extract version from output or version file + NEW_VERSION=$(cat ../../internal/version/version.txt) + echo "version=$NEW_VERSION" >> $GITHUB_OUTPUT + + # Extract release notes from delimited output + RELEASE_NOTES=$(echo "$RELEASE_OUTPUT" | sed -n '/=== RELEASE NOTES FOR/,/=== END RELEASE NOTES ===/p' | sed '1d;$d') + + # Save release notes to file for multiline output + echo "$RELEASE_NOTES" > ../../../release_notes_v3.md + + # Set output (escape for GitHub Actions) + { + echo "release_notes<> $GITHUB_OUTPUT + + echo "✅ v3-alpha release script completed - version: $NEW_VERSION" + + - name: Create v3-alpha git tag and release + if: github.event.inputs.dry_run != 'true' + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + run: | + VERSION="${{ steps.release.outputs.version }}" + echo "📝 Creating v3-alpha release: $VERSION" + + # Configure git + git config user.name "github-actions[bot]" + git config user.email "41898282+github-actions[bot]@users.noreply.github.com" + + # Commit the changelog changes + git add docs/src/content/docs/changelog.mdx v3/internal/version/version.txt + git commit -m "chore: release $VERSION + + Automated v3-alpha release created by GitHub Actions + + 🤖 Generated with [Claude Code](https://claude.ai/code) + + Co-Authored-By: Claude " + + # Create and push tag + git tag -a "$VERSION" -m "Release $VERSION" + git push origin v3-alpha + git push origin "$VERSION" + + # Create GitHub release with notes + gh release create "$VERSION" \ + --title "Release $VERSION" \ + --notes-file release_notes_v3.md \ + --target v3-alpha \ + --prerelease + + - name: Log dry-run results for v3-alpha + if: github.event.inputs.dry_run == 'true' + run: | + echo "🧪 DRY RUN - Would have created v3-alpha release:" + echo "Version: ${{ steps.release.outputs.version }}" + echo "Release Notes:" + cat release_notes_v3.md + + summary: + name: Release Summary + runs-on: ubuntu-latest + needs: [check-permissions, detect-v2-changes, detect-v3-changes, release-v2, release-v3] + if: always() && needs.check-permissions.outputs.authorized == 'true' + steps: + - name: Create release summary + run: | + echo "# 🚀 Automated Release Summary" >> $GITHUB_STEP_SUMMARY + echo "" >> $GITHUB_STEP_SUMMARY + echo "**Repository**: ${{ github.repository }}" >> $GITHUB_STEP_SUMMARY + echo "**Triggered by**: ${{ github.actor }}" >> $GITHUB_STEP_SUMMARY + echo "**Dry Run Mode**: ${{ github.event.inputs.dry_run || 'false' }}" >> $GITHUB_STEP_SUMMARY + echo "" >> $GITHUB_STEP_SUMMARY + + # v2 Summary + echo "## v2 Release" >> $GITHUB_STEP_SUMMARY + if [ "${{ needs.detect-v2-changes.outputs.has_changes }}" == "true" ]; then + if [ "${{ needs.release-v2.result }}" == "success" ]; then + echo "✅ **v2 Release**: Created successfully" >> $GITHUB_STEP_SUMMARY + echo " - Version: ${{ needs.release-v2.outputs.version }}" >> $GITHUB_STEP_SUMMARY + echo " - Commits since last: ${{ needs.detect-v2-changes.outputs.commits_since_last }}" >> $GITHUB_STEP_SUMMARY + else + echo "❌ **v2 Release**: Failed" >> $GITHUB_STEP_SUMMARY + fi + else + echo "⏭️ **v2 Release**: Skipped (no changes)" >> $GITHUB_STEP_SUMMARY + echo " - Commits since last: ${{ needs.detect-v2-changes.outputs.commits_since_last }}" >> $GITHUB_STEP_SUMMARY + fi + + # v3 Summary + echo "## v3-alpha Release" >> $GITHUB_STEP_SUMMARY + if [ "${{ needs.detect-v3-changes.outputs.has_changes }}" == "true" ]; then + if [ "${{ needs.release-v3.result }}" == "success" ]; then + echo "✅ **v3-alpha Release**: Created successfully" >> $GITHUB_STEP_SUMMARY + echo " - Version: ${{ needs.release-v3.outputs.version }}" >> $GITHUB_STEP_SUMMARY + echo " - Commits since last: ${{ needs.detect-v3-changes.outputs.commits_since_last }}" >> $GITHUB_STEP_SUMMARY + else + echo "❌ **v3-alpha Release**: Failed" >> $GITHUB_STEP_SUMMARY + fi + else + echo "⏭️ **v3-alpha Release**: Skipped (no changes)" >> $GITHUB_STEP_SUMMARY + echo " - Commits since last: ${{ needs.detect-v3-changes.outputs.commits_since_last }}" >> $GITHUB_STEP_SUMMARY + fi + + echo "" >> $GITHUB_STEP_SUMMARY + echo "---" >> $GITHUB_STEP_SUMMARY + echo "🤖 **Automated Release System** | Generated with [Claude Code](https://claude.ai/code)" >> $GITHUB_STEP_SUMMARY \ No newline at end of file diff --git a/.github/workflows/build-and-test-v3.yml b/.github/workflows/build-and-test-v3.yml index bfcef85a3..0392e5abf 100644 --- a/.github/workflows/build-and-test-v3.yml +++ b/.github/workflows/build-and-test-v3.yml @@ -5,8 +5,6 @@ on: types: [opened, synchronize, reopened, ready_for_review] branches: - v3-alpha - paths: - - 'v3/**' pull_request_review: types: [submitted] branches: @@ -29,70 +27,6 @@ jobs: echo "approved=false" >> $GITHUB_OUTPUT fi - test_go: - name: Run Go Tests v3 - needs: check_approval - runs-on: ${{ matrix.os }} - if: github.base_ref == 'v3-alpha' - strategy: - fail-fast: false - matrix: - os: [windows-latest, ubuntu-latest, macos-latest] - go-version: [1.24] - - steps: - - name: Checkout code - uses: actions/checkout@v4 - - - name: Install linux dependencies - uses: awalsh128/cache-apt-pkgs-action@latest - if: matrix.os == 'ubuntu-latest' - with: - packages: libgtk-3-dev libwebkit2gtk-4.1-dev build-essential pkg-config xvfb x11-xserver-utils at-spi2-core xdg-desktop-portal-gtk - version: 1.0 - - - name: Setup Go - uses: actions/setup-go@v5 - with: - go-version: ${{ matrix.go-version }} - cache-dependency-path: "v3/go.sum" - - - name: Install Task - uses: arduino/setup-task@v2 - with: - version: 3.x - repo-token: ${{ secrets.GITHUB_TOKEN }} - - - name: Build Examples - working-directory: v3 - run: task test:examples - - - name: Run tests (mac) - if: matrix.os == 'macos-latest' - env: - CGO_LDFLAGS: -framework UniformTypeIdentifiers -mmacosx-version-min=10.13 - working-directory: v3 - run: go test -v ./... - - - name: Run tests (windows) - if: matrix.os == 'windows-latest' - working-directory: v3 - run: go test -v ./... - - - name: Run tests (ubuntu) - if: matrix.os == 'ubuntu-latest' - working-directory: v3 - run: > - xvfb-run --auto-servernum - sh -c ' - dbus-update-activation-environment --systemd --all && - go test -v ./... - ' - - - name: Typecheck binding generator output - working-directory: v3 - run: task generator:test:check - test_js: name: Run JS Tests needs: check_approval @@ -111,17 +45,172 @@ jobs: with: node-version: ${{ matrix.node-version }} - - name: Install dependencies - run: npm install - working-directory: v2/internal/frontend/runtime + - name: Install Task + uses: arduino/setup-task@v2 + with: + version: 3.x + repo-token: ${{ secrets.GITHUB_TOKEN }} - - name: Run tests - run: npm test - working-directory: v2/internal/frontend/runtime + - name: Install dependencies + working-directory: v3/internal/runtime/desktop/@wailsio/runtime + run: | + npm ci + npx --yes esbuild@latest --version + + - name: Clean build artifacts + working-directory: v3/internal/runtime/desktop/@wailsio/runtime + run: npm run clean + + - name: Type-check runtime + working-directory: v3 + run: task runtime:check + + - name: Test runtime + working-directory: v3 + run: task runtime:test + + - name: Check that the bundled runtime builds + working-directory: v3 + run: task runtime:build + + - name: Check that the npm package builds + working-directory: v3/internal/runtime/desktop/@wailsio/runtime + run: npm run build + + - name: Pack runtime for template tests + working-directory: v3/internal/runtime/desktop/@wailsio/runtime + run: npm pack + + - name: Store runtime build artifacts + uses: actions/upload-artifact@v4 + with: + name: runtime-build-artifacts + path: | + v3/internal/runtime/desktop/@wailsio/runtime/dist/ + v3/internal/runtime/desktop/@wailsio/runtime/types/ + v3/internal/runtime/desktop/@wailsio/runtime/tsconfig.tsbuildinfo + + - name: Store runtime package + uses: actions/upload-artifact@v4 + with: + name: runtime-package + path: v3/internal/runtime/desktop/@wailsio/runtime/*.tgz + + test_go: + name: Run Go Tests v3 + needs: [check_approval, test_js] + runs-on: ${{ matrix.os }} + if: github.base_ref == 'v3-alpha' + strategy: + fail-fast: false + matrix: + os: [windows-latest, ubuntu-latest, macos-latest] + go-version: [1.24] + + steps: + - name: Checkout code + uses: actions/checkout@v4 + + - name: Install linux dependencies (GTK3) + uses: awalsh128/cache-apt-pkgs-action@latest + if: matrix.os == 'ubuntu-latest' + with: + packages: libgtk-3-dev libwebkit2gtk-4.1-dev libwayland-dev build-essential pkg-config xvfb x11-xserver-utils at-spi2-core xdg-desktop-portal-gtk + version: 1.0 + + - name: Install linux dependencies (GTK4) + if: matrix.os == 'ubuntu-latest' + run: | + sudo apt-get update + sudo apt-get install -y libgtk-4-dev libwebkitgtk-6.0-dev + + - name: Setup Go + uses: actions/setup-go@v5 + with: + go-version: ${{ matrix.go-version }} + cache: true + cache-dependency-path: "v3/go.sum" + + - name: Install Task + uses: arduino/setup-task@v2 + with: + version: 3.x + repo-token: ${{ secrets.GITHUB_TOKEN }} + + - name: Retrieve runtime build artifacts + uses: actions/download-artifact@v4 + with: + name: runtime-build-artifacts + path: v3/internal/runtime/desktop/@wailsio/runtime/ + + - name: Build Examples (GTK3 default) + working-directory: v3 + run: | + echo "Starting example compilation tests (GTK3)..." + task test:examples + echo "Example compilation tests (GTK3) completed successfully" + + - name: Build Examples (GTK4) + if: matrix.os == 'ubuntu-latest' + working-directory: v3 + run: | + echo "Starting example compilation tests (GTK4)..." + BUILD_TAGS=gtk4 task test:examples + echo "Example compilation tests (GTK4) completed successfully" + + - name: Run tests (mac) + if: matrix.os == 'macos-latest' + env: + CGO_LDFLAGS: -framework UniformTypeIdentifiers -mmacosx-version-min=10.13 + working-directory: v3 + run: go test -v ./... + + - name: Run tests (windows) + if: matrix.os == 'windows-latest' + working-directory: v3 + run: go test -v ./... + + - name: Run tests (ubuntu) - GTK3 default + if: matrix.os == 'ubuntu-latest' + working-directory: v3 + run: > + xvfb-run --auto-servernum + sh -c ' + dbus-update-activation-environment --systemd --all && + go test -v ./... + ' + + - name: Run tests (ubuntu) - GTK4 + if: matrix.os == 'ubuntu-latest' + working-directory: v3 + # Skip service tests that hang in CI due to GTK4 display requirements + run: > + xvfb-run --auto-servernum + sh -c ' + dbus-update-activation-environment --systemd --all && + go test -tags gtk4 -v -skip "TestService" ./... + ' + + - name: Typecheck binding generator output + working-directory: v3 + run: task generator:test:check + + cleanup: + name: Cleanup build artifacts + if: always() + needs: [test_js, test_go, test_templates] + runs-on: ubuntu-latest + steps: + - uses: geekyeggo/delete-artifact@v5 + with: + name: | + runtime-build-artifacts + runtime-package + failOnError: false test_templates: name: Test Templates - needs: test_go + needs: [test_js, test_go] runs-on: ${{ matrix.os }} if: github.base_ref == 'v3-alpha' strategy: @@ -146,17 +235,24 @@ jobs: - name: Checkout uses: actions/checkout@v4 - - name: Install linux dependencies + - name: Install linux dependencies (GTK3) uses: awalsh128/cache-apt-pkgs-action@latest if: matrix.os == 'ubuntu-latest' with: - packages: libgtk-3-dev libwebkit2gtk-4.1-dev build-essential pkg-config + packages: libgtk-3-dev libwebkit2gtk-4.1-dev libwayland-dev build-essential pkg-config version: 1.0 + - name: Install linux dependencies (GTK4) + if: matrix.os == 'ubuntu-latest' + run: | + sudo apt-get update + sudo apt-get install -y libgtk-4-dev libwebkitgtk-6.0-dev + - name: Setup Go uses: actions/setup-go@v5 with: go-version: ${{ matrix.go-version }} + cache: true cache-dependency-path: "v3/go.sum" - name: Install Task @@ -171,14 +267,32 @@ jobs: task install wails3 doctor - - name: Generate template '${{ matrix.template }}' + - name: Download runtime package + uses: actions/download-artifact@v4 + with: + name: runtime-package + path: wails-runtime-temp + + - name: Generate template '${{ matrix.template }}' (GTK3 default) + shell: bash run: | + # Get absolute path - use pwd -W on Windows for native paths, pwd elsewhere + if [[ "$RUNNER_OS" == "Windows" ]]; then + RUNTIME_TGZ="$(cd wails-runtime-temp && pwd -W)/$(ls wails-runtime-temp/*.tgz | xargs basename)" + else + RUNTIME_TGZ="$(cd wails-runtime-temp && pwd)/$(ls wails-runtime-temp/*.tgz | xargs basename)" + fi mkdir -p ./test-${{ matrix.template }} cd ./test-${{ matrix.template }} wails3 init -n ${{ matrix.template }} -t ${{ matrix.template }} - cd ${{ matrix.template }} + cd ${{ matrix.template }}/frontend + # Replace @wailsio/runtime version with local tarball + npm pkg set dependencies.@wailsio/runtime="file://$RUNTIME_TGZ" + cd .. wails3 build + # GTK4 template builds are covered by the Go example compilation tests above. + build_results: if: ${{ always() }} runs-on: ubuntu-latest diff --git a/.github/workflows/build-and-test.yml b/.github/workflows/build-and-test.yml index 8fe647c6f..a6ee1a0bb 100644 --- a/.github/workflows/build-and-test.yml +++ b/.github/workflows/build-and-test.yml @@ -12,8 +12,8 @@ jobs: runs-on: ${{ matrix.os }} strategy: matrix: - os: [ubuntu-22.04, ubuntu-24.04, windows-latest, macos-latest] - go-version: ['1.22'] + os: [ubuntu-22.04, ubuntu-24.04, windows-latest, macos-latest, macos-11] + go-version: ['1.21'] steps: - name: Checkout code @@ -28,7 +28,7 @@ jobs: - uses: awalsh128/cache-apt-pkgs-action@latest if: matrix.os == 'ubuntu-24.04' with: - packages: libgtk-3-dev libwebkit2gtk-4.1-dev build-essential pkg-config libegl1 + packages: libgtk-3-dev libwebkit2gtk-4.1-dev libwayland-dev build-essential pkg-config version: 1.0 - name: Setup Go @@ -38,14 +38,14 @@ jobs: cache-dependency-path: ./v2/go.sum - name: Run tests (mac) - if: matrix.os == 'macos-latest' + if: matrix.os == 'macos-latest' || matrix.os == 'macos-11' env: CGO_LDFLAGS: -framework UniformTypeIdentifiers -mmacosx-version-min=10.13 working-directory: ./v2 run: go test -v ./... - name: Run tests (!mac) - if: matrix.os != 'macos-latest' && matrix.os != 'ubuntu-24.04' + if: matrix.os != 'macos-latest' && matrix.os != 'macos-11' && matrix.os != 'ubuntu-24.04' working-directory: ./v2 run: go test -v ./... @@ -86,7 +86,7 @@ jobs: strategy: fail-fast: true matrix: - os: [ubuntu-22.04, windows-latest, macos-latest, ubuntu-24.04] + os: [ubuntu-22.04, windows-latest, macos-latest, ubuntu-24.04, macos-11] template: [ svelte, @@ -103,13 +103,13 @@ jobs: vanilla-ts, plain, ] - go-version: ['1.22'] + go-version: ['1.21'] steps: - name: Checkout uses: actions/checkout@v4 - name: Setup Go - uses: actions/setup-go@v5 + uses: actions/setup-go@v4 with: go-version: ${{ matrix.go-version }} cache-dependency-path: ./v2/go.sum @@ -120,25 +120,13 @@ jobs: go install wails -help - - uses: awalsh128/cache-apt-pkgs-action@latest + - name: Install linux dependencies ( 22.04 ) if: matrix.os == 'ubuntu-22.04' - with: - packages: libgtk-3-dev libwebkit2gtk-4.0-dev build-essential pkg-config - version: 1.0 + run: sudo apt-get update -y && sudo apt-get install -y libgtk-3-dev libwebkit2gtk-4.0-dev build-essential pkg-config -# - name: Install linux dependencies ( 22.04 ) -# if: matrix.os == 'ubuntu-22.04' -# run: sudo apt-get update -y && sudo apt-get install -y libgtk-3-dev libwebkit2gtk-4.0-dev build-essential pkg-config - - - uses: awalsh128/cache-apt-pkgs-action@latest + - name: Install linux dependencies ( 24.04 ) if: matrix.os == 'ubuntu-24.04' - with: - packages: libgtk-3-dev libwebkit2gtk-4.1-dev build-essential pkg-config libegl1 - version: 1.0 - -# - name: Install linux dependencies ( 24.04 ) -# if: matrix.os == 'ubuntu-24.04' -# run: sudo apt-get update -y && sudo apt-get install -y libgtk-3-dev libwebkit2gtk-4.1-dev build-essential pkg-config + run: sudo apt-get update -y && sudo apt-get install -y libgtk-3-dev libwebkit2gtk-4.1-dev libwayland-dev build-essential pkg-config - name: Generate & Build template '${{ matrix.template }}' if: matrix.os != 'ubuntu-24.04' diff --git a/.github/workflows/build-cross-image.yml b/.github/workflows/build-cross-image.yml index 83b40f2be..1af95a59b 100644 --- a/.github/workflows/build-cross-image.yml +++ b/.github/workflows/build-cross-image.yml @@ -94,10 +94,18 @@ jobs: build-args: | ZIG_VERSION=${{ steps.vars.outputs.zig_version }} MACOS_SDK_VERSION=${{ steps.vars.outputs.sdk_version }} - cache-from: type=gha - cache-to: type=gha,mode=max + cache-from: | + type=gha + type=registry,ref=${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}:buildcache + cache-to: | + type=gha,mode=max + type=registry,ref=${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}:buildcache,mode=max - # Test cross-compilation for all platforms + # Test cross-compilation using wails3 task system (3 parallel jobs) + # Runs on Linux/amd64 runner - tests actual cross-compilation only: + # - darwin: cross-platform (arm64) + # - windows: cross-platform (arm64) + # - linux: cross-architecture (arm64 from amd64 runner) test-cross-compile: needs: build if: ${{ inputs.skip_tests != 'true' }} @@ -106,33 +114,24 @@ jobs: fail-fast: false matrix: include: - # Darwin targets (Zig + macOS SDK) - no platform emulation needed + # Darwin arm64 (Intel Macs are EOL, skip amd64) - os: darwin arch: arm64 - platform: "" - expected_file: "Mach-O 64-bit.*arm64" - - os: darwin - arch: amd64 - platform: "" - expected_file: "Mach-O 64-bit.*x86_64" - # Linux targets (GCC) - need platform to match architecture - - os: linux - arch: amd64 - platform: "linux/amd64" - expected_file: "ELF 64-bit LSB.*x86-64" - - os: linux - arch: arm64 - platform: "linux/arm64" - expected_file: "ELF 64-bit LSB.*ARM aarch64" - # Windows targets (Zig + mingw) - no platform emulation needed + expected: "Mach-O 64-bit.*arm64" + # Windows - both archs - os: windows arch: amd64 - platform: "" - expected_file: "PE32\\+ executable.*x86-64" + expected: "PE32.*x86-64" - os: windows arch: arm64 - platform: "" - expected_file: "PE32\\+ executable.*Aarch64" + expected: "PE32.*Aarch64" + # Linux - both archs via Docker + - os: linux + arch: amd64 + expected: "ELF 64-bit LSB.*x86-64" + - os: linux + arch: arm64 + expected: "ELF 64-bit LSB.*ARM aarch64" steps: - name: Checkout @@ -140,8 +139,29 @@ jobs: with: ref: ${{ inputs.branch || github.ref }} + - name: Set up Go + uses: actions/setup-go@v5 + with: + go-version: '1.24' + cache: false + + - name: Set up Node.js + uses: actions/setup-node@v4 + with: + node-version: '20' + + - name: Install Linux dev dependencies + run: | + sudo apt-get update + sudo apt-get install -y libgtk-3-dev libwebkit2gtk-4.1-dev libwayland-dev + + - name: Install wails3 CLI + run: | + cd v3 + go install ./cmd/wails3 + - name: Set up QEMU - if: matrix.platform != '' + if: matrix.os == 'linux' uses: docker/setup-qemu-action@v3 - name: Log in to Container Registry @@ -151,95 +171,74 @@ jobs: username: ${{ github.actor }} password: ${{ secrets.GITHUB_TOKEN }} - - name: Create test CGO project + - name: Pull and tag Docker image run: | - mkdir -p test-project - cd test-project + # Pull both platform variants and tag them for the task system + # The task uses --platform flag which requires matching arch variant + IMAGE="${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}:${{ needs.build.outputs.image_tag || 'latest' }}" - # Create a minimal CGO test program - cat > main.go << 'EOF' - package main - - /* - #include - - int add(int a, int b) { - return a + b; - } - */ - import "C" - import "fmt" - - func main() { - result := C.add(1, 2) - fmt.Printf("CGO test: 1 + 2 = %d\n", result) - } - EOF - - cat > go.mod << 'EOF' - module test-cgo - - go 1.21 - EOF - - - name: Build ${{ matrix.os }}/${{ matrix.arch }} (CGO) - run: | - cd test-project - PLATFORM_FLAG="" - if [ -n "${{ matrix.platform }}" ]; then - PLATFORM_FLAG="--platform ${{ matrix.platform }}" + # For Linux arm64 test, we need the arm64 variant + if [ "${{ matrix.os }}" = "linux" ] && [ "${{ matrix.arch }}" = "arm64" ]; then + docker pull --platform linux/arm64 "$IMAGE" + docker tag "$IMAGE" wails-cross + else + docker pull "$IMAGE" + docker tag "$IMAGE" wails-cross fi - docker run --rm $PLATFORM_FLAG \ - -v "$(pwd):/app" \ - -e APP_NAME="test-cgo" \ - ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}:${{ needs.build.outputs.image_tag || 'latest' }} \ - ${{ matrix.os }} ${{ matrix.arch }} - - - name: Verify binary format + - name: Generate wails3 test project run: | - cd test-project/bin + cd /tmp + wails3 init -n test-wails-app -t vanilla + cd test-wails-app + + # Update replace directive to use absolute path (wails3 init adds relative path) + sed -i 's|replace github.com/wailsapp/wails/v3 => .*|replace github.com/wailsapp/wails/v3 => ${{ github.workspace }}/v3|' go.mod + + - name: Cross-compile ${{ matrix.os }}/${{ matrix.arch }} via task + run: | + cd /tmp/test-wails-app + # For Linux, always use docker build to test the Docker image + if [ "${{ matrix.os }}" = "linux" ]; then + wails3 task linux:build:docker ARCH=${{ matrix.arch }} + else + wails3 task ${{ matrix.os }}:build ARCH=${{ matrix.arch }} + fi + + - name: Verify binary + run: | + cd /tmp/test-wails-app/bin ls -la - # Find the built binary if [ "${{ matrix.os }}" = "windows" ]; then - BINARY=$(ls test-cgo-${{ matrix.os }}-${{ matrix.arch }}.exe 2>/dev/null || ls *.exe | head -1) + BINARY="test-wails-app.exe" else - BINARY=$(ls test-cgo-${{ matrix.os }}-${{ matrix.arch }} 2>/dev/null || ls test-cgo* | grep -v '.exe' | head -1) + BINARY="test-wails-app" fi - echo "Binary: $BINARY" + echo "Checking: $BINARY" FILE_OUTPUT=$(file "$BINARY") - echo "File output: $FILE_OUTPUT" + echo " $FILE_OUTPUT" - # Verify the binary format matches expected - if echo "$FILE_OUTPUT" | grep -qE "${{ matrix.expected_file }}"; then - echo "✅ Binary format verified: ${{ matrix.os }}/${{ matrix.arch }}" + if echo "$FILE_OUTPUT" | grep -qE "${{ matrix.expected }}"; then + echo " ✅ Cross-compilation verified: ${{ matrix.os }}/${{ matrix.arch }}" else - echo "❌ Binary format mismatch!" - echo "Expected pattern: ${{ matrix.expected_file }}" - echo "Got: $FILE_OUTPUT" + echo " ❌ Format mismatch! Expected: ${{ matrix.expected }}" exit 1 fi - name: Check library dependencies (Linux only) if: matrix.os == 'linux' run: | - cd test-project/bin - BINARY=$(ls test-cgo-${{ matrix.os }}-${{ matrix.arch }} 2>/dev/null || ls test-cgo* | grep -v '.exe' | head -1) + cd /tmp/test-wails-app/bin - echo "## Library Dependencies for $BINARY" + echo "## Library Dependencies" echo "" - - # Use readelf to show dynamic dependencies echo "### NEEDED libraries:" - readelf -d "$BINARY" | grep NEEDED || echo "No dynamic dependencies (statically linked)" - - # Verify expected libraries are linked + readelf -d test-wails-app | grep NEEDED || echo "No dynamic dependencies" echo "" - echo "### Verifying required libraries..." - NEEDED=$(readelf -d "$BINARY" | grep NEEDED) + NEEDED=$(readelf -d test-wails-app | grep NEEDED) MISSING="" for lib in libwebkit2gtk-4.1.so libgtk-3.so libglib-2.0.so libc.so; do if echo "$NEEDED" | grep -q "$lib"; then @@ -251,139 +250,13 @@ jobs: done if [ -n "$MISSING" ]; then - echo "" echo "ERROR: Missing required libraries:$MISSING" exit 1 fi - # Test non-CGO builds (pure Go cross-compilation) - test-non-cgo: - needs: build - if: ${{ inputs.skip_tests != 'true' }} - runs-on: ubuntu-latest - strategy: - fail-fast: false - matrix: - include: - - os: darwin - arch: arm64 - expected_file: "Mach-O 64-bit.*arm64" - - os: darwin - arch: amd64 - expected_file: "Mach-O 64-bit.*x86_64" - - os: linux - arch: amd64 - expected_file: "ELF 64-bit LSB" - - os: linux - arch: arm64 - expected_file: "ELF 64-bit LSB.*ARM aarch64" - - os: windows - arch: amd64 - expected_file: "PE32\\+ executable.*x86-64" - - os: windows - arch: arm64 - expected_file: "PE32\\+ executable.*Aarch64" - - steps: - - name: Checkout - uses: actions/checkout@v4 - with: - ref: ${{ inputs.branch || github.ref }} - - - name: Log in to Container Registry - uses: docker/login-action@v3 - with: - registry: ${{ env.REGISTRY }} - username: ${{ github.actor }} - password: ${{ secrets.GITHUB_TOKEN }} - - - name: Create test non-CGO project - run: | - mkdir -p test-project - cd test-project - - # Create a pure Go test program (no CGO) - cat > main.go << 'EOF' - package main - - import "fmt" - - func main() { - fmt.Println("Pure Go cross-compilation test") - } - EOF - - cat > go.mod << 'EOF' - module test-pure-go - - go 1.21 - EOF - - - name: Build ${{ matrix.os }}/${{ matrix.arch }} (non-CGO) - run: | - cd test-project - - # For non-CGO, we can use any platform since Go handles cross-compilation - # We set CGO_ENABLED=0 to ensure pure Go build - docker run --rm \ - -v "$(pwd):/app" \ - -e APP_NAME="test-pure-go" \ - -e CGO_ENABLED=0 \ - --entrypoint /bin/sh \ - ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}:${{ needs.build.outputs.image_tag || 'latest' }} \ - -c "GOOS=${{ matrix.os }} GOARCH=${{ matrix.arch }} go build -o bin/test-pure-go-${{ matrix.os }}-${{ matrix.arch }}${{ matrix.os == 'windows' && '.exe' || '' }} ." - - - name: Verify binary format - run: | - cd test-project/bin - ls -la - - # Find the built binary - if [ "${{ matrix.os }}" = "windows" ]; then - BINARY="test-pure-go-${{ matrix.os }}-${{ matrix.arch }}.exe" - else - BINARY="test-pure-go-${{ matrix.os }}-${{ matrix.arch }}" - fi - - echo "Binary: $BINARY" - FILE_OUTPUT=$(file "$BINARY") - echo "File output: $FILE_OUTPUT" - - # Verify the binary format matches expected - if echo "$FILE_OUTPUT" | grep -qE "${{ matrix.expected_file }}"; then - echo "✅ Binary format verified: ${{ matrix.os }}/${{ matrix.arch }} (non-CGO)" - else - echo "❌ Binary format mismatch!" - echo "Expected pattern: ${{ matrix.expected_file }}" - echo "Got: $FILE_OUTPUT" - exit 1 - fi - - - name: Check library dependencies (Linux only) - if: matrix.os == 'linux' - run: | - cd test-project/bin - BINARY="test-pure-go-${{ matrix.os }}-${{ matrix.arch }}" - - echo "## Library Dependencies for $BINARY (non-CGO)" - echo "" - - # Non-CGO builds should have minimal dependencies (just libc or statically linked) - echo "### NEEDED libraries:" - readelf -d "$BINARY" | grep NEEDED || echo "No dynamic dependencies (statically linked)" - - # Verify NO GTK/WebKit libraries (since CGO is disabled) - NEEDED=$(readelf -d "$BINARY" | grep NEEDED || true) - if echo "$NEEDED" | grep -q "libwebkit\|libgtk"; then - echo "❌ ERROR: Non-CGO binary should not link to GTK/WebKit!" - exit 1 - else - echo "✅ Confirmed: No GTK/WebKit dependencies (expected for non-CGO)" - fi - # Summary job test-summary: - needs: [build, test-cross-compile, test-non-cgo] + needs: [build, test-cross-compile] if: always() && inputs.skip_tests != 'true' runs-on: ubuntu-latest steps: @@ -393,30 +266,23 @@ jobs: echo "" >> $GITHUB_STEP_SUMMARY if [ "${{ needs.test-cross-compile.result }}" = "success" ]; then - echo "✅ **CGO Tests**: All passed" >> $GITHUB_STEP_SUMMARY + echo "✅ **All Tests Passed**" >> $GITHUB_STEP_SUMMARY else - echo "❌ **CGO Tests**: Failed" >> $GITHUB_STEP_SUMMARY - fi - - if [ "${{ needs.test-non-cgo.result }}" = "success" ]; then - echo "✅ **Non-CGO Tests**: All passed" >> $GITHUB_STEP_SUMMARY - else - echo "❌ **Non-CGO Tests**: Failed" >> $GITHUB_STEP_SUMMARY + echo "❌ **Some Tests Failed**" >> $GITHUB_STEP_SUMMARY fi echo "" >> $GITHUB_STEP_SUMMARY - echo "### Tested Platforms" >> $GITHUB_STEP_SUMMARY - echo "| Platform | Architecture | CGO | Non-CGO |" >> $GITHUB_STEP_SUMMARY - echo "|----------|-------------|-----|---------|" >> $GITHUB_STEP_SUMMARY - echo "| Darwin | arm64 | ✅ | ✅ |" >> $GITHUB_STEP_SUMMARY - echo "| Darwin | amd64 | ✅ | ✅ |" >> $GITHUB_STEP_SUMMARY - echo "| Linux | arm64 | ✅ | ✅ |" >> $GITHUB_STEP_SUMMARY - echo "| Linux | amd64 | ✅ | ✅ |" >> $GITHUB_STEP_SUMMARY - echo "| Windows | arm64 | ✅ | ✅ |" >> $GITHUB_STEP_SUMMARY - echo "| Windows | amd64 | ✅ | ✅ |" >> $GITHUB_STEP_SUMMARY + echo "### Cross-Compilation Tests (from Linux/amd64 runner)" >> $GITHUB_STEP_SUMMARY + echo "| Target | Status |" >> $GITHUB_STEP_SUMMARY + echo "|--------|--------|" >> $GITHUB_STEP_SUMMARY + echo "| Darwin/arm64 | ✅ |" >> $GITHUB_STEP_SUMMARY + echo "| Windows/amd64 | ✅ |" >> $GITHUB_STEP_SUMMARY + echo "| Windows/arm64 | ✅ |" >> $GITHUB_STEP_SUMMARY + echo "| Linux/amd64 | ✅ |" >> $GITHUB_STEP_SUMMARY + echo "| Linux/arm64 | ✅ |" >> $GITHUB_STEP_SUMMARY # Fail if any test failed - if [ "${{ needs.test-cross-compile.result }}" != "success" ] || [ "${{ needs.test-non-cgo.result }}" != "success" ]; then + if [ "${{ needs.test-cross-compile.result }}" != "success" ]; then echo "" echo "❌ Some tests failed. Check the individual job logs for details." exit 1 diff --git a/.github/workflows/changelog-v3.yml b/.github/workflows/changelog-v3.yml deleted file mode 100644 index 688959b9e..000000000 --- a/.github/workflows/changelog-v3.yml +++ /dev/null @@ -1,216 +0,0 @@ -name: Changelog Validation (v3) - -on: - pull_request: - branches: [ v3-alpha ] - paths: - - 'docs/src/content/docs/changelog.mdx' - workflow_dispatch: - inputs: - pr_number: - description: 'PR number to validate' - required: true - type: string - -jobs: - validate: - runs-on: ubuntu-latest - permissions: - contents: write - pull-requests: write - actions: write - - steps: - - name: Checkout PR code - uses: actions/checkout@v4 - with: - ref: ${{ github.event.pull_request.head.sha || format('refs/pull/{0}/head', github.event.inputs.pr_number) }} - fetch-depth: 0 - token: ${{ secrets.GITHUB_TOKEN || github.token }} - - - name: Get REAL validation script from v3-alpha - run: | - echo "Fetching the REAL validation script from v3-alpha branch..." - git fetch origin v3-alpha - git checkout origin/v3-alpha -- v3/scripts/validate-changelog.go - - echo "Validation script fetched successfully:" - ls -la v3/scripts/ - - - name: Setup Go - uses: actions/setup-go@v4 - with: - go-version: '1.23' - - - name: Get PR information - id: pr_info - run: | - if [ "${{ github.event_name }}" = "pull_request" ]; then - echo "pr_number=${{ github.event.pull_request.number }}" >> $GITHUB_OUTPUT - echo "base_ref=${{ github.event.pull_request.base.ref }}" >> $GITHUB_OUTPUT - else - echo "pr_number=${{ github.event.inputs.pr_number }}" >> $GITHUB_OUTPUT - echo "base_ref=v3-alpha" >> $GITHUB_OUTPUT - fi - - - name: Check changelog modifications - id: changelog_check - run: | - echo "Checking PR #${{ steps.pr_info.outputs.pr_number }} for changelog changes" - git fetch origin ${{ steps.pr_info.outputs.base_ref }} - - if git diff --name-only origin/${{ steps.pr_info.outputs.base_ref }}..HEAD | grep -q "docs/src/content/docs/changelog.mdx"; then - echo "changelog_modified=true" >> $GITHUB_OUTPUT - echo "✅ Changelog was modified in this PR" - else - echo "changelog_modified=false" >> $GITHUB_OUTPUT - echo "ℹ️ Changelog was not modified - skipping validation" - fi - - - name: Get changelog diff - id: get_diff - if: steps.changelog_check.outputs.changelog_modified == 'true' - run: | - echo "Getting diff for changelog changes..." - git diff origin/${{ steps.pr_info.outputs.base_ref }}..HEAD docs/src/content/docs/changelog.mdx | grep "^+" | grep -v "^+++" | sed 's/^+//' > /tmp/pr_added_lines.txt - - echo "Lines added in this PR:" - cat /tmp/pr_added_lines.txt - echo "Total lines added: $(wc -l < /tmp/pr_added_lines.txt)" - - - name: Validate changelog - id: validate - if: steps.changelog_check.outputs.changelog_modified == 'true' - run: | - echo "Running changelog validation..." - cd v3/scripts - OUTPUT=$(go run validate-changelog.go ../../docs/src/content/docs/changelog.mdx /tmp/pr_added_lines.txt 2>&1) - echo "$OUTPUT" - - RESULT=$(echo "$OUTPUT" | grep "VALIDATION_RESULT=" | cut -d'=' -f2) - echo "result=$RESULT" >> $GITHUB_OUTPUT - - - name: Commit fixes - id: commit_fixes - if: steps.validate.outputs.result == 'fixed' - run: | - echo "Committing automatic fixes..." - git config --local user.email "action@github.com" - git config --local user.name "GitHub Action" - - # Check only the changelog file for changes - if git diff --quiet docs/src/content/docs/changelog.mdx; then - echo "No changes to commit" - echo "committed=false" >> $GITHUB_OUTPUT - else - # Ensure validation script doesn't get committed - echo "v3/scripts/validate-changelog.go" >> .git/info/exclude - # Get the correct branch name to push to - REPO_OWNER="wailsapp" # Always wailsapp for this repo - - if [ "${{ github.event_name }}" = "pull_request" ]; then - BRANCH_NAME="${{ github.event.pull_request.head.ref }}" - else - # For manual workflow dispatch, get PR info - PR_INFO=$(gh pr view ${{ steps.pr_info.outputs.pr_number }} --json headRefName,headRepository) - BRANCH_NAME=$(echo "$PR_INFO" | jq -r '.headRefName') - HEAD_REPO=$(echo "$PR_INFO" | jq -r '.headRepository.name') - - echo "🔍 PR source branch: $BRANCH_NAME" - echo "🔍 Head repository: $HEAD_REPO" - - # Don't push if this is from a fork or if branch is v3-alpha (main branch) - if [ "$HEAD_REPO" != "wails" ] || [ "$BRANCH_NAME" = "v3-alpha" ]; then - echo "⚠️ Cannot push - either fork or direct v3-alpha branch. Manual fix required." - echo "committed=false" >> $GITHUB_OUTPUT - exit 0 - fi - fi - - echo "Pushing to branch: $BRANCH_NAME in repo: $REPO_OWNER" - - # Only commit the changelog changes, not the validation script - git add docs/src/content/docs/changelog.mdx - git commit -m "🤖 Fix changelog: move entries to Unreleased section" - - # Only push if running on the main wailsapp repository - if [ "${{ github.repository }}" = "wailsapp/wails" ]; then - # Pull latest changes and rebase our commit - git fetch origin $BRANCH_NAME - git rebase origin/$BRANCH_NAME - git push origin HEAD:$BRANCH_NAME - else - echo "⚠️ Running on fork (${{ github.repository }}). Skipping push - manual fix required." - echo "committed=false" >> $GITHUB_OUTPUT - exit 0 - fi - - echo "committed=true" >> $GITHUB_OUTPUT - echo "✅ Changes committed and pushed" - fi - env: - GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} - - - name: Get PR author for tagging - id: pr_author - if: steps.validate.outputs.result && github.event.inputs.pr_number - run: | - PR_AUTHOR=$(gh pr view ${{ steps.pr_info.outputs.pr_number }} --json author --jq '.author.login') - echo "author=$PR_AUTHOR" >> $GITHUB_OUTPUT - env: - GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} - - - name: Comment on PR - if: steps.validate.outputs.result && github.event.inputs.pr_number - uses: actions/github-script@v7 - with: - script: | - const result = '${{ steps.validate.outputs.result }}'; - const committed = '${{ steps.commit_fixes.outputs.committed }}'; - const author = '${{ steps.pr_author.outputs.author }}'; - - let message; - if (result === 'success') { - message = '## ✅ Changelog Validation Passed\n\nNo misplaced changelog entries detected.'; - } else if (result === 'fixed' && committed === 'true') { - message = '## 🔧 Changelog Updated\n\nMisplaced entries were automatically moved to the `[Unreleased]` section. The changes have been committed to this PR.'; - } else if (result === 'fixed' || result === 'cannot_fix' || result === 'error') { - // Read the fixed changelog content - const fs = require('fs'); - let fixedContent = ''; - try { - fixedContent = fs.readFileSync('docs/src/content/docs/changelog.mdx', 'utf8'); - } catch (error) { - fixedContent = 'Error reading fixed changelog content'; - } - - message = '## ⚠️ Changelog Validation Issue\\n\\n' + - '@' + author + ' Your PR contains changelog entries that were added to already-released versions. These need to be moved to the `[Unreleased]` section.\\n\\n' + - (committed === 'true' ? - '✅ **Auto-fix applied**: The changes have been automatically committed to this PR.' : - '❌ **Manual fix required**: Please apply the changes shown below manually.') + '\\n\\n' + - '
\\n' + - '📝 Click to see the corrected changelog content\\n\\n' + - '```mdx\\n' + - fixedContent + - '\\n```\\n\\n' + - '
\\n\\n' + - '**What happened?** \\n' + - 'The validation script detected that you added changelog entries to a version section that has already been released (like `v3.0.0-alpha.10`). All new entries should go in the `[Unreleased]` section under the appropriate category (`### Added`, `### Fixed`, etc.).\\n\\n' + - (committed !== 'true' ? '**Action needed:** Please copy the corrected content from above and replace your changelog file.' : ''); - } - - if (message) { - await github.rest.issues.createComment({ - issue_number: ${{ steps.pr_info.outputs.pr_number }}, - owner: context.repo.owner, - repo: context.repo.repo, - body: message - }); - } - - - name: Fail if validation failed - if: steps.validate.outputs.result == 'cannot_fix' || steps.validate.outputs.result == 'error' - run: | - echo "❌ Changelog validation failed" - exit 1 \ No newline at end of file diff --git a/.github/workflows/changelog-validation-v3.yml b/.github/workflows/changelog-validation-v3.yml new file mode 100644 index 000000000..8d4b97726 --- /dev/null +++ b/.github/workflows/changelog-validation-v3.yml @@ -0,0 +1,74 @@ +name: Changelog Validation (v3) + +on: + pull_request: + branches: [ v3-alpha ] + workflow_dispatch: + inputs: + pr_number: + description: 'PR number to validate (for manual testing)' + required: true + type: string + +jobs: + validate-changelog: + runs-on: ubuntu-latest + if: github.event_name == 'pull_request' || github.event.inputs.pr_number + + permissions: + contents: write + pull-requests: write + + steps: + - name: Checkout code + uses: actions/checkout@v4 + with: + ref: ${{ github.event.pull_request.head.sha || format('refs/pull/{0}/head', github.event.inputs.pr_number) }} + fetch-depth: 0 + token: ${{ secrets.GITHUB_TOKEN }} + + - name: Setup Go + uses: actions/setup-go@v4 + with: + go-version: '1.23' + + - name: Get PR information + id: pr_info + run: | + if [ "${{ github.event_name }}" = "pull_request" ]; then + echo "pr_number=${{ github.event.pull_request.number }}" >> $GITHUB_OUTPUT + echo "base_ref=${{ github.event.pull_request.base.ref }}" >> $GITHUB_OUTPUT + else + echo "pr_number=${{ github.event.inputs.pr_number }}" >> $GITHUB_OUTPUT + echo "base_ref=v3-alpha" >> $GITHUB_OUTPUT + fi + + - name: Check if changelog was modified + id: changelog_check + run: | + git fetch origin ${{ steps.pr_info.outputs.base_ref }} + if git diff --name-only origin/${{ steps.pr_info.outputs.base_ref }}..HEAD | grep -q "v3/UNRELEASED_CHANGELOG.md"; then + echo "changelog_modified=true" >> $GITHUB_OUTPUT + echo "✅ UNRELEASED_CHANGELOG.md was modified in this PR" + else + echo "changelog_modified=false" >> $GITHUB_OUTPUT + echo "⚠️ UNRELEASED_CHANGELOG.md was not modified" + fi + + - name: Comment on PR about missing changelog + if: steps.changelog_check.outputs.changelog_modified == 'false' && github.event_name == 'pull_request' + uses: actions/github-script@v7 + with: + script: | + const author = context.payload.pull_request.user.login; + const message = '## ⚠️ Missing Changelog Update\n\n' + + `Hi @${author}, please update \`v3/UNRELEASED_CHANGELOG.md\` with a description of your changes.\n\n` + + 'This helps us keep track of changes for the next release.'; + + await github.rest.issues.createComment({ + issue_number: ${{ steps.pr_info.outputs.pr_number }}, + owner: context.repo.owner, + repo: context.repo.repo, + body: message + }); + diff --git a/.github/workflows/claude-code-review.yml b/.github/workflows/claude-code-review.yml deleted file mode 100644 index b5e8cfd4d..000000000 --- a/.github/workflows/claude-code-review.yml +++ /dev/null @@ -1,44 +0,0 @@ -name: Claude Code Review - -on: - pull_request: - types: [opened, synchronize, ready_for_review, reopened] - # Optional: Only run on specific file changes - # paths: - # - "src/**/*.ts" - # - "src/**/*.tsx" - # - "src/**/*.js" - # - "src/**/*.jsx" - -jobs: - claude-review: - # Optional: Filter by PR author - # if: | - # github.event.pull_request.user.login == 'external-contributor' || - # github.event.pull_request.user.login == 'new-developer' || - # github.event.pull_request.author_association == 'FIRST_TIME_CONTRIBUTOR' - - runs-on: ubuntu-latest - permissions: - contents: read - pull-requests: read - issues: read - id-token: write - - steps: - - name: Checkout repository - uses: actions/checkout@v4 - with: - fetch-depth: 1 - - - name: Run Claude Code Review - id: claude-review - uses: anthropics/claude-code-action@v1 - with: - claude_code_oauth_token: ${{ secrets.CLAUDE_CODE_OAUTH_TOKEN }} - plugin_marketplaces: 'https://github.com/anthropics/claude-code.git' - plugins: 'code-review@claude-code-plugins' - prompt: '/code-review:code-review ${{ github.repository }}/pull/${{ github.event.pull_request.number }}' - # See https://github.com/anthropics/claude-code-action/blob/main/docs/usage.md - # or https://code.claude.com/docs/en/cli-reference for available options - diff --git a/.github/workflows/claude.yml b/.github/workflows/claude.yml deleted file mode 100644 index d300267f1..000000000 --- a/.github/workflows/claude.yml +++ /dev/null @@ -1,50 +0,0 @@ -name: Claude Code - -on: - issue_comment: - types: [created] - pull_request_review_comment: - types: [created] - issues: - types: [opened, assigned] - pull_request_review: - types: [submitted] - -jobs: - claude: - if: | - (github.event_name == 'issue_comment' && contains(github.event.comment.body, '@claude')) || - (github.event_name == 'pull_request_review_comment' && contains(github.event.comment.body, '@claude')) || - (github.event_name == 'pull_request_review' && contains(github.event.review.body, '@claude')) || - (github.event_name == 'issues' && (contains(github.event.issue.body, '@claude') || contains(github.event.issue.title, '@claude'))) - runs-on: ubuntu-latest - permissions: - contents: read - pull-requests: read - issues: read - id-token: write - actions: read # Required for Claude to read CI results on PRs - steps: - - name: Checkout repository - uses: actions/checkout@v4 - with: - fetch-depth: 1 - - - name: Run Claude Code - id: claude - uses: anthropics/claude-code-action@v1 - with: - claude_code_oauth_token: ${{ secrets.CLAUDE_CODE_OAUTH_TOKEN }} - - # This is an optional setting that allows Claude to read CI results on PRs - additional_permissions: | - actions: read - - # Optional: Give a custom prompt to Claude. If this is not specified, Claude will perform the instructions specified in the comment that tagged it. - # prompt: 'Update the pull request description to include a summary of changes.' - - # Optional: Add claude_args to customize behavior and configuration - # See https://github.com/anthropics/claude-code-action/blob/main/docs/usage.md - # or https://code.claude.com/docs/en/cli-reference for available options - # claude_args: '--allowed-tools Bash(gh pr:*)' - diff --git a/.github/workflows/cross-compile-test-v3.yml b/.github/workflows/cross-compile-test-v3.yml new file mode 100644 index 000000000..2d7c3dbcb --- /dev/null +++ b/.github/workflows/cross-compile-test-v3.yml @@ -0,0 +1,135 @@ +name: Cross-Compile Test v3 + +on: + pull_request_review: + types: [submitted] + branches: + - v3-alpha + workflow_dispatch: + inputs: + pr_number: + description: 'PR number to test (optional, uses current branch if not specified)' + required: false + type: string + +jobs: + check_approval: + name: Check PR Approval + runs-on: ubuntu-latest + if: github.event_name == 'workflow_dispatch' || github.event.review.state == 'approved' + outputs: + approved: ${{ steps.check.outputs.approved }} + steps: + - name: Check if PR is approved or manual dispatch + id: check + run: | + if [[ "${{ github.event_name }}" == "workflow_dispatch" ]]; then + echo "Manual dispatch, proceeding with cross-compile tests" + else + echo "PR approved, proceeding with cross-compile tests" + fi + echo "approved=true" >> $GITHUB_OUTPUT + + cross_compile: + name: Cross-Compile (${{ matrix.target_os }}/${{ matrix.target_arch }}) + needs: check_approval + runs-on: ${{ matrix.runner }} + if: needs.check_approval.outputs.approved == 'true' + strategy: + fail-fast: false + matrix: + include: + - target_os: darwin + target_arch: arm64 + runner: ubuntu-latest + - target_os: darwin + target_arch: amd64 + runner: ubuntu-latest + - target_os: linux + target_arch: arm64 + runner: ubuntu-24.04-arm # Native ARM64 runner - much faster than QEMU + - target_os: linux + target_arch: amd64 + runner: ubuntu-latest + - target_os: windows + target_arch: arm64 + runner: ubuntu-latest + - target_os: windows + target_arch: amd64 + runner: ubuntu-latest + steps: + - name: Checkout code + uses: actions/checkout@v4 + + - name: Checkout PR (if specified) + if: github.event_name == 'workflow_dispatch' && inputs.pr_number != '' + run: gh pr checkout ${{ inputs.pr_number }} + env: + GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} + + - name: Setup Go + uses: actions/setup-go@v5 + with: + go-version: '1.25' + cache: true + cache-dependency-path: "v3/go.sum" + + - name: Install Task + uses: arduino/setup-task@v2 + with: + version: 3.x + repo-token: ${{ secrets.GITHUB_TOKEN }} + + - name: Install Linux dependencies + uses: awalsh128/cache-apt-pkgs-action@latest + with: + packages: libgtk-3-dev libwebkit2gtk-4.1-dev libwayland-dev build-essential pkg-config + version: 1.0 + + - name: Install Wails3 CLI + working-directory: v3 + run: | + go install ./cmd/wails3 + wails3 version + + - name: Create test project + run: | + mkdir -p test-cross-compile + cd test-cross-compile + wails3 init -n crosstest -t vanilla + + - name: Setup Docker cross-compile image + working-directory: test-cross-compile/crosstest + run: task common:setup:docker + + - name: Fix replace directive for Docker build + working-directory: test-cross-compile/crosstest + run: | + # Change the replace directive to use absolute path that matches Docker mount + go mod edit -dropreplace github.com/wailsapp/wails/v3 + go mod edit -replace github.com/wailsapp/wails/v3=${{ github.workspace }}/v3 + + - name: Cross-compile for ${{ matrix.target_os }}/${{ matrix.target_arch }} + working-directory: test-cross-compile/crosstest + run: | + echo "Cross-compiling for ${{ matrix.target_os }}/${{ matrix.target_arch }}..." + task ${{ matrix.target_os }}:build ARCH=${{ matrix.target_arch }} + echo "Cross-compilation successful!" + ls -la bin/ + + cross_compile_results: + if: ${{ always() }} + runs-on: ubuntu-latest + name: Cross-Compile Results + needs: [cross_compile] + steps: + - run: | + result="${{ needs.cross_compile.result }}" + echo "Cross-compile result: $result" + if [[ $result == "success" || $result == "skipped" ]]; then + echo "Cross-compile tests passed (or were skipped)!" + exit 0 + else + echo "One or more cross-compile tests failed" + exit 1 + fi diff --git a/.github/workflows/generate-sponsor-image.yml b/.github/workflows/generate-sponsor-image.yml index 56548ab43..585d7e19f 100644 --- a/.github/workflows/generate-sponsor-image.yml +++ b/.github/workflows/generate-sponsor-image.yml @@ -25,7 +25,7 @@ jobs: SPONSORKIT_GITHUB_LOGIN: wailsapp - name: Create Pull Request - uses: peter-evans/create-pull-request@v6 + uses: peter-evans/create-pull-request@v4 with: commit-message: "chore: update sponsors.svg" add-paths: "website/static/img/sponsors.svg" diff --git a/.github/workflows/issue-triage-automation.yml b/.github/workflows/issue-triage-automation.yml index 99159a2f5..4a827d527 100644 --- a/.github/workflows/issue-triage-automation.yml +++ b/.github/workflows/issue-triage-automation.yml @@ -2,7 +2,7 @@ name: Issue Triage Automation on: issues: - types: [opened] + types: [opened, reopened, labeled, unlabeled] jobs: triage: diff --git a/.github/workflows/pr-master.yml b/.github/workflows/pr-master.yml index c961b4434..1de533199 100644 --- a/.github/workflows/pr-master.yml +++ b/.github/workflows/pr-master.yml @@ -1,26 +1,17 @@ -# Updated to ensure "Run Go Tests" runs for pull requests as expected. -# Key fix: the test_go job previously required github.event.review.state == 'approved' -# which only exists on pull_request_review events. That prevented the job from -# running for regular pull_request events (opened / synchronize / reopened). -# New logic: run tests for pull_request events, and also allow running when a -# pull_request_review is submitted with state == 'approved'. +name: PR Checks (master) + on: pull_request: - types: [opened, synchronize, reopened] branches: - master pull_request_review: types: [submitted] branches: - master - workflow_dispatch: {} - -name: PR Checks (master) - jobs: check_docs: name: Check Docs - if: ${{ github.repository == 'wailsapp/wails' && github.base_ref == 'master' }} + if: ${{github.repository == 'wailsapp/wails' && github.base_ref == 'master'}} runs-on: ubuntu-latest steps: - uses: actions/checkout@v3 @@ -32,6 +23,7 @@ jobs: files: | website/**/*.mdx website/**/*.md + - name: Run step only when files change. if: steps.verify-changed-files.outputs.files_changed != 'true' run: | @@ -40,18 +32,11 @@ jobs: test_go: name: Run Go Tests runs-on: ${{ matrix.os }} - # Run when: - # - the event is a pull_request (opened/synchronize/reopened) OR - # - the event is a pull_request_review AND the review state is 'approved' - # plus other existing filters (not the update-sponsors branch, repo and base_ref) if: > - github.repository == 'wailsapp/wails' && + github.event.review.state == 'approved' && + github.repository == 'wailsapp/wails' && github.base_ref == 'master' && - github.event.pull_request.head.ref != 'update-sponsors' && - ( - github.event_name == 'pull_request' || - (github.event_name == 'pull_request_review' && github.event.review.state == 'approved') - ) + github.event.pull_request.head.ref != 'update-sponsors' strategy: matrix: os: [ubuntu-22.04, windows-latest, macos-latest, ubuntu-24.04] @@ -67,7 +52,7 @@ jobs: - name: Install linux dependencies (24.04) if: matrix.os == 'ubuntu-24.04' - run: sudo apt-get update -y && sudo apt-get install -y libgtk-3-dev libwebkit2gtk-4.1-dev build-essential pkg-config + run: sudo apt-get update -y && sudo apt-get install -y libgtk-3-dev libwebkit2gtk-4.1-dev libwayland-dev build-essential pkg-config - name: Setup Go uses: actions/setup-go@v3 @@ -90,15 +75,3 @@ jobs: if: matrix.os == 'ubuntu-24.04' working-directory: ./v2 run: go test -v -tags webkit2_41 ./... - - # This job will run instead of test_go for the update-sponsors branch - skip_tests: - name: Skip Tests (Sponsor Update) - if: github.event.pull_request.head.ref == 'update-sponsors' - runs-on: ubuntu-latest - steps: - - name: Skip tests for sponsor updates - run: | - echo "Skipping tests for sponsor update branch" - echo "This is an automated update of the sponsors image." - continue-on-error: true diff --git a/.github/workflows/publish-npm.yml b/.github/workflows/publish-npm.yml new file mode 100644 index 000000000..3ebd2f282 --- /dev/null +++ b/.github/workflows/publish-npm.yml @@ -0,0 +1,119 @@ +on: + push: + branches: ['v3-alpha'] + workflow_dispatch: + +concurrency: + group: publish-npm-v3 + cancel-in-progress: true + +jobs: + detect: + name: Detect committed changes + if: github.event_name != 'workflow_dispatch' + outputs: + changed: ${{ steps.package-json-changes.outputs.any_modified == 'true' || steps.source-changes.outputs.any_modified == 'true' }} + runs-on: ubuntu-latest + steps: + - name: Checkout code + uses: actions/checkout@v4 + with: + ref: ${{ github.sha }} + persist-credentials: 'true' + + - name: Detect committed package.json changes + id: package-json-changes + uses: step-security/changed-files@3dbe17c78367e7d60f00d78ae6781a35be47b4a1 # v45.0.1 + with: + files: | + v3/internal/runtime/desktop/@wailsio/runtime/package.json + v3/internal/runtime/desktop/@wailsio/runtime/package-lock.json + + - name: Detect committed source changes + if: >- + steps.package-json-changes.outputs.any_modified != 'true' + id: source-changes + uses: step-security/changed-files@3dbe17c78367e7d60f00d78ae6781a35be47b4a1 # v45.0.1 + with: + files: | + v3/internal/runtime/Taskfile.yaml + v3/internal/runtime/desktop/@wailsio/compiled/main.js + v3/internal/runtime/desktop/@wailsio/runtime/tsconfig.json + v3/internal/runtime/desktop/@wailsio/runtime/src/** + v3/pkg/events/events.txt + v3/tasks/events/** + + rebuild_and_publish: + name: Rebuild and publish + needs: [detect] + if: >- + !failure() && !cancelled() + && (github.event_name == 'workflow_dispatch' || needs.detect.outputs.changed == 'true') + runs-on: ubuntu-latest + permissions: + contents: write + actions: read + pull-requests: read + steps: + - name: Checkout code + uses: actions/checkout@v4 + with: + fetch-depth: 0 + ref: 'v3-alpha' + token: ${{ secrets.WAILS_REPO_TOKEN || github.token }} + + - name: Configure git + run: | + git config --global user.email "github-actions@github.com" + git config --global user.name "GitHub Actions" + git config --global url."https://x-access-token:${{ secrets.WAILS_REPO_TOKEN || github.token }}@github.com/".insteadOf "https://github.com/" + + - name: Install Task + uses: arduino/setup-task@v2 + with: + version: 3.x + repo-token: ${{ secrets.GITHUB_TOKEN }} + + - name: Use Node.js 20 + uses: actions/setup-node@v4 + with: + node-version: "20" + + - name: Install dependencies + working-directory: v3/internal/runtime/desktop/@wailsio/runtime + run: | + npm ci + npx --yes esbuild@latest --version + + - name: Clean build artifacts + working-directory: v3/internal/runtime/desktop/@wailsio/runtime + run: npm run clean + + - name: Build bundled runtime + working-directory: v3 + run: task runtime:build + + - name: Test+Build npm package + working-directory: v3/internal/runtime/desktop/@wailsio/runtime + run: | + npm test + npm run build + + - name: Bump version + id: bump-version + working-directory: v3/internal/runtime/desktop/@wailsio/runtime + run: | + echo "version=$(npm --no-git-tag-version --force version prerelease)" >> "$GITHUB_OUTPUT" + + - name: Commit changes + run: | + git add . + git commit -m "[skip ci] Publish @wailsio/runtime ${{ steps.bump-version.outputs.version }}" + git push + + - name: Publish npm package + uses: JS-DevTools/npm-publish@v3 + with: + package: v3/internal/runtime/desktop/@wailsio/runtime + access: public + token: ${{ secrets.NPM_TOKEN }} diff --git a/.github/workflows/test-nightly-releases.yml b/.github/workflows/test-nightly-releases.yml index 63df09935..1e6f12a69 100644 --- a/.github/workflows/test-nightly-releases.yml +++ b/.github/workflows/test-nightly-releases.yml @@ -1,4 +1,6 @@ name: Test Nightly Releases (Dry Run) +permissions: + contents: read on: workflow_dispatch: diff --git a/.github/workflows/test-simple.yml b/.github/workflows/test-simple.yml new file mode 100644 index 000000000..8c4c88295 --- /dev/null +++ b/.github/workflows/test-simple.yml @@ -0,0 +1,11 @@ +name: Test Simple + +on: + workflow_dispatch: + +jobs: + test: + runs-on: ubuntu-latest + steps: + - name: Test + run: echo "Hello World" \ No newline at end of file diff --git a/.github/workflows/unreleased-changelog-trigger.yml b/.github/workflows/unreleased-changelog-trigger.yml index 8cfe85de0..381023052 100644 --- a/.github/workflows/unreleased-changelog-trigger.yml +++ b/.github/workflows/unreleased-changelog-trigger.yml @@ -39,7 +39,6 @@ jobs: name: Trigger v3-alpha Release permissions: contents: read - actions: write runs-on: ubuntu-latest needs: check-permissions if: needs.check-permissions.outputs.authorized == 'true' diff --git a/.github/workflows/v3-docs.yml b/.github/workflows/v3-docs.yml new file mode 100644 index 000000000..c70bffb8a --- /dev/null +++ b/.github/workflows/v3-docs.yml @@ -0,0 +1,51 @@ +name: Deploy to GitHub Pages + +on: + # Trigger the workflow every time you push to the `main` branch + # Using a different branch name? Replace `main` with your branch's name + push: + branches: [v3-alpha] + paths: + - 'docs/**' + - '.github/workflows/v3-docs.yml' + # Allows you to run this workflow manually from the Actions tab on GitHub. + workflow_dispatch: + +# Allow this job to clone the repo and create a page deployment +permissions: + contents: read + pages: write + id-token: write + +jobs: + build: + runs-on: ubuntu-latest + if: github.event.repository.fork == false + steps: + - name: Checkout your repository using git + uses: actions/checkout@v4 + - name: Install D2 + run: | + curl -fsSL https://d2lang.com/install.sh > install.sh + chmod +x install.sh + ./install.sh + sudo cp ~/.local/bin/d2 /usr/local/bin/d2 + d2 --version + rm install.sh + - name: Install, build, and upload your site output + uses: withastro/action@v2 + with: + path: docs + node-version: 20 # The specific version of Node that should be used to build your site. Defaults to 18. (optional) + # package-manager: pnpm@latest # The Node package manager that should be used to install dependencies and build your site. Automatically detected based on your lockfile. (optional) + + deploy: + needs: build + runs-on: ubuntu-latest + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} + steps: + - name: Deploy to GitHub Pages + id: deployment + uses: actions/deploy-pages@v4 \ No newline at end of file diff --git a/.gitignore b/.gitignore index e7888b44a..61efe756b 100644 --- a/.gitignore +++ b/.gitignore @@ -37,5 +37,61 @@ v2/cmd/wails/internal/commands/initialise/templates/testtemplates/ /websitev3/site/ /v3/examples/plugins/bin/testapp +# V3 Example binaries - ignore executables that match directory names +/v3/examples/badge-custom/badge-custom +/v3/examples/badge/badge +/v3/examples/binding/binding +/v3/examples/cancel-async/cancel-async +/v3/examples/cancel-chaining/cancel-chaining +/v3/examples/clipboard/clipboard +/v3/examples/contextmenus/contextmenus +/v3/examples/dev/dev +/v3/examples/dialogs-basic/dialogs-basic +/v3/examples/dialogs/dialogs +/v3/examples/drag-n-drop/drag-n-drop +/v3/examples/environment/environment +/v3/examples/events-bug/events-bug +/v3/examples/events/events +/v3/examples/file-association/file-association +/v3/examples/frameless/frameless +/v3/examples/gin-example/gin-example +/v3/examples/gin-routing/gin-routing +/v3/examples/gin-service/gin-service +/v3/examples/hide-window/hide-window +/v3/examples/html-dnd-api/html-dnd-api +/v3/examples/ignore-mouse/ignore-mouse +/v3/examples/keybindings/keybindings +/v3/examples/menu/menu +/v3/examples/notifications/notifications +/v3/examples/panic-handling/panic-handling +/v3/examples/plain/plain +/v3/examples/raw-message/raw-message +/v3/examples/screen/screen +/v3/examples/services/services +/v3/examples/show-macos-toolbar/show-macos-toolbar +/v3/examples/single-instance/single-instance +/v3/examples/systray-basic/systray-basic +/v3/examples/systray-custom/systray-custom +/v3/examples/systray-menu/systray-menu +/v3/examples/video/video +/v3/examples/window-api/window-api +/v3/examples/window-call/window-call +/v3/examples/window-menu/window-menu +/v3/examples/window/window +/v3/examples/wml/wml + +# Common binary names in examples +/v3/examples/*/main +/v3/examples/*/app +/v3/examples/*/changeme +/v3/examples/*/testbuild-* + # Temporary called mkdocs, should be renamed to more standard -website or similar -/mkdocs-website/site +/docs/site +.aider* +.aider* +.cache +.local + +# Ignore local iOS test app +/v3/testiosapp/ diff --git a/.prettierrc.yml b/.prettierrc.yml index 685d8b6e7..1e2d2dada 100644 --- a/.prettierrc.yml +++ b/.prettierrc.yml @@ -1,6 +1,7 @@ overrides: - files: - "**/*.md" + - "**/*.mdx" options: printWidth: 80 proseWrap: always diff --git a/.replit b/.replit deleted file mode 100644 index 619bd7227..000000000 --- a/.replit +++ /dev/null @@ -1,8 +0,0 @@ -modules = ["go-1.21", "web", "nodejs-20"] -run = "go run v2/cmd/wails/main.go" - -[nix] -channel = "stable-24_05" - -[deployment] -run = ["sh", "-c", "go run v2/cmd/wails/main.go"] diff --git a/AGENTS.md b/AGENTS.md new file mode 100644 index 000000000..0d4177023 --- /dev/null +++ b/AGENTS.md @@ -0,0 +1,197 @@ +# AI Agent Instructions for Wails v3 + +## Issue Tracking with bd (beads) + +**IMPORTANT**: This project uses **bd (beads)** for ALL issue tracking. Do NOT use markdown TODOs, task lists, or other tracking methods. + +### Why bd? + +- Dependency-aware: Track blockers and relationships between issues +- Git-friendly: Auto-syncs to JSONL for version control +- Agent-optimized: JSON output, ready work detection, discovered-from links +- Prevents duplicate tracking systems and confusion + +### Quick Start + +**Check for ready work:** +```bash +bd ready --json +``` + +**Create new issues:** +```bash +bd create "Issue title" -t bug|feature|task -p 0-4 --json +bd create "Issue title" -p 1 --deps discovered-from:bd-123 --json +bd create "Subtask" --parent --json # Hierarchical subtask (gets ID like epic-id.1) +``` + +**Claim and update:** +```bash +bd update bd-42 --status in_progress --json +bd update bd-42 --priority 1 --json +``` + +**Complete work:** +```bash +bd close bd-42 --reason "Completed" --json +``` + +### Issue Types + +- `bug` - Something broken +- `feature` - New functionality +- `task` - Work item (tests, docs, refactoring) +- `epic` - Large feature with subtasks +- `chore` - Maintenance (dependencies, tooling) + +### Priorities + +- `0` - Critical (security, data loss, broken builds) +- `1` - High (major features, important bugs) +- `2` - Medium (default, nice-to-have) +- `3` - Low (polish, optimization) +- `4` - Backlog (future ideas) + +### Workflow for AI Agents + +1. **Check ready work**: `bd ready` shows unblocked issues +2. **Claim your task**: `bd update --status in_progress` +3. **Work on it**: Implement, test, document +4. **Discover new work?** Create linked issue: + - `bd create "Found bug" -p 1 --deps discovered-from:` +5. **Complete**: `bd close --reason "Done"` +6. **Commit together**: Always commit the `.beads/issues.jsonl` file together with the code changes so issue state stays in sync with code state + +### Auto-Sync + +bd automatically syncs with git: +- Exports to `.beads/issues.jsonl` after changes (5s debounce) +- Imports from JSONL when newer (e.g., after `git pull`) +- No manual export/import needed! + +### GitHub Copilot Integration + +If using GitHub Copilot, also create `.github/copilot-instructions.md` for automatic instruction loading. +Run `bd onboard` to get the content, or see step 2 of the onboard instructions. + +### MCP Server (Recommended) + +If using Claude or MCP-compatible clients, install the beads MCP server: + +```bash +pip install beads-mcp +``` + +Add to MCP config (e.g., `~/.config/claude/config.json`): +```json +{ + "beads": { + "command": "beads-mcp", + "args": [] + } +} +``` + +Then use `mcp__beads__*` functions instead of CLI commands. + +### Managing AI-Generated Planning Documents + +AI assistants often create planning and design documents during development: +- PLAN.md, IMPLEMENTATION.md, ARCHITECTURE.md +- DESIGN.md, CODEBASE_SUMMARY.md, INTEGRATION_PLAN.md +- TESTING_GUIDE.md, TECHNICAL_DESIGN.md, and similar files + +**Best Practice: Use a dedicated directory for these ephemeral files** + +**Recommended approach:** +- Create a `history/` directory in the project root +- Store ALL AI-generated planning/design docs in `history/` +- Keep the repository root clean and focused on permanent project files +- Only access `history/` when explicitly asked to review past planning + +**Example .gitignore entry (optional):** +``` +# AI planning documents (ephemeral) +history/ +``` + +**Benefits:** +- Clean repository root +- Clear separation between ephemeral and permanent documentation +- Easy to exclude from version control if desired +- Preserves planning history for archeological research +- Reduces noise when browsing the project + +### CLI Help + +Run `bd --help` to see all available flags for any command. +For example: `bd create --help` shows `--parent`, `--deps`, `--assignee`, etc. + +### Important Rules + +- Use bd for ALL task tracking +- Always use `--json` flag for programmatic use +- Link discovered work with `discovered-from` dependencies +- Check `bd ready` before asking "what should I work on?" +- Store AI planning docs in `history/` directory +- Run `bd --help` to discover available flags +- **ALWAYS run `coderabbit --plain` before committing** to get code analysis and catch issues early +- Do NOT create markdown TODO lists +- Do NOT use external issue trackers +- Do NOT duplicate tracking systems +- Do NOT clutter repo root with planning documents + +For more details, see README.md and QUICKSTART.md. + +## Implementation Tracking (IMPLEMENTATION.md) + +**IMPORTANT**: The `IMPLEMENTATION.md` file at the repository root is a **persistent tracking document** for the WebKitGTK 6.0 / GTK4 implementation work. It is NOT an ephemeral planning document. + +### Requirements + +1. **Update with EVERY commit** that touches GTK4/WebKitGTK 6.0 related code +2. **Track all architectural decisions** with context, decision, and rationale +3. **Maintain progress status** for each implementation phase +4. **Document API differences** between GTK3 and GTK4 +5. **Keep file references** accurate and up-to-date + +### What to Update + +- Phase completion status (✅ COMPLETE, 🔄 IN PROGRESS, 📋 PENDING) +- New decisions made during implementation +- Files created or modified +- Changelog entries with dates +- TODO items discovered during work + +### Commit Message Pattern + +When updating IMPLEMENTATION.md: +``` +docs: update implementation tracker for [phase/feature] +``` + +## Landing the Plane (Session Completion) + +**When ending a work session**, you MUST complete ALL steps below. Work is NOT complete until `git push` succeeds. + +**MANDATORY WORKFLOW:** + +1. **File issues for remaining work** - Create issues for anything that needs follow-up +2. **Run quality gates** (if code changed) - Tests, linters, builds +3. **Update issue status** - Close finished work, update in-progress items +4. **PUSH TO REMOTE** - This is MANDATORY: + ```bash + git pull --rebase + bd sync + git push + git status # MUST show "up to date with origin" + ``` +5. **Clean up** - Clear stashes, prune remote branches +6. **Verify** - All changes committed AND pushed +7. **Hand off** - Provide context for next session + +**CRITICAL RULES:** +- Work is NOT complete until `git push` succeeds +- NEVER stop before pushing - that leaves work stranded locally +- NEVER say "ready to push when you are" - YOU must push +- If push fails, resolve and retry until it succeeds diff --git a/CNAME b/CNAME new file mode 100644 index 000000000..23caa94af --- /dev/null +++ b/CNAME @@ -0,0 +1 @@ +v3alpha.wails.io \ No newline at end of file diff --git a/IMPLEMENTATION.md b/IMPLEMENTATION.md new file mode 100644 index 000000000..16d048f3f --- /dev/null +++ b/IMPLEMENTATION.md @@ -0,0 +1,543 @@ +# WebKitGTK 6.0 / GTK4 Implementation Tracker + +## Overview + +This document tracks the implementation of WebKitGTK 6.0 (GTK4) support for Wails v3 on Linux. + +**Goal**: Provide GTK4/WebKitGTK 6.0 support as an EXPERIMENTAL opt-in via `-tags gtk4`, while maintaining GTK3/WebKit2GTK 4.1 as the stable default. + +## Architecture Decisions + +### Decision 1: GTK3 as Default, GTK4 Opt-In (2026-02-04) +**Context**: Need to support modern Linux distributions with GTK4 while maintaining stability for existing apps. + +**Decision**: GTK3 remains the stable default (no build tag required). GTK4 is available as experimental via `-tags gtk4`. + +**Rationale**: +- GTK3/WebKit2GTK 4.1 is battle-tested and widely deployed +- GTK4 support needs more community testing before becoming default +- Allows gradual migration and feedback collection +- Protects existing apps from unexpected breakage + +**Build Tags**: +- Default (no tag): `//go:build linux && cgo && !gtk4 && !android` +- Experimental GTK4: `//go:build linux && cgo && gtk4 && !android` + +### Decision 2: pkg-config Libraries (2026-01-04) +**GTK4/WebKitGTK 6.0**: +``` +#cgo linux pkg-config: gtk4 webkitgtk-6.0 libsoup-3.0 +``` + +**GTK3/WebKit2GTK 4.1** (legacy): +``` +#cgo linux pkg-config: gtk+-3.0 webkit2gtk-4.1 libsoup-3.0 +``` + +### Decision 3: Wayland Window Positioning (2026-01-04) +**Context**: GTK4/Wayland doesn't support arbitrary window positioning - this is a Wayland protocol limitation. + +**Decision**: Window positioning functions (`move()`, `setPosition()`, `center()`) are documented NO-OPs on GTK4/Wayland. + +**Rationale**: This is a fundamental Wayland design decision, not a limitation we can work around. Users need to be aware of this behavioral difference. + +### Decision 4: Menu System Architecture (2026-01-04) +**Context**: GTK4 removes GtkMenu/GtkMenuItem in favor of GMenu/GAction. + +**Decision**: Complete rewrite of menu system for GTK4 using GMenu/GAction/GtkPopoverMenuBar. + +**Status**: Stub implementations only. Full implementation pending. + +### Decision 5: System Tray Compatibility (2026-01-04) +**Context**: v3's system tray uses D-Bus StatusNotifierItem protocol. + +**Decision**: No changes needed - system tray is already GTK-agnostic. + +## Implementation Progress + +### Phase 1: Build Infrastructure ✅ COMPLETE + +**Commit**: `a0ca13fdc` (2026-01-04) + +#### 1.1 Add gtk3 constraint to existing files +Files modified: +- `v3/pkg/application/application_linux.go` - Added `gtk3` constraint +- `v3/pkg/application/linux_cgo.go` - Added `gtk3` constraint +- `v3/internal/assetserver/webview/request_linux.go` - Added `gtk3` constraint +- `v3/internal/assetserver/webview/responsewriter_linux.go` - Added `gtk3` constraint +- `v3/internal/assetserver/webview/webkit2.go` - Added `gtk3` constraint + +#### 1.2 Create GTK4 stub files +Files created: +- `v3/pkg/application/linux_cgo_gtk4.go` (~1000 lines) + - Main CGO file with GTK4 bindings + - Implements: window management, clipboard, basic menu stubs + - Uses `gtk4 webkitgtk-6.0` pkg-config + +- `v3/pkg/application/application_linux_gtk4.go` (~250 lines) + - Application lifecycle management + - System theme detection via D-Bus + - NVIDIA DMA-BUF workaround for Wayland + +#### 1.3 Create WebKitGTK 6.0 asset server stubs +Files created: +- `v3/internal/assetserver/webview/webkit6.go` +- `v3/internal/assetserver/webview/request_linux_gtk4.go` +- `v3/internal/assetserver/webview/responsewriter_linux_gtk4.go` + +### Phase 2: Doctor & Capabilities ✅ COMPLETE + +**Goal**: Update `wails doctor` to check for GTK4 as primary, GTK3 as secondary. + +#### 2.1 Package Manager Updates +All 7 package managers updated to check GTK4/WebKitGTK 6.0 as primary, GTK3 as optional/legacy: +- `v3/internal/doctor/packagemanager/apt.go` ✅ +- `v3/internal/doctor/packagemanager/dnf.go` ✅ +- `v3/internal/doctor/packagemanager/pacman.go` ✅ +- `v3/internal/doctor/packagemanager/zypper.go` ✅ +- `v3/internal/doctor/packagemanager/emerge.go` ✅ +- `v3/internal/doctor/packagemanager/eopkg.go` ✅ +- `v3/internal/doctor/packagemanager/nixpkgs.go` ✅ + +Package key naming convention: `gtk3`, `webkit2gtk-4.1` (primary/default), `gtk4`, `webkitgtk-6.0` (experimental, optional) + +#### 2.2 Capabilities Detection +Files created/updated: +- `v3/internal/capabilities/capabilities.go` - Added `GTKVersion` (int) and `WebKitVersion` (string) fields +- `v3/internal/capabilities/capabilities_linux.go` - GTK4 default: `GTKVersion: 4, WebKitVersion: "6.0"` +- `v3/internal/capabilities/capabilities_linux_gtk3.go` - GTK3 legacy: `GTKVersion: 3, WebKitVersion: "4.1"` + +TODO (deferred to Phase 3): +- [ ] Update `v3/internal/doctor/doctor_linux.go` - Improve output to show GTK4 vs GTK3 status + +### Phase 3: Window Management ✅ COMPLETE + +#### 3.1 GTK4 Event Controllers +GTK4 replaces direct signal handlers with `GtkEventController` objects: +- `GtkEventControllerFocus` for focus in/out events +- `GtkGestureClick` for button press/release events +- `GtkEventControllerKey` for keyboard events +- Window signals: `close-request`, `notify::maximized`, `notify::fullscreened` + +New C function `setupWindowEventControllers()` sets up all event controllers. + +#### 3.2 Window Drag and Resize +GTK4 uses `GdkToplevel` API instead of GTK3's `gtk_window_begin_move_drag`: +- `gdk_toplevel_begin_move()` for window drag +- `gdk_toplevel_begin_resize()` for window resize +- Requires `gtk_native_get_surface()` to get the GdkSurface + +#### 3.3 Drag-and-Drop with GtkDropTarget +Complete implementation using GTK4's `GtkDropTarget`: +- `on_drop_enter` / `on_drop_leave` for drag enter/exit events +- `on_drop_motion` for drag position updates +- `on_drop` handles file drops via `GDK_TYPE_FILE_LIST` +- Go callbacks: `onDropEnter`, `onDropLeave`, `onDropMotion`, `onDropFiles` + +#### 3.4 Window State Detection +- `isMinimised()` uses `gdk_toplevel_get_state()` with `GDK_TOPLEVEL_STATE_MINIMIZED` +- `isMaximised()` uses `gtk_window_is_maximized()` +- `isFullscreen()` uses `gtk_window_is_fullscreen()` + +#### 3.5 Size Constraints +GTK4 removed `gtk_window_set_geometry_hints()`. Now using `gtk_widget_set_size_request()` for minimum size. + +TODO (deferred): +- [ ] Test window lifecycle on GTK4 with actual GTK4 libraries + +### Phase 4: Menu System ✅ COMPLETE + +GTK4 completely replaced the menu system. GTK3's GtkMenu/GtkMenuItem are gone. + +#### 4.1 GMenu/GAction Architecture +- `GMenu` - Menu model (data structure, not a widget) +- `GMenuItem` - Individual menu item in the model +- `GSimpleAction` - Action that gets triggered when menu item is activated +- `GSimpleActionGroup` - Container for actions, attached to widgets + +#### 4.2 Menu Bar Implementation +- `GtkPopoverMenuBar` created from `GMenu` model via `create_menu_bar_from_model()` +- Action group attached to window with `attach_action_group_to_widget()` +- Actions use "app.action_name" namespace + +#### 4.3 New Files Created +- `v3/pkg/application/menu_linux_gtk4.go` - GTK4 menu processing +- `v3/pkg/application/menuitem_linux_gtk4.go` - GTK4 menu item handling + +#### 4.4 Build Tag Changes +- `menu_linux.go` - Added `gtk3` tag +- `menuitem_linux.go` - Added `gtk3` tag + +#### 4.5 Key Functions +- `menuActionActivated()` - Callback when GAction is triggered +- `menuItemNewWithId()` - Creates GMenuItem + associated GSimpleAction +- `menuCheckItemNewWithId()` - Creates stateful toggle action +- `menuRadioItemNewWithId()` - Creates radio action +- `set_action_enabled()` / `set_action_state()` - Manage action state + +TODO (deferred): +- [ ] Context menus with GtkPopoverMenu + +### Phase 5: Asset Server ✅ COMPLETE + +WebKitGTK 6.0 uses the same URI scheme handler API as WebKitGTK 4.1. +The asset server implementation is identical between GTK3 and GTK4. + +#### 5.1 Asset Server Files (already created in Phase 1) +- `v3/internal/assetserver/webview/webkit6.go` - WebKitGTK 6.0 helpers +- `v3/internal/assetserver/webview/request_linux_gtk4.go` - Request handling +- `v3/internal/assetserver/webview/responsewriter_linux_gtk4.go` - Response writing + +#### 5.2 Missing Exports Added +The GTK4 CGO file was missing two critical exports that were in the GTK3 file: +- `onProcessRequest` - Handles URI scheme requests from WebKit +- `sendMessageToBackend` - Handles JavaScript to Go communication + +Both exports were added to `linux_cgo_gtk4.go`. + +#### 5.3 Key Differences from GTK3 +| Aspect | GTK3 | GTK4 | +|--------|------|------| +| pkg-config | `webkit2gtk-4.1` | `webkitgtk-6.0` | +| Headers | `webkit2/webkit2.h` | `webkit/webkit.h` | +| Min version | 2.40 | 6.0 | +| URI scheme API | Same | Same | + +TODO (deferred to testing phase): +- [ ] Test asset loading on actual GTK4 system +- [ ] Verify JavaScript execution works correctly + +### Phase 6: Docker & Build System ✅ COMPLETE + +#### 6.1 Docker Container Updates +Updated both Dockerfile.linux-x86_64 and Dockerfile.linux-arm64 to install: +- GTK3 + WebKit2GTK 4.1 (default build target) +- GTK4 + WebKitGTK 6.0 (for experimental `-tags gtk4` builds) + +Build scripts now support `BUILD_TAGS` environment variable: +- Default: Builds with GTK3/WebKit2GTK 4.1 +- `BUILD_TAGS=gtk4`: Builds with GTK4/WebKitGTK 6.0 (experimental) + +#### 6.2 Taskfile Targets +New targets added to `v3/Taskfile.yaml`: + +| Target | Description | +|--------|-------------| +| `test:example:linux` | Build single example with GTK3 (native, default) | +| `test:example:linux:gtk4` | Build single example with GTK4 (native, experimental) | +| `test:examples:linux:docker:x86_64` | Build all examples with GTK3 in Docker | +| `test:examples:linux:docker:x86_64:gtk4` | Build all examples with GTK4 in Docker (experimental) | +| `test:examples:linux:docker:arm64` | Build all examples with GTK3 in Docker (ARM64) | +| `test:examples:linux:docker:arm64:gtk4` | Build all examples with GTK4 in Docker (ARM64, experimental) | + +TODO (deferred): +- [ ] Update CI/CD workflows to test both GTK versions + +### Phase 8: Dialog System ✅ COMPLETE + +GTK4 completely replaced the dialog APIs. GTK3's `GtkFileChooserDialog` and +`gtk_message_dialog_new` are deprecated/removed. + +#### 8.1 File Dialogs +GTK4 uses `GtkFileDialog` with async API: +- `gtk_file_dialog_open()` - Open single file +- `gtk_file_dialog_open_multiple()` - Open multiple files +- `gtk_file_dialog_select_folder()` - Select folder +- `gtk_file_dialog_select_multiple_folders()` - Select multiple folders +- `gtk_file_dialog_save()` - Save file + +Key differences: +- No more `gtk_dialog_run()` - everything is async with callbacks +- Filters use `GListStore` of `GtkFileFilter` objects +- Results delivered via `GAsyncResult` callbacks +- Custom button text via `gtk_file_dialog_set_accept_label()` + +#### 8.1.1 GTK4 File Dialog Limitations (Portal-based) + +GTK4's `GtkFileDialog` uses **xdg-desktop-portal** for native file dialogs. This provides +better desktop integration but removes some application control: + +| Feature | GTK3 | GTK4 | Notes | +|---------|------|------|-------| +| `ShowHiddenFiles()` | ✅ Works | ❌ No effect | User controls via portal UI toggle | +| `CanCreateDirectories()` | ✅ Works | ❌ No effect | Always enabled in portal | +| `ResolvesAliases()` | ✅ Works | ❌ No effect | Portal handles symlinks | +| `SetButtonText()` | ✅ Works | ✅ Works | `gtk_file_dialog_set_accept_label()` | +| Multiple folders | ✅ Works | ✅ Works | `gtk_file_dialog_select_multiple_folders()` | + +**Why these limitations exist**: GTK4's portal-based dialogs delegate UI control to the +desktop environment (GNOME, KDE, etc.). This is intentional - the portal provides +consistent UX across applications and respects user preferences. + +#### 8.2 Message Dialogs +GTK4 uses `GtkAlertDialog`: +- `gtk_alert_dialog_choose()` - Show dialog with buttons +- Buttons specified as NULL-terminated string array +- Default and cancel button indices configurable + +#### 8.3 Implementation Details +- Request ID tracking for async callback matching +- `fileDialogCallback` / `alertDialogCallback` C exports for results +- `runChooserDialog()` and `runQuestionDialog()` Go wrappers +- `runOpenFileDialog()` and `runSaveFileDialog()` convenience functions + +| GTK3 | GTK4 | +|------|------| +| `GtkFileChooserDialog` | `GtkFileDialog` | +| `gtk_dialog_run()` | Async callbacks | +| `gtk_message_dialog_new()` | `GtkAlertDialog` | +| `gtk_widget_destroy()` | `g_object_unref()` | + +### Phase 9: Keyboard Accelerators ✅ COMPLETE + +GTK4 uses `gtk_application_set_accels_for_action()` to bind keyboard shortcuts to GActions. + +#### 9.1 Key Components + +**C Helper Functions** (in `linux_cgo_gtk4.go`): +- `set_action_accelerator(app, action_name, accel)` - Sets accelerator for a GAction +- `build_accelerator_string(key, mods)` - Converts key+modifiers to GTK accelerator string + +**Go Functions** (in `linux_cgo_gtk4.go`): +- `namedKeysToGTK` - Map of key names to GDK keysym values (e.g., "backspace" → 0xff08) +- `parseKeyGTK(key)` - Converts Wails key string to GDK keysym +- `parseModifiersGTK(modifiers)` - Converts Wails modifiers to GdkModifierType +- `acceleratorToGTK(accel)` - Converts full accelerator to GTK format +- `setMenuItemAccelerator(itemId, accel)` - Sets accelerator for a menu item + +**Integration** (in `menuitem_linux_gtk4.go`): +- `setAccelerator()` method on `linuxMenuItem` calls `setMenuItemAccelerator()` +- `newMenuItemImpl()`, `newCheckMenuItemImpl()`, `newRadioMenuItemImpl()` all set accelerators during creation + +#### 9.2 Accelerator String Format + +GTK accelerator strings use format like: +- `q` - Ctrl+Q +- `s` - Ctrl+Shift+S +- `F4` - Alt+F4 +- `e` - Super+E (Windows/Command key) + +#### 9.3 Modifier Mapping + +| Wails Modifier | GDK Modifier | +|----------------|--------------| +| `CmdOrCtrlKey` | `GDK_CONTROL_MASK` | +| `ControlKey` | `GDK_CONTROL_MASK` | +| `OptionOrAltKey` | `GDK_ALT_MASK` | +| `ShiftKey` | `GDK_SHIFT_MASK` | +| `SuperKey` | `GDK_SUPER_MASK` | + +### Phase 10: Testing 📋 PENDING + +TODO: +- [ ] Test on Ubuntu 24.04 (native GTK4) +- [ ] Test on Ubuntu 22.04 (backported WebKitGTK 6.0) +- [ ] Test legacy build on older systems +- [ ] Performance benchmarks +- [ ] Verify file dialogs work correctly +- [ ] Verify message dialogs work correctly + +## API Differences: GTK3 vs GTK4 + +| Feature | GTK3 | GTK4 | +|---------|------|------| +| Init | `gtk_init(&argc, &argv)` | `gtk_init_check()` | +| Container | `gtk_container_add()` | `gtk_window_set_child()` | +| Show | `gtk_widget_show_all()` | Widgets visible by default | +| Hide | `gtk_widget_hide()` | `gtk_widget_set_visible(w, FALSE)` | +| Clipboard | `GtkClipboard` | `GdkClipboard` | +| Menu | `GtkMenu/GtkMenuItem` | `GMenu/GAction` | +| Menu Bar | `GtkMenuBar` | `GtkPopoverMenuBar` | +| Window Move | `gtk_window_move()` | NO-OP on Wayland | +| Window Position | `gtk_window_get_position()` | Not available on Wayland | +| Destroy | `gtk_widget_destroy()` | `gtk_window_destroy()` | +| Drag Start | `gtk_window_begin_move_drag()` | `gtk_native_get_surface()` + surface drag | + +## Files Reference + +### GTK3 (Default) Files +``` +v3/pkg/application/ + linux_cgo.go # Main CGO (!gtk4 tag - default) + application_linux.go # App lifecycle (!gtk4 tag - default) + +v3/internal/assetserver/webview/ + webkit2.go # WebKit2GTK helpers (!gtk4 tag - default) + request_linux.go # Request handling (!gtk4 tag - default) + responsewriter_linux.go # Response writing (!gtk4 tag - default) + +v3/internal/capabilities/ + capabilities_linux_gtk3.go # GTK3 capabilities (!gtk4 tag - default) + +v3/internal/operatingsystem/ + webkit_linux.go # WebKit version info (!gtk4 tag - default) +``` + +### GTK4 (Experimental) Files +``` +v3/pkg/application/ + linux_cgo_gtk4.go # Main CGO (gtk4 tag - experimental) + application_linux_gtk4.go # App lifecycle (gtk4 tag - experimental) + +v3/internal/assetserver/webview/ + webkit6.go # WebKitGTK 6.0 helpers (gtk4 tag - experimental) + request_linux_gtk4.go # Request handling (gtk4 tag - experimental) + responsewriter_linux_gtk4.go # Response writing (gtk4 tag - experimental) + +v3/internal/capabilities/ + capabilities_linux.go # GTK4 capabilities (gtk4 tag - experimental) + +v3/internal/operatingsystem/ + webkit_linux_gtk4.go # WebKit version info (gtk4 tag - experimental) +``` + +### Shared Files (no GTK-specific code) +``` +v3/pkg/application/ + webview_window_linux.go # Window wrapper (uses methods from CGO files) + systemtray_linux.go # D-Bus based, GTK-agnostic + +v3/internal/assetserver/webview/ + request.go # Interface definitions + responsewriter.go # Interface definitions +``` + +## Changelog + +### 2026-01-07 (Session 11) +- Fixed GTK4 dialog system bugs +- **File Dialog Fix**: Removed premature `g_object_unref()` that freed dialog before async callback + - GTK4 async dialogs manage their own lifecycle + - Commit: `6f9c5beb5` +- **Alert Dialog Fixes**: + - Removed premature `g_object_unref(dialog)` from `show_alert_dialog()` (same issue as file dialogs) + - Fixed deadlock in `dialogs_linux.go` - `InvokeAsync` → `go func()` since `runQuestionDialog` blocks internally + - Fixed `runQuestionDialog` to use `options.Title` as message (was using `options.Message`) + - Added default "OK" button when no buttons specified + - Commit: `1a77e6091` +- **Other Fixes**: + - Fixed checkptr errors with `-race` flag by changing C signal functions to accept `uintptr_t` (`3999f1f24`) + - Fixed ExecJS race condition by adding mutex for `runtimeLoaded`/`pendingJS` (`8e386034e`) +- Added DEBUG_LOG macro for compile-time debug output: `CGO_CFLAGS="-DWAILS_GTK_DEBUG" go build ...` +- Added manual dialog test suite in `v3/test/manual/dialog/` +- **Additional Dialog Fixes** (Session 11 continued): + - Added `gtk_file_dialog_set_accept_label()` for custom button text + - Added `gtk_file_dialog_select_multiple_folders()` for multiple directory selection + - Fixed data race in `application.go` cleanup - was using RLock() when writing `a.windows = nil` + - Documented GTK4 portal limitations (ShowHiddenFiles, CanCreateDirectories have no effect) +- Files modified: + - `v3/pkg/application/linux_cgo_gtk4.go` - dialog fixes, race fixes, accept label, multiple folders + - `v3/pkg/application/linux_cgo_gtk4.c` - DEBUG_LOG macro, alert dialog lifecycle fix, select_multiple_folders callback + - `v3/pkg/application/linux_cgo_gtk4.h` - uintptr_t for signal functions + - `v3/pkg/application/dialogs_linux.go` - deadlock fix + - `v3/pkg/application/webview_window.go` - pendingJS mutex + - `v3/pkg/application/application.go` - RLock → Lock for cleanup writes + - `docs/src/content/docs/reference/dialogs.mdx` - documented GTK4 limitations + +### 2026-01-04 (Session 10) +- Fixed Window → Zoom menu behavior to toggle maximize/restore (was incorrectly calling webview zoomIn) +- Fixed radio button styling in GTK4 GMenu (now shows dots instead of checkmarks) + - Implemented proper GMenu radio groups with string-valued stateful actions + - All items in group share same action name with unique target values + - Added `create_radio_menu_item()` C helper and `menuRadioItemNewWithGroup()` Go wrapper +- Researched Wayland minimize behavior: + - `gtk_window_minimize()` works on GNOME/KDE (sends xdg_toplevel_set_minimized) + - May be no-op on tiling WMs (Sway, etc.) per Wayland protocol design +- Fixed app not terminating when last window closed + - Added quit logic to `unregisterWindow()` in `application_linux_gtk4.go` + - Respects `DisableQuitOnLastWindowClosed` option +- Fixed menu separators not showing + - GMenu uses sections for visual separators (not separate separator items) + - Rewrote menu processing to group items into sections, separators create new sections + - Added `menuNewSection()`, `menuAppendSection()`, `menuAppendItemToSection()` helpers +- Added CSS provider to reduce popover menu padding +- Removed all debug println statements +- Files modified: + - `v3/pkg/application/linux_cgo_gtk4.go` - added radio group support, section helpers + - `v3/pkg/application/linux_cgo_gtk4.c` - added create_radio_menu_item(), init_menu_css() + - `v3/pkg/application/linux_cgo_gtk4.h` - added function declaration + - `v3/pkg/application/application_linux_gtk4.go` - added quit-on-last-window logic + - `v3/pkg/application/menu_linux_gtk4.go` - section-based menu processing, radio groups + - `v3/pkg/application/menuitem_linux_gtk4.go` - updated radio item creation + - `v3/pkg/application/webview_window_linux.go` - fixed zoom() to toggle maximize + - `v3/pkg/application/window_manager.go` - removed debug output + +### 2026-01-04 (Session 9) +- Fixed GTK4 window creation crash (SIGSEGV in gtk_application_window_new) +- **Root Cause**: GTK4 requires app to be "activated" before creating windows +- **Solution**: Added activation synchronization mechanism: + - Added `activated` channel and `sync.Once` to `linuxApp` struct + - Added `markActivated()` method called from `activateLinux()` callback + - Added `waitForActivation()` method for callers to block until ready + - Modified `WebviewWindow.Run()` to wait for activation before `InvokeSync` +- Files modified: + - `v3/pkg/application/application_linux_gtk4.go` - activation gate + - `v3/pkg/application/linux_cgo_gtk4.go` - call markActivated() in activateLinux + - `v3/pkg/application/webview_window.go` - wait for activation on GTK4 +- GTK4 apps now create windows successfully without crashes + +### 2026-01-04 (Session 8) +- Fixed GTK3/GTK4 symbol conflict in operatingsystem package +- Added `gtk3` build tag to `v3/internal/operatingsystem/webkit_linux.go` +- Created `v3/internal/operatingsystem/webkit_linux_gtk4.go` with GTK4/WebKitGTK 6.0 +- Moved app initialization from `init()` to `newPlatformApp()` for cleaner setup +- Resolved runtime crash: "GTK 2/3 symbols detected in GTK 4 process" +- Verified menu example runs successfully with GTK 4.20.3 and WebKitGTK 2.50.3 + +### 2026-01-04 (Session 7) +- Completed Phase 9: Keyboard Accelerators +- Added namedKeysToGTK map with GDK keysym values for all special keys +- Added parseKeyGTK() and parseModifiersGTK() conversion functions +- Added acceleratorToGTK() to convert Wails accelerator format to GTK +- Added setMenuItemAccelerator() Go wrapper that calls C helpers +- Integrated accelerator setting in all menu item creation functions +- Uses gtk_application_set_accels_for_action() for GTK4 shortcut binding + +### 2026-01-04 (Session 6) +- Completed Phase 8: Dialog System +- Implemented GtkFileDialog for file open/save/folder dialogs +- Implemented GtkAlertDialog for message dialogs +- Added async callback system for GTK4 dialogs (no more gtk_dialog_run) +- Added C helper functions and Go wrapper functions + +### 2026-01-04 (Session 5 continued) +- Completed Phase 6: Docker & Build System +- Updated Dockerfile.linux-x86_64 and Dockerfile.linux-arm64 for GTK4 + GTK3 +- Added BUILD_TAGS environment variable support in build scripts +- Added Taskfile targets for GTK4 (default) and GTK3 (legacy) builds + +### 2026-01-04 (Session 5) +- Completed Phase 5: Asset Server +- Verified WebKitGTK 6.0 uses same URI scheme handler API as WebKitGTK 4.1 +- Added missing `onProcessRequest` export to linux_cgo_gtk4.go +- Added missing `sendMessageToBackend` export to linux_cgo_gtk4.go +- Confirmed asset server files (webkit6.go, request/responsewriter) are complete + +### 2026-01-04 (Session 4) +- Completed Phase 4: Menu System +- Implemented GMenu/GAction architecture for GTK4 menus +- Created GtkPopoverMenuBar integration +- Added menu_linux_gtk4.go and menuitem_linux_gtk4.go +- Added gtk3 build tags to original menu files +- Implemented stateful actions for checkboxes and radio items + +### 2026-01-04 (Session 3) +- Completed Phase 3: Window Management +- Implemented GTK4 event controllers (GtkEventControllerFocus, GtkGestureClick, GtkEventControllerKey) +- Implemented window drag using GdkToplevel API (gdk_toplevel_begin_move/resize) +- Implemented complete drag-and-drop with GtkDropTarget +- Fixed window state detection (isMinimised, isMaximised, isFullscreen) +- Fixed size() function to properly return window dimensions +- Updated windowSetGeometryHints for GTK4 (uses gtk_widget_set_size_request) + +### 2026-01-04 (Session 2) +- Completed Phase 2: Doctor & Capabilities +- Updated all 7 package managers for GTK4/WebKitGTK 6.0 as primary +- Added GTKVersion and WebKitVersion fields to Capabilities struct +- Created capabilities_linux_gtk3.go for legacy build path + +### 2026-01-04 (Session 1) +- Initial implementation of GTK4 build infrastructure +- Added `gtk3` constraint to 5 existing files +- Created 5 new GTK4 stub files +- Updated UNRELEASED_CHANGELOG.md diff --git a/IOS_ARCHITECTURE.md b/IOS_ARCHITECTURE.md new file mode 100644 index 000000000..2e07f4f0c --- /dev/null +++ b/IOS_ARCHITECTURE.md @@ -0,0 +1,419 @@ +# Wails v3 iOS Architecture + +## Executive Summary + +This document provides a comprehensive technical architecture for iOS support in Wails v3. The implementation enables Go applications to run natively on iOS with a WKWebView frontend, maintaining the Wails philosophy of using web technologies for UI while leveraging Go for business logic. + +## Table of Contents + +1. [Architecture Overview](#architecture-overview) +2. [Core Components](#core-components) +3. [Layer Architecture](#layer-architecture) +4. [Implementation Details](#implementation-details) +5. [Battery Optimization](#battery-optimization) +6. [Build System](#build-system) +7. [Security Considerations](#security-considerations) +8. [API Reference](#api-reference) + +## Architecture Overview + +### Design Principles + +1. **Battery Efficiency First**: All architectural decisions prioritize battery life +2. **No Network Ports**: Asset serving happens in-process via native APIs +3. **Minimal WebView Instances**: Maximum 2 concurrent WebViews (1 primary, 1 for transitions) +4. **Native Integration**: Deep iOS integration using Objective-C runtime +5. **Wails v3 Compatibility**: Maintain API compatibility with existing Wails v3 applications + +### High-Level Architecture + +``` +┌─────────────────────────────────────────────────────────────┐ +│ iOS Application │ +├─────────────────────────────────────────────────────────────┤ +│ UIKit Framework │ +│ ┌─────────────────────────────────────────────────────┐ │ +│ │ WailsViewController │ │ +│ │ ┌───────────────────────────────────────────────┐ │ │ +│ │ │ WKWebView Instance │ │ │ +│ │ │ ┌─────────────────────────────────────────┐ │ │ │ +│ │ │ │ Web Application (HTML/JS) │ │ │ │ +│ │ │ └─────────────────────────────────────────┘ │ │ │ +│ │ └───────────────────────────────────────────────┘ │ │ +│ └─────────────────────────────────────────────────────┘ │ +├─────────────────────────────────────────────────────────────┤ +│ Bridge Layer (CGO) │ +│ ┌──────────────┐ ┌──────────────┐ ┌──────────────┐ │ +│ │URL Handler │ │JS Bridge │ │Message Handler│ │ +│ └──────────────┘ └──────────────┘ └──────────────┘ │ +├─────────────────────────────────────────────────────────────┤ +│ Go Runtime │ +│ ┌──────────────────────────────────────────────────────┐ │ +│ │ Wails Application │ │ +│ │ ┌──────────┐ ┌──────────┐ ┌──────────────────┐ │ │ +│ │ │App Logic │ │Services │ │Asset Server │ │ │ +│ │ └──────────┘ └──────────┘ └──────────────────┘ │ │ +│ └──────────────────────────────────────────────────────┘ │ +└─────────────────────────────────────────────────────────────┘ +``` + +## Core Components + +### 1. Platform Layer (`application_ios.go`) + +**Purpose**: Go interface for iOS platform operations + +**Key Functions**: +- `platformRun()`: Initialize and run the iOS application +- `platformQuit()`: Gracefully shutdown the application +- `isDarkMode()`: Detect iOS dark mode state +- `ExecuteJavaScript(windowID uint, js string)`: Execute JS in WebView + +**Exported Go Functions (Called from Objective-C)**: +- `ServeAssetRequest(windowID C.uint, urlStr *C.char, callbackID C.uint)` +- `HandleJSMessage(windowID C.uint, message *C.char)` + +### 2. Native iOS Layer (`application_ios.m`) + +**Components**: + +#### WailsSchemeHandler +```objc +@interface WailsSchemeHandler : NSObject +``` +- Implements `WKURLSchemeHandler` protocol +- Intercepts `wails://` URL requests +- Bridges to Go for asset serving +- Manages pending requests with callback IDs + +**Methods**: +- `startURLSchemeTask:`: Intercept request, call Go handler +- `stopURLSchemeTask:`: Cancel pending request +- `completeRequest:withData:mimeType:`: Complete request with data from Go + +#### WailsMessageHandler +```objc +@interface WailsMessageHandler : NSObject +``` +- Implements JavaScript to Go communication +- Handles `window.webkit.messageHandlers.external.postMessage()` +- Serializes messages to JSON for Go processing + +**Methods**: +- `userContentController:didReceiveScriptMessage:`: Process JS messages + +#### WailsViewController +```objc +@interface WailsViewController : UIViewController +``` +- Main view controller containing WKWebView +- Manages WebView lifecycle +- Handles JavaScript execution requests + +**Properties**: +- `webView`: WKWebView instance +- `schemeHandler`: Custom URL scheme handler +- `messageHandler`: JS message handler +- `windowID`: Unique window identifier + +**Methods**: +- `viewDidLoad`: Initialize WebView with configuration +- `executeJavaScript:`: Run JS code in WebView + +### 3. Bridge Layer (CGO) + +**C Interface Functions**: +```c +void ios_app_init(void); // Initialize iOS app +void ios_app_run(void); // Run main loop +void ios_app_quit(void); // Quit application +bool ios_is_dark_mode(void); // Check dark mode +unsigned int ios_create_webview(void); // Create WebView +void ios_execute_javascript(unsigned int windowID, const char* js); +void ios_complete_request(unsigned int callbackID, const char* data, const char* mimeType); +``` + +## Layer Architecture + +### Layer 1: Presentation Layer (WebView) + +**Responsibilities**: +- Render HTML/CSS/JavaScript UI +- Handle user interactions +- Communicate with native layer + +**Key Features**: +- WKWebView for modern web standards +- Hardware-accelerated rendering +- Efficient memory management + +### Layer 2: Communication Layer + +**Request Interception**: +``` +WebView Request → WKURLSchemeHandler → Go ServeAssetRequest → AssetServer → Response +``` + +**JavaScript Bridge**: +``` +JS postMessage → WKScriptMessageHandler → Go HandleJSMessage → Process → ExecuteJavaScript +``` + +### Layer 3: Application Layer (Go) + +**Components**: +- Application lifecycle management +- Service binding and method calls +- Asset serving from embedded fs.FS +- Business logic execution + +### Layer 4: Platform Integration Layer + +**iOS-Specific Features**: +- Dark mode detection +- System appearance integration +- iOS-specific optimizations + +## Implementation Details + +### Request Handling Flow + +1. **WebView makes request** to `wails://localhost/path` +2. **WKURLSchemeHandler intercepts** request +3. **Creates callback ID** and stores `WKURLSchemeTask` +4. **Calls Go function** `ServeAssetRequest` with URL and callback ID +5. **Go processes request** through AssetServer +6. **Go calls** `ios_complete_request` with response data +7. **Objective-C completes** the `WKURLSchemeTask` with response + +### JavaScript Execution Flow + +1. **Go calls** `ios_execute_javascript` with JS code +2. **Bridge dispatches** to main thread +3. **WKWebView evaluates** JavaScript +4. **Completion handler** logs any errors + +### Message Passing Flow + +1. **JavaScript calls** `window.webkit.messageHandlers.wails.postMessage(data)` +2. **WKScriptMessageHandler receives** message +3. **Serializes to JSON** and passes to Go +4. **Go processes** message in `HandleJSMessage` +5. **Go can respond** via `ExecuteJavaScript` + +## Battery Optimization + +### WebView Configuration + +```objc +// Disable unnecessary features +config.suppressesIncrementalRendering = NO; +config.allowsInlineMediaPlayback = YES; +config.mediaTypesRequiringUserActionForPlayback = WKAudiovisualMediaTypeNone; +``` + +### Memory Management + +1. **Single WebView Instance**: Reuse instead of creating new instances +2. **Automatic Reference Counting**: Use ARC for Objective-C objects +3. **Lazy Loading**: Initialize components only when needed +4. **Resource Cleanup**: Properly release resources when done + +### Request Optimization + +1. **In-Process Serving**: No network overhead +2. **Direct Memory Transfer**: Pass data directly without serialization +3. **Efficient Caching**: Leverage WKWebView's built-in cache +4. **Minimal Wake Locks**: No background network activity + +## Build System + +### Build Tags + +```go +//go:build ios +``` + +### CGO Configuration + +```go +#cgo CFLAGS: -x objective-c -fobjc-arc +#cgo LDFLAGS: -framework Foundation -framework UIKit -framework WebKit +``` + +### Build Script (`build_ios.sh`) + +**Steps**: +1. Check dependencies (go, xcodebuild, xcrun) +2. Set up iOS cross-compilation environment +3. Build Go binary with iOS tags +4. Create app bundle structure +5. Generate Info.plist +6. Sign for simulator +7. Create launch script + +**Environment Variables**: +```bash +export CGO_ENABLED=1 +export GOOS=ios +export GOARCH=arm64 +export SDK_PATH=$(xcrun --sdk iphonesimulator --show-sdk-path) +``` + +### Simulator Deployment + +```bash +xcrun simctl install "$DEVICE_ID" "WailsIOSDemo.app" +xcrun simctl launch "$DEVICE_ID" "com.wails.iosdemo" +``` + +## Security Considerations + +### URL Scheme Security + +1. **Custom Scheme**: Use `wails://` to avoid conflicts +2. **Origin Validation**: Only serve to authorized WebViews +3. **No External Access**: Scheme handler only responds to app's WebView + +### JavaScript Execution + +1. **Input Validation**: Sanitize JS code before execution +2. **Sandboxed Execution**: WKWebView provides isolation +3. **No eval()**: Avoid dynamic code evaluation + +### Data Protection + +1. **In-Memory Only**: No temporary files on disk +2. **ATS Compliance**: App Transport Security enabled +3. **Secure Communication**: All data stays within app process + +## API Reference + +### Go API + +#### Application Functions + +```go +// Create new iOS application +app := application.New(application.Options{ + Name: "App Name", + Description: "App Description", +}) + +// Run the application +app.Run() + +// Execute JavaScript +app.ExecuteJavaScript(windowID, "console.log('Hello')") +``` + +#### Service Binding + +```go +type MyService struct{} + +func (s *MyService) Greet(name string) string { + return fmt.Sprintf("Hello, %s!", name) +} + +app := application.New(application.Options{ + Services: []application.Service{ + application.NewService(&MyService{}), + }, +}) +``` + +### JavaScript API + +#### Send Message to Go + +```javascript +window.webkit.messageHandlers.wails.postMessage({ + type: 'methodCall', + service: 'MyService', + method: 'Greet', + args: ['World'] +}); +``` + +#### Receive from Go + +```javascript +window.wailsCallback = function(data) { + console.log('Received:', data); +}; +``` + +### Objective-C Bridge API + +#### From Go to Objective-C + +```c +// Execute JavaScript +ios_execute_javascript(windowID, "alert('Hello')"); + +// Complete asset request +ios_complete_request(callbackID, htmlData, "text/html"); +``` + +#### From Objective-C to Go + +```c +// Serve asset request +ServeAssetRequest(windowID, urlString, callbackID); + +// Handle JavaScript message +HandleJSMessage(windowID, jsonMessage); +``` + +## Performance Metrics + +### Target Metrics + +- **WebView Creation**: < 100ms +- **Asset Request**: < 10ms for cached, < 50ms for first load +- **JS Execution**: < 5ms for simple scripts +- **Message Passing**: < 2ms round trip +- **Memory Usage**: < 50MB baseline +- **Battery Impact**: < 2% per hour active use + +### Monitoring + +1. **Xcode Instruments**: CPU, Memory, Energy profiling +2. **WebView Inspector**: JavaScript performance +3. **Go Profiling**: pprof for Go code analysis + +## Future Enhancements + +### Phase 1: Core Stability +- [ ] Production-ready error handling +- [ ] Comprehensive test suite +- [ ] Performance optimization + +### Phase 2: Feature Parity +- [ ] Multiple window support +- [ ] System tray integration +- [ ] Native menu implementation + +### Phase 3: iOS-Specific Features +- [ ] Widget extension support +- [ ] App Clip support +- [ ] ShareSheet integration +- [ ] Siri Shortcuts + +### Phase 4: Advanced Features +- [ ] Background task support +- [ ] Push notifications +- [ ] CloudKit integration +- [ ] Apple Watch companion app + +## Conclusion + +This architecture provides a solid foundation for iOS support in Wails v3. The design prioritizes battery efficiency, native performance, and seamless integration with the existing Wails ecosystem. The proof of concept demonstrates all four required capabilities: + +1. ✅ **WebView Creation**: Native WKWebView with optimized configuration +2. ✅ **Request Interception**: Custom scheme handler without network ports +3. ✅ **JavaScript Execution**: Bidirectional communication bridge +4. ✅ **iOS Simulator Support**: Complete build and deployment pipeline + +The architecture is designed to scale from this proof of concept to a full production implementation while maintaining the simplicity and elegance that Wails developers expect. \ No newline at end of file diff --git a/README.de.md b/README.de.md index 5df35de5b..b1616d2f9 100644 --- a/README.de.md +++ b/README.de.md @@ -25,7 +25,7 @@ Erschaffe Desktop Anwendungen mit Go & Web Technologien. Awesome - Discord + Discord
diff --git a/README.es.md b/README.es.md index 277d1c1fd..59cbcf132 100644 --- a/README.es.md +++ b/README.es.md @@ -25,7 +25,7 @@ Awesome - Discord + Discord
diff --git a/README.fr.md b/README.fr.md index 61230f353..2f405b46a 100644 --- a/README.fr.md +++ b/README.fr.md @@ -25,7 +25,7 @@ Awesome - Discord + Discord
diff --git a/README.ja.md b/README.ja.md index ffd9f8103..d4edb662c 100644 --- a/README.ja.md +++ b/README.ja.md @@ -27,7 +27,7 @@ Awesome - Discord + Discord
diff --git a/README.ko.md b/README.ko.md index 075e04229..fc27dfbe1 100644 --- a/README.ko.md +++ b/README.ko.md @@ -27,7 +27,7 @@ Awesome - Discord + Discord
diff --git a/README.md b/README.md index 5ab9309b4..12ff1d6dc 100644 --- a/README.md +++ b/README.md @@ -25,7 +25,7 @@ Awesome - Discord + Discord
@@ -98,9 +98,9 @@ The installation instructions are on the [official website](https://wails.io/doc This project is supported by these kind people / companies: -## Powered By - -[![JetBrains logo.](https://resources.jetbrains.com/storage/products/company/brand/logos/jetbrains.svg)](https://jb.gg/OpenSource) +

+ +

## FAQ diff --git a/README.pt-br.md b/README.pt-br.md index 0e3883352..8129ac853 100644 --- a/README.pt-br.md +++ b/README.pt-br.md @@ -25,7 +25,7 @@ Awesome
- Discord + Discord
diff --git a/README.ru.md b/README.ru.md index 76fa59d07..4a24b9bcb 100644 --- a/README.ru.md +++ b/README.ru.md @@ -25,7 +25,7 @@ Awesome - Discord + Discord
diff --git a/README.tr.md b/README.tr.md index e9b16ca76..b9e88c0b9 100644 --- a/README.tr.md +++ b/README.tr.md @@ -25,7 +25,7 @@ Awesome - Discord + Discord
diff --git a/README.uz.md b/README.uz.md index 807262405..88744e94e 100644 --- a/README.uz.md +++ b/README.uz.md @@ -25,7 +25,7 @@ Awesome - Discord + Discord
diff --git a/README.zh-Hans.md b/README.zh-Hans.md index 4c09d0c45..baeeb420e 100644 --- a/README.zh-Hans.md +++ b/README.zh-Hans.md @@ -27,7 +27,7 @@ Awesome - Discord + Discord
diff --git a/Taskfile.yaml b/Taskfile.yaml index 7cc165825..051da3e42 100644 --- a/Taskfile.yaml +++ b/Taskfile.yaml @@ -16,6 +16,11 @@ includes: dir: v3 optional: true + docs: + taskfile: docs + dir: docs + optional: true + tasks: contributors:check: cmds: diff --git a/docs/.gitignore b/docs/.gitignore new file mode 100644 index 000000000..6240da8b1 --- /dev/null +++ b/docs/.gitignore @@ -0,0 +1,21 @@ +# build output +dist/ +# generated types +.astro/ + +# dependencies +node_modules/ + +# logs +npm-debug.log* +yarn-debug.log* +yarn-error.log* +pnpm-debug.log* + + +# environment variables +.env +.env.production + +# macOS-specific files +.DS_Store diff --git a/docs/.npmrc b/docs/.npmrc new file mode 100644 index 000000000..cffe8cdef --- /dev/null +++ b/docs/.npmrc @@ -0,0 +1 @@ +save-exact=true diff --git a/docs/.vscode/extensions.json b/docs/.vscode/extensions.json new file mode 100644 index 000000000..22a15055d --- /dev/null +++ b/docs/.vscode/extensions.json @@ -0,0 +1,4 @@ +{ + "recommendations": ["astro-build.astro-vscode"], + "unwantedRecommendations": [] +} diff --git a/docs/.vscode/launch.json b/docs/.vscode/launch.json new file mode 100644 index 000000000..d64220976 --- /dev/null +++ b/docs/.vscode/launch.json @@ -0,0 +1,11 @@ +{ + "version": "0.2.0", + "configurations": [ + { + "command": "./node_modules/.bin/astro dev", + "name": "Development server", + "request": "launch", + "type": "node-terminal" + } + ] +} diff --git a/docs/CNAME b/docs/CNAME new file mode 100644 index 000000000..23caa94af --- /dev/null +++ b/docs/CNAME @@ -0,0 +1 @@ +v3alpha.wails.io \ No newline at end of file diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 000000000..108b2a1fa --- /dev/null +++ b/docs/README.md @@ -0,0 +1,65 @@ +# Wails v3 Documentation + +[![Built with Starlight](https://astro.badg.es/v2/built-with-starlight/tiny.svg)](https://starlight.astro.build) + +World-class documentation for Wails v3, redesigned following Netflix documentation principles. + +## 📚 Documentation Redesign (2025-10-01) + +This documentation has been completely redesigned to follow the **Netflix approach** to developer documentation: + +- **Problem-first framing** - Start with why, not what +- **Progressive disclosure** - Multiple entry points for different skill levels +- **Real production examples** - No toy code +- **Story-Code-Context pattern** - Why → How → When +- **Scannable content** - Clear structure, visual aids + +**Status:** Foundation complete (~20%), ready for content migration + +See [IMPLEMENTATION_SUMMARY.md](./IMPLEMENTATION_SUMMARY.md) for full details. + +## 🚀 Project Structure + +Inside of your Astro + Starlight project, you'll see the following folders and +files: + +```sh +. +├── public/ +├── src/ +│ ├── assets/ +│ ├── content/ +│ │ ├── docs/ +│ │ └── config.ts +│ └── env.d.ts +├── astro.config.mjs +├── package.json +└── tsconfig.json +``` + +Starlight looks for `.md` or `.mdx` files in the `src/content/docs/` directory. +Each file is exposed as a route based on its file name. + +Images can be added to `src/assets/` and embedded in Markdown with a relative +link. + +Static assets, like favicons, can be placed in the `public/` directory. + +## 🧞 Commands + +All commands are run from the root of the project, from a terminal: + +| Command | Action | +| :------------------------ | :----------------------------------------------- | +| `npm install` | Installs dependencies | +| `npm run dev` | Starts local dev server at `localhost:4321` | +| `npm run build` | Build your production site to `./dist/` | +| `npm run preview` | Preview your build locally, before deploying | +| `npm run astro ...` | Run CLI commands like `astro add`, `astro check` | +| `npm run astro -- --help` | Get help using the Astro CLI | + +## 👀 Want to learn more? + +Check out [Starlight’s docs](https://starlight.astro.build/), read +[the Astro documentation](https://docs.astro.build), or jump into the +[Astro Discord server](https://astro.build/chat). diff --git a/docs/Taskfile.yml b/docs/Taskfile.yml new file mode 100644 index 000000000..9f7c01fd6 --- /dev/null +++ b/docs/Taskfile.yml @@ -0,0 +1,36 @@ +# https://taskfile.dev + +version: '3' + +vars: + # Change this to switch package managers: bun, npm, pnpm, yarn + PKG_MANAGER: npm + +tasks: + + setup: + summary: Setup the project (including D2 diagram tool) + preconditions: + - sh: '{{.PKG_MANAGER}} --version' + msg: "Looks like {{.PKG_MANAGER}} isn't installed." + - sh: 'go version' + msg: "Go is not installed. Install from https://go.dev/dl/" + cmds: + - '{{.PKG_MANAGER}} install' + - go install oss.terrastruct.com/d2@latest + - echo "✓ Setup complete. D2 installed to $(go env GOPATH)/bin/d2" + + dev: + summary: Run the dev server + deps: [setup] + cmds: + - '{{.PKG_MANAGER}} run dev' + + build: + summary: Build the docs + preconditions: + - sh: '{{.PKG_MANAGER}} --version' + msg: "Looks like {{.PKG_MANAGER}} isn't installed." + cmds: + - '{{.PKG_MANAGER}} run build' + diff --git a/docs/astro.config.mjs b/docs/astro.config.mjs new file mode 100644 index 000000000..03133e2f5 --- /dev/null +++ b/docs/astro.config.mjs @@ -0,0 +1,351 @@ +// @ts-check +import { defineConfig } from "astro/config"; +import starlight from "@astrojs/starlight"; +import sitemap from "@astrojs/sitemap"; +import starlightLinksValidator from "starlight-links-validator"; +import starlightImageZoom from "starlight-image-zoom"; +import starlightBlog from "starlight-blog"; +import { authors } from "./src/content/authors"; +import d2 from 'astro-d2'; +import react from '@astrojs/react'; + +// https://astro.build/config +export default defineConfig({ + site: "https://wails.io", + trailingSlash: "ignore", + compressHTML: true, + output: "static", + build: { format: "directory" }, + devToolbar: { enabled: true }, + integrations: [ + react(), + d2(), + sitemap(), + starlight({ + title: "", + titleDelimiter: "", + logo: { + dark: "./src/assets/wails-logo-horizontal-dark.svg", + light: "./src/assets/wails-logo-horizontal-light.svg", + }, + favicon: "./public/favicon.svg", + description: "Build beautiful desktop applications using Go and modern web technologies.", + pagefind: true, + customCss: ["./src/stylesheets/extra.css"], + lastUpdated: true, + pagination: true, + editLink: { + baseUrl: "https://github.com/wailsapp/wails/edit/v3-alpha/docs", + }, + social: [ + { icon: 'github', label: 'GitHub', href: 'https://github.com/wailsapp/wails' }, + { icon: 'discord', label: 'Discord', href: 'https://discord.gg/JDdSxwjhGf' }, + { icon: 'x.com', label: 'X', href: 'https://x.com/wailsapp' }, + ], + head: [ + { + tag: 'script', + content: ` + document.addEventListener('DOMContentLoaded', () => { + const socialLinks = document.querySelector('.social-icons'); + if (socialLinks) { + const sponsorLink = document.createElement('a'); + sponsorLink.href = 'https://github.com/sponsors/leaanthony'; + sponsorLink.className = 'sl-flex'; + sponsorLink.title = 'Sponsor'; + sponsorLink.innerHTML = 'Sponsor'; + socialLinks.appendChild(sponsorLink); + } + }); + `, + }, + ], + defaultLocale: "root", + locales: { + root: { label: "English", lang: "en", dir: "ltr" }, + }, + plugins: [ + starlightImageZoom(), + starlightBlog({ + title: "Wails Blog", + authors: authors, + }), + ], + sidebar: [ + { label: "Home", link: "/" }, + + // Progressive Onboarding - Netflix Principle: Start with the problem + { label: "Why Wails?", link: "/quick-start/why-wails" }, + + { + label: "Quick Start", + collapsed: false, + items: [ + { label: "Installation", link: "/quick-start/installation" }, + { label: "Your First App", link: "/quick-start/first-app" }, + { label: "Next Steps", link: "/quick-start/next-steps" }, + ], + }, + + // Tutorials + { + label: "Tutorials", + collapsed: true, + autogenerate: { directory: "tutorials" }, + }, + + // Core Concepts + { + label: "Core Concepts", + collapsed: true, + items: [ + { label: "How Wails Works", link: "/concepts/architecture" }, + { label: "Manager API", link: "/concepts/manager-api" }, + { label: "Application Lifecycle", link: "/concepts/lifecycle" }, + { label: "Go-Frontend Bridge", link: "/concepts/bridge" }, + { label: "Build System", link: "/concepts/build-system" }, + ], + }, + + { + label: "Features", + collapsed: true, + items: [ + { + label: "Windows", + collapsed: true, + items: [ + { label: "Window Basics", link: "/features/windows/basics" }, + { label: "Window Options", link: "/features/windows/options" }, + { label: "Multiple Windows", link: "/features/windows/multiple" }, + { label: "Frameless Windows", link: "/features/windows/frameless" }, + { label: "Window Events", link: "/features/windows/events" }, + ], + }, + { + label: "Menus", + collapsed: true, + items: [ + { label: "Application Menus", link: "/features/menus/application" }, + { label: "Context Menus", link: "/features/menus/context" }, + { label: "System Tray Menus", link: "/features/menus/systray" }, + { label: "Menu Reference", link: "/features/menus/reference" }, + ], + }, + { + label: "Bindings & Services", + collapsed: true, + items: [ + { label: "Method Binding", link: "/features/bindings/methods" }, + { label: "Services", link: "/features/bindings/services" }, + { label: "Data Models", link: "/features/bindings/models" }, + { label: "Enums", link: "/features/bindings/enums" }, + { label: "Advanced Binding", link: "/features/bindings/advanced" }, + { label: "Best Practices", link: "/features/bindings/best-practices" }, + ], + }, + { + label: "Events", + collapsed: true, + items: [ + { label: "Event System", link: "/features/events/system" }, + { label: "Application Events", link: "/features/events/application" }, + { label: "Window Events", link: "/features/events/window" }, + { label: "Custom Events", link: "/features/events/custom" }, + ], + }, + { + label: "Dialogs", + collapsed: true, + items: [ + { label: "File Dialogs", link: "/features/dialogs/file" }, + { label: "Message Dialogs", link: "/features/dialogs/message" }, + { label: "Custom Dialogs", link: "/features/dialogs/custom" }, + ], + }, + { + label: "Clipboard", + collapsed: true, + autogenerate: { directory: "features/clipboard" }, + }, + { + label: "Browser", + collapsed: true, + autogenerate: { directory: "features/browser" }, + }, + { + label: "Drag & Drop", + collapsed: true, + autogenerate: { directory: "features/drag-and-drop" }, + }, + { + label: "Keyboard", + collapsed: true, + autogenerate: { directory: "features/keyboard" }, + }, + { + label: "Notifications", + collapsed: true, + autogenerate: { directory: "features/notifications" }, + }, + { + label: "Screens", + collapsed: true, + autogenerate: { directory: "features/screens" }, + }, + { + label: "Environment", + collapsed: true, + autogenerate: { directory: "features/environment" }, + }, + { + label: "Platform-Specific", + collapsed: true, + autogenerate: { directory: "features/platform" }, + }, + ], + }, + + // Guides - Task-oriented patterns (Netflix: When to use it, when not to use it) + { + label: "Guides", + collapsed: true, + items: [ + { + label: "Development", + collapsed: true, + items: [ + { label: "Project Structure", link: "/guides/dev/project-structure" }, + { label: "Development Workflow", link: "/guides/dev/workflow" }, + { label: "Debugging", link: "/guides/dev/debugging" }, + { label: "Testing", link: "/guides/dev/testing" }, + ], + }, + { + label: "Building & Packaging", + collapsed: true, + items: [ + { label: "Building Applications", link: "/guides/build/building" }, + { label: "Build Customization", link: "/guides/build/customization" }, + { label: "Cross-Platform Builds", link: "/guides/build/cross-platform" }, + { label: "Code Signing", link: "/guides/build/signing" }, + { label: "Windows Packaging", link: "/guides/build/windows" }, + { label: "macOS Packaging", link: "/guides/build/macos" }, + { label: "Linux Packaging", link: "/guides/build/linux" }, + { label: "MSIX Packaging", link: "/guides/build/msix" }, + ], + }, + { + label: "Distribution", + collapsed: true, + items: [ + { label: "Auto-Updates", link: "/guides/distribution/auto-updates" }, + { label: "File Associations", link: "/guides/distribution/file-associations" }, + { label: "Custom Protocols", link: "/guides/distribution/custom-protocols" }, + { label: "Single Instance", link: "/guides/distribution/single-instance" }, + ], + }, + { + label: "Integration Patterns", + collapsed: true, + items: [ + { label: "Using Gin Router", link: "/guides/patterns/gin-routing" }, + { label: "Gin Services", link: "/guides/patterns/gin-services" }, + { label: "Database Integration", link: "/guides/patterns/database" }, + { label: "REST APIs", link: "/guides/patterns/rest-api" }, + ], + }, + { + label: "Advanced Topics", + collapsed: true, + items: [ + { label: "Server Build", link: "/guides/server-build", badge: { text: "Experimental", variant: "caution" } }, + { label: "Custom Templates", link: "/guides/advanced/custom-templates" }, + { label: "WML (Wails Markup)", link: "/guides/advanced/wml" }, + { label: "Panic Handling", link: "/guides/advanced/panic-handling" }, + { label: "Security Best Practices", link: "/guides/advanced/security" }, + ], + }, + ], + }, + + // Reference - Comprehensive API docs (Netflix: Complete technical reference) + { + label: "API Reference", + collapsed: true, + items: [ + { label: "Overview", link: "/reference/overview" }, + { label: "Application", link: "/reference/application" }, + { label: "Window", link: "/reference/window" }, + { label: "Menu", link: "/reference/menu" }, + { label: "Events", link: "/reference/events" }, + { label: "Dialogs", link: "/reference/dialogs" }, + { label: "Frontend Runtime", link: "/reference/frontend-runtime" }, + { label: "CLI", link: "/reference/cli" }, + ], + }, + + // Contributing + { + label: "Contributing", + collapsed: true, + items: [ + { label: "Getting Started", link: "/contributing/getting-started" }, + { label: "Development Setup", link: "/contributing/setup" }, + { label: "Coding Standards", link: "/contributing/standards" }, + ], + }, + + // Migration & Troubleshooting + { + label: "Migration", + collapsed: true, + items: [ + { label: "From v2 to v3", link: "/migration/v2-to-v3" }, + { label: "From Electron", link: "/migration/from-electron" }, + ], + }, + + { + label: "Troubleshooting", + collapsed: true, + autogenerate: { directory: "troubleshooting" }, + }, + + // Community & Resources + { + label: "Community", + collapsed: true, + items: [ + { label: "Links", link: "/community/links" }, + { label: "Templates", link: "/community/templates" }, + { + label: "Showcase", + collapsed: true, + items: [ + { label: "Overview", link: "/community/showcase" }, + { + label: "Applications", + autogenerate: { + directory: "community/showcase", + collapsed: true, + }, + }, + ], + }, + ], + }, + + { label: "What's New", link: "/whats-new" }, + { label: "Status", link: "/status" }, + { label: "Changelog", link: "/changelog" }, + { + label: "Sponsor", + link: "https://github.com/sponsors/leaanthony", + badge: { text: "❤️" }, + }, + { label: "Credits", link: "/credits" }, + ], + }), + ], +}); diff --git a/docs/package-lock.json b/docs/package-lock.json new file mode 100644 index 000000000..428b7ec7b --- /dev/null +++ b/docs/package-lock.json @@ -0,0 +1,9082 @@ +{ + "name": "wails-docs", + "version": "0.0.1", + "lockfileVersion": 3, + "requires": true, + "packages": { + "": { + "name": "wails-docs", + "version": "0.0.1", + "dependencies": { + "@astrojs/check": "^0.9.4", + "@astrojs/react": "^4.1.0", + "@astrojs/starlight": "0.36.2", + "@types/react": "^19.0.1", + "@types/react-dom": "^19.0.2", + "astro": "^5.0.0", + "astro-d2": "^0.5.0", + "framer-motion": "^11.14.4", + "motion": "^11.14.4", + "react": "^19.0.0", + "react-dom": "^19.0.0", + "sharp": "^0.33.5", + "starlight-blog": "0.25.1", + "starlight-image-zoom": "^0.9.0", + "starlight-links-validator": "^0.13.4", + "starlight-showcases": "^0.2.0", + "typescript": "^5.7.2" + } + }, + "node_modules/@astro-community/astro-embed-twitter": { + "version": "0.5.9", + "resolved": "https://registry.npmjs.org/@astro-community/astro-embed-twitter/-/astro-embed-twitter-0.5.9.tgz", + "integrity": "sha512-bTIP/2LB3iEzlZ58L7dFyLJuWLeFDXgzZUQZKlWIfsXiKYqKIfLTQ01U10sh9UiHpm1M+4kOVPpue5LbUpJXHw==", + "license": "MIT", + "dependencies": { + "@astro-community/astro-embed-utils": "^0.1.5" + }, + "peerDependencies": { + "astro": "^2.0.0 || ^3.0.0-beta || ^4.0.0-beta || ^5.0.0-beta" + } + }, + "node_modules/@astro-community/astro-embed-utils": { + "version": "0.1.5", + "resolved": "https://registry.npmjs.org/@astro-community/astro-embed-utils/-/astro-embed-utils-0.1.5.tgz", + "integrity": "sha512-0RlP7J1YEWrguWDfEDsm4uDCXk4FKn0HHakmSOSwHLg6YR8WNEN/LGMGhhsxLc/mDqO2lRh1VqfJy+yPLLkzsQ==", + "license": "MIT", + "dependencies": { + "linkedom": "^0.18.12" + } + }, + "node_modules/@astro-community/astro-embed-youtube": { + "version": "0.5.9", + "resolved": "https://registry.npmjs.org/@astro-community/astro-embed-youtube/-/astro-embed-youtube-0.5.9.tgz", + "integrity": "sha512-8Uk2SKbyZVb+jxwqSAMoEpQo+063XYwCI3yRy9cbkyHpu09mDabGZNTF5XrL8CKr3NtR5haBkeYK/kSuKUkJ/g==", + "license": "MIT", + "dependencies": { + "lite-youtube-embed": "^0.3.4" + }, + "peerDependencies": { + "astro": "^2.0.0 || ^3.0.0-beta || ^4.0.0-beta || ^5.0.0-beta" + } + }, + "node_modules/@astrojs/check": { + "version": "0.9.5", + "resolved": "https://registry.npmjs.org/@astrojs/check/-/check-0.9.5.tgz", + "integrity": "sha512-88vc8n2eJ1Oua74yXSGo/8ABMeypfQPGEzuoAx2awL9Ju8cE6tZ2Rz9jVx5hIExHK5gKVhpxfZj4WXm7e32g1w==", + "license": "MIT", + "dependencies": { + "@astrojs/language-server": "^2.15.0", + "chokidar": "^4.0.1", + "kleur": "^4.1.5", + "yargs": "^17.7.2" + }, + "bin": { + "astro-check": "dist/bin.js" + }, + "peerDependencies": { + "typescript": "^5.0.0" + } + }, + "node_modules/@astrojs/compiler": { + "version": "2.13.0", + "resolved": "https://registry.npmjs.org/@astrojs/compiler/-/compiler-2.13.0.tgz", + "integrity": "sha512-mqVORhUJViA28fwHYaWmsXSzLO9osbdZ5ImUfxBarqsYdMlPbqAqGJCxsNzvppp1BEzc1mJNjOVvQqeDN8Vspw==", + "license": "MIT" + }, + "node_modules/@astrojs/internal-helpers": { + "version": "0.7.5", + "resolved": "https://registry.npmjs.org/@astrojs/internal-helpers/-/internal-helpers-0.7.5.tgz", + "integrity": "sha512-vreGnYSSKhAjFJCWAwe/CNhONvoc5lokxtRoZims+0wa3KbHBdPHSSthJsKxPd8d/aic6lWKpRTYGY/hsgK6EA==", + "license": "MIT" + }, + "node_modules/@astrojs/language-server": { + "version": "2.16.0", + "resolved": "https://registry.npmjs.org/@astrojs/language-server/-/language-server-2.16.0.tgz", + "integrity": "sha512-oX2KkuIfEEM5d4/+lfuxy6usRDYko0S02YvtHFTrnqW0h9e4ElAfWZRKyqxWlwpuPdciBPKef5YJ7DFH3PPssw==", + "license": "MIT", + "dependencies": { + "@astrojs/compiler": "^2.10.3", + "@astrojs/yaml2ts": "^0.2.2", + "@jridgewell/sourcemap-codec": "^1.4.15", + "@volar/kit": "~2.4.23", + "@volar/language-core": "~2.4.23", + "@volar/language-server": "~2.4.23", + "@volar/language-service": "~2.4.23", + "fast-glob": "^3.2.12", + "muggle-string": "^0.4.1", + "volar-service-css": "0.0.66", + "volar-service-emmet": "0.0.66", + "volar-service-html": "0.0.66", + "volar-service-prettier": "0.0.66", + "volar-service-typescript": "0.0.66", + "volar-service-typescript-twoslash-queries": "0.0.66", + "volar-service-yaml": "0.0.66", + "vscode-html-languageservice": "^5.5.2", + "vscode-uri": "^3.1.0" + }, + "bin": { + "astro-ls": "bin/nodeServer.js" + }, + "peerDependencies": { + "prettier": "^3.0.0", + "prettier-plugin-astro": ">=0.11.0" + }, + "peerDependenciesMeta": { + "prettier": { + "optional": true + }, + "prettier-plugin-astro": { + "optional": true + } + } + }, + "node_modules/@astrojs/markdown-remark": { + "version": "6.3.9", + "resolved": "https://registry.npmjs.org/@astrojs/markdown-remark/-/markdown-remark-6.3.9.tgz", + "integrity": "sha512-hX2cLC/KW74Io1zIbn92kI482j9J7LleBLGCVU9EP3BeH5MVrnFawOnqD0t/q6D1Z+ZNeQG2gNKMslCcO36wng==", + "license": "MIT", + "dependencies": { + "@astrojs/internal-helpers": "0.7.5", + "@astrojs/prism": "3.3.0", + "github-slugger": "^2.0.0", + "hast-util-from-html": "^2.0.3", + "hast-util-to-text": "^4.0.2", + "import-meta-resolve": "^4.2.0", + "js-yaml": "^4.1.0", + "mdast-util-definitions": "^6.0.0", + "rehype-raw": "^7.0.0", + "rehype-stringify": "^10.0.1", + "remark-gfm": "^4.0.1", + "remark-parse": "^11.0.0", + "remark-rehype": "^11.1.2", + "remark-smartypants": "^3.0.2", + "shiki": "^3.13.0", + "smol-toml": "^1.4.2", + "unified": "^11.0.5", + "unist-util-remove-position": "^5.0.0", + "unist-util-visit": "^5.0.0", + "unist-util-visit-parents": "^6.0.2", + "vfile": "^6.0.3" + } + }, + "node_modules/@astrojs/mdx": { + "version": "4.3.12", + "resolved": "https://registry.npmjs.org/@astrojs/mdx/-/mdx-4.3.12.tgz", + "integrity": "sha512-pL3CVPtuQrPnDhWjy7zqbOibNyPaxP4VpQS8T8spwKqKzauJ4yoKyNkVTD8jrP7EAJHmBhZ7PTmUGZqOpKKp8g==", + "license": "MIT", + "dependencies": { + "@astrojs/markdown-remark": "6.3.9", + "@mdx-js/mdx": "^3.1.1", + "acorn": "^8.15.0", + "es-module-lexer": "^1.7.0", + "estree-util-visit": "^2.0.0", + "hast-util-to-html": "^9.0.5", + "piccolore": "^0.1.3", + "rehype-raw": "^7.0.0", + "remark-gfm": "^4.0.1", + "remark-smartypants": "^3.0.2", + "source-map": "^0.7.6", + "unist-util-visit": "^5.0.0", + "vfile": "^6.0.3" + }, + "engines": { + "node": "18.20.8 || ^20.3.0 || >=22.0.0" + }, + "peerDependencies": { + "astro": "^5.0.0" + } + }, + "node_modules/@astrojs/prism": { + "version": "3.3.0", + "resolved": "https://registry.npmjs.org/@astrojs/prism/-/prism-3.3.0.tgz", + "integrity": "sha512-q8VwfU/fDZNoDOf+r7jUnMC2//H2l0TuQ6FkGJL8vD8nw/q5KiL3DS1KKBI3QhI9UQhpJ5dc7AtqfbXWuOgLCQ==", + "license": "MIT", + "dependencies": { + "prismjs": "^1.30.0" + }, + "engines": { + "node": "18.20.8 || ^20.3.0 || >=22.0.0" + } + }, + "node_modules/@astrojs/react": { + "version": "4.4.2", + "resolved": "https://registry.npmjs.org/@astrojs/react/-/react-4.4.2.tgz", + "integrity": "sha512-1tl95bpGfuaDMDn8O3x/5Dxii1HPvzjvpL2YTuqOOrQehs60I2DKiDgh1jrKc7G8lv+LQT5H15V6QONQ+9waeQ==", + "license": "MIT", + "dependencies": { + "@vitejs/plugin-react": "^4.7.0", + "ultrahtml": "^1.6.0", + "vite": "^6.4.1" + }, + "engines": { + "node": "18.20.8 || ^20.3.0 || >=22.0.0" + }, + "peerDependencies": { + "@types/react": "^17.0.50 || ^18.0.21 || ^19.0.0", + "@types/react-dom": "^17.0.17 || ^18.0.6 || ^19.0.0", + "react": "^17.0.2 || ^18.0.0 || ^19.0.0", + "react-dom": "^17.0.2 || ^18.0.0 || ^19.0.0" + } + }, + "node_modules/@astrojs/rss": { + "version": "4.0.14", + "resolved": "https://registry.npmjs.org/@astrojs/rss/-/rss-4.0.14.tgz", + "integrity": "sha512-KCe1imDcADKOOuO/wtKOMDO/umsBD6DWF+94r5auna1jKl5fmlK9vzf+sjA3EyveXA/FoB3khtQ/u/tQgETmTw==", + "license": "MIT", + "dependencies": { + "fast-xml-parser": "^5.3.0", + "piccolore": "^0.1.3" + } + }, + "node_modules/@astrojs/sitemap": { + "version": "3.6.0", + "resolved": "https://registry.npmjs.org/@astrojs/sitemap/-/sitemap-3.6.0.tgz", + "integrity": "sha512-4aHkvcOZBWJigRmMIAJwRQXBS+ayoP5z40OklTXYXhUDhwusz+DyDl+nSshY6y9DvkVEavwNcFO8FD81iGhXjg==", + "license": "MIT", + "dependencies": { + "sitemap": "^8.0.0", + "stream-replace-string": "^2.0.0", + "zod": "^3.25.76" + } + }, + "node_modules/@astrojs/starlight": { + "version": "0.36.2", + "resolved": "https://registry.npmjs.org/@astrojs/starlight/-/starlight-0.36.2.tgz", + "integrity": "sha512-QR8NfO7+7DR13kBikhQwAj3IAoptLLNs9DkyKko2M2l3PrqpcpVUnw1JBJ0msGDIwE6tBbua2UeBND48mkh03w==", + "license": "MIT", + "peer": true, + "dependencies": { + "@astrojs/markdown-remark": "^6.3.1", + "@astrojs/mdx": "^4.2.3", + "@astrojs/sitemap": "^3.3.0", + "@pagefind/default-ui": "^1.3.0", + "@types/hast": "^3.0.4", + "@types/js-yaml": "^4.0.9", + "@types/mdast": "^4.0.4", + "astro-expressive-code": "^0.41.1", + "bcp-47": "^2.1.0", + "hast-util-from-html": "^2.0.1", + "hast-util-select": "^6.0.2", + "hast-util-to-string": "^3.0.0", + "hastscript": "^9.0.0", + "i18next": "^23.11.5", + "js-yaml": "^4.1.0", + "klona": "^2.0.6", + "mdast-util-directive": "^3.0.0", + "mdast-util-to-markdown": "^2.1.0", + "mdast-util-to-string": "^4.0.0", + "pagefind": "^1.3.0", + "rehype": "^13.0.1", + "rehype-format": "^5.0.0", + "remark-directive": "^3.0.0", + "ultrahtml": "^1.6.0", + "unified": "^11.0.5", + "unist-util-visit": "^5.0.0", + "vfile": "^6.0.2" + }, + "peerDependencies": { + "astro": "^5.5.0" + } + }, + "node_modules/@astrojs/telemetry": { + "version": "3.3.0", + "resolved": "https://registry.npmjs.org/@astrojs/telemetry/-/telemetry-3.3.0.tgz", + "integrity": "sha512-UFBgfeldP06qu6khs/yY+q1cDAaArM2/7AEIqQ9Cuvf7B1hNLq0xDrZkct+QoIGyjq56y8IaE2I3CTvG99mlhQ==", + "license": "MIT", + "dependencies": { + "ci-info": "^4.2.0", + "debug": "^4.4.0", + "dlv": "^1.1.3", + "dset": "^3.1.4", + "is-docker": "^3.0.0", + "is-wsl": "^3.1.0", + "which-pm-runs": "^1.1.0" + }, + "engines": { + "node": "18.20.8 || ^20.3.0 || >=22.0.0" + } + }, + "node_modules/@astrojs/yaml2ts": { + "version": "0.2.2", + "resolved": "https://registry.npmjs.org/@astrojs/yaml2ts/-/yaml2ts-0.2.2.tgz", + "integrity": "sha512-GOfvSr5Nqy2z5XiwqTouBBpy5FyI6DEe+/g/Mk5am9SjILN1S5fOEvYK0GuWHg98yS/dobP4m8qyqw/URW35fQ==", + "license": "MIT", + "dependencies": { + "yaml": "^2.5.0" + } + }, + "node_modules/@babel/code-frame": { + "version": "7.27.1", + "resolved": "https://registry.npmjs.org/@babel/code-frame/-/code-frame-7.27.1.tgz", + "integrity": "sha512-cjQ7ZlQ0Mv3b47hABuTevyTuYN4i+loJKGeV9flcCgIK37cCXRh+L1bd3iBHlynerhQ7BhCkn2BPbQUL+rGqFg==", + "license": "MIT", + "dependencies": { + "@babel/helper-validator-identifier": "^7.27.1", + "js-tokens": "^4.0.0", + "picocolors": "^1.1.1" + }, + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/compat-data": { + "version": "7.28.5", + "resolved": "https://registry.npmjs.org/@babel/compat-data/-/compat-data-7.28.5.tgz", + "integrity": "sha512-6uFXyCayocRbqhZOB+6XcuZbkMNimwfVGFji8CTZnCzOHVGvDqzvitu1re2AU5LROliz7eQPhB8CpAMvnx9EjA==", + "license": "MIT", + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/core": { + "version": "7.28.5", + "resolved": "https://registry.npmjs.org/@babel/core/-/core-7.28.5.tgz", + "integrity": "sha512-e7jT4DxYvIDLk1ZHmU/m/mB19rex9sv0c2ftBtjSBv+kVM/902eh0fINUzD7UwLLNR+jU585GxUJ8/EBfAM5fw==", + "license": "MIT", + "peer": true, + "dependencies": { + "@babel/code-frame": "^7.27.1", + "@babel/generator": "^7.28.5", + "@babel/helper-compilation-targets": "^7.27.2", + "@babel/helper-module-transforms": "^7.28.3", + "@babel/helpers": "^7.28.4", + "@babel/parser": "^7.28.5", + "@babel/template": "^7.27.2", + "@babel/traverse": "^7.28.5", + "@babel/types": "^7.28.5", + "@jridgewell/remapping": "^2.3.5", + "convert-source-map": "^2.0.0", + "debug": "^4.1.0", + "gensync": "^1.0.0-beta.2", + "json5": "^2.2.3", + "semver": "^6.3.1" + }, + "engines": { + "node": ">=6.9.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/babel" + } + }, + "node_modules/@babel/generator": { + "version": "7.28.5", + "resolved": "https://registry.npmjs.org/@babel/generator/-/generator-7.28.5.tgz", + "integrity": "sha512-3EwLFhZ38J4VyIP6WNtt2kUdW9dokXA9Cr4IVIFHuCpZ3H8/YFOl5JjZHisrn1fATPBmKKqXzDFvh9fUwHz6CQ==", + "license": "MIT", + "dependencies": { + "@babel/parser": "^7.28.5", + "@babel/types": "^7.28.5", + "@jridgewell/gen-mapping": "^0.3.12", + "@jridgewell/trace-mapping": "^0.3.28", + "jsesc": "^3.0.2" + }, + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/helper-compilation-targets": { + "version": "7.27.2", + "resolved": "https://registry.npmjs.org/@babel/helper-compilation-targets/-/helper-compilation-targets-7.27.2.tgz", + "integrity": "sha512-2+1thGUUWWjLTYTHZWK1n8Yga0ijBz1XAhUXcKy81rd5g6yh7hGqMp45v7cadSbEHc9G3OTv45SyneRN3ps4DQ==", + "license": "MIT", + "dependencies": { + "@babel/compat-data": "^7.27.2", + "@babel/helper-validator-option": "^7.27.1", + "browserslist": "^4.24.0", + "lru-cache": "^5.1.1", + "semver": "^6.3.1" + }, + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/helper-globals": { + "version": "7.28.0", + "resolved": "https://registry.npmjs.org/@babel/helper-globals/-/helper-globals-7.28.0.tgz", + "integrity": "sha512-+W6cISkXFa1jXsDEdYA8HeevQT/FULhxzR99pxphltZcVaugps53THCeiWA8SguxxpSp3gKPiuYfSWopkLQ4hw==", + "license": "MIT", + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/helper-module-imports": { + "version": "7.27.1", + "resolved": "https://registry.npmjs.org/@babel/helper-module-imports/-/helper-module-imports-7.27.1.tgz", + "integrity": "sha512-0gSFWUPNXNopqtIPQvlD5WgXYI5GY2kP2cCvoT8kczjbfcfuIljTbcWrulD1CIPIX2gt1wghbDy08yE1p+/r3w==", + "license": "MIT", + "dependencies": { + "@babel/traverse": "^7.27.1", + "@babel/types": "^7.27.1" + }, + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/helper-module-transforms": { + "version": "7.28.3", + "resolved": "https://registry.npmjs.org/@babel/helper-module-transforms/-/helper-module-transforms-7.28.3.tgz", + "integrity": "sha512-gytXUbs8k2sXS9PnQptz5o0QnpLL51SwASIORY6XaBKF88nsOT0Zw9szLqlSGQDP/4TljBAD5y98p2U1fqkdsw==", + "license": "MIT", + "dependencies": { + "@babel/helper-module-imports": "^7.27.1", + "@babel/helper-validator-identifier": "^7.27.1", + "@babel/traverse": "^7.28.3" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0" + } + }, + "node_modules/@babel/helper-plugin-utils": { + "version": "7.27.1", + "resolved": "https://registry.npmjs.org/@babel/helper-plugin-utils/-/helper-plugin-utils-7.27.1.tgz", + "integrity": "sha512-1gn1Up5YXka3YYAHGKpbideQ5Yjf1tDa9qYcgysz+cNCXukyLl6DjPXhD3VRwSb8c0J9tA4b2+rHEZtc6R0tlw==", + "license": "MIT", + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/helper-string-parser": { + "version": "7.27.1", + "resolved": "https://registry.npmjs.org/@babel/helper-string-parser/-/helper-string-parser-7.27.1.tgz", + "integrity": "sha512-qMlSxKbpRlAridDExk92nSobyDdpPijUq2DW6oDnUqd0iOGxmQjyqhMIihI9+zv4LPyZdRje2cavWPbCbWm3eA==", + "license": "MIT", + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/helper-validator-identifier": { + "version": "7.28.5", + "resolved": "https://registry.npmjs.org/@babel/helper-validator-identifier/-/helper-validator-identifier-7.28.5.tgz", + "integrity": "sha512-qSs4ifwzKJSV39ucNjsvc6WVHs6b7S03sOh2OcHF9UHfVPqWWALUsNUVzhSBiItjRZoLHx7nIarVjqKVusUZ1Q==", + "license": "MIT", + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/helper-validator-option": { + "version": "7.27.1", + "resolved": "https://registry.npmjs.org/@babel/helper-validator-option/-/helper-validator-option-7.27.1.tgz", + "integrity": "sha512-YvjJow9FxbhFFKDSuFnVCe2WxXk1zWc22fFePVNEaWJEu8IrZVlda6N0uHwzZrUM1il7NC9Mlp4MaJYbYd9JSg==", + "license": "MIT", + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/helpers": { + "version": "7.28.4", + "resolved": "https://registry.npmjs.org/@babel/helpers/-/helpers-7.28.4.tgz", + "integrity": "sha512-HFN59MmQXGHVyYadKLVumYsA9dBFun/ldYxipEjzA4196jpLZd8UjEEBLkbEkvfYreDqJhZxYAWFPtrfhNpj4w==", + "license": "MIT", + "dependencies": { + "@babel/template": "^7.27.2", + "@babel/types": "^7.28.4" + }, + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/parser": { + "version": "7.28.5", + "resolved": "https://registry.npmjs.org/@babel/parser/-/parser-7.28.5.tgz", + "integrity": "sha512-KKBU1VGYR7ORr3At5HAtUQ+TV3SzRCXmA/8OdDZiLDBIZxVyzXuztPjfLd3BV1PRAQGCMWWSHYhL0F8d5uHBDQ==", + "license": "MIT", + "dependencies": { + "@babel/types": "^7.28.5" + }, + "bin": { + "parser": "bin/babel-parser.js" + }, + "engines": { + "node": ">=6.0.0" + } + }, + "node_modules/@babel/plugin-transform-react-jsx-self": { + "version": "7.27.1", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-react-jsx-self/-/plugin-transform-react-jsx-self-7.27.1.tgz", + "integrity": "sha512-6UzkCs+ejGdZ5mFFC/OCUrv028ab2fp1znZmCZjAOBKiBK2jXD1O+BPSfX8X2qjJ75fZBMSnQn3Rq2mrBJK2mw==", + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.27.1" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-react-jsx-source": { + "version": "7.27.1", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-react-jsx-source/-/plugin-transform-react-jsx-source-7.27.1.tgz", + "integrity": "sha512-zbwoTsBruTeKB9hSq73ha66iFeJHuaFkUbwvqElnygoNbj/jHRsSeokowZFN3CZ64IvEqcmmkVe89OPXc7ldAw==", + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.27.1" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/runtime": { + "version": "7.28.4", + "resolved": "https://registry.npmjs.org/@babel/runtime/-/runtime-7.28.4.tgz", + "integrity": "sha512-Q/N6JNWvIvPnLDvjlE1OUBLPQHH6l3CltCEsHIujp45zQUSSh8K+gHnaEX45yAT1nyngnINhvWtzN+Nb9D8RAQ==", + "license": "MIT", + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/template": { + "version": "7.27.2", + "resolved": "https://registry.npmjs.org/@babel/template/-/template-7.27.2.tgz", + "integrity": "sha512-LPDZ85aEJyYSd18/DkjNh4/y1ntkE5KwUHWTiqgRxruuZL2F1yuHligVHLvcHY2vMHXttKFpJn6LwfI7cw7ODw==", + "license": "MIT", + "dependencies": { + "@babel/code-frame": "^7.27.1", + "@babel/parser": "^7.27.2", + "@babel/types": "^7.27.1" + }, + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/traverse": { + "version": "7.28.5", + "resolved": "https://registry.npmjs.org/@babel/traverse/-/traverse-7.28.5.tgz", + "integrity": "sha512-TCCj4t55U90khlYkVV/0TfkJkAkUg3jZFA3Neb7unZT8CPok7iiRfaX0F+WnqWqt7OxhOn0uBKXCw4lbL8W0aQ==", + "license": "MIT", + "dependencies": { + "@babel/code-frame": "^7.27.1", + "@babel/generator": "^7.28.5", + "@babel/helper-globals": "^7.28.0", + "@babel/parser": "^7.28.5", + "@babel/template": "^7.27.2", + "@babel/types": "^7.28.5", + "debug": "^4.3.1" + }, + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/types": { + "version": "7.28.5", + "resolved": "https://registry.npmjs.org/@babel/types/-/types-7.28.5.tgz", + "integrity": "sha512-qQ5m48eI/MFLQ5PxQj4PFaprjyCTLI37ElWMmNs0K8Lk3dVeOdNpB3ks8jc7yM5CDmVC73eMVk/trk3fgmrUpA==", + "license": "MIT", + "dependencies": { + "@babel/helper-string-parser": "^7.27.1", + "@babel/helper-validator-identifier": "^7.28.5" + }, + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@capsizecss/unpack": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/@capsizecss/unpack/-/unpack-3.0.1.tgz", + "integrity": "sha512-8XqW8xGn++Eqqbz3e9wKuK7mxryeRjs4LOHLxbh2lwKeSbuNR4NFifDZT4KzvjU6HMOPbiNTsWpniK5EJfTWkg==", + "license": "MIT", + "dependencies": { + "fontkit": "^2.0.2" + }, + "engines": { + "node": ">=18" + } + }, + "node_modules/@ctrl/tinycolor": { + "version": "4.2.0", + "resolved": "https://registry.npmjs.org/@ctrl/tinycolor/-/tinycolor-4.2.0.tgz", + "integrity": "sha512-kzyuwOAQnXJNLS9PSyrk0CWk35nWJW/zl/6KvnTBMFK65gm7U1/Z5BqjxeapjZCIhQcM/DsrEmcbRwDyXyXK4A==", + "license": "MIT", + "engines": { + "node": ">=14" + } + }, + "node_modules/@emmetio/abbreviation": { + "version": "2.3.3", + "resolved": "https://registry.npmjs.org/@emmetio/abbreviation/-/abbreviation-2.3.3.tgz", + "integrity": "sha512-mgv58UrU3rh4YgbE/TzgLQwJ3pFsHHhCLqY20aJq+9comytTXUDNGG/SMtSeMJdkpxgXSXunBGLD8Boka3JyVA==", + "license": "MIT", + "dependencies": { + "@emmetio/scanner": "^1.0.4" + } + }, + "node_modules/@emmetio/css-abbreviation": { + "version": "2.1.8", + "resolved": "https://registry.npmjs.org/@emmetio/css-abbreviation/-/css-abbreviation-2.1.8.tgz", + "integrity": "sha512-s9yjhJ6saOO/uk1V74eifykk2CBYi01STTK3WlXWGOepyKa23ymJ053+DNQjpFcy1ingpaO7AxCcwLvHFY9tuw==", + "license": "MIT", + "dependencies": { + "@emmetio/scanner": "^1.0.4" + } + }, + "node_modules/@emmetio/css-parser": { + "version": "0.4.0", + "resolved": "git+ssh://git@github.com/ramya-rao-a/css-parser.git#370c480ac103bd17c7bcfb34bf5d577dc40d3660", + "license": "MIT", + "dependencies": { + "@emmetio/stream-reader": "^2.2.0", + "@emmetio/stream-reader-utils": "^0.1.0" + } + }, + "node_modules/@emmetio/html-matcher": { + "version": "1.3.0", + "resolved": "https://registry.npmjs.org/@emmetio/html-matcher/-/html-matcher-1.3.0.tgz", + "integrity": "sha512-NTbsvppE5eVyBMuyGfVu2CRrLvo7J4YHb6t9sBFLyY03WYhXET37qA4zOYUjBWFCRHO7pS1B9khERtY0f5JXPQ==", + "license": "ISC", + "dependencies": { + "@emmetio/scanner": "^1.0.0" + } + }, + "node_modules/@emmetio/scanner": { + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/@emmetio/scanner/-/scanner-1.0.4.tgz", + "integrity": "sha512-IqRuJtQff7YHHBk4G8YZ45uB9BaAGcwQeVzgj/zj8/UdOhtQpEIupUhSk8dys6spFIWVZVeK20CzGEnqR5SbqA==", + "license": "MIT" + }, + "node_modules/@emmetio/stream-reader": { + "version": "2.2.0", + "resolved": "https://registry.npmjs.org/@emmetio/stream-reader/-/stream-reader-2.2.0.tgz", + "integrity": "sha512-fXVXEyFA5Yv3M3n8sUGT7+fvecGrZP4k6FnWWMSZVQf69kAq0LLpaBQLGcPR30m3zMmKYhECP4k/ZkzvhEW5kw==", + "license": "MIT" + }, + "node_modules/@emmetio/stream-reader-utils": { + "version": "0.1.0", + "resolved": "https://registry.npmjs.org/@emmetio/stream-reader-utils/-/stream-reader-utils-0.1.0.tgz", + "integrity": "sha512-ZsZ2I9Vzso3Ho/pjZFsmmZ++FWeEd/txqybHTm4OgaZzdS8V9V/YYWQwg5TC38Z7uLWUV1vavpLLbjJtKubR1A==", + "license": "MIT" + }, + "node_modules/@emnapi/runtime": { + "version": "1.7.1", + "resolved": "https://registry.npmjs.org/@emnapi/runtime/-/runtime-1.7.1.tgz", + "integrity": "sha512-PVtJr5CmLwYAU9PZDMITZoR5iAOShYREoR45EyyLrbntV50mdePTgUn4AmOw90Ifcj+x2kRjdzr1HP3RrNiHGA==", + "license": "MIT", + "optional": true, + "dependencies": { + "tslib": "^2.4.0" + } + }, + "node_modules/@esbuild/aix-ppc64": { + "version": "0.25.12", + "resolved": "https://registry.npmjs.org/@esbuild/aix-ppc64/-/aix-ppc64-0.25.12.tgz", + "integrity": "sha512-Hhmwd6CInZ3dwpuGTF8fJG6yoWmsToE+vYgD4nytZVxcu1ulHpUQRAB1UJ8+N1Am3Mz4+xOByoQoSZf4D+CpkA==", + "cpu": [ + "ppc64" + ], + "license": "MIT", + "optional": true, + "os": [ + "aix" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/android-arm": { + "version": "0.25.12", + "resolved": "https://registry.npmjs.org/@esbuild/android-arm/-/android-arm-0.25.12.tgz", + "integrity": "sha512-VJ+sKvNA/GE7Ccacc9Cha7bpS8nyzVv0jdVgwNDaR4gDMC/2TTRc33Ip8qrNYUcpkOHUT5OZ0bUcNNVZQ9RLlg==", + "cpu": [ + "arm" + ], + "license": "MIT", + "optional": true, + "os": [ + "android" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/android-arm64": { + "version": "0.25.12", + "resolved": "https://registry.npmjs.org/@esbuild/android-arm64/-/android-arm64-0.25.12.tgz", + "integrity": "sha512-6AAmLG7zwD1Z159jCKPvAxZd4y/VTO0VkprYy+3N2FtJ8+BQWFXU+OxARIwA46c5tdD9SsKGZ/1ocqBS/gAKHg==", + "cpu": [ + "arm64" + ], + "license": "MIT", + "optional": true, + "os": [ + "android" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/android-x64": { + "version": "0.25.12", + "resolved": "https://registry.npmjs.org/@esbuild/android-x64/-/android-x64-0.25.12.tgz", + "integrity": "sha512-5jbb+2hhDHx5phYR2By8GTWEzn6I9UqR11Kwf22iKbNpYrsmRB18aX/9ivc5cabcUiAT/wM+YIZ6SG9QO6a8kg==", + "cpu": [ + "x64" + ], + "license": "MIT", + "optional": true, + "os": [ + "android" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/darwin-arm64": { + "version": "0.25.12", + "resolved": "https://registry.npmjs.org/@esbuild/darwin-arm64/-/darwin-arm64-0.25.12.tgz", + "integrity": "sha512-N3zl+lxHCifgIlcMUP5016ESkeQjLj/959RxxNYIthIg+CQHInujFuXeWbWMgnTo4cp5XVHqFPmpyu9J65C1Yg==", + "cpu": [ + "arm64" + ], + "license": "MIT", + "optional": true, + "os": [ + "darwin" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/darwin-x64": { + "version": "0.25.12", + "resolved": "https://registry.npmjs.org/@esbuild/darwin-x64/-/darwin-x64-0.25.12.tgz", + "integrity": "sha512-HQ9ka4Kx21qHXwtlTUVbKJOAnmG1ipXhdWTmNXiPzPfWKpXqASVcWdnf2bnL73wgjNrFXAa3yYvBSd9pzfEIpA==", + "cpu": [ + "x64" + ], + "license": "MIT", + "optional": true, + "os": [ + "darwin" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/freebsd-arm64": { + "version": "0.25.12", + "resolved": "https://registry.npmjs.org/@esbuild/freebsd-arm64/-/freebsd-arm64-0.25.12.tgz", + "integrity": "sha512-gA0Bx759+7Jve03K1S0vkOu5Lg/85dou3EseOGUes8flVOGxbhDDh/iZaoek11Y8mtyKPGF3vP8XhnkDEAmzeg==", + "cpu": [ + "arm64" + ], + "license": "MIT", + "optional": true, + "os": [ + "freebsd" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/freebsd-x64": { + "version": "0.25.12", + "resolved": "https://registry.npmjs.org/@esbuild/freebsd-x64/-/freebsd-x64-0.25.12.tgz", + "integrity": "sha512-TGbO26Yw2xsHzxtbVFGEXBFH0FRAP7gtcPE7P5yP7wGy7cXK2oO7RyOhL5NLiqTlBh47XhmIUXuGciXEqYFfBQ==", + "cpu": [ + "x64" + ], + "license": "MIT", + "optional": true, + "os": [ + "freebsd" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/linux-arm": { + "version": "0.25.12", + "resolved": "https://registry.npmjs.org/@esbuild/linux-arm/-/linux-arm-0.25.12.tgz", + "integrity": "sha512-lPDGyC1JPDou8kGcywY0YILzWlhhnRjdof3UlcoqYmS9El818LLfJJc3PXXgZHrHCAKs/Z2SeZtDJr5MrkxtOw==", + "cpu": [ + "arm" + ], + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/linux-arm64": { + "version": "0.25.12", + "resolved": "https://registry.npmjs.org/@esbuild/linux-arm64/-/linux-arm64-0.25.12.tgz", + "integrity": "sha512-8bwX7a8FghIgrupcxb4aUmYDLp8pX06rGh5HqDT7bB+8Rdells6mHvrFHHW2JAOPZUbnjUpKTLg6ECyzvas2AQ==", + "cpu": [ + "arm64" + ], + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/linux-ia32": { + "version": "0.25.12", + "resolved": "https://registry.npmjs.org/@esbuild/linux-ia32/-/linux-ia32-0.25.12.tgz", + "integrity": "sha512-0y9KrdVnbMM2/vG8KfU0byhUN+EFCny9+8g202gYqSSVMonbsCfLjUO+rCci7pM0WBEtz+oK/PIwHkzxkyharA==", + "cpu": [ + "ia32" + ], + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/linux-loong64": { + "version": "0.25.12", + "resolved": "https://registry.npmjs.org/@esbuild/linux-loong64/-/linux-loong64-0.25.12.tgz", + "integrity": "sha512-h///Lr5a9rib/v1GGqXVGzjL4TMvVTv+s1DPoxQdz7l/AYv6LDSxdIwzxkrPW438oUXiDtwM10o9PmwS/6Z0Ng==", + "cpu": [ + "loong64" + ], + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/linux-mips64el": { + "version": "0.25.12", + "resolved": "https://registry.npmjs.org/@esbuild/linux-mips64el/-/linux-mips64el-0.25.12.tgz", + "integrity": "sha512-iyRrM1Pzy9GFMDLsXn1iHUm18nhKnNMWscjmp4+hpafcZjrr2WbT//d20xaGljXDBYHqRcl8HnxbX6uaA/eGVw==", + "cpu": [ + "mips64el" + ], + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/linux-ppc64": { + "version": "0.25.12", + "resolved": "https://registry.npmjs.org/@esbuild/linux-ppc64/-/linux-ppc64-0.25.12.tgz", + "integrity": "sha512-9meM/lRXxMi5PSUqEXRCtVjEZBGwB7P/D4yT8UG/mwIdze2aV4Vo6U5gD3+RsoHXKkHCfSxZKzmDssVlRj1QQA==", + "cpu": [ + "ppc64" + ], + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/linux-riscv64": { + "version": "0.25.12", + "resolved": "https://registry.npmjs.org/@esbuild/linux-riscv64/-/linux-riscv64-0.25.12.tgz", + "integrity": "sha512-Zr7KR4hgKUpWAwb1f3o5ygT04MzqVrGEGXGLnj15YQDJErYu/BGg+wmFlIDOdJp0PmB0lLvxFIOXZgFRrdjR0w==", + "cpu": [ + "riscv64" + ], + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/linux-s390x": { + "version": "0.25.12", + "resolved": "https://registry.npmjs.org/@esbuild/linux-s390x/-/linux-s390x-0.25.12.tgz", + "integrity": "sha512-MsKncOcgTNvdtiISc/jZs/Zf8d0cl/t3gYWX8J9ubBnVOwlk65UIEEvgBORTiljloIWnBzLs4qhzPkJcitIzIg==", + "cpu": [ + "s390x" + ], + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/linux-x64": { + "version": "0.25.12", + "resolved": "https://registry.npmjs.org/@esbuild/linux-x64/-/linux-x64-0.25.12.tgz", + "integrity": "sha512-uqZMTLr/zR/ed4jIGnwSLkaHmPjOjJvnm6TVVitAa08SLS9Z0VM8wIRx7gWbJB5/J54YuIMInDquWyYvQLZkgw==", + "cpu": [ + "x64" + ], + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/netbsd-arm64": { + "version": "0.25.12", + "resolved": "https://registry.npmjs.org/@esbuild/netbsd-arm64/-/netbsd-arm64-0.25.12.tgz", + "integrity": "sha512-xXwcTq4GhRM7J9A8Gv5boanHhRa/Q9KLVmcyXHCTaM4wKfIpWkdXiMog/KsnxzJ0A1+nD+zoecuzqPmCRyBGjg==", + "cpu": [ + "arm64" + ], + "license": "MIT", + "optional": true, + "os": [ + "netbsd" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/netbsd-x64": { + "version": "0.25.12", + "resolved": "https://registry.npmjs.org/@esbuild/netbsd-x64/-/netbsd-x64-0.25.12.tgz", + "integrity": "sha512-Ld5pTlzPy3YwGec4OuHh1aCVCRvOXdH8DgRjfDy/oumVovmuSzWfnSJg+VtakB9Cm0gxNO9BzWkj6mtO1FMXkQ==", + "cpu": [ + "x64" + ], + "license": "MIT", + "optional": true, + "os": [ + "netbsd" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/openbsd-arm64": { + "version": "0.25.12", + "resolved": "https://registry.npmjs.org/@esbuild/openbsd-arm64/-/openbsd-arm64-0.25.12.tgz", + "integrity": "sha512-fF96T6KsBo/pkQI950FARU9apGNTSlZGsv1jZBAlcLL1MLjLNIWPBkj5NlSz8aAzYKg+eNqknrUJ24QBybeR5A==", + "cpu": [ + "arm64" + ], + "license": "MIT", + "optional": true, + "os": [ + "openbsd" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/openbsd-x64": { + "version": "0.25.12", + "resolved": "https://registry.npmjs.org/@esbuild/openbsd-x64/-/openbsd-x64-0.25.12.tgz", + "integrity": "sha512-MZyXUkZHjQxUvzK7rN8DJ3SRmrVrke8ZyRusHlP+kuwqTcfWLyqMOE3sScPPyeIXN/mDJIfGXvcMqCgYKekoQw==", + "cpu": [ + "x64" + ], + "license": "MIT", + "optional": true, + "os": [ + "openbsd" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/openharmony-arm64": { + "version": "0.25.12", + "resolved": "https://registry.npmjs.org/@esbuild/openharmony-arm64/-/openharmony-arm64-0.25.12.tgz", + "integrity": "sha512-rm0YWsqUSRrjncSXGA7Zv78Nbnw4XL6/dzr20cyrQf7ZmRcsovpcRBdhD43Nuk3y7XIoW2OxMVvwuRvk9XdASg==", + "cpu": [ + "arm64" + ], + "license": "MIT", + "optional": true, + "os": [ + "openharmony" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/sunos-x64": { + "version": "0.25.12", + "resolved": "https://registry.npmjs.org/@esbuild/sunos-x64/-/sunos-x64-0.25.12.tgz", + "integrity": "sha512-3wGSCDyuTHQUzt0nV7bocDy72r2lI33QL3gkDNGkod22EsYl04sMf0qLb8luNKTOmgF/eDEDP5BFNwoBKH441w==", + "cpu": [ + "x64" + ], + "license": "MIT", + "optional": true, + "os": [ + "sunos" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/win32-arm64": { + "version": "0.25.12", + "resolved": "https://registry.npmjs.org/@esbuild/win32-arm64/-/win32-arm64-0.25.12.tgz", + "integrity": "sha512-rMmLrur64A7+DKlnSuwqUdRKyd3UE7oPJZmnljqEptesKM8wx9J8gx5u0+9Pq0fQQW8vqeKebwNXdfOyP+8Bsg==", + "cpu": [ + "arm64" + ], + "license": "MIT", + "optional": true, + "os": [ + "win32" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/win32-ia32": { + "version": "0.25.12", + "resolved": "https://registry.npmjs.org/@esbuild/win32-ia32/-/win32-ia32-0.25.12.tgz", + "integrity": "sha512-HkqnmmBoCbCwxUKKNPBixiWDGCpQGVsrQfJoVGYLPT41XWF8lHuE5N6WhVia2n4o5QK5M4tYr21827fNhi4byQ==", + "cpu": [ + "ia32" + ], + "license": "MIT", + "optional": true, + "os": [ + "win32" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/win32-x64": { + "version": "0.25.12", + "resolved": "https://registry.npmjs.org/@esbuild/win32-x64/-/win32-x64-0.25.12.tgz", + "integrity": "sha512-alJC0uCZpTFrSL0CCDjcgleBXPnCrEAhTBILpeAp7M/OFgoqtAetfBzX0xM00MUsVVPpVjlPuMbREqnZCXaTnA==", + "cpu": [ + "x64" + ], + "license": "MIT", + "optional": true, + "os": [ + "win32" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@expressive-code/core": { + "version": "0.41.3", + "resolved": "https://registry.npmjs.org/@expressive-code/core/-/core-0.41.3.tgz", + "integrity": "sha512-9qzohqU7O0+JwMEEgQhnBPOw5DtsQRBXhW++5fvEywsuX44vCGGof1SL5OvPElvNgaWZ4pFZAFSlkNOkGyLwSQ==", + "license": "MIT", + "dependencies": { + "@ctrl/tinycolor": "^4.0.4", + "hast-util-select": "^6.0.2", + "hast-util-to-html": "^9.0.1", + "hast-util-to-text": "^4.0.1", + "hastscript": "^9.0.0", + "postcss": "^8.4.38", + "postcss-nested": "^6.0.1", + "unist-util-visit": "^5.0.0", + "unist-util-visit-parents": "^6.0.1" + } + }, + "node_modules/@expressive-code/plugin-frames": { + "version": "0.41.3", + "resolved": "https://registry.npmjs.org/@expressive-code/plugin-frames/-/plugin-frames-0.41.3.tgz", + "integrity": "sha512-rFQtmf/3N2CK3Cq/uERweMTYZnBu+CwxBdHuOftEmfA9iBE7gTVvwpbh82P9ZxkPLvc40UMhYt7uNuAZexycRQ==", + "license": "MIT", + "dependencies": { + "@expressive-code/core": "^0.41.3" + } + }, + "node_modules/@expressive-code/plugin-shiki": { + "version": "0.41.3", + "resolved": "https://registry.npmjs.org/@expressive-code/plugin-shiki/-/plugin-shiki-0.41.3.tgz", + "integrity": "sha512-RlTARoopzhFJIOVHLGvuXJ8DCEme/hjV+ZnRJBIxzxsKVpGPW4Oshqg9xGhWTYdHstTsxO663s0cdBLzZj9TQA==", + "license": "MIT", + "dependencies": { + "@expressive-code/core": "^0.41.3", + "shiki": "^3.2.2" + } + }, + "node_modules/@expressive-code/plugin-text-markers": { + "version": "0.41.3", + "resolved": "https://registry.npmjs.org/@expressive-code/plugin-text-markers/-/plugin-text-markers-0.41.3.tgz", + "integrity": "sha512-SN8tkIzDpA0HLAscEYD2IVrfLiid6qEdE9QLlGVSxO1KEw7qYvjpbNBQjUjMr5/jvTJ7ys6zysU2vLPHE0sb2g==", + "license": "MIT", + "dependencies": { + "@expressive-code/core": "^0.41.3" + } + }, + "node_modules/@img/colour": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/@img/colour/-/colour-1.0.0.tgz", + "integrity": "sha512-A5P/LfWGFSl6nsckYtjw9da+19jB8hkJ6ACTGcDfEJ0aE+l2n2El7dsVM7UVHZQ9s2lmYMWlrS21YLy2IR1LUw==", + "license": "MIT", + "optional": true, + "engines": { + "node": ">=18" + } + }, + "node_modules/@img/sharp-darwin-arm64": { + "version": "0.33.5", + "resolved": "https://registry.npmjs.org/@img/sharp-darwin-arm64/-/sharp-darwin-arm64-0.33.5.tgz", + "integrity": "sha512-UT4p+iz/2H4twwAoLCqfA9UH5pI6DggwKEGuaPy7nCVQ8ZsiY5PIcrRvD1DzuY3qYL07NtIQcWnBSY/heikIFQ==", + "cpu": [ + "arm64" + ], + "license": "Apache-2.0", + "optional": true, + "os": [ + "darwin" + ], + "engines": { + "node": "^18.17.0 || ^20.3.0 || >=21.0.0" + }, + "funding": { + "url": "https://opencollective.com/libvips" + }, + "optionalDependencies": { + "@img/sharp-libvips-darwin-arm64": "1.0.4" + } + }, + "node_modules/@img/sharp-darwin-x64": { + "version": "0.33.5", + "resolved": "https://registry.npmjs.org/@img/sharp-darwin-x64/-/sharp-darwin-x64-0.33.5.tgz", + "integrity": "sha512-fyHac4jIc1ANYGRDxtiqelIbdWkIuQaI84Mv45KvGRRxSAa7o7d1ZKAOBaYbnepLC1WqxfpimdeWfvqqSGwR2Q==", + "cpu": [ + "x64" + ], + "license": "Apache-2.0", + "optional": true, + "os": [ + "darwin" + ], + "engines": { + "node": "^18.17.0 || ^20.3.0 || >=21.0.0" + }, + "funding": { + "url": "https://opencollective.com/libvips" + }, + "optionalDependencies": { + "@img/sharp-libvips-darwin-x64": "1.0.4" + } + }, + "node_modules/@img/sharp-libvips-darwin-arm64": { + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/@img/sharp-libvips-darwin-arm64/-/sharp-libvips-darwin-arm64-1.0.4.tgz", + "integrity": "sha512-XblONe153h0O2zuFfTAbQYAX2JhYmDHeWikp1LM9Hul9gVPjFY427k6dFEcOL72O01QxQsWi761svJ/ev9xEDg==", + "cpu": [ + "arm64" + ], + "license": "LGPL-3.0-or-later", + "optional": true, + "os": [ + "darwin" + ], + "funding": { + "url": "https://opencollective.com/libvips" + } + }, + "node_modules/@img/sharp-libvips-darwin-x64": { + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/@img/sharp-libvips-darwin-x64/-/sharp-libvips-darwin-x64-1.0.4.tgz", + "integrity": "sha512-xnGR8YuZYfJGmWPvmlunFaWJsb9T/AO2ykoP3Fz/0X5XV2aoYBPkX6xqCQvUTKKiLddarLaxpzNe+b1hjeWHAQ==", + "cpu": [ + "x64" + ], + "license": "LGPL-3.0-or-later", + "optional": true, + "os": [ + "darwin" + ], + "funding": { + "url": "https://opencollective.com/libvips" + } + }, + "node_modules/@img/sharp-libvips-linux-arm": { + "version": "1.0.5", + "resolved": "https://registry.npmjs.org/@img/sharp-libvips-linux-arm/-/sharp-libvips-linux-arm-1.0.5.tgz", + "integrity": "sha512-gvcC4ACAOPRNATg/ov8/MnbxFDJqf/pDePbBnuBDcjsI8PssmjoKMAz4LtLaVi+OnSb5FK/yIOamqDwGmXW32g==", + "cpu": [ + "arm" + ], + "license": "LGPL-3.0-or-later", + "optional": true, + "os": [ + "linux" + ], + "funding": { + "url": "https://opencollective.com/libvips" + } + }, + "node_modules/@img/sharp-libvips-linux-arm64": { + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/@img/sharp-libvips-linux-arm64/-/sharp-libvips-linux-arm64-1.0.4.tgz", + "integrity": "sha512-9B+taZ8DlyyqzZQnoeIvDVR/2F4EbMepXMc/NdVbkzsJbzkUjhXv/70GQJ7tdLA4YJgNP25zukcxpX2/SueNrA==", + "cpu": [ + "arm64" + ], + "license": "LGPL-3.0-or-later", + "optional": true, + "os": [ + "linux" + ], + "funding": { + "url": "https://opencollective.com/libvips" + } + }, + "node_modules/@img/sharp-libvips-linux-ppc64": { + "version": "1.2.4", + "resolved": "https://registry.npmjs.org/@img/sharp-libvips-linux-ppc64/-/sharp-libvips-linux-ppc64-1.2.4.tgz", + "integrity": "sha512-FMuvGijLDYG6lW+b/UvyilUWu5Ayu+3r2d1S8notiGCIyYU/76eig1UfMmkZ7vwgOrzKzlQbFSuQfgm7GYUPpA==", + "cpu": [ + "ppc64" + ], + "license": "LGPL-3.0-or-later", + "optional": true, + "os": [ + "linux" + ], + "funding": { + "url": "https://opencollective.com/libvips" + } + }, + "node_modules/@img/sharp-libvips-linux-riscv64": { + "version": "1.2.4", + "resolved": "https://registry.npmjs.org/@img/sharp-libvips-linux-riscv64/-/sharp-libvips-linux-riscv64-1.2.4.tgz", + "integrity": "sha512-oVDbcR4zUC0ce82teubSm+x6ETixtKZBh/qbREIOcI3cULzDyb18Sr/Wcyx7NRQeQzOiHTNbZFF1UwPS2scyGA==", + "cpu": [ + "riscv64" + ], + "license": "LGPL-3.0-or-later", + "optional": true, + "os": [ + "linux" + ], + "funding": { + "url": "https://opencollective.com/libvips" + } + }, + "node_modules/@img/sharp-libvips-linux-s390x": { + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/@img/sharp-libvips-linux-s390x/-/sharp-libvips-linux-s390x-1.0.4.tgz", + "integrity": "sha512-u7Wz6ntiSSgGSGcjZ55im6uvTrOxSIS8/dgoVMoiGE9I6JAfU50yH5BoDlYA1tcuGS7g/QNtetJnxA6QEsCVTA==", + "cpu": [ + "s390x" + ], + "license": "LGPL-3.0-or-later", + "optional": true, + "os": [ + "linux" + ], + "funding": { + "url": "https://opencollective.com/libvips" + } + }, + "node_modules/@img/sharp-libvips-linux-x64": { + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/@img/sharp-libvips-linux-x64/-/sharp-libvips-linux-x64-1.0.4.tgz", + "integrity": "sha512-MmWmQ3iPFZr0Iev+BAgVMb3ZyC4KeFc3jFxnNbEPas60e1cIfevbtuyf9nDGIzOaW9PdnDciJm+wFFaTlj5xYw==", + "cpu": [ + "x64" + ], + "license": "LGPL-3.0-or-later", + "optional": true, + "os": [ + "linux" + ], + "funding": { + "url": "https://opencollective.com/libvips" + } + }, + "node_modules/@img/sharp-libvips-linuxmusl-arm64": { + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/@img/sharp-libvips-linuxmusl-arm64/-/sharp-libvips-linuxmusl-arm64-1.0.4.tgz", + "integrity": "sha512-9Ti+BbTYDcsbp4wfYib8Ctm1ilkugkA/uscUn6UXK1ldpC1JjiXbLfFZtRlBhjPZ5o1NCLiDbg8fhUPKStHoTA==", + "cpu": [ + "arm64" + ], + "license": "LGPL-3.0-or-later", + "optional": true, + "os": [ + "linux" + ], + "funding": { + "url": "https://opencollective.com/libvips" + } + }, + "node_modules/@img/sharp-libvips-linuxmusl-x64": { + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/@img/sharp-libvips-linuxmusl-x64/-/sharp-libvips-linuxmusl-x64-1.0.4.tgz", + "integrity": "sha512-viYN1KX9m+/hGkJtvYYp+CCLgnJXwiQB39damAO7WMdKWlIhmYTfHjwSbQeUK/20vY154mwezd9HflVFM1wVSw==", + "cpu": [ + "x64" + ], + "license": "LGPL-3.0-or-later", + "optional": true, + "os": [ + "linux" + ], + "funding": { + "url": "https://opencollective.com/libvips" + } + }, + "node_modules/@img/sharp-linux-arm": { + "version": "0.33.5", + "resolved": "https://registry.npmjs.org/@img/sharp-linux-arm/-/sharp-linux-arm-0.33.5.tgz", + "integrity": "sha512-JTS1eldqZbJxjvKaAkxhZmBqPRGmxgu+qFKSInv8moZ2AmT5Yib3EQ1c6gp493HvrvV8QgdOXdyaIBrhvFhBMQ==", + "cpu": [ + "arm" + ], + "license": "Apache-2.0", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": "^18.17.0 || ^20.3.0 || >=21.0.0" + }, + "funding": { + "url": "https://opencollective.com/libvips" + }, + "optionalDependencies": { + "@img/sharp-libvips-linux-arm": "1.0.5" + } + }, + "node_modules/@img/sharp-linux-arm64": { + "version": "0.33.5", + "resolved": "https://registry.npmjs.org/@img/sharp-linux-arm64/-/sharp-linux-arm64-0.33.5.tgz", + "integrity": "sha512-JMVv+AMRyGOHtO1RFBiJy/MBsgz0x4AWrT6QoEVVTyh1E39TrCUpTRI7mx9VksGX4awWASxqCYLCV4wBZHAYxA==", + "cpu": [ + "arm64" + ], + "license": "Apache-2.0", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": "^18.17.0 || ^20.3.0 || >=21.0.0" + }, + "funding": { + "url": "https://opencollective.com/libvips" + }, + "optionalDependencies": { + "@img/sharp-libvips-linux-arm64": "1.0.4" + } + }, + "node_modules/@img/sharp-linux-ppc64": { + "version": "0.34.5", + "resolved": "https://registry.npmjs.org/@img/sharp-linux-ppc64/-/sharp-linux-ppc64-0.34.5.tgz", + "integrity": "sha512-7zznwNaqW6YtsfrGGDA6BRkISKAAE1Jo0QdpNYXNMHu2+0dTrPflTLNkpc8l7MUP5M16ZJcUvysVWWrMefZquA==", + "cpu": [ + "ppc64" + ], + "license": "Apache-2.0", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": "^18.17.0 || ^20.3.0 || >=21.0.0" + }, + "funding": { + "url": "https://opencollective.com/libvips" + }, + "optionalDependencies": { + "@img/sharp-libvips-linux-ppc64": "1.2.4" + } + }, + "node_modules/@img/sharp-linux-riscv64": { + "version": "0.34.5", + "resolved": "https://registry.npmjs.org/@img/sharp-linux-riscv64/-/sharp-linux-riscv64-0.34.5.tgz", + "integrity": "sha512-51gJuLPTKa7piYPaVs8GmByo7/U7/7TZOq+cnXJIHZKavIRHAP77e3N2HEl3dgiqdD/w0yUfiJnII77PuDDFdw==", + "cpu": [ + "riscv64" + ], + "license": "Apache-2.0", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": "^18.17.0 || ^20.3.0 || >=21.0.0" + }, + "funding": { + "url": "https://opencollective.com/libvips" + }, + "optionalDependencies": { + "@img/sharp-libvips-linux-riscv64": "1.2.4" + } + }, + "node_modules/@img/sharp-linux-s390x": { + "version": "0.33.5", + "resolved": "https://registry.npmjs.org/@img/sharp-linux-s390x/-/sharp-linux-s390x-0.33.5.tgz", + "integrity": "sha512-y/5PCd+mP4CA/sPDKl2961b+C9d+vPAveS33s6Z3zfASk2j5upL6fXVPZi7ztePZ5CuH+1kW8JtvxgbuXHRa4Q==", + "cpu": [ + "s390x" + ], + "license": "Apache-2.0", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": "^18.17.0 || ^20.3.0 || >=21.0.0" + }, + "funding": { + "url": "https://opencollective.com/libvips" + }, + "optionalDependencies": { + "@img/sharp-libvips-linux-s390x": "1.0.4" + } + }, + "node_modules/@img/sharp-linux-x64": { + "version": "0.33.5", + "resolved": "https://registry.npmjs.org/@img/sharp-linux-x64/-/sharp-linux-x64-0.33.5.tgz", + "integrity": "sha512-opC+Ok5pRNAzuvq1AG0ar+1owsu842/Ab+4qvU879ippJBHvyY5n2mxF1izXqkPYlGuP/M556uh53jRLJmzTWA==", + "cpu": [ + "x64" + ], + "license": "Apache-2.0", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": "^18.17.0 || ^20.3.0 || >=21.0.0" + }, + "funding": { + "url": "https://opencollective.com/libvips" + }, + "optionalDependencies": { + "@img/sharp-libvips-linux-x64": "1.0.4" + } + }, + "node_modules/@img/sharp-linuxmusl-arm64": { + "version": "0.33.5", + "resolved": "https://registry.npmjs.org/@img/sharp-linuxmusl-arm64/-/sharp-linuxmusl-arm64-0.33.5.tgz", + "integrity": "sha512-XrHMZwGQGvJg2V/oRSUfSAfjfPxO+4DkiRh6p2AFjLQztWUuY/o8Mq0eMQVIY7HJ1CDQUJlxGGZRw1a5bqmd1g==", + "cpu": [ + "arm64" + ], + "license": "Apache-2.0", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": "^18.17.0 || ^20.3.0 || >=21.0.0" + }, + "funding": { + "url": "https://opencollective.com/libvips" + }, + "optionalDependencies": { + "@img/sharp-libvips-linuxmusl-arm64": "1.0.4" + } + }, + "node_modules/@img/sharp-linuxmusl-x64": { + "version": "0.33.5", + "resolved": "https://registry.npmjs.org/@img/sharp-linuxmusl-x64/-/sharp-linuxmusl-x64-0.33.5.tgz", + "integrity": "sha512-WT+d/cgqKkkKySYmqoZ8y3pxx7lx9vVejxW/W4DOFMYVSkErR+w7mf2u8m/y4+xHe7yY9DAXQMWQhpnMuFfScw==", + "cpu": [ + "x64" + ], + "license": "Apache-2.0", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": "^18.17.0 || ^20.3.0 || >=21.0.0" + }, + "funding": { + "url": "https://opencollective.com/libvips" + }, + "optionalDependencies": { + "@img/sharp-libvips-linuxmusl-x64": "1.0.4" + } + }, + "node_modules/@img/sharp-wasm32": { + "version": "0.33.5", + "resolved": "https://registry.npmjs.org/@img/sharp-wasm32/-/sharp-wasm32-0.33.5.tgz", + "integrity": "sha512-ykUW4LVGaMcU9lu9thv85CbRMAwfeadCJHRsg2GmeRa/cJxsVY9Rbd57JcMxBkKHag5U/x7TSBpScF4U8ElVzg==", + "cpu": [ + "wasm32" + ], + "license": "Apache-2.0 AND LGPL-3.0-or-later AND MIT", + "optional": true, + "dependencies": { + "@emnapi/runtime": "^1.2.0" + }, + "engines": { + "node": "^18.17.0 || ^20.3.0 || >=21.0.0" + }, + "funding": { + "url": "https://opencollective.com/libvips" + } + }, + "node_modules/@img/sharp-win32-arm64": { + "version": "0.34.5", + "resolved": "https://registry.npmjs.org/@img/sharp-win32-arm64/-/sharp-win32-arm64-0.34.5.tgz", + "integrity": "sha512-WQ3AgWCWYSb2yt+IG8mnC6Jdk9Whs7O0gxphblsLvdhSpSTtmu69ZG1Gkb6NuvxsNACwiPV6cNSZNzt0KPsw7g==", + "cpu": [ + "arm64" + ], + "license": "Apache-2.0 AND LGPL-3.0-or-later", + "optional": true, + "os": [ + "win32" + ], + "engines": { + "node": "^18.17.0 || ^20.3.0 || >=21.0.0" + }, + "funding": { + "url": "https://opencollective.com/libvips" + } + }, + "node_modules/@img/sharp-win32-ia32": { + "version": "0.33.5", + "resolved": "https://registry.npmjs.org/@img/sharp-win32-ia32/-/sharp-win32-ia32-0.33.5.tgz", + "integrity": "sha512-T36PblLaTwuVJ/zw/LaH0PdZkRz5rd3SmMHX8GSmR7vtNSP5Z6bQkExdSK7xGWyxLw4sUknBuugTelgw2faBbQ==", + "cpu": [ + "ia32" + ], + "license": "Apache-2.0 AND LGPL-3.0-or-later", + "optional": true, + "os": [ + "win32" + ], + "engines": { + "node": "^18.17.0 || ^20.3.0 || >=21.0.0" + }, + "funding": { + "url": "https://opencollective.com/libvips" + } + }, + "node_modules/@img/sharp-win32-x64": { + "version": "0.33.5", + "resolved": "https://registry.npmjs.org/@img/sharp-win32-x64/-/sharp-win32-x64-0.33.5.tgz", + "integrity": "sha512-MpY/o8/8kj+EcnxwvrP4aTJSWw/aZ7JIGR4aBeZkZw5B7/Jn+tY9/VNwtcoGmdT7GfggGIU4kygOMSbYnOrAbg==", + "cpu": [ + "x64" + ], + "license": "Apache-2.0 AND LGPL-3.0-or-later", + "optional": true, + "os": [ + "win32" + ], + "engines": { + "node": "^18.17.0 || ^20.3.0 || >=21.0.0" + }, + "funding": { + "url": "https://opencollective.com/libvips" + } + }, + "node_modules/@jridgewell/gen-mapping": { + "version": "0.3.13", + "resolved": "https://registry.npmjs.org/@jridgewell/gen-mapping/-/gen-mapping-0.3.13.tgz", + "integrity": "sha512-2kkt/7niJ6MgEPxF0bYdQ6etZaA+fQvDcLKckhy1yIQOzaoKjBBjSj63/aLVjYE3qhRt5dvM+uUyfCg6UKCBbA==", + "license": "MIT", + "dependencies": { + "@jridgewell/sourcemap-codec": "^1.5.0", + "@jridgewell/trace-mapping": "^0.3.24" + } + }, + "node_modules/@jridgewell/remapping": { + "version": "2.3.5", + "resolved": "https://registry.npmjs.org/@jridgewell/remapping/-/remapping-2.3.5.tgz", + "integrity": "sha512-LI9u/+laYG4Ds1TDKSJW2YPrIlcVYOwi2fUC6xB43lueCjgxV4lffOCZCtYFiH6TNOX+tQKXx97T4IKHbhyHEQ==", + "license": "MIT", + "dependencies": { + "@jridgewell/gen-mapping": "^0.3.5", + "@jridgewell/trace-mapping": "^0.3.24" + } + }, + "node_modules/@jridgewell/resolve-uri": { + "version": "3.1.2", + "resolved": "https://registry.npmjs.org/@jridgewell/resolve-uri/-/resolve-uri-3.1.2.tgz", + "integrity": "sha512-bRISgCIjP20/tbWSPWMEi54QVPRZExkuD9lJL+UIxUKtwVJA8wW1Trb1jMs1RFXo1CBTNZ/5hpC9QvmKWdopKw==", + "license": "MIT", + "engines": { + "node": ">=6.0.0" + } + }, + "node_modules/@jridgewell/sourcemap-codec": { + "version": "1.5.5", + "resolved": "https://registry.npmjs.org/@jridgewell/sourcemap-codec/-/sourcemap-codec-1.5.5.tgz", + "integrity": "sha512-cYQ9310grqxueWbl+WuIUIaiUaDcj7WOq5fVhEljNVgRfOUhY9fy2zTvfoqWsnebh8Sl70VScFbICvJnLKB0Og==", + "license": "MIT" + }, + "node_modules/@jridgewell/trace-mapping": { + "version": "0.3.31", + "resolved": "https://registry.npmjs.org/@jridgewell/trace-mapping/-/trace-mapping-0.3.31.tgz", + "integrity": "sha512-zzNR+SdQSDJzc8joaeP8QQoCQr8NuYx2dIIytl1QeBEZHJ9uW6hebsrYgbz8hJwUQao3TWCMtmfV8Nu1twOLAw==", + "license": "MIT", + "dependencies": { + "@jridgewell/resolve-uri": "^3.1.0", + "@jridgewell/sourcemap-codec": "^1.4.14" + } + }, + "node_modules/@mdx-js/mdx": { + "version": "3.1.1", + "resolved": "https://registry.npmjs.org/@mdx-js/mdx/-/mdx-3.1.1.tgz", + "integrity": "sha512-f6ZO2ifpwAQIpzGWaBQT2TXxPv6z3RBzQKpVftEWN78Vl/YweF1uwussDx8ECAXVtr3Rs89fKyG9YlzUs9DyGQ==", + "license": "MIT", + "dependencies": { + "@types/estree": "^1.0.0", + "@types/estree-jsx": "^1.0.0", + "@types/hast": "^3.0.0", + "@types/mdx": "^2.0.0", + "acorn": "^8.0.0", + "collapse-white-space": "^2.0.0", + "devlop": "^1.0.0", + "estree-util-is-identifier-name": "^3.0.0", + "estree-util-scope": "^1.0.0", + "estree-walker": "^3.0.0", + "hast-util-to-jsx-runtime": "^2.0.0", + "markdown-extensions": "^2.0.0", + "recma-build-jsx": "^1.0.0", + "recma-jsx": "^1.0.0", + "recma-stringify": "^1.0.0", + "rehype-recma": "^1.0.0", + "remark-mdx": "^3.0.0", + "remark-parse": "^11.0.0", + "remark-rehype": "^11.0.0", + "source-map": "^0.7.0", + "unified": "^11.0.0", + "unist-util-position-from-estree": "^2.0.0", + "unist-util-stringify-position": "^4.0.0", + "unist-util-visit": "^5.0.0", + "vfile": "^6.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/@nodelib/fs.scandir": { + "version": "2.1.5", + "resolved": "https://registry.npmjs.org/@nodelib/fs.scandir/-/fs.scandir-2.1.5.tgz", + "integrity": "sha512-vq24Bq3ym5HEQm2NKCr3yXDwjc7vTsEThRDnkp2DK9p1uqLR+DHurm/NOTo0KG7HYHU7eppKZj3MyqYuMBf62g==", + "license": "MIT", + "dependencies": { + "@nodelib/fs.stat": "2.0.5", + "run-parallel": "^1.1.9" + }, + "engines": { + "node": ">= 8" + } + }, + "node_modules/@nodelib/fs.stat": { + "version": "2.0.5", + "resolved": "https://registry.npmjs.org/@nodelib/fs.stat/-/fs.stat-2.0.5.tgz", + "integrity": "sha512-RkhPPp2zrqDAQA/2jNhnztcPAlv64XdhIp7a7454A5ovI7Bukxgt7MX7udwAu3zg1DcpPU0rz3VV1SeaqvY4+A==", + "license": "MIT", + "engines": { + "node": ">= 8" + } + }, + "node_modules/@nodelib/fs.walk": { + "version": "1.2.8", + "resolved": "https://registry.npmjs.org/@nodelib/fs.walk/-/fs.walk-1.2.8.tgz", + "integrity": "sha512-oGB+UxlgWcgQkgwo8GcEGwemoTFt3FIO9ababBmaGwXIoBKZ+GTy0pP185beGg7Llih/NSHSV2XAs1lnznocSg==", + "license": "MIT", + "dependencies": { + "@nodelib/fs.scandir": "2.1.5", + "fastq": "^1.6.0" + }, + "engines": { + "node": ">= 8" + } + }, + "node_modules/@oslojs/encoding": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/@oslojs/encoding/-/encoding-1.1.0.tgz", + "integrity": "sha512-70wQhgYmndg4GCPxPPxPGevRKqTIJ2Nh4OkiMWmDAVYsTQ+Ta7Sq+rPevXyXGdzr30/qZBnyOalCszoMxlyldQ==", + "license": "MIT" + }, + "node_modules/@pagefind/darwin-arm64": { + "version": "1.4.0", + "resolved": "https://registry.npmjs.org/@pagefind/darwin-arm64/-/darwin-arm64-1.4.0.tgz", + "integrity": "sha512-2vMqkbv3lbx1Awea90gTaBsvpzgRs7MuSgKDxW0m9oV1GPZCZbZBJg/qL83GIUEN2BFlY46dtUZi54pwH+/pTQ==", + "cpu": [ + "arm64" + ], + "license": "MIT", + "optional": true, + "os": [ + "darwin" + ] + }, + "node_modules/@pagefind/darwin-x64": { + "version": "1.4.0", + "resolved": "https://registry.npmjs.org/@pagefind/darwin-x64/-/darwin-x64-1.4.0.tgz", + "integrity": "sha512-e7JPIS6L9/cJfow+/IAqknsGqEPjJnVXGjpGm25bnq+NPdoD3c/7fAwr1OXkG4Ocjx6ZGSCijXEV4ryMcH2E3A==", + "cpu": [ + "x64" + ], + "license": "MIT", + "optional": true, + "os": [ + "darwin" + ] + }, + "node_modules/@pagefind/default-ui": { + "version": "1.4.0", + "resolved": "https://registry.npmjs.org/@pagefind/default-ui/-/default-ui-1.4.0.tgz", + "integrity": "sha512-wie82VWn3cnGEdIjh4YwNESyS1G6vRHwL6cNjy9CFgNnWW/PGRjsLq300xjVH5sfPFK3iK36UxvIBymtQIEiSQ==", + "license": "MIT" + }, + "node_modules/@pagefind/freebsd-x64": { + "version": "1.4.0", + "resolved": "https://registry.npmjs.org/@pagefind/freebsd-x64/-/freebsd-x64-1.4.0.tgz", + "integrity": "sha512-WcJVypXSZ+9HpiqZjFXMUobfFfZZ6NzIYtkhQ9eOhZrQpeY5uQFqNWLCk7w9RkMUwBv1HAMDW3YJQl/8OqsV0Q==", + "cpu": [ + "x64" + ], + "license": "MIT", + "optional": true, + "os": [ + "freebsd" + ] + }, + "node_modules/@pagefind/linux-arm64": { + "version": "1.4.0", + "resolved": "https://registry.npmjs.org/@pagefind/linux-arm64/-/linux-arm64-1.4.0.tgz", + "integrity": "sha512-PIt8dkqt4W06KGmQjONw7EZbhDF+uXI7i0XtRLN1vjCUxM9vGPdtJc2mUyVPevjomrGz5M86M8bqTr6cgDp1Uw==", + "cpu": [ + "arm64" + ], + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@pagefind/linux-x64": { + "version": "1.4.0", + "resolved": "https://registry.npmjs.org/@pagefind/linux-x64/-/linux-x64-1.4.0.tgz", + "integrity": "sha512-z4oddcWwQ0UHrTHR8psLnVlz6USGJ/eOlDPTDYZ4cI8TK8PgwRUPQZp9D2iJPNIPcS6Qx/E4TebjuGJOyK8Mmg==", + "cpu": [ + "x64" + ], + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@pagefind/windows-x64": { + "version": "1.4.0", + "resolved": "https://registry.npmjs.org/@pagefind/windows-x64/-/windows-x64-1.4.0.tgz", + "integrity": "sha512-NkT+YAdgS2FPCn8mIA9bQhiBs+xmniMGq1LFPDhcFn0+2yIUEiIG06t7bsZlhdjknEQRTSdT7YitP6fC5qwP0g==", + "cpu": [ + "x64" + ], + "license": "MIT", + "optional": true, + "os": [ + "win32" + ] + }, + "node_modules/@rolldown/pluginutils": { + "version": "1.0.0-beta.27", + "resolved": "https://registry.npmjs.org/@rolldown/pluginutils/-/pluginutils-1.0.0-beta.27.tgz", + "integrity": "sha512-+d0F4MKMCbeVUJwG96uQ4SgAznZNSq93I3V+9NHA4OpvqG8mRCpGdKmK8l/dl02h2CCDHwW2FqilnTyDcAnqjA==", + "license": "MIT" + }, + "node_modules/@rollup/pluginutils": { + "version": "5.3.0", + "resolved": "https://registry.npmjs.org/@rollup/pluginutils/-/pluginutils-5.3.0.tgz", + "integrity": "sha512-5EdhGZtnu3V88ces7s53hhfK5KSASnJZv8Lulpc04cWO3REESroJXg73DFsOmgbU2BhwV0E20bu2IDZb3VKW4Q==", + "license": "MIT", + "dependencies": { + "@types/estree": "^1.0.0", + "estree-walker": "^2.0.2", + "picomatch": "^4.0.2" + }, + "engines": { + "node": ">=14.0.0" + }, + "peerDependencies": { + "rollup": "^1.20.0||^2.0.0||^3.0.0||^4.0.0" + }, + "peerDependenciesMeta": { + "rollup": { + "optional": true + } + } + }, + "node_modules/@rollup/pluginutils/node_modules/estree-walker": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/estree-walker/-/estree-walker-2.0.2.tgz", + "integrity": "sha512-Rfkk/Mp/DL7JVje3u18FxFujQlTNR2q6QfMSMB7AvCBx91NGj/ba3kCfza0f6dVDbw7YlRf/nDrn7pQrCCyQ/w==", + "license": "MIT" + }, + "node_modules/@rollup/rollup-android-arm-eabi": { + "version": "4.53.3", + "resolved": "https://registry.npmjs.org/@rollup/rollup-android-arm-eabi/-/rollup-android-arm-eabi-4.53.3.tgz", + "integrity": "sha512-mRSi+4cBjrRLoaal2PnqH82Wqyb+d3HsPUN/W+WslCXsZsyHa9ZeQQX/pQsZaVIWDkPcpV6jJ+3KLbTbgnwv8w==", + "cpu": [ + "arm" + ], + "license": "MIT", + "optional": true, + "os": [ + "android" + ] + }, + "node_modules/@rollup/rollup-android-arm64": { + "version": "4.53.3", + "resolved": "https://registry.npmjs.org/@rollup/rollup-android-arm64/-/rollup-android-arm64-4.53.3.tgz", + "integrity": "sha512-CbDGaMpdE9sh7sCmTrTUyllhrg65t6SwhjlMJsLr+J8YjFuPmCEjbBSx4Z/e4SmDyH3aB5hGaJUP2ltV/vcs4w==", + "cpu": [ + "arm64" + ], + "license": "MIT", + "optional": true, + "os": [ + "android" + ] + }, + "node_modules/@rollup/rollup-darwin-arm64": { + "version": "4.53.3", + "resolved": "https://registry.npmjs.org/@rollup/rollup-darwin-arm64/-/rollup-darwin-arm64-4.53.3.tgz", + "integrity": "sha512-Nr7SlQeqIBpOV6BHHGZgYBuSdanCXuw09hon14MGOLGmXAFYjx1wNvquVPmpZnl0tLjg25dEdr4IQ6GgyToCUA==", + "cpu": [ + "arm64" + ], + "license": "MIT", + "optional": true, + "os": [ + "darwin" + ] + }, + "node_modules/@rollup/rollup-darwin-x64": { + "version": "4.53.3", + "resolved": "https://registry.npmjs.org/@rollup/rollup-darwin-x64/-/rollup-darwin-x64-4.53.3.tgz", + "integrity": "sha512-DZ8N4CSNfl965CmPktJ8oBnfYr3F8dTTNBQkRlffnUarJ2ohudQD17sZBa097J8xhQ26AwhHJ5mvUyQW8ddTsQ==", + "cpu": [ + "x64" + ], + "license": "MIT", + "optional": true, + "os": [ + "darwin" + ] + }, + "node_modules/@rollup/rollup-freebsd-arm64": { + "version": "4.53.3", + "resolved": "https://registry.npmjs.org/@rollup/rollup-freebsd-arm64/-/rollup-freebsd-arm64-4.53.3.tgz", + "integrity": "sha512-yMTrCrK92aGyi7GuDNtGn2sNW+Gdb4vErx4t3Gv/Tr+1zRb8ax4z8GWVRfr3Jw8zJWvpGHNpss3vVlbF58DZ4w==", + "cpu": [ + "arm64" + ], + "license": "MIT", + "optional": true, + "os": [ + "freebsd" + ] + }, + "node_modules/@rollup/rollup-freebsd-x64": { + "version": "4.53.3", + "resolved": "https://registry.npmjs.org/@rollup/rollup-freebsd-x64/-/rollup-freebsd-x64-4.53.3.tgz", + "integrity": "sha512-lMfF8X7QhdQzseM6XaX0vbno2m3hlyZFhwcndRMw8fbAGUGL3WFMBdK0hbUBIUYcEcMhVLr1SIamDeuLBnXS+Q==", + "cpu": [ + "x64" + ], + "license": "MIT", + "optional": true, + "os": [ + "freebsd" + ] + }, + "node_modules/@rollup/rollup-linux-arm-gnueabihf": { + "version": "4.53.3", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm-gnueabihf/-/rollup-linux-arm-gnueabihf-4.53.3.tgz", + "integrity": "sha512-k9oD15soC/Ln6d2Wv/JOFPzZXIAIFLp6B+i14KhxAfnq76ajt0EhYc5YPeX6W1xJkAdItcVT+JhKl1QZh44/qw==", + "cpu": [ + "arm" + ], + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-arm-musleabihf": { + "version": "4.53.3", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm-musleabihf/-/rollup-linux-arm-musleabihf-4.53.3.tgz", + "integrity": "sha512-vTNlKq+N6CK/8UktsrFuc+/7NlEYVxgaEgRXVUVK258Z5ymho29skzW1sutgYjqNnquGwVUObAaxae8rZ6YMhg==", + "cpu": [ + "arm" + ], + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-arm64-gnu": { + "version": "4.53.3", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm64-gnu/-/rollup-linux-arm64-gnu-4.53.3.tgz", + "integrity": "sha512-RGrFLWgMhSxRs/EWJMIFM1O5Mzuz3Xy3/mnxJp/5cVhZ2XoCAxJnmNsEyeMJtpK+wu0FJFWz+QF4mjCA7AUQ3w==", + "cpu": [ + "arm64" + ], + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-arm64-musl": { + "version": "4.53.3", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm64-musl/-/rollup-linux-arm64-musl-4.53.3.tgz", + "integrity": "sha512-kASyvfBEWYPEwe0Qv4nfu6pNkITLTb32p4yTgzFCocHnJLAHs+9LjUu9ONIhvfT/5lv4YS5muBHyuV84epBo/A==", + "cpu": [ + "arm64" + ], + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-loong64-gnu": { + "version": "4.53.3", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-loong64-gnu/-/rollup-linux-loong64-gnu-4.53.3.tgz", + "integrity": "sha512-JiuKcp2teLJwQ7vkJ95EwESWkNRFJD7TQgYmCnrPtlu50b4XvT5MOmurWNrCj3IFdyjBQ5p9vnrX4JM6I8OE7g==", + "cpu": [ + "loong64" + ], + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-ppc64-gnu": { + "version": "4.53.3", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-ppc64-gnu/-/rollup-linux-ppc64-gnu-4.53.3.tgz", + "integrity": "sha512-EoGSa8nd6d3T7zLuqdojxC20oBfNT8nexBbB/rkxgKj5T5vhpAQKKnD+h3UkoMuTyXkP5jTjK/ccNRmQrPNDuw==", + "cpu": [ + "ppc64" + ], + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-riscv64-gnu": { + "version": "4.53.3", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-riscv64-gnu/-/rollup-linux-riscv64-gnu-4.53.3.tgz", + "integrity": "sha512-4s+Wped2IHXHPnAEbIB0YWBv7SDohqxobiiPA1FIWZpX+w9o2i4LezzH/NkFUl8LRci/8udci6cLq+jJQlh+0g==", + "cpu": [ + "riscv64" + ], + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-riscv64-musl": { + "version": "4.53.3", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-riscv64-musl/-/rollup-linux-riscv64-musl-4.53.3.tgz", + "integrity": "sha512-68k2g7+0vs2u9CxDt5ktXTngsxOQkSEV/xBbwlqYcUrAVh6P9EgMZvFsnHy4SEiUl46Xf0IObWVbMvPrr2gw8A==", + "cpu": [ + "riscv64" + ], + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-s390x-gnu": { + "version": "4.53.3", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-s390x-gnu/-/rollup-linux-s390x-gnu-4.53.3.tgz", + "integrity": "sha512-VYsFMpULAz87ZW6BVYw3I6sWesGpsP9OPcyKe8ofdg9LHxSbRMd7zrVrr5xi/3kMZtpWL/wC+UIJWJYVX5uTKg==", + "cpu": [ + "s390x" + ], + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-x64-gnu": { + "version": "4.53.3", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-x64-gnu/-/rollup-linux-x64-gnu-4.53.3.tgz", + "integrity": "sha512-3EhFi1FU6YL8HTUJZ51imGJWEX//ajQPfqWLI3BQq4TlvHy4X0MOr5q3D2Zof/ka0d5FNdPwZXm3Yyib/UEd+w==", + "cpu": [ + "x64" + ], + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-x64-musl": { + "version": "4.53.3", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-x64-musl/-/rollup-linux-x64-musl-4.53.3.tgz", + "integrity": "sha512-eoROhjcc6HbZCJr+tvVT8X4fW3/5g/WkGvvmwz/88sDtSJzO7r/blvoBDgISDiCjDRZmHpwud7h+6Q9JxFwq1Q==", + "cpu": [ + "x64" + ], + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-openharmony-arm64": { + "version": "4.53.3", + "resolved": "https://registry.npmjs.org/@rollup/rollup-openharmony-arm64/-/rollup-openharmony-arm64-4.53.3.tgz", + "integrity": "sha512-OueLAWgrNSPGAdUdIjSWXw+u/02BRTcnfw9PN41D2vq/JSEPnJnVuBgw18VkN8wcd4fjUs+jFHVM4t9+kBSNLw==", + "cpu": [ + "arm64" + ], + "license": "MIT", + "optional": true, + "os": [ + "openharmony" + ] + }, + "node_modules/@rollup/rollup-win32-arm64-msvc": { + "version": "4.53.3", + "resolved": "https://registry.npmjs.org/@rollup/rollup-win32-arm64-msvc/-/rollup-win32-arm64-msvc-4.53.3.tgz", + "integrity": "sha512-GOFuKpsxR/whszbF/bzydebLiXIHSgsEUp6M0JI8dWvi+fFa1TD6YQa4aSZHtpmh2/uAlj/Dy+nmby3TJ3pkTw==", + "cpu": [ + "arm64" + ], + "license": "MIT", + "optional": true, + "os": [ + "win32" + ] + }, + "node_modules/@rollup/rollup-win32-ia32-msvc": { + "version": "4.53.3", + "resolved": "https://registry.npmjs.org/@rollup/rollup-win32-ia32-msvc/-/rollup-win32-ia32-msvc-4.53.3.tgz", + "integrity": "sha512-iah+THLcBJdpfZ1TstDFbKNznlzoxa8fmnFYK4V67HvmuNYkVdAywJSoteUszvBQ9/HqN2+9AZghbajMsFT+oA==", + "cpu": [ + "ia32" + ], + "license": "MIT", + "optional": true, + "os": [ + "win32" + ] + }, + "node_modules/@rollup/rollup-win32-x64-gnu": { + "version": "4.53.3", + "resolved": "https://registry.npmjs.org/@rollup/rollup-win32-x64-gnu/-/rollup-win32-x64-gnu-4.53.3.tgz", + "integrity": "sha512-J9QDiOIZlZLdcot5NXEepDkstocktoVjkaKUtqzgzpt2yWjGlbYiKyp05rWwk4nypbYUNoFAztEgixoLaSETkg==", + "cpu": [ + "x64" + ], + "license": "MIT", + "optional": true, + "os": [ + "win32" + ] + }, + "node_modules/@rollup/rollup-win32-x64-msvc": { + "version": "4.53.3", + "resolved": "https://registry.npmjs.org/@rollup/rollup-win32-x64-msvc/-/rollup-win32-x64-msvc-4.53.3.tgz", + "integrity": "sha512-UhTd8u31dXadv0MopwGgNOBpUVROFKWVQgAg5N1ESyCz8AuBcMqm4AuTjrwgQKGDfoFuz02EuMRHQIw/frmYKQ==", + "cpu": [ + "x64" + ], + "license": "MIT", + "optional": true, + "os": [ + "win32" + ] + }, + "node_modules/@shikijs/core": { + "version": "3.15.0", + "resolved": "https://registry.npmjs.org/@shikijs/core/-/core-3.15.0.tgz", + "integrity": "sha512-8TOG6yG557q+fMsSVa8nkEDOZNTSxjbbR8l6lF2gyr6Np+jrPlslqDxQkN6rMXCECQ3isNPZAGszAfYoJOPGlg==", + "license": "MIT", + "dependencies": { + "@shikijs/types": "3.15.0", + "@shikijs/vscode-textmate": "^10.0.2", + "@types/hast": "^3.0.4", + "hast-util-to-html": "^9.0.5" + } + }, + "node_modules/@shikijs/engine-javascript": { + "version": "3.15.0", + "resolved": "https://registry.npmjs.org/@shikijs/engine-javascript/-/engine-javascript-3.15.0.tgz", + "integrity": "sha512-ZedbOFpopibdLmvTz2sJPJgns8Xvyabe2QbmqMTz07kt1pTzfEvKZc5IqPVO/XFiEbbNyaOpjPBkkr1vlwS+qg==", + "license": "MIT", + "dependencies": { + "@shikijs/types": "3.15.0", + "@shikijs/vscode-textmate": "^10.0.2", + "oniguruma-to-es": "^4.3.3" + } + }, + "node_modules/@shikijs/engine-oniguruma": { + "version": "3.15.0", + "resolved": "https://registry.npmjs.org/@shikijs/engine-oniguruma/-/engine-oniguruma-3.15.0.tgz", + "integrity": "sha512-HnqFsV11skAHvOArMZdLBZZApRSYS4LSztk2K3016Y9VCyZISnlYUYsL2hzlS7tPqKHvNqmI5JSUJZprXloMvA==", + "license": "MIT", + "dependencies": { + "@shikijs/types": "3.15.0", + "@shikijs/vscode-textmate": "^10.0.2" + } + }, + "node_modules/@shikijs/langs": { + "version": "3.15.0", + "resolved": "https://registry.npmjs.org/@shikijs/langs/-/langs-3.15.0.tgz", + "integrity": "sha512-WpRvEFvkVvO65uKYW4Rzxs+IG0gToyM8SARQMtGGsH4GDMNZrr60qdggXrFOsdfOVssG/QQGEl3FnJ3EZ+8w8A==", + "license": "MIT", + "dependencies": { + "@shikijs/types": "3.15.0" + } + }, + "node_modules/@shikijs/themes": { + "version": "3.15.0", + "resolved": "https://registry.npmjs.org/@shikijs/themes/-/themes-3.15.0.tgz", + "integrity": "sha512-8ow2zWb1IDvCKjYb0KiLNrK4offFdkfNVPXb1OZykpLCzRU6j+efkY+Y7VQjNlNFXonSw+4AOdGYtmqykDbRiQ==", + "license": "MIT", + "dependencies": { + "@shikijs/types": "3.15.0" + } + }, + "node_modules/@shikijs/types": { + "version": "3.15.0", + "resolved": "https://registry.npmjs.org/@shikijs/types/-/types-3.15.0.tgz", + "integrity": "sha512-BnP+y/EQnhihgHy4oIAN+6FFtmfTekwOLsQbRw9hOKwqgNy8Bdsjq8B05oAt/ZgvIWWFrshV71ytOrlPfYjIJw==", + "license": "MIT", + "dependencies": { + "@shikijs/vscode-textmate": "^10.0.2", + "@types/hast": "^3.0.4" + } + }, + "node_modules/@shikijs/vscode-textmate": { + "version": "10.0.2", + "resolved": "https://registry.npmjs.org/@shikijs/vscode-textmate/-/vscode-textmate-10.0.2.tgz", + "integrity": "sha512-83yeghZ2xxin3Nj8z1NMd/NCuca+gsYXswywDy5bHvwlWL8tpTQmzGeUuHd9FC3E/SBEMvzJRwWEOz5gGes9Qg==", + "license": "MIT" + }, + "node_modules/@swc/helpers": { + "version": "0.5.17", + "resolved": "https://registry.npmjs.org/@swc/helpers/-/helpers-0.5.17.tgz", + "integrity": "sha512-5IKx/Y13RsYd+sauPb2x+U/xZikHjolzfuDgTAl/Tdf3Q8rslRvC19NKDLgAJQ6wsqADk10ntlv08nPFw/gO/A==", + "license": "Apache-2.0", + "dependencies": { + "tslib": "^2.8.0" + } + }, + "node_modules/@types/babel__core": { + "version": "7.20.5", + "resolved": "https://registry.npmjs.org/@types/babel__core/-/babel__core-7.20.5.tgz", + "integrity": "sha512-qoQprZvz5wQFJwMDqeseRXWv3rqMvhgpbXFfVyWhbx9X47POIA6i/+dXefEmZKoAgOaTdaIgNSMqMIU61yRyzA==", + "license": "MIT", + "dependencies": { + "@babel/parser": "^7.20.7", + "@babel/types": "^7.20.7", + "@types/babel__generator": "*", + "@types/babel__template": "*", + "@types/babel__traverse": "*" + } + }, + "node_modules/@types/babel__generator": { + "version": "7.27.0", + "resolved": "https://registry.npmjs.org/@types/babel__generator/-/babel__generator-7.27.0.tgz", + "integrity": "sha512-ufFd2Xi92OAVPYsy+P4n7/U7e68fex0+Ee8gSG9KX7eo084CWiQ4sdxktvdl0bOPupXtVJPY19zk6EwWqUQ8lg==", + "license": "MIT", + "dependencies": { + "@babel/types": "^7.0.0" + } + }, + "node_modules/@types/babel__template": { + "version": "7.4.4", + "resolved": "https://registry.npmjs.org/@types/babel__template/-/babel__template-7.4.4.tgz", + "integrity": "sha512-h/NUaSyG5EyxBIp8YRxo4RMe2/qQgvyowRwVMzhYhBCONbW8PUsg4lkFMrhgZhUe5z3L3MiLDuvyJ/CaPa2A8A==", + "license": "MIT", + "dependencies": { + "@babel/parser": "^7.1.0", + "@babel/types": "^7.0.0" + } + }, + "node_modules/@types/babel__traverse": { + "version": "7.28.0", + "resolved": "https://registry.npmjs.org/@types/babel__traverse/-/babel__traverse-7.28.0.tgz", + "integrity": "sha512-8PvcXf70gTDZBgt9ptxJ8elBeBjcLOAcOtoO/mPJjtji1+CdGbHgm77om1GrsPxsiE+uXIpNSK64UYaIwQXd4Q==", + "license": "MIT", + "dependencies": { + "@babel/types": "^7.28.2" + } + }, + "node_modules/@types/debug": { + "version": "4.1.12", + "resolved": "https://registry.npmjs.org/@types/debug/-/debug-4.1.12.tgz", + "integrity": "sha512-vIChWdVG3LG1SMxEvI/AK+FWJthlrqlTu7fbrlywTkkaONwk/UAGaULXRlf8vkzFBLVm0zkMdCquhL5aOjhXPQ==", + "license": "MIT", + "dependencies": { + "@types/ms": "*" + } + }, + "node_modules/@types/estree": { + "version": "1.0.8", + "resolved": "https://registry.npmjs.org/@types/estree/-/estree-1.0.8.tgz", + "integrity": "sha512-dWHzHa2WqEXI/O1E9OjrocMTKJl2mSrEolh1Iomrv6U+JuNwaHXsXx9bLu5gG7BUWFIN0skIQJQ/L1rIex4X6w==", + "license": "MIT" + }, + "node_modules/@types/estree-jsx": { + "version": "1.0.5", + "resolved": "https://registry.npmjs.org/@types/estree-jsx/-/estree-jsx-1.0.5.tgz", + "integrity": "sha512-52CcUVNFyfb1A2ALocQw/Dd1BQFNmSdkuC3BkZ6iqhdMfQz7JWOFRuJFloOzjk+6WijU56m9oKXFAXc7o3Towg==", + "license": "MIT", + "dependencies": { + "@types/estree": "*" + } + }, + "node_modules/@types/fontkit": { + "version": "2.0.8", + "resolved": "https://registry.npmjs.org/@types/fontkit/-/fontkit-2.0.8.tgz", + "integrity": "sha512-wN+8bYxIpJf+5oZdrdtaX04qUuWHcKxcDEgRS9Qm9ZClSHjzEn13SxUC+5eRM+4yXIeTYk8mTzLAWGF64847ew==", + "license": "MIT", + "dependencies": { + "@types/node": "*" + } + }, + "node_modules/@types/hast": { + "version": "3.0.4", + "resolved": "https://registry.npmjs.org/@types/hast/-/hast-3.0.4.tgz", + "integrity": "sha512-WPs+bbQw5aCj+x6laNGWLH3wviHtoCv/P3+otBhbOhJgG8qtpdAMlTCxLtsTWA7LH1Oh/bFCHsBn0TPS5m30EQ==", + "license": "MIT", + "dependencies": { + "@types/unist": "*" + } + }, + "node_modules/@types/js-yaml": { + "version": "4.0.9", + "resolved": "https://registry.npmjs.org/@types/js-yaml/-/js-yaml-4.0.9.tgz", + "integrity": "sha512-k4MGaQl5TGo/iipqb2UDG2UwjXziSWkh0uysQelTlJpX1qGlpUZYm8PnO4DxG1qBomtJUdYJ6qR6xdIah10JLg==", + "license": "MIT" + }, + "node_modules/@types/mdast": { + "version": "4.0.4", + "resolved": "https://registry.npmjs.org/@types/mdast/-/mdast-4.0.4.tgz", + "integrity": "sha512-kGaNbPh1k7AFzgpud/gMdvIm5xuECykRR+JnWKQno9TAXVa6WIVCGTPvYGekIDL4uwCZQSYbUxNBSb1aUo79oA==", + "license": "MIT", + "dependencies": { + "@types/unist": "*" + } + }, + "node_modules/@types/mdx": { + "version": "2.0.13", + "resolved": "https://registry.npmjs.org/@types/mdx/-/mdx-2.0.13.tgz", + "integrity": "sha512-+OWZQfAYyio6YkJb3HLxDrvnx6SWWDbC0zVPfBRzUk0/nqoDyf6dNxQi3eArPe8rJ473nobTMQ/8Zk+LxJ+Yuw==", + "license": "MIT" + }, + "node_modules/@types/ms": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/@types/ms/-/ms-2.1.0.tgz", + "integrity": "sha512-GsCCIZDE/p3i96vtEqx+7dBUGXrc7zeSK3wwPHIaRThS+9OhWIXRqzs4d6k1SVU8g91DrNRWxWUGhp5KXQb2VA==", + "license": "MIT" + }, + "node_modules/@types/nlcst": { + "version": "2.0.3", + "resolved": "https://registry.npmjs.org/@types/nlcst/-/nlcst-2.0.3.tgz", + "integrity": "sha512-vSYNSDe6Ix3q+6Z7ri9lyWqgGhJTmzRjZRqyq15N0Z/1/UnVsno9G/N40NBijoYx2seFDIl0+B2mgAb9mezUCA==", + "license": "MIT", + "dependencies": { + "@types/unist": "*" + } + }, + "node_modules/@types/node": { + "version": "24.10.1", + "resolved": "https://registry.npmjs.org/@types/node/-/node-24.10.1.tgz", + "integrity": "sha512-GNWcUTRBgIRJD5zj+Tq0fKOJ5XZajIiBroOF0yvj2bSU1WvNdYS/dn9UxwsujGW4JX06dnHyjV2y9rRaybH0iQ==", + "license": "MIT", + "dependencies": { + "undici-types": "~7.16.0" + } + }, + "node_modules/@types/picomatch": { + "version": "2.3.3", + "resolved": "https://registry.npmjs.org/@types/picomatch/-/picomatch-2.3.3.tgz", + "integrity": "sha512-Yll76ZHikRFCyz/pffKGjrCwe/le2CDwOP5F210KQo27kpRE46U2rDnzikNlVn6/ezH3Mhn46bJMTfeVTtcYMg==", + "license": "MIT" + }, + "node_modules/@types/react": { + "version": "19.2.6", + "resolved": "https://registry.npmjs.org/@types/react/-/react-19.2.6.tgz", + "integrity": "sha512-p/jUvulfgU7oKtj6Xpk8cA2Y1xKTtICGpJYeJXz2YVO2UcvjQgeRMLDGfDeqeRW2Ta+0QNFwcc8X3GH8SxZz6w==", + "license": "MIT", + "peer": true, + "dependencies": { + "csstype": "^3.2.2" + } + }, + "node_modules/@types/react-dom": { + "version": "19.2.3", + "resolved": "https://registry.npmjs.org/@types/react-dom/-/react-dom-19.2.3.tgz", + "integrity": "sha512-jp2L/eY6fn+KgVVQAOqYItbF0VY/YApe5Mz2F0aykSO8gx31bYCZyvSeYxCHKvzHG5eZjc+zyaS5BrBWya2+kQ==", + "license": "MIT", + "peer": true, + "peerDependencies": { + "@types/react": "^19.2.0" + } + }, + "node_modules/@types/sax": { + "version": "1.2.7", + "resolved": "https://registry.npmjs.org/@types/sax/-/sax-1.2.7.tgz", + "integrity": "sha512-rO73L89PJxeYM3s3pPPjiPgVVcymqU490g0YO5n5By0k2Erzj6tay/4lr1CHAAU4JyOWd1rpQ8bCf6cZfHU96A==", + "license": "MIT", + "dependencies": { + "@types/node": "*" + } + }, + "node_modules/@types/unist": { + "version": "3.0.3", + "resolved": "https://registry.npmjs.org/@types/unist/-/unist-3.0.3.tgz", + "integrity": "sha512-ko/gIFJRv177XgZsZcBwnqJN5x/Gien8qNOn0D5bQU/zAzVf9Zt3BlcUiLqhV9y4ARk0GbT3tnUiPNgnTXzc/Q==", + "license": "MIT" + }, + "node_modules/@ungap/structured-clone": { + "version": "1.3.0", + "resolved": "https://registry.npmjs.org/@ungap/structured-clone/-/structured-clone-1.3.0.tgz", + "integrity": "sha512-WmoN8qaIAo7WTYWbAZuG8PYEhn5fkz7dZrqTBZ7dtt//lL2Gwms1IcnQ5yHqjDfX8Ft5j4YzDM23f87zBfDe9g==", + "license": "ISC" + }, + "node_modules/@vitejs/plugin-react": { + "version": "4.7.0", + "resolved": "https://registry.npmjs.org/@vitejs/plugin-react/-/plugin-react-4.7.0.tgz", + "integrity": "sha512-gUu9hwfWvvEDBBmgtAowQCojwZmJ5mcLn3aufeCsitijs3+f2NsrPtlAWIR6OPiqljl96GVCUbLe0HyqIpVaoA==", + "license": "MIT", + "dependencies": { + "@babel/core": "^7.28.0", + "@babel/plugin-transform-react-jsx-self": "^7.27.1", + "@babel/plugin-transform-react-jsx-source": "^7.27.1", + "@rolldown/pluginutils": "1.0.0-beta.27", + "@types/babel__core": "^7.20.5", + "react-refresh": "^0.17.0" + }, + "engines": { + "node": "^14.18.0 || >=16.0.0" + }, + "peerDependencies": { + "vite": "^4.2.0 || ^5.0.0 || ^6.0.0 || ^7.0.0" + } + }, + "node_modules/@volar/kit": { + "version": "2.4.23", + "resolved": "https://registry.npmjs.org/@volar/kit/-/kit-2.4.23.tgz", + "integrity": "sha512-YuUIzo9zwC2IkN7FStIcVl1YS9w5vkSFEZfPvnu0IbIMaR9WHhc9ZxvlT+91vrcSoRY469H2jwbrGqpG7m1KaQ==", + "license": "MIT", + "dependencies": { + "@volar/language-service": "2.4.23", + "@volar/typescript": "2.4.23", + "typesafe-path": "^0.2.2", + "vscode-languageserver-textdocument": "^1.0.11", + "vscode-uri": "^3.0.8" + }, + "peerDependencies": { + "typescript": "*" + } + }, + "node_modules/@volar/language-core": { + "version": "2.4.23", + "resolved": "https://registry.npmjs.org/@volar/language-core/-/language-core-2.4.23.tgz", + "integrity": "sha512-hEEd5ET/oSmBC6pi1j6NaNYRWoAiDhINbT8rmwtINugR39loROSlufGdYMF9TaKGfz+ViGs1Idi3mAhnuPcoGQ==", + "license": "MIT", + "dependencies": { + "@volar/source-map": "2.4.23" + } + }, + "node_modules/@volar/language-server": { + "version": "2.4.23", + "resolved": "https://registry.npmjs.org/@volar/language-server/-/language-server-2.4.23.tgz", + "integrity": "sha512-k0iO+tybMGMMyrNdWOxgFkP0XJTdbH0w+WZlM54RzJU3WZSjHEupwL30klpM7ep4FO6qyQa03h+VcGHD4Q8gEg==", + "license": "MIT", + "dependencies": { + "@volar/language-core": "2.4.23", + "@volar/language-service": "2.4.23", + "@volar/typescript": "2.4.23", + "path-browserify": "^1.0.1", + "request-light": "^0.7.0", + "vscode-languageserver": "^9.0.1", + "vscode-languageserver-protocol": "^3.17.5", + "vscode-languageserver-textdocument": "^1.0.11", + "vscode-uri": "^3.0.8" + } + }, + "node_modules/@volar/language-service": { + "version": "2.4.23", + "resolved": "https://registry.npmjs.org/@volar/language-service/-/language-service-2.4.23.tgz", + "integrity": "sha512-h5mU9DZ/6u3LCB9xomJtorNG6awBNnk9VuCioGsp6UtFiM8amvS5FcsaC3dabdL9zO0z+Gq9vIEMb/5u9K6jGQ==", + "license": "MIT", + "dependencies": { + "@volar/language-core": "2.4.23", + "vscode-languageserver-protocol": "^3.17.5", + "vscode-languageserver-textdocument": "^1.0.11", + "vscode-uri": "^3.0.8" + } + }, + "node_modules/@volar/source-map": { + "version": "2.4.23", + "resolved": "https://registry.npmjs.org/@volar/source-map/-/source-map-2.4.23.tgz", + "integrity": "sha512-Z1Uc8IB57Lm6k7q6KIDu/p+JWtf3xsXJqAX/5r18hYOTpJyBn0KXUR8oTJ4WFYOcDzWC9n3IflGgHowx6U6z9Q==", + "license": "MIT" + }, + "node_modules/@volar/typescript": { + "version": "2.4.23", + "resolved": "https://registry.npmjs.org/@volar/typescript/-/typescript-2.4.23.tgz", + "integrity": "sha512-lAB5zJghWxVPqfcStmAP1ZqQacMpe90UrP5RJ3arDyrhy4aCUQqmxPPLB2PWDKugvylmO41ljK7vZ+t6INMTag==", + "license": "MIT", + "dependencies": { + "@volar/language-core": "2.4.23", + "path-browserify": "^1.0.1", + "vscode-uri": "^3.0.8" + } + }, + "node_modules/@vscode/emmet-helper": { + "version": "2.11.0", + "resolved": "https://registry.npmjs.org/@vscode/emmet-helper/-/emmet-helper-2.11.0.tgz", + "integrity": "sha512-QLxjQR3imPZPQltfbWRnHU6JecWTF1QSWhx3GAKQpslx7y3Dp6sIIXhKjiUJ/BR9FX8PVthjr9PD6pNwOJfAzw==", + "license": "MIT", + "dependencies": { + "emmet": "^2.4.3", + "jsonc-parser": "^2.3.0", + "vscode-languageserver-textdocument": "^1.0.1", + "vscode-languageserver-types": "^3.15.1", + "vscode-uri": "^3.0.8" + } + }, + "node_modules/@vscode/l10n": { + "version": "0.0.18", + "resolved": "https://registry.npmjs.org/@vscode/l10n/-/l10n-0.0.18.tgz", + "integrity": "sha512-KYSIHVmslkaCDyw013pphY+d7x1qV8IZupYfeIfzNA+nsaWHbn5uPuQRvdRFsa9zFzGeudPuoGoZ1Op4jrJXIQ==", + "license": "MIT" + }, + "node_modules/acorn": { + "version": "8.15.0", + "resolved": "https://registry.npmjs.org/acorn/-/acorn-8.15.0.tgz", + "integrity": "sha512-NZyJarBfL7nWwIq+FDL6Zp/yHEhePMNnnJ0y3qfieCrmNvYct8uvtiV41UvlSe6apAfk0fY1FbWx+NwfmpvtTg==", + "license": "MIT", + "peer": true, + "bin": { + "acorn": "bin/acorn" + }, + "engines": { + "node": ">=0.4.0" + } + }, + "node_modules/acorn-jsx": { + "version": "5.3.2", + "resolved": "https://registry.npmjs.org/acorn-jsx/-/acorn-jsx-5.3.2.tgz", + "integrity": "sha512-rq9s+JNhf0IChjtDXxllJ7g41oZk5SlXtp0LHwyA5cejwn7vKmKp4pPri6YEePv2PU65sAsegbXtIinmDFDXgQ==", + "license": "MIT", + "peerDependencies": { + "acorn": "^6.0.0 || ^7.0.0 || ^8.0.0" + } + }, + "node_modules/ajv": { + "version": "8.17.1", + "resolved": "https://registry.npmjs.org/ajv/-/ajv-8.17.1.tgz", + "integrity": "sha512-B/gBuNg5SiMTrPkC+A2+cW0RszwxYmn6VYxB/inlBStS5nx6xHIt/ehKRhIMhqusl7a8LjQoZnjCs5vhwxOQ1g==", + "license": "MIT", + "peer": true, + "dependencies": { + "fast-deep-equal": "^3.1.3", + "fast-uri": "^3.0.1", + "json-schema-traverse": "^1.0.0", + "require-from-string": "^2.0.2" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/epoberezkin" + } + }, + "node_modules/ajv-draft-04": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/ajv-draft-04/-/ajv-draft-04-1.0.0.tgz", + "integrity": "sha512-mv00Te6nmYbRp5DCwclxtt7yV/joXJPGS7nM+97GdxvuttCOfgI3K4U25zboyeX0O+myI8ERluxQe5wljMmVIw==", + "license": "MIT", + "peerDependencies": { + "ajv": "^8.5.0" + }, + "peerDependenciesMeta": { + "ajv": { + "optional": true + } + } + }, + "node_modules/ansi-align": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/ansi-align/-/ansi-align-3.0.1.tgz", + "integrity": "sha512-IOfwwBF5iczOjp/WeY4YxyjqAFMQoZufdQWDd19SEExbVLNXqvpzSJ/M7Za4/sCPmQ0+GRquoA7bGcINcxew6w==", + "license": "ISC", + "dependencies": { + "string-width": "^4.1.0" + } + }, + "node_modules/ansi-align/node_modules/ansi-regex": { + "version": "5.0.1", + "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-5.0.1.tgz", + "integrity": "sha512-quJQXlTSUGL2LH9SUXo8VwsY4soanhgo6LNSm84E1LBcE8s3O0wpdiRzyR9z/ZZJMlMWv37qOOb9pdJlMUEKFQ==", + "license": "MIT", + "engines": { + "node": ">=8" + } + }, + "node_modules/ansi-align/node_modules/emoji-regex": { + "version": "8.0.0", + "resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-8.0.0.tgz", + "integrity": "sha512-MSjYzcWNOA0ewAHpz0MxpYFvwg6yjy1NG3xteoqz644VCo/RPgnr1/GGt+ic3iJTzQ8Eu3TdM14SawnVUmGE6A==", + "license": "MIT" + }, + "node_modules/ansi-align/node_modules/string-width": { + "version": "4.2.3", + "resolved": "https://registry.npmjs.org/string-width/-/string-width-4.2.3.tgz", + "integrity": "sha512-wKyQRQpjJ0sIp62ErSZdGsjMJWsap5oRNihHhu6G7JVO/9jIB6UyevL+tXuOqrng8j/cxKTWyWUwvSTriiZz/g==", + "license": "MIT", + "dependencies": { + "emoji-regex": "^8.0.0", + "is-fullwidth-code-point": "^3.0.0", + "strip-ansi": "^6.0.1" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/ansi-align/node_modules/strip-ansi": { + "version": "6.0.1", + "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-6.0.1.tgz", + "integrity": "sha512-Y38VPSHcqkFrCpFnQ9vuSXmquuv5oXOKpGeT6aGrr3o3Gc9AlVa6JBfUSOCnbxGGZF+/0ooI7KrPuUSztUdU5A==", + "license": "MIT", + "dependencies": { + "ansi-regex": "^5.0.1" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/ansi-regex": { + "version": "6.2.2", + "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-6.2.2.tgz", + "integrity": "sha512-Bq3SmSpyFHaWjPk8If9yc6svM8c56dB5BAtW4Qbw5jHTwwXXcTLoRMkpDJp6VL0XzlWaCHTXrkFURMYmD0sLqg==", + "license": "MIT", + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/chalk/ansi-regex?sponsor=1" + } + }, + "node_modules/ansi-styles": { + "version": "6.2.3", + "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-6.2.3.tgz", + "integrity": "sha512-4Dj6M28JB+oAH8kFkTLUo+a2jwOFkuqb3yucU0CANcRRUbxS0cP0nZYCGjcc3BNXwRIsUVmDGgzawme7zvJHvg==", + "license": "MIT", + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/chalk/ansi-styles?sponsor=1" + } + }, + "node_modules/anymatch": { + "version": "3.1.3", + "resolved": "https://registry.npmjs.org/anymatch/-/anymatch-3.1.3.tgz", + "integrity": "sha512-KMReFUr0B4t+D+OBkjR3KYqvocp2XaSzO55UcB6mgQMd3KbcE+mWTyvVV7D/zsdEbNnV6acZUutkiHQXvTr1Rw==", + "license": "ISC", + "dependencies": { + "normalize-path": "^3.0.0", + "picomatch": "^2.0.4" + }, + "engines": { + "node": ">= 8" + } + }, + "node_modules/anymatch/node_modules/picomatch": { + "version": "2.3.1", + "resolved": "https://registry.npmjs.org/picomatch/-/picomatch-2.3.1.tgz", + "integrity": "sha512-JU3teHTNjmE2VCGFzuY8EXzCDVwEqB2a8fsIvwaStHhAWJEeVd1o1QD80CU6+ZdEXXSLbSsuLwJjkCBWqRQUVA==", + "license": "MIT", + "engines": { + "node": ">=8.6" + }, + "funding": { + "url": "https://github.com/sponsors/jonschlinkert" + } + }, + "node_modules/arg": { + "version": "5.0.2", + "resolved": "https://registry.npmjs.org/arg/-/arg-5.0.2.tgz", + "integrity": "sha512-PYjyFOLKQ9y57JvQ6QLo8dAgNqswh8M1RMJYdQduT6xbWSgK36P/Z/v+p888pM69jMMfS8Xd8F6I1kQ/I9HUGg==", + "license": "MIT" + }, + "node_modules/argparse": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/argparse/-/argparse-2.0.1.tgz", + "integrity": "sha512-8+9WqebbFzpX9OR+Wa6O29asIogeRMzcGtAINdpMHHyAg10f05aSFVBbcEqGf/PXw1EjAZ+q2/bEBg3DvurK3Q==", + "license": "Python-2.0" + }, + "node_modules/aria-query": { + "version": "5.3.2", + "resolved": "https://registry.npmjs.org/aria-query/-/aria-query-5.3.2.tgz", + "integrity": "sha512-COROpnaoap1E2F000S62r6A60uHZnmlvomhfyT2DlTcrY1OrBKn2UhH7qn5wTC9zMvD0AY7csdPSNwKP+7WiQw==", + "license": "Apache-2.0", + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/array-iterate": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/array-iterate/-/array-iterate-2.0.1.tgz", + "integrity": "sha512-I1jXZMjAgCMmxT4qxXfPXa6SthSoE8h6gkSI9BGGNv8mP8G/v0blc+qFnZu6K42vTOiuME596QaLO0TP3Lk0xg==", + "license": "MIT", + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, + "node_modules/astring": { + "version": "1.9.0", + "resolved": "https://registry.npmjs.org/astring/-/astring-1.9.0.tgz", + "integrity": "sha512-LElXdjswlqjWrPpJFg1Fx4wpkOCxj1TDHlSV4PlaRxHGWko024xICaa97ZkMfs6DRKlCguiAI+rbXv5GWwXIkg==", + "license": "MIT", + "bin": { + "astring": "bin/astring" + } + }, + "node_modules/astro": { + "version": "5.16.0", + "resolved": "https://registry.npmjs.org/astro/-/astro-5.16.0.tgz", + "integrity": "sha512-GaDRs2Mngpw3dr2vc085GnORh98NiXxwIjg/EoQQQl/icZt3Z7s0BRsYHDZ8swkZbOA6wZsqWJdrNirl+iKcDg==", + "license": "MIT", + "peer": true, + "dependencies": { + "@astrojs/compiler": "^2.13.0", + "@astrojs/internal-helpers": "0.7.5", + "@astrojs/markdown-remark": "6.3.9", + "@astrojs/telemetry": "3.3.0", + "@capsizecss/unpack": "^3.0.1", + "@oslojs/encoding": "^1.1.0", + "@rollup/pluginutils": "^5.3.0", + "acorn": "^8.15.0", + "aria-query": "^5.3.2", + "axobject-query": "^4.1.0", + "boxen": "8.0.1", + "ci-info": "^4.3.1", + "clsx": "^2.1.1", + "common-ancestor-path": "^1.0.1", + "cookie": "^1.0.2", + "cssesc": "^3.0.0", + "debug": "^4.4.3", + "deterministic-object-hash": "^2.0.2", + "devalue": "^5.5.0", + "diff": "^5.2.0", + "dlv": "^1.1.3", + "dset": "^3.1.4", + "es-module-lexer": "^1.7.0", + "esbuild": "^0.25.0", + "estree-walker": "^3.0.3", + "flattie": "^1.1.1", + "fontace": "~0.3.1", + "github-slugger": "^2.0.0", + "html-escaper": "3.0.3", + "http-cache-semantics": "^4.2.0", + "import-meta-resolve": "^4.2.0", + "js-yaml": "^4.1.1", + "magic-string": "^0.30.21", + "magicast": "^0.5.1", + "mrmime": "^2.0.1", + "neotraverse": "^0.6.18", + "p-limit": "^6.2.0", + "p-queue": "^8.1.1", + "package-manager-detector": "^1.5.0", + "piccolore": "^0.1.3", + "picomatch": "^4.0.3", + "prompts": "^2.4.2", + "rehype": "^13.0.2", + "semver": "^7.7.3", + "shiki": "^3.15.0", + "smol-toml": "^1.5.0", + "svgo": "^4.0.0", + "tinyexec": "^1.0.2", + "tinyglobby": "^0.2.15", + "tsconfck": "^3.1.6", + "ultrahtml": "^1.6.0", + "unifont": "~0.6.0", + "unist-util-visit": "^5.0.0", + "unstorage": "^1.17.2", + "vfile": "^6.0.3", + "vite": "^6.4.1", + "vitefu": "^1.1.1", + "xxhash-wasm": "^1.1.0", + "yargs-parser": "^21.1.1", + "yocto-spinner": "^0.2.3", + "zod": "^3.25.76", + "zod-to-json-schema": "^3.24.6", + "zod-to-ts": "^1.2.0" + }, + "bin": { + "astro": "astro.js" + }, + "engines": { + "node": "18.20.8 || ^20.3.0 || >=22.0.0", + "npm": ">=9.6.5", + "pnpm": ">=7.1.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/astrodotbuild" + }, + "optionalDependencies": { + "sharp": "^0.34.0" + } + }, + "node_modules/astro-d2": { + "version": "0.5.2", + "resolved": "https://registry.npmjs.org/astro-d2/-/astro-d2-0.5.2.tgz", + "integrity": "sha512-JN5kHalh/dQIZD6JG8y+WXY/j+K9NigyW7dLa+VbPeQnoNkRbvVms6847gqU5czojR7uzpArL7ug27vKae4lQg==", + "license": "MIT", + "dependencies": { + "unist-util-visit": "5.0.0" + }, + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "astro": ">=4.0.0" + } + }, + "node_modules/astro-expressive-code": { + "version": "0.41.3", + "resolved": "https://registry.npmjs.org/astro-expressive-code/-/astro-expressive-code-0.41.3.tgz", + "integrity": "sha512-u+zHMqo/QNLE2eqYRCrK3+XMlKakv33Bzuz+56V1gs8H0y6TZ0hIi3VNbIxeTn51NLn+mJfUV/A0kMNfE4rANw==", + "license": "MIT", + "dependencies": { + "rehype-expressive-code": "^0.41.3" + }, + "peerDependencies": { + "astro": "^4.0.0-beta || ^5.0.0-beta || ^3.3.0" + } + }, + "node_modules/astro-remote": { + "version": "0.3.4", + "resolved": "https://registry.npmjs.org/astro-remote/-/astro-remote-0.3.4.tgz", + "integrity": "sha512-jL5skNQLA0YBc1R3bVGXyHew3FqGqsT7AgLzWAVeTLzFkwVMUYvs4/lKJSmS7ygcF1GnHnoKG6++8GL9VtWwGQ==", + "license": "MIT", + "dependencies": { + "entities": "^4.5.0", + "marked": "^12.0.0", + "marked-footnote": "^1.2.2", + "marked-smartypants": "^1.1.6", + "ultrahtml": "^1.5.3" + }, + "engines": { + "node": ">=18.14.1" + } + }, + "node_modules/astro-remote/node_modules/entities": { + "version": "4.5.0", + "resolved": "https://registry.npmjs.org/entities/-/entities-4.5.0.tgz", + "integrity": "sha512-V0hjH4dGPh9Ao5p0MoRY6BVqtwCjhz6vI5LT8AJ55H+4g9/4vbHx1I54fS0XuclLhDHArPQCiMjDxjaL8fPxhw==", + "license": "BSD-2-Clause", + "engines": { + "node": ">=0.12" + }, + "funding": { + "url": "https://github.com/fb55/entities?sponsor=1" + } + }, + "node_modules/astro-remote/node_modules/marked": { + "version": "12.0.2", + "resolved": "https://registry.npmjs.org/marked/-/marked-12.0.2.tgz", + "integrity": "sha512-qXUm7e/YKFoqFPYPa3Ukg9xlI5cyAtGmyEIzMfW//m6kXwCy2Ps9DYf5ioijFKQ8qyuscrHoY04iJGctu2Kg0Q==", + "license": "MIT", + "bin": { + "marked": "bin/marked.js" + }, + "engines": { + "node": ">= 18" + } + }, + "node_modules/astro/node_modules/@img/sharp-darwin-arm64": { + "version": "0.34.5", + "resolved": "https://registry.npmjs.org/@img/sharp-darwin-arm64/-/sharp-darwin-arm64-0.34.5.tgz", + "integrity": "sha512-imtQ3WMJXbMY4fxb/Ndp6HBTNVtWCUI0WdobyheGf5+ad6xX8VIDO8u2xE4qc/fr08CKG/7dDseFtn6M6g/r3w==", + "cpu": [ + "arm64" + ], + "license": "Apache-2.0", + "optional": true, + "os": [ + "darwin" + ], + "engines": { + "node": "^18.17.0 || ^20.3.0 || >=21.0.0" + }, + "funding": { + "url": "https://opencollective.com/libvips" + }, + "optionalDependencies": { + "@img/sharp-libvips-darwin-arm64": "1.2.4" + } + }, + "node_modules/astro/node_modules/@img/sharp-darwin-x64": { + "version": "0.34.5", + "resolved": "https://registry.npmjs.org/@img/sharp-darwin-x64/-/sharp-darwin-x64-0.34.5.tgz", + "integrity": "sha512-YNEFAF/4KQ/PeW0N+r+aVVsoIY0/qxxikF2SWdp+NRkmMB7y9LBZAVqQ4yhGCm/H3H270OSykqmQMKLBhBJDEw==", + "cpu": [ + "x64" + ], + "license": "Apache-2.0", + "optional": true, + "os": [ + "darwin" + ], + "engines": { + "node": "^18.17.0 || ^20.3.0 || >=21.0.0" + }, + "funding": { + "url": "https://opencollective.com/libvips" + }, + "optionalDependencies": { + "@img/sharp-libvips-darwin-x64": "1.2.4" + } + }, + "node_modules/astro/node_modules/@img/sharp-libvips-darwin-arm64": { + "version": "1.2.4", + "resolved": "https://registry.npmjs.org/@img/sharp-libvips-darwin-arm64/-/sharp-libvips-darwin-arm64-1.2.4.tgz", + "integrity": "sha512-zqjjo7RatFfFoP0MkQ51jfuFZBnVE2pRiaydKJ1G/rHZvnsrHAOcQALIi9sA5co5xenQdTugCvtb1cuf78Vf4g==", + "cpu": [ + "arm64" + ], + "license": "LGPL-3.0-or-later", + "optional": true, + "os": [ + "darwin" + ], + "funding": { + "url": "https://opencollective.com/libvips" + } + }, + "node_modules/astro/node_modules/@img/sharp-libvips-darwin-x64": { + "version": "1.2.4", + "resolved": "https://registry.npmjs.org/@img/sharp-libvips-darwin-x64/-/sharp-libvips-darwin-x64-1.2.4.tgz", + "integrity": "sha512-1IOd5xfVhlGwX+zXv2N93k0yMONvUlANylbJw1eTah8K/Jtpi15KC+WSiaX/nBmbm2HxRM1gZ0nSdjSsrZbGKg==", + "cpu": [ + "x64" + ], + "license": "LGPL-3.0-or-later", + "optional": true, + "os": [ + "darwin" + ], + "funding": { + "url": "https://opencollective.com/libvips" + } + }, + "node_modules/astro/node_modules/@img/sharp-libvips-linux-arm": { + "version": "1.2.4", + "resolved": "https://registry.npmjs.org/@img/sharp-libvips-linux-arm/-/sharp-libvips-linux-arm-1.2.4.tgz", + "integrity": "sha512-bFI7xcKFELdiNCVov8e44Ia4u2byA+l3XtsAj+Q8tfCwO6BQ8iDojYdvoPMqsKDkuoOo+X6HZA0s0q11ANMQ8A==", + "cpu": [ + "arm" + ], + "license": "LGPL-3.0-or-later", + "optional": true, + "os": [ + "linux" + ], + "funding": { + "url": "https://opencollective.com/libvips" + } + }, + "node_modules/astro/node_modules/@img/sharp-libvips-linux-arm64": { + "version": "1.2.4", + "resolved": "https://registry.npmjs.org/@img/sharp-libvips-linux-arm64/-/sharp-libvips-linux-arm64-1.2.4.tgz", + "integrity": "sha512-excjX8DfsIcJ10x1Kzr4RcWe1edC9PquDRRPx3YVCvQv+U5p7Yin2s32ftzikXojb1PIFc/9Mt28/y+iRklkrw==", + "cpu": [ + "arm64" + ], + "license": "LGPL-3.0-or-later", + "optional": true, + "os": [ + "linux" + ], + "funding": { + "url": "https://opencollective.com/libvips" + } + }, + "node_modules/astro/node_modules/@img/sharp-libvips-linux-s390x": { + "version": "1.2.4", + "resolved": "https://registry.npmjs.org/@img/sharp-libvips-linux-s390x/-/sharp-libvips-linux-s390x-1.2.4.tgz", + "integrity": "sha512-qmp9VrzgPgMoGZyPvrQHqk02uyjA0/QrTO26Tqk6l4ZV0MPWIW6LTkqOIov+J1yEu7MbFQaDpwdwJKhbJvuRxQ==", + "cpu": [ + "s390x" + ], + "license": "LGPL-3.0-or-later", + "optional": true, + "os": [ + "linux" + ], + "funding": { + "url": "https://opencollective.com/libvips" + } + }, + "node_modules/astro/node_modules/@img/sharp-libvips-linux-x64": { + "version": "1.2.4", + "resolved": "https://registry.npmjs.org/@img/sharp-libvips-linux-x64/-/sharp-libvips-linux-x64-1.2.4.tgz", + "integrity": "sha512-tJxiiLsmHc9Ax1bz3oaOYBURTXGIRDODBqhveVHonrHJ9/+k89qbLl0bcJns+e4t4rvaNBxaEZsFtSfAdquPrw==", + "cpu": [ + "x64" + ], + "license": "LGPL-3.0-or-later", + "optional": true, + "os": [ + "linux" + ], + "funding": { + "url": "https://opencollective.com/libvips" + } + }, + "node_modules/astro/node_modules/@img/sharp-libvips-linuxmusl-arm64": { + "version": "1.2.4", + "resolved": "https://registry.npmjs.org/@img/sharp-libvips-linuxmusl-arm64/-/sharp-libvips-linuxmusl-arm64-1.2.4.tgz", + "integrity": "sha512-FVQHuwx1IIuNow9QAbYUzJ+En8KcVm9Lk5+uGUQJHaZmMECZmOlix9HnH7n1TRkXMS0pGxIJokIVB9SuqZGGXw==", + "cpu": [ + "arm64" + ], + "license": "LGPL-3.0-or-later", + "optional": true, + "os": [ + "linux" + ], + "funding": { + "url": "https://opencollective.com/libvips" + } + }, + "node_modules/astro/node_modules/@img/sharp-libvips-linuxmusl-x64": { + "version": "1.2.4", + "resolved": "https://registry.npmjs.org/@img/sharp-libvips-linuxmusl-x64/-/sharp-libvips-linuxmusl-x64-1.2.4.tgz", + "integrity": "sha512-+LpyBk7L44ZIXwz/VYfglaX/okxezESc6UxDSoyo2Ks6Jxc4Y7sGjpgU9s4PMgqgjj1gZCylTieNamqA1MF7Dg==", + "cpu": [ + "x64" + ], + "license": "LGPL-3.0-or-later", + "optional": true, + "os": [ + "linux" + ], + "funding": { + "url": "https://opencollective.com/libvips" + } + }, + "node_modules/astro/node_modules/@img/sharp-linux-arm": { + "version": "0.34.5", + "resolved": "https://registry.npmjs.org/@img/sharp-linux-arm/-/sharp-linux-arm-0.34.5.tgz", + "integrity": "sha512-9dLqsvwtg1uuXBGZKsxem9595+ujv0sJ6Vi8wcTANSFpwV/GONat5eCkzQo/1O6zRIkh0m/8+5BjrRr7jDUSZw==", + "cpu": [ + "arm" + ], + "license": "Apache-2.0", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": "^18.17.0 || ^20.3.0 || >=21.0.0" + }, + "funding": { + "url": "https://opencollective.com/libvips" + }, + "optionalDependencies": { + "@img/sharp-libvips-linux-arm": "1.2.4" + } + }, + "node_modules/astro/node_modules/@img/sharp-linux-arm64": { + "version": "0.34.5", + "resolved": "https://registry.npmjs.org/@img/sharp-linux-arm64/-/sharp-linux-arm64-0.34.5.tgz", + "integrity": "sha512-bKQzaJRY/bkPOXyKx5EVup7qkaojECG6NLYswgktOZjaXecSAeCWiZwwiFf3/Y+O1HrauiE3FVsGxFg8c24rZg==", + "cpu": [ + "arm64" + ], + "license": "Apache-2.0", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": "^18.17.0 || ^20.3.0 || >=21.0.0" + }, + "funding": { + "url": "https://opencollective.com/libvips" + }, + "optionalDependencies": { + "@img/sharp-libvips-linux-arm64": "1.2.4" + } + }, + "node_modules/astro/node_modules/@img/sharp-linux-s390x": { + "version": "0.34.5", + "resolved": "https://registry.npmjs.org/@img/sharp-linux-s390x/-/sharp-linux-s390x-0.34.5.tgz", + "integrity": "sha512-nQtCk0PdKfho3eC5MrbQoigJ2gd1CgddUMkabUj+rBevs8tZ2cULOx46E7oyX+04WGfABgIwmMC0VqieTiR4jg==", + "cpu": [ + "s390x" + ], + "license": "Apache-2.0", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": "^18.17.0 || ^20.3.0 || >=21.0.0" + }, + "funding": { + "url": "https://opencollective.com/libvips" + }, + "optionalDependencies": { + "@img/sharp-libvips-linux-s390x": "1.2.4" + } + }, + "node_modules/astro/node_modules/@img/sharp-linux-x64": { + "version": "0.34.5", + "resolved": "https://registry.npmjs.org/@img/sharp-linux-x64/-/sharp-linux-x64-0.34.5.tgz", + "integrity": "sha512-MEzd8HPKxVxVenwAa+JRPwEC7QFjoPWuS5NZnBt6B3pu7EG2Ge0id1oLHZpPJdn3OQK+BQDiw9zStiHBTJQQQQ==", + "cpu": [ + "x64" + ], + "license": "Apache-2.0", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": "^18.17.0 || ^20.3.0 || >=21.0.0" + }, + "funding": { + "url": "https://opencollective.com/libvips" + }, + "optionalDependencies": { + "@img/sharp-libvips-linux-x64": "1.2.4" + } + }, + "node_modules/astro/node_modules/@img/sharp-linuxmusl-arm64": { + "version": "0.34.5", + "resolved": "https://registry.npmjs.org/@img/sharp-linuxmusl-arm64/-/sharp-linuxmusl-arm64-0.34.5.tgz", + "integrity": "sha512-fprJR6GtRsMt6Kyfq44IsChVZeGN97gTD331weR1ex1c1rypDEABN6Tm2xa1wE6lYb5DdEnk03NZPqA7Id21yg==", + "cpu": [ + "arm64" + ], + "license": "Apache-2.0", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": "^18.17.0 || ^20.3.0 || >=21.0.0" + }, + "funding": { + "url": "https://opencollective.com/libvips" + }, + "optionalDependencies": { + "@img/sharp-libvips-linuxmusl-arm64": "1.2.4" + } + }, + "node_modules/astro/node_modules/@img/sharp-linuxmusl-x64": { + "version": "0.34.5", + "resolved": "https://registry.npmjs.org/@img/sharp-linuxmusl-x64/-/sharp-linuxmusl-x64-0.34.5.tgz", + "integrity": "sha512-Jg8wNT1MUzIvhBFxViqrEhWDGzqymo3sV7z7ZsaWbZNDLXRJZoRGrjulp60YYtV4wfY8VIKcWidjojlLcWrd8Q==", + "cpu": [ + "x64" + ], + "license": "Apache-2.0", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": "^18.17.0 || ^20.3.0 || >=21.0.0" + }, + "funding": { + "url": "https://opencollective.com/libvips" + }, + "optionalDependencies": { + "@img/sharp-libvips-linuxmusl-x64": "1.2.4" + } + }, + "node_modules/astro/node_modules/@img/sharp-wasm32": { + "version": "0.34.5", + "resolved": "https://registry.npmjs.org/@img/sharp-wasm32/-/sharp-wasm32-0.34.5.tgz", + "integrity": "sha512-OdWTEiVkY2PHwqkbBI8frFxQQFekHaSSkUIJkwzclWZe64O1X4UlUjqqqLaPbUpMOQk6FBu/HtlGXNblIs0huw==", + "cpu": [ + "wasm32" + ], + "license": "Apache-2.0 AND LGPL-3.0-or-later AND MIT", + "optional": true, + "dependencies": { + "@emnapi/runtime": "^1.7.0" + }, + "engines": { + "node": "^18.17.0 || ^20.3.0 || >=21.0.0" + }, + "funding": { + "url": "https://opencollective.com/libvips" + } + }, + "node_modules/astro/node_modules/@img/sharp-win32-ia32": { + "version": "0.34.5", + "resolved": "https://registry.npmjs.org/@img/sharp-win32-ia32/-/sharp-win32-ia32-0.34.5.tgz", + "integrity": "sha512-FV9m/7NmeCmSHDD5j4+4pNI8Cp3aW+JvLoXcTUo0IqyjSfAZJ8dIUmijx1qaJsIiU+Hosw6xM5KijAWRJCSgNg==", + "cpu": [ + "ia32" + ], + "license": "Apache-2.0 AND LGPL-3.0-or-later", + "optional": true, + "os": [ + "win32" + ], + "engines": { + "node": "^18.17.0 || ^20.3.0 || >=21.0.0" + }, + "funding": { + "url": "https://opencollective.com/libvips" + } + }, + "node_modules/astro/node_modules/@img/sharp-win32-x64": { + "version": "0.34.5", + "resolved": "https://registry.npmjs.org/@img/sharp-win32-x64/-/sharp-win32-x64-0.34.5.tgz", + "integrity": "sha512-+29YMsqY2/9eFEiW93eqWnuLcWcufowXewwSNIT6UwZdUUCrM3oFjMWH/Z6/TMmb4hlFenmfAVbpWeup2jryCw==", + "cpu": [ + "x64" + ], + "license": "Apache-2.0 AND LGPL-3.0-or-later", + "optional": true, + "os": [ + "win32" + ], + "engines": { + "node": "^18.17.0 || ^20.3.0 || >=21.0.0" + }, + "funding": { + "url": "https://opencollective.com/libvips" + } + }, + "node_modules/astro/node_modules/semver": { + "version": "7.7.3", + "resolved": "https://registry.npmjs.org/semver/-/semver-7.7.3.tgz", + "integrity": "sha512-SdsKMrI9TdgjdweUSR9MweHA4EJ8YxHn8DFaDisvhVlUOe4BF1tLD7GAj0lIqWVl+dPb/rExr0Btby5loQm20Q==", + "license": "ISC", + "bin": { + "semver": "bin/semver.js" + }, + "engines": { + "node": ">=10" + } + }, + "node_modules/astro/node_modules/sharp": { + "version": "0.34.5", + "resolved": "https://registry.npmjs.org/sharp/-/sharp-0.34.5.tgz", + "integrity": "sha512-Ou9I5Ft9WNcCbXrU9cMgPBcCK8LiwLqcbywW3t4oDV37n1pzpuNLsYiAV8eODnjbtQlSDwZ2cUEeQz4E54Hltg==", + "hasInstallScript": true, + "license": "Apache-2.0", + "optional": true, + "dependencies": { + "@img/colour": "^1.0.0", + "detect-libc": "^2.1.2", + "semver": "^7.7.3" + }, + "engines": { + "node": "^18.17.0 || ^20.3.0 || >=21.0.0" + }, + "funding": { + "url": "https://opencollective.com/libvips" + }, + "optionalDependencies": { + "@img/sharp-darwin-arm64": "0.34.5", + "@img/sharp-darwin-x64": "0.34.5", + "@img/sharp-libvips-darwin-arm64": "1.2.4", + "@img/sharp-libvips-darwin-x64": "1.2.4", + "@img/sharp-libvips-linux-arm": "1.2.4", + "@img/sharp-libvips-linux-arm64": "1.2.4", + "@img/sharp-libvips-linux-ppc64": "1.2.4", + "@img/sharp-libvips-linux-riscv64": "1.2.4", + "@img/sharp-libvips-linux-s390x": "1.2.4", + "@img/sharp-libvips-linux-x64": "1.2.4", + "@img/sharp-libvips-linuxmusl-arm64": "1.2.4", + "@img/sharp-libvips-linuxmusl-x64": "1.2.4", + "@img/sharp-linux-arm": "0.34.5", + "@img/sharp-linux-arm64": "0.34.5", + "@img/sharp-linux-ppc64": "0.34.5", + "@img/sharp-linux-riscv64": "0.34.5", + "@img/sharp-linux-s390x": "0.34.5", + "@img/sharp-linux-x64": "0.34.5", + "@img/sharp-linuxmusl-arm64": "0.34.5", + "@img/sharp-linuxmusl-x64": "0.34.5", + "@img/sharp-wasm32": "0.34.5", + "@img/sharp-win32-arm64": "0.34.5", + "@img/sharp-win32-ia32": "0.34.5", + "@img/sharp-win32-x64": "0.34.5" + } + }, + "node_modules/axobject-query": { + "version": "4.1.0", + "resolved": "https://registry.npmjs.org/axobject-query/-/axobject-query-4.1.0.tgz", + "integrity": "sha512-qIj0G9wZbMGNLjLmg1PT6v2mE9AH2zlnADJD/2tC6E00hgmhUOfEB6greHPAfLRSufHqROIUTkw6E+M3lH0PTQ==", + "license": "Apache-2.0", + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/bail": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/bail/-/bail-2.0.2.tgz", + "integrity": "sha512-0xO6mYd7JB2YesxDKplafRpsiOzPt9V02ddPCLbY1xYGPOX24NTyN50qnUxgCPcSoYMhKpAuBTjQoRZCAkUDRw==", + "license": "MIT", + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, + "node_modules/base-64": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/base-64/-/base-64-1.0.0.tgz", + "integrity": "sha512-kwDPIFCGx0NZHog36dj+tHiwP4QMzsZ3AgMViUBKI0+V5n4U0ufTCUMhnQ04diaRI8EX/QcPfql7zlhZ7j4zgg==", + "license": "MIT" + }, + "node_modules/base64-js": { + "version": "1.5.1", + "resolved": "https://registry.npmjs.org/base64-js/-/base64-js-1.5.1.tgz", + "integrity": "sha512-AKpaYlHn8t4SVbOHCy+b5+KKgvR4vrsD8vbvrbiQJps7fKDTkjkDry6ji0rUJjC0kzbNePLwzxq8iypo41qeWA==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/feross" + }, + { + "type": "patreon", + "url": "https://www.patreon.com/feross" + }, + { + "type": "consulting", + "url": "https://feross.org/support" + } + ], + "license": "MIT" + }, + "node_modules/baseline-browser-mapping": { + "version": "2.8.30", + "resolved": "https://registry.npmjs.org/baseline-browser-mapping/-/baseline-browser-mapping-2.8.30.tgz", + "integrity": "sha512-aTUKW4ptQhS64+v2d6IkPzymEzzhw+G0bA1g3uBRV3+ntkH+svttKseW5IOR4Ed6NUVKqnY7qT3dKvzQ7io4AA==", + "license": "Apache-2.0", + "bin": { + "baseline-browser-mapping": "dist/cli.js" + } + }, + "node_modules/bcp-47": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/bcp-47/-/bcp-47-2.1.0.tgz", + "integrity": "sha512-9IIS3UPrvIa1Ej+lVDdDwO7zLehjqsaByECw0bu2RRGP73jALm6FYbzI5gWbgHLvNdkvfXB5YrSbocZdOS0c0w==", + "license": "MIT", + "dependencies": { + "is-alphabetical": "^2.0.0", + "is-alphanumerical": "^2.0.0", + "is-decimal": "^2.0.0" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, + "node_modules/bcp-47-match": { + "version": "2.0.3", + "resolved": "https://registry.npmjs.org/bcp-47-match/-/bcp-47-match-2.0.3.tgz", + "integrity": "sha512-JtTezzbAibu8G0R9op9zb3vcWZd9JF6M0xOYGPn0fNCd7wOpRB1mU2mH9T8gaBGbAAyIIVgB2G7xG0GP98zMAQ==", + "license": "MIT", + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, + "node_modules/boolbase": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/boolbase/-/boolbase-1.0.0.tgz", + "integrity": "sha512-JZOSA7Mo9sNGB8+UjSgzdLtokWAky1zbztM3WRLCbZ70/3cTANmQmOdR7y2g+J0e2WXywy1yS468tY+IruqEww==", + "license": "ISC" + }, + "node_modules/boxen": { + "version": "8.0.1", + "resolved": "https://registry.npmjs.org/boxen/-/boxen-8.0.1.tgz", + "integrity": "sha512-F3PH5k5juxom4xktynS7MoFY+NUWH5LC4CnH11YB8NPew+HLpmBLCybSAEyb2F+4pRXhuhWqFesoQd6DAyc2hw==", + "license": "MIT", + "dependencies": { + "ansi-align": "^3.0.1", + "camelcase": "^8.0.0", + "chalk": "^5.3.0", + "cli-boxes": "^3.0.0", + "string-width": "^7.2.0", + "type-fest": "^4.21.0", + "widest-line": "^5.0.0", + "wrap-ansi": "^9.0.0" + }, + "engines": { + "node": ">=18" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/braces": { + "version": "3.0.3", + "resolved": "https://registry.npmjs.org/braces/-/braces-3.0.3.tgz", + "integrity": "sha512-yQbXgO/OSZVD2IsiLlro+7Hf6Q18EJrKSEsdoMzKePKXct3gvD8oLcOQdIzGupr5Fj+EDe8gO/lxc1BzfMpxvA==", + "license": "MIT", + "dependencies": { + "fill-range": "^7.1.1" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/brotli": { + "version": "1.3.3", + "resolved": "https://registry.npmjs.org/brotli/-/brotli-1.3.3.tgz", + "integrity": "sha512-oTKjJdShmDuGW94SyyaoQvAjf30dZaHnjJ8uAF+u2/vGJkJbJPJAT1gDiOJP5v1Zb6f9KEyW/1HpuaWIXtGHPg==", + "license": "MIT", + "dependencies": { + "base64-js": "^1.1.2" + } + }, + "node_modules/browserslist": { + "version": "4.28.0", + "resolved": "https://registry.npmjs.org/browserslist/-/browserslist-4.28.0.tgz", + "integrity": "sha512-tbydkR/CxfMwelN0vwdP/pLkDwyAASZ+VfWm4EOwlB6SWhx1sYnWLqo8N5j0rAzPfzfRaxt0mM/4wPU/Su84RQ==", + "funding": [ + { + "type": "opencollective", + "url": "https://opencollective.com/browserslist" + }, + { + "type": "tidelift", + "url": "https://tidelift.com/funding/github/npm/browserslist" + }, + { + "type": "github", + "url": "https://github.com/sponsors/ai" + } + ], + "license": "MIT", + "peer": true, + "dependencies": { + "baseline-browser-mapping": "^2.8.25", + "caniuse-lite": "^1.0.30001754", + "electron-to-chromium": "^1.5.249", + "node-releases": "^2.0.27", + "update-browserslist-db": "^1.1.4" + }, + "bin": { + "browserslist": "cli.js" + }, + "engines": { + "node": "^6 || ^7 || ^8 || ^9 || ^10 || ^11 || ^12 || >=13.7" + } + }, + "node_modules/camelcase": { + "version": "8.0.0", + "resolved": "https://registry.npmjs.org/camelcase/-/camelcase-8.0.0.tgz", + "integrity": "sha512-8WB3Jcas3swSvjIeA2yvCJ+Miyz5l1ZmB6HFb9R1317dt9LCQoswg/BGrmAmkWVEszSrrg4RwmO46qIm2OEnSA==", + "license": "MIT", + "engines": { + "node": ">=16" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/caniuse-lite": { + "version": "1.0.30001756", + "resolved": "https://registry.npmjs.org/caniuse-lite/-/caniuse-lite-1.0.30001756.tgz", + "integrity": "sha512-4HnCNKbMLkLdhJz3TToeVWHSnfJvPaq6vu/eRP0Ahub/07n484XHhBF5AJoSGHdVrS8tKFauUQz8Bp9P7LVx7A==", + "funding": [ + { + "type": "opencollective", + "url": "https://opencollective.com/browserslist" + }, + { + "type": "tidelift", + "url": "https://tidelift.com/funding/github/npm/caniuse-lite" + }, + { + "type": "github", + "url": "https://github.com/sponsors/ai" + } + ], + "license": "CC-BY-4.0" + }, + "node_modules/ccount": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/ccount/-/ccount-2.0.1.tgz", + "integrity": "sha512-eyrF0jiFpY+3drT6383f1qhkbGsLSifNAjA61IUjZjmLCWjItY6LB9ft9YhoDgwfmclB2zhu51Lc7+95b8NRAg==", + "license": "MIT", + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, + "node_modules/chalk": { + "version": "5.6.2", + "resolved": "https://registry.npmjs.org/chalk/-/chalk-5.6.2.tgz", + "integrity": "sha512-7NzBL0rN6fMUW+f7A6Io4h40qQlG+xGmtMxfbnH/K7TAtt8JQWVQK+6g0UXKMeVJoyV5EkkNsErQ8pVD3bLHbA==", + "license": "MIT", + "engines": { + "node": "^12.17.0 || ^14.13 || >=16.0.0" + }, + "funding": { + "url": "https://github.com/chalk/chalk?sponsor=1" + } + }, + "node_modules/character-entities": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/character-entities/-/character-entities-2.0.2.tgz", + "integrity": "sha512-shx7oQ0Awen/BRIdkjkvz54PnEEI/EjwXDSIZp86/KKdbafHh1Df/RYGBhn4hbe2+uKC9FnT5UCEdyPz3ai9hQ==", + "license": "MIT", + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, + "node_modules/character-entities-html4": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/character-entities-html4/-/character-entities-html4-2.1.0.tgz", + "integrity": "sha512-1v7fgQRj6hnSwFpq1Eu0ynr/CDEw0rXo2B61qXrLNdHZmPKgb7fqS1a2JwF0rISo9q77jDI8VMEHoApn8qDoZA==", + "license": "MIT", + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, + "node_modules/character-entities-legacy": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/character-entities-legacy/-/character-entities-legacy-3.0.0.tgz", + "integrity": "sha512-RpPp0asT/6ufRm//AJVwpViZbGM/MkjQFxJccQRHmISF/22NBtsHqAWmL+/pmkPWoIUJdWyeVleTl1wydHATVQ==", + "license": "MIT", + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, + "node_modules/character-reference-invalid": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/character-reference-invalid/-/character-reference-invalid-2.0.1.tgz", + "integrity": "sha512-iBZ4F4wRbyORVsu0jPV7gXkOsGYjGHPmAyv+HiHG8gi5PtC9KI2j1+v8/tlibRvjoWX027ypmG/n0HtO5t7unw==", + "license": "MIT", + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, + "node_modules/chokidar": { + "version": "4.0.3", + "resolved": "https://registry.npmjs.org/chokidar/-/chokidar-4.0.3.tgz", + "integrity": "sha512-Qgzu8kfBvo+cA4962jnP1KkS6Dop5NS6g7R5LFYJr4b8Ub94PPQXUksCw9PvXoeXPRRddRNC5C1JQUR2SMGtnA==", + "license": "MIT", + "dependencies": { + "readdirp": "^4.0.1" + }, + "engines": { + "node": ">= 14.16.0" + }, + "funding": { + "url": "https://paulmillr.com/funding/" + } + }, + "node_modules/ci-info": { + "version": "4.3.1", + "resolved": "https://registry.npmjs.org/ci-info/-/ci-info-4.3.1.tgz", + "integrity": "sha512-Wdy2Igu8OcBpI2pZePZ5oWjPC38tmDVx5WKUXKwlLYkA0ozo85sLsLvkBbBn/sZaSCMFOGZJ14fvW9t5/d7kdA==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/sibiraj-s" + } + ], + "license": "MIT", + "engines": { + "node": ">=8" + } + }, + "node_modules/cli-boxes": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/cli-boxes/-/cli-boxes-3.0.0.tgz", + "integrity": "sha512-/lzGpEWL/8PfI0BmBOPRwp0c/wFNX1RdUML3jK/RcSBA9T8mZDdQpqYBKtCFTOfQbwPqWEOpjqW+Fnayc0969g==", + "license": "MIT", + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/cliui": { + "version": "8.0.1", + "resolved": "https://registry.npmjs.org/cliui/-/cliui-8.0.1.tgz", + "integrity": "sha512-BSeNnyus75C4//NQ9gQt1/csTXyo/8Sb+afLAkzAptFuMsod9HFokGNudZpi/oQV73hnVK+sR+5PVRMd+Dr7YQ==", + "license": "ISC", + "dependencies": { + "string-width": "^4.2.0", + "strip-ansi": "^6.0.1", + "wrap-ansi": "^7.0.0" + }, + "engines": { + "node": ">=12" + } + }, + "node_modules/cliui/node_modules/ansi-regex": { + "version": "5.0.1", + "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-5.0.1.tgz", + "integrity": "sha512-quJQXlTSUGL2LH9SUXo8VwsY4soanhgo6LNSm84E1LBcE8s3O0wpdiRzyR9z/ZZJMlMWv37qOOb9pdJlMUEKFQ==", + "license": "MIT", + "engines": { + "node": ">=8" + } + }, + "node_modules/cliui/node_modules/ansi-styles": { + "version": "4.3.0", + "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-4.3.0.tgz", + "integrity": "sha512-zbB9rCJAT1rbjiVDb2hqKFHNYLxgtk8NURxZ3IZwD3F6NtxbXZQCnnSi1Lkx+IDohdPlFp222wVALIheZJQSEg==", + "license": "MIT", + "dependencies": { + "color-convert": "^2.0.1" + }, + "engines": { + "node": ">=8" + }, + "funding": { + "url": "https://github.com/chalk/ansi-styles?sponsor=1" + } + }, + "node_modules/cliui/node_modules/emoji-regex": { + "version": "8.0.0", + "resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-8.0.0.tgz", + "integrity": "sha512-MSjYzcWNOA0ewAHpz0MxpYFvwg6yjy1NG3xteoqz644VCo/RPgnr1/GGt+ic3iJTzQ8Eu3TdM14SawnVUmGE6A==", + "license": "MIT" + }, + "node_modules/cliui/node_modules/string-width": { + "version": "4.2.3", + "resolved": "https://registry.npmjs.org/string-width/-/string-width-4.2.3.tgz", + "integrity": "sha512-wKyQRQpjJ0sIp62ErSZdGsjMJWsap5oRNihHhu6G7JVO/9jIB6UyevL+tXuOqrng8j/cxKTWyWUwvSTriiZz/g==", + "license": "MIT", + "dependencies": { + "emoji-regex": "^8.0.0", + "is-fullwidth-code-point": "^3.0.0", + "strip-ansi": "^6.0.1" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/cliui/node_modules/strip-ansi": { + "version": "6.0.1", + "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-6.0.1.tgz", + "integrity": "sha512-Y38VPSHcqkFrCpFnQ9vuSXmquuv5oXOKpGeT6aGrr3o3Gc9AlVa6JBfUSOCnbxGGZF+/0ooI7KrPuUSztUdU5A==", + "license": "MIT", + "dependencies": { + "ansi-regex": "^5.0.1" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/cliui/node_modules/wrap-ansi": { + "version": "7.0.0", + "resolved": "https://registry.npmjs.org/wrap-ansi/-/wrap-ansi-7.0.0.tgz", + "integrity": "sha512-YVGIj2kamLSTxw6NsZjoBxfSwsn0ycdesmc4p+Q21c5zPuZ1pl+NfxVdxPtdHvmNVOQ6XSYG4AUtyt/Fi7D16Q==", + "license": "MIT", + "dependencies": { + "ansi-styles": "^4.0.0", + "string-width": "^4.1.0", + "strip-ansi": "^6.0.0" + }, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/chalk/wrap-ansi?sponsor=1" + } + }, + "node_modules/clone": { + "version": "2.1.2", + "resolved": "https://registry.npmjs.org/clone/-/clone-2.1.2.tgz", + "integrity": "sha512-3Pe/CF1Nn94hyhIYpjtiLhdCoEoz0DqQ+988E9gmeEdQZlojxnOb74wctFyuwWQHzqyf9X7C7MG8juUpqBJT8w==", + "license": "MIT", + "engines": { + "node": ">=0.8" + } + }, + "node_modules/clsx": { + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/clsx/-/clsx-2.1.1.tgz", + "integrity": "sha512-eYm0QWBtUrBWZWG0d386OGAw16Z995PiOVo2B7bjWSbHedGl5e0ZWaq65kOGgUSNesEIDkB9ISbTg/JK9dhCZA==", + "license": "MIT", + "engines": { + "node": ">=6" + } + }, + "node_modules/collapse-white-space": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/collapse-white-space/-/collapse-white-space-2.1.0.tgz", + "integrity": "sha512-loKTxY1zCOuG4j9f6EPnuyyYkf58RnhhWTvRoZEokgB+WbdXehfjFviyOVYkqzEWz1Q5kRiZdBYS5SwxbQYwzw==", + "license": "MIT", + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, + "node_modules/color": { + "version": "4.2.3", + "resolved": "https://registry.npmjs.org/color/-/color-4.2.3.tgz", + "integrity": "sha512-1rXeuUUiGGrykh+CeBdu5Ie7OJwinCgQY0bc7GCRxy5xVHy+moaqkpL/jqQq0MtQOeYcrqEz4abc5f0KtU7W4A==", + "license": "MIT", + "dependencies": { + "color-convert": "^2.0.1", + "color-string": "^1.9.0" + }, + "engines": { + "node": ">=12.5.0" + } + }, + "node_modules/color-convert": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/color-convert/-/color-convert-2.0.1.tgz", + "integrity": "sha512-RRECPsj7iu/xb5oKYcsFHSppFNnsj/52OVTRKb4zP5onXwVF3zVmmToNcOfGC+CRDpfK/U584fMg38ZHCaElKQ==", + "license": "MIT", + "dependencies": { + "color-name": "~1.1.4" + }, + "engines": { + "node": ">=7.0.0" + } + }, + "node_modules/color-name": { + "version": "1.1.4", + "resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.4.tgz", + "integrity": "sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA==", + "license": "MIT" + }, + "node_modules/color-string": { + "version": "1.9.1", + "resolved": "https://registry.npmjs.org/color-string/-/color-string-1.9.1.tgz", + "integrity": "sha512-shrVawQFojnZv6xM40anx4CkoDP+fZsw/ZerEMsW/pyzsRbElpsL/DBVW7q3ExxwusdNXI3lXpuhEZkzs8p5Eg==", + "license": "MIT", + "dependencies": { + "color-name": "^1.0.0", + "simple-swizzle": "^0.2.2" + } + }, + "node_modules/comma-separated-tokens": { + "version": "2.0.3", + "resolved": "https://registry.npmjs.org/comma-separated-tokens/-/comma-separated-tokens-2.0.3.tgz", + "integrity": "sha512-Fu4hJdvzeylCfQPp9SGWidpzrMs7tTrlu6Vb8XGaRGck8QSNZJJp538Wrb60Lax4fPwR64ViY468OIUTbRlGZg==", + "license": "MIT", + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, + "node_modules/commander": { + "version": "11.1.0", + "resolved": "https://registry.npmjs.org/commander/-/commander-11.1.0.tgz", + "integrity": "sha512-yPVavfyCcRhmorC7rWlkHn15b4wDVgVmBA7kV4QVBsF7kv/9TKJAbAXVTxvTnwP8HHKjRCJDClKbciiYS7p0DQ==", + "license": "MIT", + "engines": { + "node": ">=16" + } + }, + "node_modules/common-ancestor-path": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/common-ancestor-path/-/common-ancestor-path-1.0.1.tgz", + "integrity": "sha512-L3sHRo1pXXEqX8VU28kfgUY+YGsk09hPqZiZmLacNib6XNTCM8ubYeT7ryXQw8asB1sKgcU5lkB7ONug08aB8w==", + "license": "ISC" + }, + "node_modules/convert-source-map": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/convert-source-map/-/convert-source-map-2.0.0.tgz", + "integrity": "sha512-Kvp459HrV2FEJ1CAsi1Ku+MY3kasH19TFykTz2xWmMeq6bk2NU3XXvfJ+Q61m0xktWwt+1HSYf3JZsTms3aRJg==", + "license": "MIT" + }, + "node_modules/cookie": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/cookie/-/cookie-1.0.2.tgz", + "integrity": "sha512-9Kr/j4O16ISv8zBBhJoi4bXOYNTkFLOqSL3UDB0njXxCXNezjeyVrJyGOWtgfs/q2km1gwBcfH8q1yEGoMYunA==", + "license": "MIT", + "engines": { + "node": ">=18" + } + }, + "node_modules/cookie-es": { + "version": "1.2.2", + "resolved": "https://registry.npmjs.org/cookie-es/-/cookie-es-1.2.2.tgz", + "integrity": "sha512-+W7VmiVINB+ywl1HGXJXmrqkOhpKrIiVZV6tQuV54ZyQC7MMuBt81Vc336GMLoHBq5hV/F9eXgt5Mnx0Rha5Fg==", + "license": "MIT" + }, + "node_modules/crossws": { + "version": "0.3.5", + "resolved": "https://registry.npmjs.org/crossws/-/crossws-0.3.5.tgz", + "integrity": "sha512-ojKiDvcmByhwa8YYqbQI/hg7MEU0NC03+pSdEq4ZUnZR9xXpwk7E43SMNGkn+JxJGPFtNvQ48+vV2p+P1ml5PA==", + "license": "MIT", + "dependencies": { + "uncrypto": "^0.1.3" + } + }, + "node_modules/css-select": { + "version": "5.2.2", + "resolved": "https://registry.npmjs.org/css-select/-/css-select-5.2.2.tgz", + "integrity": "sha512-TizTzUddG/xYLA3NXodFM0fSbNizXjOKhqiQQwvhlspadZokn1KDy0NZFS0wuEubIYAV5/c1/lAr0TaaFXEXzw==", + "license": "BSD-2-Clause", + "dependencies": { + "boolbase": "^1.0.0", + "css-what": "^6.1.0", + "domhandler": "^5.0.2", + "domutils": "^3.0.1", + "nth-check": "^2.0.1" + }, + "funding": { + "url": "https://github.com/sponsors/fb55" + } + }, + "node_modules/css-selector-parser": { + "version": "3.2.0", + "resolved": "https://registry.npmjs.org/css-selector-parser/-/css-selector-parser-3.2.0.tgz", + "integrity": "sha512-L1bdkNKUP5WYxiW5dW6vA2hd3sL8BdRNLy2FCX0rLVise4eNw9nBdeBuJHxlELieSE2H1f6bYQFfwVUwWCV9rQ==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/mdevils" + }, + { + "type": "patreon", + "url": "https://patreon.com/mdevils" + } + ], + "license": "MIT" + }, + "node_modules/css-tree": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/css-tree/-/css-tree-3.1.0.tgz", + "integrity": "sha512-0eW44TGN5SQXU1mWSkKwFstI/22X2bG1nYzZTYMAWjylYURhse752YgbE4Cx46AC+bAvI+/dYTPRk1LqSUnu6w==", + "license": "MIT", + "dependencies": { + "mdn-data": "2.12.2", + "source-map-js": "^1.0.1" + }, + "engines": { + "node": "^10 || ^12.20.0 || ^14.13.0 || >=15.0.0" + } + }, + "node_modules/css-what": { + "version": "6.2.2", + "resolved": "https://registry.npmjs.org/css-what/-/css-what-6.2.2.tgz", + "integrity": "sha512-u/O3vwbptzhMs3L1fQE82ZSLHQQfto5gyZzwteVIEyeaY5Fc7R4dapF/BvRoSYFeqfBk4m0V1Vafq5Pjv25wvA==", + "license": "BSD-2-Clause", + "engines": { + "node": ">= 6" + }, + "funding": { + "url": "https://github.com/sponsors/fb55" + } + }, + "node_modules/cssesc": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/cssesc/-/cssesc-3.0.0.tgz", + "integrity": "sha512-/Tb/JcjK111nNScGob5MNtsntNM1aCNUDipB/TkwZFhyDrrE47SOx/18wF2bbjgc3ZzCSKW1T5nt5EbFoAz/Vg==", + "license": "MIT", + "bin": { + "cssesc": "bin/cssesc" + }, + "engines": { + "node": ">=4" + } + }, + "node_modules/csso": { + "version": "5.0.5", + "resolved": "https://registry.npmjs.org/csso/-/csso-5.0.5.tgz", + "integrity": "sha512-0LrrStPOdJj+SPCCrGhzryycLjwcgUSHBtxNA8aIDxf0GLsRh1cKYhB00Gd1lDOS4yGH69+SNn13+TWbVHETFQ==", + "license": "MIT", + "dependencies": { + "css-tree": "~2.2.0" + }, + "engines": { + "node": "^10 || ^12.20.0 || ^14.13.0 || >=15.0.0", + "npm": ">=7.0.0" + } + }, + "node_modules/csso/node_modules/css-tree": { + "version": "2.2.1", + "resolved": "https://registry.npmjs.org/css-tree/-/css-tree-2.2.1.tgz", + "integrity": "sha512-OA0mILzGc1kCOCSJerOeqDxDQ4HOh+G8NbOJFOTgOCzpw7fCBubk0fEyxp8AgOL/jvLgYA/uV0cMbe43ElF1JA==", + "license": "MIT", + "dependencies": { + "mdn-data": "2.0.28", + "source-map-js": "^1.0.1" + }, + "engines": { + "node": "^10 || ^12.20.0 || ^14.13.0 || >=15.0.0", + "npm": ">=7.0.0" + } + }, + "node_modules/csso/node_modules/mdn-data": { + "version": "2.0.28", + "resolved": "https://registry.npmjs.org/mdn-data/-/mdn-data-2.0.28.tgz", + "integrity": "sha512-aylIc7Z9y4yzHYAJNuESG3hfhC+0Ibp/MAMiaOZgNv4pmEdFyfZhhhny4MNiAfWdBQ1RQ2mfDWmM1x8SvGyp8g==", + "license": "CC0-1.0" + }, + "node_modules/cssom": { + "version": "0.5.0", + "resolved": "https://registry.npmjs.org/cssom/-/cssom-0.5.0.tgz", + "integrity": "sha512-iKuQcq+NdHqlAcwUY0o/HL69XQrUaQdMjmStJ8JFmUaiiQErlhrmuigkg/CU4E2J0IyUKUrMAgl36TvN67MqTw==", + "license": "MIT" + }, + "node_modules/csstype": { + "version": "3.2.3", + "resolved": "https://registry.npmjs.org/csstype/-/csstype-3.2.3.tgz", + "integrity": "sha512-z1HGKcYy2xA8AGQfwrn0PAy+PB7X/GSj3UVJW9qKyn43xWa+gl5nXmU4qqLMRzWVLFC8KusUX8T/0kCiOYpAIQ==", + "license": "MIT" + }, + "node_modules/debug": { + "version": "4.4.3", + "resolved": "https://registry.npmjs.org/debug/-/debug-4.4.3.tgz", + "integrity": "sha512-RGwwWnwQvkVfavKVt22FGLw+xYSdzARwm0ru6DhTVA3umU5hZc28V3kO4stgYryrTlLpuvgI9GiijltAjNbcqA==", + "license": "MIT", + "dependencies": { + "ms": "^2.1.3" + }, + "engines": { + "node": ">=6.0" + }, + "peerDependenciesMeta": { + "supports-color": { + "optional": true + } + } + }, + "node_modules/decode-named-character-reference": { + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/decode-named-character-reference/-/decode-named-character-reference-1.2.0.tgz", + "integrity": "sha512-c6fcElNV6ShtZXmsgNgFFV5tVX2PaV4g+MOAkb8eXHvn6sryJBrZa9r0zV6+dtTyoCKxtDy5tyQ5ZwQuidtd+Q==", + "license": "MIT", + "dependencies": { + "character-entities": "^2.0.0" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, + "node_modules/defu": { + "version": "6.1.4", + "resolved": "https://registry.npmjs.org/defu/-/defu-6.1.4.tgz", + "integrity": "sha512-mEQCMmwJu317oSz8CwdIOdwf3xMif1ttiM8LTufzc3g6kR+9Pe236twL8j3IYT1F7GfRgGcW6MWxzZjLIkuHIg==", + "license": "MIT" + }, + "node_modules/dequal": { + "version": "2.0.3", + "resolved": "https://registry.npmjs.org/dequal/-/dequal-2.0.3.tgz", + "integrity": "sha512-0je+qPKHEMohvfRTCEo3CrPG6cAzAYgmzKyxRiYSSDkS6eGJdyVJm7WaYA5ECaAD9wLB2T4EEeymA5aFVcYXCA==", + "license": "MIT", + "engines": { + "node": ">=6" + } + }, + "node_modules/destr": { + "version": "2.0.5", + "resolved": "https://registry.npmjs.org/destr/-/destr-2.0.5.tgz", + "integrity": "sha512-ugFTXCtDZunbzasqBxrK93Ik/DRYsO6S/fedkWEMKqt04xZ4csmnmwGDBAb07QWNaGMAmnTIemsYZCksjATwsA==", + "license": "MIT" + }, + "node_modules/detect-libc": { + "version": "2.1.2", + "resolved": "https://registry.npmjs.org/detect-libc/-/detect-libc-2.1.2.tgz", + "integrity": "sha512-Btj2BOOO83o3WyH59e8MgXsxEQVcarkUOpEYrubB0urwnN10yQ364rsiByU11nZlqWYZm05i/of7io4mzihBtQ==", + "license": "Apache-2.0", + "engines": { + "node": ">=8" + } + }, + "node_modules/deterministic-object-hash": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/deterministic-object-hash/-/deterministic-object-hash-2.0.2.tgz", + "integrity": "sha512-KxektNH63SrbfUyDiwXqRb1rLwKt33AmMv+5Nhsw1kqZ13SJBRTgZHtGbE+hH3a1mVW1cz+4pqSWVPAtLVXTzQ==", + "license": "MIT", + "dependencies": { + "base-64": "^1.0.0" + }, + "engines": { + "node": ">=18" + } + }, + "node_modules/devalue": { + "version": "5.5.0", + "resolved": "https://registry.npmjs.org/devalue/-/devalue-5.5.0.tgz", + "integrity": "sha512-69sM5yrHfFLJt0AZ9QqZXGCPfJ7fQjvpln3Rq5+PS03LD32Ost1Q9N+eEnaQwGRIriKkMImXD56ocjQmfjbV3w==", + "license": "MIT" + }, + "node_modules/devlop": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/devlop/-/devlop-1.1.0.tgz", + "integrity": "sha512-RWmIqhcFf1lRYBvNmr7qTNuyCt/7/ns2jbpp1+PalgE/rDQcBT0fioSMUpJ93irlUhC5hrg4cYqe6U+0ImW0rA==", + "license": "MIT", + "dependencies": { + "dequal": "^2.0.0" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, + "node_modules/dfa": { + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/dfa/-/dfa-1.2.0.tgz", + "integrity": "sha512-ED3jP8saaweFTjeGX8HQPjeC1YYyZs98jGNZx6IiBvxW7JG5v492kamAQB3m2wop07CvU/RQmzcKr6bgcC5D/Q==", + "license": "MIT" + }, + "node_modules/diff": { + "version": "5.2.0", + "resolved": "https://registry.npmjs.org/diff/-/diff-5.2.0.tgz", + "integrity": "sha512-uIFDxqpRZGZ6ThOk84hEfqWoHx2devRFvpTZcTHur85vImfaxUbTW9Ryh4CpCuDnToOP1CEtXKIgytHBPVff5A==", + "license": "BSD-3-Clause", + "engines": { + "node": ">=0.3.1" + } + }, + "node_modules/direction": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/direction/-/direction-2.0.1.tgz", + "integrity": "sha512-9S6m9Sukh1cZNknO1CWAr2QAWsbKLafQiyM5gZ7VgXHeuaoUwffKN4q6NC4A/Mf9iiPlOXQEKW/Mv/mh9/3YFA==", + "license": "MIT", + "bin": { + "direction": "cli.js" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, + "node_modules/dlv": { + "version": "1.1.3", + "resolved": "https://registry.npmjs.org/dlv/-/dlv-1.1.3.tgz", + "integrity": "sha512-+HlytyjlPKnIG8XuRG8WvmBP8xs8P71y+SKKS6ZXWoEgLuePxtDoUEiH7WkdePWrQ5JBpE6aoVqfZfJUQkjXwA==", + "license": "MIT" + }, + "node_modules/dom-serializer": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/dom-serializer/-/dom-serializer-2.0.0.tgz", + "integrity": "sha512-wIkAryiqt/nV5EQKqQpo3SToSOV9J0DnbJqwK7Wv/Trc92zIAYZ4FlMu+JPFW1DfGFt81ZTCGgDEabffXeLyJg==", + "license": "MIT", + "dependencies": { + "domelementtype": "^2.3.0", + "domhandler": "^5.0.2", + "entities": "^4.2.0" + }, + "funding": { + "url": "https://github.com/cheeriojs/dom-serializer?sponsor=1" + } + }, + "node_modules/dom-serializer/node_modules/entities": { + "version": "4.5.0", + "resolved": "https://registry.npmjs.org/entities/-/entities-4.5.0.tgz", + "integrity": "sha512-V0hjH4dGPh9Ao5p0MoRY6BVqtwCjhz6vI5LT8AJ55H+4g9/4vbHx1I54fS0XuclLhDHArPQCiMjDxjaL8fPxhw==", + "license": "BSD-2-Clause", + "engines": { + "node": ">=0.12" + }, + "funding": { + "url": "https://github.com/fb55/entities?sponsor=1" + } + }, + "node_modules/domelementtype": { + "version": "2.3.0", + "resolved": "https://registry.npmjs.org/domelementtype/-/domelementtype-2.3.0.tgz", + "integrity": "sha512-OLETBj6w0OsagBwdXnPdN0cnMfF9opN69co+7ZrbfPGrdpPVNBUj02spi6B1N7wChLQiPn4CSH/zJvXw56gmHw==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/fb55" + } + ], + "license": "BSD-2-Clause" + }, + "node_modules/domhandler": { + "version": "5.0.3", + "resolved": "https://registry.npmjs.org/domhandler/-/domhandler-5.0.3.tgz", + "integrity": "sha512-cgwlv/1iFQiFnU96XXgROh8xTeetsnJiDsTc7TYCLFd9+/WNkIqPTxiM/8pSd8VIrhXGTf1Ny1q1hquVqDJB5w==", + "license": "BSD-2-Clause", + "dependencies": { + "domelementtype": "^2.3.0" + }, + "engines": { + "node": ">= 4" + }, + "funding": { + "url": "https://github.com/fb55/domhandler?sponsor=1" + } + }, + "node_modules/domutils": { + "version": "3.2.2", + "resolved": "https://registry.npmjs.org/domutils/-/domutils-3.2.2.tgz", + "integrity": "sha512-6kZKyUajlDuqlHKVX1w7gyslj9MPIXzIFiz/rGu35uC1wMi+kMhQwGhl4lt9unC9Vb9INnY9Z3/ZA3+FhASLaw==", + "license": "BSD-2-Clause", + "dependencies": { + "dom-serializer": "^2.0.0", + "domelementtype": "^2.3.0", + "domhandler": "^5.0.3" + }, + "funding": { + "url": "https://github.com/fb55/domutils?sponsor=1" + } + }, + "node_modules/dset": { + "version": "3.1.4", + "resolved": "https://registry.npmjs.org/dset/-/dset-3.1.4.tgz", + "integrity": "sha512-2QF/g9/zTaPDc3BjNcVTGoBbXBgYfMTTceLaYcFJ/W9kggFUkhxD/hMEeuLKbugyef9SqAx8cpgwlIP/jinUTA==", + "license": "MIT", + "engines": { + "node": ">=4" + } + }, + "node_modules/electron-to-chromium": { + "version": "1.5.259", + "resolved": "https://registry.npmjs.org/electron-to-chromium/-/electron-to-chromium-1.5.259.tgz", + "integrity": "sha512-I+oLXgpEJzD6Cwuwt1gYjxsDmu/S/Kd41mmLA3O+/uH2pFRO/DvOjUyGozL8j3KeLV6WyZ7ssPwELMsXCcsJAQ==", + "license": "ISC" + }, + "node_modules/emmet": { + "version": "2.4.11", + "resolved": "https://registry.npmjs.org/emmet/-/emmet-2.4.11.tgz", + "integrity": "sha512-23QPJB3moh/U9sT4rQzGgeyyGIrcM+GH5uVYg2C6wZIxAIJq7Ng3QLT79tl8FUwDXhyq9SusfknOrofAKqvgyQ==", + "license": "MIT", + "workspaces": [ + "./packages/scanner", + "./packages/abbreviation", + "./packages/css-abbreviation", + "./" + ], + "dependencies": { + "@emmetio/abbreviation": "^2.3.3", + "@emmetio/css-abbreviation": "^2.1.8" + } + }, + "node_modules/emoji-regex": { + "version": "10.6.0", + "resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-10.6.0.tgz", + "integrity": "sha512-toUI84YS5YmxW219erniWD0CIVOo46xGKColeNQRgOzDorgBi1v4D71/OFzgD9GO2UGKIv1C3Sp8DAn0+j5w7A==", + "license": "MIT" + }, + "node_modules/entities": { + "version": "6.0.1", + "resolved": "https://registry.npmjs.org/entities/-/entities-6.0.1.tgz", + "integrity": "sha512-aN97NXWF6AWBTahfVOIrB/NShkzi5H7F9r1s9mD3cDj4Ko5f2qhhVoYMibXF7GlLveb/D2ioWay8lxI97Ven3g==", + "license": "BSD-2-Clause", + "engines": { + "node": ">=0.12" + }, + "funding": { + "url": "https://github.com/fb55/entities?sponsor=1" + } + }, + "node_modules/es-module-lexer": { + "version": "1.7.0", + "resolved": "https://registry.npmjs.org/es-module-lexer/-/es-module-lexer-1.7.0.tgz", + "integrity": "sha512-jEQoCwk8hyb2AZziIOLhDqpm5+2ww5uIE6lkO/6jcOCusfk6LhMHpXXfBLXTZ7Ydyt0j4VoUQv6uGNYbdW+kBA==", + "license": "MIT" + }, + "node_modules/esast-util-from-estree": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/esast-util-from-estree/-/esast-util-from-estree-2.0.0.tgz", + "integrity": "sha512-4CyanoAudUSBAn5K13H4JhsMH6L9ZP7XbLVe/dKybkxMO7eDyLsT8UHl9TRNrU2Gr9nz+FovfSIjuXWJ81uVwQ==", + "license": "MIT", + "dependencies": { + "@types/estree-jsx": "^1.0.0", + "devlop": "^1.0.0", + "estree-util-visit": "^2.0.0", + "unist-util-position-from-estree": "^2.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/esast-util-from-js": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/esast-util-from-js/-/esast-util-from-js-2.0.1.tgz", + "integrity": "sha512-8Ja+rNJ0Lt56Pcf3TAmpBZjmx8ZcK5Ts4cAzIOjsjevg9oSXJnl6SUQ2EevU8tv3h6ZLWmoKL5H4fgWvdvfETw==", + "license": "MIT", + "dependencies": { + "@types/estree-jsx": "^1.0.0", + "acorn": "^8.0.0", + "esast-util-from-estree": "^2.0.0", + "vfile-message": "^4.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/esbuild": { + "version": "0.25.12", + "resolved": "https://registry.npmjs.org/esbuild/-/esbuild-0.25.12.tgz", + "integrity": "sha512-bbPBYYrtZbkt6Os6FiTLCTFxvq4tt3JKall1vRwshA3fdVztsLAatFaZobhkBC8/BrPetoa0oksYoKXoG4ryJg==", + "hasInstallScript": true, + "license": "MIT", + "bin": { + "esbuild": "bin/esbuild" + }, + "engines": { + "node": ">=18" + }, + "optionalDependencies": { + "@esbuild/aix-ppc64": "0.25.12", + "@esbuild/android-arm": "0.25.12", + "@esbuild/android-arm64": "0.25.12", + "@esbuild/android-x64": "0.25.12", + "@esbuild/darwin-arm64": "0.25.12", + "@esbuild/darwin-x64": "0.25.12", + "@esbuild/freebsd-arm64": "0.25.12", + "@esbuild/freebsd-x64": "0.25.12", + "@esbuild/linux-arm": "0.25.12", + "@esbuild/linux-arm64": "0.25.12", + "@esbuild/linux-ia32": "0.25.12", + "@esbuild/linux-loong64": "0.25.12", + "@esbuild/linux-mips64el": "0.25.12", + "@esbuild/linux-ppc64": "0.25.12", + "@esbuild/linux-riscv64": "0.25.12", + "@esbuild/linux-s390x": "0.25.12", + "@esbuild/linux-x64": "0.25.12", + "@esbuild/netbsd-arm64": "0.25.12", + "@esbuild/netbsd-x64": "0.25.12", + "@esbuild/openbsd-arm64": "0.25.12", + "@esbuild/openbsd-x64": "0.25.12", + "@esbuild/openharmony-arm64": "0.25.12", + "@esbuild/sunos-x64": "0.25.12", + "@esbuild/win32-arm64": "0.25.12", + "@esbuild/win32-ia32": "0.25.12", + "@esbuild/win32-x64": "0.25.12" + } + }, + "node_modules/escalade": { + "version": "3.2.0", + "resolved": "https://registry.npmjs.org/escalade/-/escalade-3.2.0.tgz", + "integrity": "sha512-WUj2qlxaQtO4g6Pq5c29GTcWGDyd8itL8zTlipgECz3JesAiiOKotd8JU6otB3PACgG6xkJUyVhboMS+bje/jA==", + "license": "MIT", + "engines": { + "node": ">=6" + } + }, + "node_modules/escape-string-regexp": { + "version": "5.0.0", + "resolved": "https://registry.npmjs.org/escape-string-regexp/-/escape-string-regexp-5.0.0.tgz", + "integrity": "sha512-/veY75JbMK4j1yjvuUxuVsiS/hr/4iHs9FTT6cgTexxdE0Ly/glccBAkloH/DofkjRbZU3bnoj38mOmhkZ0lHw==", + "license": "MIT", + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/estree-util-attach-comments": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/estree-util-attach-comments/-/estree-util-attach-comments-3.0.0.tgz", + "integrity": "sha512-cKUwm/HUcTDsYh/9FgnuFqpfquUbwIqwKM26BVCGDPVgvaCl/nDCCjUfiLlx6lsEZ3Z4RFxNbOQ60pkaEwFxGw==", + "license": "MIT", + "dependencies": { + "@types/estree": "^1.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/estree-util-build-jsx": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/estree-util-build-jsx/-/estree-util-build-jsx-3.0.1.tgz", + "integrity": "sha512-8U5eiL6BTrPxp/CHbs2yMgP8ftMhR5ww1eIKoWRMlqvltHF8fZn5LRDvTKuxD3DUn+shRbLGqXemcP51oFCsGQ==", + "license": "MIT", + "dependencies": { + "@types/estree-jsx": "^1.0.0", + "devlop": "^1.0.0", + "estree-util-is-identifier-name": "^3.0.0", + "estree-walker": "^3.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/estree-util-is-identifier-name": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/estree-util-is-identifier-name/-/estree-util-is-identifier-name-3.0.0.tgz", + "integrity": "sha512-hFtqIDZTIUZ9BXLb8y4pYGyk6+wekIivNVTcmvk8NoOh+VeRn5y6cEHzbURrWbfp1fIqdVipilzj+lfaadNZmg==", + "license": "MIT", + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/estree-util-scope": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/estree-util-scope/-/estree-util-scope-1.0.0.tgz", + "integrity": "sha512-2CAASclonf+JFWBNJPndcOpA8EMJwa0Q8LUFJEKqXLW6+qBvbFZuF5gItbQOs/umBUkjviCSDCbBwU2cXbmrhQ==", + "license": "MIT", + "dependencies": { + "@types/estree": "^1.0.0", + "devlop": "^1.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/estree-util-to-js": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/estree-util-to-js/-/estree-util-to-js-2.0.0.tgz", + "integrity": "sha512-WDF+xj5rRWmD5tj6bIqRi6CkLIXbbNQUcxQHzGysQzvHmdYG2G7p/Tf0J0gpxGgkeMZNTIjT/AoSvC9Xehcgdg==", + "license": "MIT", + "dependencies": { + "@types/estree-jsx": "^1.0.0", + "astring": "^1.8.0", + "source-map": "^0.7.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/estree-util-visit": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/estree-util-visit/-/estree-util-visit-2.0.0.tgz", + "integrity": "sha512-m5KgiH85xAhhW8Wta0vShLcUvOsh3LLPI2YVwcbio1l7E09NTLL1EyMZFM1OyWowoH0skScNbhOPl4kcBgzTww==", + "license": "MIT", + "dependencies": { + "@types/estree-jsx": "^1.0.0", + "@types/unist": "^3.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/estree-walker": { + "version": "3.0.3", + "resolved": "https://registry.npmjs.org/estree-walker/-/estree-walker-3.0.3.tgz", + "integrity": "sha512-7RUKfXgSMMkzt6ZuXmqapOurLGPPfgj6l9uRZ7lRGolvk0y2yocc35LdcxKC5PQZdn2DMqioAQ2NoWcrTKmm6g==", + "license": "MIT", + "dependencies": { + "@types/estree": "^1.0.0" + } + }, + "node_modules/eventemitter3": { + "version": "5.0.1", + "resolved": "https://registry.npmjs.org/eventemitter3/-/eventemitter3-5.0.1.tgz", + "integrity": "sha512-GWkBvjiSZK87ELrYOSESUYeVIc9mvLLf/nXalMOS5dYrgZq9o5OVkbZAVM06CVxYsCwH9BDZFPlQTlPA1j4ahA==", + "license": "MIT" + }, + "node_modules/expressive-code": { + "version": "0.41.3", + "resolved": "https://registry.npmjs.org/expressive-code/-/expressive-code-0.41.3.tgz", + "integrity": "sha512-YLnD62jfgBZYrXIPQcJ0a51Afv9h8VlWqEGK9uU2T5nL/5rb8SnA86+7+mgCZe5D34Tff5RNEA5hjNVJYHzrFg==", + "license": "MIT", + "dependencies": { + "@expressive-code/core": "^0.41.3", + "@expressive-code/plugin-frames": "^0.41.3", + "@expressive-code/plugin-shiki": "^0.41.3", + "@expressive-code/plugin-text-markers": "^0.41.3" + } + }, + "node_modules/extend": { + "version": "3.0.2", + "resolved": "https://registry.npmjs.org/extend/-/extend-3.0.2.tgz", + "integrity": "sha512-fjquC59cD7CyW6urNXK0FBufkZcoiGG80wTuPujX590cB5Ttln20E2UB4S/WARVqhXffZl2LNgS+gQdPIIim/g==", + "license": "MIT" + }, + "node_modules/fast-deep-equal": { + "version": "3.1.3", + "resolved": "https://registry.npmjs.org/fast-deep-equal/-/fast-deep-equal-3.1.3.tgz", + "integrity": "sha512-f3qQ9oQy9j2AhBe/H9VC91wLmKBCCU/gDOnKNAYG5hswO7BLKj09Hc5HYNz9cGI++xlpDCIgDaitVs03ATR84Q==", + "license": "MIT" + }, + "node_modules/fast-glob": { + "version": "3.3.3", + "resolved": "https://registry.npmjs.org/fast-glob/-/fast-glob-3.3.3.tgz", + "integrity": "sha512-7MptL8U0cqcFdzIzwOTHoilX9x5BrNqye7Z/LuC7kCMRio1EMSyqRK3BEAUD7sXRq4iT4AzTVuZdhgQ2TCvYLg==", + "license": "MIT", + "dependencies": { + "@nodelib/fs.stat": "^2.0.2", + "@nodelib/fs.walk": "^1.2.3", + "glob-parent": "^5.1.2", + "merge2": "^1.3.0", + "micromatch": "^4.0.8" + }, + "engines": { + "node": ">=8.6.0" + } + }, + "node_modules/fast-uri": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/fast-uri/-/fast-uri-3.1.0.tgz", + "integrity": "sha512-iPeeDKJSWf4IEOasVVrknXpaBV0IApz/gp7S2bb7Z4Lljbl2MGJRqInZiUrQwV16cpzw/D3S5j5Julj/gT52AA==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/fastify" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/fastify" + } + ], + "license": "BSD-3-Clause" + }, + "node_modules/fast-xml-parser": { + "version": "5.3.2", + "resolved": "https://registry.npmjs.org/fast-xml-parser/-/fast-xml-parser-5.3.2.tgz", + "integrity": "sha512-n8v8b6p4Z1sMgqRmqLJm3awW4NX7NkaKPfb3uJIBTSH7Pdvufi3PQ3/lJLQrvxcMYl7JI2jnDO90siPEpD8JBA==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/NaturalIntelligence" + } + ], + "license": "MIT", + "dependencies": { + "strnum": "^2.1.0" + }, + "bin": { + "fxparser": "src/cli/cli.js" + } + }, + "node_modules/fastq": { + "version": "1.19.1", + "resolved": "https://registry.npmjs.org/fastq/-/fastq-1.19.1.tgz", + "integrity": "sha512-GwLTyxkCXjXbxqIhTsMI2Nui8huMPtnxg7krajPJAjnEG/iiOS7i+zCtWGZR9G0NBKbXKh6X9m9UIsYX/N6vvQ==", + "license": "ISC", + "dependencies": { + "reusify": "^1.0.4" + } + }, + "node_modules/fdir": { + "version": "6.5.0", + "resolved": "https://registry.npmjs.org/fdir/-/fdir-6.5.0.tgz", + "integrity": "sha512-tIbYtZbucOs0BRGqPJkshJUYdL+SDH7dVM8gjy+ERp3WAUjLEFJE+02kanyHtwjWOnwrKYBiwAmM0p4kLJAnXg==", + "license": "MIT", + "engines": { + "node": ">=12.0.0" + }, + "peerDependencies": { + "picomatch": "^3 || ^4" + }, + "peerDependenciesMeta": { + "picomatch": { + "optional": true + } + } + }, + "node_modules/fill-range": { + "version": "7.1.1", + "resolved": "https://registry.npmjs.org/fill-range/-/fill-range-7.1.1.tgz", + "integrity": "sha512-YsGpe3WHLK8ZYi4tWDg2Jy3ebRz2rXowDxnld4bkQB00cc/1Zw9AWnC0i9ztDJitivtQvaI9KaLyKrc+hBW0yg==", + "license": "MIT", + "dependencies": { + "to-regex-range": "^5.0.1" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/flattie": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/flattie/-/flattie-1.1.1.tgz", + "integrity": "sha512-9UbaD6XdAL97+k/n+N7JwX46K/M6Zc6KcFYskrYL8wbBV/Uyk0CTAMY0VT+qiK5PM7AIc9aTWYtq65U7T+aCNQ==", + "license": "MIT", + "engines": { + "node": ">=8" + } + }, + "node_modules/fontace": { + "version": "0.3.1", + "resolved": "https://registry.npmjs.org/fontace/-/fontace-0.3.1.tgz", + "integrity": "sha512-9f5g4feWT1jWT8+SbL85aLIRLIXUaDygaM2xPXRmzPYxrOMNok79Lr3FGJoKVNKibE0WCunNiEVG2mwuE+2qEg==", + "license": "MIT", + "dependencies": { + "@types/fontkit": "^2.0.8", + "fontkit": "^2.0.4" + } + }, + "node_modules/fontkit": { + "version": "2.0.4", + "resolved": "https://registry.npmjs.org/fontkit/-/fontkit-2.0.4.tgz", + "integrity": "sha512-syetQadaUEDNdxdugga9CpEYVaQIxOwk7GlwZWWZ19//qW4zE5bknOKeMBDYAASwnpaSHKJITRLMF9m1fp3s6g==", + "license": "MIT", + "dependencies": { + "@swc/helpers": "^0.5.12", + "brotli": "^1.3.2", + "clone": "^2.1.2", + "dfa": "^1.2.0", + "fast-deep-equal": "^3.1.3", + "restructure": "^3.0.0", + "tiny-inflate": "^1.0.3", + "unicode-properties": "^1.4.0", + "unicode-trie": "^2.0.0" + } + }, + "node_modules/framer-motion": { + "version": "11.18.2", + "resolved": "https://registry.npmjs.org/framer-motion/-/framer-motion-11.18.2.tgz", + "integrity": "sha512-5F5Och7wrvtLVElIpclDT0CBzMVg3dL22B64aZwHtsIY8RB4mXICLrkajK4G9R+ieSAGcgrLeae2SeUTg2pr6w==", + "license": "MIT", + "dependencies": { + "motion-dom": "^11.18.1", + "motion-utils": "^11.18.1", + "tslib": "^2.4.0" + }, + "peerDependencies": { + "@emotion/is-prop-valid": "*", + "react": "^18.0.0 || ^19.0.0", + "react-dom": "^18.0.0 || ^19.0.0" + }, + "peerDependenciesMeta": { + "@emotion/is-prop-valid": { + "optional": true + }, + "react": { + "optional": true + }, + "react-dom": { + "optional": true + } + } + }, + "node_modules/fsevents": { + "version": "2.3.3", + "resolved": "https://registry.npmjs.org/fsevents/-/fsevents-2.3.3.tgz", + "integrity": "sha512-5xoDfX+fL7faATnagmWPpbFtwh/R77WmMMqqHGS65C3vvB0YHrgF+B1YmZ3441tMj5n63k0212XNoJwzlhffQw==", + "hasInstallScript": true, + "license": "MIT", + "optional": true, + "os": [ + "darwin" + ], + "engines": { + "node": "^8.16.0 || ^10.6.0 || >=11.0.0" + } + }, + "node_modules/gensync": { + "version": "1.0.0-beta.2", + "resolved": "https://registry.npmjs.org/gensync/-/gensync-1.0.0-beta.2.tgz", + "integrity": "sha512-3hN7NaskYvMDLQY55gnW3NQ+mesEAepTqlg+VEbj7zzqEMBVNhzcGYYeqFo/TlYz6eQiFcp1HcsCZO+nGgS8zg==", + "license": "MIT", + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/get-caller-file": { + "version": "2.0.5", + "resolved": "https://registry.npmjs.org/get-caller-file/-/get-caller-file-2.0.5.tgz", + "integrity": "sha512-DyFP3BM/3YHTQOCUL/w0OZHR0lpKeGrxotcHWcqNEdnltqFwXVfhEBQ94eIo34AfQpo0rGki4cyIiftY06h2Fg==", + "license": "ISC", + "engines": { + "node": "6.* || 8.* || >= 10.*" + } + }, + "node_modules/get-east-asian-width": { + "version": "1.4.0", + "resolved": "https://registry.npmjs.org/get-east-asian-width/-/get-east-asian-width-1.4.0.tgz", + "integrity": "sha512-QZjmEOC+IT1uk6Rx0sX22V6uHWVwbdbxf1faPqJ1QhLdGgsRGCZoyaQBm/piRdJy/D2um6hM1UP7ZEeQ4EkP+Q==", + "license": "MIT", + "engines": { + "node": ">=18" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/github-slugger": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/github-slugger/-/github-slugger-2.0.0.tgz", + "integrity": "sha512-IaOQ9puYtjrkq7Y0Ygl9KDZnrf/aiUJYUpVf89y8kyaxbRG7Y1SrX/jaumrv81vc61+kiMempujsM3Yw7w5qcw==", + "license": "ISC" + }, + "node_modules/glob-parent": { + "version": "5.1.2", + "resolved": "https://registry.npmjs.org/glob-parent/-/glob-parent-5.1.2.tgz", + "integrity": "sha512-AOIgSQCepiJYwP3ARnGx+5VnTu2HBYdzbGP45eLw1vr3zB3vZLeyed1sC9hnbcOc9/SrMyM5RPQrkGz4aS9Zow==", + "license": "ISC", + "dependencies": { + "is-glob": "^4.0.1" + }, + "engines": { + "node": ">= 6" + } + }, + "node_modules/h3": { + "version": "1.15.4", + "resolved": "https://registry.npmjs.org/h3/-/h3-1.15.4.tgz", + "integrity": "sha512-z5cFQWDffyOe4vQ9xIqNfCZdV4p//vy6fBnr8Q1AWnVZ0teurKMG66rLj++TKwKPUP3u7iMUvrvKaEUiQw2QWQ==", + "license": "MIT", + "dependencies": { + "cookie-es": "^1.2.2", + "crossws": "^0.3.5", + "defu": "^6.1.4", + "destr": "^2.0.5", + "iron-webcrypto": "^1.2.1", + "node-mock-http": "^1.0.2", + "radix3": "^1.1.2", + "ufo": "^1.6.1", + "uncrypto": "^0.1.3" + } + }, + "node_modules/hast-util-embedded": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/hast-util-embedded/-/hast-util-embedded-3.0.0.tgz", + "integrity": "sha512-naH8sld4Pe2ep03qqULEtvYr7EjrLK2QHY8KJR6RJkTUjPGObe1vnx585uzem2hGra+s1q08DZZpfgDVYRbaXA==", + "license": "MIT", + "dependencies": { + "@types/hast": "^3.0.0", + "hast-util-is-element": "^3.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/hast-util-format": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/hast-util-format/-/hast-util-format-1.1.0.tgz", + "integrity": "sha512-yY1UDz6bC9rDvCWHpx12aIBGRG7krurX0p0Fm6pT547LwDIZZiNr8a+IHDogorAdreULSEzP82Nlv5SZkHZcjA==", + "license": "MIT", + "dependencies": { + "@types/hast": "^3.0.0", + "hast-util-embedded": "^3.0.0", + "hast-util-minify-whitespace": "^1.0.0", + "hast-util-phrasing": "^3.0.0", + "hast-util-whitespace": "^3.0.0", + "html-whitespace-sensitive-tag-names": "^3.0.0", + "unist-util-visit-parents": "^6.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/hast-util-from-html": { + "version": "2.0.3", + "resolved": "https://registry.npmjs.org/hast-util-from-html/-/hast-util-from-html-2.0.3.tgz", + "integrity": "sha512-CUSRHXyKjzHov8yKsQjGOElXy/3EKpyX56ELnkHH34vDVw1N1XSQ1ZcAvTyAPtGqLTuKP/uxM+aLkSPqF/EtMw==", + "license": "MIT", + "dependencies": { + "@types/hast": "^3.0.0", + "devlop": "^1.1.0", + "hast-util-from-parse5": "^8.0.0", + "parse5": "^7.0.0", + "vfile": "^6.0.0", + "vfile-message": "^4.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/hast-util-from-parse5": { + "version": "8.0.3", + "resolved": "https://registry.npmjs.org/hast-util-from-parse5/-/hast-util-from-parse5-8.0.3.tgz", + "integrity": "sha512-3kxEVkEKt0zvcZ3hCRYI8rqrgwtlIOFMWkbclACvjlDw8Li9S2hk/d51OI0nr/gIpdMHNepwgOKqZ/sy0Clpyg==", + "license": "MIT", + "dependencies": { + "@types/hast": "^3.0.0", + "@types/unist": "^3.0.0", + "devlop": "^1.0.0", + "hastscript": "^9.0.0", + "property-information": "^7.0.0", + "vfile": "^6.0.0", + "vfile-location": "^5.0.0", + "web-namespaces": "^2.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/hast-util-has-property": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/hast-util-has-property/-/hast-util-has-property-3.0.0.tgz", + "integrity": "sha512-MNilsvEKLFpV604hwfhVStK0usFY/QmM5zX16bo7EjnAEGofr5YyI37kzopBlZJkHD4t887i+q/C8/tr5Q94cA==", + "license": "MIT", + "dependencies": { + "@types/hast": "^3.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/hast-util-is-body-ok-link": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/hast-util-is-body-ok-link/-/hast-util-is-body-ok-link-3.0.1.tgz", + "integrity": "sha512-0qpnzOBLztXHbHQenVB8uNuxTnm/QBFUOmdOSsEn7GnBtyY07+ENTWVFBAnXd/zEgd9/SUG3lRY7hSIBWRgGpQ==", + "license": "MIT", + "dependencies": { + "@types/hast": "^3.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/hast-util-is-element": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/hast-util-is-element/-/hast-util-is-element-3.0.0.tgz", + "integrity": "sha512-Val9mnv2IWpLbNPqc/pUem+a7Ipj2aHacCwgNfTiK0vJKl0LF+4Ba4+v1oPHFpf3bLYmreq0/l3Gud9S5OH42g==", + "license": "MIT", + "dependencies": { + "@types/hast": "^3.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/hast-util-minify-whitespace": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/hast-util-minify-whitespace/-/hast-util-minify-whitespace-1.0.1.tgz", + "integrity": "sha512-L96fPOVpnclQE0xzdWb/D12VT5FabA7SnZOUMtL1DbXmYiHJMXZvFkIZfiMmTCNJHUeO2K9UYNXoVyfz+QHuOw==", + "license": "MIT", + "dependencies": { + "@types/hast": "^3.0.0", + "hast-util-embedded": "^3.0.0", + "hast-util-is-element": "^3.0.0", + "hast-util-whitespace": "^3.0.0", + "unist-util-is": "^6.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/hast-util-parse-selector": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/hast-util-parse-selector/-/hast-util-parse-selector-4.0.0.tgz", + "integrity": "sha512-wkQCkSYoOGCRKERFWcxMVMOcYE2K1AaNLU8DXS9arxnLOUEWbOXKXiJUNzEpqZ3JOKpnha3jkFrumEjVliDe7A==", + "license": "MIT", + "dependencies": { + "@types/hast": "^3.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/hast-util-phrasing": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/hast-util-phrasing/-/hast-util-phrasing-3.0.1.tgz", + "integrity": "sha512-6h60VfI3uBQUxHqTyMymMZnEbNl1XmEGtOxxKYL7stY2o601COo62AWAYBQR9lZbYXYSBoxag8UpPRXK+9fqSQ==", + "license": "MIT", + "dependencies": { + "@types/hast": "^3.0.0", + "hast-util-embedded": "^3.0.0", + "hast-util-has-property": "^3.0.0", + "hast-util-is-body-ok-link": "^3.0.0", + "hast-util-is-element": "^3.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/hast-util-raw": { + "version": "9.1.0", + "resolved": "https://registry.npmjs.org/hast-util-raw/-/hast-util-raw-9.1.0.tgz", + "integrity": "sha512-Y8/SBAHkZGoNkpzqqfCldijcuUKh7/su31kEBp67cFY09Wy0mTRgtsLYsiIxMJxlu0f6AA5SUTbDR8K0rxnbUw==", + "license": "MIT", + "dependencies": { + "@types/hast": "^3.0.0", + "@types/unist": "^3.0.0", + "@ungap/structured-clone": "^1.0.0", + "hast-util-from-parse5": "^8.0.0", + "hast-util-to-parse5": "^8.0.0", + "html-void-elements": "^3.0.0", + "mdast-util-to-hast": "^13.0.0", + "parse5": "^7.0.0", + "unist-util-position": "^5.0.0", + "unist-util-visit": "^5.0.0", + "vfile": "^6.0.0", + "web-namespaces": "^2.0.0", + "zwitch": "^2.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/hast-util-select": { + "version": "6.0.4", + "resolved": "https://registry.npmjs.org/hast-util-select/-/hast-util-select-6.0.4.tgz", + "integrity": "sha512-RqGS1ZgI0MwxLaKLDxjprynNzINEkRHY2i8ln4DDjgv9ZhcYVIHN9rlpiYsqtFwrgpYU361SyWDQcGNIBVu3lw==", + "license": "MIT", + "dependencies": { + "@types/hast": "^3.0.0", + "@types/unist": "^3.0.0", + "bcp-47-match": "^2.0.0", + "comma-separated-tokens": "^2.0.0", + "css-selector-parser": "^3.0.0", + "devlop": "^1.0.0", + "direction": "^2.0.0", + "hast-util-has-property": "^3.0.0", + "hast-util-to-string": "^3.0.0", + "hast-util-whitespace": "^3.0.0", + "nth-check": "^2.0.0", + "property-information": "^7.0.0", + "space-separated-tokens": "^2.0.0", + "unist-util-visit": "^5.0.0", + "zwitch": "^2.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/hast-util-to-estree": { + "version": "3.1.3", + "resolved": "https://registry.npmjs.org/hast-util-to-estree/-/hast-util-to-estree-3.1.3.tgz", + "integrity": "sha512-48+B/rJWAp0jamNbAAf9M7Uf//UVqAoMmgXhBdxTDJLGKY+LRnZ99qcG+Qjl5HfMpYNzS5v4EAwVEF34LeAj7w==", + "license": "MIT", + "dependencies": { + "@types/estree": "^1.0.0", + "@types/estree-jsx": "^1.0.0", + "@types/hast": "^3.0.0", + "comma-separated-tokens": "^2.0.0", + "devlop": "^1.0.0", + "estree-util-attach-comments": "^3.0.0", + "estree-util-is-identifier-name": "^3.0.0", + "hast-util-whitespace": "^3.0.0", + "mdast-util-mdx-expression": "^2.0.0", + "mdast-util-mdx-jsx": "^3.0.0", + "mdast-util-mdxjs-esm": "^2.0.0", + "property-information": "^7.0.0", + "space-separated-tokens": "^2.0.0", + "style-to-js": "^1.0.0", + "unist-util-position": "^5.0.0", + "zwitch": "^2.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/hast-util-to-html": { + "version": "9.0.5", + "resolved": "https://registry.npmjs.org/hast-util-to-html/-/hast-util-to-html-9.0.5.tgz", + "integrity": "sha512-OguPdidb+fbHQSU4Q4ZiLKnzWo8Wwsf5bZfbvu7//a9oTYoqD/fWpe96NuHkoS9h0ccGOTe0C4NGXdtS0iObOw==", + "license": "MIT", + "dependencies": { + "@types/hast": "^3.0.0", + "@types/unist": "^3.0.0", + "ccount": "^2.0.0", + "comma-separated-tokens": "^2.0.0", + "hast-util-whitespace": "^3.0.0", + "html-void-elements": "^3.0.0", + "mdast-util-to-hast": "^13.0.0", + "property-information": "^7.0.0", + "space-separated-tokens": "^2.0.0", + "stringify-entities": "^4.0.0", + "zwitch": "^2.0.4" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/hast-util-to-jsx-runtime": { + "version": "2.3.6", + "resolved": "https://registry.npmjs.org/hast-util-to-jsx-runtime/-/hast-util-to-jsx-runtime-2.3.6.tgz", + "integrity": "sha512-zl6s8LwNyo1P9uw+XJGvZtdFF1GdAkOg8ujOw+4Pyb76874fLps4ueHXDhXWdk6YHQ6OgUtinliG7RsYvCbbBg==", + "license": "MIT", + "dependencies": { + "@types/estree": "^1.0.0", + "@types/hast": "^3.0.0", + "@types/unist": "^3.0.0", + "comma-separated-tokens": "^2.0.0", + "devlop": "^1.0.0", + "estree-util-is-identifier-name": "^3.0.0", + "hast-util-whitespace": "^3.0.0", + "mdast-util-mdx-expression": "^2.0.0", + "mdast-util-mdx-jsx": "^3.0.0", + "mdast-util-mdxjs-esm": "^2.0.0", + "property-information": "^7.0.0", + "space-separated-tokens": "^2.0.0", + "style-to-js": "^1.0.0", + "unist-util-position": "^5.0.0", + "vfile-message": "^4.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/hast-util-to-parse5": { + "version": "8.0.0", + "resolved": "https://registry.npmjs.org/hast-util-to-parse5/-/hast-util-to-parse5-8.0.0.tgz", + "integrity": "sha512-3KKrV5ZVI8if87DVSi1vDeByYrkGzg4mEfeu4alwgmmIeARiBLKCZS2uw5Gb6nU9x9Yufyj3iudm6i7nl52PFw==", + "license": "MIT", + "dependencies": { + "@types/hast": "^3.0.0", + "comma-separated-tokens": "^2.0.0", + "devlop": "^1.0.0", + "property-information": "^6.0.0", + "space-separated-tokens": "^2.0.0", + "web-namespaces": "^2.0.0", + "zwitch": "^2.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/hast-util-to-parse5/node_modules/property-information": { + "version": "6.5.0", + "resolved": "https://registry.npmjs.org/property-information/-/property-information-6.5.0.tgz", + "integrity": "sha512-PgTgs/BlvHxOu8QuEN7wi5A0OmXaBcHpmCSTehcs6Uuu9IkDIEo13Hy7n898RHfrQ49vKCoGeWZSaAK01nwVig==", + "license": "MIT", + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, + "node_modules/hast-util-to-string": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/hast-util-to-string/-/hast-util-to-string-3.0.1.tgz", + "integrity": "sha512-XelQVTDWvqcl3axRfI0xSeoVKzyIFPwsAGSLIsKdJKQMXDYJS4WYrBNF/8J7RdhIcFI2BOHgAifggsvsxp/3+A==", + "license": "MIT", + "dependencies": { + "@types/hast": "^3.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/hast-util-to-text": { + "version": "4.0.2", + "resolved": "https://registry.npmjs.org/hast-util-to-text/-/hast-util-to-text-4.0.2.tgz", + "integrity": "sha512-KK6y/BN8lbaq654j7JgBydev7wuNMcID54lkRav1P0CaE1e47P72AWWPiGKXTJU271ooYzcvTAn/Zt0REnvc7A==", + "license": "MIT", + "dependencies": { + "@types/hast": "^3.0.0", + "@types/unist": "^3.0.0", + "hast-util-is-element": "^3.0.0", + "unist-util-find-after": "^5.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/hast-util-whitespace": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/hast-util-whitespace/-/hast-util-whitespace-3.0.0.tgz", + "integrity": "sha512-88JUN06ipLwsnv+dVn+OIYOvAuvBMy/Qoi6O7mQHxdPXpjy+Cd6xRkWwux7DKO+4sYILtLBRIKgsdpS2gQc7qw==", + "license": "MIT", + "dependencies": { + "@types/hast": "^3.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/hastscript": { + "version": "9.0.1", + "resolved": "https://registry.npmjs.org/hastscript/-/hastscript-9.0.1.tgz", + "integrity": "sha512-g7df9rMFX/SPi34tyGCyUBREQoKkapwdY/T04Qn9TDWfHhAYt4/I0gMVirzK5wEzeUqIjEB+LXC/ypb7Aqno5w==", + "license": "MIT", + "dependencies": { + "@types/hast": "^3.0.0", + "comma-separated-tokens": "^2.0.0", + "hast-util-parse-selector": "^4.0.0", + "property-information": "^7.0.0", + "space-separated-tokens": "^2.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/html-escaper": { + "version": "3.0.3", + "resolved": "https://registry.npmjs.org/html-escaper/-/html-escaper-3.0.3.tgz", + "integrity": "sha512-RuMffC89BOWQoY0WKGpIhn5gX3iI54O6nRA0yC124NYVtzjmFWBIiFd8M0x+ZdX0P9R4lADg1mgP8C7PxGOWuQ==", + "license": "MIT" + }, + "node_modules/html-void-elements": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/html-void-elements/-/html-void-elements-3.0.0.tgz", + "integrity": "sha512-bEqo66MRXsUGxWHV5IP0PUiAWwoEjba4VCzg0LjFJBpchPaTfyfCKTG6bc5F8ucKec3q5y6qOdGyYTSBEvhCrg==", + "license": "MIT", + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, + "node_modules/html-whitespace-sensitive-tag-names": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/html-whitespace-sensitive-tag-names/-/html-whitespace-sensitive-tag-names-3.0.1.tgz", + "integrity": "sha512-q+310vW8zmymYHALr1da4HyXUQ0zgiIwIicEfotYPWGN0OJVEN/58IJ3A4GBYcEq3LGAZqKb+ugvP0GNB9CEAA==", + "license": "MIT", + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/htmlparser2": { + "version": "10.0.0", + "resolved": "https://registry.npmjs.org/htmlparser2/-/htmlparser2-10.0.0.tgz", + "integrity": "sha512-TwAZM+zE5Tq3lrEHvOlvwgj1XLWQCtaaibSN11Q+gGBAS7Y1uZSWwXXRe4iF6OXnaq1riyQAPFOBtYc77Mxq0g==", + "funding": [ + "https://github.com/fb55/htmlparser2?sponsor=1", + { + "type": "github", + "url": "https://github.com/sponsors/fb55" + } + ], + "license": "MIT", + "dependencies": { + "domelementtype": "^2.3.0", + "domhandler": "^5.0.3", + "domutils": "^3.2.1", + "entities": "^6.0.0" + } + }, + "node_modules/http-cache-semantics": { + "version": "4.2.0", + "resolved": "https://registry.npmjs.org/http-cache-semantics/-/http-cache-semantics-4.2.0.tgz", + "integrity": "sha512-dTxcvPXqPvXBQpq5dUr6mEMJX4oIEFv6bwom3FDwKRDsuIjjJGANqhBuoAn9c1RQJIdAKav33ED65E2ys+87QQ==", + "license": "BSD-2-Clause" + }, + "node_modules/i18next": { + "version": "23.16.8", + "resolved": "https://registry.npmjs.org/i18next/-/i18next-23.16.8.tgz", + "integrity": "sha512-06r/TitrM88Mg5FdUXAKL96dJMzgqLE5dv3ryBAra4KCwD9mJ4ndOTS95ZuymIGoE+2hzfdaMak2X11/es7ZWg==", + "funding": [ + { + "type": "individual", + "url": "https://locize.com" + }, + { + "type": "individual", + "url": "https://locize.com/i18next.html" + }, + { + "type": "individual", + "url": "https://www.i18next.com/how-to/faq#i18next-is-awesome.-how-can-i-support-the-project" + } + ], + "license": "MIT", + "dependencies": { + "@babel/runtime": "^7.23.2" + } + }, + "node_modules/import-meta-resolve": { + "version": "4.2.0", + "resolved": "https://registry.npmjs.org/import-meta-resolve/-/import-meta-resolve-4.2.0.tgz", + "integrity": "sha512-Iqv2fzaTQN28s/FwZAoFq0ZSs/7hMAHJVX+w8PZl3cY19Pxk6jFFalxQoIfW2826i/fDLXv8IiEZRIT0lDuWcg==", + "license": "MIT", + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, + "node_modules/inline-style-parser": { + "version": "0.2.7", + "resolved": "https://registry.npmjs.org/inline-style-parser/-/inline-style-parser-0.2.7.tgz", + "integrity": "sha512-Nb2ctOyNR8DqQoR0OwRG95uNWIC0C1lCgf5Naz5H6Ji72KZ8OcFZLz2P5sNgwlyoJ8Yif11oMuYs5pBQa86csA==", + "license": "MIT" + }, + "node_modules/iron-webcrypto": { + "version": "1.2.1", + "resolved": "https://registry.npmjs.org/iron-webcrypto/-/iron-webcrypto-1.2.1.tgz", + "integrity": "sha512-feOM6FaSr6rEABp/eDfVseKyTMDt+KGpeB35SkVn9Tyn0CqvVsY3EwI0v5i8nMHyJnzCIQf7nsy3p41TPkJZhg==", + "license": "MIT", + "funding": { + "url": "https://github.com/sponsors/brc-dd" + } + }, + "node_modules/is-absolute-url": { + "version": "4.0.1", + "resolved": "https://registry.npmjs.org/is-absolute-url/-/is-absolute-url-4.0.1.tgz", + "integrity": "sha512-/51/TKE88Lmm7Gc4/8btclNXWS+g50wXhYJq8HWIBAGUBnoAdRu1aXeh364t/O7wXDAcTJDP8PNuNKWUDWie+A==", + "license": "MIT", + "engines": { + "node": "^12.20.0 || ^14.13.1 || >=16.0.0" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/is-alphabetical": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/is-alphabetical/-/is-alphabetical-2.0.1.tgz", + "integrity": "sha512-FWyyY60MeTNyeSRpkM2Iry0G9hpr7/9kD40mD/cGQEuilcZYS4okz8SN2Q6rLCJ8gbCt6fN+rC+6tMGS99LaxQ==", + "license": "MIT", + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, + "node_modules/is-alphanumerical": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/is-alphanumerical/-/is-alphanumerical-2.0.1.tgz", + "integrity": "sha512-hmbYhX/9MUMF5uh7tOXyK/n0ZvWpad5caBA17GsC6vyuCqaWliRG5K1qS9inmUhEMaOBIW7/whAnSwveW/LtZw==", + "license": "MIT", + "dependencies": { + "is-alphabetical": "^2.0.0", + "is-decimal": "^2.0.0" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, + "node_modules/is-arrayish": { + "version": "0.3.4", + "resolved": "https://registry.npmjs.org/is-arrayish/-/is-arrayish-0.3.4.tgz", + "integrity": "sha512-m6UrgzFVUYawGBh1dUsWR5M2Clqic9RVXC/9f8ceNlv2IcO9j9J/z8UoCLPqtsPBFNzEpfR3xftohbfqDx8EQA==", + "license": "MIT" + }, + "node_modules/is-decimal": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/is-decimal/-/is-decimal-2.0.1.tgz", + "integrity": "sha512-AAB9hiomQs5DXWcRB1rqsxGUstbRroFOPPVAomNk/3XHR5JyEZChOyTWe2oayKnsSsr/kcGqF+z6yuH6HHpN0A==", + "license": "MIT", + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, + "node_modules/is-docker": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/is-docker/-/is-docker-3.0.0.tgz", + "integrity": "sha512-eljcgEDlEns/7AXFosB5K/2nCM4P7FQPkGc/DWLy5rmFEWvZayGrik1d9/QIY5nJ4f9YsVvBkA6kJpHn9rISdQ==", + "license": "MIT", + "bin": { + "is-docker": "cli.js" + }, + "engines": { + "node": "^12.20.0 || ^14.13.1 || >=16.0.0" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/is-extglob": { + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/is-extglob/-/is-extglob-2.1.1.tgz", + "integrity": "sha512-SbKbANkN603Vi4jEZv49LeVJMn4yGwsbzZworEoyEiutsN3nJYdbO36zfhGJ6QEDpOZIFkDtnq5JRxmvl3jsoQ==", + "license": "MIT", + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/is-fullwidth-code-point": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/is-fullwidth-code-point/-/is-fullwidth-code-point-3.0.0.tgz", + "integrity": "sha512-zymm5+u+sCsSWyD9qNaejV3DFvhCKclKdizYaJUuHA83RLjb7nSuGnddCHGv0hk+KY7BMAlsWeK4Ueg6EV6XQg==", + "license": "MIT", + "engines": { + "node": ">=8" + } + }, + "node_modules/is-glob": { + "version": "4.0.3", + "resolved": "https://registry.npmjs.org/is-glob/-/is-glob-4.0.3.tgz", + "integrity": "sha512-xelSayHH36ZgE7ZWhli7pW34hNbNl8Ojv5KVmkJD4hBdD3th8Tfk9vYasLM+mXWOZhFkgZfxhLSnrwRr4elSSg==", + "license": "MIT", + "dependencies": { + "is-extglob": "^2.1.1" + }, + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/is-hexadecimal": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/is-hexadecimal/-/is-hexadecimal-2.0.1.tgz", + "integrity": "sha512-DgZQp241c8oO6cA1SbTEWiXeoxV42vlcJxgH+B3hi1AiqqKruZR3ZGF8In3fj4+/y/7rHvlOZLZtgJ/4ttYGZg==", + "license": "MIT", + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, + "node_modules/is-inside-container": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/is-inside-container/-/is-inside-container-1.0.0.tgz", + "integrity": "sha512-KIYLCCJghfHZxqjYBE7rEy0OBuTd5xCHS7tHVgvCLkx7StIoaxwNW3hCALgEUjFfeRk+MG/Qxmp/vtETEF3tRA==", + "license": "MIT", + "dependencies": { + "is-docker": "^3.0.0" + }, + "bin": { + "is-inside-container": "cli.js" + }, + "engines": { + "node": ">=14.16" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/is-number": { + "version": "7.0.0", + "resolved": "https://registry.npmjs.org/is-number/-/is-number-7.0.0.tgz", + "integrity": "sha512-41Cifkg6e8TylSpdtTpeLVMqvSBEVzTttHvERD741+pnZ8ANv0004MRL43QKPDlK9cGvNp6NZWZUBlbGXYxxng==", + "license": "MIT", + "engines": { + "node": ">=0.12.0" + } + }, + "node_modules/is-plain-obj": { + "version": "4.1.0", + "resolved": "https://registry.npmjs.org/is-plain-obj/-/is-plain-obj-4.1.0.tgz", + "integrity": "sha512-+Pgi+vMuUNkJyExiMBt5IlFoMyKnr5zhJ4Uspz58WOhBF5QoIZkFyNHIbBAtHwzVAgk5RtndVNsDRN61/mmDqg==", + "license": "MIT", + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/is-wsl": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/is-wsl/-/is-wsl-3.1.0.tgz", + "integrity": "sha512-UcVfVfaK4Sc4m7X3dUSoHoozQGBEFeDC+zVo06t98xe8CzHSZZBekNXH+tu0NalHolcJ/QAGqS46Hef7QXBIMw==", + "license": "MIT", + "dependencies": { + "is-inside-container": "^1.0.0" + }, + "engines": { + "node": ">=16" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/js-tokens": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/js-tokens/-/js-tokens-4.0.0.tgz", + "integrity": "sha512-RdJUflcE3cUzKiMqQgsCu06FPu9UdIJO0beYbPhHN4k6apgJtifcoCtT9bcxOpYBtpD2kCM6Sbzg4CausW/PKQ==", + "license": "MIT" + }, + "node_modules/js-yaml": { + "version": "4.1.1", + "resolved": "https://registry.npmjs.org/js-yaml/-/js-yaml-4.1.1.tgz", + "integrity": "sha512-qQKT4zQxXl8lLwBtHMWwaTcGfFOZviOJet3Oy/xmGk2gZH677CJM9EvtfdSkgWcATZhj/55JZ0rmy3myCT5lsA==", + "license": "MIT", + "dependencies": { + "argparse": "^2.0.1" + }, + "bin": { + "js-yaml": "bin/js-yaml.js" + } + }, + "node_modules/jsesc": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/jsesc/-/jsesc-3.1.0.tgz", + "integrity": "sha512-/sM3dO2FOzXjKQhJuo0Q173wf2KOo8t4I8vHy6lF9poUp7bKT0/NHE8fPX23PwfhnykfqnC2xRxOnVw5XuGIaA==", + "license": "MIT", + "bin": { + "jsesc": "bin/jsesc" + }, + "engines": { + "node": ">=6" + } + }, + "node_modules/json-schema-traverse": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/json-schema-traverse/-/json-schema-traverse-1.0.0.tgz", + "integrity": "sha512-NM8/P9n3XjXhIZn1lLhkFaACTOURQXjWhV4BA/RnOv8xvgqtqpAX9IO4mRQxSx1Rlo4tqzeqb0sOlruaOy3dug==", + "license": "MIT" + }, + "node_modules/json5": { + "version": "2.2.3", + "resolved": "https://registry.npmjs.org/json5/-/json5-2.2.3.tgz", + "integrity": "sha512-XmOWe7eyHYH14cLdVPoyg+GOH3rYX++KpzrylJwSW98t3Nk+U8XOl8FWKOgwtzdb8lXGf6zYwDUzeHMWfxasyg==", + "license": "MIT", + "bin": { + "json5": "lib/cli.js" + }, + "engines": { + "node": ">=6" + } + }, + "node_modules/jsonc-parser": { + "version": "2.3.1", + "resolved": "https://registry.npmjs.org/jsonc-parser/-/jsonc-parser-2.3.1.tgz", + "integrity": "sha512-H8jvkz1O50L3dMZCsLqiuB2tA7muqbSg1AtGEkN0leAqGjsUzDJir3Zwr02BhqdcITPg3ei3mZ+HjMocAknhhg==", + "license": "MIT" + }, + "node_modules/kleur": { + "version": "4.1.5", + "resolved": "https://registry.npmjs.org/kleur/-/kleur-4.1.5.tgz", + "integrity": "sha512-o+NO+8WrRiQEE4/7nwRJhN1HWpVmJm511pBHUxPLtp0BUISzlBplORYSmTclCnJvQq2tKu/sgl3xVpkc7ZWuQQ==", + "license": "MIT", + "engines": { + "node": ">=6" + } + }, + "node_modules/klona": { + "version": "2.0.6", + "resolved": "https://registry.npmjs.org/klona/-/klona-2.0.6.tgz", + "integrity": "sha512-dhG34DXATL5hSxJbIexCft8FChFXtmskoZYnoPWjXQuebWYCNkVeV3KkGegCK9CP1oswI/vQibS2GY7Em/sJJA==", + "license": "MIT", + "engines": { + "node": ">= 8" + } + }, + "node_modules/linkedom": { + "version": "0.18.12", + "resolved": "https://registry.npmjs.org/linkedom/-/linkedom-0.18.12.tgz", + "integrity": "sha512-jalJsOwIKuQJSeTvsgzPe9iJzyfVaEJiEXl+25EkKevsULHvMJzpNqwvj1jOESWdmgKDiXObyjOYwlUqG7wo1Q==", + "license": "ISC", + "dependencies": { + "css-select": "^5.1.0", + "cssom": "^0.5.0", + "html-escaper": "^3.0.3", + "htmlparser2": "^10.0.0", + "uhyphen": "^0.2.0" + }, + "engines": { + "node": ">=16" + }, + "peerDependencies": { + "canvas": ">= 2" + }, + "peerDependenciesMeta": { + "canvas": { + "optional": true + } + } + }, + "node_modules/lite-youtube-embed": { + "version": "0.3.4", + "resolved": "https://registry.npmjs.org/lite-youtube-embed/-/lite-youtube-embed-0.3.4.tgz", + "integrity": "sha512-aXgxpwK7AIW58GEbRzA8EYaY4LWvF3FKak6B9OtSJmuNyLhX2ouD4cMTxz/yR5HFInhknaYd2jLWOTRTvT8oAw==", + "license": "Apache-2.0" + }, + "node_modules/lodash": { + "version": "4.17.21", + "resolved": "https://registry.npmjs.org/lodash/-/lodash-4.17.21.tgz", + "integrity": "sha512-v2kDEe57lecTulaDIuNTPy3Ry4gLGJ6Z1O3vE1krgXZNrsQ+LFTGHVxVjcXPs17LhbZVGedAJv8XZ1tvj5FvSg==", + "license": "MIT" + }, + "node_modules/longest-streak": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/longest-streak/-/longest-streak-3.1.0.tgz", + "integrity": "sha512-9Ri+o0JYgehTaVBBDoMqIl8GXtbWg711O3srftcHhZ0dqnETqLaoIK0x17fUw9rFSlK/0NlsKe0Ahhyl5pXE2g==", + "license": "MIT", + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, + "node_modules/lru-cache": { + "version": "5.1.1", + "resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-5.1.1.tgz", + "integrity": "sha512-KpNARQA3Iwv+jTA0utUVVbrh+Jlrr1Fv0e56GGzAFOXN7dk/FviaDW8LHmK52DlcH4WP2n6gI8vN1aesBFgo9w==", + "license": "ISC", + "dependencies": { + "yallist": "^3.0.2" + } + }, + "node_modules/magic-string": { + "version": "0.30.21", + "resolved": "https://registry.npmjs.org/magic-string/-/magic-string-0.30.21.tgz", + "integrity": "sha512-vd2F4YUyEXKGcLHoq+TEyCjxueSeHnFxyyjNp80yg0XV4vUhnDer/lvvlqM/arB5bXQN5K2/3oinyCRyx8T2CQ==", + "license": "MIT", + "dependencies": { + "@jridgewell/sourcemap-codec": "^1.5.5" + } + }, + "node_modules/magicast": { + "version": "0.5.1", + "resolved": "https://registry.npmjs.org/magicast/-/magicast-0.5.1.tgz", + "integrity": "sha512-xrHS24IxaLrvuo613F719wvOIv9xPHFWQHuvGUBmPnCA/3MQxKI3b+r7n1jAoDHmsbC5bRhTZYR77invLAxVnw==", + "license": "MIT", + "dependencies": { + "@babel/parser": "^7.28.5", + "@babel/types": "^7.28.5", + "source-map-js": "^1.2.1" + } + }, + "node_modules/markdown-extensions": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/markdown-extensions/-/markdown-extensions-2.0.0.tgz", + "integrity": "sha512-o5vL7aDWatOTX8LzaS1WMoaoxIiLRQJuIKKe2wAw6IeULDHaqbiqiggmx+pKvZDb1Sj+pE46Sn1T7lCqfFtg1Q==", + "license": "MIT", + "engines": { + "node": ">=16" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/markdown-table": { + "version": "3.0.4", + "resolved": "https://registry.npmjs.org/markdown-table/-/markdown-table-3.0.4.tgz", + "integrity": "sha512-wiYz4+JrLyb/DqW2hkFJxP7Vd7JuTDm77fvbM8VfEQdmSMqcImWeeRbHwZjBjIFki/VaMK2BhFi7oUUZeM5bqw==", + "license": "MIT", + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, + "node_modules/marked": { + "version": "15.0.12", + "resolved": "https://registry.npmjs.org/marked/-/marked-15.0.12.tgz", + "integrity": "sha512-8dD6FusOQSrpv9Z1rdNMdlSgQOIP880DHqnohobOmYLElGEqAL/JvxvuxZO16r4HtjTlfPRDC1hbvxC9dPN2nA==", + "license": "MIT", + "peer": true, + "bin": { + "marked": "bin/marked.js" + }, + "engines": { + "node": ">= 18" + } + }, + "node_modules/marked-footnote": { + "version": "1.4.0", + "resolved": "https://registry.npmjs.org/marked-footnote/-/marked-footnote-1.4.0.tgz", + "integrity": "sha512-fZTxAhI1TcLEs5UOjCfYfTHpyKGaWQevbxaGTEA68B51l7i87SctPFtHETYqPkEN0ka5opvy4Dy1l/yXVC+hmg==", + "license": "MIT", + "peerDependencies": { + "marked": ">=7.0.0" + } + }, + "node_modules/marked-plaintify": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/marked-plaintify/-/marked-plaintify-1.1.1.tgz", + "integrity": "sha512-r3kMKArhfo2H3lD4ctFq/OJTzM0uNvXHh7FBTI1hMDpf4Ac1djjtq4g8NfTBWMxWLmaEz3KL1jCkLygik3gExA==", + "license": "MIT", + "peerDependencies": { + "marked": ">=13.0.0" + } + }, + "node_modules/marked-smartypants": { + "version": "1.1.11", + "resolved": "https://registry.npmjs.org/marked-smartypants/-/marked-smartypants-1.1.11.tgz", + "integrity": "sha512-Jt0eq/6rf9oXDfEKPzQ0z7UzVWcEAK3L6QBBQzbwV8bT304OvPVLTqpH3yvkSung9foOM4s120TMHEHP76Metg==", + "license": "MIT", + "dependencies": { + "smartypants": "^0.2.2" + }, + "peerDependencies": { + "marked": ">=4 <18" + } + }, + "node_modules/mdast-util-definitions": { + "version": "6.0.0", + "resolved": "https://registry.npmjs.org/mdast-util-definitions/-/mdast-util-definitions-6.0.0.tgz", + "integrity": "sha512-scTllyX6pnYNZH/AIp/0ePz6s4cZtARxImwoPJ7kS42n+MnVsI4XbnG6d4ibehRIldYMWM2LD7ImQblVhUejVQ==", + "license": "MIT", + "dependencies": { + "@types/mdast": "^4.0.0", + "@types/unist": "^3.0.0", + "unist-util-visit": "^5.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/mdast-util-directive": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/mdast-util-directive/-/mdast-util-directive-3.1.0.tgz", + "integrity": "sha512-I3fNFt+DHmpWCYAT7quoM6lHf9wuqtI+oCOfvILnoicNIqjh5E3dEJWiXuYME2gNe8vl1iMQwyUHa7bgFmak6Q==", + "license": "MIT", + "dependencies": { + "@types/mdast": "^4.0.0", + "@types/unist": "^3.0.0", + "ccount": "^2.0.0", + "devlop": "^1.0.0", + "mdast-util-from-markdown": "^2.0.0", + "mdast-util-to-markdown": "^2.0.0", + "parse-entities": "^4.0.0", + "stringify-entities": "^4.0.0", + "unist-util-visit-parents": "^6.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/mdast-util-find-and-replace": { + "version": "3.0.2", + "resolved": "https://registry.npmjs.org/mdast-util-find-and-replace/-/mdast-util-find-and-replace-3.0.2.tgz", + "integrity": "sha512-Tmd1Vg/m3Xz43afeNxDIhWRtFZgM2VLyaf4vSTYwudTyeuTneoL3qtWMA5jeLyz/O1vDJmmV4QuScFCA2tBPwg==", + "license": "MIT", + "dependencies": { + "@types/mdast": "^4.0.0", + "escape-string-regexp": "^5.0.0", + "unist-util-is": "^6.0.0", + "unist-util-visit-parents": "^6.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/mdast-util-from-markdown": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/mdast-util-from-markdown/-/mdast-util-from-markdown-2.0.2.tgz", + "integrity": "sha512-uZhTV/8NBuw0WHkPTrCqDOl0zVe1BIng5ZtHoDk49ME1qqcjYmmLmOf0gELgcRMxN4w2iuIeVso5/6QymSrgmA==", + "license": "MIT", + "dependencies": { + "@types/mdast": "^4.0.0", + "@types/unist": "^3.0.0", + "decode-named-character-reference": "^1.0.0", + "devlop": "^1.0.0", + "mdast-util-to-string": "^4.0.0", + "micromark": "^4.0.0", + "micromark-util-decode-numeric-character-reference": "^2.0.0", + "micromark-util-decode-string": "^2.0.0", + "micromark-util-normalize-identifier": "^2.0.0", + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0", + "unist-util-stringify-position": "^4.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/mdast-util-gfm": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/mdast-util-gfm/-/mdast-util-gfm-3.1.0.tgz", + "integrity": "sha512-0ulfdQOM3ysHhCJ1p06l0b0VKlhU0wuQs3thxZQagjcjPrlFRqY215uZGHHJan9GEAXd9MbfPjFJz+qMkVR6zQ==", + "license": "MIT", + "dependencies": { + "mdast-util-from-markdown": "^2.0.0", + "mdast-util-gfm-autolink-literal": "^2.0.0", + "mdast-util-gfm-footnote": "^2.0.0", + "mdast-util-gfm-strikethrough": "^2.0.0", + "mdast-util-gfm-table": "^2.0.0", + "mdast-util-gfm-task-list-item": "^2.0.0", + "mdast-util-to-markdown": "^2.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/mdast-util-gfm-autolink-literal": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/mdast-util-gfm-autolink-literal/-/mdast-util-gfm-autolink-literal-2.0.1.tgz", + "integrity": "sha512-5HVP2MKaP6L+G6YaxPNjuL0BPrq9orG3TsrZ9YXbA3vDw/ACI4MEsnoDpn6ZNm7GnZgtAcONJyPhOP8tNJQavQ==", + "license": "MIT", + "dependencies": { + "@types/mdast": "^4.0.0", + "ccount": "^2.0.0", + "devlop": "^1.0.0", + "mdast-util-find-and-replace": "^3.0.0", + "micromark-util-character": "^2.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/mdast-util-gfm-footnote": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/mdast-util-gfm-footnote/-/mdast-util-gfm-footnote-2.1.0.tgz", + "integrity": "sha512-sqpDWlsHn7Ac9GNZQMeUzPQSMzR6Wv0WKRNvQRg0KqHh02fpTz69Qc1QSseNX29bhz1ROIyNyxExfawVKTm1GQ==", + "license": "MIT", + "dependencies": { + "@types/mdast": "^4.0.0", + "devlop": "^1.1.0", + "mdast-util-from-markdown": "^2.0.0", + "mdast-util-to-markdown": "^2.0.0", + "micromark-util-normalize-identifier": "^2.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/mdast-util-gfm-strikethrough": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/mdast-util-gfm-strikethrough/-/mdast-util-gfm-strikethrough-2.0.0.tgz", + "integrity": "sha512-mKKb915TF+OC5ptj5bJ7WFRPdYtuHv0yTRxK2tJvi+BDqbkiG7h7u/9SI89nRAYcmap2xHQL9D+QG/6wSrTtXg==", + "license": "MIT", + "dependencies": { + "@types/mdast": "^4.0.0", + "mdast-util-from-markdown": "^2.0.0", + "mdast-util-to-markdown": "^2.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/mdast-util-gfm-table": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/mdast-util-gfm-table/-/mdast-util-gfm-table-2.0.0.tgz", + "integrity": "sha512-78UEvebzz/rJIxLvE7ZtDd/vIQ0RHv+3Mh5DR96p7cS7HsBhYIICDBCu8csTNWNO6tBWfqXPWekRuj2FNOGOZg==", + "license": "MIT", + "dependencies": { + "@types/mdast": "^4.0.0", + "devlop": "^1.0.0", + "markdown-table": "^3.0.0", + "mdast-util-from-markdown": "^2.0.0", + "mdast-util-to-markdown": "^2.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/mdast-util-gfm-task-list-item": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/mdast-util-gfm-task-list-item/-/mdast-util-gfm-task-list-item-2.0.0.tgz", + "integrity": "sha512-IrtvNvjxC1o06taBAVJznEnkiHxLFTzgonUdy8hzFVeDun0uTjxxrRGVaNFqkU1wJR3RBPEfsxmU6jDWPofrTQ==", + "license": "MIT", + "dependencies": { + "@types/mdast": "^4.0.0", + "devlop": "^1.0.0", + "mdast-util-from-markdown": "^2.0.0", + "mdast-util-to-markdown": "^2.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/mdast-util-mdx": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/mdast-util-mdx/-/mdast-util-mdx-3.0.0.tgz", + "integrity": "sha512-JfbYLAW7XnYTTbUsmpu0kdBUVe+yKVJZBItEjwyYJiDJuZ9w4eeaqks4HQO+R7objWgS2ymV60GYpI14Ug554w==", + "license": "MIT", + "dependencies": { + "mdast-util-from-markdown": "^2.0.0", + "mdast-util-mdx-expression": "^2.0.0", + "mdast-util-mdx-jsx": "^3.0.0", + "mdast-util-mdxjs-esm": "^2.0.0", + "mdast-util-to-markdown": "^2.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/mdast-util-mdx-expression": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/mdast-util-mdx-expression/-/mdast-util-mdx-expression-2.0.1.tgz", + "integrity": "sha512-J6f+9hUp+ldTZqKRSg7Vw5V6MqjATc+3E4gf3CFNcuZNWD8XdyI6zQ8GqH7f8169MM6P7hMBRDVGnn7oHB9kXQ==", + "license": "MIT", + "dependencies": { + "@types/estree-jsx": "^1.0.0", + "@types/hast": "^3.0.0", + "@types/mdast": "^4.0.0", + "devlop": "^1.0.0", + "mdast-util-from-markdown": "^2.0.0", + "mdast-util-to-markdown": "^2.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/mdast-util-mdx-jsx": { + "version": "3.2.0", + "resolved": "https://registry.npmjs.org/mdast-util-mdx-jsx/-/mdast-util-mdx-jsx-3.2.0.tgz", + "integrity": "sha512-lj/z8v0r6ZtsN/cGNNtemmmfoLAFZnjMbNyLzBafjzikOM+glrjNHPlf6lQDOTccj9n5b0PPihEBbhneMyGs1Q==", + "license": "MIT", + "dependencies": { + "@types/estree-jsx": "^1.0.0", + "@types/hast": "^3.0.0", + "@types/mdast": "^4.0.0", + "@types/unist": "^3.0.0", + "ccount": "^2.0.0", + "devlop": "^1.1.0", + "mdast-util-from-markdown": "^2.0.0", + "mdast-util-to-markdown": "^2.0.0", + "parse-entities": "^4.0.0", + "stringify-entities": "^4.0.0", + "unist-util-stringify-position": "^4.0.0", + "vfile-message": "^4.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/mdast-util-mdxjs-esm": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/mdast-util-mdxjs-esm/-/mdast-util-mdxjs-esm-2.0.1.tgz", + "integrity": "sha512-EcmOpxsZ96CvlP03NghtH1EsLtr0n9Tm4lPUJUBccV9RwUOneqSycg19n5HGzCf+10LozMRSObtVr3ee1WoHtg==", + "license": "MIT", + "dependencies": { + "@types/estree-jsx": "^1.0.0", + "@types/hast": "^3.0.0", + "@types/mdast": "^4.0.0", + "devlop": "^1.0.0", + "mdast-util-from-markdown": "^2.0.0", + "mdast-util-to-markdown": "^2.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/mdast-util-phrasing": { + "version": "4.1.0", + "resolved": "https://registry.npmjs.org/mdast-util-phrasing/-/mdast-util-phrasing-4.1.0.tgz", + "integrity": "sha512-TqICwyvJJpBwvGAMZjj4J2n0X8QWp21b9l0o7eXyVJ25YNWYbJDVIyD1bZXE6WtV6RmKJVYmQAKWa0zWOABz2w==", + "license": "MIT", + "dependencies": { + "@types/mdast": "^4.0.0", + "unist-util-is": "^6.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/mdast-util-to-hast": { + "version": "13.2.0", + "resolved": "https://registry.npmjs.org/mdast-util-to-hast/-/mdast-util-to-hast-13.2.0.tgz", + "integrity": "sha512-QGYKEuUsYT9ykKBCMOEDLsU5JRObWQusAolFMeko/tYPufNkRffBAQjIE+99jbA87xv6FgmjLtwjh9wBWajwAA==", + "license": "MIT", + "dependencies": { + "@types/hast": "^3.0.0", + "@types/mdast": "^4.0.0", + "@ungap/structured-clone": "^1.0.0", + "devlop": "^1.0.0", + "micromark-util-sanitize-uri": "^2.0.0", + "trim-lines": "^3.0.0", + "unist-util-position": "^5.0.0", + "unist-util-visit": "^5.0.0", + "vfile": "^6.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/mdast-util-to-markdown": { + "version": "2.1.2", + "resolved": "https://registry.npmjs.org/mdast-util-to-markdown/-/mdast-util-to-markdown-2.1.2.tgz", + "integrity": "sha512-xj68wMTvGXVOKonmog6LwyJKrYXZPvlwabaryTjLh9LuvovB/KAH+kvi8Gjj+7rJjsFi23nkUxRQv1KqSroMqA==", + "license": "MIT", + "dependencies": { + "@types/mdast": "^4.0.0", + "@types/unist": "^3.0.0", + "longest-streak": "^3.0.0", + "mdast-util-phrasing": "^4.0.0", + "mdast-util-to-string": "^4.0.0", + "micromark-util-classify-character": "^2.0.0", + "micromark-util-decode-string": "^2.0.0", + "unist-util-visit": "^5.0.0", + "zwitch": "^2.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/mdast-util-to-string": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/mdast-util-to-string/-/mdast-util-to-string-4.0.0.tgz", + "integrity": "sha512-0H44vDimn51F0YwvxSJSm0eCDOJTRlmN0R1yBh4HLj9wiV1Dn0QoXGbvFAWj2hSItVTlCmBF1hqKlIyUBVFLPg==", + "license": "MIT", + "dependencies": { + "@types/mdast": "^4.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/mdn-data": { + "version": "2.12.2", + "resolved": "https://registry.npmjs.org/mdn-data/-/mdn-data-2.12.2.tgz", + "integrity": "sha512-IEn+pegP1aManZuckezWCO+XZQDplx1366JoVhTpMpBB1sPey/SbveZQUosKiKiGYjg1wH4pMlNgXbCiYgihQA==", + "license": "CC0-1.0" + }, + "node_modules/merge2": { + "version": "1.4.1", + "resolved": "https://registry.npmjs.org/merge2/-/merge2-1.4.1.tgz", + "integrity": "sha512-8q7VEgMJW4J8tcfVPy8g09NcQwZdbwFEqhe/WZkoIzjn/3TGDwtOCYtXGxA3O8tPzpczCCDgv+P2P5y00ZJOOg==", + "license": "MIT", + "engines": { + "node": ">= 8" + } + }, + "node_modules/micromark": { + "version": "4.0.2", + "resolved": "https://registry.npmjs.org/micromark/-/micromark-4.0.2.tgz", + "integrity": "sha512-zpe98Q6kvavpCr1NPVSCMebCKfD7CA2NqZ+rykeNhONIJBpc1tFKt9hucLGwha3jNTNI8lHpctWJWoimVF4PfA==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT", + "dependencies": { + "@types/debug": "^4.0.0", + "debug": "^4.0.0", + "decode-named-character-reference": "^1.0.0", + "devlop": "^1.0.0", + "micromark-core-commonmark": "^2.0.0", + "micromark-factory-space": "^2.0.0", + "micromark-util-character": "^2.0.0", + "micromark-util-chunked": "^2.0.0", + "micromark-util-combine-extensions": "^2.0.0", + "micromark-util-decode-numeric-character-reference": "^2.0.0", + "micromark-util-encode": "^2.0.0", + "micromark-util-normalize-identifier": "^2.0.0", + "micromark-util-resolve-all": "^2.0.0", + "micromark-util-sanitize-uri": "^2.0.0", + "micromark-util-subtokenize": "^2.0.0", + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0" + } + }, + "node_modules/micromark-core-commonmark": { + "version": "2.0.3", + "resolved": "https://registry.npmjs.org/micromark-core-commonmark/-/micromark-core-commonmark-2.0.3.tgz", + "integrity": "sha512-RDBrHEMSxVFLg6xvnXmb1Ayr2WzLAWjeSATAoxwKYJV94TeNavgoIdA0a9ytzDSVzBy2YKFK+emCPOEibLeCrg==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT", + "dependencies": { + "decode-named-character-reference": "^1.0.0", + "devlop": "^1.0.0", + "micromark-factory-destination": "^2.0.0", + "micromark-factory-label": "^2.0.0", + "micromark-factory-space": "^2.0.0", + "micromark-factory-title": "^2.0.0", + "micromark-factory-whitespace": "^2.0.0", + "micromark-util-character": "^2.0.0", + "micromark-util-chunked": "^2.0.0", + "micromark-util-classify-character": "^2.0.0", + "micromark-util-html-tag-name": "^2.0.0", + "micromark-util-normalize-identifier": "^2.0.0", + "micromark-util-resolve-all": "^2.0.0", + "micromark-util-subtokenize": "^2.0.0", + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0" + } + }, + "node_modules/micromark-extension-directive": { + "version": "3.0.2", + "resolved": "https://registry.npmjs.org/micromark-extension-directive/-/micromark-extension-directive-3.0.2.tgz", + "integrity": "sha512-wjcXHgk+PPdmvR58Le9d7zQYWy+vKEU9Se44p2CrCDPiLr2FMyiT4Fyb5UFKFC66wGB3kPlgD7q3TnoqPS7SZA==", + "license": "MIT", + "dependencies": { + "devlop": "^1.0.0", + "micromark-factory-space": "^2.0.0", + "micromark-factory-whitespace": "^2.0.0", + "micromark-util-character": "^2.0.0", + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0", + "parse-entities": "^4.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/micromark-extension-gfm": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/micromark-extension-gfm/-/micromark-extension-gfm-3.0.0.tgz", + "integrity": "sha512-vsKArQsicm7t0z2GugkCKtZehqUm31oeGBV/KVSorWSy8ZlNAv7ytjFhvaryUiCUJYqs+NoE6AFhpQvBTM6Q4w==", + "license": "MIT", + "dependencies": { + "micromark-extension-gfm-autolink-literal": "^2.0.0", + "micromark-extension-gfm-footnote": "^2.0.0", + "micromark-extension-gfm-strikethrough": "^2.0.0", + "micromark-extension-gfm-table": "^2.0.0", + "micromark-extension-gfm-tagfilter": "^2.0.0", + "micromark-extension-gfm-task-list-item": "^2.0.0", + "micromark-util-combine-extensions": "^2.0.0", + "micromark-util-types": "^2.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/micromark-extension-gfm-autolink-literal": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/micromark-extension-gfm-autolink-literal/-/micromark-extension-gfm-autolink-literal-2.1.0.tgz", + "integrity": "sha512-oOg7knzhicgQ3t4QCjCWgTmfNhvQbDDnJeVu9v81r7NltNCVmhPy1fJRX27pISafdjL+SVc4d3l48Gb6pbRypw==", + "license": "MIT", + "dependencies": { + "micromark-util-character": "^2.0.0", + "micromark-util-sanitize-uri": "^2.0.0", + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/micromark-extension-gfm-footnote": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/micromark-extension-gfm-footnote/-/micromark-extension-gfm-footnote-2.1.0.tgz", + "integrity": "sha512-/yPhxI1ntnDNsiHtzLKYnE3vf9JZ6cAisqVDauhp4CEHxlb4uoOTxOCJ+9s51bIB8U1N1FJ1RXOKTIlD5B/gqw==", + "license": "MIT", + "dependencies": { + "devlop": "^1.0.0", + "micromark-core-commonmark": "^2.0.0", + "micromark-factory-space": "^2.0.0", + "micromark-util-character": "^2.0.0", + "micromark-util-normalize-identifier": "^2.0.0", + "micromark-util-sanitize-uri": "^2.0.0", + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/micromark-extension-gfm-strikethrough": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/micromark-extension-gfm-strikethrough/-/micromark-extension-gfm-strikethrough-2.1.0.tgz", + "integrity": "sha512-ADVjpOOkjz1hhkZLlBiYA9cR2Anf8F4HqZUO6e5eDcPQd0Txw5fxLzzxnEkSkfnD0wziSGiv7sYhk/ktvbf1uw==", + "license": "MIT", + "dependencies": { + "devlop": "^1.0.0", + "micromark-util-chunked": "^2.0.0", + "micromark-util-classify-character": "^2.0.0", + "micromark-util-resolve-all": "^2.0.0", + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/micromark-extension-gfm-table": { + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/micromark-extension-gfm-table/-/micromark-extension-gfm-table-2.1.1.tgz", + "integrity": "sha512-t2OU/dXXioARrC6yWfJ4hqB7rct14e8f7m0cbI5hUmDyyIlwv5vEtooptH8INkbLzOatzKuVbQmAYcbWoyz6Dg==", + "license": "MIT", + "dependencies": { + "devlop": "^1.0.0", + "micromark-factory-space": "^2.0.0", + "micromark-util-character": "^2.0.0", + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/micromark-extension-gfm-tagfilter": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/micromark-extension-gfm-tagfilter/-/micromark-extension-gfm-tagfilter-2.0.0.tgz", + "integrity": "sha512-xHlTOmuCSotIA8TW1mDIM6X2O1SiX5P9IuDtqGonFhEK0qgRI4yeC6vMxEV2dgyr2TiD+2PQ10o+cOhdVAcwfg==", + "license": "MIT", + "dependencies": { + "micromark-util-types": "^2.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/micromark-extension-gfm-task-list-item": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/micromark-extension-gfm-task-list-item/-/micromark-extension-gfm-task-list-item-2.1.0.tgz", + "integrity": "sha512-qIBZhqxqI6fjLDYFTBIa4eivDMnP+OZqsNwmQ3xNLE4Cxwc+zfQEfbs6tzAo2Hjq+bh6q5F+Z8/cksrLFYWQQw==", + "license": "MIT", + "dependencies": { + "devlop": "^1.0.0", + "micromark-factory-space": "^2.0.0", + "micromark-util-character": "^2.0.0", + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/micromark-extension-mdx-expression": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/micromark-extension-mdx-expression/-/micromark-extension-mdx-expression-3.0.1.tgz", + "integrity": "sha512-dD/ADLJ1AeMvSAKBwO22zG22N4ybhe7kFIZ3LsDI0GlsNr2A3KYxb0LdC1u5rj4Nw+CHKY0RVdnHX8vj8ejm4Q==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT", + "dependencies": { + "@types/estree": "^1.0.0", + "devlop": "^1.0.0", + "micromark-factory-mdx-expression": "^2.0.0", + "micromark-factory-space": "^2.0.0", + "micromark-util-character": "^2.0.0", + "micromark-util-events-to-acorn": "^2.0.0", + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0" + } + }, + "node_modules/micromark-extension-mdx-jsx": { + "version": "3.0.2", + "resolved": "https://registry.npmjs.org/micromark-extension-mdx-jsx/-/micromark-extension-mdx-jsx-3.0.2.tgz", + "integrity": "sha512-e5+q1DjMh62LZAJOnDraSSbDMvGJ8x3cbjygy2qFEi7HCeUT4BDKCvMozPozcD6WmOt6sVvYDNBKhFSz3kjOVQ==", + "license": "MIT", + "dependencies": { + "@types/estree": "^1.0.0", + "devlop": "^1.0.0", + "estree-util-is-identifier-name": "^3.0.0", + "micromark-factory-mdx-expression": "^2.0.0", + "micromark-factory-space": "^2.0.0", + "micromark-util-character": "^2.0.0", + "micromark-util-events-to-acorn": "^2.0.0", + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0", + "vfile-message": "^4.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/micromark-extension-mdx-md": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/micromark-extension-mdx-md/-/micromark-extension-mdx-md-2.0.0.tgz", + "integrity": "sha512-EpAiszsB3blw4Rpba7xTOUptcFeBFi+6PY8VnJ2hhimH+vCQDirWgsMpz7w1XcZE7LVrSAUGb9VJpG9ghlYvYQ==", + "license": "MIT", + "dependencies": { + "micromark-util-types": "^2.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/micromark-extension-mdxjs": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/micromark-extension-mdxjs/-/micromark-extension-mdxjs-3.0.0.tgz", + "integrity": "sha512-A873fJfhnJ2siZyUrJ31l34Uqwy4xIFmvPY1oj+Ean5PHcPBYzEsvqvWGaWcfEIr11O5Dlw3p2y0tZWpKHDejQ==", + "license": "MIT", + "dependencies": { + "acorn": "^8.0.0", + "acorn-jsx": "^5.0.0", + "micromark-extension-mdx-expression": "^3.0.0", + "micromark-extension-mdx-jsx": "^3.0.0", + "micromark-extension-mdx-md": "^2.0.0", + "micromark-extension-mdxjs-esm": "^3.0.0", + "micromark-util-combine-extensions": "^2.0.0", + "micromark-util-types": "^2.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/micromark-extension-mdxjs-esm": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/micromark-extension-mdxjs-esm/-/micromark-extension-mdxjs-esm-3.0.0.tgz", + "integrity": "sha512-DJFl4ZqkErRpq/dAPyeWp15tGrcrrJho1hKK5uBS70BCtfrIFg81sqcTVu3Ta+KD1Tk5vAtBNElWxtAa+m8K9A==", + "license": "MIT", + "dependencies": { + "@types/estree": "^1.0.0", + "devlop": "^1.0.0", + "micromark-core-commonmark": "^2.0.0", + "micromark-util-character": "^2.0.0", + "micromark-util-events-to-acorn": "^2.0.0", + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0", + "unist-util-position-from-estree": "^2.0.0", + "vfile-message": "^4.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/micromark-factory-destination": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/micromark-factory-destination/-/micromark-factory-destination-2.0.1.tgz", + "integrity": "sha512-Xe6rDdJlkmbFRExpTOmRj9N3MaWmbAgdpSrBQvCFqhezUn4AHqJHbaEnfbVYYiexVSs//tqOdY/DxhjdCiJnIA==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT", + "dependencies": { + "micromark-util-character": "^2.0.0", + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0" + } + }, + "node_modules/micromark-factory-label": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/micromark-factory-label/-/micromark-factory-label-2.0.1.tgz", + "integrity": "sha512-VFMekyQExqIW7xIChcXn4ok29YE3rnuyveW3wZQWWqF4Nv9Wk5rgJ99KzPvHjkmPXF93FXIbBp6YdW3t71/7Vg==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT", + "dependencies": { + "devlop": "^1.0.0", + "micromark-util-character": "^2.0.0", + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0" + } + }, + "node_modules/micromark-factory-mdx-expression": { + "version": "2.0.3", + "resolved": "https://registry.npmjs.org/micromark-factory-mdx-expression/-/micromark-factory-mdx-expression-2.0.3.tgz", + "integrity": "sha512-kQnEtA3vzucU2BkrIa8/VaSAsP+EJ3CKOvhMuJgOEGg9KDC6OAY6nSnNDVRiVNRqj7Y4SlSzcStaH/5jge8JdQ==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT", + "dependencies": { + "@types/estree": "^1.0.0", + "devlop": "^1.0.0", + "micromark-factory-space": "^2.0.0", + "micromark-util-character": "^2.0.0", + "micromark-util-events-to-acorn": "^2.0.0", + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0", + "unist-util-position-from-estree": "^2.0.0", + "vfile-message": "^4.0.0" + } + }, + "node_modules/micromark-factory-space": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/micromark-factory-space/-/micromark-factory-space-2.0.1.tgz", + "integrity": "sha512-zRkxjtBxxLd2Sc0d+fbnEunsTj46SWXgXciZmHq0kDYGnck/ZSGj9/wULTV95uoeYiK5hRXP2mJ98Uo4cq/LQg==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT", + "dependencies": { + "micromark-util-character": "^2.0.0", + "micromark-util-types": "^2.0.0" + } + }, + "node_modules/micromark-factory-title": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/micromark-factory-title/-/micromark-factory-title-2.0.1.tgz", + "integrity": "sha512-5bZ+3CjhAd9eChYTHsjy6TGxpOFSKgKKJPJxr293jTbfry2KDoWkhBb6TcPVB4NmzaPhMs1Frm9AZH7OD4Cjzw==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT", + "dependencies": { + "micromark-factory-space": "^2.0.0", + "micromark-util-character": "^2.0.0", + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0" + } + }, + "node_modules/micromark-factory-whitespace": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/micromark-factory-whitespace/-/micromark-factory-whitespace-2.0.1.tgz", + "integrity": "sha512-Ob0nuZ3PKt/n0hORHyvoD9uZhr+Za8sFoP+OnMcnWK5lngSzALgQYKMr9RJVOWLqQYuyn6ulqGWSXdwf6F80lQ==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT", + "dependencies": { + "micromark-factory-space": "^2.0.0", + "micromark-util-character": "^2.0.0", + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0" + } + }, + "node_modules/micromark-util-character": { + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/micromark-util-character/-/micromark-util-character-2.1.1.tgz", + "integrity": "sha512-wv8tdUTJ3thSFFFJKtpYKOYiGP2+v96Hvk4Tu8KpCAsTMs6yi+nVmGh1syvSCsaxz45J6Jbw+9DD6g97+NV67Q==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT", + "dependencies": { + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0" + } + }, + "node_modules/micromark-util-chunked": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/micromark-util-chunked/-/micromark-util-chunked-2.0.1.tgz", + "integrity": "sha512-QUNFEOPELfmvv+4xiNg2sRYeS/P84pTW0TCgP5zc9FpXetHY0ab7SxKyAQCNCc1eK0459uoLI1y5oO5Vc1dbhA==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT", + "dependencies": { + "micromark-util-symbol": "^2.0.0" + } + }, + "node_modules/micromark-util-classify-character": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/micromark-util-classify-character/-/micromark-util-classify-character-2.0.1.tgz", + "integrity": "sha512-K0kHzM6afW/MbeWYWLjoHQv1sgg2Q9EccHEDzSkxiP/EaagNzCm7T/WMKZ3rjMbvIpvBiZgwR3dKMygtA4mG1Q==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT", + "dependencies": { + "micromark-util-character": "^2.0.0", + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0" + } + }, + "node_modules/micromark-util-combine-extensions": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/micromark-util-combine-extensions/-/micromark-util-combine-extensions-2.0.1.tgz", + "integrity": "sha512-OnAnH8Ujmy59JcyZw8JSbK9cGpdVY44NKgSM7E9Eh7DiLS2E9RNQf0dONaGDzEG9yjEl5hcqeIsj4hfRkLH/Bg==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT", + "dependencies": { + "micromark-util-chunked": "^2.0.0", + "micromark-util-types": "^2.0.0" + } + }, + "node_modules/micromark-util-decode-numeric-character-reference": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/micromark-util-decode-numeric-character-reference/-/micromark-util-decode-numeric-character-reference-2.0.2.tgz", + "integrity": "sha512-ccUbYk6CwVdkmCQMyr64dXz42EfHGkPQlBj5p7YVGzq8I7CtjXZJrubAYezf7Rp+bjPseiROqe7G6foFd+lEuw==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT", + "dependencies": { + "micromark-util-symbol": "^2.0.0" + } + }, + "node_modules/micromark-util-decode-string": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/micromark-util-decode-string/-/micromark-util-decode-string-2.0.1.tgz", + "integrity": "sha512-nDV/77Fj6eH1ynwscYTOsbK7rR//Uj0bZXBwJZRfaLEJ1iGBR6kIfNmlNqaqJf649EP0F3NWNdeJi03elllNUQ==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT", + "dependencies": { + "decode-named-character-reference": "^1.0.0", + "micromark-util-character": "^2.0.0", + "micromark-util-decode-numeric-character-reference": "^2.0.0", + "micromark-util-symbol": "^2.0.0" + } + }, + "node_modules/micromark-util-encode": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/micromark-util-encode/-/micromark-util-encode-2.0.1.tgz", + "integrity": "sha512-c3cVx2y4KqUnwopcO9b/SCdo2O67LwJJ/UyqGfbigahfegL9myoEFoDYZgkT7f36T0bLrM9hZTAaAyH+PCAXjw==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT" + }, + "node_modules/micromark-util-events-to-acorn": { + "version": "2.0.3", + "resolved": "https://registry.npmjs.org/micromark-util-events-to-acorn/-/micromark-util-events-to-acorn-2.0.3.tgz", + "integrity": "sha512-jmsiEIiZ1n7X1Rr5k8wVExBQCg5jy4UXVADItHmNk1zkwEVhBuIUKRu3fqv+hs4nxLISi2DQGlqIOGiFxgbfHg==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT", + "dependencies": { + "@types/estree": "^1.0.0", + "@types/unist": "^3.0.0", + "devlop": "^1.0.0", + "estree-util-visit": "^2.0.0", + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0", + "vfile-message": "^4.0.0" + } + }, + "node_modules/micromark-util-html-tag-name": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/micromark-util-html-tag-name/-/micromark-util-html-tag-name-2.0.1.tgz", + "integrity": "sha512-2cNEiYDhCWKI+Gs9T0Tiysk136SnR13hhO8yW6BGNyhOC4qYFnwF1nKfD3HFAIXA5c45RrIG1ub11GiXeYd1xA==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT" + }, + "node_modules/micromark-util-normalize-identifier": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/micromark-util-normalize-identifier/-/micromark-util-normalize-identifier-2.0.1.tgz", + "integrity": "sha512-sxPqmo70LyARJs0w2UclACPUUEqltCkJ6PhKdMIDuJ3gSf/Q+/GIe3WKl0Ijb/GyH9lOpUkRAO2wp0GVkLvS9Q==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT", + "dependencies": { + "micromark-util-symbol": "^2.0.0" + } + }, + "node_modules/micromark-util-resolve-all": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/micromark-util-resolve-all/-/micromark-util-resolve-all-2.0.1.tgz", + "integrity": "sha512-VdQyxFWFT2/FGJgwQnJYbe1jjQoNTS4RjglmSjTUlpUMa95Htx9NHeYW4rGDJzbjvCsl9eLjMQwGeElsqmzcHg==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT", + "dependencies": { + "micromark-util-types": "^2.0.0" + } + }, + "node_modules/micromark-util-sanitize-uri": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/micromark-util-sanitize-uri/-/micromark-util-sanitize-uri-2.0.1.tgz", + "integrity": "sha512-9N9IomZ/YuGGZZmQec1MbgxtlgougxTodVwDzzEouPKo3qFWvymFHWcnDi2vzV1ff6kas9ucW+o3yzJK9YB1AQ==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT", + "dependencies": { + "micromark-util-character": "^2.0.0", + "micromark-util-encode": "^2.0.0", + "micromark-util-symbol": "^2.0.0" + } + }, + "node_modules/micromark-util-subtokenize": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/micromark-util-subtokenize/-/micromark-util-subtokenize-2.1.0.tgz", + "integrity": "sha512-XQLu552iSctvnEcgXw6+Sx75GflAPNED1qx7eBJ+wydBb2KCbRZe+NwvIEEMM83uml1+2WSXpBAcp9IUCgCYWA==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT", + "dependencies": { + "devlop": "^1.0.0", + "micromark-util-chunked": "^2.0.0", + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0" + } + }, + "node_modules/micromark-util-symbol": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/micromark-util-symbol/-/micromark-util-symbol-2.0.1.tgz", + "integrity": "sha512-vs5t8Apaud9N28kgCrRUdEed4UJ+wWNvicHLPxCa9ENlYuAY31M0ETy5y1vA33YoNPDFTghEbnh6efaE8h4x0Q==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT" + }, + "node_modules/micromark-util-types": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/micromark-util-types/-/micromark-util-types-2.0.2.tgz", + "integrity": "sha512-Yw0ECSpJoViF1qTU4DC6NwtC4aWGt1EkzaQB8KPPyCRR8z9TWeV0HbEFGTO+ZY1wB22zmxnJqhPyTpOVCpeHTA==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT" + }, + "node_modules/micromatch": { + "version": "4.0.8", + "resolved": "https://registry.npmjs.org/micromatch/-/micromatch-4.0.8.tgz", + "integrity": "sha512-PXwfBhYu0hBCPw8Dn0E+WDYb7af3dSLVWKi3HGv84IdF4TyFoC0ysxFd0Goxw7nSv4T/PzEJQxsYsEiFCKo2BA==", + "license": "MIT", + "dependencies": { + "braces": "^3.0.3", + "picomatch": "^2.3.1" + }, + "engines": { + "node": ">=8.6" + } + }, + "node_modules/micromatch/node_modules/picomatch": { + "version": "2.3.1", + "resolved": "https://registry.npmjs.org/picomatch/-/picomatch-2.3.1.tgz", + "integrity": "sha512-JU3teHTNjmE2VCGFzuY8EXzCDVwEqB2a8fsIvwaStHhAWJEeVd1o1QD80CU6+ZdEXXSLbSsuLwJjkCBWqRQUVA==", + "license": "MIT", + "engines": { + "node": ">=8.6" + }, + "funding": { + "url": "https://github.com/sponsors/jonschlinkert" + } + }, + "node_modules/motion": { + "version": "11.18.2", + "resolved": "https://registry.npmjs.org/motion/-/motion-11.18.2.tgz", + "integrity": "sha512-JLjvFDuFr42NFtcVoMAyC2sEjnpA8xpy6qWPyzQvCloznAyQ8FIXioxWfHiLtgYhoVpfUqSWpn1h9++skj9+Wg==", + "license": "MIT", + "dependencies": { + "framer-motion": "^11.18.2", + "tslib": "^2.4.0" + }, + "peerDependencies": { + "@emotion/is-prop-valid": "*", + "react": "^18.0.0 || ^19.0.0", + "react-dom": "^18.0.0 || ^19.0.0" + }, + "peerDependenciesMeta": { + "@emotion/is-prop-valid": { + "optional": true + }, + "react": { + "optional": true + }, + "react-dom": { + "optional": true + } + } + }, + "node_modules/motion-dom": { + "version": "11.18.1", + "resolved": "https://registry.npmjs.org/motion-dom/-/motion-dom-11.18.1.tgz", + "integrity": "sha512-g76KvA001z+atjfxczdRtw/RXOM3OMSdd1f4DL77qCTF/+avrRJiawSG4yDibEQ215sr9kpinSlX2pCTJ9zbhw==", + "license": "MIT", + "dependencies": { + "motion-utils": "^11.18.1" + } + }, + "node_modules/motion-utils": { + "version": "11.18.1", + "resolved": "https://registry.npmjs.org/motion-utils/-/motion-utils-11.18.1.tgz", + "integrity": "sha512-49Kt+HKjtbJKLtgO/LKj9Ld+6vw9BjH5d9sc40R/kVyH8GLAXgT42M2NnuPcJNuA3s9ZfZBUcwIgpmZWGEE+hA==", + "license": "MIT" + }, + "node_modules/mrmime": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/mrmime/-/mrmime-2.0.1.tgz", + "integrity": "sha512-Y3wQdFg2Va6etvQ5I82yUhGdsKrcYox6p7FfL1LbK2J4V01F9TGlepTIhnK24t7koZibmg82KGglhA1XK5IsLQ==", + "license": "MIT", + "engines": { + "node": ">=10" + } + }, + "node_modules/ms": { + "version": "2.1.3", + "resolved": "https://registry.npmjs.org/ms/-/ms-2.1.3.tgz", + "integrity": "sha512-6FlzubTLZG3J2a/NVCAleEhjzq5oxgHyaCU9yYXvcLsvoVaHJq/s5xXI6/XXP6tz7R9xAOtHnSO/tXtF3WRTlA==", + "license": "MIT" + }, + "node_modules/muggle-string": { + "version": "0.4.1", + "resolved": "https://registry.npmjs.org/muggle-string/-/muggle-string-0.4.1.tgz", + "integrity": "sha512-VNTrAak/KhO2i8dqqnqnAHOa3cYBwXEZe9h+D5h/1ZqFSTEFHdM65lR7RoIqq3tBBYavsOXV84NoHXZ0AkPyqQ==", + "license": "MIT" + }, + "node_modules/nanoid": { + "version": "3.3.11", + "resolved": "https://registry.npmjs.org/nanoid/-/nanoid-3.3.11.tgz", + "integrity": "sha512-N8SpfPUnUp1bK+PMYW8qSWdl9U+wwNWI4QKxOYDy9JAro3WMX7p2OeVRF9v+347pnakNevPmiHhNmZ2HbFA76w==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/ai" + } + ], + "license": "MIT", + "bin": { + "nanoid": "bin/nanoid.cjs" + }, + "engines": { + "node": "^10 || ^12 || ^13.7 || ^14 || >=15.0.1" + } + }, + "node_modules/neotraverse": { + "version": "0.6.18", + "resolved": "https://registry.npmjs.org/neotraverse/-/neotraverse-0.6.18.tgz", + "integrity": "sha512-Z4SmBUweYa09+o6pG+eASabEpP6QkQ70yHj351pQoEXIs8uHbaU2DWVmzBANKgflPa47A50PtB2+NgRpQvr7vA==", + "license": "MIT", + "engines": { + "node": ">= 10" + } + }, + "node_modules/nlcst-to-string": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/nlcst-to-string/-/nlcst-to-string-4.0.0.tgz", + "integrity": "sha512-YKLBCcUYKAg0FNlOBT6aI91qFmSiFKiluk655WzPF+DDMA02qIyy8uiRqI8QXtcFpEvll12LpL5MXqEmAZ+dcA==", + "license": "MIT", + "dependencies": { + "@types/nlcst": "^2.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/node-fetch-native": { + "version": "1.6.7", + "resolved": "https://registry.npmjs.org/node-fetch-native/-/node-fetch-native-1.6.7.tgz", + "integrity": "sha512-g9yhqoedzIUm0nTnTqAQvueMPVOuIY16bqgAJJC8XOOubYFNwz6IER9qs0Gq2Xd0+CecCKFjtdDTMA4u4xG06Q==", + "license": "MIT" + }, + "node_modules/node-mock-http": { + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/node-mock-http/-/node-mock-http-1.0.3.tgz", + "integrity": "sha512-jN8dK25fsfnMrVsEhluUTPkBFY+6ybu7jSB1n+ri/vOGjJxU8J9CZhpSGkHXSkFjtUhbmoncG/YG9ta5Ludqog==", + "license": "MIT" + }, + "node_modules/node-releases": { + "version": "2.0.27", + "resolved": "https://registry.npmjs.org/node-releases/-/node-releases-2.0.27.tgz", + "integrity": "sha512-nmh3lCkYZ3grZvqcCH+fjmQ7X+H0OeZgP40OierEaAptX4XofMh5kwNbWh7lBduUzCcV/8kZ+NDLCwm2iorIlA==", + "license": "MIT" + }, + "node_modules/normalize-path": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/normalize-path/-/normalize-path-3.0.0.tgz", + "integrity": "sha512-6eZs5Ls3WtCisHWp9S2GUy8dqkpGi4BVSz3GaqiE6ezub0512ESztXUwUB6C6IKbQkY2Pnb/mD4WYojCRwcwLA==", + "license": "MIT", + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/nth-check": { + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/nth-check/-/nth-check-2.1.1.tgz", + "integrity": "sha512-lqjrjmaOoAnWfMmBPL+XNnynZh2+swxiX3WUE0s4yEHI6m+AwrK2UZOimIRl3X/4QctVqS8AiZjFqyOGrMXb/w==", + "license": "BSD-2-Clause", + "dependencies": { + "boolbase": "^1.0.0" + }, + "funding": { + "url": "https://github.com/fb55/nth-check?sponsor=1" + } + }, + "node_modules/ofetch": { + "version": "1.5.1", + "resolved": "https://registry.npmjs.org/ofetch/-/ofetch-1.5.1.tgz", + "integrity": "sha512-2W4oUZlVaqAPAil6FUg/difl6YhqhUR7x2eZY4bQCko22UXg3hptq9KLQdqFClV+Wu85UX7hNtdGTngi/1BxcA==", + "license": "MIT", + "dependencies": { + "destr": "^2.0.5", + "node-fetch-native": "^1.6.7", + "ufo": "^1.6.1" + } + }, + "node_modules/ohash": { + "version": "2.0.11", + "resolved": "https://registry.npmjs.org/ohash/-/ohash-2.0.11.tgz", + "integrity": "sha512-RdR9FQrFwNBNXAr4GixM8YaRZRJ5PUWbKYbE5eOsrwAjJW0q2REGcf79oYPsLyskQCZG1PLN+S/K1V00joZAoQ==", + "license": "MIT" + }, + "node_modules/oniguruma-parser": { + "version": "0.12.1", + "resolved": "https://registry.npmjs.org/oniguruma-parser/-/oniguruma-parser-0.12.1.tgz", + "integrity": "sha512-8Unqkvk1RYc6yq2WBYRj4hdnsAxVze8i7iPfQr8e4uSP3tRv0rpZcbGUDvxfQQcdwHt/e9PrMvGCsa8OqG9X3w==", + "license": "MIT" + }, + "node_modules/oniguruma-to-es": { + "version": "4.3.4", + "resolved": "https://registry.npmjs.org/oniguruma-to-es/-/oniguruma-to-es-4.3.4.tgz", + "integrity": "sha512-3VhUGN3w2eYxnTzHn+ikMI+fp/96KoRSVK9/kMTcFqj1NRDh2IhQCKvYxDnWePKRXY/AqH+Fuiyb7VHSzBjHfA==", + "license": "MIT", + "dependencies": { + "oniguruma-parser": "^0.12.1", + "regex": "^6.0.1", + "regex-recursion": "^6.0.2" + } + }, + "node_modules/p-limit": { + "version": "6.2.0", + "resolved": "https://registry.npmjs.org/p-limit/-/p-limit-6.2.0.tgz", + "integrity": "sha512-kuUqqHNUqoIWp/c467RI4X6mmyuojY5jGutNU0wVTmEOOfcuwLqyMVoAi9MKi2Ak+5i9+nhmrK4ufZE8069kHA==", + "license": "MIT", + "dependencies": { + "yocto-queue": "^1.1.1" + }, + "engines": { + "node": ">=18" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/p-queue": { + "version": "8.1.1", + "resolved": "https://registry.npmjs.org/p-queue/-/p-queue-8.1.1.tgz", + "integrity": "sha512-aNZ+VfjobsWryoiPnEApGGmf5WmNsCo9xu8dfaYamG5qaLP7ClhLN6NgsFe6SwJ2UbLEBK5dv9x8Mn5+RVhMWQ==", + "license": "MIT", + "dependencies": { + "eventemitter3": "^5.0.1", + "p-timeout": "^6.1.2" + }, + "engines": { + "node": ">=18" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/p-timeout": { + "version": "6.1.4", + "resolved": "https://registry.npmjs.org/p-timeout/-/p-timeout-6.1.4.tgz", + "integrity": "sha512-MyIV3ZA/PmyBN/ud8vV9XzwTrNtR4jFrObymZYnZqMmW0zA8Z17vnT0rBgFE/TlohB+YCHqXMgZzb3Csp49vqg==", + "license": "MIT", + "engines": { + "node": ">=14.16" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/package-manager-detector": { + "version": "1.5.0", + "resolved": "https://registry.npmjs.org/package-manager-detector/-/package-manager-detector-1.5.0.tgz", + "integrity": "sha512-uBj69dVlYe/+wxj8JOpr97XfsxH/eumMt6HqjNTmJDf/6NO9s+0uxeOneIz3AsPt2m6y9PqzDzd3ATcU17MNfw==", + "license": "MIT" + }, + "node_modules/pagefind": { + "version": "1.4.0", + "resolved": "https://registry.npmjs.org/pagefind/-/pagefind-1.4.0.tgz", + "integrity": "sha512-z2kY1mQlL4J8q5EIsQkLzQjilovKzfNVhX8De6oyE6uHpfFtyBaqUpcl/XzJC/4fjD8vBDyh1zolimIcVrCn9g==", + "license": "MIT", + "bin": { + "pagefind": "lib/runner/bin.cjs" + }, + "optionalDependencies": { + "@pagefind/darwin-arm64": "1.4.0", + "@pagefind/darwin-x64": "1.4.0", + "@pagefind/freebsd-x64": "1.4.0", + "@pagefind/linux-arm64": "1.4.0", + "@pagefind/linux-x64": "1.4.0", + "@pagefind/windows-x64": "1.4.0" + } + }, + "node_modules/pako": { + "version": "0.2.9", + "resolved": "https://registry.npmjs.org/pako/-/pako-0.2.9.tgz", + "integrity": "sha512-NUcwaKxUxWrZLpDG+z/xZaCgQITkA/Dv4V/T6bw7VON6l1Xz/VnrBqrYjZQ12TamKHzITTfOEIYUj48y2KXImA==", + "license": "MIT" + }, + "node_modules/parse-entities": { + "version": "4.0.2", + "resolved": "https://registry.npmjs.org/parse-entities/-/parse-entities-4.0.2.tgz", + "integrity": "sha512-GG2AQYWoLgL877gQIKeRPGO1xF9+eG1ujIb5soS5gPvLQ1y2o8FL90w2QWNdf9I361Mpp7726c+lj3U0qK1uGw==", + "license": "MIT", + "dependencies": { + "@types/unist": "^2.0.0", + "character-entities-legacy": "^3.0.0", + "character-reference-invalid": "^2.0.0", + "decode-named-character-reference": "^1.0.0", + "is-alphanumerical": "^2.0.0", + "is-decimal": "^2.0.0", + "is-hexadecimal": "^2.0.0" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, + "node_modules/parse-entities/node_modules/@types/unist": { + "version": "2.0.11", + "resolved": "https://registry.npmjs.org/@types/unist/-/unist-2.0.11.tgz", + "integrity": "sha512-CmBKiL6NNo/OqgmMn95Fk9Whlp2mtvIv+KNpQKN2F4SjvrEesubTRWGYSg+BnWZOnlCaSTU1sMpsBOzgbYhnsA==", + "license": "MIT" + }, + "node_modules/parse-latin": { + "version": "7.0.0", + "resolved": "https://registry.npmjs.org/parse-latin/-/parse-latin-7.0.0.tgz", + "integrity": "sha512-mhHgobPPua5kZ98EF4HWiH167JWBfl4pvAIXXdbaVohtK7a6YBOy56kvhCqduqyo/f3yrHFWmqmiMg/BkBkYYQ==", + "license": "MIT", + "dependencies": { + "@types/nlcst": "^2.0.0", + "@types/unist": "^3.0.0", + "nlcst-to-string": "^4.0.0", + "unist-util-modify-children": "^4.0.0", + "unist-util-visit-children": "^3.0.0", + "vfile": "^6.0.0" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, + "node_modules/parse5": { + "version": "7.3.0", + "resolved": "https://registry.npmjs.org/parse5/-/parse5-7.3.0.tgz", + "integrity": "sha512-IInvU7fabl34qmi9gY8XOVxhYyMyuH2xUNpb2q8/Y+7552KlejkRvqvD19nMoUW/uQGGbqNpA6Tufu5FL5BZgw==", + "license": "MIT", + "dependencies": { + "entities": "^6.0.0" + }, + "funding": { + "url": "https://github.com/inikulin/parse5?sponsor=1" + } + }, + "node_modules/path-browserify": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/path-browserify/-/path-browserify-1.0.1.tgz", + "integrity": "sha512-b7uo2UCUOYZcnF/3ID0lulOJi/bafxa1xPe7ZPsammBSpjSWQkjNxlt635YGS2MiR9GjvuXCtz2emr3jbsz98g==", + "license": "MIT" + }, + "node_modules/piccolore": { + "version": "0.1.3", + "resolved": "https://registry.npmjs.org/piccolore/-/piccolore-0.1.3.tgz", + "integrity": "sha512-o8bTeDWjE086iwKrROaDf31K0qC/BENdm15/uH9usSC/uZjJOKb2YGiVHfLY4GhwsERiPI1jmwI2XrA7ACOxVw==", + "license": "ISC" + }, + "node_modules/picocolors": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/picocolors/-/picocolors-1.1.1.tgz", + "integrity": "sha512-xceH2snhtb5M9liqDsmEw56le376mTZkEX/jEb/RxNFyegNul7eNslCXP9FDj/Lcu0X8KEyMceP2ntpaHrDEVA==", + "license": "ISC" + }, + "node_modules/picomatch": { + "version": "4.0.3", + "resolved": "https://registry.npmjs.org/picomatch/-/picomatch-4.0.3.tgz", + "integrity": "sha512-5gTmgEY/sqK6gFXLIsQNH19lWb4ebPDLA4SdLP7dsWkIXHWlG66oPuVvXSGFPppYZz8ZDZq0dYYrbHfBCVUb1Q==", + "license": "MIT", + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/sponsors/jonschlinkert" + } + }, + "node_modules/postcss": { + "version": "8.5.6", + "resolved": "https://registry.npmjs.org/postcss/-/postcss-8.5.6.tgz", + "integrity": "sha512-3Ybi1tAuwAP9s0r1UQ2J4n5Y0G05bJkpUIO0/bI9MhwmD70S5aTWbXGBwxHrelT+XM1k6dM0pk+SwNkpTRN7Pg==", + "funding": [ + { + "type": "opencollective", + "url": "https://opencollective.com/postcss/" + }, + { + "type": "tidelift", + "url": "https://tidelift.com/funding/github/npm/postcss" + }, + { + "type": "github", + "url": "https://github.com/sponsors/ai" + } + ], + "license": "MIT", + "peer": true, + "dependencies": { + "nanoid": "^3.3.11", + "picocolors": "^1.1.1", + "source-map-js": "^1.2.1" + }, + "engines": { + "node": "^10 || ^12 || >=14" + } + }, + "node_modules/postcss-nested": { + "version": "6.2.0", + "resolved": "https://registry.npmjs.org/postcss-nested/-/postcss-nested-6.2.0.tgz", + "integrity": "sha512-HQbt28KulC5AJzG+cZtj9kvKB93CFCdLvog1WFLf1D+xmMvPGlBstkpTEZfK5+AN9hfJocyBFCNiqyS48bpgzQ==", + "funding": [ + { + "type": "opencollective", + "url": "https://opencollective.com/postcss/" + }, + { + "type": "github", + "url": "https://github.com/sponsors/ai" + } + ], + "license": "MIT", + "dependencies": { + "postcss-selector-parser": "^6.1.1" + }, + "engines": { + "node": ">=12.0" + }, + "peerDependencies": { + "postcss": "^8.2.14" + } + }, + "node_modules/postcss-selector-parser": { + "version": "6.1.2", + "resolved": "https://registry.npmjs.org/postcss-selector-parser/-/postcss-selector-parser-6.1.2.tgz", + "integrity": "sha512-Q8qQfPiZ+THO/3ZrOrO0cJJKfpYCagtMUkXbnEfmgUjwXg6z/WBeOyS9APBBPCTSiDV+s4SwQGu8yFsiMRIudg==", + "license": "MIT", + "dependencies": { + "cssesc": "^3.0.0", + "util-deprecate": "^1.0.2" + }, + "engines": { + "node": ">=4" + } + }, + "node_modules/prettier": { + "version": "3.6.2", + "resolved": "https://registry.npmjs.org/prettier/-/prettier-3.6.2.tgz", + "integrity": "sha512-I7AIg5boAr5R0FFtJ6rCfD+LFsWHp81dolrFD8S79U9tb8Az2nGrJncnMSnys+bpQJfRUzqs9hnA81OAA3hCuQ==", + "license": "MIT", + "peer": true, + "bin": { + "prettier": "bin/prettier.cjs" + }, + "engines": { + "node": ">=14" + }, + "funding": { + "url": "https://github.com/prettier/prettier?sponsor=1" + } + }, + "node_modules/prismjs": { + "version": "1.30.0", + "resolved": "https://registry.npmjs.org/prismjs/-/prismjs-1.30.0.tgz", + "integrity": "sha512-DEvV2ZF2r2/63V+tK8hQvrR2ZGn10srHbXviTlcv7Kpzw8jWiNTqbVgjO3IY8RxrrOUF8VPMQQFysYYYv0YZxw==", + "license": "MIT", + "engines": { + "node": ">=6" + } + }, + "node_modules/prompts": { + "version": "2.4.2", + "resolved": "https://registry.npmjs.org/prompts/-/prompts-2.4.2.tgz", + "integrity": "sha512-NxNv/kLguCA7p3jE8oL2aEBsrJWgAakBpgmgK6lpPWV+WuOmY6r2/zbAVnP+T8bQlA0nzHXSJSJW0Hq7ylaD2Q==", + "license": "MIT", + "dependencies": { + "kleur": "^3.0.3", + "sisteransi": "^1.0.5" + }, + "engines": { + "node": ">= 6" + } + }, + "node_modules/prompts/node_modules/kleur": { + "version": "3.0.3", + "resolved": "https://registry.npmjs.org/kleur/-/kleur-3.0.3.tgz", + "integrity": "sha512-eTIzlVOSUR+JxdDFepEYcBMtZ9Qqdef+rnzWdRZuMbOywu5tO2w2N7rqjoANZ5k9vywhL6Br1VRjUIgTQx4E8w==", + "license": "MIT", + "engines": { + "node": ">=6" + } + }, + "node_modules/property-information": { + "version": "7.1.0", + "resolved": "https://registry.npmjs.org/property-information/-/property-information-7.1.0.tgz", + "integrity": "sha512-TwEZ+X+yCJmYfL7TPUOcvBZ4QfoT5YenQiJuX//0th53DE6w0xxLEtfK3iyryQFddXuvkIk51EEgrJQ0WJkOmQ==", + "license": "MIT", + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, + "node_modules/queue-microtask": { + "version": "1.2.3", + "resolved": "https://registry.npmjs.org/queue-microtask/-/queue-microtask-1.2.3.tgz", + "integrity": "sha512-NuaNSa6flKT5JaSYQzJok04JzTL1CA6aGhv5rfLW3PgqA+M2ChpZQnAC8h8i4ZFkBS8X5RqkDBHA7r4hej3K9A==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/feross" + }, + { + "type": "patreon", + "url": "https://www.patreon.com/feross" + }, + { + "type": "consulting", + "url": "https://feross.org/support" + } + ], + "license": "MIT" + }, + "node_modules/radix3": { + "version": "1.1.2", + "resolved": "https://registry.npmjs.org/radix3/-/radix3-1.1.2.tgz", + "integrity": "sha512-b484I/7b8rDEdSDKckSSBA8knMpcdsXudlE/LNL639wFoHKwLbEkQFZHWEYwDC0wa0FKUcCY+GAF73Z7wxNVFA==", + "license": "MIT" + }, + "node_modules/react": { + "version": "19.2.0", + "resolved": "https://registry.npmjs.org/react/-/react-19.2.0.tgz", + "integrity": "sha512-tmbWg6W31tQLeB5cdIBOicJDJRR2KzXsV7uSK9iNfLWQ5bIZfxuPEHp7M8wiHyHnn0DD1i7w3Zmin0FtkrwoCQ==", + "license": "MIT", + "peer": true, + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/react-dom": { + "version": "19.2.0", + "resolved": "https://registry.npmjs.org/react-dom/-/react-dom-19.2.0.tgz", + "integrity": "sha512-UlbRu4cAiGaIewkPyiRGJk0imDN2T3JjieT6spoL2UeSf5od4n5LB/mQ4ejmxhCFT1tYe8IvaFulzynWovsEFQ==", + "license": "MIT", + "peer": true, + "dependencies": { + "scheduler": "^0.27.0" + }, + "peerDependencies": { + "react": "^19.2.0" + } + }, + "node_modules/react-refresh": { + "version": "0.17.0", + "resolved": "https://registry.npmjs.org/react-refresh/-/react-refresh-0.17.0.tgz", + "integrity": "sha512-z6F7K9bV85EfseRCp2bzrpyQ0Gkw1uLoCel9XBVWPg/TjRj94SkJzUTGfOa4bs7iJvBWtQG0Wq7wnI0syw3EBQ==", + "license": "MIT", + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/readdirp": { + "version": "4.1.2", + "resolved": "https://registry.npmjs.org/readdirp/-/readdirp-4.1.2.tgz", + "integrity": "sha512-GDhwkLfywWL2s6vEjyhri+eXmfH6j1L7JE27WhqLeYzoh/A3DBaYGEj2H/HFZCn/kMfim73FXxEJTw06WtxQwg==", + "license": "MIT", + "engines": { + "node": ">= 14.18.0" + }, + "funding": { + "type": "individual", + "url": "https://paulmillr.com/funding/" + } + }, + "node_modules/recma-build-jsx": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/recma-build-jsx/-/recma-build-jsx-1.0.0.tgz", + "integrity": "sha512-8GtdyqaBcDfva+GUKDr3nev3VpKAhup1+RvkMvUxURHpW7QyIvk9F5wz7Vzo06CEMSilw6uArgRqhpiUcWp8ew==", + "license": "MIT", + "dependencies": { + "@types/estree": "^1.0.0", + "estree-util-build-jsx": "^3.0.0", + "vfile": "^6.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/recma-jsx": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/recma-jsx/-/recma-jsx-1.0.1.tgz", + "integrity": "sha512-huSIy7VU2Z5OLv6oFLosQGGDqPqdO1iq6bWNAdhzMxSJP7RAso4fCZ1cKu8j9YHCZf3TPrq4dw3okhrylgcd7w==", + "license": "MIT", + "dependencies": { + "acorn-jsx": "^5.0.0", + "estree-util-to-js": "^2.0.0", + "recma-parse": "^1.0.0", + "recma-stringify": "^1.0.0", + "unified": "^11.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + }, + "peerDependencies": { + "acorn": "^6.0.0 || ^7.0.0 || ^8.0.0" + } + }, + "node_modules/recma-parse": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/recma-parse/-/recma-parse-1.0.0.tgz", + "integrity": "sha512-OYLsIGBB5Y5wjnSnQW6t3Xg7q3fQ7FWbw/vcXtORTnyaSFscOtABg+7Pnz6YZ6c27fG1/aN8CjfwoUEUIdwqWQ==", + "license": "MIT", + "dependencies": { + "@types/estree": "^1.0.0", + "esast-util-from-js": "^2.0.0", + "unified": "^11.0.0", + "vfile": "^6.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/recma-stringify": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/recma-stringify/-/recma-stringify-1.0.0.tgz", + "integrity": "sha512-cjwII1MdIIVloKvC9ErQ+OgAtwHBmcZ0Bg4ciz78FtbT8In39aAYbaA7zvxQ61xVMSPE8WxhLwLbhif4Js2C+g==", + "license": "MIT", + "dependencies": { + "@types/estree": "^1.0.0", + "estree-util-to-js": "^2.0.0", + "unified": "^11.0.0", + "vfile": "^6.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/regex": { + "version": "6.0.1", + "resolved": "https://registry.npmjs.org/regex/-/regex-6.0.1.tgz", + "integrity": "sha512-uorlqlzAKjKQZ5P+kTJr3eeJGSVroLKoHmquUj4zHWuR+hEyNqlXsSKlYYF5F4NI6nl7tWCs0apKJ0lmfsXAPA==", + "license": "MIT", + "dependencies": { + "regex-utilities": "^2.3.0" + } + }, + "node_modules/regex-recursion": { + "version": "6.0.2", + "resolved": "https://registry.npmjs.org/regex-recursion/-/regex-recursion-6.0.2.tgz", + "integrity": "sha512-0YCaSCq2VRIebiaUviZNs0cBz1kg5kVS2UKUfNIx8YVs1cN3AV7NTctO5FOKBA+UT2BPJIWZauYHPqJODG50cg==", + "license": "MIT", + "dependencies": { + "regex-utilities": "^2.3.0" + } + }, + "node_modules/regex-utilities": { + "version": "2.3.0", + "resolved": "https://registry.npmjs.org/regex-utilities/-/regex-utilities-2.3.0.tgz", + "integrity": "sha512-8VhliFJAWRaUiVvREIiW2NXXTmHs4vMNnSzuJVhscgmGav3g9VDxLrQndI3dZZVVdp0ZO/5v0xmX516/7M9cng==", + "license": "MIT" + }, + "node_modules/rehype": { + "version": "13.0.2", + "resolved": "https://registry.npmjs.org/rehype/-/rehype-13.0.2.tgz", + "integrity": "sha512-j31mdaRFrwFRUIlxGeuPXXKWQxet52RBQRvCmzl5eCefn/KGbomK5GMHNMsOJf55fgo3qw5tST5neDuarDYR2A==", + "license": "MIT", + "dependencies": { + "@types/hast": "^3.0.0", + "rehype-parse": "^9.0.0", + "rehype-stringify": "^10.0.0", + "unified": "^11.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/rehype-expressive-code": { + "version": "0.41.3", + "resolved": "https://registry.npmjs.org/rehype-expressive-code/-/rehype-expressive-code-0.41.3.tgz", + "integrity": "sha512-8d9Py4c/V6I/Od2VIXFAdpiO2kc0SV2qTJsRAaqSIcM9aruW4ASLNe2kOEo1inXAAkIhpFzAHTc358HKbvpNUg==", + "license": "MIT", + "dependencies": { + "expressive-code": "^0.41.3" + } + }, + "node_modules/rehype-format": { + "version": "5.0.1", + "resolved": "https://registry.npmjs.org/rehype-format/-/rehype-format-5.0.1.tgz", + "integrity": "sha512-zvmVru9uB0josBVpr946OR8ui7nJEdzZobwLOOqHb/OOD88W0Vk2SqLwoVOj0fM6IPCCO6TaV9CvQvJMWwukFQ==", + "license": "MIT", + "dependencies": { + "@types/hast": "^3.0.0", + "hast-util-format": "^1.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/rehype-parse": { + "version": "9.0.1", + "resolved": "https://registry.npmjs.org/rehype-parse/-/rehype-parse-9.0.1.tgz", + "integrity": "sha512-ksCzCD0Fgfh7trPDxr2rSylbwq9iYDkSn8TCDmEJ49ljEUBxDVCzCHv7QNzZOfODanX4+bWQ4WZqLCRWYLfhag==", + "license": "MIT", + "dependencies": { + "@types/hast": "^3.0.0", + "hast-util-from-html": "^2.0.0", + "unified": "^11.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/rehype-raw": { + "version": "7.0.0", + "resolved": "https://registry.npmjs.org/rehype-raw/-/rehype-raw-7.0.0.tgz", + "integrity": "sha512-/aE8hCfKlQeA8LmyeyQvQF3eBiLRGNlfBJEvWH7ivp9sBqs7TNqBL5X3v157rM4IFETqDnIOO+z5M/biZbo9Ww==", + "license": "MIT", + "dependencies": { + "@types/hast": "^3.0.0", + "hast-util-raw": "^9.0.0", + "vfile": "^6.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/rehype-recma": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/rehype-recma/-/rehype-recma-1.0.0.tgz", + "integrity": "sha512-lqA4rGUf1JmacCNWWZx0Wv1dHqMwxzsDWYMTowuplHF3xH0N/MmrZ/G3BDZnzAkRmxDadujCjaKM2hqYdCBOGw==", + "license": "MIT", + "dependencies": { + "@types/estree": "^1.0.0", + "@types/hast": "^3.0.0", + "hast-util-to-estree": "^3.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/rehype-stringify": { + "version": "10.0.1", + "resolved": "https://registry.npmjs.org/rehype-stringify/-/rehype-stringify-10.0.1.tgz", + "integrity": "sha512-k9ecfXHmIPuFVI61B9DeLPN0qFHfawM6RsuX48hoqlaKSF61RskNjSm1lI8PhBEM0MRdLxVVm4WmTqJQccH9mA==", + "license": "MIT", + "dependencies": { + "@types/hast": "^3.0.0", + "hast-util-to-html": "^9.0.0", + "unified": "^11.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/remark-directive": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/remark-directive/-/remark-directive-3.0.1.tgz", + "integrity": "sha512-gwglrEQEZcZYgVyG1tQuA+h58EZfq5CSULw7J90AFuCTyib1thgHPoqQ+h9iFvU6R+vnZ5oNFQR5QKgGpk741A==", + "license": "MIT", + "dependencies": { + "@types/mdast": "^4.0.0", + "mdast-util-directive": "^3.0.0", + "micromark-extension-directive": "^3.0.0", + "unified": "^11.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/remark-gfm": { + "version": "4.0.1", + "resolved": "https://registry.npmjs.org/remark-gfm/-/remark-gfm-4.0.1.tgz", + "integrity": "sha512-1quofZ2RQ9EWdeN34S79+KExV1764+wCUGop5CPL1WGdD0ocPpu91lzPGbwWMECpEpd42kJGQwzRfyov9j4yNg==", + "license": "MIT", + "dependencies": { + "@types/mdast": "^4.0.0", + "mdast-util-gfm": "^3.0.0", + "micromark-extension-gfm": "^3.0.0", + "remark-parse": "^11.0.0", + "remark-stringify": "^11.0.0", + "unified": "^11.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/remark-mdx": { + "version": "3.1.1", + "resolved": "https://registry.npmjs.org/remark-mdx/-/remark-mdx-3.1.1.tgz", + "integrity": "sha512-Pjj2IYlUY3+D8x00UJsIOg5BEvfMyeI+2uLPn9VO9Wg4MEtN/VTIq2NEJQfde9PnX15KgtHyl9S0BcTnWrIuWg==", + "license": "MIT", + "dependencies": { + "mdast-util-mdx": "^3.0.0", + "micromark-extension-mdxjs": "^3.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/remark-parse": { + "version": "11.0.0", + "resolved": "https://registry.npmjs.org/remark-parse/-/remark-parse-11.0.0.tgz", + "integrity": "sha512-FCxlKLNGknS5ba/1lmpYijMUzX2esxW5xQqjWxw2eHFfS2MSdaHVINFmhjo+qN1WhZhNimq0dZATN9pH0IDrpA==", + "license": "MIT", + "dependencies": { + "@types/mdast": "^4.0.0", + "mdast-util-from-markdown": "^2.0.0", + "micromark-util-types": "^2.0.0", + "unified": "^11.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/remark-rehype": { + "version": "11.1.2", + "resolved": "https://registry.npmjs.org/remark-rehype/-/remark-rehype-11.1.2.tgz", + "integrity": "sha512-Dh7l57ianaEoIpzbp0PC9UKAdCSVklD8E5Rpw7ETfbTl3FqcOOgq5q2LVDhgGCkaBv7p24JXikPdvhhmHvKMsw==", + "license": "MIT", + "dependencies": { + "@types/hast": "^3.0.0", + "@types/mdast": "^4.0.0", + "mdast-util-to-hast": "^13.0.0", + "unified": "^11.0.0", + "vfile": "^6.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/remark-smartypants": { + "version": "3.0.2", + "resolved": "https://registry.npmjs.org/remark-smartypants/-/remark-smartypants-3.0.2.tgz", + "integrity": "sha512-ILTWeOriIluwEvPjv67v7Blgrcx+LZOkAUVtKI3putuhlZm84FnqDORNXPPm+HY3NdZOMhyDwZ1E+eZB/Df5dA==", + "license": "MIT", + "dependencies": { + "retext": "^9.0.0", + "retext-smartypants": "^6.0.0", + "unified": "^11.0.4", + "unist-util-visit": "^5.0.0" + }, + "engines": { + "node": ">=16.0.0" + } + }, + "node_modules/remark-stringify": { + "version": "11.0.0", + "resolved": "https://registry.npmjs.org/remark-stringify/-/remark-stringify-11.0.0.tgz", + "integrity": "sha512-1OSmLd3awB/t8qdoEOMazZkNsfVTeY4fTsgzcQFdXNq8ToTN4ZGwrMnlda4K6smTFKD+GRV6O48i6Z4iKgPPpw==", + "license": "MIT", + "dependencies": { + "@types/mdast": "^4.0.0", + "mdast-util-to-markdown": "^2.0.0", + "unified": "^11.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/request-light": { + "version": "0.7.0", + "resolved": "https://registry.npmjs.org/request-light/-/request-light-0.7.0.tgz", + "integrity": "sha512-lMbBMrDoxgsyO+yB3sDcrDuX85yYt7sS8BfQd11jtbW/z5ZWgLZRcEGLsLoYw7I0WSUGQBs8CC8ScIxkTX1+6Q==", + "license": "MIT" + }, + "node_modules/require-directory": { + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/require-directory/-/require-directory-2.1.1.tgz", + "integrity": "sha512-fGxEI7+wsG9xrvdjsrlmL22OMTTiHRwAMroiEeMgq8gzoLC/PQr7RsRDSTLUg/bZAZtF+TVIkHc6/4RIKrui+Q==", + "license": "MIT", + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/require-from-string": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/require-from-string/-/require-from-string-2.0.2.tgz", + "integrity": "sha512-Xf0nWe6RseziFMu+Ap9biiUbmplq6S9/p+7w7YXP/JBHhrUDDUhwa+vANyubuqfZWTveU//DYVGsDG7RKL/vEw==", + "license": "MIT", + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/restructure": { + "version": "3.0.2", + "resolved": "https://registry.npmjs.org/restructure/-/restructure-3.0.2.tgz", + "integrity": "sha512-gSfoiOEA0VPE6Tukkrr7I0RBdE0s7H1eFCDBk05l1KIQT1UIKNc5JZy6jdyW6eYH3aR3g5b3PuL77rq0hvwtAw==", + "license": "MIT" + }, + "node_modules/retext": { + "version": "9.0.0", + "resolved": "https://registry.npmjs.org/retext/-/retext-9.0.0.tgz", + "integrity": "sha512-sbMDcpHCNjvlheSgMfEcVrZko3cDzdbe1x/e7G66dFp0Ff7Mldvi2uv6JkJQzdRcvLYE8CA8Oe8siQx8ZOgTcA==", + "license": "MIT", + "dependencies": { + "@types/nlcst": "^2.0.0", + "retext-latin": "^4.0.0", + "retext-stringify": "^4.0.0", + "unified": "^11.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/retext-latin": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/retext-latin/-/retext-latin-4.0.0.tgz", + "integrity": "sha512-hv9woG7Fy0M9IlRQloq/N6atV82NxLGveq+3H2WOi79dtIYWN8OaxogDm77f8YnVXJL2VD3bbqowu5E3EMhBYA==", + "license": "MIT", + "dependencies": { + "@types/nlcst": "^2.0.0", + "parse-latin": "^7.0.0", + "unified": "^11.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/retext-smartypants": { + "version": "6.2.0", + "resolved": "https://registry.npmjs.org/retext-smartypants/-/retext-smartypants-6.2.0.tgz", + "integrity": "sha512-kk0jOU7+zGv//kfjXEBjdIryL1Acl4i9XNkHxtM7Tm5lFiCog576fjNC9hjoR7LTKQ0DsPWy09JummSsH1uqfQ==", + "license": "MIT", + "dependencies": { + "@types/nlcst": "^2.0.0", + "nlcst-to-string": "^4.0.0", + "unist-util-visit": "^5.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/retext-stringify": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/retext-stringify/-/retext-stringify-4.0.0.tgz", + "integrity": "sha512-rtfN/0o8kL1e+78+uxPTqu1Klt0yPzKuQ2BfWwwfgIUSayyzxpM1PJzkKt4V8803uB9qSy32MvI7Xep9khTpiA==", + "license": "MIT", + "dependencies": { + "@types/nlcst": "^2.0.0", + "nlcst-to-string": "^4.0.0", + "unified": "^11.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/reusify": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/reusify/-/reusify-1.1.0.tgz", + "integrity": "sha512-g6QUff04oZpHs0eG5p83rFLhHeV00ug/Yf9nZM6fLeUrPguBTkTQOdpAWWspMh55TZfVQDPaN3NQJfbVRAxdIw==", + "license": "MIT", + "engines": { + "iojs": ">=1.0.0", + "node": ">=0.10.0" + } + }, + "node_modules/rollup": { + "version": "4.53.3", + "resolved": "https://registry.npmjs.org/rollup/-/rollup-4.53.3.tgz", + "integrity": "sha512-w8GmOxZfBmKknvdXU1sdM9NHcoQejwF/4mNgj2JuEEdRaHwwF12K7e9eXn1nLZ07ad+du76mkVsyeb2rKGllsA==", + "license": "MIT", + "peer": true, + "dependencies": { + "@types/estree": "1.0.8" + }, + "bin": { + "rollup": "dist/bin/rollup" + }, + "engines": { + "node": ">=18.0.0", + "npm": ">=8.0.0" + }, + "optionalDependencies": { + "@rollup/rollup-android-arm-eabi": "4.53.3", + "@rollup/rollup-android-arm64": "4.53.3", + "@rollup/rollup-darwin-arm64": "4.53.3", + "@rollup/rollup-darwin-x64": "4.53.3", + "@rollup/rollup-freebsd-arm64": "4.53.3", + "@rollup/rollup-freebsd-x64": "4.53.3", + "@rollup/rollup-linux-arm-gnueabihf": "4.53.3", + "@rollup/rollup-linux-arm-musleabihf": "4.53.3", + "@rollup/rollup-linux-arm64-gnu": "4.53.3", + "@rollup/rollup-linux-arm64-musl": "4.53.3", + "@rollup/rollup-linux-loong64-gnu": "4.53.3", + "@rollup/rollup-linux-ppc64-gnu": "4.53.3", + "@rollup/rollup-linux-riscv64-gnu": "4.53.3", + "@rollup/rollup-linux-riscv64-musl": "4.53.3", + "@rollup/rollup-linux-s390x-gnu": "4.53.3", + "@rollup/rollup-linux-x64-gnu": "4.53.3", + "@rollup/rollup-linux-x64-musl": "4.53.3", + "@rollup/rollup-openharmony-arm64": "4.53.3", + "@rollup/rollup-win32-arm64-msvc": "4.53.3", + "@rollup/rollup-win32-ia32-msvc": "4.53.3", + "@rollup/rollup-win32-x64-gnu": "4.53.3", + "@rollup/rollup-win32-x64-msvc": "4.53.3", + "fsevents": "~2.3.2" + } + }, + "node_modules/run-parallel": { + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/run-parallel/-/run-parallel-1.2.0.tgz", + "integrity": "sha512-5l4VyZR86LZ/lDxZTR6jqL8AFE2S0IFLMP26AbjsLVADxHdhB/c0GUsH+y39UfCi3dzz8OlQuPmnaJOMoDHQBA==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/feross" + }, + { + "type": "patreon", + "url": "https://www.patreon.com/feross" + }, + { + "type": "consulting", + "url": "https://feross.org/support" + } + ], + "license": "MIT", + "dependencies": { + "queue-microtask": "^1.2.2" + } + }, + "node_modules/sax": { + "version": "1.4.3", + "resolved": "https://registry.npmjs.org/sax/-/sax-1.4.3.tgz", + "integrity": "sha512-yqYn1JhPczigF94DMS+shiDMjDowYO6y9+wB/4WgO0Y19jWYk0lQ4tuG5KI7kj4FTp1wxPj5IFfcrz/s1c3jjQ==", + "license": "BlueOak-1.0.0" + }, + "node_modules/scheduler": { + "version": "0.27.0", + "resolved": "https://registry.npmjs.org/scheduler/-/scheduler-0.27.0.tgz", + "integrity": "sha512-eNv+WrVbKu1f3vbYJT/xtiF5syA5HPIMtf9IgY/nKg0sWqzAUEvqY/xm7OcZc/qafLx/iO9FgOmeSAp4v5ti/Q==", + "license": "MIT" + }, + "node_modules/semver": { + "version": "6.3.1", + "resolved": "https://registry.npmjs.org/semver/-/semver-6.3.1.tgz", + "integrity": "sha512-BR7VvDCVHO+q2xBEWskxS6DJE1qRnb7DxzUrogb71CWoSficBxYsiAGd+Kl0mmq/MprG9yArRkyrQxTO6XjMzA==", + "license": "ISC", + "bin": { + "semver": "bin/semver.js" + } + }, + "node_modules/sharp": { + "version": "0.33.5", + "resolved": "https://registry.npmjs.org/sharp/-/sharp-0.33.5.tgz", + "integrity": "sha512-haPVm1EkS9pgvHrQ/F3Xy+hgcuMV0Wm9vfIBSiwZ05k+xgb0PkBQpGsAA/oWdDobNaZTH5ppvHtzCFbnSEwHVw==", + "hasInstallScript": true, + "license": "Apache-2.0", + "dependencies": { + "color": "^4.2.3", + "detect-libc": "^2.0.3", + "semver": "^7.6.3" + }, + "engines": { + "node": "^18.17.0 || ^20.3.0 || >=21.0.0" + }, + "funding": { + "url": "https://opencollective.com/libvips" + }, + "optionalDependencies": { + "@img/sharp-darwin-arm64": "0.33.5", + "@img/sharp-darwin-x64": "0.33.5", + "@img/sharp-libvips-darwin-arm64": "1.0.4", + "@img/sharp-libvips-darwin-x64": "1.0.4", + "@img/sharp-libvips-linux-arm": "1.0.5", + "@img/sharp-libvips-linux-arm64": "1.0.4", + "@img/sharp-libvips-linux-s390x": "1.0.4", + "@img/sharp-libvips-linux-x64": "1.0.4", + "@img/sharp-libvips-linuxmusl-arm64": "1.0.4", + "@img/sharp-libvips-linuxmusl-x64": "1.0.4", + "@img/sharp-linux-arm": "0.33.5", + "@img/sharp-linux-arm64": "0.33.5", + "@img/sharp-linux-s390x": "0.33.5", + "@img/sharp-linux-x64": "0.33.5", + "@img/sharp-linuxmusl-arm64": "0.33.5", + "@img/sharp-linuxmusl-x64": "0.33.5", + "@img/sharp-wasm32": "0.33.5", + "@img/sharp-win32-ia32": "0.33.5", + "@img/sharp-win32-x64": "0.33.5" + } + }, + "node_modules/sharp/node_modules/semver": { + "version": "7.7.3", + "resolved": "https://registry.npmjs.org/semver/-/semver-7.7.3.tgz", + "integrity": "sha512-SdsKMrI9TdgjdweUSR9MweHA4EJ8YxHn8DFaDisvhVlUOe4BF1tLD7GAj0lIqWVl+dPb/rExr0Btby5loQm20Q==", + "license": "ISC", + "bin": { + "semver": "bin/semver.js" + }, + "engines": { + "node": ">=10" + } + }, + "node_modules/shiki": { + "version": "3.15.0", + "resolved": "https://registry.npmjs.org/shiki/-/shiki-3.15.0.tgz", + "integrity": "sha512-kLdkY6iV3dYbtPwS9KXU7mjfmDm25f5m0IPNFnaXO7TBPcvbUOY72PYXSuSqDzwp+vlH/d7MXpHlKO/x+QoLXw==", + "license": "MIT", + "dependencies": { + "@shikijs/core": "3.15.0", + "@shikijs/engine-javascript": "3.15.0", + "@shikijs/engine-oniguruma": "3.15.0", + "@shikijs/langs": "3.15.0", + "@shikijs/themes": "3.15.0", + "@shikijs/types": "3.15.0", + "@shikijs/vscode-textmate": "^10.0.2", + "@types/hast": "^3.0.4" + } + }, + "node_modules/simple-swizzle": { + "version": "0.2.4", + "resolved": "https://registry.npmjs.org/simple-swizzle/-/simple-swizzle-0.2.4.tgz", + "integrity": "sha512-nAu1WFPQSMNr2Zn9PGSZK9AGn4t/y97lEm+MXTtUDwfP0ksAIX4nO+6ruD9Jwut4C49SB1Ws+fbXsm/yScWOHw==", + "license": "MIT", + "dependencies": { + "is-arrayish": "^0.3.1" + } + }, + "node_modules/sisteransi": { + "version": "1.0.5", + "resolved": "https://registry.npmjs.org/sisteransi/-/sisteransi-1.0.5.tgz", + "integrity": "sha512-bLGGlR1QxBcynn2d5YmDX4MGjlZvy2MRBDRNHLJ8VI6l6+9FUiyTFNJ0IveOSP0bcXgVDPRcfGqA0pjaqUpfVg==", + "license": "MIT" + }, + "node_modules/sitemap": { + "version": "8.0.2", + "resolved": "https://registry.npmjs.org/sitemap/-/sitemap-8.0.2.tgz", + "integrity": "sha512-LwktpJcyZDoa0IL6KT++lQ53pbSrx2c9ge41/SeLTyqy2XUNA6uR4+P9u5IVo5lPeL2arAcOKn1aZAxoYbCKlQ==", + "license": "MIT", + "dependencies": { + "@types/node": "^17.0.5", + "@types/sax": "^1.2.1", + "arg": "^5.0.0", + "sax": "^1.4.1" + }, + "bin": { + "sitemap": "dist/cli.js" + }, + "engines": { + "node": ">=14.0.0", + "npm": ">=6.0.0" + } + }, + "node_modules/sitemap/node_modules/@types/node": { + "version": "17.0.45", + "resolved": "https://registry.npmjs.org/@types/node/-/node-17.0.45.tgz", + "integrity": "sha512-w+tIMs3rq2afQdsPJlODhoUEKzFP1ayaoyl1CcnwtIlsVe7K7bA1NGm4s3PraqTLlXnbIN84zuBlxBWo1u9BLw==", + "license": "MIT" + }, + "node_modules/smartypants": { + "version": "0.2.2", + "resolved": "https://registry.npmjs.org/smartypants/-/smartypants-0.2.2.tgz", + "integrity": "sha512-TzobUYoEft/xBtb2voRPryAUIvYguG0V7Tt3de79I1WfXgCwelqVsGuZSnu3GFGRZhXR90AeEYIM+icuB/S06Q==", + "license": "BSD-3-Clause", + "bin": { + "smartypants": "bin/smartypants.js", + "smartypantsu": "bin/smartypantsu.js" + } + }, + "node_modules/smol-toml": { + "version": "1.5.2", + "resolved": "https://registry.npmjs.org/smol-toml/-/smol-toml-1.5.2.tgz", + "integrity": "sha512-QlaZEqcAH3/RtNyet1IPIYPsEWAaYyXXv1Krsi+1L/QHppjX4Ifm8MQsBISz9vE8cHicIq3clogsheili5vhaQ==", + "license": "BSD-3-Clause", + "engines": { + "node": ">= 18" + }, + "funding": { + "url": "https://github.com/sponsors/cyyynthia" + } + }, + "node_modules/source-map": { + "version": "0.7.6", + "resolved": "https://registry.npmjs.org/source-map/-/source-map-0.7.6.tgz", + "integrity": "sha512-i5uvt8C3ikiWeNZSVZNWcfZPItFQOsYTUAOkcUPGd8DqDy1uOUikjt5dG+uRlwyvR108Fb9DOd4GvXfT0N2/uQ==", + "license": "BSD-3-Clause", + "engines": { + "node": ">= 12" + } + }, + "node_modules/source-map-js": { + "version": "1.2.1", + "resolved": "https://registry.npmjs.org/source-map-js/-/source-map-js-1.2.1.tgz", + "integrity": "sha512-UXWMKhLOwVKb728IUtQPXxfYU+usdybtUrK/8uGE8CQMvrhOpwvzDBwj0QhSL7MQc7vIsISBG8VQ8+IDQxpfQA==", + "license": "BSD-3-Clause", + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/space-separated-tokens": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/space-separated-tokens/-/space-separated-tokens-2.0.2.tgz", + "integrity": "sha512-PEGlAwrG8yXGXRjW32fGbg66JAlOAwbObuqVoJpv/mRgoWDQfgH1wDPvtzWyUSNAXBGSk8h755YDbbcEy3SH2Q==", + "license": "MIT", + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, + "node_modules/starlight-blog": { + "version": "0.25.1", + "resolved": "https://registry.npmjs.org/starlight-blog/-/starlight-blog-0.25.1.tgz", + "integrity": "sha512-T/4x+9brr0r2QbhxQIdesvsSuOdqLNFtE/MGhoDyGt73KdBTT3EPUq/CgKY+yTWq1QhKtw/GzMox6qbsqEBHXA==", + "license": "MIT", + "dependencies": { + "@astrojs/markdown-remark": "^6.3.1", + "@astrojs/mdx": "^4.0.8", + "@astrojs/rss": "^4.0.11", + "astro-remote": "^0.3.3", + "github-slugger": "^2.0.0", + "hast-util-from-html": "^2.0.3", + "hast-util-to-html": "^9.0.5", + "hast-util-to-string": "^3.0.1", + "marked": "^15.0.4", + "marked-plaintify": "^1.1.1", + "mdast-util-mdx-expression": "^2.0.1", + "unist-util-is": "^6.0.0", + "unist-util-remove": "^4.0.0", + "unist-util-visit": "^5.0.0" + }, + "engines": { + "node": ">=18.20.8" + }, + "peerDependencies": { + "@astrojs/starlight": ">=0.33.0" + } + }, + "node_modules/starlight-image-zoom": { + "version": "0.9.0", + "resolved": "https://registry.npmjs.org/starlight-image-zoom/-/starlight-image-zoom-0.9.0.tgz", + "integrity": "sha512-XG87T80g5hsT6dvtNk9OKx0gD+M8lsloVTApQYnxdc3JD8lQBfu2kCsrwkyrwXZRtV7JRyd0PDHwx1UFmGmI1g==", + "license": "MIT", + "dependencies": { + "rehype-raw": "7.0.0", + "unist-util-visit": "5.0.0", + "unist-util-visit-parents": "6.0.1" + }, + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "@astrojs/starlight": ">=0.22.0" + } + }, + "node_modules/starlight-image-zoom/node_modules/unist-util-visit-parents": { + "version": "6.0.1", + "resolved": "https://registry.npmjs.org/unist-util-visit-parents/-/unist-util-visit-parents-6.0.1.tgz", + "integrity": "sha512-L/PqWzfTP9lzzEa6CKs0k2nARxTdZduw3zyh8d2NVBnsyvHjSX4TWse388YrrQKbvI8w20fGjGlhgT96WwKykw==", + "license": "MIT", + "dependencies": { + "@types/unist": "^3.0.0", + "unist-util-is": "^6.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/starlight-links-validator": { + "version": "0.13.4", + "resolved": "https://registry.npmjs.org/starlight-links-validator/-/starlight-links-validator-0.13.4.tgz", + "integrity": "sha512-LdmLbJyPHVrSUhcuxiP3pJNnW8zRcOg/32C996Ic0LOCKbB8vylqHLvAMdIhT67FvEV4eAROun+2wTVU2J156A==", + "license": "MIT", + "dependencies": { + "@types/picomatch": "2.3.3", + "github-slugger": "2.0.0", + "hast-util-from-html": "2.0.1", + "hast-util-has-property": "3.0.0", + "is-absolute-url": "4.0.1", + "kleur": "4.1.5", + "mdast-util-to-string": "4.0.0", + "picomatch": "4.0.2", + "unist-util-visit": "5.0.0" + }, + "engines": { + "node": ">=18.14.1" + }, + "peerDependencies": { + "@astrojs/starlight": ">=0.15.0", + "astro": ">=4.0.0" + } + }, + "node_modules/starlight-links-validator/node_modules/hast-util-from-html": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/hast-util-from-html/-/hast-util-from-html-2.0.1.tgz", + "integrity": "sha512-RXQBLMl9kjKVNkJTIO6bZyb2n+cUH8LFaSSzo82jiLT6Tfc+Pt7VQCS+/h3YwG4jaNE2TA2sdJisGWR+aJrp0g==", + "license": "MIT", + "dependencies": { + "@types/hast": "^3.0.0", + "devlop": "^1.1.0", + "hast-util-from-parse5": "^8.0.0", + "parse5": "^7.0.0", + "vfile": "^6.0.0", + "vfile-message": "^4.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/starlight-links-validator/node_modules/picomatch": { + "version": "4.0.2", + "resolved": "https://registry.npmjs.org/picomatch/-/picomatch-4.0.2.tgz", + "integrity": "sha512-M7BAV6Rlcy5u+m6oPhAPFgJTzAioX/6B0DxyvDlo9l8+T3nLKbrczg2WLUyzd45L8RqfUMyGPzekbMvX2Ldkwg==", + "license": "MIT", + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/sponsors/jonschlinkert" + } + }, + "node_modules/starlight-showcases": { + "version": "0.2.0", + "resolved": "https://registry.npmjs.org/starlight-showcases/-/starlight-showcases-0.2.0.tgz", + "integrity": "sha512-YWJuTqArkUdVJV85VKZJ0BvKCQRu1SKtH/Cr5t6G/oIfI4IptWc92E7BmiuNnpuQ2U7TczTRidCYurPrbgQQVA==", + "license": "MIT", + "dependencies": { + "@astro-community/astro-embed-twitter": "^0.5.4", + "@astro-community/astro-embed-youtube": "^0.5.2" + }, + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "@astrojs/starlight": ">=0.23.0" + } + }, + "node_modules/stream-replace-string": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/stream-replace-string/-/stream-replace-string-2.0.0.tgz", + "integrity": "sha512-TlnjJ1C0QrmxRNrON00JvaFFlNh5TTG00APw23j74ET7gkQpTASi6/L2fuiav8pzK715HXtUeClpBTw2NPSn6w==", + "license": "MIT" + }, + "node_modules/string-width": { + "version": "7.2.0", + "resolved": "https://registry.npmjs.org/string-width/-/string-width-7.2.0.tgz", + "integrity": "sha512-tsaTIkKW9b4N+AEj+SVA+WhJzV7/zMhcSu78mLKWSk7cXMOSHsBKFWUs0fWwq8QyK3MgJBQRX6Gbi4kYbdvGkQ==", + "license": "MIT", + "dependencies": { + "emoji-regex": "^10.3.0", + "get-east-asian-width": "^1.0.0", + "strip-ansi": "^7.1.0" + }, + "engines": { + "node": ">=18" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/stringify-entities": { + "version": "4.0.4", + "resolved": "https://registry.npmjs.org/stringify-entities/-/stringify-entities-4.0.4.tgz", + "integrity": "sha512-IwfBptatlO+QCJUo19AqvrPNqlVMpW9YEL2LIVY+Rpv2qsjCGxaDLNRgeGsQWJhfItebuJhsGSLjaBbNSQ+ieg==", + "license": "MIT", + "dependencies": { + "character-entities-html4": "^2.0.0", + "character-entities-legacy": "^3.0.0" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, + "node_modules/strip-ansi": { + "version": "7.1.2", + "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-7.1.2.tgz", + "integrity": "sha512-gmBGslpoQJtgnMAvOVqGZpEz9dyoKTCzy2nfz/n8aIFhN/jCE/rCmcxabB6jOOHV+0WNnylOxaxBQPSvcWklhA==", + "license": "MIT", + "dependencies": { + "ansi-regex": "^6.0.1" + }, + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/chalk/strip-ansi?sponsor=1" + } + }, + "node_modules/strnum": { + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/strnum/-/strnum-2.1.1.tgz", + "integrity": "sha512-7ZvoFTiCnGxBtDqJ//Cu6fWtZtc7Y3x+QOirG15wztbdngGSkht27o2pyGWrVy0b4WAy3jbKmnoK6g5VlVNUUw==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/NaturalIntelligence" + } + ], + "license": "MIT" + }, + "node_modules/style-to-js": { + "version": "1.1.21", + "resolved": "https://registry.npmjs.org/style-to-js/-/style-to-js-1.1.21.tgz", + "integrity": "sha512-RjQetxJrrUJLQPHbLku6U/ocGtzyjbJMP9lCNK7Ag0CNh690nSH8woqWH9u16nMjYBAok+i7JO1NP2pOy8IsPQ==", + "license": "MIT", + "dependencies": { + "style-to-object": "1.0.14" + } + }, + "node_modules/style-to-object": { + "version": "1.0.14", + "resolved": "https://registry.npmjs.org/style-to-object/-/style-to-object-1.0.14.tgz", + "integrity": "sha512-LIN7rULI0jBscWQYaSswptyderlarFkjQ+t79nzty8tcIAceVomEVlLzH5VP4Cmsv6MtKhs7qaAiwlcp+Mgaxw==", + "license": "MIT", + "dependencies": { + "inline-style-parser": "0.2.7" + } + }, + "node_modules/svgo": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/svgo/-/svgo-4.0.0.tgz", + "integrity": "sha512-VvrHQ+9uniE+Mvx3+C9IEe/lWasXCU0nXMY2kZeLrHNICuRiC8uMPyM14UEaMOFA5mhyQqEkB02VoQ16n3DLaw==", + "license": "MIT", + "dependencies": { + "commander": "^11.1.0", + "css-select": "^5.1.0", + "css-tree": "^3.0.1", + "css-what": "^6.1.0", + "csso": "^5.0.5", + "picocolors": "^1.1.1", + "sax": "^1.4.1" + }, + "bin": { + "svgo": "bin/svgo.js" + }, + "engines": { + "node": ">=16" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/svgo" + } + }, + "node_modules/tiny-inflate": { + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/tiny-inflate/-/tiny-inflate-1.0.3.tgz", + "integrity": "sha512-pkY1fj1cKHb2seWDy0B16HeWyczlJA9/WW3u3c4z/NiWDsO3DOU5D7nhTLE9CF0yXv/QZFY7sEJmj24dK+Rrqw==", + "license": "MIT" + }, + "node_modules/tinyexec": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/tinyexec/-/tinyexec-1.0.2.tgz", + "integrity": "sha512-W/KYk+NFhkmsYpuHq5JykngiOCnxeVL8v8dFnqxSD8qEEdRfXk1SDM6JzNqcERbcGYj9tMrDQBYV9cjgnunFIg==", + "license": "MIT", + "engines": { + "node": ">=18" + } + }, + "node_modules/tinyglobby": { + "version": "0.2.15", + "resolved": "https://registry.npmjs.org/tinyglobby/-/tinyglobby-0.2.15.tgz", + "integrity": "sha512-j2Zq4NyQYG5XMST4cbs02Ak8iJUdxRM0XI5QyxXuZOzKOINmWurp3smXu3y5wDcJrptwpSjgXHzIQxR0omXljQ==", + "license": "MIT", + "dependencies": { + "fdir": "^6.5.0", + "picomatch": "^4.0.3" + }, + "engines": { + "node": ">=12.0.0" + }, + "funding": { + "url": "https://github.com/sponsors/SuperchupuDev" + } + }, + "node_modules/to-regex-range": { + "version": "5.0.1", + "resolved": "https://registry.npmjs.org/to-regex-range/-/to-regex-range-5.0.1.tgz", + "integrity": "sha512-65P7iz6X5yEr1cwcgvQxbbIw7Uk3gOy5dIdtZ4rDveLqhrdJP+Li/Hx6tyK0NEb+2GCyneCMJiGqrADCSNk8sQ==", + "license": "MIT", + "dependencies": { + "is-number": "^7.0.0" + }, + "engines": { + "node": ">=8.0" + } + }, + "node_modules/trim-lines": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/trim-lines/-/trim-lines-3.0.1.tgz", + "integrity": "sha512-kRj8B+YHZCc9kQYdWfJB2/oUl9rA99qbowYYBtr4ui4mZyAQ2JpvVBd/6U2YloATfqBhBTSMhTpgBHtU0Mf3Rg==", + "license": "MIT", + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, + "node_modules/trough": { + "version": "2.2.0", + "resolved": "https://registry.npmjs.org/trough/-/trough-2.2.0.tgz", + "integrity": "sha512-tmMpK00BjZiUyVyvrBK7knerNgmgvcV/KLVyuma/SC+TQN167GrMRciANTz09+k3zW8L8t60jWO1GpfkZdjTaw==", + "license": "MIT", + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, + "node_modules/tsconfck": { + "version": "3.1.6", + "resolved": "https://registry.npmjs.org/tsconfck/-/tsconfck-3.1.6.tgz", + "integrity": "sha512-ks6Vjr/jEw0P1gmOVwutM3B7fWxoWBL2KRDb1JfqGVawBmO5UsvmWOQFGHBPl5yxYz4eERr19E6L7NMv+Fej4w==", + "license": "MIT", + "bin": { + "tsconfck": "bin/tsconfck.js" + }, + "engines": { + "node": "^18 || >=20" + }, + "peerDependencies": { + "typescript": "^5.0.0" + }, + "peerDependenciesMeta": { + "typescript": { + "optional": true + } + } + }, + "node_modules/tslib": { + "version": "2.8.1", + "resolved": "https://registry.npmjs.org/tslib/-/tslib-2.8.1.tgz", + "integrity": "sha512-oJFu94HQb+KVduSUQL7wnpmqnfmLsOA/nAh6b6EH0wCEoK0/mPeXU6c3wKDV83MkOuHPRHtSXKKU99IBazS/2w==", + "license": "0BSD" + }, + "node_modules/type-fest": { + "version": "4.41.0", + "resolved": "https://registry.npmjs.org/type-fest/-/type-fest-4.41.0.tgz", + "integrity": "sha512-TeTSQ6H5YHvpqVwBRcnLDCBnDOHWYu7IvGbHT6N8AOymcr9PJGjc1GTtiWZTYg0NCgYwvnYWEkVChQAr9bjfwA==", + "license": "(MIT OR CC0-1.0)", + "engines": { + "node": ">=16" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/typesafe-path": { + "version": "0.2.2", + "resolved": "https://registry.npmjs.org/typesafe-path/-/typesafe-path-0.2.2.tgz", + "integrity": "sha512-OJabfkAg1WLZSqJAJ0Z6Sdt3utnbzr/jh+NAHoyWHJe8CMSy79Gm085094M9nvTPy22KzTVn5Zq5mbapCI/hPA==", + "license": "MIT" + }, + "node_modules/typescript": { + "version": "5.9.3", + "resolved": "https://registry.npmjs.org/typescript/-/typescript-5.9.3.tgz", + "integrity": "sha512-jl1vZzPDinLr9eUt3J/t7V6FgNEw9QjvBPdysz9KfQDD41fQrC2Y4vKQdiaUpFT4bXlb1RHhLpp8wtm6M5TgSw==", + "license": "Apache-2.0", + "peer": true, + "bin": { + "tsc": "bin/tsc", + "tsserver": "bin/tsserver" + }, + "engines": { + "node": ">=14.17" + } + }, + "node_modules/typescript-auto-import-cache": { + "version": "0.3.6", + "resolved": "https://registry.npmjs.org/typescript-auto-import-cache/-/typescript-auto-import-cache-0.3.6.tgz", + "integrity": "sha512-RpuHXrknHdVdK7wv/8ug3Fr0WNsNi5l5aB8MYYuXhq2UH5lnEB1htJ1smhtD5VeCsGr2p8mUDtd83LCQDFVgjQ==", + "license": "MIT", + "dependencies": { + "semver": "^7.3.8" + } + }, + "node_modules/typescript-auto-import-cache/node_modules/semver": { + "version": "7.7.3", + "resolved": "https://registry.npmjs.org/semver/-/semver-7.7.3.tgz", + "integrity": "sha512-SdsKMrI9TdgjdweUSR9MweHA4EJ8YxHn8DFaDisvhVlUOe4BF1tLD7GAj0lIqWVl+dPb/rExr0Btby5loQm20Q==", + "license": "ISC", + "bin": { + "semver": "bin/semver.js" + }, + "engines": { + "node": ">=10" + } + }, + "node_modules/ufo": { + "version": "1.6.1", + "resolved": "https://registry.npmjs.org/ufo/-/ufo-1.6.1.tgz", + "integrity": "sha512-9a4/uxlTWJ4+a5i0ooc1rU7C7YOw3wT+UGqdeNNHWnOF9qcMBgLRS+4IYUqbczewFx4mLEig6gawh7X6mFlEkA==", + "license": "MIT" + }, + "node_modules/uhyphen": { + "version": "0.2.0", + "resolved": "https://registry.npmjs.org/uhyphen/-/uhyphen-0.2.0.tgz", + "integrity": "sha512-qz3o9CHXmJJPGBdqzab7qAYuW8kQGKNEuoHFYrBwV6hWIMcpAmxDLXojcHfFr9US1Pe6zUswEIJIbLI610fuqA==", + "license": "ISC" + }, + "node_modules/ultrahtml": { + "version": "1.6.0", + "resolved": "https://registry.npmjs.org/ultrahtml/-/ultrahtml-1.6.0.tgz", + "integrity": "sha512-R9fBn90VTJrqqLDwyMph+HGne8eqY1iPfYhPzZrvKpIfwkWZbcYlfpsb8B9dTvBfpy1/hqAD7Wi8EKfP9e8zdw==", + "license": "MIT" + }, + "node_modules/uncrypto": { + "version": "0.1.3", + "resolved": "https://registry.npmjs.org/uncrypto/-/uncrypto-0.1.3.tgz", + "integrity": "sha512-Ql87qFHB3s/De2ClA9e0gsnS6zXG27SkTiSJwjCc9MebbfapQfuPzumMIUMi38ezPZVNFcHI9sUIepeQfw8J8Q==", + "license": "MIT" + }, + "node_modules/undici-types": { + "version": "7.16.0", + "resolved": "https://registry.npmjs.org/undici-types/-/undici-types-7.16.0.tgz", + "integrity": "sha512-Zz+aZWSj8LE6zoxD+xrjh4VfkIG8Ya6LvYkZqtUQGJPZjYl53ypCaUwWqo7eI0x66KBGeRo+mlBEkMSeSZ38Nw==", + "license": "MIT" + }, + "node_modules/unicode-properties": { + "version": "1.4.1", + "resolved": "https://registry.npmjs.org/unicode-properties/-/unicode-properties-1.4.1.tgz", + "integrity": "sha512-CLjCCLQ6UuMxWnbIylkisbRj31qxHPAurvena/0iwSVbQ2G1VY5/HjV0IRabOEbDHlzZlRdCrD4NhB0JtU40Pg==", + "license": "MIT", + "dependencies": { + "base64-js": "^1.3.0", + "unicode-trie": "^2.0.0" + } + }, + "node_modules/unicode-trie": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/unicode-trie/-/unicode-trie-2.0.0.tgz", + "integrity": "sha512-x7bc76x0bm4prf1VLg79uhAzKw8DVboClSN5VxJuQ+LKDOVEW9CdH+VY7SP+vX7xCYQqzzgQpFqz15zeLvAtZQ==", + "license": "MIT", + "dependencies": { + "pako": "^0.2.5", + "tiny-inflate": "^1.0.0" + } + }, + "node_modules/unified": { + "version": "11.0.5", + "resolved": "https://registry.npmjs.org/unified/-/unified-11.0.5.tgz", + "integrity": "sha512-xKvGhPWw3k84Qjh8bI3ZeJjqnyadK+GEFtazSfZv/rKeTkTjOJho6mFqh2SM96iIcZokxiOpg78GazTSg8+KHA==", + "license": "MIT", + "dependencies": { + "@types/unist": "^3.0.0", + "bail": "^2.0.0", + "devlop": "^1.0.0", + "extend": "^3.0.0", + "is-plain-obj": "^4.0.0", + "trough": "^2.0.0", + "vfile": "^6.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/unifont": { + "version": "0.6.0", + "resolved": "https://registry.npmjs.org/unifont/-/unifont-0.6.0.tgz", + "integrity": "sha512-5Fx50fFQMQL5aeHyWnZX9122sSLckcDvcfFiBf3QYeHa7a1MKJooUy52b67moi2MJYkrfo/TWY+CoLdr/w0tTA==", + "license": "MIT", + "dependencies": { + "css-tree": "^3.0.0", + "ofetch": "^1.4.1", + "ohash": "^2.0.0" + } + }, + "node_modules/unist-util-find-after": { + "version": "5.0.0", + "resolved": "https://registry.npmjs.org/unist-util-find-after/-/unist-util-find-after-5.0.0.tgz", + "integrity": "sha512-amQa0Ep2m6hE2g72AugUItjbuM8X8cGQnFoHk0pGfrFeT9GZhzN5SW8nRsiGKK7Aif4CrACPENkA6P/Lw6fHGQ==", + "license": "MIT", + "dependencies": { + "@types/unist": "^3.0.0", + "unist-util-is": "^6.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/unist-util-is": { + "version": "6.0.1", + "resolved": "https://registry.npmjs.org/unist-util-is/-/unist-util-is-6.0.1.tgz", + "integrity": "sha512-LsiILbtBETkDz8I9p1dQ0uyRUWuaQzd/cuEeS1hoRSyW5E5XGmTzlwY1OrNzzakGowI9Dr/I8HVaw4hTtnxy8g==", + "license": "MIT", + "dependencies": { + "@types/unist": "^3.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/unist-util-modify-children": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/unist-util-modify-children/-/unist-util-modify-children-4.0.0.tgz", + "integrity": "sha512-+tdN5fGNddvsQdIzUF3Xx82CU9sMM+fA0dLgR9vOmT0oPT2jH+P1nd5lSqfCfXAw+93NhcXNY2qqvTUtE4cQkw==", + "license": "MIT", + "dependencies": { + "@types/unist": "^3.0.0", + "array-iterate": "^2.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/unist-util-position": { + "version": "5.0.0", + "resolved": "https://registry.npmjs.org/unist-util-position/-/unist-util-position-5.0.0.tgz", + "integrity": "sha512-fucsC7HjXvkB5R3kTCO7kUjRdrS0BJt3M/FPxmHMBOm8JQi2BsHAHFsy27E0EolP8rp0NzXsJ+jNPyDWvOJZPA==", + "license": "MIT", + "dependencies": { + "@types/unist": "^3.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/unist-util-position-from-estree": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/unist-util-position-from-estree/-/unist-util-position-from-estree-2.0.0.tgz", + "integrity": "sha512-KaFVRjoqLyF6YXCbVLNad/eS4+OfPQQn2yOd7zF/h5T/CSL2v8NpN6a5TPvtbXthAGw5nG+PuTtq+DdIZr+cRQ==", + "license": "MIT", + "dependencies": { + "@types/unist": "^3.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/unist-util-remove": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/unist-util-remove/-/unist-util-remove-4.0.0.tgz", + "integrity": "sha512-b4gokeGId57UVRX/eVKej5gXqGlc9+trkORhFJpu9raqZkZhU0zm8Doi05+HaiBsMEIJowL+2WtQ5ItjsngPXg==", + "license": "MIT", + "dependencies": { + "@types/unist": "^3.0.0", + "unist-util-is": "^6.0.0", + "unist-util-visit-parents": "^6.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/unist-util-remove-position": { + "version": "5.0.0", + "resolved": "https://registry.npmjs.org/unist-util-remove-position/-/unist-util-remove-position-5.0.0.tgz", + "integrity": "sha512-Hp5Kh3wLxv0PHj9m2yZhhLt58KzPtEYKQQ4yxfYFEO7EvHwzyDYnduhHnY1mDxoqr7VUwVuHXk9RXKIiYS1N8Q==", + "license": "MIT", + "dependencies": { + "@types/unist": "^3.0.0", + "unist-util-visit": "^5.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/unist-util-stringify-position": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/unist-util-stringify-position/-/unist-util-stringify-position-4.0.0.tgz", + "integrity": "sha512-0ASV06AAoKCDkS2+xw5RXJywruurpbC4JZSm7nr7MOt1ojAzvyyaO+UxZf18j8FCF6kmzCZKcAgN/yu2gm2XgQ==", + "license": "MIT", + "dependencies": { + "@types/unist": "^3.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/unist-util-visit": { + "version": "5.0.0", + "resolved": "https://registry.npmjs.org/unist-util-visit/-/unist-util-visit-5.0.0.tgz", + "integrity": "sha512-MR04uvD+07cwl/yhVuVWAtw+3GOR/knlL55Nd/wAdblk27GCVt3lqpTivy/tkJcZoNPzTwS1Y+KMojlLDhoTzg==", + "license": "MIT", + "dependencies": { + "@types/unist": "^3.0.0", + "unist-util-is": "^6.0.0", + "unist-util-visit-parents": "^6.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/unist-util-visit-children": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/unist-util-visit-children/-/unist-util-visit-children-3.0.0.tgz", + "integrity": "sha512-RgmdTfSBOg04sdPcpTSD1jzoNBjt9a80/ZCzp5cI9n1qPzLZWF9YdvWGN2zmTumP1HWhXKdUWexjy/Wy/lJ7tA==", + "license": "MIT", + "dependencies": { + "@types/unist": "^3.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/unist-util-visit-parents": { + "version": "6.0.2", + "resolved": "https://registry.npmjs.org/unist-util-visit-parents/-/unist-util-visit-parents-6.0.2.tgz", + "integrity": "sha512-goh1s1TBrqSqukSc8wrjwWhL0hiJxgA8m4kFxGlQ+8FYQ3C/m11FcTs4YYem7V664AhHVvgoQLk890Ssdsr2IQ==", + "license": "MIT", + "dependencies": { + "@types/unist": "^3.0.0", + "unist-util-is": "^6.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/unstorage": { + "version": "1.17.3", + "resolved": "https://registry.npmjs.org/unstorage/-/unstorage-1.17.3.tgz", + "integrity": "sha512-i+JYyy0DoKmQ3FximTHbGadmIYb8JEpq7lxUjnjeB702bCPum0vzo6oy5Mfu0lpqISw7hCyMW2yj4nWC8bqJ3Q==", + "license": "MIT", + "dependencies": { + "anymatch": "^3.1.3", + "chokidar": "^4.0.3", + "destr": "^2.0.5", + "h3": "^1.15.4", + "lru-cache": "^10.4.3", + "node-fetch-native": "^1.6.7", + "ofetch": "^1.5.1", + "ufo": "^1.6.1" + }, + "peerDependencies": { + "@azure/app-configuration": "^1.8.0", + "@azure/cosmos": "^4.2.0", + "@azure/data-tables": "^13.3.0", + "@azure/identity": "^4.6.0", + "@azure/keyvault-secrets": "^4.9.0", + "@azure/storage-blob": "^12.26.0", + "@capacitor/preferences": "^6.0.3 || ^7.0.0", + "@deno/kv": ">=0.9.0", + "@netlify/blobs": "^6.5.0 || ^7.0.0 || ^8.1.0 || ^9.0.0 || ^10.0.0", + "@planetscale/database": "^1.19.0", + "@upstash/redis": "^1.34.3", + "@vercel/blob": ">=0.27.1", + "@vercel/functions": "^2.2.12 || ^3.0.0", + "@vercel/kv": "^1.0.1", + "aws4fetch": "^1.0.20", + "db0": ">=0.2.1", + "idb-keyval": "^6.2.1", + "ioredis": "^5.4.2", + "uploadthing": "^7.4.4" + }, + "peerDependenciesMeta": { + "@azure/app-configuration": { + "optional": true + }, + "@azure/cosmos": { + "optional": true + }, + "@azure/data-tables": { + "optional": true + }, + "@azure/identity": { + "optional": true + }, + "@azure/keyvault-secrets": { + "optional": true + }, + "@azure/storage-blob": { + "optional": true + }, + "@capacitor/preferences": { + "optional": true + }, + "@deno/kv": { + "optional": true + }, + "@netlify/blobs": { + "optional": true + }, + "@planetscale/database": { + "optional": true + }, + "@upstash/redis": { + "optional": true + }, + "@vercel/blob": { + "optional": true + }, + "@vercel/functions": { + "optional": true + }, + "@vercel/kv": { + "optional": true + }, + "aws4fetch": { + "optional": true + }, + "db0": { + "optional": true + }, + "idb-keyval": { + "optional": true + }, + "ioredis": { + "optional": true + }, + "uploadthing": { + "optional": true + } + } + }, + "node_modules/unstorage/node_modules/lru-cache": { + "version": "10.4.3", + "resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-10.4.3.tgz", + "integrity": "sha512-JNAzZcXrCt42VGLuYz0zfAzDfAvJWW6AfYlDBQyDV5DClI2m5sAmK+OIO7s59XfsRsWHp02jAJrRadPRGTt6SQ==", + "license": "ISC" + }, + "node_modules/update-browserslist-db": { + "version": "1.1.4", + "resolved": "https://registry.npmjs.org/update-browserslist-db/-/update-browserslist-db-1.1.4.tgz", + "integrity": "sha512-q0SPT4xyU84saUX+tomz1WLkxUbuaJnR1xWt17M7fJtEJigJeWUNGUqrauFXsHnqev9y9JTRGwk13tFBuKby4A==", + "funding": [ + { + "type": "opencollective", + "url": "https://opencollective.com/browserslist" + }, + { + "type": "tidelift", + "url": "https://tidelift.com/funding/github/npm/browserslist" + }, + { + "type": "github", + "url": "https://github.com/sponsors/ai" + } + ], + "license": "MIT", + "dependencies": { + "escalade": "^3.2.0", + "picocolors": "^1.1.1" + }, + "bin": { + "update-browserslist-db": "cli.js" + }, + "peerDependencies": { + "browserslist": ">= 4.21.0" + } + }, + "node_modules/util-deprecate": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/util-deprecate/-/util-deprecate-1.0.2.tgz", + "integrity": "sha512-EPD5q1uXyFxJpCrLnCc1nHnq3gOa6DZBocAIiI2TaSCA7VCJ1UJDMagCzIkXNsUYfD1daK//LTEQ8xiIbrHtcw==", + "license": "MIT" + }, + "node_modules/vfile": { + "version": "6.0.3", + "resolved": "https://registry.npmjs.org/vfile/-/vfile-6.0.3.tgz", + "integrity": "sha512-KzIbH/9tXat2u30jf+smMwFCsno4wHVdNmzFyL+T/L3UGqqk6JKfVqOFOZEpZSHADH1k40ab6NUIXZq422ov3Q==", + "license": "MIT", + "dependencies": { + "@types/unist": "^3.0.0", + "vfile-message": "^4.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/vfile-location": { + "version": "5.0.3", + "resolved": "https://registry.npmjs.org/vfile-location/-/vfile-location-5.0.3.tgz", + "integrity": "sha512-5yXvWDEgqeiYiBe1lbxYF7UMAIm/IcopxMHrMQDq3nvKcjPKIhZklUKL+AE7J7uApI4kwe2snsK+eI6UTj9EHg==", + "license": "MIT", + "dependencies": { + "@types/unist": "^3.0.0", + "vfile": "^6.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/vfile-message": { + "version": "4.0.3", + "resolved": "https://registry.npmjs.org/vfile-message/-/vfile-message-4.0.3.tgz", + "integrity": "sha512-QTHzsGd1EhbZs4AsQ20JX1rC3cOlt/IWJruk893DfLRr57lcnOeMaWG4K0JrRta4mIJZKth2Au3mM3u03/JWKw==", + "license": "MIT", + "dependencies": { + "@types/unist": "^3.0.0", + "unist-util-stringify-position": "^4.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/vite": { + "version": "6.4.1", + "resolved": "https://registry.npmjs.org/vite/-/vite-6.4.1.tgz", + "integrity": "sha512-+Oxm7q9hDoLMyJOYfUYBuHQo+dkAloi33apOPP56pzj+vsdJDzr+j1NISE5pyaAuKL4A3UD34qd0lx5+kfKp2g==", + "license": "MIT", + "peer": true, + "dependencies": { + "esbuild": "^0.25.0", + "fdir": "^6.4.4", + "picomatch": "^4.0.2", + "postcss": "^8.5.3", + "rollup": "^4.34.9", + "tinyglobby": "^0.2.13" + }, + "bin": { + "vite": "bin/vite.js" + }, + "engines": { + "node": "^18.0.0 || ^20.0.0 || >=22.0.0" + }, + "funding": { + "url": "https://github.com/vitejs/vite?sponsor=1" + }, + "optionalDependencies": { + "fsevents": "~2.3.3" + }, + "peerDependencies": { + "@types/node": "^18.0.0 || ^20.0.0 || >=22.0.0", + "jiti": ">=1.21.0", + "less": "*", + "lightningcss": "^1.21.0", + "sass": "*", + "sass-embedded": "*", + "stylus": "*", + "sugarss": "*", + "terser": "^5.16.0", + "tsx": "^4.8.1", + "yaml": "^2.4.2" + }, + "peerDependenciesMeta": { + "@types/node": { + "optional": true + }, + "jiti": { + "optional": true + }, + "less": { + "optional": true + }, + "lightningcss": { + "optional": true + }, + "sass": { + "optional": true + }, + "sass-embedded": { + "optional": true + }, + "stylus": { + "optional": true + }, + "sugarss": { + "optional": true + }, + "terser": { + "optional": true + }, + "tsx": { + "optional": true + }, + "yaml": { + "optional": true + } + } + }, + "node_modules/vitefu": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/vitefu/-/vitefu-1.1.1.tgz", + "integrity": "sha512-B/Fegf3i8zh0yFbpzZ21amWzHmuNlLlmJT6n7bu5e+pCHUKQIfXSYokrqOBGEMMe9UG2sostKQF9mml/vYaWJQ==", + "license": "MIT", + "workspaces": [ + "tests/deps/*", + "tests/projects/*", + "tests/projects/workspace/packages/*" + ], + "peerDependencies": { + "vite": "^3.0.0 || ^4.0.0 || ^5.0.0 || ^6.0.0 || ^7.0.0-beta.0" + }, + "peerDependenciesMeta": { + "vite": { + "optional": true + } + } + }, + "node_modules/volar-service-css": { + "version": "0.0.66", + "resolved": "https://registry.npmjs.org/volar-service-css/-/volar-service-css-0.0.66.tgz", + "integrity": "sha512-XrL1V9LEAHnunglYdDf/7shJbQXqKsHB+P69zPmJTqHx6hqvM9GWNbn2h7M0P/oElW8p/MTVHdfjl6C8cxdsBQ==", + "license": "MIT", + "dependencies": { + "vscode-css-languageservice": "^6.3.0", + "vscode-languageserver-textdocument": "^1.0.11", + "vscode-uri": "^3.0.8" + }, + "peerDependencies": { + "@volar/language-service": "~2.4.0" + }, + "peerDependenciesMeta": { + "@volar/language-service": { + "optional": true + } + } + }, + "node_modules/volar-service-emmet": { + "version": "0.0.66", + "resolved": "https://registry.npmjs.org/volar-service-emmet/-/volar-service-emmet-0.0.66.tgz", + "integrity": "sha512-BMPSpm6mk0DAEVdI2haxYIOt1Z2oaIZvCGtXuRu95x50a5pOSRPjdeHv2uGp1rQsq1Izigx+VR/bZUf2HcSnVQ==", + "license": "MIT", + "dependencies": { + "@emmetio/css-parser": "github:ramya-rao-a/css-parser#vscode", + "@emmetio/html-matcher": "^1.3.0", + "@vscode/emmet-helper": "^2.9.3", + "vscode-uri": "^3.0.8" + }, + "peerDependencies": { + "@volar/language-service": "~2.4.0" + }, + "peerDependenciesMeta": { + "@volar/language-service": { + "optional": true + } + } + }, + "node_modules/volar-service-html": { + "version": "0.0.66", + "resolved": "https://registry.npmjs.org/volar-service-html/-/volar-service-html-0.0.66.tgz", + "integrity": "sha512-MKKD2qM8qVZvBKBIugt00+Bm8j1ehgeX7Cm5XwgeEgdW/3PhUEEe/aeTxQGon1WJIGf2MM/cHPjZxPJOQN4WfQ==", + "license": "MIT", + "dependencies": { + "vscode-html-languageservice": "^5.3.0", + "vscode-languageserver-textdocument": "^1.0.11", + "vscode-uri": "^3.0.8" + }, + "peerDependencies": { + "@volar/language-service": "~2.4.0" + }, + "peerDependenciesMeta": { + "@volar/language-service": { + "optional": true + } + } + }, + "node_modules/volar-service-prettier": { + "version": "0.0.66", + "resolved": "https://registry.npmjs.org/volar-service-prettier/-/volar-service-prettier-0.0.66.tgz", + "integrity": "sha512-CVaQEyfmFWoq3NhNVExoyDKonPqdacmb/07w7OfTZljxLgZpDRygiHAvzBKIcenb7rKtJNHqfQJv99ULOinJBA==", + "license": "MIT", + "dependencies": { + "vscode-uri": "^3.0.8" + }, + "peerDependencies": { + "@volar/language-service": "~2.4.0", + "prettier": "^2.2 || ^3.0" + }, + "peerDependenciesMeta": { + "@volar/language-service": { + "optional": true + }, + "prettier": { + "optional": true + } + } + }, + "node_modules/volar-service-typescript": { + "version": "0.0.66", + "resolved": "https://registry.npmjs.org/volar-service-typescript/-/volar-service-typescript-0.0.66.tgz", + "integrity": "sha512-8irsfCEf86R1RqPijrU6p5NCqKDNzyJNWKM6ZXmCcJqhebtl7Hr/a0bnlr59AzqkS3Ym4PbbJZs1K/92CXTDsw==", + "license": "MIT", + "dependencies": { + "path-browserify": "^1.0.1", + "semver": "^7.6.2", + "typescript-auto-import-cache": "^0.3.5", + "vscode-languageserver-textdocument": "^1.0.11", + "vscode-nls": "^5.2.0", + "vscode-uri": "^3.0.8" + }, + "peerDependencies": { + "@volar/language-service": "~2.4.0" + }, + "peerDependenciesMeta": { + "@volar/language-service": { + "optional": true + } + } + }, + "node_modules/volar-service-typescript-twoslash-queries": { + "version": "0.0.66", + "resolved": "https://registry.npmjs.org/volar-service-typescript-twoslash-queries/-/volar-service-typescript-twoslash-queries-0.0.66.tgz", + "integrity": "sha512-PA3CyvEaBrkxJcBq+HFdks1TF1oJ8H+jTOTQUurLDRkVjmUFg8bfdya6U/dWfTsPaDSRM4m/2chwgew5zoQXfg==", + "license": "MIT", + "dependencies": { + "vscode-uri": "^3.0.8" + }, + "peerDependencies": { + "@volar/language-service": "~2.4.0" + }, + "peerDependenciesMeta": { + "@volar/language-service": { + "optional": true + } + } + }, + "node_modules/volar-service-typescript/node_modules/semver": { + "version": "7.7.3", + "resolved": "https://registry.npmjs.org/semver/-/semver-7.7.3.tgz", + "integrity": "sha512-SdsKMrI9TdgjdweUSR9MweHA4EJ8YxHn8DFaDisvhVlUOe4BF1tLD7GAj0lIqWVl+dPb/rExr0Btby5loQm20Q==", + "license": "ISC", + "bin": { + "semver": "bin/semver.js" + }, + "engines": { + "node": ">=10" + } + }, + "node_modules/volar-service-yaml": { + "version": "0.0.66", + "resolved": "https://registry.npmjs.org/volar-service-yaml/-/volar-service-yaml-0.0.66.tgz", + "integrity": "sha512-q6oTKD6EMEu1ws1FDjRw+cfCF69Gu51IEGM9jVbtmSZS1qQHKxMqlt2+wBInKl2D+xILtjzkWbfkjQyBYQMw7g==", + "license": "MIT", + "dependencies": { + "vscode-uri": "^3.0.8", + "yaml-language-server": "~1.19.2" + }, + "peerDependencies": { + "@volar/language-service": "~2.4.0" + }, + "peerDependenciesMeta": { + "@volar/language-service": { + "optional": true + } + } + }, + "node_modules/vscode-css-languageservice": { + "version": "6.3.8", + "resolved": "https://registry.npmjs.org/vscode-css-languageservice/-/vscode-css-languageservice-6.3.8.tgz", + "integrity": "sha512-dBk/9ullEjIMbfSYAohGpDOisOVU1x2MQHOeU12ohGJQI7+r0PCimBwaa/pWpxl/vH4f7ibrBfxIZY3anGmHKQ==", + "license": "MIT", + "dependencies": { + "@vscode/l10n": "^0.0.18", + "vscode-languageserver-textdocument": "^1.0.12", + "vscode-languageserver-types": "3.17.5", + "vscode-uri": "^3.1.0" + } + }, + "node_modules/vscode-html-languageservice": { + "version": "5.6.0", + "resolved": "https://registry.npmjs.org/vscode-html-languageservice/-/vscode-html-languageservice-5.6.0.tgz", + "integrity": "sha512-FIVz83oGw2tBkOr8gQPeiREInnineCKGCz3ZD1Pi6opOuX3nSRkc4y4zLLWsuop+6ttYX//XZCI6SLzGhRzLmA==", + "license": "MIT", + "dependencies": { + "@vscode/l10n": "^0.0.18", + "vscode-languageserver-textdocument": "^1.0.12", + "vscode-languageserver-types": "^3.17.5", + "vscode-uri": "^3.1.0" + } + }, + "node_modules/vscode-json-languageservice": { + "version": "4.1.8", + "resolved": "https://registry.npmjs.org/vscode-json-languageservice/-/vscode-json-languageservice-4.1.8.tgz", + "integrity": "sha512-0vSpg6Xd9hfV+eZAaYN63xVVMOTmJ4GgHxXnkLCh+9RsQBkWKIghzLhW2B9ebfG+LQQg8uLtsQ2aUKjTgE+QOg==", + "license": "MIT", + "dependencies": { + "jsonc-parser": "^3.0.0", + "vscode-languageserver-textdocument": "^1.0.1", + "vscode-languageserver-types": "^3.16.0", + "vscode-nls": "^5.0.0", + "vscode-uri": "^3.0.2" + }, + "engines": { + "npm": ">=7.0.0" + } + }, + "node_modules/vscode-json-languageservice/node_modules/jsonc-parser": { + "version": "3.3.1", + "resolved": "https://registry.npmjs.org/jsonc-parser/-/jsonc-parser-3.3.1.tgz", + "integrity": "sha512-HUgH65KyejrUFPvHFPbqOY0rsFip3Bo5wb4ngvdi1EpCYWUQDC5V+Y7mZws+DLkr4M//zQJoanu1SP+87Dv1oQ==", + "license": "MIT" + }, + "node_modules/vscode-jsonrpc": { + "version": "8.2.0", + "resolved": "https://registry.npmjs.org/vscode-jsonrpc/-/vscode-jsonrpc-8.2.0.tgz", + "integrity": "sha512-C+r0eKJUIfiDIfwJhria30+TYWPtuHJXHtI7J0YlOmKAo7ogxP20T0zxB7HZQIFhIyvoBPwWskjxrvAtfjyZfA==", + "license": "MIT", + "engines": { + "node": ">=14.0.0" + } + }, + "node_modules/vscode-languageserver": { + "version": "9.0.1", + "resolved": "https://registry.npmjs.org/vscode-languageserver/-/vscode-languageserver-9.0.1.tgz", + "integrity": "sha512-woByF3PDpkHFUreUa7Hos7+pUWdeWMXRd26+ZX2A8cFx6v/JPTtd4/uN0/jB6XQHYaOlHbio03NTHCqrgG5n7g==", + "license": "MIT", + "dependencies": { + "vscode-languageserver-protocol": "3.17.5" + }, + "bin": { + "installServerIntoExtension": "bin/installServerIntoExtension" + } + }, + "node_modules/vscode-languageserver-protocol": { + "version": "3.17.5", + "resolved": "https://registry.npmjs.org/vscode-languageserver-protocol/-/vscode-languageserver-protocol-3.17.5.tgz", + "integrity": "sha512-mb1bvRJN8SVznADSGWM9u/b07H7Ecg0I3OgXDuLdn307rl/J3A9YD6/eYOssqhecL27hK1IPZAsaqh00i/Jljg==", + "license": "MIT", + "dependencies": { + "vscode-jsonrpc": "8.2.0", + "vscode-languageserver-types": "3.17.5" + } + }, + "node_modules/vscode-languageserver-textdocument": { + "version": "1.0.12", + "resolved": "https://registry.npmjs.org/vscode-languageserver-textdocument/-/vscode-languageserver-textdocument-1.0.12.tgz", + "integrity": "sha512-cxWNPesCnQCcMPeenjKKsOCKQZ/L6Tv19DTRIGuLWe32lyzWhihGVJ/rcckZXJxfdKCFvRLS3fpBIsV/ZGX4zA==", + "license": "MIT" + }, + "node_modules/vscode-languageserver-types": { + "version": "3.17.5", + "resolved": "https://registry.npmjs.org/vscode-languageserver-types/-/vscode-languageserver-types-3.17.5.tgz", + "integrity": "sha512-Ld1VelNuX9pdF39h2Hgaeb5hEZM2Z3jUrrMgWQAu82jMtZp7p3vJT3BzToKtZI7NgQssZje5o0zryOrhQvzQAg==", + "license": "MIT" + }, + "node_modules/vscode-nls": { + "version": "5.2.0", + "resolved": "https://registry.npmjs.org/vscode-nls/-/vscode-nls-5.2.0.tgz", + "integrity": "sha512-RAaHx7B14ZU04EU31pT+rKz2/zSl7xMsfIZuo8pd+KZO6PXtQmpevpq3vxvWNcrGbdmhM/rr5Uw5Mz+NBfhVng==", + "license": "MIT" + }, + "node_modules/vscode-uri": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/vscode-uri/-/vscode-uri-3.1.0.tgz", + "integrity": "sha512-/BpdSx+yCQGnCvecbyXdxHDkuk55/G3xwnC0GqY4gmQ3j+A+g8kzzgB4Nk/SINjqn6+waqw3EgbVF2QKExkRxQ==", + "license": "MIT" + }, + "node_modules/web-namespaces": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/web-namespaces/-/web-namespaces-2.0.1.tgz", + "integrity": "sha512-bKr1DkiNa2krS7qxNtdrtHAmzuYGFQLiQ13TsorsdT6ULTkPLKuu5+GsFpDlg6JFjUTwX2DyhMPG2be8uPrqsQ==", + "license": "MIT", + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, + "node_modules/which-pm-runs": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/which-pm-runs/-/which-pm-runs-1.1.0.tgz", + "integrity": "sha512-n1brCuqClxfFfq/Rb0ICg9giSZqCS+pLtccdag6C2HyufBrh3fBOiy9nb6ggRMvWOVH5GrdJskj5iGTZNxd7SA==", + "license": "MIT", + "engines": { + "node": ">=4" + } + }, + "node_modules/widest-line": { + "version": "5.0.0", + "resolved": "https://registry.npmjs.org/widest-line/-/widest-line-5.0.0.tgz", + "integrity": "sha512-c9bZp7b5YtRj2wOe6dlj32MK+Bx/M/d+9VB2SHM1OtsUHR0aV0tdP6DWh/iMt0kWi1t5g1Iudu6hQRNd1A4PVA==", + "license": "MIT", + "dependencies": { + "string-width": "^7.0.0" + }, + "engines": { + "node": ">=18" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/wrap-ansi": { + "version": "9.0.2", + "resolved": "https://registry.npmjs.org/wrap-ansi/-/wrap-ansi-9.0.2.tgz", + "integrity": "sha512-42AtmgqjV+X1VpdOfyTGOYRi0/zsoLqtXQckTmqTeybT+BDIbM/Guxo7x3pE2vtpr1ok6xRqM9OpBe+Jyoqyww==", + "license": "MIT", + "dependencies": { + "ansi-styles": "^6.2.1", + "string-width": "^7.0.0", + "strip-ansi": "^7.1.0" + }, + "engines": { + "node": ">=18" + }, + "funding": { + "url": "https://github.com/chalk/wrap-ansi?sponsor=1" + } + }, + "node_modules/xxhash-wasm": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/xxhash-wasm/-/xxhash-wasm-1.1.0.tgz", + "integrity": "sha512-147y/6YNh+tlp6nd/2pWq38i9h6mz/EuQ6njIrmW8D1BS5nCqs0P6DG+m6zTGnNz5I+uhZ0SHxBs9BsPrwcKDA==", + "license": "MIT" + }, + "node_modules/y18n": { + "version": "5.0.8", + "resolved": "https://registry.npmjs.org/y18n/-/y18n-5.0.8.tgz", + "integrity": "sha512-0pfFzegeDWJHJIAmTLRP2DwHjdF5s7jo9tuztdQxAhINCdvS+3nGINqPd00AphqJR/0LhANUS6/+7SCb98YOfA==", + "license": "ISC", + "engines": { + "node": ">=10" + } + }, + "node_modules/yallist": { + "version": "3.1.1", + "resolved": "https://registry.npmjs.org/yallist/-/yallist-3.1.1.tgz", + "integrity": "sha512-a4UGQaWPH59mOXUYnAG2ewncQS4i4F43Tv3JoAM+s2VDAmS9NsK8GpDMLrCHPksFT7h3K6TOoUNn2pb7RoXx4g==", + "license": "ISC" + }, + "node_modules/yaml": { + "version": "2.8.1", + "resolved": "https://registry.npmjs.org/yaml/-/yaml-2.8.1.tgz", + "integrity": "sha512-lcYcMxX2PO9XMGvAJkJ3OsNMw+/7FKes7/hgerGUYWIoWu5j/+YQqcZr5JnPZWzOsEBgMbSbiSTn/dv/69Mkpw==", + "license": "ISC", + "bin": { + "yaml": "bin.mjs" + }, + "engines": { + "node": ">= 14.6" + } + }, + "node_modules/yaml-language-server": { + "version": "1.19.2", + "resolved": "https://registry.npmjs.org/yaml-language-server/-/yaml-language-server-1.19.2.tgz", + "integrity": "sha512-9F3myNmJzUN/679jycdMxqtydPSDRAarSj3wPiF7pchEPnO9Dg07Oc+gIYLqXR4L+g+FSEVXXv2+mr54StLFOg==", + "license": "MIT", + "dependencies": { + "@vscode/l10n": "^0.0.18", + "ajv": "^8.17.1", + "ajv-draft-04": "^1.0.0", + "lodash": "4.17.21", + "prettier": "^3.5.0", + "request-light": "^0.5.7", + "vscode-json-languageservice": "4.1.8", + "vscode-languageserver": "^9.0.0", + "vscode-languageserver-textdocument": "^1.0.1", + "vscode-languageserver-types": "^3.16.0", + "vscode-uri": "^3.0.2", + "yaml": "2.7.1" + }, + "bin": { + "yaml-language-server": "bin/yaml-language-server" + } + }, + "node_modules/yaml-language-server/node_modules/request-light": { + "version": "0.5.8", + "resolved": "https://registry.npmjs.org/request-light/-/request-light-0.5.8.tgz", + "integrity": "sha512-3Zjgh+8b5fhRJBQZoy+zbVKpAQGLyka0MPgW3zruTF4dFFJ8Fqcfu9YsAvi/rvdcaTeWG3MkbZv4WKxAn/84Lg==", + "license": "MIT" + }, + "node_modules/yaml-language-server/node_modules/yaml": { + "version": "2.7.1", + "resolved": "https://registry.npmjs.org/yaml/-/yaml-2.7.1.tgz", + "integrity": "sha512-10ULxpnOCQXxJvBgxsn9ptjq6uviG/htZKk9veJGhlqn3w/DxQ631zFF+nlQXLwmImeS5amR2dl2U8sg6U9jsQ==", + "license": "ISC", + "bin": { + "yaml": "bin.mjs" + }, + "engines": { + "node": ">= 14" + } + }, + "node_modules/yargs": { + "version": "17.7.2", + "resolved": "https://registry.npmjs.org/yargs/-/yargs-17.7.2.tgz", + "integrity": "sha512-7dSzzRQ++CKnNI/krKnYRV7JKKPUXMEh61soaHKg9mrWEhzFWhFnxPxGl+69cD1Ou63C13NUPCnmIcrvqCuM6w==", + "license": "MIT", + "dependencies": { + "cliui": "^8.0.1", + "escalade": "^3.1.1", + "get-caller-file": "^2.0.5", + "require-directory": "^2.1.1", + "string-width": "^4.2.3", + "y18n": "^5.0.5", + "yargs-parser": "^21.1.1" + }, + "engines": { + "node": ">=12" + } + }, + "node_modules/yargs-parser": { + "version": "21.1.1", + "resolved": "https://registry.npmjs.org/yargs-parser/-/yargs-parser-21.1.1.tgz", + "integrity": "sha512-tVpsJW7DdjecAiFpbIB1e3qxIQsE6NoPc5/eTdrbbIC4h0LVsWhnoa3g+m2HclBIujHzsxZ4VJVA+GUuc2/LBw==", + "license": "ISC", + "engines": { + "node": ">=12" + } + }, + "node_modules/yargs/node_modules/ansi-regex": { + "version": "5.0.1", + "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-5.0.1.tgz", + "integrity": "sha512-quJQXlTSUGL2LH9SUXo8VwsY4soanhgo6LNSm84E1LBcE8s3O0wpdiRzyR9z/ZZJMlMWv37qOOb9pdJlMUEKFQ==", + "license": "MIT", + "engines": { + "node": ">=8" + } + }, + "node_modules/yargs/node_modules/emoji-regex": { + "version": "8.0.0", + "resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-8.0.0.tgz", + "integrity": "sha512-MSjYzcWNOA0ewAHpz0MxpYFvwg6yjy1NG3xteoqz644VCo/RPgnr1/GGt+ic3iJTzQ8Eu3TdM14SawnVUmGE6A==", + "license": "MIT" + }, + "node_modules/yargs/node_modules/string-width": { + "version": "4.2.3", + "resolved": "https://registry.npmjs.org/string-width/-/string-width-4.2.3.tgz", + "integrity": "sha512-wKyQRQpjJ0sIp62ErSZdGsjMJWsap5oRNihHhu6G7JVO/9jIB6UyevL+tXuOqrng8j/cxKTWyWUwvSTriiZz/g==", + "license": "MIT", + "dependencies": { + "emoji-regex": "^8.0.0", + "is-fullwidth-code-point": "^3.0.0", + "strip-ansi": "^6.0.1" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/yargs/node_modules/strip-ansi": { + "version": "6.0.1", + "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-6.0.1.tgz", + "integrity": "sha512-Y38VPSHcqkFrCpFnQ9vuSXmquuv5oXOKpGeT6aGrr3o3Gc9AlVa6JBfUSOCnbxGGZF+/0ooI7KrPuUSztUdU5A==", + "license": "MIT", + "dependencies": { + "ansi-regex": "^5.0.1" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/yocto-queue": { + "version": "1.2.2", + "resolved": "https://registry.npmjs.org/yocto-queue/-/yocto-queue-1.2.2.tgz", + "integrity": "sha512-4LCcse/U2MHZ63HAJVE+v71o7yOdIe4cZ70Wpf8D/IyjDKYQLV5GD46B+hSTjJsvV5PztjvHoU580EftxjDZFQ==", + "license": "MIT", + "engines": { + "node": ">=12.20" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/yocto-spinner": { + "version": "0.2.3", + "resolved": "https://registry.npmjs.org/yocto-spinner/-/yocto-spinner-0.2.3.tgz", + "integrity": "sha512-sqBChb33loEnkoXte1bLg45bEBsOP9N1kzQh5JZNKj/0rik4zAPTNSAVPj3uQAdc6slYJ0Ksc403G2XgxsJQFQ==", + "license": "MIT", + "dependencies": { + "yoctocolors": "^2.1.1" + }, + "engines": { + "node": ">=18.19" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/yoctocolors": { + "version": "2.1.2", + "resolved": "https://registry.npmjs.org/yoctocolors/-/yoctocolors-2.1.2.tgz", + "integrity": "sha512-CzhO+pFNo8ajLM2d2IW/R93ipy99LWjtwblvC1RsoSUMZgyLbYFr221TnSNT7GjGdYui6P459mw9JH/g/zW2ug==", + "license": "MIT", + "engines": { + "node": ">=18" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/zod": { + "version": "3.25.76", + "resolved": "https://registry.npmjs.org/zod/-/zod-3.25.76.tgz", + "integrity": "sha512-gzUt/qt81nXsFGKIFcC3YnfEAx5NkunCfnDlvuBSSFS02bcXu4Lmea0AFIUwbLWxWPx3d9p8S5QoaujKcNQxcQ==", + "license": "MIT", + "peer": true, + "funding": { + "url": "https://github.com/sponsors/colinhacks" + } + }, + "node_modules/zod-to-json-schema": { + "version": "3.25.0", + "resolved": "https://registry.npmjs.org/zod-to-json-schema/-/zod-to-json-schema-3.25.0.tgz", + "integrity": "sha512-HvWtU2UG41LALjajJrML6uQejQhNJx+JBO9IflpSja4R03iNWfKXrj6W2h7ljuLyc1nKS+9yDyL/9tD1U/yBnQ==", + "license": "ISC", + "peerDependencies": { + "zod": "^3.25 || ^4" + } + }, + "node_modules/zod-to-ts": { + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/zod-to-ts/-/zod-to-ts-1.2.0.tgz", + "integrity": "sha512-x30XE43V+InwGpvTySRNz9kB7qFU8DlyEy7BsSTCHPH1R0QasMmHWZDCzYm6bVXtj/9NNJAZF3jW8rzFvH5OFA==", + "peerDependencies": { + "typescript": "^4.9.4 || ^5.0.2", + "zod": "^3" + } + }, + "node_modules/zwitch": { + "version": "2.0.4", + "resolved": "https://registry.npmjs.org/zwitch/-/zwitch-2.0.4.tgz", + "integrity": "sha512-bXE4cR/kVZhKZX/RjPEflHaKVhUVl85noU3v6b8apfQEc1x4A+zBxjZ4lN8LqGd6WZ3dl98pY4o717VFmoPp+A==", + "license": "MIT", + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + } + } +} diff --git a/docs/package.json b/docs/package.json new file mode 100644 index 000000000..773d51419 --- /dev/null +++ b/docs/package.json @@ -0,0 +1,31 @@ +{ + "name": "wails-docs", + "type": "module", + "version": "0.0.1", + "scripts": { + "dev": "astro dev", + "start": "astro dev", + "build": "astro check && astro build", + "preview": "astro preview", + "astro": "astro" + }, + "dependencies": { + "@astrojs/check": "^0.9.4", + "@astrojs/react": "^4.1.0", + "@astrojs/starlight": "0.36.2", + "@types/react": "^19.0.1", + "@types/react-dom": "^19.0.2", + "astro": "^5.0.0", + "astro-d2": "^0.5.0", + "framer-motion": "^11.14.4", + "motion": "^11.14.4", + "react": "^19.0.0", + "react-dom": "^19.0.0", + "sharp": "^0.33.5", + "starlight-blog": "0.25.1", + "starlight-image-zoom": "^0.9.0", + "starlight-links-validator": "^0.13.4", + "starlight-showcases": "^0.2.0", + "typescript": "^5.7.2" + } +} diff --git a/docs/public/d2/docs/DEVELOPER_GUIDE-0.svg b/docs/public/d2/docs/DEVELOPER_GUIDE-0.svg new file mode 100644 index 000000000..a9b379378 --- /dev/null +++ b/docs/public/d2/docs/DEVELOPER_GUIDE-0.svg @@ -0,0 +1,188 @@ +DeveloperCLI Layer(cmd/wails3)Command Handlers(internal/commands)Task Runner(internal/commands/task.go)Taskfile(v3/Taskfile.yaml)Build/Packaging(internal/*)Templates(internal/templates)Runtime Assets(internal/runtime)Application Core(pkg/application)Asset Server(internal/assetserver)Message Processor(pkg/application/messageprocessor*.go)WebView Implementations(pkg/application/webview_window_*.go)Services & Bindings(pkg/services/*)Platform Layers(pkg/mac, pkg/w32, pkg/events, pkg/ui) runs wails3registers subcommandswraps build/package/devexecutes tasksinvokes packagers & generatorsrenders scaffoldsbuilds runtime JSembedded assetsserves HTTProutes runtime callsbridge over WebViewbinds Go servicesdispatches to OSfeeds frontendexpose methods + + + + + + + + + + + + + + + + + diff --git a/docs/public/d2/docs/DEVELOPER_GUIDE-1.svg b/docs/public/d2/docs/DEVELOPER_GUIDE-1.svg new file mode 100644 index 000000000..ae97cb156 --- /dev/null +++ b/docs/public/d2/docs/DEVELOPER_GUIDE-1.svg @@ -0,0 +1,181 @@ +App.Run dispatch hubapplicationEventsEventManagerwindowEventsWindowswebviewRequestsAssetServerwindowMessagesMessageHandlerswindowKeyEventsKeyBindingdragDropBuffermenuItemClickedMenuManager goroutineEvent.handleApplicationEventgoroutinehandleWindowEventServeWebViewRequestHandleMessage / RawMessageHandlerHandleKeyEventHandleDragAndDrop + + + + + + + + + + diff --git a/docs/public/favicon.svg b/docs/public/favicon.svg new file mode 100644 index 000000000..e682e4453 --- /dev/null +++ b/docs/public/favicon.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/docs/public/missing.png b/docs/public/missing.png new file mode 100644 index 000000000..05d2bafc3 Binary files /dev/null and b/docs/public/missing.png differ diff --git a/docs/public/showcase-images/bboard.webp b/docs/public/showcase-images/bboard.webp new file mode 100644 index 000000000..463d25de0 Binary files /dev/null and b/docs/public/showcase-images/bboard.webp differ diff --git a/docs/public/showcase-images/cfntracker.webp b/docs/public/showcase-images/cfntracker.webp new file mode 100644 index 000000000..6a2288a5c Binary files /dev/null and b/docs/public/showcase-images/cfntracker.webp differ diff --git a/docs/public/showcase-images/edex-ui.webp b/docs/public/showcase-images/edex-ui.webp new file mode 100644 index 000000000..110ca1acf Binary files /dev/null and b/docs/public/showcase-images/edex-ui.webp differ diff --git a/docs/public/showcase-images/emailit.webp b/docs/public/showcase-images/emailit.webp new file mode 100644 index 000000000..fc1b9a51a Binary files /dev/null and b/docs/public/showcase-images/emailit.webp differ diff --git a/docs/public/showcase-images/encrypteasy.webp b/docs/public/showcase-images/encrypteasy.webp new file mode 100644 index 000000000..c0789a3e3 Binary files /dev/null and b/docs/public/showcase-images/encrypteasy.webp differ diff --git a/docs/public/showcase-images/filehound.webp b/docs/public/showcase-images/filehound.webp new file mode 100644 index 000000000..92769ca8e Binary files /dev/null and b/docs/public/showcase-images/filehound.webp differ diff --git a/website/static/img/showcase/gamestacker.webp b/docs/public/showcase-images/gamestacker.webp similarity index 100% rename from website/static/img/showcase/gamestacker.webp rename to docs/public/showcase-images/gamestacker.webp diff --git a/docs/public/showcase-images/hiposter.webp b/docs/public/showcase-images/hiposter.webp new file mode 100644 index 000000000..7c7510ea1 Binary files /dev/null and b/docs/public/showcase-images/hiposter.webp differ diff --git a/docs/public/showcase-images/mchat.webp b/docs/public/showcase-images/mchat.webp new file mode 100644 index 000000000..393b6f77b Binary files /dev/null and b/docs/public/showcase-images/mchat.webp differ diff --git a/docs/public/showcase-images/minecraft-mod-updater.webp b/docs/public/showcase-images/minecraft-mod-updater.webp new file mode 100644 index 000000000..c8e011cf3 Binary files /dev/null and b/docs/public/showcase-images/minecraft-mod-updater.webp differ diff --git a/docs/public/showcase-images/minesweeper-xp.webp b/docs/public/showcase-images/minesweeper-xp.webp new file mode 100644 index 000000000..b3c5ca26b Binary files /dev/null and b/docs/public/showcase-images/minesweeper-xp.webp differ diff --git a/docs/public/showcase-images/modalfilemanager.webp b/docs/public/showcase-images/modalfilemanager.webp new file mode 100644 index 000000000..2fdf219fc Binary files /dev/null and b/docs/public/showcase-images/modalfilemanager.webp differ diff --git a/docs/public/showcase-images/mollywallet.webp b/docs/public/showcase-images/mollywallet.webp new file mode 100644 index 000000000..11641f8ca Binary files /dev/null and b/docs/public/showcase-images/mollywallet.webp differ diff --git a/docs/public/showcase-images/october.webp b/docs/public/showcase-images/october.webp new file mode 100644 index 000000000..ceec1c573 Binary files /dev/null and b/docs/public/showcase-images/october.webp differ diff --git a/docs/public/showcase-images/optimus.webp b/docs/public/showcase-images/optimus.webp new file mode 100644 index 000000000..0aac84058 Binary files /dev/null and b/docs/public/showcase-images/optimus.webp differ diff --git a/docs/public/showcase-images/portfall.webp b/docs/public/showcase-images/portfall.webp new file mode 100644 index 000000000..12f8d6e5b Binary files /dev/null and b/docs/public/showcase-images/portfall.webp differ diff --git a/docs/public/showcase-images/resizem.webp b/docs/public/showcase-images/resizem.webp new file mode 100644 index 000000000..aaee1c806 Binary files /dev/null and b/docs/public/showcase-images/resizem.webp differ diff --git a/docs/public/showcase-images/riftshare-main.webp b/docs/public/showcase-images/riftshare-main.webp new file mode 100644 index 000000000..2d6a8fb3a Binary files /dev/null and b/docs/public/showcase-images/riftshare-main.webp differ diff --git a/docs/public/showcase-images/scriptbar.webp b/docs/public/showcase-images/scriptbar.webp new file mode 100644 index 000000000..92463fdb9 Binary files /dev/null and b/docs/public/showcase-images/scriptbar.webp differ diff --git a/docs/public/showcase-images/tiny-rdm1.webp b/docs/public/showcase-images/tiny-rdm1.webp new file mode 100644 index 000000000..11b375580 Binary files /dev/null and b/docs/public/showcase-images/tiny-rdm1.webp differ diff --git a/docs/public/showcase-images/tiny-rdm2.webp b/docs/public/showcase-images/tiny-rdm2.webp new file mode 100644 index 000000000..9de730fb4 Binary files /dev/null and b/docs/public/showcase-images/tiny-rdm2.webp differ diff --git a/docs/public/showcase-images/varly2.webp b/docs/public/showcase-images/varly2.webp new file mode 100644 index 000000000..6dbe0c9bf Binary files /dev/null and b/docs/public/showcase-images/varly2.webp differ diff --git a/docs/public/showcase-images/wailsterm.webp b/docs/public/showcase-images/wailsterm.webp new file mode 100644 index 000000000..6d4251a75 Binary files /dev/null and b/docs/public/showcase-images/wailsterm.webp differ diff --git a/docs/public/showcase-images/wally.webp b/docs/public/showcase-images/wally.webp new file mode 100644 index 000000000..150c98c74 Binary files /dev/null and b/docs/public/showcase-images/wally.webp differ diff --git a/docs/public/showcase-images/wombat.webp b/docs/public/showcase-images/wombat.webp new file mode 100644 index 000000000..97f965834 Binary files /dev/null and b/docs/public/showcase-images/wombat.webp differ diff --git a/docs/public/showcase-images/ytd.webp b/docs/public/showcase-images/ytd.webp new file mode 100644 index 000000000..c7988cee5 Binary files /dev/null and b/docs/public/showcase-images/ytd.webp differ diff --git a/docs/public/sponsors/jetbrains-grayscale.webp b/docs/public/sponsors/jetbrains-grayscale.webp new file mode 100644 index 000000000..be39c4856 Binary files /dev/null and b/docs/public/sponsors/jetbrains-grayscale.webp differ diff --git a/docs/public/sponsors/sponsors.svg b/docs/public/sponsors/sponsors.svg new file mode 100644 index 000000000..1a9985e59 --- /dev/null +++ b/docs/public/sponsors/sponsors.svg @@ -0,0 +1,197 @@ + + + + +Champion + Masato Miura + +Bronze Sponsors + Cody Bentley + + + + Kazuya Gokita + + + + Simon Thomas + + + + CodeRabbit + +Covering Costs + Nick + + + + Marcus + + + + John + + + + Matt Holt + + + + Iain + + + + Julien + + + + Andrei + + + + Michael + +Buying Breakfast + tc-hib + + + + Tai Groot + + + + Tom Wu + + + + Arden + + + + igops + + + + vaaski + +Buying Coffee + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +Helpers + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/public/sponsors/zsa.png b/docs/public/sponsors/zsa.png new file mode 100644 index 000000000..507e983fa Binary files /dev/null and b/docs/public/sponsors/zsa.png differ diff --git a/docs/src/assets/blog-images/browser.webp b/docs/src/assets/blog-images/browser.webp new file mode 100644 index 000000000..a19d5b036 Binary files /dev/null and b/docs/src/assets/blog-images/browser.webp differ diff --git a/docs/src/assets/blog-images/build-cross-windows.webp b/docs/src/assets/blog-images/build-cross-windows.webp new file mode 100644 index 000000000..ba1a538f6 Binary files /dev/null and b/docs/src/assets/blog-images/build-cross-windows.webp differ diff --git a/docs/src/assets/blog-images/build-darwin-amd.webp b/docs/src/assets/blog-images/build-darwin-amd.webp new file mode 100644 index 000000000..6126129ca Binary files /dev/null and b/docs/src/assets/blog-images/build-darwin-amd.webp differ diff --git a/docs/src/assets/blog-images/build-darwin-arm.webp b/docs/src/assets/blog-images/build-darwin-arm.webp new file mode 100644 index 000000000..47fcf4583 Binary files /dev/null and b/docs/src/assets/blog-images/build-darwin-arm.webp differ diff --git a/docs/src/assets/blog-images/build-darwin-universal.webp b/docs/src/assets/blog-images/build-darwin-universal.webp new file mode 100644 index 000000000..c95d92ccb Binary files /dev/null and b/docs/src/assets/blog-images/build-darwin-universal.webp differ diff --git a/docs/src/assets/blog-images/devtools.png b/docs/src/assets/blog-images/devtools.png new file mode 100644 index 000000000..e56a0d304 Binary files /dev/null and b/docs/src/assets/blog-images/devtools.png differ diff --git a/docs/src/assets/blog-images/linux-build-cross-windows.webp b/docs/src/assets/blog-images/linux-build-cross-windows.webp new file mode 100644 index 000000000..cbed7585b Binary files /dev/null and b/docs/src/assets/blog-images/linux-build-cross-windows.webp differ diff --git a/docs/src/assets/blog-images/montage.png b/docs/src/assets/blog-images/montage.png new file mode 100644 index 000000000..ddd771851 Binary files /dev/null and b/docs/src/assets/blog-images/montage.png differ diff --git a/docs/src/assets/blog-images/multiwindow.webp b/docs/src/assets/blog-images/multiwindow.webp new file mode 100644 index 000000000..746a1d7f2 Binary files /dev/null and b/docs/src/assets/blog-images/multiwindow.webp differ diff --git a/docs/src/assets/blog-images/remote-linux.webp b/docs/src/assets/blog-images/remote-linux.webp new file mode 100644 index 000000000..25ad11ea3 Binary files /dev/null and b/docs/src/assets/blog-images/remote-linux.webp differ diff --git a/docs/src/assets/blog-images/remote-mac.webp b/docs/src/assets/blog-images/remote-mac.webp new file mode 100644 index 000000000..bf4758e1a Binary files /dev/null and b/docs/src/assets/blog-images/remote-mac.webp differ diff --git a/docs/src/assets/blog-images/remote.webp b/docs/src/assets/blog-images/remote.webp new file mode 100644 index 000000000..3968c5ddc Binary files /dev/null and b/docs/src/assets/blog-images/remote.webp differ diff --git a/docs/src/assets/blog-images/vscode.webp b/docs/src/assets/blog-images/vscode.webp new file mode 100644 index 000000000..156fa3078 Binary files /dev/null and b/docs/src/assets/blog-images/vscode.webp differ diff --git a/docs/src/assets/blog-images/wails-linux.webp b/docs/src/assets/blog-images/wails-linux.webp new file mode 100644 index 000000000..45c76ed0e Binary files /dev/null and b/docs/src/assets/blog-images/wails-linux.webp differ diff --git a/docs/src/assets/blog-images/wails-mac.webp b/docs/src/assets/blog-images/wails-mac.webp new file mode 100644 index 000000000..26ee0be13 Binary files /dev/null and b/docs/src/assets/blog-images/wails-mac.webp differ diff --git a/docs/src/assets/blog-images/wails-menus-linux.webp b/docs/src/assets/blog-images/wails-menus-linux.webp new file mode 100644 index 000000000..391225a35 Binary files /dev/null and b/docs/src/assets/blog-images/wails-menus-linux.webp differ diff --git a/docs/src/assets/blog-images/wails-menus-mac.webp b/docs/src/assets/blog-images/wails-menus-mac.webp new file mode 100644 index 000000000..033f68d35 Binary files /dev/null and b/docs/src/assets/blog-images/wails-menus-mac.webp differ diff --git a/docs/src/assets/blog-images/wails-menus.webp b/docs/src/assets/blog-images/wails-menus.webp new file mode 100644 index 000000000..ba64152b4 Binary files /dev/null and b/docs/src/assets/blog-images/wails-menus.webp differ diff --git a/docs/src/assets/blog-images/wails.webp b/docs/src/assets/blog-images/wails.webp new file mode 100644 index 000000000..777f4d05c Binary files /dev/null and b/docs/src/assets/blog-images/wails.webp differ diff --git a/docs/src/assets/contributors.html b/docs/src/assets/contributors.html new file mode 100644 index 000000000..465a64801 --- /dev/null +++ b/docs/src/assets/contributors.html @@ -0,0 +1,246 @@ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Lea Anthony
Lea Anthony

💻 🤔 🎨 🖋 💡 🧑‍🏫 📆 🔧 🐛 📝 🚧 📦 👀 💬 🔬 ⚠️ 📢 👀 📖
stffabi
stffabi

💻 🤔 🎨 🐛 🚧 📦 👀 💬 🔬 👀 📖 ⚠️
Travis McLane
Travis McLane

💻 🔬 📦 🤔 🐛 👀 ⚠️ 💬 📖
Misite Bao
Misite Bao

📖 🌍 🔬 🚧
Byron Chris
Byron Chris

💻 🔬 🚧 🐛 👀 ⚠️ 💬 🤔 🎨 📦 🚇
konez2k
konez2k

💻 📦 🤔
Dario Emerson
Dario Emerson

💻 🐛 🤔 ⚠️
Ian M. Jones
Ian M. Jones

💻 🐛 🤔 ⚠️ 👀 📦
marktohark
marktohark

💻
Ryan H
Ryan H

💻
Cody Bentley
Cody Bentley

💻 📦 🤔 💵
Florent
Florent

💻 🐛
Alexander Hudek
Alexander Hudek

💻 💵
Tim Kipp
Tim Kipp

💻
Altynbek Kaliakbarov
Altynbek Kaliakbarov

💻
Nikolai Zimmermann
Nikolai Zimmermann

💻
k-muchmore
k-muchmore

💻
Snider
Snider

💻 🤔 📖 💵
Albert Sun
Albert Sun

💻 ⚠️
Ariel
Ariel

💻 🐛
Ilgıt Yıldırım
Ilgıt Yıldırım

💻 🐛 💵
Toyam Cox
Toyam Cox

💻 📦 🐛
hi019
hi019

💻 🐛
Arthur Wiebe
Arthur Wiebe

💻 🐛
Balakrishna Prasad Ganne
Balakrishna Prasad Ganne

💻
BillBuilt
BillBuilt

💻 📦 🤔 💬 💵
Eng Zer Jun
Eng Zer Jun

🚧 💻
LGiki
LGiki

📖
Lontten
Lontten

📖
Lukas Crepaz
Lukas Crepaz

💻 🐛
Marcus Crane
Marcus Crane

🐛 📖 💵
Qais Patankar
Qais Patankar

📖
Wakeful-Cloud
Wakeful-Cloud

💻 🐛
Zámbó, Levente
Zámbó, Levente

💻 📦 🐛 ⚠️
Ironpark
Ironpark

💻 🤔
mondy
mondy

💻 📖
Benjamin Ryan
Benjamin Ryan

🐛
fallendusk
fallendusk

📦 💻
Mat Ryer
Mat Ryer

💻 🤔 🐛
Abtin
Abtin

💻 🐛
Adrian Lanzafame
Adrian Lanzafame

📦 💻
Aleksey Polyakov
Aleksey Polyakov

🐛 💻
Alexander Matviychuk
Alexander Matviychuk

💻 📦
AlienRecall
AlienRecall

💻 📦
Aman
Aman

📖
Amaury Tobias Quiroz
Amaury Tobias Quiroz

💻 🐛
Andreas Wenk
Andreas Wenk

📖
Antonio Stanković
Antonio Stanković

💻 📦
Arpit Jain
Arpit Jain

📖
Austin Schey
Austin Schey

💻 🐛
Benjamin Thomas
Benjamin Thomas

💻 📦 🤔
Bertram Truong
Bertram Truong

💻 🐛
Blake Bourque
Blake Bourque

📖
Denis
Denis

📖
diogox
diogox

💻 📦
Dmitry Gomzyakov
Dmitry Gomzyakov

💻 📦
Edward Browncross
Edward Browncross

💻
Elie Grenon
Elie Grenon

💻
Florian Didron
Florian Didron

💻 🐛 🤔 ⚠️ 👀 📦
GargantuaX
GargantuaX

💵
Igor Minin
Igor Minin

💻 🐛
Jae-Sung Lee
Jae-Sung Lee

💻 🤔
Jarek
Jarek

💻 📦
Junker
Junker

📖
Kris Raney
Kris Raney

💻 🐛
Luken
Luken

📖
Mark Stenglein
Mark Stenglein

💻 🐛
buddyabaddon
buddyabaddon

💻
MikeSchaap
MikeSchaap

💻 🐛
NYSSEN Michaël
NYSSEN Michaël

💻 🐛
Nan0
Nan0

💻 🤔 ⚠️ 👀
oskar
oskar

📖
Pierre Joye
Pierre Joye

💻 🐛 🤔 ⚠️
Reuben Thomas-Davis
Reuben Thomas-Davis

💻 🐛
Robin
Robin

💻 🐛
Sebastian Bauer
Sebastian Bauer

💻 🤔 ⚠️ 👀 💬
Sidharth Rathi
Sidharth Rathi

📖 🐛
Sithembiso Khumalo
Sithembiso Khumalo

💻 🐛
Soheib El-Harrache
Soheib El-Harrache

💻 🐛 💵
Sophie Au
Sophie Au

💻 🐛
Stefanos Papadakis
Stefanos Papadakis

💻 🐛
Steve Chung
Steve Chung

💻 🐛
Timm Ortloff
Timm Ortloff

📖
Tom
Tom

💻
Valentin Trinqué
Valentin Trinqué

💻 🐛
mattn
mattn

💻 🐛
bearsh
bearsh

💻 🤔 📖
chenxiao
chenxiao

💻 🤔 📖
fengweiqiang
fengweiqiang

💻 📦
flin7
flin7

📖
fred21O4
fred21O4

📖
gardc
gardc

📖
rayshoo
rayshoo

📖
Ishiyama Yuzuki
Ishiyama Yuzuki

💻 🐛
佰阅
佰阅

💻
刀刀
刀刀

📖 🐛
归位
归位

💻 🐛
skamensky
skamensky

💻 🤔 📖
dependabot[bot]
dependabot[bot]

💻 🚧
Damian Sieradzki
Damian Sieradzki

💵
John Dorman
John Dorman

💵
Ian Sinnott
Ian Sinnott

💵
Arden Shackelford
Arden Shackelford

💵
Bironou
Bironou

💵
CharlieGo_
CharlieGo_

💵
overnet
overnet

💵
jugglingjsons
jugglingjsons

💵
Selvin Ortiz
Selvin Ortiz

💵
ZanderCodes
ZanderCodes

💵
Michael Voronov
Michael Voronov

💵
letheanVPN
letheanVPN

💵
Tai Groot
Tai Groot

💵
easy-web-it
easy-web-it

💵
Michael Olson
Michael Olson

💵
EdenNetwork Italia
EdenNetwork Italia

💵
ondoki
ondoki

💵
QuEST Rail LLC
QuEST Rail LLC

💵
Gilgameš
Gilgameš

💵
Bernt-Johan Bergshaven
Bernt-Johan Bergshaven

💵
Liam Bigelow
Liam Bigelow

💵
Nick Arellano
Nick Arellano

💵
Frank Chiarulli Jr.
Frank Chiarulli Jr.

💵
Tyler
Tyler

💵
Trea Hauet
Trea Hauet

💵
Kent 'picat' Gruber
Kent 'picat' Gruber

💵
tc-hib
tc-hib

💵
Antonio
Antonio

📖
MyNameIsAres
MyNameIsAres

📖
Maicarons J
Maicarons J

📖
kiddov
kiddov

📖 💵 ⚠️ 🤔
Nicolas Coutin
Nicolas Coutin

💵
Parvin Eyvazov
Parvin Eyvazov

📖
github-actions[bot]
github-actions[bot]

💻
Oleg Gulevskyy
Oleg Gulevskyy

💻 📖 🚧 📦
Richard Guay
Richard Guay

📖
Adam Tenderholt
Adam Tenderholt

💻
JulioDRF
JulioDRF

💻
Scott Opell
Scott Opell

💻
Vadim Shchepotev
Vadim Shchepotev

💻
Will Andrews
Will Andrews

💻
Gwyn
Gwyn

💻 👀 💬 🔬
希嘉嘉
希嘉嘉

💻
ALMAS
ALMAS

💻
Alex
Alex

💻
Arif Ali
Arif Ali

💻
Artur Siarohau
Artur Siarohau

💻
Binyamin Aron Green
Binyamin Aron Green

💻
Brian Dwyer
Brian Dwyer

💻
Christian Kilb
Christian Kilb

💻
David Florness
David Florness

📖
David Walton
David Walton

💻
Debdut Karmakar
Debdut Karmakar

💻
Dieter Zhu
Dieter Zhu

💻
Fredrik Holmqvist
Fredrik Holmqvist

💻
Giovanni Palma
Giovanni Palma

💻
Hao
Hao

💻
Igor Sementsov
Igor Sementsov

💻
Johannes Haseitl
Johannes Haseitl

💻
Joshua Hull
Joshua Hull

💻
Joshua Mangiola
Joshua Mangiola

📖
Kevin MacMartin
Kevin MacMartin

💻
Liang Li
Liang Li

💻
Marvin Collins Hosea
Marvin Collins Hosea

💻
Matt Holt
Matt Holt

💻
Niklas
Niklas

💻
Andy Hsu
Andy Hsu

💻
NullCode
NullCode

💻
Oussama Sethoum
Oussama Sethoum

💻
ParkourLiu
ParkourLiu

💻
Rachel Chen
Rachel Chen

💻
Rob Nice
Rob Nice

💻
Ryo TAGAMI
Ryo TAGAMI

💻
Sam Hennessy
Sam Hennessy

💻
Sean
Sean

💻
Sean Gosiaco
Sean Gosiaco

💻
Eric P Sheets
Eric P Sheets

💻
Supian M
Supian M

💻
Watson-Sei
Watson-Sei

💻 📖
Yuki Shindo
Yuki Shindo

💻
cuigege
cuigege

💻
cybertramp
cybertramp

💻
hiroki yagi
hiroki yagi

💻
imgbot[bot]
imgbot[bot]

💻
juju
juju

💻
Michael Eatherly
Michael Eatherly

💻
tk
tk

💻
allcontributors[bot]
allcontributors[bot]

📖
wander
wander

📖
+ + +
\ No newline at end of file diff --git a/docs/src/assets/menus/context-menu.png b/docs/src/assets/menus/context-menu.png new file mode 100644 index 000000000..dd43c0c7f --- /dev/null +++ b/docs/src/assets/menus/context-menu.png @@ -0,0 +1 @@ +iVBORw0KGgoAAAANSUhEUgAAASwAAAEsCAYAAAB5fY51AAAAGXRFWHRTb2Z0d2FyZQBBZG9iZSBJbWFnZVJlYWR5ccllPAAAAyJpVFh0WE1MOmNvbS5hZG9iZS54bXAAAAAAADw/eHBhY2tldCBiZWdpbj0i77u/IiBpZD0iVzVNME1wQ2VoaUh6cmVTek5UY3prYzlkIj8+IDx4OnhtcG1ldGEgeG1sbnM6eD0iYWRvYmU6bnM6bWV0YS8iIHg6eG1wdGs9IkFkb2JlIFhNUCBDb3JlIDUuMy1jMDExIDY2LjE0NTY2MSwgMjAxMi8wMi8wNi0xNDo1NjoyNyAgICAgICAgIj4gPHJkZjpSREYgeG1sbnM6cmRmPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5LzAyLzIyLXJkZi1zeW50YXgtbnMjIj4gPHJkZjpEZXNjcmlwdGlvbiByZGY6YWJvdXQ9IiIgeG1sbnM6eG1wPSJodHRwOi8vbnMuYWRvYmUuY29tL3hhcC8xLjAvIiB4bWxuczp4bXBNTT0iaHR0cDovL25zLmFkb2JlLmNvbS94YXAvMS4wL21tLyIgeG1sbnM6c3RSZWY9Imh0dHA6Ly9ucy5hZG9iZS5jb20veGFwLzEuMC9zVHlwZS9SZXNvdXJjZVJlZiMiIHhtcDpDcmVhdG9yVG9vbD0iQWRvYmUgUGhvdG9zaG9wIENTNiAoV2luZG93cykiIHhtcE1NOkluc3RhbmNlSUQ9InhtcC5paWQ6MTIzODU1NjI4RjU1MTFFQjg5QzVCNTY1QjY1NjY1QjYiIHhtcE1NOkRvY3VtZW50SUQ9InhtcC5kaWQ6MTIzODU1NjM4RjU1MTFFQjg5QzVCNTY1QjY1NjY1QjYiPiA8eG1wTU06RGVyaXZlZEZyb20gc3RSZWY6aW5zdGFuY2VJRD0ieG1wLmlpZDoxMjM4NTU2MDhGNTUxMUVCODlDNUI1NjVCNjU2NjVCNiIgc3RSZWY6ZG9jdW1lbnRJRD0ieG1wLmRpZDoxMjM4NTU2MThGNTUxMUVCODlDNUI1NjVCNjU2NjVCNiIvPiA8L3JkZjpEZXNjcmlwdGlvbj4gPC9yZGY6UkRGPiA8L3g6eG1wbWV0YT4gPD94cGFja2V0IGVuZD0iciI/PgH//v38+/r5+Pf29fTz8vHw7+7t7Ovq6ejn5uXk4+Lh4N/e3dzb2tnY19bV1NPS0dDPzs3My8rJyMfGxcTDwsHAv769vLu6ubi3trW0s7KxsK+urayrqqmop6alpKOioaCfnp2cm5qZmJeWlZSTkpGQj46NjIuKiYiHhoWEg4KBgH9+fXx7enl4d3Z1dHNycXBvbm1sa2ppaGdmZWRjYmFgX15dXFtaWVhXVlVUU1JRUE9OTUxLSklIR0ZFRENCQUA/Pj08Ozo5ODc2NTQzMjEwLy4tLCsqKSgnJiUkIyIhIB8eHRwbGhkYFxYVFBMSERAPDg0MCwoJCAcGBQQDAgEAACH5BAEAAAAALAAAAAAsASwBAAL/hI+py+0Po5y02ouz3rz7D4biSJbmiabqyrbuC8fyTNf2jef6zvf+DwwKh8Si8YhMKpfMpvMJjUqn1Kr1is1qt9yu9wsOi8fksvmMTqvX7Lb7DY/L5/S6/Y7P6/f8vv8PGCg4SFhoeIiYqLjI2Oj4CBkpOUlZaXmJmam5ydnp+QkaKjpKWmp6ipqqusra6voKGys7S1tre4ubq7vL2+v7CxwsPExcbHyMnKy8zNzs/AwdLT1NXW19jZ2tvc3d7f0NHi4+Tl5ufo6err7O3u7+Dh8vP09fb3+Pn6+/z9/v/w8woMCBBAsaPIgwocKFDBs6fAgxosSJFCtavIgxo8aN/xw7evwIMqTIkSRLmjyJMqXKlSxbunwJM6bMmTRr2ryJM6fOnTx7+vwJNKjQoUSLGj2KNKnSpUybOn0KNarUqVSrWr2KNavWrVy7ev0KNqzYsWTLmj2LNq3atWzbun0LN67cuXTr2r2LN6/evXz7+v0LOLDgwYQLGz6MOLHixYwbO34MObLkyZQrW76MObPmzZw7e/4MOrTo0aRLmz6NOrXq1axbu34NO7bs2bRr276NO7fu3bx7+/4NPLjw4cSLGz+OPLny5cybO38OPbr06dSrW7+OPbv27dy7e/8OPrz48eTLmz+PPr369ezbu38PP778+fTr27+PP7/+/fz7+9OPX7//fwAGKOCABBZo4IEIJqjgggw26OCDEEYo4YQUVmjhhRhmqOGGHHbo4YcghijiiCSWaOKJKKao4oostujiizDGKOOMNNZo44045qjjjjz26OOPQAYp5JBEFmnkkUgmqeSSTDbp5JNQRinllFRWaeWVWGap5ZZcdunll2CGKeaYZJZp5plopqnmmmy26eabcMYp55x01mnnnXjmqeeefPbp55+ABirooIQWauihiCaq6KKMNuroo5BGKumklFZq6aWYZqrpppx26umnoIYq6qiklmrqqaimquqqrLbq6quwxirrqxEAADs= diff --git a/docs/src/assets/notes-app.png b/docs/src/assets/notes-app.png new file mode 100644 index 000000000..4e4953204 Binary files /dev/null and b/docs/src/assets/notes-app.png differ diff --git a/docs/src/assets/qr1.png b/docs/src/assets/qr1.png new file mode 100644 index 000000000..69885acbe Binary files /dev/null and b/docs/src/assets/qr1.png differ diff --git a/docs/src/assets/qr2.png b/docs/src/assets/qr2.png new file mode 100644 index 000000000..e2ce2a5f1 Binary files /dev/null and b/docs/src/assets/qr2.png differ diff --git a/docs/src/assets/showcase-images/bboard.webp b/docs/src/assets/showcase-images/bboard.webp new file mode 100644 index 000000000..463d25de0 Binary files /dev/null and b/docs/src/assets/showcase-images/bboard.webp differ diff --git a/docs/src/assets/showcase-images/cfntracker.webp b/docs/src/assets/showcase-images/cfntracker.webp new file mode 100644 index 000000000..6a2288a5c Binary files /dev/null and b/docs/src/assets/showcase-images/cfntracker.webp differ diff --git a/docs/src/assets/showcase-images/clave.png b/docs/src/assets/showcase-images/clave.png new file mode 100644 index 000000000..3ee29c303 Binary files /dev/null and b/docs/src/assets/showcase-images/clave.png differ diff --git a/docs/src/assets/showcase-images/emailit.webp b/docs/src/assets/showcase-images/emailit.webp new file mode 100644 index 000000000..fc1b9a51a Binary files /dev/null and b/docs/src/assets/showcase-images/emailit.webp differ diff --git a/docs/src/assets/showcase-images/encrypteasy.webp b/docs/src/assets/showcase-images/encrypteasy.webp new file mode 100644 index 000000000..c0789a3e3 Binary files /dev/null and b/docs/src/assets/showcase-images/encrypteasy.webp differ diff --git a/docs/src/assets/showcase-images/esp-studio.png b/docs/src/assets/showcase-images/esp-studio.png new file mode 100644 index 000000000..9cb7d39fa Binary files /dev/null and b/docs/src/assets/showcase-images/esp-studio.png differ diff --git a/docs/src/assets/showcase-images/filehound.webp b/docs/src/assets/showcase-images/filehound.webp new file mode 100644 index 000000000..92769ca8e Binary files /dev/null and b/docs/src/assets/showcase-images/filehound.webp differ diff --git a/docs/src/assets/showcase-images/hiposter.webp b/docs/src/assets/showcase-images/hiposter.webp new file mode 100644 index 000000000..7c7510ea1 Binary files /dev/null and b/docs/src/assets/showcase-images/hiposter.webp differ diff --git a/docs/src/assets/showcase-images/mac-app.png b/docs/src/assets/showcase-images/mac-app.png new file mode 100644 index 000000000..1f4c85304 Binary files /dev/null and b/docs/src/assets/showcase-images/mac-app.png differ diff --git a/docs/src/assets/showcase-images/mchat.png b/docs/src/assets/showcase-images/mchat.png new file mode 100644 index 000000000..0942c482b Binary files /dev/null and b/docs/src/assets/showcase-images/mchat.png differ diff --git a/docs/src/assets/showcase-images/minecraft-mod-updater.webp b/docs/src/assets/showcase-images/minecraft-mod-updater.webp new file mode 100644 index 000000000..c8e011cf3 Binary files /dev/null and b/docs/src/assets/showcase-images/minecraft-mod-updater.webp differ diff --git a/docs/src/assets/showcase-images/minesweeper-xp.webp b/docs/src/assets/showcase-images/minesweeper-xp.webp new file mode 100644 index 000000000..b3c5ca26b Binary files /dev/null and b/docs/src/assets/showcase-images/minesweeper-xp.webp differ diff --git a/docs/src/assets/showcase-images/modalfilemanager.webp b/docs/src/assets/showcase-images/modalfilemanager.webp new file mode 100644 index 000000000..2fdf219fc Binary files /dev/null and b/docs/src/assets/showcase-images/modalfilemanager.webp differ diff --git a/docs/src/assets/showcase-images/mollywallet.webp b/docs/src/assets/showcase-images/mollywallet.webp new file mode 100644 index 000000000..11641f8ca Binary files /dev/null and b/docs/src/assets/showcase-images/mollywallet.webp differ diff --git a/docs/src/assets/showcase-images/october.webp b/docs/src/assets/showcase-images/october.webp new file mode 100644 index 000000000..ceec1c573 Binary files /dev/null and b/docs/src/assets/showcase-images/october.webp differ diff --git a/docs/src/assets/showcase-images/optimus.webp b/docs/src/assets/showcase-images/optimus.webp new file mode 100644 index 000000000..0aac84058 Binary files /dev/null and b/docs/src/assets/showcase-images/optimus.webp differ diff --git a/docs/src/assets/showcase-images/portfall.webp b/docs/src/assets/showcase-images/portfall.webp new file mode 100644 index 000000000..12f8d6e5b Binary files /dev/null and b/docs/src/assets/showcase-images/portfall.webp differ diff --git a/docs/src/assets/showcase-images/resizem.webp b/docs/src/assets/showcase-images/resizem.webp new file mode 100644 index 000000000..aaee1c806 Binary files /dev/null and b/docs/src/assets/showcase-images/resizem.webp differ diff --git a/docs/src/assets/showcase-images/restic-browser-2.png b/docs/src/assets/showcase-images/restic-browser-2.png new file mode 100644 index 000000000..b986bfe68 Binary files /dev/null and b/docs/src/assets/showcase-images/restic-browser-2.png differ diff --git a/docs/src/assets/showcase-images/riftshare-main.webp b/docs/src/assets/showcase-images/riftshare-main.webp new file mode 100644 index 000000000..2d6a8fb3a Binary files /dev/null and b/docs/src/assets/showcase-images/riftshare-main.webp differ diff --git a/docs/src/assets/showcase-images/scriptbar.webp b/docs/src/assets/showcase-images/scriptbar.webp new file mode 100644 index 000000000..92463fdb9 Binary files /dev/null and b/docs/src/assets/showcase-images/scriptbar.webp differ diff --git a/docs/src/assets/showcase-images/snippetexpandergui-add-snippet.png b/docs/src/assets/showcase-images/snippetexpandergui-add-snippet.png new file mode 100644 index 000000000..0f34e4f53 Binary files /dev/null and b/docs/src/assets/showcase-images/snippetexpandergui-add-snippet.png differ diff --git a/docs/src/assets/showcase-images/snippetexpandergui-search-and-paste.png b/docs/src/assets/showcase-images/snippetexpandergui-search-and-paste.png new file mode 100644 index 000000000..d87878c29 Binary files /dev/null and b/docs/src/assets/showcase-images/snippetexpandergui-search-and-paste.png differ diff --git a/docs/src/assets/showcase-images/snippetexpandergui-select-snippet.png b/docs/src/assets/showcase-images/snippetexpandergui-select-snippet.png new file mode 100644 index 000000000..b82468c80 Binary files /dev/null and b/docs/src/assets/showcase-images/snippetexpandergui-select-snippet.png differ diff --git a/docs/src/assets/showcase-images/surge.png b/docs/src/assets/showcase-images/surge.png new file mode 100644 index 000000000..d732fabe8 Binary files /dev/null and b/docs/src/assets/showcase-images/surge.png differ diff --git a/docs/src/assets/showcase-images/tiny-rdm1.webp b/docs/src/assets/showcase-images/tiny-rdm1.webp new file mode 100644 index 000000000..11b375580 Binary files /dev/null and b/docs/src/assets/showcase-images/tiny-rdm1.webp differ diff --git a/docs/src/assets/showcase-images/tiny-rdm2.webp b/docs/src/assets/showcase-images/tiny-rdm2.webp new file mode 100644 index 000000000..9de730fb4 Binary files /dev/null and b/docs/src/assets/showcase-images/tiny-rdm2.webp differ diff --git a/docs/src/assets/showcase-images/varly2.webp b/docs/src/assets/showcase-images/varly2.webp new file mode 100644 index 000000000..6dbe0c9bf Binary files /dev/null and b/docs/src/assets/showcase-images/varly2.webp differ diff --git a/docs/src/assets/showcase-images/wailsterm.webp b/docs/src/assets/showcase-images/wailsterm.webp new file mode 100644 index 000000000..6d4251a75 Binary files /dev/null and b/docs/src/assets/showcase-images/wailsterm.webp differ diff --git a/docs/src/assets/showcase-images/wally.webp b/docs/src/assets/showcase-images/wally.webp new file mode 100644 index 000000000..150c98c74 Binary files /dev/null and b/docs/src/assets/showcase-images/wally.webp differ diff --git a/docs/src/assets/showcase-images/warmine1.png b/docs/src/assets/showcase-images/warmine1.png new file mode 100644 index 000000000..38441d99d Binary files /dev/null and b/docs/src/assets/showcase-images/warmine1.png differ diff --git a/docs/src/assets/showcase-images/warmine2.png b/docs/src/assets/showcase-images/warmine2.png new file mode 100644 index 000000000..4713462da Binary files /dev/null and b/docs/src/assets/showcase-images/warmine2.png differ diff --git a/docs/src/assets/showcase-images/wombat.webp b/docs/src/assets/showcase-images/wombat.webp new file mode 100644 index 000000000..97f965834 Binary files /dev/null and b/docs/src/assets/showcase-images/wombat.webp differ diff --git a/docs/src/assets/showcase-images/ytd.webp b/docs/src/assets/showcase-images/ytd.webp new file mode 100644 index 000000000..c7988cee5 Binary files /dev/null and b/docs/src/assets/showcase-images/ytd.webp differ diff --git a/docs/src/assets/todo-app.png b/docs/src/assets/todo-app.png new file mode 100644 index 000000000..319cc8fbf Binary files /dev/null and b/docs/src/assets/todo-app.png differ diff --git a/docs/src/assets/wails-logo-dark.svg b/docs/src/assets/wails-logo-dark.svg new file mode 100644 index 000000000..dfc54485c --- /dev/null +++ b/docs/src/assets/wails-logo-dark.svg @@ -0,0 +1,49 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/src/assets/wails-logo-horizontal-dark.svg b/docs/src/assets/wails-logo-horizontal-dark.svg new file mode 100644 index 000000000..01808dca5 --- /dev/null +++ b/docs/src/assets/wails-logo-horizontal-dark.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/docs/src/assets/wails-logo-horizontal-light.svg b/docs/src/assets/wails-logo-horizontal-light.svg new file mode 100644 index 000000000..465bc5cf9 --- /dev/null +++ b/docs/src/assets/wails-logo-horizontal-light.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/docs/src/assets/wails-logo-light.svg b/docs/src/assets/wails-logo-light.svg new file mode 100644 index 000000000..ab02c827a --- /dev/null +++ b/docs/src/assets/wails-logo-light.svg @@ -0,0 +1,49 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/src/assets/wails_build.mp4 b/docs/src/assets/wails_build.mp4 new file mode 100644 index 000000000..2d1ee783b Binary files /dev/null and b/docs/src/assets/wails_build.mp4 differ diff --git a/docs/src/assets/wails_dev.mp4 b/docs/src/assets/wails_dev.mp4 new file mode 100644 index 000000000..29c2a45a4 Binary files /dev/null and b/docs/src/assets/wails_dev.mp4 differ diff --git a/docs/src/assets/wails_init.mp4 b/docs/src/assets/wails_init.mp4 new file mode 100644 index 000000000..337bc0f5a Binary files /dev/null and b/docs/src/assets/wails_init.mp4 differ diff --git a/docs/src/components/CardAnimation.astro b/docs/src/components/CardAnimation.astro new file mode 100644 index 000000000..5d3de111b --- /dev/null +++ b/docs/src/components/CardAnimation.astro @@ -0,0 +1,62 @@ +--- +--- + diff --git a/docs/src/content/authors.ts b/docs/src/content/authors.ts new file mode 100644 index 000000000..0500490f3 --- /dev/null +++ b/docs/src/content/authors.ts @@ -0,0 +1,11 @@ +import type { StarlightBlogUserConfig } from "starlight-blog"; + +type Authors = NonNullable["authors"]; +export const authors: Authors = { + leaanthony: { + name: "Lea Anthony", + title: "Maintainer of Wails", + url: "https://github.com/leaanthony", + picture: "https://github.com/leaanthony.png", + }, +}; diff --git a/docs/src/content/config.ts b/docs/src/content/config.ts new file mode 100644 index 000000000..dae3197fe --- /dev/null +++ b/docs/src/content/config.ts @@ -0,0 +1,10 @@ +import { defineCollection } from "astro:content"; +import { docsSchema, i18nSchema } from "@astrojs/starlight/schema"; +import { blogSchema } from "starlight-blog/schema"; + +export const collections = { + i18n: defineCollection({ type: "data", schema: i18nSchema() }), + docs: defineCollection({ + schema: docsSchema({ extend: (context) => blogSchema(context) }), + }), +}; diff --git a/docs/src/content/docs/blog/2021-09-27-v2-beta1-release-notes.md b/docs/src/content/docs/blog/2021-09-27-v2-beta1-release-notes.md new file mode 100644 index 000000000..dbc8d9776 --- /dev/null +++ b/docs/src/content/docs/blog/2021-09-27-v2-beta1-release-notes.md @@ -0,0 +1,206 @@ +--- +slug: blog/wails-v2-beta-for-windows +title: Wails v2 Beta for Windows +authors: [leaanthony] +tags: [wails, v2] +date: 2021-09-27 +--- + +![wails screenshot](../../../assets/blog-images/wails.webp) + +When I first announced Wails on Reddit, just over 2 years ago from a train in +Sydney, I did not expect it to get much attention. A few days later, a prolific +tech vlogger released a tutorial video, gave it a positive review and from that +point on, interest in the project has skyrocketed. + +It was clear that people were excited about adding web frontends to their Go +projects, and almost immediately pushed the project beyond the proof of concept +that I had created. At the time, Wails used the +[webview](https://github.com/webview/webview) project to handle the frontend, +and the only option for Windows was the IE11 renderer. Many bug reports were +rooted in this limitation: poor JavaScript/CSS support and no dev tools to debug +it. This was a frustrating development experience but there wasn't much that +could have been done to rectify it. + +For a long time, I'd firmly believed that Microsoft would eventually have to +sort out their browser situation. The world was moving on, frontend development +was booming and IE wasn't cutting it. When Microsoft announced the move to using +Chromium as the basis for their new browser direction, I knew it was only a +matter of time until Wails could use it, and move the Windows developer +experience to the next level. + +Today, I am pleased to announce: **Wails v2 Beta for Windows**! There's a huge +amount to unpack in this release, so grab a drink, take a seat and we'll +begin... + +### No CGO Dependency! + +No, I'm not joking: _No_ _CGO_ _dependency_ 🤯! The thing about Windows is that, +unlike MacOS and Linux, it doesn't come with a default compiler. In addition, +CGO requires a mingw compiler and there's a ton of different installation +options. Removing the CGO requirement has massively simplified setup, as well as +making debugging an awful lot easier. Whilst I have put a fair bit of effort in +getting this working, the majority of the credit should go to +[John Chadwick](https://github.com/jchv) for not only starting a couple of +projects to make this possible, but also being open to someone taking those +projects and building on them. Credit also to +[Tad Vizbaras](https://github.com/tadvi) whose +[winc](https://github.com/tadvi/winc) project started me down this path. + +### WebView2 Chromium Renderer + +![devtools screenshot](../../../assets/blog-images/devtools.png) + +Finally, Windows developers get a first class rendering engine for their +applications! Gone are the days of contorting your frontend code to work on +Windows. On top of that, you get a first-class developer tools experience! + +The WebView2 component does, however, have a requirement to have the +`WebView2Loader.dll` sitting alongside the binary. This makes distribution just +that little bit more painful than we gophers are used to. All solutions and +libraries (that I know of) that use WebView2 have this dependency. + +However, I'm really excited to announce that Wails applications _have no such +requirement_! Thanks to the wizardry of +[John Chadwick](https://github.com/jchv), we are able to bundle this dll inside +the binary and get Windows to load it as if it were present on disk. + +Gophers rejoice! The single binary dream lives on! + +### New Features + +![wails-menus screenshot](../../../assets/blog-images/wails-menus.webp) + +There were a lot of requests for native menu support. Wails has finally got you +covered. Application menus are now available and include support for most native +menu features. This includes standard menu items, checkboxes, radio groups, +submenus and separators. + +There were a huge number of requests in v1 for the ability to have greater +control of the window itself. I'm happy to announce that there's new runtime +APIs specifically for this. It's feature-rich and supports multi-monitor +configurations. There is also an improved dialogs API: Now, you can have modern, +native dialogs with rich configuration to cater for all your dialog needs. + +There is now the option to generate IDE configuration along with your project. +This means that if you open your project in a supported IDE, it will already be +configured for building and debugging your application. Currently VSCode is +supported but we hope to support other IDEs such as Goland soon. + +![vscode screenshot](../../../assets/blog-images/vscode.webp) + +### No requirement to bundle assets + +A huge pain-point of v1 was the need to condense your entire application down to +single JS & CSS files. I'm happy to announce that for v2, there is no +requirement to bundle assets, in any way, shape or form. Want to load a local +image? Use an `` tag with a local src path. Want to use a cool font? Copy +it in and add the path to it in your CSS. + +> Wow, that sounds like a webserver... + +Yes, it works just like a webserver, except it isn't. + +> So how do I include my assets? + +You just pass a single `embed.FS` that contains all your assets into your +application configuration. They don't even need to be in the top directory - +Wails will just work it out for you. + +### New Development Experience + +![browser screenshot](../../../assets/blog-images/browser.webp) + +Now that assets don't need to be bundled, it's enabled a whole new development +experience. The new `wails dev` command will build and run your application, but +instead of using the assets in the `embed.FS`, it loads them directly from disk. + +It also provides the additional features: + +- Hot reload - Any changes to frontend assets will trigger and auto reload of + the application frontend +- Auto rebuild - Any changes to your Go code will rebuild and relaunch your + application + +In addition to this, a webserver will start on port 34115. This will serve your +application to any browser that connects to it. All connected web browsers will +respond to system events like hot reload on asset change. + +In Go, we are used to dealing with structs in our applications. It's often +useful to send structs to our frontend and use them as state in our application. +In v1, this was a very manual process and a bit of a burden on the developer. +I'm happy to announce that in v2, any application run in dev mode will +automatically generate TypeScript models for all structs that are input or +output parameters to bound methods. This enables seamless interchange of data +models between the two worlds. + +In addition to this, another JS module is dynamically generated wrapping all +your bound methods. This provides JSDoc for your methods, providing code +completion and hinting in your IDE. It's really cool when you get data models +auto-imported when hitting tab in an auto-generated module wrapping your Go +code! + +### Remote Templates + +![remote screenshot](../../../assets/blog-images/remote.webp) + +Getting an application up and running quickly was always a key goal for the +Wails project. When we launched, we tried to cover a lot of the modern +frameworks at the time: react, vue and angular. The world of frontend +development is very opinionated, fast moving and hard to keep on top of! As a +result, we found our base templates getting out of date pretty quickly and this +caused a maintenance headache. It also meant that we didn't have cool modern +templates for the latest and greatest tech stacks. + +With v2, I wanted to empower the community by giving you the ability to create +and host templates yourselves, rather than rely on the Wails project. So now you +can create projects using community supported templates! I hope this will +inspire developers to create a vibrant ecosystem of project templates. I'm +really quite excited about what our developer community can create! + +### In Conclusion + +Wails v2 represents a new foundation for the project. The aim of this release is +to get feedback on the new approach, and to iron out any bugs before a full +release. Your input would be most welcome. Please direct any feedback to the +[v2 Beta](https://github.com/wailsapp/wails/discussions/828) discussion board. + +There were many twists and turns, pivots and u-turns to get to this point. This +was due partly to early technical decisions that needed changing, and partly +because some core problems we had spent time building workarounds for were fixed +upstream: Go’s embed feature is a good example. Fortunately, everything came +together at the right time, and today we have the very best solution that we can +have. I believe the wait has been worth it - this would not have been possible +even 2 months ago. + +I also need to give a huge thank you :pray: to the following people because +without them, this release just wouldn't exist: + +- [Misite Bao](https://github.com/misitebao) - An absolute workhorse on the + Chinese translations and an incredible bug finder. +- [John Chadwick](https://github.com/jchv) - His amazing work on + [go-webview2](https://github.com/jchv/go-webview2) and + [go-winloader](https://github.com/jchv/go-winloader) have made the Windows + version we have today possible. +- [Tad Vizbaras](https://github.com/tadvi) - Experimenting with his + [winc](https://github.com/tadvi/winc) project was the first step down the path + to a pure Go Wails. +- [Mat Ryer](https://github.com/matryer) - His support, encouragement and + feedback has really helped drive the project forward. + +And finally, I'd like to give a special thank you to all the +[project sponsors](/credits#sponsors), including +[JetBrains](https://www.jetbrains.com?from=Wails), whose support drives the +project in many ways behind the scenes. + +I look forward to seeing what people build with Wails in this next exciting +phase of the project! + +Lea. + +PS: MacOS and Linux users need not feel left out - porting to this new +foundation is actively under way and most of the hard work has already been +done. Hang in there! + +PPS: If you or your company find Wails useful, please consider +[sponsoring the project](https://github.com/sponsors/leaanthony). Thanks! diff --git a/docs/src/content/docs/blog/2021-11-08-v2-beta2-release-notes.md b/docs/src/content/docs/blog/2021-11-08-v2-beta2-release-notes.md new file mode 100644 index 000000000..31d53e1bc --- /dev/null +++ b/docs/src/content/docs/blog/2021-11-08-v2-beta2-release-notes.md @@ -0,0 +1,166 @@ +--- +slug: blog/wails-v2-beta-for-mac +title: Wails v2 Beta for MacOS +authors: [leaanthony] +tags: [wails, v2] +date: 2021-11-08 +--- + +![wails-mac screenshot](../../../assets/blog-images/wails-mac.webp) + +Today marks the first beta release of Wails v2 for Mac! It's taken quite a while +to get to this point and I'm hoping that today's release will give you something +that's reasonably useful. There have been a number of twists and turns to get to +this point and I'm hoping, with your help, to iron out the crinkles and get the +Mac port polished for the final v2 release. + +You mean this isn't ready for production? For your use case, it may well be +ready, but there are still a number of known issues so keep your eye on +[this project board](https://github.com/wailsapp/wails/projects/7) and if you +would like to contribute, you'd be very welcome! + +So what's new for Wails v2 for Mac vs v1? Hint: It's pretty similar to the +Windows Beta :wink: + +### New Features + +![wails-menus-mac screenshot](../../../assets/blog-images/wails-menus-mac.webp) + +There were a lot of requests for native menu support. Wails has finally got you +covered. Application menus are now available and include support for most native +menu features. This includes standard menu items, checkboxes, radio groups, +submenus and separators. + +There were a huge number of requests in v1 for the ability to have greater +control of the window itself. I'm happy to announce that there's new runtime +APIs specifically for this. It's feature-rich and supports multi-monitor +configurations. There is also an improved dialogs API: Now, you can have modern, +native dialogs with rich configuration to cater for all your dialog needs. + +### Mac Specific Options + +In addition to the normal application options, Wails v2 for Mac also brings some +Mac extras: + +- Make your window all funky and translucent, like all the pretty swift apps! +- Highly customisable titlebar +- We support the NSAppearance options for the application +- Simple config to auto-create an "About" menu + +### No requirement to bundle assets + +A huge pain-point of v1 was the need to condense your entire application down to +single JS & CSS files. I'm happy to announce that for v2, there is no +requirement to bundle assets, in any way, shape or form. Want to load a local +image? Use an `` tag with a local src path. Want to use a cool font? Copy +it in and add the path to it in your CSS. + +> Wow, that sounds like a webserver... + +Yes, it works just like a webserver, except it isn't. + +> So how do I include my assets? + +You just pass a single `embed.FS` that contains all your assets into your +application configuration. They don't even need to be in the top directory - +Wails will just work it out for you. + +### New Development Experience + +Now that assets don't need to be bundled, it's enabled a whole new development +experience. The new `wails dev` command will build and run your application, but +instead of using the assets in the `embed.FS`, it loads them directly from disk. + +It also provides the additional features: + +- Hot reload - Any changes to frontend assets will trigger and auto reload of + the application frontend +- Auto rebuild - Any changes to your Go code will rebuild and relaunch your + application + +In addition to this, a webserver will start on port 34115. This will serve your +application to any browser that connects to it. All connected web browsers will +respond to system events like hot reload on asset change. + +In Go, we are used to dealing with structs in our applications. It's often +useful to send structs to our frontend and use them as state in our application. +In v1, this was a very manual process and a bit of a burden on the developer. +I'm happy to announce that in v2, any application run in dev mode will +automatically generate TypeScript models for all structs that are input or +output parameters to bound methods. This enables seamless interchange of data +models between the two worlds. + +In addition to this, another JS module is dynamically generated wrapping all +your bound methods. This provides JSDoc for your methods, providing code +completion and hinting in your IDE. It's really cool when you get data models +auto-imported when hitting tab in an auto-generated module wrapping your Go +code! + +### Remote Templates + +![remote-mac screenshot](../../../assets/blog-images/remote-mac.webp) + +Getting an application up and running quickly was always a key goal for the +Wails project. When we launched, we tried to cover a lot of the modern +frameworks at the time: react, vue and angular. The world of frontend +development is very opinionated, fast moving and hard to keep on top of! As a +result, we found our base templates getting out of date pretty quickly and this +caused a maintenance headache. It also meant that we didn't have cool modern +templates for the latest and greatest tech stacks. + +With v2, I wanted to empower the community by giving you the ability to create +and host templates yourselves, rather than rely on the Wails project. So now you +can create projects using community supported templates! I hope this will +inspire developers to create a vibrant ecosystem of project templates. I'm +really quite excited about what our developer community can create! + +### Native M1 Support + +Thanks to the amazing support of [Mat Ryer](https://github.com/matryer/), the +Wails project now supports M1 native builds: + +![build-darwin-arm screenshot](../../../assets/blog-images/build-darwin-arm.webp) + +You can also specify `darwin/amd64` as a target too: + +![build-darwin-amd screenshot](../../../assets/blog-images/build-darwin-amd.webp) + +Oh, I almost forgot.... you can also do `darwin/universal`.... :wink: + +![build-darwin-universal screenshot](../../../assets/blog-images/build-darwin-universal.webp) + +### Cross Compilation to Windows + +Because Wails v2 for Windows is pure Go, you can target Windows builds without +docker. + +![build-cross-windows screenshot](../../../assets/blog-images/build-cross-windows.webp) +bu + +### WKWebView Renderer + +V1 relied on a (now deprecated) WebView component. V2 uses the most recent +WKWebKit component so expect the latest and greatest from Apple. + +### In Conclusion + +As I'd said in the Windows release notes, Wails v2 represents a new foundation +for the project. The aim of this release is to get feedback on the new approach, +and to iron out any bugs before a full release. Your input would be most +welcome! Please direct any feedback to the +[v2 Beta](https://github.com/wailsapp/wails/discussions/828) discussion board. + +And finally, I'd like to give a special thank you to all the +[project sponsors](/credits#sponsors), including +[JetBrains](https://www.jetbrains.com?from=Wails), whose support drive the +project in many ways behind the scenes. + +I look forward to seeing what people build with Wails in this next exciting +phase of the project! + +Lea. + +PS: Linux users, you're next! + +PPS: If you or your company find Wails useful, please consider +[sponsoring the project](https://github.com/sponsors/leaanthony). Thanks! diff --git a/docs/src/content/docs/blog/2022-02-22-v2-beta3-release-notes.md b/docs/src/content/docs/blog/2022-02-22-v2-beta3-release-notes.md new file mode 100644 index 000000000..047236258 --- /dev/null +++ b/docs/src/content/docs/blog/2022-02-22-v2-beta3-release-notes.md @@ -0,0 +1,129 @@ +--- +slug: blog/wails-v2-beta-for-linux +title: Wails v2 Beta for Linux +authors: [leaanthony] +tags: [wails, v2] +date: 2022-02-22 +--- + +![wails-linux screenshot](../../../assets/blog-images/wails-linux.webp) + +I'm pleased to finally announce that Wails v2 is now in beta for Linux! It is +somewhat ironic that the very first experiments with v2 was on Linux and yet it +has ended up as the last release. That being said, the v2 we have today is very +different from those first experiments. So without further ado, let's go over +the new features: + +### New Features + +![wails-menus-linux screenshot](../../../assets/blog-images/wails-menus-linux.webp) + +There were a lot of requests for native menu support. Wails has finally got you +covered. Application menus are now available and include support for most native +menu features. This includes standard menu items, checkboxes, radio groups, +submenus and separators. + +There were a huge number of requests in v1 for the ability to have greater +control of the window itself. I'm happy to announce that there's new runtime +APIs specifically for this. It's feature-rich and supports multi-monitor +configurations. There is also an improved dialogs API: Now, you can have modern, +native dialogs with rich configuration to cater for all your dialog needs. + +### No requirement to bundle assets + +A huge pain-point of v1 was the need to condense your entire application down to +single JS & CSS files. I'm happy to announce that for v2, there is no +requirement to bundle assets, in any way, shape or form. Want to load a local +image? Use an `<../../../assets/blog-images>` tag with a local src path. Want to +use a cool font? Copy it in and add the path to it in your CSS. + +> Wow, that sounds like a webserver... + +Yes, it works just like a webserver, except it isn't. + +> So how do I include my assets? + +You just pass a single `embed.FS` that contains all your assets into your +application configuration. They don't even need to be in the top directory - +Wails will just work it out for you. + +### New Development Experience + +Now that assets don't need to be bundled, it's enabled a whole new development +experience. The new `wails dev` command will build and run your application, but +instead of using the assets in the `embed.FS`, it loads them directly from disk. + +It also provides the additional features: + +- Hot reload - Any changes to frontend assets will trigger an auto reload of the + application frontend +- Auto rebuild - Any changes to your Go code will rebuild and relaunch your + application + +In addition to this, a webserver will start on port 34115. This will serve your +application to any browser that connects to it. All connected web browsers will +respond to system events like hot reload on asset change. + +In Go, we are used to dealing with structs in our applications. It's often +useful to send structs to our frontend and use them as state in our application. +In v1, this was a very manual process and a bit of a burden on the developer. +I'm happy to announce that in v2, any application run in dev mode will +automatically generate TypeScript models for all structs that are input or +output parameters to bound methods. This enables seamless interchange of data +models between the two worlds. + +In addition to this, another JS module is dynamically generated wrapping all +your bound methods. This provides JSDoc for your methods, providing code +completion and hinting in your IDE. It's really cool when you get data models +auto-imported when hitting tab in an auto-generated module wrapping your Go +code! + +### Remote Templates + +![remote-linux screenshot](../../../assets/blog-images/remote-linux.webp) + +Getting an application up and running quickly was always a key goal for the +Wails project. When we launched, we tried to cover a lot of the modern +frameworks at the time: react, vue and angular. The world of frontend +development is very opinionated, fast moving and hard to keep on top of! As a +result, we found our base templates getting out of date pretty quickly and this +caused a maintenance headache. It also meant that we didn't have cool modern +templates for the latest and greatest tech stacks. + +With v2, I wanted to empower the community by giving you the ability to create +and host templates yourselves, rather than rely on the Wails project. So now you +can create projects using community supported templates! I hope this will +inspire developers to create a vibrant ecosystem of project templates. I'm +really quite excited about what our developer community can create! + +### Cross Compilation to Windows + +Because Wails v2 for Windows is pure Go, you can target Windows builds without +docker. + +![build-cross-windows screenshot](../../../assets/blog-images/linux-build-cross-windows.webp) + +### In Conclusion + +As I'd said in the Windows release notes, Wails v2 represents a new foundation +for the project. The aim of this release is to get feedback on the new approach, +and to iron out any bugs before a full release. Your input would be most +welcome! Please direct any feedback to the +[v2 Beta](https://github.com/wailsapp/wails/discussions/828) discussion board. + +Linux is **hard** to support. We expect there to be a number of quirks with the +beta. Please help us to help you by filing detailed bug reports! + +Finally, I'd like to give a special thank you to all the +[project sponsors](/credits#sponsors) whose support drives the project in many +ways behind the scenes. + +I look forward to seeing what people build with Wails in this next exciting +phase of the project! + +Lea. + +PS: The v2 release isn't far off now! + +PPS: If you or your company find Wails useful, please consider +[sponsoring the project](https://github.com/sponsors/leaanthony). Thanks! diff --git a/docs/src/content/docs/blog/2022-09-22-v2-release-notes.md b/docs/src/content/docs/blog/2022-09-22-v2-release-notes.md new file mode 100644 index 000000000..c72d7f566 --- /dev/null +++ b/docs/src/content/docs/blog/2022-09-22-v2-release-notes.md @@ -0,0 +1,198 @@ +--- +slug: blog/wails-v2-released +title: Wails v2 Released +authors: [leaanthony] +tags: [wails, v2] +date: 2022-09-22 +--- + +![montage screenshot](../../../assets/blog-images/montage.png) + +# It's here! + +Today marks the release of [Wails](https://wails.io) v2. It's been about 18 +months since the first v2 alpha and about a year from the first beta release. +I'm truly grateful to everyone involved in the evolution of the project. + +Part of the reason it took that long was due to wanting to get to some +definition of completeness before officially calling it v2. The truth is, +there's never a perfect time to tag a release - there's always outstanding +issues or "just one more" feature to squeeze in. What tagging an imperfect major +release does do, however, is to provide a bit of stability for users of the +project, as well as a bit of a reset for the developers. + +This release is more than I'd ever expected it to be. I hope it gives you as +much pleasure as it has given us to develop it. + +# What _is_ Wails? + +If you are unfamiliar with Wails, it is a project that enables Go programmers to +provide rich frontends for their Go programs using familiar web technologies. +It's a lightweight, Go alternative to Electron. Much more information can be +found on the [official site](https://wails.io/docs/introduction). + +# What's new? + +The v2 release is a huge leap forward for the project, addressing many of the +pain points of v1. If you have not read any of the blog posts on the Beta +releases for [macOS](/blog/wails-v2-beta-for-mac), +[Windows](/blog/wails-v2-beta-for-windows) or +[Linux](/blog/wails-v2-beta-for-linux), then I encourage you to do so as it +covers all the major changes in more detail. In summary: + +- Webview2 component for Windows that supports modern web standards and + debugging capabilities. +- [Dark / Light theme](https://wails.io/docs/reference/options#theme) + + [custom theming](https://wails.io/docs/reference/options#customtheme) on Windows. +- Windows now has no CGO requirements. +- Out-of-the-box support for Svelte, Vue, React, Preact, Lit & Vanilla project + templates. +- [Vite](https://vitejs.dev/) integration providing a hot-reload development + environment for your application. +- Native application + [menus](https://wails.io/docs/guides/application-development#application-menu) and + [dialogs](https://wails.io/docs/reference/runtime/dialog). +- Native window translucency effects for + [Windows](https://wails.io/docs/reference/options#windowistranslucent) and + [macOS](https://wails.io/docs/reference/options#windowistranslucent-1). Support for Mica & + Acrylic backdrops. +- Easily generate an [NSIS installer](https://wails.io/docs/guides/windows-installer) for + Windows deployments. +- A rich [runtime library](https://wails.io/docs/reference/runtime/intro) providing utility + methods for window manipulation, eventing, dialogs, menus and logging. +- Support for [obfuscating](https://wails.io/docs/guides/obfuscated) your application using + [garble](https://github.com/burrowers/garble). +- Support for compressing your application using [UPX](https://upx.github.io/). +- Automatic TypeScript generation of Go structs. More info + [here](https://wails.io/docs/howdoesitwork#calling-bound-go-methods). +- No extra libraries or DLLs are required to be shipped with your application. + For any platform. +- No requirement to bundle frontend assets. Just develop your application like + any other web application. + +# Credit & Thanks + +Getting to v2 has been a huge effort. There have been ~2.2K commits by 89 +contributors between the initial alpha and the release today, and many, many +more that have provided translations, testing, feedback and help on the +discussion forums as well as the issue tracker. I'm so unbelievably grateful to +each one of you. I'd also like to give an extra special thank you to all the +project sponsors who have provided guidance, advice and feedback. Everything you +do is hugely appreciated. + +There are a few people I'd like to give special mention to: + +Firstly, a **huge** thank you to [@stffabi](https://github.com/stffabi) who has +provided so many contributions which we all benefit from, as well as providing a +lot of support on many issues. He has provided some key features such as the +external dev server support which transformed our dev mode offering by allowing +us to hook into [Vite](https://vitejs.dev/)'s superpowers. It's fair to say that +Wails v2 would be a far less exciting release without his +[incredible contributions](https://github.com/wailsapp/wails/commits?author=stffabi&since=2020-01-04). +Thank you so much @stffabi! + +I'd also like to give a huge shout-out to +[@misitebao](https://github.com/misitebao) who has tirelessly been maintaining +the website, as well as providing Chinese translations, managing Crowdin and +helping new translators get up to speed. This is a hugely important task, and +I'm extremely grateful for all the time and effort put into this! You rock! + +Last, but not least, a huge thank you to Mat Ryer who has provided advice and +support during the development of v2. Writing xBar together using an early Alpha +of v2 was helpful in shaping the direction of v2, as well as give me an +understanding of some design flaws in the early releases. I'm happy to announce +that as of today, we will start to port xBar to Wails v2, and it will become the +flagship application for the project. Cheers Mat! + +# Lessons Learnt + +There are a number of lessons learnt in getting to v2 that will shape +development moving forward. + +## Smaller, Quicker, Focused Releases + +In the course of developing v2, there were many features and bug fixes that were +developed on an ad-hoc basis. This led to longer release cycles and were harder +to debug. Moving forward, we are going to create releases more often that will +include a reduced number of features. A release will involve updates to +documentation as well as thorough testing. Hopefully, these smaller, quicker, +focussed releases will lead to fewer regressions and better quality +documentation. + +## Encourage Engagement + +When starting this project, I wanted to immediately help everyone who had a +problem. Issues were "personal" and I wanted them resolved as quickly as +possible. This is unsustainable and ultimately works against the longevity of +the project. Moving forward, I will be giving more space for people to get +involved in answering questions and triaging issues. It would be good to get +some tooling to help with this so if you have any suggestions, please join in +the discussion [here](https://github.com/wailsapp/wails/discussions/1855). + +## Learning to say No + +The more people that engage with an Open Source project, the more requests there +will be for additional features that may or may not be useful to the majority of +people. These features will take an initial amount of time to develop and debug, +and incur an ongoing maintenance cost from that point on. I myself am the most +guilty of this, often wanting to "boil the sea" rather than provide the minimum +viable feature. Moving forward, we will need to say "No" a bit more to adding +core features and focus our energies on a way to empower developers to provide +that functionality themselves. We are looking seriously into plugins for this +scenario. This will allow anyone to extend the project as they see fit, as well +as providing an easy way to contribute towards the project. + +# Looking to the Future + +There are so many core features we are looking at to add to Wails in the next +major development cycle already. The +[roadmap](https://github.com/wailsapp/wails/discussions/1484) is full of +interesting ideas, and I'm keen to start work on them. One of the big asks has +been for multiple window support. It's a tricky one and to do it right, and we +may need to look at providing an alternative API, as the current one was not +designed with this in mind. Based on some preliminary ideas and feedback, I +think you'll like where we're looking to go with it. + +I'm personally very excited at the prospect of getting Wails apps running on +mobile. We already have a demo project showing that it is possible to run a +Wails app on Android, so I'm really keen to explore where we can go with this! + +A final point I'd like to raise is that of feature parity. It has long been a +core principle that we wouldn't add anything to the project without there being +full cross-platform support for it. Whilst this has proven to be (mainly) +achievable so far, it has really held the project back in releasing new +features. Moving forward, we will be adopting a slightly different approach: any +new feature that cannot be immediately released for all platforms will be +released under an experimental configuration or API. This allows early adopters +on certain platforms to try the feature and provide feedback that will feed into +the final design of the feature. This, of course, means that there are no +guarantees of API stability until it is fully supported by all the platforms it +can be supported on, but at least it will unblock development. + +# Final Words + +I'm really proud of what we've been able to achieve with the V2 release. It's +amazing to see what people have already been able to build using the beta +releases so far. Quality applications like [Varly](https://varly.app/), +[Surge](https://getsurge.io/) and [October](https://october.utf9k.net/). I +encourage you to check them out. + +This release was achieved through the hard work of many contributors. Whilst it +is free to download and use, it has not come about through zero cost. Make no +mistakes, this project has come at considerable cost. It has not only been my +time and the time of each and every contributor, but also the cost of absence +from friends and families of each of those people too. That's why I'm extremely +grateful for every second that has been dedicated to making this project happen. +The more contributors we have, the more this effort can be spread out and the +more we can achieve together. I'd like to encourage you all to pick one thing +that you can contribute, whether it is confirming someone's bug, suggesting a +fix, making a documentation change or helping out someone who needs it. All of +these small things have such a huge impact! It would be so awesome if you too +were part of the story in getting to v3. + +Enjoy! + +‐ Lea + +PS: If you or your company find Wails useful, please consider +[sponsoring the project](https://github.com/sponsors/leaanthony). Thanks! diff --git a/docs/src/content/docs/blog/2023-01-17-v3-roadmap.md b/docs/src/content/docs/blog/2023-01-17-v3-roadmap.md new file mode 100644 index 000000000..a7d0d3b94 --- /dev/null +++ b/docs/src/content/docs/blog/2023-01-17-v3-roadmap.md @@ -0,0 +1,256 @@ +--- +slug: blog/the-road-to-wails-v3 +title: The Road to Wails v3 +authors: [leaanthony] +tags: [wails, v3] +date: 2023-01-17 +--- + +![multiwindow screenshot](../../../assets/blog-images/multiwindow.webp) + +# Introduction + +Wails is a project that simplifies the ability to write cross-platform desktop +applications using Go. It uses native webview components for the frontend (not +embedded browsers), bringing the power of the world's most popular UI system to +Go, whilst remaining lightweight. + +Version 2 was released on the 22nd of September 2022 and brought with it a lot +of enhancements including: + +- Live development, leveraging the popular Vite project +- Rich functionality for managing windows and creating menus +- Microsoft's WebView2 component +- Generation of Typescript models that mirror your Go structs +- Creating of NSIS Installer +- Obfuscated builds + +Right now, Wails v2 provides powerful tooling for creating rich, cross-platform +desktop applications. + +This blog post aims to look at where the project is at right now and what we can +improve on moving forward. + +# Where are we now? + +It's been incredible to see the popularity of Wails rising since the v2 release. +I'm constantly amazed by the creativity of the community and the wonderful +things that are being built with it. With more popularity, comes more eyes on +the project. And with that, more feature requests and bug reports. + +Over time, I've been able to identify some of the most pressing issues facing +the project. I've also been able to identify some of the things that are holding +the project back. + +## Current issues + +I've identified the following areas that I feel are holding the project back: + +- The API +- Bindings generation +- The Build System + +### The API + +The API to build a Wails application currently consists of 2 parts: + +- The Application API +- The Runtime API + +The Application API famously has only 1 function: `Run()` which takes a heap of +options which govern how the application will work. Whilst this is very simple +to use, it is also very limiting. It is a "declarative" approach which hides a +lot of the underlying complexity. For instance, there is no handle to the main +window, so you can't interact with it directly. For that, you need to use the +Runtime API. This is a problem when you start to want to do more complex things +like create multiple windows. + +The Runtime API provides a lot of utility functions for the developer. This +includes: + +- Window management +- Dialogs +- Menus +- Events +- Logs + +There are a number of things I am not happy with the Runtime API. The first is +that it requires a "context" to be passed around. This is both frustrating and +confusing for new developers who pass in a context and then get a runtime error. + +The biggest issue with the Runtime API is that it was designed for applications +that only use a single window. Over time, the demand for multiple windows has +grown and the API is not well suited to this. + +### Thoughts on the v3 API + +Wouldn't it be great if we could do something like this? + +```go +func main() { + app := wails.NewApplication(options.App{}) + myWindow := app.NewWindow(options.Window{}) + myWindow.SetTitle("My Window") + myWindow.On(events.Window.Close, func() { + app.Quit() + }) + app.Run() +} +``` + +This programmatic approach is far more intuitive and allows the developer to +interact with the application elements directly. All current runtime methods for +windows would simply be methods on the window object. For the other runtime +methods, we could move them to the application object like so: + +```go +app := wails.NewApplication(options.App{}) +app.NewInfoDialog(options.InfoDialog{}) +app.Log.Info("Hello World") +``` + +This is a much more powerful API which will allow for more complex applications +to be built. It also allows for the creation of multiple windows, +[the most up-voted feature on GitHub](https://github.com/wailsapp/wails/issues/1480): + +```go +func main() { + app := wails.NewApplication(options.App{}) + myWindow := app.NewWindow(options.Window{}) + myWindow.SetTitle("My Window") + myWindow.On(events.Window.Close, func() { + app.Quit() + }) + myWindow2 := app.NewWindow(options.Window{}) + myWindow2.SetTitle("My Window 2") + myWindow2.On(events.Window.Close, func() { + app.Quit() + }) + app.Run() +} +``` + +### Bindings generation + +One of the key features of Wails is generating bindings for your Go methods so +they may be called from Javascript. The current method for doing this is a bit +of a hack. It involves building the application with a special flag and then +running the resultant binary which uses reflection to determine what has been +bound. This leads to a bit of a chicken and egg situation: You can't build the +application without the bindings and you can't generate the bindings without +building the application. There are many ways around this but the best one would +be not to use this approach at all. + +There were a number of attempts at writing a static analyser for Wails projects +but they didn't get very far. In more recent times, it has become slightly +easier to do this with more material available on the subject. + +Compared to reflection, the AST approach is much faster however it is +significantly more complicated. To start with, we may need to impose certain +constraints on how to specify bindings in the code. The goal is to support the +most common use cases and then expand it later on. + +### The Build System + +Like the declarative approach to the API, the build system was created to hide +the complexities of building a desktop application. When you run `wails build`, +it does a lot of things behind the scenes: + +- Builds the backend binary for bindings and generates the bindings +- Installs the frontend dependencies +- Builds the frontend assets +- Determines if the application icon is present and if so, embeds it +- Builds the final binary +- If the build is for `darwin/universal` it builds 2 binaries, one for + `darwin/amd64` and one for `darwin/arm64` and then creates a fat binary using + `lipo` +- If compression is required, it compresses the binary with UPX +- Determines if this binary is to be packaged and if so: + - Ensures the icon and application manifest are compiled into the binary + (Windows) + - Builds out the application bundle, generates the icon bundle and copies it, + the binary and Info.plist to the application bundle (Mac) +- If an NSIS installer is required, it builds it + +This entire process, whilst very powerful, is also very opaque. It is very +difficult to customise it and it is very difficult to debug. + +To address this in v3, I would like to move to a build system that exists +outside of Wails. After using [Task](https://taskfile.dev/) for a while, I am a +big fan of it. It is a great tool for configuring build systems and should be +reasonably familiar to anyone who has used Makefiles. + +The build system would be configured using a `Taskfile.yml` file which would be +generated by default with any of the supported templates. This would have all of +the steps required to do all the current tasks, such as building or packaging +the application, allowing for easy customisation. + +There will be no external requirement for this tooling as it would form part of +the Wails CLI. This means that you can still use `wails build` and it will do +all the things it does today. However, if you want to customise the build +process, you can do so by editing the `Taskfile.yml` file. It also means you can +easily understand the build steps and use your own build system if you wish. + +The missing piece in the build puzzle is the atomic operations in the build +process, such as icon generation, compression and packaging. To require a bunch +of external tooling would not be a great experience for the developer. To +address this, the Wails CLI will provide all these capabilities as part of the +CLI. This means that the builds still work as expected, with no extra external +tooling, however you can replace any step of the build with any tool you like. + +This will be a much more transparent build system which will allow for easier +customisation and address a lot of the issues that have been raised around it. + +## The Payoff + +These positive changes will be a huge benefit to the project: + +- The new API will be much more intuitive and will allow for more complex + applications to be built. +- Using static analysis for bindings generation will be much faster and reduce a + lot of the complexity around the current process. +- Using an established, external build system will make the build process + completely transparent, allowing for powerful customisation. + +Benefits to the project maintainers are: + +- The new API will be much easier to maintain and adapt to new features and + platforms. +- The new build system will be much easier to maintain and extend. I hope this + will lead to a new ecosystem of community driven build pipelines. +- Better separation of concerns within the project. This will make it easier to + add new features and platforms. + +## The Plan + +A lot of the experimentation for this has already been done and it's looking +good. There is no current timeline for this work but I'm hoping by the end of Q1 +2023, there will be an alpha release for Mac to allow the community to test, +experiment with and provide feedback. + +## Summary + +- The v2 API is declarative, hides a lot from the developer and not suitable for + features such as multiple windows. A new API will be created which will be + simpler, intuitive and more powerful. +- The build system is opaque and difficult to customise so we will move to an + external build system which will open it all up. +- The bindings generation is slow and complex so we will move to static analysis + which will remove a lot of the complexity the current method has. + +There has been a lot of work put into the guts of v2 and it's solid. It's now +time to address the layer on top of it and make it a much better experience for +the developer. + +I hope you are as excited about this as I am. I'm looking forward to hearing +your thoughts and feedback. + +Regards, + +‐ Lea + +PS: If you or your company find Wails useful, please consider +[sponsoring the project](https://github.com/sponsors/leaanthony). Thanks! + +PPS: Yes, that's a genuine screenshot of a multi-window application built with +Wails. It's not a mockup. It's real. It's awesome. It's coming soon. diff --git a/docs/src/content/docs/blog/2024-12-03-alpha10-and-new-release-strategy.md b/docs/src/content/docs/blog/2024-12-03-alpha10-and-new-release-strategy.md new file mode 100644 index 000000000..0cba0baa7 --- /dev/null +++ b/docs/src/content/docs/blog/2024-12-03-alpha10-and-new-release-strategy.md @@ -0,0 +1,52 @@ +--- +title: Alpha 10 Released - A New Chapter for Wails +description: Announcing Wails v3 Alpha 10 and our new daily release strategy +date: 2024-12-03 +author: The Wails Team +--- + +# Alpha 10 Released - A New Chapter for Wails + +We're thrilled to announce the release of **Wails v3 Alpha 10** - and it's big! While our release cadence may have seemed slow recently, there's been an incredible amount of work happening behind the scenes. Today marks not just another release, but a shift in how we approach the development of Wails. + +## Why the Wait? + +Like many development teams, we fell into the trap of trying to achieve perfection before each release. We wanted to squash every bug, polish every feature, and ensure everything was just right. But here's the thing - software is never truly bug-free, and waiting for that mythical state only delays getting improvements into your hands. + +## Our New Release Strategy + +Starting today, we're adopting a **daily release strategy**. Any new changes merged during the day will be released at the end of that day. This approach will: + +- Get bug fixes and features to you faster +- Provide more frequent feedback loops +- Speed up our journey to Beta +- Make the development process more transparent + +This means you might see more frequent, smaller releases rather than occasional large ones. We believe this will benefit everyone in the Wails community. + +## How You Can Help + +We've been overwhelmed by the number of people wanting to contribute to Wails! To make it easier for contributors to get involved, we're implementing a new system: + +- Firstly, we are opening up bug reporting for alpha releases. The frequent releases allow us to do this. +- Issues marked with **"Ready for Work"** are open for community contributions +- These issues have clear requirements and are ready to be tackled +- Most importantly, **we need people testing PRs** - this is one of the most valuable contributions you can make + +Testing doesn't require deep knowledge of the codebase, but it provides immense value by ensuring changes work across different environments and use cases. + +## What's Next? + +With our new daily release strategy, expect to see rapid progress toward Beta. We're committed to maintaining momentum and getting Wails v3 to a stable release as quickly as possible without sacrificing quality. + +And who knows? There might be a few surprises along the way... 😉 + +## Thank You + +To everyone who has contributed code, tested releases, reported bugs, or simply used Wails - thank you. Your support and feedback drive this project forward. + +Here's to more frequent releases, faster iteration, and an exciting journey ahead! + +--- + +*Want to get involved? Check out our [GitHub repository](https://github.com/wailsapp/wails) for issues marked "ready for work", or join our community to help test the latest changes.* \ No newline at end of file diff --git a/docs/src/content/docs/changelog.mdx b/docs/src/content/docs/changelog.mdx new file mode 100644 index 000000000..16206db25 --- /dev/null +++ b/docs/src/content/docs/changelog.mdx @@ -0,0 +1,1193 @@ +--- +title: Changelog +--- + + +Legend: +-  - macOS +- ⊞ - Windows +- 🐧 - Linux + +/*-- +All notable changes to this project will be documented in this file. + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), +and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +- `Added` for new features. +- `Changed` for changes in existing functionality. +- `Deprecated` for soon-to-be removed features. +- `Removed` for now removed features. +- `Fixed` for any bug fixes. +- `Security` in case of vulnerabilities. + +*/ + +/* + ** PLEASE DO NOT UPDATE THIS FILE ** + Updates should be added to `v3/UNRELEASED_CHANGELOG.md` + Thank you! +*/ +## [Unreleased] + +## v3.0.0-alpha.72 - 2026-02-16 + +## Fixed +- Fix 20-30 minute hangs during `wails3 build` and `wails3 dev` by excluding `node_modules/` from go-task's up-to-date checking. Previously, the `sources: "**/*"` glob caused go-task to enumerate and checksum every file in `node_modules/` (50-100k+ files with heavy dependencies like MUI), especially slow on Windows/NTFS (#4939) + +## v3.0.0-alpha.71 - 2026-02-10 + +## Added +- Bumped ghw version for better Apple device support by @leaanthony (#4977) +- Add `GetBadge` method to the dock service + +## Fixed +- Fix GTK4 build failure caused by C `Screen` typedef colliding with X11 Xlib.h (#4957) +- Fix dock badge methods consistency on macOS + +## v3.0.0-alpha.70 - 2026-02-09 + +## Added +- Add `-tags` flag to `wails3 build` command for passing custom Go build tags (e.g., `wails3 build -tags gtk4`) (#4957) +- Add documentation for automatic enum generation in binding generator, including dedicated Enums page and sidebar navigation (#4972) + +## Fixed +- Fix `InvisibleTitleBarHeight` being applied to all macOS windows instead of only frameless or transparent title bar windows (#4960) +- Fix window shaking/jitter when resizing from top corners with `InvisibleTitleBarHeight` enabled, by skipping drag initiation near window edges (#4960) +- Fix generation of mapped types with enum keys in JS/TS bindings (#4437) by @fbbdev + +## v3.0.0-alpha.69 - 2026-02-08 + +## Added +- Add `-tags` flag to `wails3 build` command for passing custom Go build tags (e.g., `wails3 build -tags gtk4`) (#4957) + +## Fixed +- Fix file drag-and-drop on Windows not working at non-100% display scaling +- Fix HTML5 internal drag-and-drop being broken when file drop was enabled on Windows +- Fix file drop coordinates being in wrong pixel space on Windows (physical vs CSS pixels) +- Fix file drag-and-drop on Linux not working reliably with hover effects +- Fix HTML5 internal drag-and-drop being broken when file drop was enabled on Linux +- Fix window show/hide on Linux/GTK4 sometimes restoring to minimized state by using `gtk_window_present()` (#4957) +- Fix window position get/set on Linux/GTK4 always returning 0,0 by adding X11-conditional support via `XTranslateCoordinates`/`XMoveWindow` (#4957) +- Fix max window size not being enforced on Linux/GTK4 by adding signal-based size clamping to replace removed `gtk_window_set_geometry_hints` (#4957) +- Fix DPI scaling on Linux/GTK4 by implementing proper PhysicalBounds calculation and fractional scaling support via `gdk_monitor_get_scale` (GTK 4.14+) +- Fix menu items duplicating when creating new windows on Linux/GTK4 +- Fix generation of mapped types with enum keys in JS/TS bindings (#4437) by @fbbdev + +## v3.0.0-alpha.68 - 2026-02-07 + +## Added +- Add Web API examples in `v3/examples/web-apis/` demonstrating 41 browser APIs including Storage (localStorage, sessionStorage, IndexedDB, Cache API), Network (Fetch, WebSocket, XMLHttpRequest, EventSource, Beacon), Media (Canvas, WebGL, Web Audio, MediaDevices, MediaRecorder, Speech Synthesis), Device (Geolocation, Clipboard, Fullscreen, Device Orientation, Vibration, Gamepad), Performance (Performance API, Mutation Observer, Intersection/Resize Observer), UI (Web Components, Pointer Events, Selection, Dialog, Drag and Drop), and more +- Add WebView API compatibility checker example (`v3/examples/webview-api-check/`) that tests 200+ browser APIs across platforms +- Add `internal/libpath` package for finding native library paths on Linux with parallel search, caching, and support for Flatpak/Snap/Nix +- **WIP:** Add experimental WebKitGTK 6.0 / GTK4 support for Linux, available via `-tags gtk4` (GTK3/WebKit2GTK 4.1 remains the default) + - Note: On tiling window managers (e.g., Hyprland, Sway), Minimize/Maximize operations may not work as expected since the WM controls window geometry + +## Changed +- **BREAKING**: Map keys in generated JS/TS bindings are now marked optional to accurately reflect Go map semantics. Map value access in Typescript now returns `T | undefined` instead of `T`, requiring null checks or assertions (#4943) by `@fbbdev` + +## Fixed +- Fix file drag-and-drop on Windows not working at non-100% display scaling +- Fix HTML5 internal drag-and-drop being broken when file drop was enabled on Windows +- Fix file drop coordinates being in wrong pixel space on Windows (physical vs CSS pixels) +- Fix file drag-and-drop on Linux not working reliably with hover effects +- Fix HTML5 internal drag-and-drop being broken when file drop was enabled on Linux +- Fix DPI scaling on Linux/GTK4 by implementing proper PhysicalBounds calculation and fractional scaling support via `gdk_monitor_get_scale` (GTK 4.14+) +- Fix menu items duplicating when creating new windows on Linux/GTK4 +- Fix generation of mapped types with enum keys in JS/TS bindings (#4437) by @fbbdev + +## v3.0.0-alpha.67 - 2026-02-04 + +## Added +- Added how to do `One Time Handlers` in the docs for `Listening to Events in JavaScript` by @AbdelhadiSeddar + +## Changed +- Changed the use of `Event` into `Events` according to changes in `@wailsio/runtime` and appropriate function calls in the docs in `Features/Events/Event System` by @AbdelhadiSeddar + +## Fixed +- Fix "ghost windows" issue on macOS caused by not accessing AppKit APIs from the Main Thread in App.Window.Current() (#4947) by @wimaha +- Fix HTML `` not working on macOS by implementing WKUIDelegate runOpenPanelWithParameters (#4862) +- Fix native file drag-and-drop not working when using `@wailsio/runtime` npm module on macOS/Linux (#4953) by @leaanthony +- Fix binding generation for cross-package type aliases (#4578) by @fbbdev + +## v3.0.0-alpha.66 - 2026-02-03 + +## Added +- Add `UseApplicationMenu` option to `WebviewWindowOptions` allowing windows on Windows/Linux to inherit the application menu set via `app.Menu.Set()` by @leaanthony + +## Changed +- Move `EnabledFeatures`, `DisabledFeatures`, and `AdditionalBrowserArgs` from per-window options to application-level `Options.Windows` (#4559) by @leaanthony + +## Fixed +- Fix OpenFileDialog crash on Linux due to GTK thread safety violation (#3683) by @ddmoney420 +- Fix SIGSEGV crash when calling `Focus()` on a hidden or destroyed window (#4890) by @ddmoney420 +- Fix potential panic when setting empty icon or bitmap on Linux (#4923) by @ddmoney420 +- Fix ErrorDialog crash when called from service binding on macOS (#3631) by @leaanthony +- Make menus to be displayed on Windows OS in `v3\examples\dialogs` by @ndianabasi +- Fix race condition causing TypeError during page reload (#4872) by @ddmoney420 +- Fix incorrect output from binding generator tests by removing global state in the `Collector.IsVoidAlias()` method (#4941) by @fbbdev +- Fix `` file picker not working on macOS (#4862) by @leaanthony + +## Removed +- **BREAKING**: Remove `EnabledFeatures`, `DisabledFeatures`, and `AdditionalLaunchArgs` from per-window `WindowsWindow` options. Use application-level `Options.Windows.EnabledFeatures`, `Options.Windows.DisabledFeatures`, and `Options.Windows.AdditionalBrowserArgs` instead. These flags apply globally to the shared WebView2 environment (#4559) by @leaanthony + +## v3.0.0-alpha.65 - 2026-02-01 + +## Added +- Add support for using `.icon` files (Apple Icon Composer format) for generating Liquid Glass icons and asset catalogs (macOS) (#4934) by @wimaha + +## v3.0.0-alpha.64 - 2026-01-26 + +## Added +- Add experimental server mode for headless/web deployments (`-tags server`). Enables running Wails apps as HTTP servers without native GUI dependencies. Build with `wails3 task build:server`. See `examples/server` for details. + +## v3.0.0-alpha.63 - 2026-01-25 + +## Fixed +- Fix `Position()` and `SetPosition()` using inconsistent coordinate systems on macOS, causing window position drift when saving/restoring state (#4816) by @leaanthony + +## v3.0.0-alpha.62 - 2026-01-22 + +## Fixed +- Fix SetProcessDpiAwarenessContext "Access is denied" error when DPI awareness is already set via application manifest (#4803) + +## v3.0.0-alpha.61 - 2026-01-20 + +## Fixed +- Update the docs page for keyboard shortcuts and corrects the type of the callback parameter for `KeyBinding.Add` by @ndianabasi +- Fix documentation regarding generating custom binding, must use `-d String` instead of `-o String` + +## v3.0.0-alpha.60 - 2026-01-14 + +## Fixed +- Fix menu not clearing children on `menu.Update()` + +## v3.0.0-alpha.59 - 2026-01-11 + +## Changed +- Update the README for the `Drag N Drop` example and highlights that `Internal Drag and Drop` is demonstrated with the example @ndianabasi + +## v3.0.0-alpha.58 - 2026-01-09 + +## Fixed +- Fix outdated Manager API references in documentation (31 files updated to use new pattern like `app.Window.New()`, `app.Event.Emit()`, etc.) by @leaanthony +- Fix Linux crash on panic in JS-bound Go methods due to WebKit overriding signal handlers (#3965) by @leaanthony + +## v3.0.0-alpha.57 - 2026-01-05 + +## Changed +- Replace various debug logs from Info to Debug (by @mbaklor) + +## Fixed +- Fix SaveFileDialog.SetFilename() having no effect on Linux (#4841) by @samstanier +- Fix drop coordinates showing as undefined in drag-n-drop example +- Fix macOS app bundle creation failing when APP_NAME contains spaces (brace expansion issue) +- Fix index out of bounds panic on Windows when calling service methods (revert goccy/go-json) + +## v3.0.0-alpha.56 - 2026-01-04 + +## Added +- Add `internal/libpath` package for finding native library paths on Linux with parallel search, caching, and support for Flatpak/Snap/Nix + +## Changed +- **BREAKING:** Rename `EnableDragAndDrop` to `EnableFileDrop` in window options +- **BREAKING:** Rename `DropZoneDetails` to `DropTargetDetails` in event context +- **BREAKING:** Rename `DropZoneDetails()` method to `DropTargetDetails()` on `WindowEventContext` +- **BREAKING:** Remove `WindowDropZoneFilesDropped` event, use `WindowFilesDropped` instead +- **BREAKING:** Change HTML attribute from `data-wails-dropzone` to `data-file-drop-target` +- **BREAKING:** Change CSS hover class from `wails-dropzone-hover` to `file-drop-target-active` +- **BREAKING:** Remove `DragEffect`, `OnEnterEffect`, `OnOverEffect` options from Windows (were part of removed IDropTarget) + +## Fixed +- Fix file drag-and-drop on Windows not working at non-100% display scaling +- Fix HTML5 internal drag-and-drop being broken when file drop was enabled on Windows +- Fix file drop coordinates being in wrong pixel space on Windows (physical vs CSS pixels) +- Fix file drag-and-drop on Linux not working reliably with hover effects +- Fix HTML5 internal drag-and-drop being broken when file drop was enabled on Linux + +## Removed +- Remove native `IDropTarget` implementation on Windows in favor of JavaScript-based approach (matches v2 behavior) + +## v3.0.0-alpha.55 - 2026-01-02 + +## Changed +- Switch to goccy/go-json for all runtime JSON processing (method bindings, events, webview requests, notifications, kvstore), improving performance by 21-63% and reducing memory allocations by 40-60% +- Optimize BoundMethod struct layout and cache isVariadic flag to reduce per-call overhead +- Use stack-allocated argument buffer for methods with `<=8` arguments to avoid heap allocations +- Optimize result collection in method calls to avoid slice allocation for single return values +- Use sync.Map for MIME type cache to improve concurrent performance +- Use buffer pool for HTTP transport request body reading +- Lazily allocate CloseNotify channel in content type sniffer to reduce per-request allocations +- Remove debug CSS logging from asset server +- Expand MIME type extension map to cover 50+ common web formats (fonts, audio, video, etc.) + +## Fixed +- Update all commands in Taskfile.yml files for all operating systems to accommodate spaces in variables such as `APP_NAME` by @ndianabasi + +## Removed +- Remove github.com/wailsapp/mimetype dependency in favor of expanded extension map + stdlib http.DetectContentType, reducing binary size by ~1.2MB +- Remove gopkg.in/ini.v1 dependency by implementing minimal .desktop file parser for Linux file explorer, saving ~45KB +- Remove samber/lo from runtime code by using Go 1.21+ stdlib slices package and minimal internal helpers, saving ~310KB + +## v3.0.0-alpha.54 - 2025-12-29 + +## Added +- Add `CollectionBehavior` option to `MacWindow` for controlling window behavior across macOS Spaces and fullscreen (#4756) by @leaanthony + +## Fixed +- Fix command argument error when executing 'build:universal:lipo:go' task on Linux by @wux1an +- Fix Docker error "undefined symbol: ___ubsan_handle_xxxxxxx" when running 'wails3 build GOOS=darwin GOARCH=arm64' on Linux by @wux1an + +## Removed +- Remove debug printf statements from Darwin URL scheme handler (#4834) + +## v3.0.0-alpha.53 - 2025-12-27 + +## Added +- Add unit tests for pkg/application by @leaanthony +- Add custom protocol support to MSIX packaging by @leaanthony + +## Fixed +- Consolidate custom protocol documentation and add Universal Links sections by @leaanthony + +## v3.0.0-alpha.52 - 2025-12-26 + +## Fixed +- Fix Windows systray menu crash when clicking icon repeatedly by adding guard against concurrent TrackPopupMenuEx calls (#4151) by @leaanthony + +## v3.0.0-alpha.51 - 2025-12-23 + +## Fixed +- Prevent app crashing when calling systray.Run() before app.Run() by @leaanthony + +## v3.0.0-alpha.50 - 2025-12-21 + +## Changed +- Update the documentation for Window `X/Y` options @ruhuang2001 + +## v3.0.0-alpha.49 - 2025-12-18 + +## Changed +- Update the `Frontend Runtime` documentation by adding more options for generating frontend bindings by @ndianabasi + +## v3.0.0-alpha.48 - 2025-12-16 + +## Added +- Add desktop environment detection on linux [PR #4797](https://github.com/wailsapp/wails/pull/4797) + +## Changed +- Update the documentation page for Wails v3 Asset Server by @ndianabasi +- **BREAKING**: Remove package-level dialog functions (`application.InfoDialog()`, `application.QuestionDialog()`, etc.). Use the `app.Dialog` manager instead: `app.Dialog.Info()`, `app.Dialog.Question()`, `app.Dialog.Warning()`, `app.Dialog.Error()`, `app.Dialog.OpenFile()`, `app.Dialog.SaveFile()` +- Update dialogs documentation to match actual API: use `app.Dialog.*`, `AddButton()` with callbacks (not `SetButtons()`), `SetDefaultButton(*Button)` (not string), `AddFilter()` (not `SetFilters()`), `SetFilename()` (not `SetDefaultFilename()`), and `app.Dialog.OpenFile().CanChooseDirectories(true)` for folder selection + +## Fixed +- Fix crash on macOS when toggling window visibility via Hide()/Show() with ApplicationShouldTerminateAfterLastWindowClosed enabled (#4389) by @leaanthony +- Fix memory leak in context menus on macOS and Windows when repeatedly opening menus (#4012) by @leaanthony +- Fix context menu native resources not being reused on macOS, causing fresh menu creation on each display (#4012) by @leaanthony + +## v3.0.0-alpha.47 - 2025-12-15 + +## Added +- Add `Window.Print()` method to JavaScript runtime for triggering print dialog from frontend (#4290) by @leaanthony + +## Fixed +- Fix macOS dock icon click not showing hidden windows when app started with `Hidden: true` (#4583) by @leaanthony +- Fix macOS print dialog not opening due to incorrect window pointer type in CGO call (#4290) by @leaanthony + +## v3.0.0-alpha.46 - 2025-12-14 + +## Added +- Add `XDG_SESSION_TYPE` to `wails3 doctor` output on Linux by @leaanthony +- Add additional WebKit2 load-change events for Linux: `WindowLoadStarted`, `WindowLoadRedirected`, `WindowLoadCommitted`, `WindowLoadFinished` (#3896) by @leaanthony + +## Removed +- **BREAKING**: Remove `linux:WindowLoadChanged` event - use `linux:WindowLoadFinished` instead for detecting when WebView has finished loading (#3896) by @leaanthony + +## v3.0.0-alpha.45 - 2025-12-13 + +## Added +- Add `XDG_SESSION_TYPE` to `wails3 doctor` output on Linux by @leaanthony +- Generate `.desktop` file during Linux build, not just packaging (#4575) +- Add Linux runtime dependencies documentation with distro-specific package names and nfpm packaging examples (#4339) by @leaanthony + +## Fixed +- Fix window menu crash on Wayland caused by appmenu-gtk-module accessing unrealized window (#4769) by @leaanthony +- Fix GTK application crash when app name contains invalid characters (spaces, parentheses, etc.) by @leaanthony +- Fix "not enough memory" error when initializing drag and drop on Windows (#4701) by @overlordtm +- Fix file explorer opening wrong directory on Linux due to incorrect URI escaping (#4397) by @leaanthony +- Fix AppImage build failure on modern Linux distributions (Arch, Fedora 39+, Ubuntu 24.04+) by auto-detecting `.relr.dyn` ELF sections and disabling stripping (#4642) by @leaanthony +- Fix `wails doctor` falsely reporting webkit packages as installed on Fedora/DNF-based systems (#4457) by @leaanthony + +## v3.0.0-alpha.44 - 2025-12-12 + +## Added +- Add NVIDIA driver version info to `wails3 doctor` output on Linux by @leaanthony + +## Changed +- **BREAKING**: Production builds are now the default. To create dev builds, set `DEV=true` in your Taskfiles. Generate a new project for examples by @leaanthony + +## Fixed +- Fix default `config.yml` would run `wails3 dev` with a production build by @mbaklor +- Fix iOS service stubs causing build failures due to non-existent package import by @leaanthony +- Fix structured logging in debug/info methods causing "no formatting directives" errors by @leaanthony +- Remove temporary debug print statements accidentally included from mobile platform merge by @leaanthony +- Fix WebKitGTK crash on Wayland with NVIDIA GPUs (Error 71 Protocol error) by auto-disabling DMA-BUF renderer by @leaanthony + +## v3.0.0-alpha.43 - 2025-12-11 + +## Added +- Add origin to raw message handler by @APshenkin in [PR](https://github.com/wailsapp/wails/pull/4710) +- Add universal link support for macOS by @APshenkin in [PR](https://github.com/wailsapp/wails/pull/4712) +- Refactor binding transport layer by @APshenkin in [PR](https://github.com/wailsapp/wails/pull/4702) +- Add aria-label identifiers to the helloworld templates so that the example app can be easily tested by Appium test clients by @chinenual in [PR](https://github.com/wailsapp/wails/pull/4760) + +## v3.0.0-alpha.42 - 2025-12-10 + +## Added +- Add origin to raw message handler by @APshenkin in [PR](https://github.com/wailsapp/wails/pull/4710) +- Add universal link support for macOS by @APshenkin in [PR](https://github.com/wailsapp/wails/pull/4712) +- Refactor binding transport layer by @APshenkin in [PR](https://github.com/wailsapp/wails/pull/4702) + +## v3.0.0-alpha.41 - 2025-11-23 + +## Fixed +- Resolve alpha value being ignored in `application.WebviewWindowOptions.BackgroundColour` on Linux ([#4722](https://github.com/wailsapp/wails/pull/4722), @BradHacker) + +## v3.0.0-alpha.40 - 2025-11-13 + +## Fixed +- Fix Windows systray icon not defaulting to application icon when no custom icon is provided (#4704) + +## v3.0.0-alpha.39 - 2025-11-12 + +## Added +- Typed Events by @fbbdev and @ianvs in [#4633](https://github.com/wailsapp/wails/pull/4633) + +## Changed +- When emitting a custom event with zero or one data argument, the data value will be assigned directly to the Data field without wrapping it in a slice by [@fbbdev](https://github.com/fbbdev) in [#4633](https://github.com/wailsapp/wails/pull/4633) + +## v3.0.0-alpha.38 - 2025-11-04 + +## Added +- Add `systray-clock` example showing a headless tray with live tooltip updates (#4653). + +## Changed +- Windows trays now honor `SystemTray.Show()`/`Hide()` by toggling `NIS_HIDDEN`, so apps can truly disappear and return (#4653). +- Tray registration reuses resolved icons, sets `NOTIFYICON_VERSION_4` once, and enables `NIF_SHOWTIP` so tooltips recover after Explorer restarts (#4653). + +## Fixed +- Track `HICON` ownership so only user-created handles are destroyed, preventing Explorer recycling crashes (#4653). +- Release the Windows system-theme listener and retained tray icons during destroy to stop leaking goroutines and device contexts (#4653). +- Truncate tray tooltips at 127 UTF-16 units to avoid corrupting surrogate pairs and multi-byte glyphs (#4653). + +## v3.0.0-alpha.37 - 2025-11-02 + +## Fixed +- Fix Windows package task failure (#4667) + +## v3.0.0-alpha.36 - 2025-10-15 + +## Fixed +- Fix Linux appimage appicon variable in Linux taskfile [PR #4644](https://github.com/wailsapp/wails/pull/4644) +- Fix Windows build error caused by go-webview2 v1.0.22 signature change (#4513, #4645) + +## v3.0.0-alpha.35 - 2025-10-14 + +## Fixed +- Fix Linux appimage appicon variable in Linux taskfile [PR #4644](https://github.com/wailsapp/wails/pull/4644) + +## v3.0.0-alpha.34 - 2025-10-06 + +## Added +- Added NSIS Protocol template for Windows by @Tolfx in #4510 +- Added tests for build-assets by @Tolfx in #4510 + +## Fixed +- Fixed linux desktop.tmpl protocol range, by removing `<.Info.Protocol>` to `<.Protocol>` by @Tolfx in #4510 +- Fixed redefinition error for liquid glass demo in [#4542](https://github.com/wailsapp/wails/pull/4542) by @Etesam913 + +## v3.0.0-alpha.33 - 2025-10-04 + +## Fixed +- Fixed systray menu updates on Linux [#4604](https://github.com/wailsapp/wails/issues/4604) by [@JackDoan](https://github.com/JackDoan) + +## v3.0.0-alpha.32 - 2025-10-02 + +## Fixed +- Fix the white window appearing on Windows when creating a hidden window by @leaanthony in [#4612](https://github.com/wailsapp/wails/pull/4612) +- Fix notifications package import path in documentation by @rxliuli in [#4617](https://github.com/wailsapp/wails/pull/4617) +- Fix drag-and-drop not working when using npm package @wailsio/runtime (#4489) by @leaanthony in #4616 + +## v3.0.0-alpha.31 - 2025-09-27 + +## Fixed +- Windows: Flicker of window at start and hidden windows being shown incorrectly in [PR](https://github.com/wailsapp/wails/pull/4600) by @leaanthony. +- Fixed Wayland window size maximising issues (https://github.com/wailsapp/wails/issues/4429) by [@samstanier](https://github.com/samstanier) + +## v3.0.0-alpha.30 - 2025-09-26 + +## Fixed +- Fixed Wayland window size maximising issues (https://github.com/wailsapp/wails/issues/4429) by [@samstanier](https://github.com/samstanier) + +## v3.0.0-alpha.29 - 2025-09-25 + +## Added +- macOS: Shows native window controls in the menu bar in [#4588](https://github.com/wailsapp/wails/pull/4588) by @nidib +- Add macOS Dock service to hide/show app icon in the dock @popaprozac in [PR](https://github.com/wailsapp/wails/pull/4451) + +## Changed +- macOS: Use `visibleFrame` instead of `frame` for window centering to exclude menu bar and dock areas + +## Fixed +- Fixed redefinition error for liquid glass demo in [#4542](https://github.com/wailsapp/wails/pull/4542) by @Etesam913 +- Fixed issue where AssetServer can crash on MacOS in [#4576](https://github.com/wailsapp/wails/pull/4576) by @jghiloni +- Fixed compilation issue when building with NextJs. Fixed in [#4585](https://github.com/wailsapp/wails/pull/4585) by @rev42 +- Fixed pipelines for nightly release in [#4597](https://github.com/wailsapp/wails/pull/4597) by @riadafridishibly + +## v3.0.0-alpha.29 - 2025-09-25 + +## Added +- Add macOS Dock service to hide/show app icon in the dock @popaprozac in [PR](https://github.com/wailsapp/wails/pull/4451) + +## Changed +- macOS: Use `visibleFrame` instead of `frame` for window centering to exclude menu bar and dock areas + +## Fixed +- Fixed redefinition error for liquid glass demo in [#4542](https://github.com/wailsapp/wails/pull/4542) by @Etesam913 +- Fixed issue where AssetServer can crash on MacOS in [#4576](https://github.com/wailsapp/wails/pull/4576) by @jghiloni +- Fixed compilation issue when building with NextJs. Fixed in [#4585](https://github.com/wailsapp/wails/pull/4585) by @rev42 +- Fixed pipelines for nightly release in [#4597](https://github.com/wailsapp/wails/pull/4597) by @riadafridishibly + +## v3.0.0-alpha.27 - 2025-09-07 + +## Fixed +- Fixed redefinition error for liquid glass demo in [#4542](https://github.com/wailsapp/wails/pull/4542) by @Etesam913 + + +## v3.0.0-alpha.26 - 2025-08-24 + +## Added +- Add native Liquid Glass effect support for macOS with NSGlassEffectView (macOS 15.0+) and NSVisualEffectView fallback, including comprehensive material customization options by @leaanthony in [#4534](https://github.com/wailsapp/wails/pull/4534) + +## v3.0.0-alpha.25 - 2025-08-16 + +## Changed +- When running `wails3 update build-assets` with the `-config` parameter, values set via the `-product*` parameters are + no longer ignored, and override the config value. + +## v3.0.0-alpha.24 - 2025-08-13 + +## Added +- Browser URL Sanitisation by @leaanthony in [#4500](https://github.dev/wailsapp/wails/pull/4500). Based on [#4484](https://github.com/wailsapp/wails/pull/4484) by @APShenkin. + +## v3.0.0-alpha.23 - 2025-08-11 + +## Fixed +- Fix SetBackgroundColour on Windows by @PPTGamer in [PR](https://github.com/wailsapp/wails/pull/4492) + +## v3.0.0-alpha.22 - 2025-08-10 + +## Added +- Add Content Protection on Windows/Mac by [@leaanthony](https://github.com/leaanthony) based on the original work of [@Taiterbase](https://github.com/Taiterbase) in this [PR](https://github.com/wailsapp/wails/pull/4241) +- Add support for passing CLI variables to Task commands through `wails3 build` and `wails3 package` aliases (#4422) by @leaanthony in [PR](https://github.com/wailsapp/wails/pull/4488) + +## Changed +- `window.NativeWindowHandle()` -> `window.NativeWindow()` by @leaanthony in [#4471](https://github.com/wailsapp/wails/pull/4471) +- Refactor internal window handling by @leaanthony in [#4471](https://github.com/wailsapp/wails/pull/4471) ++ Fix extra-broad Linux package dependencies, fix outdated RPM dependencies. + +## v3.0.0-alpha.21 - 2025-08-07 + +## Fixed +- Update docs to reflect changes from Manager API Refactoring by @yulesxoxo in [PR #4476](https://github.com/wailsapp/wails/pull/4476) +- Fix Linux .desktop file appicon variable in Linux taskfile [PR #4477](https://github.com/wailsapp/wails/pull/4477) + +## v3.0.0-alpha.20 - 2025-08-06 + +## Fixed +- Update docs to reflect changes from Manager API Refactoring by @yulesxoxo in [PR #4476](https://github.com/wailsapp/wails/pull/4476) + +## v3.0.0-alpha.19 - 2025-08-05 + +## Added +- Support for dropzones with event sourcing dropped element data [@atterpac](https://github.com/atterpac) in [#4318](https://github.com/wailsapp/wails/pull/4318) +- Added `AdditionalLaunchArgs` to `WindowsWindow` options to allow for additional command line arguments to be passed to the WebView2 browser. in [PR](https://github.com/wailsapp/wails/pull/4467) +- Added Run go mod tidy automatically after wails init [@triadmoko](https://github.com/triadmoko) in [PR](https://github.com/wailsapp/wails/pull/4286) +- Windows Snapassist feature by @leaanthony in [PR](https://github.dev/wailsapp/wails/pull/4463) + +## Fixed +- Fix Windows nil pointer dereference bug reported in [#4456](https://github.com/wailsapp/wails/issues/4456) by @leaanthony in [#4460](https://github.com/wailsapp/wails/pull/4460) +- Add support for `allowsBackForwardNavigationGestures` in macOS WKWebView to enable two-finger swipe navigation gestures (#1857) +- Fixes issue where onClick didn't work for menu items initially set as disabled by @leaanthony in [PR #4469](https://github.com/wailsapp/wails/pull/4469). Thanks to @IanVS for the initial investigation. +- Fix Vite server not being cleaned up when build fails (#4403) +- Fixed panic when closing or cancelling a `SaveFileDialog` on windows. Fixed in [PR](https://github.com/wailsapp/wails/pull/4284) by @hkhere +- Fixed HTML level drag and drop on Windows by [@mbaklor](https://github.com/mbaklor) in [#4259](https://github.com/wailsapp/wails/pull/4259) + +## v3.0.0-alpha.18 - 2025-08-03 + +## Added +- Added `AdditionalLaunchArgs` to `WindowsWindow` options to allow for additional command line arguments to be passed to the WebView2 browser. in [PR](https://github.com/wailsapp/wails/pull/4467) +- Added Run go mod tidy automatically after wails init [@triadmoko](https://github.com/triadmoko) in [PR](https://github.com/wailsapp/wails/pull/4286) +- Windows Snapassist feature by @leaanthony in [PR](https://github.dev/wailsapp/wails/pull/4463) + +## Fixed +- Add support for `allowsBackForwardNavigationGestures` in macOS WKWebView to enable two-finger swipe navigation gestures (#1857) +- Fixes issue where onClick didn't work for menu items initially set as disabled by @leaanthony in [PR #4469](https://github.com/wailsapp/wails/pull/4469). Thanks to @IanVS for the initial investigation. +- Fix Vite server not being cleaned up when build fails (#4403) + +## v3.0.0-alpha.17 - 2025-07-31 + +## Fixed +- Fixed notification parsing on Windows @popaprozac in [PR](https://github.com/wailsapp/wails/pull/4450) + +## v3.0.0-alpha.16 - 2025-07-25 + +## Added +- Add Windows `getAccentColor` implementation by [@almas-x](https://github.com/almas-x) in [PR](https://github.com/wailsapp/wails/pull/4427) + +## v3.0.0-alpha.15 - 2025-07-25 + +## Added +- Add Windows `getAccentColor` implementation by [@almas-x](https://github.com/almas-x) in [PR](https://github.com/wailsapp/wails/pull/4427) + +## v3.0.0-alpha.14 - 2025-07-25 + +## Added +- Windows dark theme menus + menubar. By @leaanthony in [a29b4f0861b1d0a700e9eb213c6f1076ec40efd5](https://github.com/wailsapp/wails/commit/a29b4f0861b1d0a700e9eb213c6f1076ec40efd5) +- Rename built-in services for clearer JS/TS bindings by @popaprozac in [PR](https://github.com/wailsapp/wails/pull/4405) + +## v3.0.0-alpha.12 - 2025-07-15 + +### Added +- `app.Env.GetAccentColor` to get the accent color of a user's system. Works on MacOS. by [@etesam913](https://github.com/etesam913) +- Add `window.ToggleFrameless()` api by [@atterpac](https://github.com/atterpac) in [#4137](https://github.com/wailsapp/wails/pull/4137) + +### Fixed +- Fixed doctor command to check for Windows SDK dependencies by [@kodumulo](https://github.com/kodumulo) in [#4390](https://github.com/wailsapp/wails/issues/4390) + + +## v3.0.0-alpha.11 - 2025-07-12 + +## Added +- Add distribution-specific build dependencies for Linux by @leaanthony in [PR](https://github.com/wailsapp/wails/pull/4345) +- Added bindings guide by @atterpac in [PR](https://github.com/wailsapp/wails/pull/4404) + +## v3.0.0-alpha.10 - 2025-07-06 + +### Breaking Changes +- **Manager API Refactoring**: Reorganized application API from flat structure to organized managers for better code organization and discoverability by [@leaanthony](https://github.com/leaanthony) in [#4359](https://github.com/wailsapp/wails/pull/4359) + - `app.NewWebviewWindow()` → `app.Window.New()` + - `app.CurrentWindow()` → `app.Window.Current()` + - `app.GetAllWindows()` → `app.Window.GetAll()` + - `app.WindowByName()` → `app.Window.GetByName()` + - `app.EmitEvent()` → `app.Event.Emit()` + - `app.OnApplicationEvent()` → `app.Event.OnApplicationEvent()` + - `app.OnWindowEvent()` → `app.Event.OnWindowEvent()` + - `app.SetApplicationMenu()` → `app.Menu.SetApplicationMenu()` + - `app.OpenFileDialog()` → `app.Dialog.OpenFile()` + - `app.SaveFileDialog()` → `app.Dialog.SaveFile()` + - `app.MessageDialog()` → `app.Dialog.Message()` + - `app.InfoDialog()` → `app.Dialog.Info()` + - `app.WarningDialog()` → `app.Dialog.Warning()` + - `app.ErrorDialog()` → `app.Dialog.Error()` + - `app.QuestionDialog()` → `app.Dialog.Question()` + - `app.NewSystemTray()` → `app.SystemTray.New()` + - `app.GetSystemTray()` → `app.SystemTray.Get()` + - `app.ShowContextMenu()` → `app.ContextMenu.Show()` + - `app.RegisterKeybinding()` → `app.KeyBinding.Register()` + - `app.UnregisterKeybinding()` → `app.KeyBinding.Unregister()` + - `app.GetPrimaryScreen()` → `app.Screen.GetPrimary()` + - `app.GetAllScreens()` → `app.Screen.GetAll()` + - `app.BrowserOpenURL()` → `app.Browser.OpenURL()` + - `app.Environment()` → `app.Env.GetAll()` + - `app.ClipboardGetText()` → `app.Clipboard.Text()` + - `app.ClipboardSetText()` → `app.Clipboard.SetText()` +- Renamed Service methods: `Name` -> `ServiceName`, `OnStartup` -> `ServiceStartup`, `OnShutdown` -> `ServiceShutdown` by [@leaanthony](https://github.com/leaanthony) +- Moved `Path` and `Paths` methods to `application` package by [@leaanthony](https://github.com/leaanthony) +- The application menu is now macOS only by [@leaanthony](https://github.com/leaanthony) + +### Added + +- **Organized Testing Infrastructure**: Moved Docker test files to dedicated `test/docker/` directory with optimized images and enhanced build reliability by [@leaanthony](https://github.com/leaanthony) in [#4359](https://github.com/wailsapp/wails/pull/4359) +- **Improved Resource Management Patterns**: Added proper event handler cleanup and context-aware goroutine management in examples by [@leaanthony](https://github.com/leaanthony) in [#4359](https://github.com/wailsapp/wails/pull/4359) +- Support aarch64 AppImage builds by [@AkshayKalose](https://github.com/AkshayKalose) in [#3981](https://github.com/wailsapp/wails/pull/3981) +- Add diagnostics section to `wails doctor` by [@leaanthony](https://github.com/leaanthony) +- Add window to context when calling a service method by [@leaanthony](https://github.com/leaanthony) +- Add `window-call` example to demonstrate how to know which window is calling a service by [@leaanthony](https://github.com/leaanthony) +- New Menu guide by [@leaanthony](https://github.com/leaanthony) +- Better panic handling by [@leaanthony](https://github.com/leaanthony) +- New Menu guide by [@leaanthony](https://github.com/leaanthony) +- Add doc comments for Service API by [@fbbdev](https://github.com/fbbdev) in [#4024](https://github.com/wailsapp/wails/pull/4024) +- Add function `application.NewServiceWithOptions` to initialise services with additional configuration by [@leaanthony](https://github.com/leaanthony) in [#4024](https://github.com/wailsapp/wails/pull/4024) +- Improved menu control by [@FalcoG](https://github.com/FalcoG) and [@leaanthony](https://github.com/leaanthony) in [#4031](https://github.com/wailsapp/wails/pull/4031) +- More documentation by [@leaanthony](https://github.com/leaanthony) +- Support cancellation of events in standard event listeners by [@leaanthony](https://github.com/leaanthony) +- Systray `Hide`, `Show` and `Destroy` support by [@leaanthony](https://github.com/leaanthony) +- Systray `SetTooltip` support by [@leaanthony](https://github.com/leaanthony). Original idea by [@lujihong](https://github.com/wailsapp/wails/issues/3487#issuecomment-2633242304) +- Report package path in binding generator warnings about unsupported types by [@fbbdev](https://github.com/fbbdev) in [#4045](https://github.com/wailsapp/wails/pull/4045) +- Add binding generator support for generic aliases by [@fbbdev](https://github.com/fbbdev) in [#4045](https://github.com/wailsapp/wails/pull/4045) +- Add binding generator support for `omitzero` JSON flag by [@fbbdev](https://github.com/fbbdev) in [#4045](https://github.com/wailsapp/wails/pull/4045) +- Add `//wails:ignore` directive to prevent binding generation for chosen service methods by [@fbbdev](https://github.com/fbbdev) in [#4045](https://github.com/wailsapp/wails/pull/4045) +- Add `//wails:internal` directive on services and models to allow for types that are exported in Go but not in JS/TS by [@fbbdev](https://github.com/fbbdev) in [#4045](https://github.com/wailsapp/wails/pull/4045) +- Add binding generator support for constants of alias type to allow for weakly typed enums by [@fbbdev](https://github.com/fbbdev) in [#4045](https://github.com/wailsapp/wails/pull/4045) +- Add binding generator tests for Go 1.24 features by [@fbbdev](https://github.com/fbbdev) in [#4068](https://github.com/wailsapp/wails/pull/4068) +- Add support for macOS 15 "Sequoia" to `OSInfo.Branding` for improved OS version detection in [#4065](https://github.com/wailsapp/wails/pull/4065) +- Add `PostShutdown` hook for running custom code after the shutdown process completes by [@fbbdev](https://github.com/fbbdev) in [#4066](https://github.com/wailsapp/wails/pull/4066) +- Add `FatalError` struct to support detection of fatal errors in custom error handlers by [@fbbdev](https://github.com/fbbdev) in [#4066](https://github.com/wailsapp/wails/pull/4066) +- Standardise and document service startup and shutdown order by [@fbbdev](https://github.com/fbbdev) in [#4066](https://github.com/wailsapp/wails/pull/4066) +- Add test harness for application startup/shutdown sequence and service startup/shutdown tests by [@fbbdev](https://github.com/fbbdev) in [#4066](https://github.com/wailsapp/wails/pull/4066) +- Add `RegisterService` method for registering services after the application has been created by [@fbbdev](https://github.com/fbbdev) in [#4066](https://github.com/wailsapp/wails/pull/4066) +- Add `MarshalError` field in application and service options for custom error handling in binding calls by [@fbbdev](https://github.com/fbbdev) in [#4066](https://github.com/wailsapp/wails/pull/4066) +- Add cancellable promise wrapper that propagates cancellation requests through promise chains by [@fbbdev](https://github.com/fbbdev) in [#4100](https://github.com/wailsapp/wails/pull/4100) +- Add the ability to tie binding call cancellation to an `AbortSignal` by [@fbbdev](https://github.com/fbbdev) in [#4100](https://github.com/wailsapp/wails/pull/4100) +- Support `data-wml-*` attributes for WML alongside the usual `wml-*` attributes by [@leaanthony](https://github.com/leaanthony) +- Add `Configure` method on all services for late configuration/dynamic reconfiguration by [@fbbdev](https://github.com/fbbdev) in [#4067](https://github.com/wailsapp/wails/pull/4067) +- `fileserver` service sends a 503 Service Unavailable response when unconfigured by [@fbbdev](https://github.com/fbbdev) in [#4067](https://github.com/wailsapp/wails/pull/4067) +- `kvstore` service provides an in-memory key-value store by default when unconfigured by [@fbbdev](https://github.com/fbbdev) in [#4067](https://github.com/wailsapp/wails/pull/4067) +- Add `Load` method on `kvstore` service to reload data from file after config changes by [@fbbdev](https://github.com/fbbdev) in [#4067](https://github.com/wailsapp/wails/pull/4067) +- Add `Clear` method on `kvstore` service to delete all keys by [@fbbdev](https://github.com/fbbdev) in [#4067](https://github.com/wailsapp/wails/pull/4067) +- Add type `Level` in `log` service to provide JS-side log-level constants by [@fbbdev](https://github.com/fbbdev) in [#4067](https://github.com/wailsapp/wails/pull/4067) +- Add `Log` method on `log` service to specify log-level dynamically by [@fbbdev](https://github.com/fbbdev) in [#4067](https://github.com/wailsapp/wails/pull/4067) +- `sqlite` service provides an in-memory DB by default when unconfigured by [@fbbdev](https://github.com/fbbdev) in [#4067](https://github.com/wailsapp/wails/pull/4067) +- Add method `Close` on `sqlite` service to close the DB manually by [@fbbdev](https://github.com/fbbdev) in [#4067](https://github.com/wailsapp/wails/pull/4067) +- Add cancellation support for query methods on `sqlite` service by [@fbbdev](https://github.com/fbbdev) in [#4067](https://github.com/wailsapp/wails/pull/4067) +- Add prepared statement support to `sqlite` service with JS bindings by [@fbbdev](https://github.com/fbbdev) in [#4067](https://github.com/wailsapp/wails/pull/4067) +- Gin support by [Lea Anthony](https://github.com/leaanthony) in [PR](https://github.com/wailsapp/wails/pull/3537) based on the original work of [@AnalogJ](https://github.com/AnalogJ) in this [PR](https://github.com/wailsapp/wails/pull/3537) +- Fix auto save and password auto save always enabled by [@oSethoum](https://github.com/osethoum) in [#4134](https://github.com/wailsapp/wails/pull/4134) +- Add `SetMenu()` on window to allow for setting a menu on a window by [@leaanthony](https://github.com/leaanthony) +- Add Notification support by [@popaprozac](https://github.com/popaprozac) in [#4098](https://github.com/wailsapp/wails/pull/4098) +-  Add File Association support for mac by [@wimaha](https://github.com/wimaha) in [#4177](https://github.com/wailsapp/wails/pull/4177) +- Add `wails3 tool version` for semantic version bumping by [@leaanthony](https://github.com/leaanthony) +- Add badging support for macOS and Windows by [@popaprozac](https://github.com/popaprozac) in [#](https://github.com/wailsapp/wails/pull/4234) +- Add support for registered/strictly-typed events by [@fbbdev](https://github.com/fbbdev) and [@IanVS](https://github.com/IanVS) in [#4161](https://github.com/wailsapp/wails/pull/4161) +- Add the ability to register hooks for custom events by [@fbbdev](https://github.com/fbbdev) and [@IanVS](https://github.com/IanVS) in [#4161](https://github.com/wailsapp/wails/pull/4161) + +### Fixed + +- Fixed nil pointer dereference in processURLRequest for Mac by [@etesam913](https://github.com/etesam913) in [#4366](https://github.com/wailsapp/wails/pull/4366) +- Fixed a linux bug preventing filtered dialogs by [@bh90210](https://github.com/bh90210) in [#4287](https://github.com/wailsapp/wails/pull/4287) +- Fixed Windows+Linux Edit Menu issues by [@leaanthony](https://github.com/leaanthony) in [#3f78a3a](https://github.com/wailsapp/wails/commit/3f78a3a8ce7837e8b32242c8edbbed431c68c062) +- Updated the minimum system version in macOS .plist files from 10.13.0 to 10.15.0 by [@AkshayKalose](https://github.com/AkshayKalose) in [#3981](https://github.com/wailsapp/wails/pull/3981) +- Window ID skip issue by [@leaanthony](https://github.com/leaanthony) +- Fix nil menu issue when calling RegisterContextMenu by [@leaanthony](https://github.com/leaanthony) +- Fixed dependency cycles in binding generator output by [@fbbdev](https://github.com/fbbdev) in [#4001](https://github.com/wailsapp/wails/pull/4001) +- Fixed use-before-define errors in binding generator output by [@fbbdev](https://github.com/fbbdev) in [#4001](https://github.com/wailsapp/wails/pull/4001) +- Pass build flags to binding generator by [@fbbdev](https://github.com/fbbdev) in [#4023](https://github.com/wailsapp/wails/pull/4023) +- Change paths in windows Taskfile to forward slashes to ensure it works on non-Windows platforms by [@leaanthony](https://github.com/leaanthony) +- Mac + Mac JS events now fixed by [@leaanthony](https://github.com/leaanthony) +- Fixed event deadlock for macOS by [@leaanthony](https://github.com/leaanthony) +- Fixed a `Parameter incorrect` error in Window initialisation on Windows when HTML provided but no JS by [@leaanthony](https://github.com/leaanthony) +- Fixed size of response prefix used for content type sniffing in asset server by [@fbbdev](https://github.com/fbbdev) in [#4049](https://github.com/wailsapp/wails/pull/4049) +- Fixed handling of non-404 responses on root index path in asset server by [@fbbdev](https://github.com/fbbdev) in [#4049](https://github.com/wailsapp/wails/pull/4049) +- Fixed undefined behaviour in binding generator when testing properties of generic types by [@fbbdev](https://github.com/fbbdev) in [#4045](https://github.com/wailsapp/wails/pull/4045) +- Fixed binding generator output for models when underlying type has not the same properties as named wrapper by [@fbbdev](https://github.com/fbbdev) in [#4045](https://github.com/wailsapp/wails/pull/4045) +- Fixed binding generator output for map key types and preprocessing by [@fbbdev](https://github.com/fbbdev) in [#4045](https://github.com/wailsapp/wails/pull/4045) +- Fixed binding generator output for structs that implement marshaler interfaces by [@fbbdev](https://github.com/fbbdev) in [#4045](https://github.com/wailsapp/wails/pull/4045) +- Fixed detection of type cycles involving generic types in binding generator by [@fbbdev](https://github.com/fbbdev) in [#4045](https://github.com/wailsapp/wails/pull/4045) +- Fixed invalid references to unexported models in binding generator output by [@fbbdev](https://github.com/fbbdev) in [#4045](https://github.com/wailsapp/wails/pull/4045) +- Moved injected code to the end of service files by [@fbbdev](https://github.com/fbbdev) in [#4045](https://github.com/wailsapp/wails/pull/4045) +- Fixed handling of errors from file close operations in binding generator by [@fbbdev](https://github.com/fbbdev) in [#4045](https://github.com/wailsapp/wails/pull/4045) +- Suppressed warnings for services that define lifecycle or http methods but no other bound methods by [@fbbdev](https://github.com/fbbdev) in [#4045](https://github.com/wailsapp/wails/pull/4045) +- Fixed non-React templates failing to display Hello World footer when using light system colour scheme by [@marcus-crane](https://github.com/marcus-crane) in [#4056](https://github.com/wailsapp/wails/pull/4056) +- Fixed hidden menu items on macOS by [@leaanthony](https://github.com/leaanthony) +- Fixed handling and formatting of errors in message processors by [@fbbdev](https://github.com/fbbdev) in [#4066](https://github.com/wailsapp/wails/pull/4066) +-  Fixed skipped service shutdown when quitting application by [@fbbdev](https://github.com/fbbdev) in [#4066](https://github.com/wailsapp/wails/pull/4066) +-  Ensure menu updates occur on the main thread by [@leaanthony](https://github.com/leaanthony) +- The dragging and resizing mechanism is now more robust and matches expected platform behaviour more closely by [@fbbdev](https://github.com/fbbdev) in [#4100](https://github.com/wailsapp/wails/pull/4100) +- Fixed [#4097](https://github.com/wailsapp/wails/issues/4097) Webpack/angular discards runtime init code by [@fbbdev](https://github.com/fbbdev) in [#4100](https://github.com/wailsapp/wails/pull/4100) +- Fixed initially-hidden menu items by [@IanVS](https://github.com/IanVS) in [#4116](https://github.com/wailsapp/wails/pull/4116) +- Fixed assetFileServer not serving `.html` files when non-extension request when `[request]` doesn't exist but `[request].html` does +- Fixed icon generation paths by [@robin-samuel](https://github.com/robin-samuel) in [#4125](https://github.com/wailsapp/wails/pull/4125) +- Fixed `fullscreen`, `unfullscreen`, `unminimise` and `unmaximise` events not being emitted by [@oSethoum](https://github.com/osethoum) in [#4130](https://github.com/wailsapp/wails/pull/4130) +- Fixed NSIS Error because of incorrect prefix on default version in config by [@robin-samuel](https://github.com/robin-samuel) in [#4126](https://github.com/wailsapp/wails/pull/4126) +- Fixed Dialogs runtime function returning escaped paths on Windows by [TheGB0077](https://github.com/TheGB0077) in [#4188](https://github.com/wailsapp/wails/pull/4188) +- Fixed Webview2 detection path in HKCU by [@leaanthony](https://github.com/leaanthony). +- Fixed input issue with macOS by [@leaanthony](https://github.com/leaanthony). +- Fixed Windows icon generation task file name by [@yulesxoxo](https://github.com/yulesxoxo) in [#4219](https://github.com/wailsapp/wails/pull/4219). +- Fixed transparency issue for frameless windows by [@leaanthony](https://github.com/leaanthony) based on work by @kron. +- Fixed focus calls when window is disabled or minimised by [@leaanthony](https://github.com/leaanthony) based on work by @kron. +- Fixed system trays not showing after taskbar restarts by [@leaanthony](https://github.com/leaanthony) based on work by @kron. +- Fixed fallbackResponseWriter not implementing Flush() in [#4245](https://github.com/wailsapp/wails/pull/4245) +- Fixed fallbackResponseWriter not implementing Flush() by [@superDingda] in [#4236](https://github.com/wailsapp/wails/issues/4236) +- Fixed macOS window close with pending async Go-bound function call crashes by [@joshhardy](https://github.com/joshhardy) in [#4354](https://github.com/wailsapp/wails/pull/4354) +- Fixed Windows Efficiency mode startup race condition by [@leaanthony](https://github.com/leaanthony) +- Fixed Windows icon handle cleanup by [@leaanthony](https://github.com/leaanthony). +- Fixed `OpenFileManager` on Windows by [@PPTGamer](https://github.com/PPTGamer) in [#4375](https://github.com/wailsapp/wails/pull/4375). + +### Changed + +- Removed `application.WindowIDKey` and `application.WindowNameKey` (replaced by `application.WindowKey`) by [@leaanthony](https://github.com/leaanthony) +- ContextMenuData now returns a string instead of any by [@leaanthony](https://github.com/leaanthony) +- In JS/TS bindings, class fields of fixed-length array types are now initialized with their expected length instead of being empty by [@fbbdev](https://github.com/fbbdev) in [#4001](https://github.com/wailsapp/wails/pull/4001) +- ContextMenuData now returns a string instead of any by [@leaanthony](https://github.com/leaanthony) +- `application.NewService` does not accept options as an optional parameter anymore (use `application.NewServiceWithOptions` instead) by [@leaanthony](https://github.com/leaanthony) in [#4024](https://github.com/wailsapp/wails/pull/4024) +- Removed `nanoid` dependency by [@leaanthony](https://github.com/leaanthony) +- Updated Window example for mica/acrylic/tabbed window styles by [@leaanthony](https://github.com/leaanthony) +- In JS/TS bindings, `internal.js/ts` model files have been removed; all models can now be found in `models.js/ts` by [@fbbdev](https://github.com/fbbdev) in [#4045](https://github.com/wailsapp/wails/pull/4045) +- In JS/TS bindings, named types are never rendered as aliases for other named types; the old behaviour is now restricted to aliases by [@fbbdev](https://github.com/fbbdev) in [#4045](https://github.com/wailsapp/wails/pull/4045) +- In JS/TS bindings, in class mode, struct fields whose type is a type parameter are marked optional and never initialised automatically by [@fbbdev](https://github.com/fbbdev) in [#4045](https://github.com/wailsapp/wails/pull/4045) +- Remove ESLint from templates by by [@IanVS](https://github.com/IanVS) in [#4059](https://github.com/wailsapp/wails/pull/4059) +- Update copyright date to 2025 by [@IanVS](https://github.com/IanVS) in [#4037](https://github.com/wailsapp/wails/pull/4037) +- Add docs for event.Sender by [@IanVS](https://github.com/IanVS) in [#4075](https://github.com/wailsapp/wails/pull/4075) +- Go 1.24 support by [@leaanthony](https://github.com/leaanthony) +- `ServiceStartup` hooks are now invoked when `App.Run` is called, not in `application.New` by [@fbbdev](https://github.com/fbbdev) in [#4066](https://github.com/wailsapp/wails/pull/4066) +- `ServiceStartup` errors are now returned from `App.Run` instead of terminating the process by [@fbbdev](https://github.com/fbbdev) in [#4066](https://github.com/wailsapp/wails/pull/4066) +- Binding and dialog calls from JS now reject with error objects instead of strings by [@fbbdev](https://github.com/fbbdev) in [#4066](https://github.com/wailsapp/wails/pull/4066) +- Improved systray menu positioning on Windows by [@leaanthony](https://github.com/leaanthony) +- The JS runtime has been ported to TypeScript by [@fbbdev](https://github.com/fbbdev) in [#4100](https://github.com/wailsapp/wails/pull/4100) +- The runtime initialises as soon as it is imported, no need to wait for the window to load by [@fbbdev](https://github.com/fbbdev) in [#4100](https://github.com/wailsapp/wails/pull/4100) +- The runtime does not export an init method anymore. A side effects import can be used to initialise it by [@fbbdev](https://github.com/fbbdev) in [#4100](https://github.com/wailsapp/wails/pull/4100) +- Bound methods now return a `CancellablePromise` that rejects with a `CancelError` if cancelled. The actual result of the call is discarded by [@fbbdev](https://github.com/fbbdev) in [#4100](https://github.com/wailsapp/wails/pull/4100) +- Built-in service types are now consistently called `Service` by [@fbbdev](https://github.com/fbbdev) in [#4067](https://github.com/wailsapp/wails/pull/4067) +- Built-in service creation functions with options are now consistently called `NewWithConfig` by [@fbbdev](https://github.com/fbbdev) in [#4067](https://github.com/wailsapp/wails/pull/4067) +- `Select` method on `sqlite` service is now named `Query` for consistency with Go APIs by [@fbbdev](https://github.com/fbbdev) in [#4067](https://github.com/wailsapp/wails/pull/4067) +- Templates: moved runtime to "dependencies", organized package.json files by [@IanVS](https://github.com/IanVS) in [#4133](https://github.com/wailsapp/wails/pull/4133) +- Creates and ad-hoc signs app bundles in dev to enable certain macOS APIs by [@popaprozac](https://github.com/popaprozac) in [#4171](https://github.com/wailsapp/wails/pull/4171) + +## v3.0.0-alpha.9 - 2025-01-13 + +### Added + +- `app.OpenFileManager(path string, selectFile bool)` to open the system file manager to the path `path` with optional highlighting via `selectFile` by [@Krzysztofz01](https://github.com/Krzysztofz01) [@rcalixte](https://github.com/rcalixte) +- New `-git` flag for `wails3 init` command by [@leaanthony](https://github.com/leaanthony) +- New `wails3 generate webview2bootstrapper` command by [@leaanthony](https://github.com/leaanthony) +- Added `init()` method in runtime to allow manual initialisation of the runtime by [@leaanthony](https://github.com/leaanthony) +- Added `WindowDidMoveDebounceMS` option to Window's WindowOptions by [@leaanthony](https://github.com/leaanthony) +- Added Single Instance feature by [@leaanthony](https://github.com/leaanthony). Based on the [v2 PR](https://github.com/wailsapp/wails/pull/2951) by @APshenkin. +- `wails3 generate template` command by [@leaanthony](https://github.com/leaanthony) +- `wails3 releasenotes` command by [@leaanthony](https://github.com/leaanthony) +- `wails3 update cli` command by [@leaanthony](https://github.com/leaanthony) +- `-clean` option for `wails3 generate bindings` command by [@leaanthony](https://github.com/leaanthony) +- Allow for aarch64 (arm64) AppImage Linux builds by [@AkshayKalose](https://github.com/AkshayKalose) in [#3981](https://github.com/wailsapp/wails/pull/3981) + +### Fixed + +- Fixed min/max width options for linux by @atterpac in [#3979](https://github.com/wailsapp/wails/pull/3979) +- Typescript templates types definitions via npm version bump by @atterpac in [#3966](https://github.com/wailsapp/wails/pull/3966) +- Fix Sveltekit template CSS referance by @atterpac in [#3945](https://github.com/wailsapp/wails/pull/3945) +- Ensure key callbacks in window run() are called on the main thread by [@leaanthony](https://github.com/leaanthony) +- Fix dialog directory chooser examples by [@leaanthony](https://github.com/leaanthony) +- Created new Chinese error page when index.html is missing by [@leaanthony](https://github.com/leaanthony) +-  Ensure `windowDidBecomeKey` callback is running on main thread by [@leaanthony](https://github.com/leaanthony) +-  Support fullscreen for frameless windows by [@leaanthony](https://github.com/leaanthony) +-  Improved window destroying logic by [@leaanthony](https://github.com/leaanthony) +-  Fix window position logic when attached to system trays by [@leaanthony](https://github.com/leaanthony) +-  Support fullscreen for frameless windows by [@leaanthony](https://github.com/leaanthony) +- Fix event handling by [@leaanthony](https://github.com/leaanthony) +- Fixed window shutdown logic by [@leaanthony](https://github.com/leaanthony) +- Common taskfile now defaults to generating Typescript bindings for Typescript templates by [@leaanthony](https://github.com/leaanthony) +- Fix Close application on WM_CLOSE message when no windows are open/systray only by [@mmalcek](https://github.com/mmalcek) in [#3990](https://github.com/wailsapp/wails/pull/3990) +- Fixed garble build by @5aaee9 in [#3192](https://github.com/wailsapp/wails/pull/3192) +- Fixed windows nsis builds by [@leaanthony](https://github.com/leaanthony) + +### Changed + +- Moved build assets to platform specific directories by [@leaanthony](https://github.com/leaanthony) +- Moved and renamed Taskfiles to platform specific directories by [@leaanthony](https://github.com/leaanthony) +- Created a much better experience when `index.html` is missing by [@leaanthony](https://github.com/leaanthony) +- [Windows] Improved performance of minimise and restore by [@leaanthony](https://github.com/leaanthony). Based on original [PR](https://github.com/wailsapp/wails/pull/3955) by [562589540](https://github.com/562589540) +- Removed `ShouldClose` option (Register a hook for events.Common.WindowClosing instead) by [@leaanthony](https://github.com/leaanthony) +- [Windows] Reduced flicker when opening a window by [@leaanthony](https://github.com/leaanthony) +- Removed `Window.Destroy` as this was intended to be an internal function by [@leaanthony](https://github.com/leaanthony) +- Renamed `WindowClose` events to `WindowClosing` by [@leaanthony](https://github.com/leaanthony) +- Frontend builds now use vite environment "development" or "production" depending on build type by [@leaanthony](https://github.com/leaanthony) +- Update to go-webview2 v1.19 by [@leaanthony](https://github.com/leaanthony) + +## v3.0.0-alpha.8.3 - 2024-12-07 + +### Changed + +- Ensure fork of taskfile is used by @leaanthony + +## v3.0.0-alpha.8.2 - 2024-12-07 + +### Changed + +- Update fork of Taskfile to fix version issues when installing using + `go install` by @leaanthony + +## v3.0.0-alpha.8.1 - 2024-12-07 + +### Changed + +- Using fork of Taskfile to fix version issues when installing using + `go install` by @leaanthony + +## v3.0.0-alpha.8 - 2024-12-06 + +### Added + +- Added hyperlink for sponsor by @ansxuman in [#3958](https://github.com/wailsapp/wails/pull/3958) +- Support of linux packaging of deb,rpm, and arch linux packager builds by + @atterpac in [#3909](https://github.com/wailsapp/wails/3909) +- Added Support for darwin universal builds and packages by + [ansxuman](https://github.com/ansxuman) in + [#3902](https://github.com/wailsapp/wails/pull/3902) +- Events documentation to the website by + [atterpac](https://github.com/atterpac) in + [#3867](https://github.com/wailsapp/wails/pull/3867) +- Templates for sveltekit and sveltekit-ts that are set for non-SSR development + by [atterpac](https://github.com/atterpac) in + [#3829](https://github.com/wailsapp/wails/pull/3829) +- Update build assets using new `wails3 update build-assets` command by + [leaanthony](https://github.com/leaanthony) +- Example to test the HTML Drag and Drop API by + [FerroO2000](https://github.com/FerroO2000) in + [#3856](https://github.com/wailsapp/wails/pull/3856) +- File Association support by [leaanthony](https://github.com/leaanthony) in + [#3873](https://github.com/wailsapp/wails/pull/3873) +- New `wails3 generate runtime` command by + [leaanthony](https://github.com/leaanthony) +- New `InitialPosition` option to specify if the window should be centered or + positioned at the given X/Y location by + [leaanthony](https://github.com/leaanthony) in + [#3885](https://github.com/wailsapp/wails/pull/3885) +- Add `Path` & `Paths` methods to `application` package by + [ansxuman](https://github.com/ansxuman) and + [leaanthony](https://github.com/leaanthony) in + [#3823](https://github.com/wailsapp/wails/pull/3823) +- Added `GeneralAutofillEnabled` and `PasswordAutosaveEnabled` Windows options + by [leaanthony](https://github.com/leaanthony) in + [#3766](https://github.com/wailsapp/wails/pull/3766) +- Added the ability to retrieve the window calling a service method by + [leaanthony](https://github.com/leaanthony) in + [#3888](https://github.com/wailsapp/wails/pull/3888) +- Added `EnabledFeatures` and `DisabledFeatures` options for Webview2 by + [leaanthony](https://github.com/leaanthony). +- + +### Changed + +- `service.OnStartup` now shutdowns the application on error and runs + `service.OnShutdown`for any prior services that started by @atterpac in + [#3920](https://github.com/wailsapp/wails/pull/3920) +- Refactored systray click messaging to better align with user interactions by + @atterpac in [#3907](https://github.com/wailsapp/wails/pull/3907) +- Asset embed to include `all:frontend/dist` to support frameworks that generate + subfolders by @atterpac in + [#3887](https://github.com/wailsapp/wails/pull/3887) +- Taskfile refactor by [leaanthony](https://github.com/leaanthony) in + [#3748](https://github.com/wailsapp/wails/pull/3748) +- Upgrade to `go-webview2` v1.0.16 by + [leaanthony](https://github.com/leaanthony) +- Fixed `Screen` type to include `ID` not `Id` by + [etesam913](https://github.com/etesam913) in + [#3778](https://github.com/wailsapp/wails/pull/3778) +- Update `go.mod.tmpl` wails version to support `application.ServiceOptions` by + [northes](https://github.com/northes) in + [#3836](https://github.com/wailsapp/wails/pull/3836) +- Fixed service name determination by [windom](https://github.com/windom/) in + [#3827](https://github.com/wailsapp/wails/pull/3827) +- mkdocs serve now uses docker by [leaanthony](https://github.com/leaanthony) +- Consolidated dev config into `config.yml` by + [leaanthony](https://github.com/leaanthony) +- Systray dialog now defaults to the application icon if available (Windows) by + [@leaanthony](https://github.com/leaanthony) +- Better reporting of GPU + Memory for macOS by + [@leaanthony](https://github.com/leaanthony) +- Removed `WebviewGpuIsDisabled` and `EnableFraudulentWebsiteWarnings` + (superseded by `EnabledFeatures` and `DisabledFeatures` options) by + [leaanthony](https://github.com/leaanthony) + +### Fixed + +- Fixed deadlock in Linux dialog for multiple selections caused by unclosed + channel variable by @michael-freling in + [#3925](https://github.com/wailsapp/wails/pull/3925) +- Fixed cross-platform cleanup for .syso files during Windows build by + [ansxuman](https://github.com/ansxuman) in + [#3924](https://github.com/wailsapp/wails/pull/3924) +- Fixed amd64 appimage compile by @atterpac in + [#3898](https://github.com/wailsapp/wails/pull/3898) +- Fixed build assets update by @ansxuman in + [#3901](https://github.com/wailsapp/wails/pull/3901) +- Fixed Linux systray `OnClick` and `OnRightClick` implementation by @atterpac + in [#3886](https://github.com/wailsapp/wails/pull/3886) +- Fixed `AlwaysOnTop` not working on Mac by + [leaanthony](https://github.com/leaanthony) in + [#3841](https://github.com/wailsapp/wails/pull/3841) +-  Fixed `application.NewEditMenu` including a duplicate + `PasteAndMatchStyle` role in the edit menu on Darwin by + [johnmccabe](https://github.com/johnmccabe) in + [#3839](https://github.com/wailsapp/wails/pull/3839) +- 🐧 Fixed aarch64 compilation + [#3840](https://github.com/wailsapp/wails/issues/3840) in + [#3854](https://github.com/wailsapp/wails/pull/3854) by + [kodflow](https://github.com/kodflow) +- ⊞ Fixed radio group menu items by + [@leaanthony](https://github.com/leaanthony) +- Fix error on building runnable .app on MacOS when 'name' and 'outputfilename' + are different. by @nickisworking in + [#3789](https://github.com/wailsapp/wails/pull/3789) + +## v3.0.0-alpha.7 - 2024-09-18 + +### Added + +- ⊞ New DIP system for Enhanced High DPI Monitor Support by + [mmghv](https://github.com/mmghv) in + [#3665](https://github.com/wailsapp/wails/pull/3665) +- ⊞ Window class name option by [windom](https://github.com/windom/) in + [#3682](https://github.com/wailsapp/wails/pull/3682) +- Services have been expanded to provide plugin functionality. By + [atterpac](https://github.com/atterpac) and + [leaanthony](https://github.com/leaanthony) in + [#3570](https://github.com/wailsapp/wails/pull/3570) + +### Changed + +- Events API change: `On`/`Emit` -> user events, `OnApplicationEvent` -> + Application Events `OnWindowEvent` -> Window Events, by + [leaanthony](https://github.com/leaanthony) +- Fix for Events API on Linux by [TheGB0077](https://github.com/TheGB0077) in + [#3734](https://github.com/wailsapp/wails/pull/3734) +- [CI] improvements to actions & enable to run actions also in forks and + branches prefixed with `v3/` or `v3-` by + [stendler](https://github.com/stendler) in + [#3747](https://github.com/wailsapp/wails/pull/3747) + +### Fixed + +- Fixed bug with usage of customEventProcessor in drag-n-drop example by + [etesam913](https://github.com/etesam913) in + [#3742](https://github.com/wailsapp/wails/pull/3742) +- 🐧 Fixed linux compile error introduced by IgnoreMouseEvents addition by + [atterpac](https://github.com/atterpac) in + [#3721](https://github.com/wailsapp/wails/pull/3721) +- ⊞ Fixed syso icon file generation bug by + [atterpac](https://github.com/atterpac) in + [#3675](https://github.com/wailsapp/wails/pull/3675) +- 🐧 Fix to run natively in wayland incorporated from + [#1811](https://github.com/wailsapp/wails/pull/1811) in + [#3614](https://github.com/wailsapp/wails/pull/3614) by + [@stendler](https://github.com/stendler) +- Do not bind internal service methods in + [#3720](https://github.com/wailsapp/wails/pull/3720) by + [leaanthony](https://github.com/leaanthony) +- ⊞ Fixed system tray startup panic in + [#3693](https://github.com/wailsapp/wails/issues/3693) by + [@DeltaLaboratory](https://github.com/DeltaLaboratory) +- Do not bind internal service methods in + [#3720](https://github.com/wailsapp/wails/pull/3720) by + [leaanthony](https://github.com/leaanthony) +- ⊞ Fixed system tray startup panic in + [#3693](https://github.com/wailsapp/wails/issues/3693) by + [@DeltaLaboratory](https://github.com/DeltaLaboratory) +- Major menu item refactor and event handling. Mainly improves macOS for now. By + [leaanthony](https://github.com/leaanthony) +- Fix tests after plugins and event refactor in + [#3746](https://github.com/wailsapp/wails/pull/3746) by + [@stendler](https://github.com/stendler) +- ⊞ Fixed `Failed to unregister class Chrome_WidgetWin_0` warning. By + [leaanthony](https://github.com/leaanthony) + +## v3.0.0-alpha.6 - 2024-07-30 + +### Fixed + +- Module issues + +## v3.0.0-alpha.5 - 2024-07-30 + +### Added + +- 🐧 WindowDidMove / WindowDidResize events in + [#3580](https://github.com/wailsapp/wails/pull/3580) +- ⊞ WindowDidResize event in + [#3580](https://github.com/wailsapp/wails/pull/3580) +-  add Event ApplicationShouldHandleReopen to be able to handle dock + icon click by @5aaee9 in [#2991](https://github.com/wailsapp/wails/pull/2991) +-  add getPrimaryScreen/getScreens to impl by @tmclane in + [#2618](https://github.com/wailsapp/wails/pull/2618) +-  add option for showing the toolbar in fullscreen mode on macOS by + [@fbbdev](https://github.com/fbbdev) in + [#3282](https://github.com/wailsapp/wails/pull/3282) +- 🐧 add onKeyPress logic to convert linux keypress into an accelerator + @[Atterpac](https://github.com/Atterpac) + in[#3022](https://github.com/wailsapp/wails/pull/3022]) +- 🐧 add task `run:linux` by + [@marcus-crane](https://github.com/marcus-crane) in + [#3146](https://github.com/wailsapp/wails/pull/3146) +- Export `SetIcon` method by [@almas-x](https://github.com/almas-x) in + [PR](https://github.com/wailsapp/wails/pull/3147) +- Improve `OnShutdown` by [@almas-x](https://github.com/almas-x) in + [PR](https://github.com/wailsapp/wails/pull/3189) +- Restore `ToggleMaximise` method in `Window` interface by + [@fbbdev](https://github.com/fbbdev) in + [#3281](https://github.com/wailsapp/wails/pull/3281) +- Added more information to `Environment()`. By @leaanthony in + [aba82cc](https://github.com/wailsapp/wails/commit/aba82cc52787c97fb99afa58b8b63a0004b7ff6c) + based on [PR](https://github.com/wailsapp/wails/pull/2044) by @Mai-Lapyst +- Expose the `WebviewWindow.IsFocused` method on the `Window` interface by + [@fbbdev](https://github.com/fbbdev) in + [#3295](https://github.com/wailsapp/wails/pull/3295) +- Support multiple space-separated trigger events in the WML system by + [@fbbdev](https://github.com/fbbdev) in + [#3295](https://github.com/wailsapp/wails/pull/3295) +- Add ESM exports from the bundled JS runtime script by + [@fbbdev](https://github.com/fbbdev) in + [#3295](https://github.com/wailsapp/wails/pull/3295) +- Add binding generator flag for using the bundled JS runtime script instead of + the npm package by [@fbbdev](https://github.com/fbbdev) in + [#3334](https://github.com/wailsapp/wails/pull/3334) +- Implement `setIcon` on linux by [@abichinger](https://github.com/abichinger) + in [#3354](https://github.com/wailsapp/wails/pull/3354) +- Add flag `-port` to dev command and support environment variable + `WAILS_VITE_PORT` by [@abichinger](https://github.com/abichinger) in + [#3429](https://github.com/wailsapp/wails/pull/3429) +- Add tests for bound method calls by + [@abichinger](https://github.com/abichinger) in + [#3431](https://github.com/wailsapp/wails/pull/3431) +- ⊞ add `SetIgnoreMouseEvents` for already created window by + [@bruxaodev](https://github.com/bruxaodev) in + [#3667](https://github.com/wailsapp/wails/pull/3667) +-  Add ability to set a window's stacking level (order) by + [@OlegGulevskyy](https://github.com/OlegGulevskyy) in + [#3674](https://github.com/wailsapp/wails/pull/3674) + +### Fixed + +- Fixed resize event messaging by [atterpac](https://github.com/atterpac) in + [#3606](https://github.com/wailsapp/wails/pull/3606) +- 🐧Fixed theme handling error on NixOS by + [tmclane](https://github.com/tmclane) in + [#3515](https://github.com/wailsapp/wails/pull/3515) +- Fixed cross volume project install for windows by + [atterpac](https://github.com/atterac) in + [#3512](https://github.com/wailsapp/wails/pull/3512) +- Fixed react template css to show footer by + [atterpac](https://github.com/atterpac) in + [#3477](https://github.com/wailsapp/wails/pull/3477) +- Fixed zombie processes when working in devmode by updating to latest refresh + by [Atterpac](https://github.com/atterpac) in + [#3320](https://github.com/wailsapp/wails/pull/3320). +- Fixed appimage webkit file sourcing by [Atterpac](https://github.com/atterpac) + in [#3306](https://github.com/wailsapp/wails/pull/3306). +- Fixed Doctor apt package verify by [Atterpac](https://github.com/Atterpac) in + [#2972](https://github.com/wailsapp/wails/pull/2972). +- Fixed application frozen when quit (Darwin) by @5aaee9 in + [#2982](https://github.com/wailsapp/wails/pull/2982) +- Fixed background colours of examples on Windows by + [mmghv](https://github.com/mmghv) in + [#2750](https://github.com/wailsapp/wails/pull/2750). +- Fixed default context menus by [mmghv](https://github.com/mmghv) in + [#2753](https://github.com/wailsapp/wails/pull/2753). +- Fixed hex values for arrow keys on Darwin by + [jaybeecave](https://github.com/jaybeecave) in + [#3052](https://github.com/wailsapp/wails/pull/3052). +- Set drag-n-drop for windows to working. Added by + [@pylotlight](https://github.com/pylotlight) in + [PR](https://github.com/wailsapp/wails/pull/3039) +- Fixed bug for linux in doctor in the event user doesn't have proper drivers + installed. Added by [@pylotlight](https://github.com/pylotlight) in + [PR](https://github.com/wailsapp/wails/pull/3032) +- Fix dpi scaling on start up (windows). Changed by [@almas-x](https://github.com/almas-x) in + [PR](https://github.com/wailsapp/wails/pull/3145) +- Fix replace line in `go.mod` to use relative paths. Fixes Windows paths with + spaces - @leaanthony. +- Fix MacOS systray click handling when no attached window by + [thomas-senechal](https://github.com/thomas-senechal) in PR + [#3207](https://github.com/wailsapp/wails/pull/3207) +- Fix failing Windows build due to unknown option by + [thomas-senechal](https://github.com/thomas-senechal) in PR + [#3208](https://github.com/wailsapp/wails/pull/3208) +- Fix crash on windows left clicking the systray icon when not having an + attached window [tw1nk](https://github.com/tw1nk) in PR + [#3271](https://github.com/wailsapp/wails/pull/3271) +- Fix wrong baseURL when open window twice by @5aaee9 in PR + [#3273](https://github.com/wailsapp/wails/pull/3273) +- Fix ordering of if branches in `WebviewWindow.Restore` method by + [@fbbdev](https://github.com/fbbdev) in + [#3279](https://github.com/wailsapp/wails/pull/3279) +- Correctly compute `startURL` across multiple `GetStartURL` invocations when + `FRONTEND_DEVSERVER_URL` is present. + [#3299](https://github.com/wailsapp/wails/pull/3299) +- Fix the JS type of the `Screen` struct to match its Go counterpart by + [@fbbdev](https://github.com/fbbdev) in + [#3295](https://github.com/wailsapp/wails/pull/3295) +- Fix the `WML.Reload` method to ensure proper cleanup of registered event + listeners by [@fbbdev](https://github.com/fbbdev) in + [#3295](https://github.com/wailsapp/wails/pull/3295) +- Fix custom context menu closing immediately on linux by + [@abichinger](https://github.com/abichinger) in + [#3330](https://github.com/wailsapp/wails/pull/3330) +- Fix the output path and extension of model files produced by the binding + generator by [@fbbdev](https://github.com/fbbdev) in + [#3334](https://github.com/wailsapp/wails/pull/3334) +- Fix the import paths of model files in JS code produced by the binding + generator by [@fbbdev](https://github.com/fbbdev) in + [#3334](https://github.com/wailsapp/wails/pull/3334) +- Fix drag-n-drop on some linux distros by + [@abichinger](https://github.com/abichinger) in + [#3346](https://github.com/wailsapp/wails/pull/3346) +- Fix missing task for macOS when using `wails3 task dev` by + [@hfoxy](https://github.com/hfoxy) in + [#3417](https://github.com/wailsapp/wails/pull/3417) +- Fix registering events causing a nil map assignment by + [@hfoxy](https://github.com/hfoxy) in + [#3426](https://github.com/wailsapp/wails/pull/3426) +- Fix unmarshaling of bound method parameters by + [@fbbdev](https://github.com/fbbdev) in + [#3431](https://github.com/wailsapp/wails/pull/3431) +- Fix handling of multiple return values from bound methods by + [@fbbdev](https://github.com/fbbdev) in + [#3431](https://github.com/wailsapp/wails/pull/3431) +- Fix doctor detection of npm that is not installed with system package manager + by [@pekim](https://github.com/pekim) in + [#3458](https://github.com/wailsapp/wails/pull/3458) +- Fix missing MicrosoftEdgeWebview2Setup.exe. Thanks to + [@robin-samuel](https://github.com/robin-samuel). +- Fix random crash on linux due to window ID handling by @leaanthony. Based on + PR [#3466](https://github.com/wailsapp/wails/pull/3622) by + [@5aaee9](https://github.com/5aaee9). +- Fix systemTray.setIcon crashing on Linux by + [@windom](https://github.com/windom/) in + [#3636](https://github.com/wailsapp/wails/pull/3636). +- Fix Ensure Window Frame is Applied on First Call in `setFrameless` Function on + Windows by [@bruxaodev](https://github.com/bruxaodev/) in + [#3691](https://github.com/wailsapp/wails/pull/3691). + +### Changed + +- Renamed `AbsolutePosition()` to `Position()` by + [mmghv](https://github.com/mmghv) in + [#3611](https://github.com/wailsapp/wails/pull/3611) +- Update linux webkit dependency to webkit2gtk-4.1 over webkitgtk2-4.0 to + support Ubuntu 24.04 LTS by [atterpac](https://github.com/atterpac) in + [#3461](https://github.com/wailsapp/wails/pull/3461) +- The bundled JS runtime script is now an ESM module: script tags importing it + must have the `type="module"` attribute. By + [@fbbdev](https://github.com/fbbdev) in + [#3295](https://github.com/wailsapp/wails/pull/3295) +- The `@wailsio/runtime` package does not publish its API on the `window.wails` + object, and does not start the WML system. This has been done to improve + encapsulation. The WML system can be started manually if desired by calling + the new `WML.Enable` method. The bundled JS runtime script still performs both + operations automatically. By [@fbbdev](https://github.com/fbbdev) in + [#3295](https://github.com/wailsapp/wails/pull/3295) +- The Window API module `@wailsio/runtime/src/window` now exposes the containing + window object as a default export. It is not possible anymore to import + individual methods through ESM named or namespace import syntax. +- The JS window API has been updated to match the current Go `WebviewWindow` + API. Some methods have changed name or prototype, specifically: `Screen` + becomes `GetScreen`; `GetZoomLevel`/`SetZoomLevel` become `GetZoom`/`SetZoom`; + `GetZoom`, `Width` and `Height` now return values directly instead of wrapping + them within objects. By [@fbbdev](https://github.com/fbbdev) in + [#3295](https://github.com/wailsapp/wails/pull/3295) +- The binding generator now uses calls by ID by default. The `-id` CLI option + has been removed. Use the `-names` CLI option to switch back to calls by name. + By [@fbbdev](https://github.com/fbbdev) in + [#3468](https://github.com/wailsapp/wails/pull/3468) +- New binding code layout: output files were previously organised in folders + named after their containing package; now full Go import paths are used, + including the module path. By [@fbbdev](https://github.com/fbbdev) in + [#3468](https://github.com/wailsapp/wails/pull/3468) +- The struct field `application.Options.Bind` has been renamed to + `application.Options.Services`. By [@fbbdev](https://github.com/fbbdev) in + [#3468](https://github.com/wailsapp/wails/pull/3468) +- New syntax for binding services: service instances must now be wrapped in a + call to `application.NewService`. By [@fbbdev](https://github.com/fbbdev) in + [#3468](https://github.com/wailsapp/wails/pull/3468) +- Disable spinner on Non-Terminal or CI Environment by + [@DeltaLaboratory](https://github.com/DeltaLaboratory) in + [#3574](https://github.com/wailsapp/wails/pull/3574) diff --git a/docs/src/content/docs/community/links.md b/docs/src/content/docs/community/links.md new file mode 100644 index 000000000..9507991dd --- /dev/null +++ b/docs/src/content/docs/community/links.md @@ -0,0 +1,27 @@ +--- +title: Links +--- + +This page serves as a list for community related links. + +:::tip[How to Submit a Link] + +You can click the `Edit page` at the bottom of this page to submit a PR. + +::: + +## Awesome Wails + +The [definitive list](https://github.com/wailsapp/awesome-wails) of links +related to Wails. + +## Support Channels + +- [Wails Discord Server](https://discord.gg/bdj28QNHmT) +- [Github Issues](https://github.com/wailsapp/wails/issues) + +## Social Media + +- [Twitter](https://x.com/wailsapp) +- [Wails Chinese Community QQ Group](https://qm.qq.com/cgi-bin/qm/qr?k=PmIURne5hFGNd7QWzW5qd6FV-INEjNJv&jump_from=webapi) - + Group number: 1067173054 diff --git a/docs/src/content/docs/community/showcase/_template.md b/docs/src/content/docs/community/showcase/_template.md new file mode 100644 index 000000000..f98a2ef06 --- /dev/null +++ b/docs/src/content/docs/community/showcase/_template.md @@ -0,0 +1,25 @@ +--- +title: My Project +draft: true +--- + + + +![My Project Screenshot](../../../../assets/showcase-images/your-project.webp) + + + +Your project description goes here. Explain what it does, what makes it special, and why you built it with Wails. + + + +[Visit Project Website](https://your-project.com) | [View on GitHub](https://github.com/yourusername/your-project) diff --git a/docs/src/content/docs/community/showcase/bulletinboard.md b/docs/src/content/docs/community/showcase/bulletinboard.md new file mode 100644 index 000000000..58d24b97f --- /dev/null +++ b/docs/src/content/docs/community/showcase/bulletinboard.md @@ -0,0 +1,16 @@ +--- +title: BulletinBoard +--- + +![BulletinBoard](../../../../assets/showcase-images/bboard.webp) + +The [BulletinBoard](https://github.com/raguay/BulletinBoard) application is a +versital message board for static messages or dialogs to get information from +the user for a script. It has a TUI for creating new dialogs that can latter be +used to get information from the user. It's design is to stay running on your +system and show the information as needed and then hide away. I have a process +for watching a file on my system and sending the contents to BulletinBoard when +changed. It works great with my workflows. T here is also an +[Alfred workflow](https://github.com/raguay/MyAlfred/blob/master/Alfred%205/EmailIt.alfredworkflow) +for sending information to the program. The workflow is also for working with +[EmailIt](https://github.com/raguay/EmailIt). diff --git a/docs/src/content/docs/community/showcase/cfntracker.md b/docs/src/content/docs/community/showcase/cfntracker.md new file mode 100644 index 000000000..dc9c030f3 --- /dev/null +++ b/docs/src/content/docs/community/showcase/cfntracker.md @@ -0,0 +1,36 @@ +--- +title: CFN Tracker +--- + +![CFN Tracker](../../../../assets/showcase-images/cfntracker.webp) + +[CFN Tracker](https://github.com/williamsjokvist/cfn-tracker) - Track any Street +Fighter 6 or V CFN profile's live matches. Check +[the website](https://cfn.williamsjokvist.se/) to get started. + +## Features + +- Real-time match tracking +- Storing match logs and statistics +- Support for displaying live stats to OBS via Browser Source +- Support for both SF6 and SFV +- Ability for users to create their own OBS Browser themes with CSS + +### Major tech used alongside Wails + +- [Task](https://github.com/go-task/task) - wrapping the Wails CLI to make + common commands easy to use +- [React](https://github.com/facebook/react) - chosen for its rich ecosystem + (radix, framer-motion) +- [Bun](https://github.com/oven-sh/bun) - used for its fast dependency + resolution and build-time +- [Rod](https://github.com/go-rod/rod) - headless browser automation for + authentication and polling changes +- [SQLite](https://github.com/mattn/go-sqlite3) - used for storing matches, + sessions and profiles +- [Server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events) - + a http stream to send tracking updates to OBS browser sources +- [i18next](https://github.com/i18next/) - with backend connector to serve + localization objects from the Go layer +- [xstate](https://github.com/statelyai/xstate) - state machines for auth + process and tracking diff --git a/docs/src/content/docs/community/showcase/clave.md b/docs/src/content/docs/community/showcase/clave.md new file mode 100644 index 000000000..9c405e616 --- /dev/null +++ b/docs/src/content/docs/community/showcase/clave.md @@ -0,0 +1,18 @@ +--- +title: Clave +--- + +![Clave](../../../../assets/showcase-images/clave.png) + +Key Features + +- 🎨 Simple, intuitive design for hassle-free experience +- ✅ Add accounts easily via manual entry or QR code image import. +- 🔒 End-to-end encryption with PIN or Touch ID(macOS only). +- 💻 Available for macOS, Windows, and Linux +- ⚡ Quick access from system tray for convenience +- 📂 Easily backup and restore your profiles + +Try Clave Today! + +💻 [https://clave.rocks](https://clave.rocks) diff --git a/docs/src/content/docs/community/showcase/emailit.md b/docs/src/content/docs/community/showcase/emailit.md new file mode 100644 index 000000000..6afc1da5e --- /dev/null +++ b/docs/src/content/docs/community/showcase/emailit.md @@ -0,0 +1,14 @@ +--- +title: EmailIt +--- + +![EmailIt](../../../../assets/showcase-images/emailit.webp) + +[EmailIt](https://github.com/raguay/EmailIt/) is a Wails 2 program that is a +markdown based email sender only with nine notepads, scripts to manipulate the +text, and templates. It also has a scripts terminal to run scripts in EmailIt on +files in your system. The scripts and templates can be used from the commandline +itself or with the Alfred, Keyboard Maestro, Dropzone, or PopClip extensions. It +also supports scripts and themes downloaded form GitHub. Documentation is not +complete, but the programs works. It’s built using Wails2 and Svelte, and the +download is a universal macOS application. diff --git a/docs/src/content/docs/community/showcase/encrypteasy.md b/docs/src/content/docs/community/showcase/encrypteasy.md new file mode 100644 index 000000000..3a098fac9 --- /dev/null +++ b/docs/src/content/docs/community/showcase/encrypteasy.md @@ -0,0 +1,16 @@ +--- +title: EncryptEasy +--- + +![EncryptEasy](../../../../assets/showcase-images/encrypteasy.webp) + +**[EncryptEasy](https://www.encrypteasy.app) is a simple and easy to use PGP +encryption tool, managing all your and your contacts keys. Encryption should be +simple. Developed with Wails.** + +Encrypting messages using PGP is the industry standard. Everyone has a private +and a public key. Your private key, well, needs to be kept private so only you +can read messages. Your public key is distributed to anyone who wants to send +you secret, encrypted messages. Managing keys, encrypting messages and +decrypting messages should be a smooth experience. EncryptEasy is all about +making it easy. diff --git a/docs/src/content/docs/community/showcase/espstudio.md b/docs/src/content/docs/community/showcase/espstudio.md new file mode 100644 index 000000000..0ac90a827 --- /dev/null +++ b/docs/src/content/docs/community/showcase/espstudio.md @@ -0,0 +1,9 @@ +--- +title: ESP Studio +--- + +![ESP Studio](../../../../assets/showcase-images/esp-studio.png) + +[ESP Studio](https://github.com/torabian/esp-studio) - Cross platform, Desktop, +Cloud, and Embedded software for controlling ESP/Arduino devices, and building +complex IOT workflows and control systems diff --git a/docs/src/content/docs/community/showcase/filehound.md b/docs/src/content/docs/community/showcase/filehound.md new file mode 100644 index 000000000..627007f97 --- /dev/null +++ b/docs/src/content/docs/community/showcase/filehound.md @@ -0,0 +1,29 @@ +--- +title: FileHound Export Utility +--- + +![FileHound Export Utility](../../../../assets/showcase-images/filehound.webp) + +[FileHound Export Utility](https://www.filehound.co.uk/) FileHound is a cloud +document management platform made for secure file retention, business process +automation and SmartCapture capabilities. + +The FileHound Export Utility allows FileHound Administrators the ability to run +a secure document and data extraction tasks for alternative back-up and recovery +purposes. This application will download all documents and/or meta data saved in +FileHound based on the filters you choose. The metadata will be exported in both +JSON and XML formats. + +Backend built with: + +- Go 1.15 +- Wails 1.11.0 +- go-sqlite3 1.14.6 +- go-linq 3.2 + +Frontend with: + +- Vue 2.6.11 +- Vuex 3.4.0 +- TypeScript +- Tailwind 1.9.6 diff --git a/docs/src/content/docs/community/showcase/hiposter.md b/docs/src/content/docs/community/showcase/hiposter.md new file mode 100644 index 000000000..08acfa832 --- /dev/null +++ b/docs/src/content/docs/community/showcase/hiposter.md @@ -0,0 +1,8 @@ +--- +title: hiposter +--- + +![hiposter](../../../../assets/showcase-images/hiposter.webp) + +[hiposter](https://github.com/obity/hiposter) is a simple and efficient http API +testing client tool. Based on Wails, Go and sveltejs. diff --git a/docs/src/content/docs/community/showcase/index.mdx b/docs/src/content/docs/community/showcase/index.mdx new file mode 100644 index 000000000..e1da3f75d --- /dev/null +++ b/docs/src/content/docs/community/showcase/index.mdx @@ -0,0 +1,189 @@ +--- +title: Overview +sidebar: + order: 1 +--- + +import { ShowcaseImage } from "starlight-showcases"; +import { Steps } from "@astrojs/starlight/components"; + +:::tip[See how to add your project] + +Check out the +[How to add my project in showcase](#how-to-add-my-project-in-showcase) section. + +::: + + + +## How to add my project in showcase + + + +1. Make a fork of the repository. +2. Add the image(s) under `docs/src/assets/showcase-images` folder. +3. Make a copy of the `_template.md` file under + `docs/src/content/docs/community/showcase` folder. +4. Rename the copied file to the name of your project. (Name should not start + with `_`)) +5. Update the title, image, link and content of the file. +6. Add it on the above list in + `docs/src/content/docs/community/showcase/index.mdx`. +7. Submit a PR. + + diff --git a/docs/src/content/docs/community/showcase/mchat.md b/docs/src/content/docs/community/showcase/mchat.md new file mode 100644 index 000000000..444aed343 --- /dev/null +++ b/docs/src/content/docs/community/showcase/mchat.md @@ -0,0 +1,8 @@ +--- +title: Mchat +--- + +![Mchat](../../../../assets/showcase-images/mchat.png) + +[Official page](https://marcio199226.github.io/mchat-site/public/) Fully +anonymous end2end encrypted chat. diff --git a/docs/src/content/docs/community/showcase/minecraftupdater.md b/docs/src/content/docs/community/showcase/minecraftupdater.md new file mode 100644 index 000000000..57cd80e30 --- /dev/null +++ b/docs/src/content/docs/community/showcase/minecraftupdater.md @@ -0,0 +1,10 @@ +--- +title: Minecraft Updater +--- + +![Minecraft Updater](../../../../assets/showcase-images/minecraft-mod-updater.webp) + +[Minecraft Updater](https://github.com/Gurkengewuerz/MinecraftModUpdater) is a +utility tool to update and synchronize Minecraft mods for your userbase. It’s +built using Wails2 and React with [antd](https://ant.design/) as frontend +framework. diff --git a/docs/src/content/docs/community/showcase/minesweeper-xp.md b/docs/src/content/docs/community/showcase/minesweeper-xp.md new file mode 100644 index 000000000..9ca30ed55 --- /dev/null +++ b/docs/src/content/docs/community/showcase/minesweeper-xp.md @@ -0,0 +1,8 @@ +--- +title: Minesweeper XP +--- + +![Minesweeper XP](../../../../assets/showcase-images/minesweeper-xp.webp) + +[Minesweeper-XP](https://git.new/Minesweeper-XP) allows you to experience the +classic Minesweeper XP (+ 98 and 3.1) on macOS, Windows, and Linux! diff --git a/docs/src/content/docs/community/showcase/modalfilemanager.md b/docs/src/content/docs/community/showcase/modalfilemanager.md new file mode 100644 index 000000000..7a7748d4d --- /dev/null +++ b/docs/src/content/docs/community/showcase/modalfilemanager.md @@ -0,0 +1,21 @@ +--- +title: Modal File Manager +--- + +![Modal File Manager](../../../../assets/showcase-images/modalfilemanager.webp) + +[Modal File Manager](https://github.com/raguay/ModalFileManager) is a dual pane +file manager using web technologies. My original design was based on NW.js and +can be found [here](https://github.com/raguay/ModalFileManager-NWjs). This +version uses the same Svelte based frontend code (but it has be greatly modified +since the departure from NW.js), but the backend is a +[Wails 2](https://wails.io/) implementation. By using this implementation, I no +longer use command line `rm`, `cp`, etc. commands, but a git install has to be +on the system to download themes and extensions. It is fully coded using Go and +runs much faster than the previous versions. + +This file manager is designed around the same principle as Vim: a state +controlled keyboard actions. The number of states isn't fixed, but very +programmable. Therefore, an infinite number of keyboard configurations can be +created and used. This is the main difference from other file managers. There +are themes and extensions available to download from GitHub. diff --git a/docs/src/content/docs/community/showcase/mollywallet.md b/docs/src/content/docs/community/showcase/mollywallet.md new file mode 100644 index 000000000..930aebd75 --- /dev/null +++ b/docs/src/content/docs/community/showcase/mollywallet.md @@ -0,0 +1,9 @@ +--- +title: Molley Wallet +--- + +![Molly Wallet](../../../../assets/showcase-images/mollywallet.webp) + +[Molly Wallet](https://github.com/grvlle/constellation_wallet/) the official +$DAG wallet of the Constellation Network. It'll let users interact with the +Hypergraph Network in various ways, not limited to producing $DAG transactions. diff --git a/docs/src/content/docs/community/showcase/october.md b/docs/src/content/docs/community/showcase/october.md new file mode 100644 index 000000000..60a29e91b --- /dev/null +++ b/docs/src/content/docs/community/showcase/october.md @@ -0,0 +1,16 @@ +--- +title: October +--- + +![October](../../../../assets/showcase-images/october.webp) + +[October](https://october.utf9k.net) is a small Wails application that makes it +really easy to extract highlights from +[Kobo eReaders](https://en.wikipedia.org/wiki/Kobo_eReader) and then forward +them to [Readwise](https://readwise.io). + +It has a relatively small scope with all platform versions weighing in under +10MB, and that's without enabling [UPX compression](https://upx.github.io/)! + +In contrast, the author's previous attempts with Electron quickly bloated to +several hundred megabytes. diff --git a/docs/src/content/docs/community/showcase/optimus.md b/docs/src/content/docs/community/showcase/optimus.md new file mode 100644 index 000000000..6128258b2 --- /dev/null +++ b/docs/src/content/docs/community/showcase/optimus.md @@ -0,0 +1,9 @@ +--- +title: Optimus +--- + +![Optimus](../../../../assets/showcase-images/optimus.webp) + +[Optimus](https://github.com/splode/optimus) is a desktop image optimization +application. It supports conversion and compression between WebP, JPEG, and PNG +image formats. diff --git a/docs/src/content/docs/community/showcase/portfall.md b/docs/src/content/docs/community/showcase/portfall.md new file mode 100644 index 000000000..c1ffc76f9 --- /dev/null +++ b/docs/src/content/docs/community/showcase/portfall.md @@ -0,0 +1,8 @@ +--- +title: Portfall +--- + +![Portfall](../../../../assets/showcase-images/portfall.webp) + +[Portfall](https://github.com/rekon-oss/portfall) - A desktop k8s +port-forwarding portal for easy access to all your cluster UIs diff --git a/docs/src/content/docs/community/showcase/resizem.md b/docs/src/content/docs/community/showcase/resizem.md new file mode 100644 index 000000000..3e8761dbc --- /dev/null +++ b/docs/src/content/docs/community/showcase/resizem.md @@ -0,0 +1,9 @@ +--- +title: Resizem +--- + +![Resizem Screenshot](../../../../assets/showcase-images/resizem.webp) + +[Resizem](https://github.com/barats/resizem) - is an app designed for bulk image +process. It is particularly useful for users who need to resize, convert, and +manage large numbers of image files at once. diff --git a/docs/src/content/docs/community/showcase/restic-browser.md b/docs/src/content/docs/community/showcase/restic-browser.md new file mode 100644 index 000000000..5a68cb02e --- /dev/null +++ b/docs/src/content/docs/community/showcase/restic-browser.md @@ -0,0 +1,9 @@ +--- +title: Restic Browser +--- + +![Restic Browser](../../../../assets/showcase-images/restic-browser-2.png) + +[Restic-Browser](https://github.com/emuell/restic-browser) - A simple, +cross-platform [restic](https://github.com/restic/restic) backup GUI for +browsing and restoring restic repositories. diff --git a/docs/src/content/docs/community/showcase/riftshare.md b/docs/src/content/docs/community/showcase/riftshare.md new file mode 100644 index 000000000..b6ed8f464 --- /dev/null +++ b/docs/src/content/docs/community/showcase/riftshare.md @@ -0,0 +1,23 @@ +--- +title: RiftShare +--- + +![RiftShare](../../../../assets/showcase-images/riftshare-main.webp) + +Easy, Secure, and Free file sharing for everyone. Learn more at +[Riftshare.app](https://riftshare.app) + +## Features + +- Easy secure file sharing between computers both in the local network and + through the internet +- Supports sending files or directories securely through the + [magic wormhole protocol](https://magic-wormhole.readthedocs.io/en/latest/) +- Compatible with all other apps using magic wormhole (magic-wormhole or + wormhole-william CLI, wormhole-gui, etc.) +- Automatic zipping of multiple selected files to send at once +- Full animations, progress bar, and cancellation support for sending and + receiving +- Native OS File Selection +- Open files in one click once received +- Auto Update - don't worry about having the latest release! diff --git a/docs/src/content/docs/community/showcase/scriptbar.md b/docs/src/content/docs/community/showcase/scriptbar.md new file mode 100644 index 000000000..1e03ab528 --- /dev/null +++ b/docs/src/content/docs/community/showcase/scriptbar.md @@ -0,0 +1,14 @@ +--- +title: ScriptBar +--- + +![ScriptBar](../../../../assets/showcase-images/scriptbar.webp) + +[ScriptBar](https://GitHub.com/raguay/ScriptBarApp) is a program to show the +output of scripts or [Node-Red](https://nodered.org) server. It runs scripts +defined in EmailIt program and shows the output. Scripts from xBar or TextBar +can be used, but currently on the TextBar scripts work well. It also displays +the output of scripts on your system. ScriptBar doesn't put them in the menubar, +but has them all in a convient window for easy viewing. You can have multiple +tabs to have many different things show. You can also keep the links to your +most visited web sites. diff --git a/docs/src/content/docs/community/showcase/snippetexpander.md b/docs/src/content/docs/community/showcase/snippetexpander.md new file mode 100644 index 000000000..0b5a88801 --- /dev/null +++ b/docs/src/content/docs/community/showcase/snippetexpander.md @@ -0,0 +1,34 @@ +--- +title: Snippet Expander +--- + +![Snippet Expander Screenshot](../../../../assets/showcase-images/snippetexpandergui-select-snippet.png) + +Screenshot of Snippet Expander's Select Snippet window + +![Snippet Expander Screenshot](../../../../assets/showcase-images/snippetexpandergui-add-snippet.png) + +Screenshot of Snippet Expander's Add Snippet screen + +![Snippet Expander Screenshot](../../../../assets/showcase-images/snippetexpandergui-search-and-paste.png) + +Screenshot of Snippet Expander's Search & Paste window + +[Snippet Expander](https://snippetexpander.org) is "Your little expandable text +snippets helper", for Linux. + +Snippet Expander comprises of a GUI application built with Wails for managing +snippets and settings, with a Search & Paste window mode for quickly selecting +and pasting a snippet. + +The Wails based GUI, go-lang CLI and vala-lang auto expander daemon all +communicate with a go-lang daemon via D-Bus. The daemon does the majority of the +work, managing the database of snippets and common settings, and providing +services for expanding and pasting snippets etc. + +Check out the +[source code](https://git.sr.ht/~ianmjones/snippetexpander/tree/trunk/item/cmd/snippetexpandergui/app.go#L38) +to see how the Wails app sends messages from the UI to the backend that are then +sent to the daemon, and subscribes to a D-Bus event to monitor changes to +snippets via another instance of the app or CLI and show them instantly in the +UI via a Wails event. diff --git a/docs/src/content/docs/community/showcase/surge.md b/docs/src/content/docs/community/showcase/surge.md new file mode 100644 index 000000000..3ab4444dd --- /dev/null +++ b/docs/src/content/docs/community/showcase/surge.md @@ -0,0 +1,9 @@ +--- +title: Surge +--- + +![Surge Screenshot](../../../../assets/showcase-images/surge.png) + +[Surge](https://getsurge.io/) is a p2p filesharing app designed to utilize +blockchain technologies to enable 100% anonymous file transfers. Surge is +end-to-end encrypted, decentralized and open source. diff --git a/docs/src/content/docs/community/showcase/tinyrdm.md b/docs/src/content/docs/community/showcase/tinyrdm.md new file mode 100644 index 000000000..f9551e046 --- /dev/null +++ b/docs/src/content/docs/community/showcase/tinyrdm.md @@ -0,0 +1,12 @@ +--- +title: Tiny RDM +--- + +![Tiny RDM Screenshot](../../../../assets/showcase-images/tiny-rdm1.webp) +![Tiny RDM Screenshot](../../../../assets/showcase-images/tiny-rdm2.webp) + +The [Tiny RDM](https://redis.tinycraft.cc/) application is an open-source, +modern lightweight Redis GUI. It has a beautful UI, intuitive Redis database +management, and compatible with Windows, Mac, and Linux. It provides visual +key-value data operations, supports various data decoding and viewing options, +built-in console for executing commands, slow log queries and more. diff --git a/docs/src/content/docs/community/showcase/wailsterm.md b/docs/src/content/docs/community/showcase/wailsterm.md new file mode 100644 index 000000000..0521aac70 --- /dev/null +++ b/docs/src/content/docs/community/showcase/wailsterm.md @@ -0,0 +1,8 @@ +--- +title: WailsTerm +--- + +![WailsTerm Screenshot](../../../../assets/showcase-images/wailsterm.webp) + +[WailsTerm](https://github.com/rlshukhov/wailsterm) is a simple translucent +terminal app powered by Wails and Xterm.js. diff --git a/docs/src/content/docs/community/showcase/wally.md b/docs/src/content/docs/community/showcase/wally.md new file mode 100644 index 000000000..3f4ddbfa2 --- /dev/null +++ b/docs/src/content/docs/community/showcase/wally.md @@ -0,0 +1,10 @@ +--- +title: Wally +--- + +![Wally Screenshot](../../../../assets/showcase-images/wally.webp) + +[Wally](https://ergodox-ez.com/pages/wally) is the official firmware flasher for +[Ergodox](https://ergodox-ez.com/) keyboards. It looks great and is a fantastic +example of what you can achieve with Wails: the ability to combine the power of +Go and the rich graphical tools of the web development world. diff --git a/docs/src/content/docs/community/showcase/warmine.md b/docs/src/content/docs/community/showcase/warmine.md new file mode 100644 index 000000000..19de97f2a --- /dev/null +++ b/docs/src/content/docs/community/showcase/warmine.md @@ -0,0 +1,17 @@ +--- +title: Minecraft launcher for WarMine +--- + +![WarMine Screenshot](../../../../assets/showcase-images/warmine1.png) +![WarMine Screenshot](../../../../assets/showcase-images/warmine2.png) + +[Minecraft launcher for WarMine](https://warmine.ru/) is a Wails application, +that allows you to easily join modded game servers and manage your game +accounts. + +The Launcher downloads the game files, checks their integrity and launches the +game with a wide range of customization options for the launch arguments from +the backend. + +Frontend is written in Svelte, whole launcher fits in 9MB and supports Windows +7-11. diff --git a/docs/src/content/docs/community/showcase/wombat.md b/docs/src/content/docs/community/showcase/wombat.md new file mode 100644 index 000000000..d61bdd6c9 --- /dev/null +++ b/docs/src/content/docs/community/showcase/wombat.md @@ -0,0 +1,7 @@ +--- +title: Wombat +--- + +![Wombat Screenshot](../../../../assets/showcase-images/wombat.webp) + +[Wombat](https://github.com/rogchap/wombat) is a cross platform gRPC client. diff --git a/docs/src/content/docs/community/showcase/ytd.md b/docs/src/content/docs/community/showcase/ytd.md new file mode 100644 index 000000000..bbcd6979f --- /dev/null +++ b/docs/src/content/docs/community/showcase/ytd.md @@ -0,0 +1,10 @@ +--- +title: Ytd +--- + +![Ytd Screenshot](../../../../assets/showcase-images/ytd.webp) + +[Ytd](https://github.com/marcio199226/ytd/tree/v2-wails) is an app for +downloading tracks from youtube, creating offline playlists and share them with +your friends, your friends will be able to playback your playlists or download +them for offline listening, has an built-in player. diff --git a/docs/src/content/docs/community/templates.md b/docs/src/content/docs/community/templates.md new file mode 100644 index 000000000..855b70c23 --- /dev/null +++ b/docs/src/content/docs/community/templates.md @@ -0,0 +1,132 @@ +--- +title: Templates +--- + +:::caution + +This page might be outdated for Wails v3. + +::: + + + +This page serves as a list for community supported templates. To build your own +template, please see the [Templates](https://wails.io/docs/guides/templates) +guide. + +:::tip[How to Submit a Template] + +You can click `Edit this page` at the bottom to include your templates. + +::: + +To use these templates, run +`wails init -n "Your Project Name" -t [the link below[@version]]` + +If there is no version suffix, the main branch code template is used by default. +If there is a version suffix, the code template corresponding to the tag of this +version is used. + +Example: +`wails init -n "Your Project Name" -t https://github.com/misitebao/wails-template-vue` + +:::danger[Attention] + +**The Wails project does not maintain, is not responsible nor liable for 3rd +party templates!** + +If you are unsure about a template, inspect `package.json` and `wails.json` for +what scripts are run and what packages are installed. + +::: + +## Vue + +- [wails-template-vue](https://github.com/misitebao/wails-template-vue) - Wails + template based on Vue ecology (Integrated TypeScript, Dark theme, + Internationalization, Single page routing, TailwindCSS) +- [wails-template-quasar-js](https://github.com/sgosiaco/wails-template-quasar-js) - + A template using JavaScript + Quasar V2 (Vue 3, Vite, Sass, Pinia, ESLint, + Prettier) +- [wails-template-quasar-ts](https://github.com/sgosiaco/wails-template-quasar-ts) - + A template using TypeScript + Quasar V2 (Vue 3, Vite, Sass, Pinia, ESLint, + Prettier, Composition API with <script setup>) +- [wails-template-naive](https://github.com/tk103331/wails-template-naive) - + Wails template based on Naive UI (A Vue 3 Component Library) +- [wails-template-nuxt](https://github.com/gornius/wails-template-nuxt) - Wails + template using clean Nuxt3 and TypeScript with auto-imports for wails js + runtime +- [Wails-Tool-Template](https://github.com/xisuo67/Wails-Tool-Template) - Wails + template using Vue+TypeScript+Vite+Element-plus(仿网易云) + +## Angular + +- [wails-template-angular](https://github.com/mateothegreat/wails-template-angular) - + Angular 15+ action packed & ready to roll to production. +- [wails-angular-template](https://github.com/TAINCER/wails-angular-template) - + Angular with TypeScript, Sass, Hot-Reload, Code-Splitting and i18n + +## React + +- [wails-react-template](https://github.com/AlienRecall/wails-react-template) - + A template using reactjs +- [wails-react-template](https://github.com/flin7/wails-react-template) - A + minimal template for React that supports live development +- [wails-template-nextjs](https://github.com/LGiki/wails-template-nextjs) - A + template using Next.js and TypeScript +- [wails-template-nextjs-app-router](https://github.com/thisisvk-in/wails-template-nextjs-app-router) - + A template using Next.js and TypeScript with App router +- [wails-template-nextjs-app-router-src](https://github.com/edai-git/wails-template-nextjs-app-router) - + A template using Next.js and TypeScript with App router src + example +- [wails-vite-react-ts-tailwind-template](https://github.com/hotafrika/wails-vite-react-ts-tailwind-template) - + A template for React + TypeScript + Vite + TailwindCSS +- [wails-vite-react-ts-tailwind-shadcnui-template](https://github.com/Mahcks/wails-vite-react-tailwind-shadcnui-ts) - + A template with Vite, React, TypeScript, TailwindCSS, and shadcn/ui + +## Svelte + +- [wails-svelte-template](https://github.com/raitonoberu/wails-svelte-template) - + A template using Svelte +- [wails-vite-svelte-template](https://github.com/BillBuilt/wails-vite-svelte-template) - + A template using Svelte and Vite +- [wails-vite-svelte-tailwind-template](https://github.com/BillBuilt/wails-vite-svelte-tailwind-template) - + A template using Svelte and Vite with TailwindCSS v3 +- [wails-svelte-tailwind-vite-template](https://github.com/PylotLight/wails-vite-svelte-tailwind-template/tree/master) - + An updated template using Svelte v4.2.0 and Vite with TailwindCSS v3.3.3 +- [wails-sveltekit-template](https://github.com/h8gi/wails-sveltekit-template) - + A template using SvelteKit +- [wails-template-shadcn-svelte](https://github.com/xijaja/wails-template-shadcn-svelte) - + A template using Sveltekit and Shadcn-Svelte + +## Solid + +- [wails-template-vite-solid-ts](https://github.com/xijaja/wails-template-solid-ts) - + A template using Solid + Ts + Vite +- [wails-template-vite-solid-js](https://github.com/xijaja/wails-template-solid-js) - + A template using Solid + Js + Vite + +## Elm + +- [wails-elm-template](https://github.com/benjamin-thomas/wails-elm-template) - + Develop your GUI app with functional programming and a **snappy** hot-reload + setup :tada: :rocket: +- [wails-template-elm-tailwind](https://github.com/rnice01/wails-template-elm-tailwind) - + Combine the powers :muscle: of Elm + Tailwind CSS + Wails! Hot reloading + supported. + +## HTMX + +- [wails-htmx-templ-chi-tailwind](https://github.com/PylotLight/wails-hmtx-templ-template) - + Use a unique combination of pure htmx for interactivity plus templ for + creating components and forms + +## Pure JavaScript (Vanilla) + +- [wails-pure-js-template](https://github.com/KiddoV/wails-pure-js-template) - A + template with nothing but just basic JavaScript, HTML, and CSS + +## Lit (web components) + +- [wails-lit-shoelace-esbuild-template](https://github.com/Braincompiler/wails-lit-shoelace-esbuild-template) - + Wails template providing frontend with lit, Shoelace component library + + pre-configured prettier and typescript. diff --git a/docs/src/content/docs/concepts/architecture.mdx b/docs/src/content/docs/concepts/architecture.mdx new file mode 100644 index 000000000..d72affe3b --- /dev/null +++ b/docs/src/content/docs/concepts/architecture.mdx @@ -0,0 +1,655 @@ +--- +title: How Wails Works +description: Understanding the Wails architecture and how it achieves native performance +sidebar: + order: 1 +--- + +import { Tabs, TabItem } from "@astrojs/starlight/components"; + +Wails is a framework for building desktop applications using **Go for the backend** and **web technologies for the frontend**. But unlike Electron, Wails doesn't bundle a browser—it uses the **operating system's native WebView**. + +```d2 +direction: right + +User: "User" { + shape: person + style.fill: "#3B82F6" +} + +Application: "Your Wails Application" { + Frontend: "Frontend\n(HTML/CSS/JS)" { + shape: rectangle + style.fill: "#8B5CF6" + } + + Runtime: "Wails Runtime" { + Bridge: "Message Bridge" { + shape: diamond + style.fill: "#10B981" + } + + Bindings: "Type-Safe Bindings" { + shape: rectangle + style.fill: "#10B981" + } + } + + Backend: "Go Backend" { + Services: "Your Services" { + shape: rectangle + style.fill: "#00ADD8" + } + + NativeAPIs: "OS APIs" { + shape: rectangle + style.fill: "#00ADD8" + } + } +} + +OS: "Operating System" { + WebView: "Native WebView\n(WebKit/WebView2/WebKitGTK)" { + shape: rectangle + style.fill: "#6B7280" + } + + SystemAPIs: "System APIs\n(Windows/macOS/Linux)" { + shape: rectangle + style.fill: "#6B7280" + } +} + +User -> Application.Frontend: "Interacts with UI" +Application.Frontend <-> Application.Runtime.Bridge: "JSON messages" +Application.Runtime.Bridge <-> Application.Backend.Services: "Direct function calls" +Application.Runtime.Bindings -> Application.Frontend: "TypeScript definitions" +Application.Frontend -> OS.WebView: "Renders in" +Application.Backend.NativeAPIs -> OS.SystemAPIs: "Native calls" +``` + +**Key differences from Electron:** + +| Aspect | Wails | Electron | +|--------|-------|----------| +| **Browser** | OS-provided WebView | Bundled Chromium (~100MB) | +| **Backend** | Go (compiled) | Node.js (interpreted) | +| **Communication** | In-memory bridge | IPC (inter-process) | +| **Bundle Size** | ~15MB | ~150MB | +| **Memory** | ~10MB | ~100MB+ | +| **Startup** | <0.5s | 2-3s | + +## Core Components + +### 1. Native WebView + +Wails uses the operating system's built-in web rendering engine: + + + + **WebView2** (Microsoft Edge WebView2) + - Based on Chromium (same as Edge browser) + - Pre-installed on Windows 10/11 + - Automatic updates via Windows Update + - Full modern web standards support + + + + **WebKit** (Safari's rendering engine) + - Built into macOS + - Same engine as Safari browser + - Excellent performance and battery life + - Full modern web standards support + + + + **WebKitGTK** (GTK port of WebKit) + - Installed via package manager + - Same engine as GNOME Web (Epiphany) + - Good standards support + - Lightweight and performant + + + +**Why this matters:** +- **No bundled browser** → Smaller app size +- **OS-native** → Better integration and performance +- **Auto-updates** → Security patches from OS updates +- **Familiar rendering** → Same as system browser + +### 2. The Wails Bridge + +The bridge is the heart of Wails—it enables **direct communication** between Go and JavaScript. + +```d2 +direction: down + +Frontend: "Frontend (JavaScript)" { + shape: rectangle + style.fill: "#8B5CF6" +} + +Bridge: "Wails Bridge" { + Encoder: "JSON Encoder" { + shape: rectangle + } + + Router: "Method Router" { + shape: diamond + style.fill: "#10B981" + } + + Decoder: "JSON Decoder" { + shape: rectangle + } +} + +Backend: "Backend (Go)" { + Services: "Registered Services" { + shape: rectangle + style.fill: "#00ADD8" + } +} + +Frontend -> Bridge.Encoder: "1. Call Go method\nGreet('Alice')" +Bridge.Encoder -> Bridge.Router: "2. Encode to JSON\n{method: 'Greet', args: ['Alice']}" +Bridge.Router -> Backend.Services: "3. Route to service\nGreetService.Greet('Alice')" +Backend.Services -> Bridge.Decoder: "4. Return result\n'Hello, Alice!'" +Bridge.Decoder -> Frontend: "5. Decode to JS\nPromise resolves" +``` + +**How it works:** + +1. **Frontend calls a Go method** (via auto-generated binding) +2. **Bridge encodes the call** to JSON (method name + arguments) +3. **Router finds the Go method** in registered services +4. **Go method executes** and returns a value +5. **Bridge decodes the result** and sends back to frontend +6. **Promise resolves** in JavaScript with the result + +**Performance characteristics:** +- **In-memory**: No network overhead, no HTTP +- **Zero-copy** where possible (for large data) +- **Async by default**: Non-blocking on both sides +- **Type-safe**: TypeScript definitions auto-generated + +### 3. Service System + +Services are the recommended way to expose Go functionality to the frontend. + +```go +// Define a service (just a regular Go struct) +type GreetService struct { + prefix string +} + +// Methods with exported names are automatically available +func (g *GreetService) Greet(name string) string { + return g.prefix + name + "!" +} + +func (g *GreetService) GetTime() time.Time { + return time.Now() +} + +// Register the service +app := application.New(application.Options{ + Services: []application.Service{ + application.NewService(&GreetService{prefix: "Hello, "}), + }, +}) +``` + +**Service discovery:** +- Wails **scans your struct** at startup +- **Exported methods** become callable from frontend +- **Type information** is extracted for TypeScript bindings +- **Error handling** is automatic (Go errors → JS exceptions) + +**Generated TypeScript binding:** +```typescript +// Auto-generated in frontend/bindings/GreetService.ts +export function Greet(name: string): Promise +export function GetTime(): Promise +``` + +**Why services?** +- **Type-safe**: Full TypeScript support +- **Auto-discovery**: No manual registration of methods +- **Organised**: Group related functionality +- **Testable**: Services are just Go structs + +[Learn more about services →](/features/bindings/services) + +### 4. Event System + +Events enable **pub/sub communication** between components. + +```d2 +direction: right + +GoService: "Go Service" { + shape: rectangle + style.fill: "#00ADD8" +} + +EventBus: "Event Bus" { + shape: cylinder + style.fill: "#10B981" +} + +Frontend1: "Window 1" { + shape: rectangle + style.fill: "#8B5CF6" +} + +Frontend2: "Window 2" { + shape: rectangle + style.fill: "#8B5CF6" +} + +GoService -> EventBus: "Emit('data-updated', data)" +EventBus -> Frontend1: "Notify subscribers" +EventBus -> Frontend2: "Notify subscribers" +Frontend1 -> EventBus: "On('data-updated', handler)" +Frontend2 -> EventBus: "On('data-updated', handler)" +``` + +**Use cases:** +- **Window communication**: One window notifies others +- **Background tasks**: Go service notifies UI of progress +- **State synchronisation**: Keep multiple windows in sync +- **Loose coupling**: Components don't need direct references + +**Example:** +```go +// Go: Emit an event +app.Event.Emit("user-logged-in", user) +``` + +```javascript +// JavaScript: Listen for event +import { On } from '@wailsio/runtime' + +On('user-logged-in', (user) => { + console.log('User logged in:', user) +}) +``` + +[Learn more about events →](/features/events/system) + +## Application Lifecycle + +Understanding the lifecycle helps you know when to initialise resources and clean up. + +```d2 +direction: down + +Start: "Application Start" { + shape: oval + style.fill: "#10B981" +} + +Init: "Initialisation" { + Create: "Create Application" { + shape: rectangle + } + + Register: "Register Services" { + shape: rectangle + } + + Setup: "Setup Windows/Menus" { + shape: rectangle + } +} + +Run: "Event Loop" { + Events: "Process Events" { + shape: rectangle + } + + Messages: "Handle Messages" { + shape: rectangle + } + + Render: "Update UI" { + shape: rectangle + } +} + +Shutdown: "Shutdown" { + Cleanup: "Cleanup Resources" { + shape: rectangle + } + + Save: "Save State" { + shape: rectangle + } +} + +End: "Application End" { + shape: oval + style.fill: "#EF4444" +} + +Start -> Init.Create +Init.Create -> Init.Register +Init.Register -> Init.Setup +Init.Setup -> Run.Events +Run.Events -> Run.Messages +Run.Messages -> Run.Render +Run.Render -> Run.Events: "Loop" +Run.Events -> Shutdown.Cleanup: "Quit signal" +Shutdown.Cleanup -> Shutdown.Save +Shutdown.Save -> End +``` + +**Lifecycle hooks:** + +```go +app := application.New(application.Options{ + Name: "My App", + + // Called before windows are created + OnStartup: func(ctx context.Context) { + // Initialise database, load config, etc. + }, + + // Called when app is about to quit + OnShutdown: func() { + // Save state, close connections, etc. + }, +}) +``` + +[Learn more about lifecycle →](/concepts/lifecycle) + +## Build Process + +Understanding how Wails builds your application: + +```d2 +direction: down + +Source: "Source Code" { + Go: "Go Code\n(main.go, services)" { + shape: rectangle + style.fill: "#00ADD8" + } + + Frontend: "Frontend Code\n(HTML/CSS/JS)" { + shape: rectangle + style.fill: "#8B5CF6" + } +} + +Build: "Build Process" { + AnalyseGo: "Analyse Go Code" { + shape: rectangle + } + + GenerateBindings: "Generate Bindings" { + shape: rectangle + } + + BuildFrontend: "Build Frontend" { + shape: rectangle + } + + CompileGo: "Compile Go" { + shape: rectangle + } + + Embed: "Embed Assets" { + shape: rectangle + } +} + +Output: "Output" { + Binary: "Native Binary\n(myapp.exe/.app)" { + shape: rectangle + style.fill: "#10B981" + } +} + +Source.Go -> Build.AnalyseGo +Build.AnalyseGo -> Build.GenerateBindings: "Extract types" +Build.GenerateBindings -> Source.Frontend: "TypeScript bindings" +Source.Frontend -> Build.BuildFrontend: "Compile (Vite/webpack)" +Build.BuildFrontend -> Build.Embed: "Bundled assets" +Source.Go -> Build.CompileGo +Build.CompileGo -> Build.Embed +Build.Embed -> Output.Binary +``` + +**Build steps:** + +1. **Analyse Go code** + - Scan services for exported methods + - Extract parameter and return types + - Generate method signatures + +2. **Generate TypeScript bindings** + - Create `.ts` files for each service + - Include full type definitions + - Add JSDoc comments + +3. **Build frontend** + - Run your bundler (Vite, webpack, etc.) + - Minify and optimise + - Output to `frontend/dist/` + +4. **Compile Go** + - Compile with optimisations (`-ldflags="-s -w"`) + - Include build metadata + - Platform-specific compilation + +5. **Embed assets** + - Embed frontend files into Go binary + - Compress assets + - Create single executable + +**Result:** A single native executable with everything embedded. + +[Learn more about building →](/guides/build/building) + +## Development vs Production + +Wails behaves differently in development and production: + + + + **Characteristics:** + - **Hot reload**: Frontend changes reload instantly + - **Source maps**: Debug with original source + - **DevTools**: Browser DevTools available + - **Logging**: Verbose logging enabled + - **External frontend**: Served from dev server (Vite) + + **How it works:** + ```d2 + direction: right + + WailsApp: "Wails App" { + shape: rectangle + style.fill: "#00ADD8" + } + + DevServer: "Vite Dev Server\n(localhost:5173)" { + shape: rectangle + style.fill: "#8B5CF6" + } + + WebView: "WebView" { + shape: rectangle + style.fill: "#6B7280" + } + + WailsApp -> DevServer: "Proxy requests" + DevServer -> WebView: "Serve with HMR" + WebView -> WailsApp: "Call Go methods" + ``` + + **Benefits:** + - Instant feedback on changes + - Full debugging capabilities + - Faster iteration + + + + **Characteristics:** + - **Embedded assets**: Frontend built into binary + - **Optimised**: Minified, compressed + - **No DevTools**: Disabled by default + - **Minimal logging**: Errors only + - **Single file**: Everything in one executable + + **How it works:** + ```d2 + direction: right + + Binary: "Single Binary\n(myapp.exe)" { + GoCode: "Compiled Go" { + shape: rectangle + style.fill: "#00ADD8" + } + + Assets: "Embedded Assets\n(HTML/CSS/JS)" { + shape: rectangle + style.fill: "#8B5CF6" + } + } + + WebView: "WebView" { + shape: rectangle + style.fill: "#6B7280" + } + + Binary.Assets -> WebView: "Serve from memory" + WebView -> Binary.GoCode: "Call Go methods" + ``` + + **Benefits:** + - Single file distribution + - Smaller size (minified) + - Better performance + - No external dependencies + + + +## Memory Model + +Understanding memory usage helps you build efficient applications. + +{/* VISUAL PLACEHOLDER: Memory Diagram +Description: Memory layout diagram showing: +1. Go Heap (services, application state) +2. WebView Memory (DOM, JavaScript heap) +3. Shared Memory (bridge communication) +4. Arrows showing data flow between regions +5. Annotations for zero-copy optimisations +Style: Technical diagram with memory regions as boxes, clear labels, size indicators +*/} + +**Memory regions:** + +1. **Go Heap** + - Your services and application state + - Managed by Go garbage collector + - Typically 5-10MB for simple apps + +2. **WebView Memory** + - DOM, JavaScript heap, CSS + - Managed by WebView's engine + - Typically 10-20MB for simple apps + +3. **Bridge Memory** + - Message buffers for communication + - Minimal overhead (\<1MB) + - Zero-copy for large data where possible + +**Optimisation tips:** +- **Avoid large data transfers**: Pass IDs, fetch details on demand +- **Use events for updates**: Don't poll from frontend +- **Stream large files**: Don't load entirely into memory +- **Clean up listeners**: Remove event listeners when done + +[Learn more about performance →](/guides/advanced/performance) + +## Security Model + +Wails provides a secure-by-default architecture: + +```d2 +direction: down + +Frontend: "Frontend (Untrusted)" { + shape: rectangle + style.fill: "#EF4444" +} + +Bridge: "Wails Bridge (Validation)" { + shape: diamond + style.fill: "#F59E0B" +} + +Backend: "Backend (Trusted)" { + shape: rectangle + style.fill: "#10B981" +} + +Frontend -> Bridge: "Call method" +Bridge -> Bridge: "Validate:\n- Method exists?\n- Types correct?\n- Access allowed?" +Bridge -> Backend: "Execute if valid" +Backend -> Bridge: "Return result" +Bridge -> Frontend: "Send response" +``` + +**Security features:** + +1. **Method whitelisting** + - Only exported methods are callable + - Private methods are inaccessible + - Explicit service registration required + +2. **Type validation** + - Arguments checked against Go types + - Invalid types rejected + - Prevents injection attacks + +3. **No eval()** + - Frontend can't execute arbitrary Go code + - Only predefined methods callable + - No dynamic code execution + +4. **Context isolation** + - Each window has its own context + - Services can check caller context + - Permissions per window possible + +**Best practices:** +- **Validate user input** in Go (don't trust frontend) +- **Use context** for authentication/authorisation +- **Sanitise file paths** before file operations +- **Rate limit** expensive operations + +[Learn more about security →](/guides/advanced/security) + +## Next Steps + +**Application Lifecycle** - Understand startup, shutdown, and lifecycle hooks +[Learn More →](/concepts/lifecycle) + +**Go-Frontend Bridge** - Deep dive into how the bridge works +[Learn More →](/concepts/bridge) + +**Build System** - Understand how Wails builds your application +[Learn More →](/concepts/build-system) + +**Start Building** - Apply what you've learned in a tutorial +[Tutorials →](/tutorials/03-notes-vanilla) + +--- + +**Questions about architecture?** Ask in [Discord](https://discord.gg/JDdSxwjhGf) or check the [API reference](/reference/overview). diff --git a/docs/src/content/docs/concepts/bridge.mdx b/docs/src/content/docs/concepts/bridge.mdx new file mode 100644 index 000000000..7593d896a --- /dev/null +++ b/docs/src/content/docs/concepts/bridge.mdx @@ -0,0 +1,700 @@ +--- +title: Go-Frontend Bridge +description: Deep dive into how Wails enables direct communication between Go and JavaScript +sidebar: + order: 3 +--- + +import { Tabs, TabItem } from "@astrojs/starlight/components"; + +## Direct Go-JavaScript Communication + +Wails provides a **direct, in-memory bridge** between Go and JavaScript, enabling seamless communication without HTTP overhead, process boundaries, or serialisation bottlenecks. + +## The Big Picture + +```d2 +direction: right + +Frontend: "Frontend (JavaScript)" { + UI: "React/Vue/Vanilla" { + shape: rectangle + style.fill: "#8B5CF6" + } + + Bindings: "Auto-Generated Bindings" { + shape: rectangle + style.fill: "#A78BFA" + } +} + +Bridge: "Wails Bridge" { + Encoder: "JSON Encoder" { + shape: rectangle + style.fill: "#10B981" + } + + Router: "Method Router" { + shape: diamond + style.fill: "#10B981" + } + + Decoder: "JSON Decoder" { + shape: rectangle + style.fill: "#10B981" + } + + TypeGen: "Type Generator" { + shape: rectangle + style.fill: "#10B981" + } +} + +Backend: "Backend (Go)" { + Services: "Your Services" { + shape: rectangle + style.fill: "#00ADD8" + } + + Registry: "Service Registry" { + shape: rectangle + style.fill: "#00ADD8" + } +} + +Frontend.UI -> Frontend.Bindings: "import { Method }" +Frontend.Bindings -> Bridge.Encoder: "Call Method('arg')" +Bridge.Encoder -> Bridge.Router: "Encode to JSON" +Bridge.Router -> Backend.Registry: "Find service" +Backend.Registry -> Backend.Services: "Invoke method" +Backend.Services -> Bridge.Decoder: "Return result" +Bridge.Decoder -> Frontend.Bindings: "Decode to JS" +Frontend.Bindings -> Frontend.UI: "Promise resolves" +Bridge.TypeGen -> Frontend.Bindings: "Generate types" +``` + +**Key insight:** No HTTP, no IPC, no process boundaries. Just **direct function calls** with **type safety**. + +## How It Works: Step by Step + +### 1. Service Registration (Startup) + +When your application starts, Wails scans your services: + +```go +type GreetService struct { + prefix string +} + +func (g *GreetService) Greet(name string) string { + return g.prefix + name + "!" +} + +func (g *GreetService) Add(a, b int) int { + return a + b +} + +// Register service +app := application.New(application.Options{ + Services: []application.Service{ + application.NewService(&GreetService{prefix: "Hello, "}), + }, +}) +``` + +**What Wails does:** +1. **Scans the struct** for exported methods +2. **Extracts type information** (parameters, return types) +3. **Builds a registry** mapping method names to functions +4. **Generates TypeScript bindings** with full type definitions + +### 2. Binding Generation (Build Time) + +Wails generates TypeScript bindings automatically: + +```typescript +// Auto-generated: frontend/bindings/GreetService.ts +export function Greet(name: string): Promise +export function Add(a: number, b: number): Promise +``` + +**Type mapping:** + +| Go Type | TypeScript Type | +|---------|-----------------| +| `string` | `string` | +| `int`, `int32`, `int64` | `number` | +| `float32`, `float64` | `number` | +| `bool` | `boolean` | +| `[]T` | `T[]` | +| `map[string]T` | `Record` | +| `struct` | `interface` | +| `time.Time` | `Date` | +| `error` | Exception (thrown) | + +### 3. Frontend Call (Runtime) + +Developer calls the Go method from JavaScript: + +```javascript +import { Greet, Add } from './bindings/GreetService' + +// Call Go from JavaScript +const greeting = await Greet("World") +console.log(greeting) // "Hello, World!" + +const sum = await Add(5, 3) +console.log(sum) // 8 +``` + +**What happens:** +1. **Binding function called** - `Greet("World")` +2. **Message created** - `{ service: "GreetService", method: "Greet", args: ["World"] }` +3. **Sent to bridge** - Via WebView's JavaScript bridge +4. **Promise returned** - Awaits response + +### 4. Bridge Processing (Runtime) + +The bridge receives the message and processes it: + +```d2 +direction: down + +Receive: "Receive Message" { + shape: rectangle + style.fill: "#10B981" +} + +Parse: "Parse JSON" { + shape: rectangle +} + +Validate: "Validate" { + Check: "Service exists?" { + shape: diamond + } + + CheckMethod: "Method exists?" { + shape: diamond + } + + CheckTypes: "Types correct?" { + shape: diamond + } +} + +Invoke: "Invoke Go Method" { + shape: rectangle + style.fill: "#00ADD8" +} + +Encode: "Encode Result" { + shape: rectangle +} + +Send: "Send Response" { + shape: rectangle + style.fill: "#10B981" +} + +Error: "Send Error" { + shape: rectangle + style.fill: "#EF4444" +} + +Receive -> Parse +Parse -> Validate.Check +Validate.Check -> Validate.CheckMethod: "Yes" +Validate.Check -> Error: "No" +Validate.CheckMethod -> Validate.CheckTypes: "Yes" +Validate.CheckMethod -> Error: "No" +Validate.CheckTypes -> Invoke: "Yes" +Validate.CheckTypes -> Error: "No" +Invoke -> Encode: "Success" +Invoke -> Error: "Error" +Encode -> Send +``` + +**Security:** Only registered services and exported methods are callable. + +### 5. Go Execution (Runtime) + +The Go method executes: + +```go +func (g *GreetService) Greet(name string) string { + // This runs in Go + return g.prefix + name + "!" +} +``` + +**Execution context:** +- Runs in a **goroutine** (non-blocking) +- Has access to **all Go features** (file system, network, databases) +- Can call **other Go code** freely +- Returns result or error + +### 6. Response (Runtime) + +Result is sent back to JavaScript: + +```javascript +// Promise resolves with result +const greeting = await Greet("World") +// greeting = "Hello, World!" +``` + +**Error handling:** + +```go +func (g *GreetService) Divide(a, b float64) (float64, error) { + if b == 0 { + return 0, errors.New("division by zero") + } + return a / b, nil +} +``` + +```javascript +try { + const result = await Divide(10, 0) +} catch (error) { + console.error("Go error:", error) // "division by zero" +} +``` + +## Performance Characteristics + +### Speed + +**Typical call overhead:** <1ms + +``` +Frontend Call → Bridge → Go Execution → Bridge → Frontend Response + ↓ ↓ ↓ ↓ ↓ + <0.1ms <0.1ms [varies] <0.1ms <0.1ms +``` + +**Compared to alternatives:** +- **HTTP/REST:** 5-50ms (network stack, serialisation) +- **IPC:** 1-10ms (process boundaries, marshalling) +- **Wails Bridge:** <1ms (in-memory, direct call) + +### Memory + +**Per-call overhead:** ~1KB (message buffer) + +**Zero-copy optimisation:** Large data (>1MB) uses shared memory where possible. + +### Concurrency + +**Calls are concurrent:** +- Each call runs in its own goroutine +- Multiple calls can execute simultaneously +- No blocking between calls + +```javascript +// These run concurrently +const [result1, result2, result3] = await Promise.all([ + SlowOperation1(), + SlowOperation2(), + SlowOperation3(), +]) +``` + +## Type System + +### Supported Types + +#### Primitives + +```go +// Go +func Example( + s string, + i int, + f float64, + b bool, +) (string, int, float64, bool) { + return s, i, f, b +} +``` + +```typescript +// TypeScript (auto-generated) +function Example( + s: string, + i: number, + f: number, + b: boolean, +): Promise<[string, number, number, boolean]> +``` + +#### Slices and Arrays + +```go +// Go +func Sum(numbers []int) int { + total := 0 + for _, n := range numbers { + total += n + } + return total +} +``` + +```typescript +// TypeScript +function Sum(numbers: number[]): Promise + +// Usage +const total = await Sum([1, 2, 3, 4, 5]) // 15 +``` + +#### Maps + +```go +// Go +func GetConfig() map[string]interface{} { + return map[string]interface{}{ + "theme": "dark", + "fontSize": 14, + "enabled": true, + } +} +``` + +```typescript +// TypeScript +function GetConfig(): Promise> + +// Usage +const config = await GetConfig() +console.log(config.theme) // "dark" +``` + +#### Structs + +```go +// Go +type User struct { + ID int `json:"id"` + Name string `json:"name"` + Email string `json:"email"` +} + +func GetUser(id int) (*User, error) { + return &User{ + ID: id, + Name: "Alice", + Email: "alice@example.com", + }, nil +} +``` + +```typescript +// TypeScript (auto-generated) +interface User { + id: number + name: string + email: string +} + +function GetUser(id: number): Promise + +// Usage +const user = await GetUser(1) +console.log(user.name) // "Alice" +``` + +**JSON tags:** Use `json:` tags to control field names in TypeScript. + +#### Time + +```go +// Go +func GetTimestamp() time.Time { + return time.Now() +} +``` + +```typescript +// TypeScript +function GetTimestamp(): Promise + +// Usage +const timestamp = await GetTimestamp() +console.log(timestamp.toISOString()) +``` + +#### Errors + +```go +// Go +func Validate(input string) error { + if input == "" { + return errors.New("input cannot be empty") + } + return nil +} +``` + +```typescript +// TypeScript +function Validate(input: string): Promise + +// Usage +try { + await Validate("") +} catch (error) { + console.error(error) // "input cannot be empty" +} +``` + +### Unsupported Types + +These types **cannot** be passed across the bridge: + +- **Channels** (`chan T`) +- **Functions** (`func()`) +- **Interfaces** (except `interface{}` / `any`) +- **Pointers** (except to structs) +- **Unexported fields** (lowercase) + +**Workaround:** Use IDs or handles: + +```go +// ❌ Can't pass file handle +func OpenFile(path string) (*os.File, error) { + return os.Open(path) +} + +// ✅ Return file ID instead +var files = make(map[string]*os.File) + +func OpenFile(path string) (string, error) { + file, err := os.Open(path) + if err != nil { + return "", err + } + id := generateID() + files[id] = file + return id, nil +} + +func ReadFile(id string) ([]byte, error) { + file := files[id] + return io.ReadAll(file) +} + +func CloseFile(id string) error { + file := files[id] + delete(files, id) + return file.Close() +} +``` + +## Advanced Patterns + +### Context Passing + +Services can access the call context: + +```go +type UserService struct{} + +func (s *UserService) GetCurrentUser(ctx context.Context) (*User, error) { + // Access window that made the call + window := application.ContextWindow(ctx) + + // Access application + app := application.ContextApplication(ctx) + + // Your logic + return getCurrentUser(), nil +} +``` + +**Context provides:** +- Window that made the call +- Application instance +- Request metadata + +### Streaming Data + +For large data, use events instead of return values: + +```go +func ProcessLargeFile(path string) error { + file, err := os.Open(path) + if err != nil { + return err + } + defer file.Close() + + scanner := bufio.NewScanner(file) + lineNum := 0 + + for scanner.Scan() { + lineNum++ + // Emit progress events + app.Event.Emit("file-progress", map[string]interface{}{ + "line": lineNum, + "text": scanner.Text(), + }) + } + + return scanner.Err() +} +``` + +```javascript +import { On } from '@wailsio/runtime' +import { ProcessLargeFile } from './bindings/FileService' + +// Listen for progress +On('file-progress', (data) => { + console.log(`Line ${data.line}: ${data.text}`) +}) + +// Start processing +await ProcessLargeFile('/path/to/large/file.txt') +``` + +### Cancellation + +Use context for cancellable operations: + +```go +func LongRunningTask(ctx context.Context) error { + for i := 0; i < 1000; i++ { + // Check if cancelled + select { + case <-ctx.Done(): + return ctx.Err() + default: + // Continue work + time.Sleep(100 * time.Millisecond) + } + } + return nil +} +``` + +**Note:** Context cancellation on frontend disconnect is automatic. + +### Batch Operations + +Reduce bridge overhead by batching: + +```go +// ❌ Inefficient: N bridge calls +for _, item := range items { + await ProcessItem(item) +} + +// ✅ Efficient: 1 bridge call +await ProcessItems(items) +``` + +```go +func ProcessItems(items []Item) ([]Result, error) { + results := make([]Result, len(items)) + for i, item := range items { + results[i] = processItem(item) + } + return results, nil +} +``` + +## Debugging the Bridge + +### Enable Debug Logging + +```go +app := application.New(application.Options{ + Name: "My App", + Logger: application.NewDefaultLogger(), + LogLevel: logger.DEBUG, +}) +``` + +**Output shows:** +- Method calls +- Parameters +- Return values +- Errors +- Timing information + +### Inspect Generated Bindings + +Check `frontend/bindings/` to see generated TypeScript: + +```typescript +// frontend/bindings/MyService.ts +export function MyMethod(arg: string): Promise { + return window.wails.Call('MyService.MyMethod', arg) +} +``` + +### Test Services Directly + +Test Go services without the frontend: + +```go +func TestGreetService(t *testing.T) { + service := &GreetService{prefix: "Hello, "} + result := service.Greet("Test") + if result != "Hello, Test!" { + t.Errorf("Expected 'Hello, Test!', got '%s'", result) + } +} +``` + +## Performance Tips + +### ✅ Do + +- **Batch operations** - Reduce bridge calls +- **Use events for streaming** - Don't return large arrays +- **Keep methods fast** - <100ms ideal +- **Use goroutines** - For long operations +- **Cache on Go side** - Avoid repeated calculations + +### ❌ Don't + +- **Don't make excessive calls** - Batch when possible +- **Don't return huge data** - Use pagination or streaming +- **Don't block** - Use goroutines for long operations +- **Don't pass complex types** - Keep it simple +- **Don't ignore errors** - Always handle them + +## Security + +The bridge is secure by default: + +1. **Whitelist only** - Only registered services callable +2. **Type validation** - Arguments checked against Go types +3. **No eval()** - Frontend can't execute arbitrary Go code +4. **No reflection abuse** - Only exported methods accessible + +**Best practices:** +- **Validate input** in Go (don't trust frontend) +- **Use context** for authentication/authorisation +- **Rate limit** expensive operations +- **Sanitise** file paths and user input + +## Next Steps + +**Build System** - Learn how Wails builds and bundles your application +[Learn More →](/concepts/build-system) + +**Services** - Deep dive into the service system +[Learn More →](/features/bindings/services) + +**Events** - Use events for pub/sub communication +[Learn More →](/features/events/system) + +--- + +**Questions about the bridge?** Ask in [Discord](https://discord.gg/JDdSxwjhGf) or check the [binding examples](https://github.com/wailsapp/wails/tree/v3-alpha/v3/examples/binding). diff --git a/docs/src/content/docs/concepts/build-system.mdx b/docs/src/content/docs/concepts/build-system.mdx new file mode 100644 index 000000000..f9de52bc5 --- /dev/null +++ b/docs/src/content/docs/concepts/build-system.mdx @@ -0,0 +1,700 @@ +--- +title: Build System +description: Understanding how Wails builds and packages your application +sidebar: + order: 4 +--- + +import { Tabs, TabItem } from "@astrojs/starlight/components"; + +## Unified Build System + +Wails provides a **unified build system** that compiles Go code, bundles frontend assets, embeds everything into a single executable, and handles platform-specific builds—all with one command. + +```bash +wails3 build +``` + +**Output:** Native executable with everything embedded. + +## Build Process Overview + +{/* +TODO: Fix D2 diagram generation or embed as image. +The previous D2 code block was causing MDX parsing errors in the build pipeline. +*/} + +**[Build Process Diagram Placeholder]** + + +## Build Phases + +### 1. Analysis Phase + +Wails scans your Go code to understand your services: + +```go +type GreetService struct { + prefix string +} + +func (g *GreetService) Greet(name string) string { + return g.prefix + name + "!" +} +``` + +**What Wails extracts:** +- Service name: `GreetService` +- Method name: `Greet` +- Parameter types: `string` +- Return types: `string` + +**Used for:** Generating TypeScript bindings + +### 2. Generation Phase + +#### TypeScript Bindings + +Wails generates type-safe bindings: + +```typescript +// Auto-generated: frontend/bindings/GreetService.ts +export function Greet(name: string): Promise { + return window.wails.Call('GreetService.Greet', name) +} +``` + +**Benefits:** +- Full type safety +- IDE autocomplete +- Compile-time errors +- JSDoc comments + +#### Frontend Build + +Your frontend bundler runs (Vite, webpack, etc.): + +```bash +# Vite example +vite build --outDir dist +``` + +**What happens:** +- JavaScript/TypeScript compiled +- CSS processed and minified +- Assets optimised +- Source maps generated (dev only) +- Output to `frontend/dist/` + +### 3. Compilation Phase + +#### Go Compilation + +Go code is compiled with optimisations: + +```bash +go build -ldflags="-s -w" -o myapp.exe +``` + +**Flags:** +- `-s`: Strip symbol table +- `-w`: Strip DWARF debugging info +- Result: Smaller binary (~30% reduction) + +**Platform-specific:** +- Windows: `.exe` with icon embedded +- macOS: `.app` bundle structure +- Linux: ELF binary + +#### Asset Embedding + +Frontend assets are embedded into the Go binary: + +```go +//go:embed frontend/dist +var assets embed.FS +``` + +**Result:** Single executable with everything inside. + +### 4. Output + +**Single native binary:** +- Windows: `myapp.exe` (~15MB) +- macOS: `myapp.app` (~15MB) +- Linux: `myapp` (~15MB) + +**No dependencies** (except system WebView). + +## Development vs Production + + + + **Optimised for speed:** + + ```bash + wails3 dev + ``` + + **What happens:** + 1. Starts frontend dev server (Vite on port 5173) + 2. Compiles Go without optimisations + 3. Launches app pointing to dev server + 4. Enables hot reload + 5. Includes source maps + + **Characteristics:** + - **Fast rebuilds** (<1s for frontend changes) + - **No asset embedding** (served from dev server) + - **Debug symbols** included + - **Source maps** enabled + - **Verbose logging** + + **File size:** Larger (~50MB with debug symbols) + + + + **Optimised for size and performance:** + + ```bash + wails3 build + ``` + + **What happens:** + 1. Builds frontend for production (minified) + 2. Compiles Go with optimisations + 3. Strips debug symbols + 4. Embeds assets + 5. Creates single binary + + **Characteristics:** + - **Optimised code** (minified, tree-shaken) + - **Assets embedded** (no external files) + - **Debug symbols stripped** + - **No source maps** + - **Minimal logging** + + **File size:** Smaller (~15MB) + + + +## Build Commands + +### Basic Build + +```bash +wails3 build +``` + +**Output:** `build/bin/myapp[.exe]` + +### Build for Specific Platform + +```bash +# Build for Windows (from any OS) +wails3 build -platform windows/amd64 + +# Build for macOS +wails3 build -platform darwin/amd64 +wails3 build -platform darwin/arm64 + +# Build for Linux +wails3 build -platform linux/amd64 +``` + +**Cross-compilation:** Build for any platform from any platform. + +### Build with Options + +```bash +# Custom output directory +wails3 build -o ./dist/myapp + +# Skip frontend build (use existing) +wails3 build -skipbindings + +# Clean build (remove cache) +wails3 build -clean + +# Verbose output +wails3 build -v +``` + +### Build Modes + +```bash +# Debug build (includes symbols) +wails3 build -debug + +# Production build (default, optimised) +wails3 build + +# Development build (fast, unoptimised) +wails3 build -devbuild +``` + +## Build Configuration + +### Taskfile.yml + +Wails uses [Taskfile](https://taskfile.dev/) for build configuration: + +```yaml +# Taskfile.yml +version: '3' + +tasks: + build: + desc: Build the application + cmds: + - wails3 build + + build:windows: + desc: Build for Windows + cmds: + - wails3 build -platform windows/amd64 + + build:macos: + desc: Build for macOS (Universal) + cmds: + - wails3 build -platform darwin/amd64 + - wails3 build -platform darwin/arm64 + - lipo -create -output build/bin/myapp.app build/bin/myapp-amd64.app build/bin/myapp-arm64.app + + build:linux: + desc: Build for Linux + cmds: + - wails3 build -platform linux/amd64 +``` + +**Run tasks:** + +```bash +task build:windows +task build:macos +task build:linux +``` + +### Build Options File + +Create `build/build.json` for persistent configuration: + +```json +{ + "name": "My Application", + "version": "1.0.0", + "author": "Your Name", + "description": "Application description", + "icon": "build/appicon.png", + "outputFilename": "myapp", + "platforms": ["windows/amd64", "darwin/amd64", "linux/amd64"], + "frontend": { + "dir": "./frontend", + "install": "npm install", + "build": "npm run build", + "dev": "npm run dev" + }, + "go": { + "ldflags": "-s -w -X main.version={{.Version}}" + } +} +``` + +## Asset Embedding + +### How It Works + +Wails uses Go's `embed` package: + +```go +package main + +import ( + "embed" + "github.com/wailsapp/wails/v3/pkg/application" +) + +//go:embed frontend/dist +var assets embed.FS + +func main() { + app := application.New(application.Options{ + Name: "My App", + Assets: application.AssetOptions{ + Handler: application.AssetFileServerFS(assets), + }, + }) + + app.Window.New() + app.Run() +} +``` + +**At build time:** +1. Frontend built to `frontend/dist/` +2. `//go:embed` directive includes files +3. Files compiled into binary +4. Binary contains everything + +**At runtime:** +1. App starts +2. Assets served from memory +3. No disk I/O for assets +4. Fast loading + +### Custom Assets + +Embed additional files: + +```go +//go:embed frontend/dist +var frontendAssets embed.FS + +//go:embed data/*.json +var dataAssets embed.FS + +//go:embed templates/*.html +var templateAssets embed.FS +``` + +## Build Optimisations + +### Frontend Optimisations + +**Vite (default):** + +```javascript +// vite.config.js +export default { + build: { + minify: 'terser', + terserOptions: { + compress: { + drop_console: true, // Remove console.log + drop_debugger: true, + }, + }, + rollupOptions: { + output: { + manualChunks: { + vendor: ['react', 'react-dom'], // Separate vendor bundle + }, + }, + }, + }, +} +``` + +**Results:** +- JavaScript minified (~70% reduction) +- CSS minified (~60% reduction) +- Images optimised +- Tree-shaking applied + +### Go Optimisations + +**Compiler flags:** + +```bash +-ldflags="-s -w" +``` + +- `-s`: Strip symbol table (~10% reduction) +- `-w`: Strip DWARF debug info (~20% reduction) + +**Additional optimisations:** + +```bash +-ldflags="-s -w -X main.version=1.0.0" +``` + +- `-X`: Set variable values at build time +- Useful for version numbers, build dates + +### Binary Compression + +**UPX (optional):** + +```bash +# After building +upx --best build/bin/myapp.exe +``` + +**Results:** +- ~50% size reduction +- Slightly slower startup (~100ms) +- Not recommended for macOS (code signing issues) + +## Platform-Specific Builds + +### Windows + +**Output:** `myapp.exe` + +**Includes:** +- Application icon +- Version information +- Manifest (UAC settings) + +**Icon:** + +```bash +# Specify icon +wails3 build -icon build/appicon.png +``` + +Wails converts PNG to `.ico` automatically. + +**Manifest:** + +```xml + + + + + + + + + + + + +``` + +### macOS + +**Output:** `myapp.app` (application bundle) + +**Structure:** + +``` +myapp.app/ +├── Contents/ +│ ├── Info.plist # App metadata +│ ├── MacOS/ +│ │ └── myapp # Binary +│ ├── Resources/ +│ │ └── icon.icns # Icon +│ └── _CodeSignature/ # Code signature (if signed) +``` + +**Info.plist:** + +```xml + + + + + CFBundleName + My App + CFBundleIdentifier + com.example.myapp + CFBundleVersion + 1.0.0 + + +``` + +**Universal Binary:** + +```bash +# Build for both architectures +wails3 build -platform darwin/amd64 +wails3 build -platform darwin/arm64 + +# Combine into universal binary +lipo -create -output myapp-universal \ + build/bin/myapp-amd64 \ + build/bin/myapp-arm64 +``` + +### Linux + +**Output:** `myapp` (ELF binary) + +**Dependencies:** +- GTK3 +- WebKitGTK + +**Desktop file:** + +```ini +# myapp.desktop +[Desktop Entry] +Name=My App +Exec=/usr/bin/myapp +Icon=myapp +Type=Application +Categories=Utility; +``` + +**Installation:** + +```bash +# Copy binary +sudo cp myapp /usr/bin/ + +# Copy desktop file +sudo cp myapp.desktop /usr/share/applications/ + +# Copy icon +sudo cp icon.png /usr/share/icons/hicolor/256x256/apps/myapp.png +``` + +## Build Performance + +### Typical Build Times + +| Phase | Time | Notes | +|-------|------|-------| +| Analysis | <1s | Go code scanning | +| Binding Generation | <1s | TypeScript generation | +| Frontend Build | 5-30s | Depends on project size | +| Go Compilation | 2-10s | Depends on code size | +| Asset Embedding | <1s | Embedding frontend | +| **Total** | **10-45s** | First build | +| **Incremental** | **5-15s** | Subsequent builds | + +### Speeding Up Builds + +**1. Use build cache:** + +```bash +# Go build cache is automatic +# Frontend cache (Vite) +npm run build # Uses cache by default +``` + +**2. Skip unchanged steps:** + +```bash +# Skip frontend if unchanged +wails3 build -skipbindings +``` + +**3. Parallel builds:** + +```bash +# Build multiple platforms in parallel +wails3 build -platform windows/amd64 & +wails3 build -platform darwin/amd64 & +wails3 build -platform linux/amd64 & +wait +``` + +**4. Use faster tools:** + +```bash +# Use esbuild instead of webpack +# (Vite uses esbuild by default) +``` + +## Troubleshooting + +### Build Fails + +**Symptom:** `wails3 build` exits with error + +**Common causes:** + +1. **Go compilation error** + ```bash + # Check Go code compiles + go build + ``` + +2. **Frontend build error** + ```bash + # Check frontend builds + cd frontend + npm run build + ``` + +3. **Missing dependencies** + ```bash + # Install dependencies + npm install + go mod download + ``` + +### Binary Too Large + +**Symptom:** Binary is >50MB + +**Solutions:** + +1. **Strip debug symbols** (should be automatic) + ```bash + wails3 build # Already includes -ldflags="-s -w" + ``` + +2. **Check embedded assets** + ```bash + # Remove unnecessary files from frontend/dist/ + # Check for large images, videos, etc. + ``` + +3. **Use UPX compression** + ```bash + upx --best build/bin/myapp.exe + ``` + +### Slow Builds + +**Symptom:** Builds take >1 minute + +**Solutions:** + +1. **Use build cache** + - Go cache is automatic + - Frontend cache (Vite) is automatic + +2. **Skip unchanged steps** + ```bash + wails3 build -skipbindings + ``` + +3. **Optimise frontend build** + ```javascript + // vite.config.js + export default { + build: { + minify: 'esbuild', // Faster than terser + }, + } + ``` + +## Best Practices + +### ✅ Do + +- **Use `wails3 dev` during development** - Fast iteration +- **Use `wails3 build` for releases** - Optimised output +- **Version your builds** - Use `-ldflags` to embed version +- **Test builds on target platforms** - Cross-compilation isn't perfect +- **Keep frontend builds fast** - Optimise bundler config +- **Use build cache** - Speeds up subsequent builds + +### ❌ Don't + +- **Don't commit `build/` directory** - Add to `.gitignore` +- **Don't skip testing builds** - Always test before release +- **Don't embed unnecessary assets** - Keep binaries small +- **Don't use debug builds for production** - Use optimised builds +- **Don't forget code signing** - Required for distribution + +## Next Steps + +**Building Applications** - Detailed guide to building and packaging +[Learn More →](/guides/building) + +**Cross-Platform Builds** - Build for all platforms from one machine +[Learn More →](/guides/cross-platform) + +**Creating Installers** - Create installers for end users +[Learn More →](/guides/installers) + +--- + +**Questions about building?** Ask in [Discord](https://discord.gg/JDdSxwjhGf) or check the [build examples](https://github.com/wailsapp/wails/tree/v3-alpha/v3/examples/build). diff --git a/docs/src/content/docs/concepts/lifecycle.mdx b/docs/src/content/docs/concepts/lifecycle.mdx new file mode 100644 index 000000000..c7f6c0805 --- /dev/null +++ b/docs/src/content/docs/concepts/lifecycle.mdx @@ -0,0 +1,807 @@ +--- +title: Application Lifecycle +description: Understanding the Wails application lifecycle from startup to shutdown +sidebar: + order: 2 +--- + +import { Tabs, TabItem } from "@astrojs/starlight/components"; + +## Understanding Application Lifecycle + +Desktop applications have a lifecycle from startup to shutdown. Wails v3 provides **services**, **events**, and **hooks** to manage this lifecycle effectively. + +## The Lifecycle Stages + +```d2 +direction: down + +Start: "Application Start" { + shape: oval + style.fill: "#10B981" +} + +Init: "Initialisation" { + Parse: "Parse Options" { + shape: rectangle + } + Register: "Register Services" { + shape: rectangle + } + Setup: "Setup Runtime" { + shape: rectangle + } +} + +AppRun: "app.Run()" { + shape: rectangle + style.fill: "#3B82F6" +} + +ServiceStartup: "Service Startup" { + shape: rectangle + style.fill: "#8B5CF6" +} + +EventLoop: "Event Loop" { + Process: "Process Events" { + shape: rectangle + } + Handle: "Handle Messages" { + shape: rectangle + } + Update: "Update UI" { + shape: rectangle + } +} + +QuitSignal: "Quit Signal" { + shape: diamond + style.fill: "#F59E0B" +} + +ShouldQuit: "ShouldQuit Check" { + shape: rectangle + style.fill: "#3B82F6" +} + +OnShutdown: "OnShutdown Callbacks" { + shape: rectangle + style.fill: "#3B82F6" +} + +ServiceShutdown: "Service Shutdown" { + shape: rectangle + style.fill: "#8B5CF6" +} + +Cleanup: "Cleanup" { + Close: "Close Windows" { + shape: rectangle + } + Release: "Release Resources" { + shape: rectangle + } +} + +End: "Application End" { + shape: oval + style.fill: "#EF4444" +} + +Start -> Init.Parse +Init.Parse -> Init.Register +Init.Register -> Init.Setup +Init.Setup -> AppRun +AppRun -> ServiceStartup +ServiceStartup -> EventLoop.Process +EventLoop.Process -> EventLoop.Handle +EventLoop.Handle -> EventLoop.Update +EventLoop.Update -> EventLoop.Process: "Loop" +EventLoop.Process -> QuitSignal: "User quits" +QuitSignal -> ShouldQuit: "Check allowed?" +ShouldQuit -> EventLoop.Process: "Denied" +ShouldQuit -> OnShutdown: "Allowed" +OnShutdown -> ServiceShutdown +ServiceShutdown -> Cleanup.Close +Cleanup.Close -> Cleanup.Release +Cleanup.Release -> End +``` + +### 1. Application Creation + +Create your application with `application.New()`: + +```go +app := application.New(application.Options{ + Name: "My App", + Description: "An application built with Wails", + Services: []application.Service{ + application.NewService(&MyService{}), + }, + Assets: application.AssetOptions{ + Handler: application.BundledAssetFileServer(assets), + }, +}) +``` + +**What happens:** +1. Options are parsed and validated +2. Services are registered (but not started yet) +3. Asset server is configured +4. Runtime is set up + +### 2. Running the Application + +Call `app.Run()` to start the application: + +```go +err := app.Run() // Blocks until quit +if err != nil { + log.Fatal(err) +} +``` + +**What happens:** +1. Services are started in registration order +2. Event listeners are activated +3. Windows can be created +4. Event loop begins + +### 3. Event Loop + +The application enters the event loop where it spends most of its time: + +- OS events processed (mouse, keyboard, window events) +- Go-to-JS messages handled +- JS-to-Go calls executed +- UI updates rendered + +### 4. Shutdown + +When the application quits: + +1. `ShouldQuit` callback is checked (if set) +2. `OnShutdown` callbacks are executed +3. Services are shut down in reverse order +4. Windows are closed +5. Resources are released + +## Services Lifecycle + +Services are the primary way to manage lifecycle in Wails v3. They provide startup and shutdown hooks through interfaces. For complete documentation on services, see the [Services guide](/features/bindings/services). + +### Creating a Service + +```go +type MyService struct { + db *sql.DB +} + +// ServiceStartup is called when the application starts +func (s *MyService) ServiceStartup(ctx context.Context, options application.ServiceOptions) error { + var err error + s.db, err = sql.Open("sqlite3", "app.db") + if err != nil { + return err // Startup aborts if error returned + } + + // Run migrations + if err := s.runMigrations(); err != nil { + return err + } + + return nil +} + +// ServiceShutdown is called when the application shuts down +func (s *MyService) ServiceShutdown() error { + if s.db != nil { + return s.db.Close() + } + return nil +} +``` + +### Registering Services + +```go +app := application.New(application.Options{ + Services: []application.Service{ + application.NewService(&MyService{}), + application.NewService(&AnotherService{}), + }, +}) +``` + +**Key points:** +- Services start in registration order +- Services shut down in **reverse** registration order +- If a service's `ServiceStartup` returns an error, the application aborts +- The `ctx` passed to `ServiceStartup` is cancelled when shutdown begins + +### Using the Application Context + +The context passed to `ServiceStartup` is valid for the application's lifetime: + +```go +func (s *MyService) ServiceStartup(ctx context.Context, options application.ServiceOptions) error { + // Start a background task that respects shutdown + go func() { + ticker := time.NewTicker(5 * time.Minute) + defer ticker.Stop() + + for { + select { + case <-ticker.C: + s.performBackgroundSync() + case <-ctx.Done(): + // Application is shutting down + return + } + } + }() + + return nil +} +``` + +You can also access the context from the application instance: + +```go +app := application.Get() +ctx := app.Context() +``` + +## Application-Level Hooks + +These are convenience callbacks in `application.Options` that let you hook into the application lifecycle without creating a full service. They're useful for simple cleanup tasks, quit confirmation, or when you need to run code at specific points in the shutdown sequence. + +For more complex lifecycle management with startup logic, dependency injection, or stateful resources, use [Services](#services-lifecycle) instead. + +### ShouldQuit + +The `ShouldQuit` callback is called whenever a quit is requested—whether by the user closing the last window, pressing Cmd+Q (macOS) / Alt+F4 (Windows), or calling `app.Quit()` programmatically. + +**Return value:** +- Return `true` to allow the quit to proceed (application will shut down) +- Return `false` to cancel the quit (application continues running) + +This is your opportunity to intercept quit requests and optionally prevent them, for example to prompt the user about unsaved changes: + +```go +app := application.New(application.Options{ + ShouldQuit: func() bool { + if !hasUnsavedChanges() { + return true // No unsaved changes, allow quit + } + + // Prompt the user + result, _ := application.QuestionDialog(). + SetTitle("Unsaved Changes"). + SetMessage("You have unsaved changes. Quit anyway?"). + AddButton("Quit", "quit"). + AddButton("Cancel", "cancel"). + Show() + + // Only quit if user clicked "Quit" + return result == "quit" + }, +}) +``` + +If `ShouldQuit` is not set, the application will quit immediately when requested. + +**When ShouldQuit is called:** +- User closes the last window (unless `DisableQuitOnLastWindowClosed` is set) +- User presses Cmd+Q on macOS +- User presses Alt+F4 on Windows (when focused on last window) +- Code calls `app.Quit()` + +**When ShouldQuit is NOT called:** +- The process is killed (SIGKILL, Task Manager force-quit) +- `os.Exit()` is called directly + +### OnShutdown + +The `OnShutdown` callback is called when the application is confirmed to be quitting (after `ShouldQuit` returns `true`, if set). Use this for cleanup tasks like saving state, closing database connections, or releasing resources. + +```go +app := application.New(application.Options{ + OnShutdown: func() { + // Save application state + saveState() + + // Close connections + cleanup() + }, +}) +``` + +You can also register additional shutdown callbacks programmatically at any time during the application's lifecycle: + +```go +app.OnShutdown(func() { + log.Println("Application shutting down...") +}) +``` + +Multiple callbacks are executed in the order they were registered. The shutdown process blocks until all callbacks complete. + +**Important:** Keep shutdown callbacks fast (under 1 second). The operating system may force-terminate applications that take too long to quit, which could interrupt your cleanup and cause data loss. + +### PostShutdown + +The `PostShutdown` callback is called after all shutdown tasks have completed, just before the process terminates. At this point, the application instance is no longer usable—windows are closed, services are shut down, and resources are released. + +This is primarily useful for: +- Final logging that must happen after all other cleanup +- Testing and debugging shutdown behaviour +- Platforms where `app.Run()` doesn't return (the callback ensures your code runs) + +```go +app := application.New(application.Options{ + PostShutdown: func() { + // Final logging + log.Println("Application terminated cleanly") + + // Flush any buffered logs + logger.Sync() + }, +}) +``` + +**Note:** Do not attempt to use application features (windows, dialogs, etc.) in `PostShutdown`—they are no longer available. + +## Event-Based Lifecycle + +Wails provides an event system that notifies you when things happen in your application—windows opening, the application starting, theme changes, and more. You can listen to these events to react to lifecycle changes without blocking or intercepting them. + +For window events, you can also use `RegisterHook` instead of `OnWindowEvent` to intercept and cancel actions—for example, preventing a window from closing. See [Window Hooks](#window-hooks-cancellable-events) below. + +For full documentation on the event system, see the [Events guide](/features/events/system). + +### Application Events + +Listen to application lifecycle events: + +```go +app.Event.OnApplicationEvent(events.Common.ApplicationStarted, func(event *application.ApplicationEvent) { + app.Logger.Info("Application has started!") +}) +``` + +Platform-specific events are also available: + +```go +// macOS +app.Event.OnApplicationEvent(events.Mac.ApplicationDidFinishLaunching, func(event *application.ApplicationEvent) { + // Handle macOS launch +}) + +app.Event.OnApplicationEvent(events.Mac.ApplicationWillTerminate, func(event *application.ApplicationEvent) { + // Handle macOS termination +}) + +// Windows +app.Event.OnApplicationEvent(events.Windows.ApplicationStarted, func(event *application.ApplicationEvent) { + // Handle Windows start +}) +``` + +### Window Events + +Listen to window lifecycle events: + +```go +window := app.Window.New() + +window.OnWindowEvent(events.Common.WindowFocus, func(e *application.WindowEvent) { + app.Logger.Info("Window gained focus") +}) + +window.OnWindowEvent(events.Common.WindowClosing, func(e *application.WindowEvent) { + app.Logger.Info("Window is closing") +}) +``` + +### Window Hooks (Cancellable Events) + +Use `RegisterHook` instead of `OnWindowEvent` when you need to **cancel** an event: + +```go +window := app.Window.New() + +var countdown = 3 + +window.RegisterHook(events.Common.WindowClosing, func(e *application.WindowEvent) { + countdown-- + if countdown > 0 { + app.Logger.Info("Not closing yet!", "remaining", countdown) + e.Cancel() // Prevent the window from closing + return + } + app.Logger.Info("Window closing now") +}) +``` + +**Difference between OnWindowEvent and RegisterHook:** +- `OnWindowEvent`: Notifies you when an event happens (cannot cancel) +- `RegisterHook`: Lets you intercept and potentially cancel the event + +## Window Lifecycle + +Windows have their own lifecycle, from creation through to destruction. Each window loads its frontend content independently and can be shown, hidden, or closed at any time. When a user attempts to close a window, you can intercept this with a `RegisterHook` to prompt for confirmation or hide the window instead of destroying it. + +For complete window documentation, see the [Windows guide](/features/windows/basics). + +```d2 +direction: down + +Create: "Create Window" { + shape: oval + style.fill: "#10B981" +} + +Load: "Load Frontend" { + shape: rectangle +} + +Show: "Show Window" { + shape: rectangle +} + +Active: "Window Active" { + Events: "Handle Events" { + shape: rectangle + } +} + +CloseRequest: "Close Request" { + shape: diamond + style.fill: "#F59E0B" +} + +Hook: "WindowClosing Hook" { + shape: rectangle + style.fill: "#3B82F6" +} + +Destroy: "Destroy Window" { + shape: rectangle +} + +End: "Window Closed" { + shape: oval + style.fill: "#EF4444" +} + +Create -> Load +Load -> Show +Show -> Active.Events +Active.Events -> Active.Events: "Loop" +Active.Events -> CloseRequest: "User closes" +CloseRequest -> Hook +Hook -> Active.Events: "Cancelled" +Hook -> Destroy: "Allowed" +Destroy -> End +``` + +### Creating Windows + +```go +window := app.Window.NewWithOptions(application.WebviewWindowOptions{ + Title: "My Window", + Width: 800, + Height: 600, +}) +``` + +### Preventing Window Close + +```go +window.RegisterHook(events.Common.WindowClosing, func(e *application.WindowEvent) { + if hasUnsavedChanges() { + // Show dialog + result, _ := application.QuestionDialog(). + SetTitle("Unsaved Changes"). + SetMessage("Save before closing?"). + AddButton("Save", "save"). + AddButton("Discard", "discard"). + AddButton("Cancel", "cancel"). + Show() + + switch result { + case "save": + saveChanges() + // Allow close + case "cancel": + e.Cancel() // Prevent close + } + // "discard" falls through and allows close + } +}) +``` + +### Hide Instead of Close + +A common pattern for system tray apps: + +```go +window.RegisterHook(events.Common.WindowClosing, func(e *application.WindowEvent) { + window.Hide() // Hide instead of destroy + e.Cancel() // Prevent actual close +}) +``` + +## Multi-Window Lifecycle + +With multiple windows: + +```go +mainWindow := app.Window.NewWithOptions(application.WebviewWindowOptions{ + Title: "Main Window", +}) + +settingsWindow := app.Window.NewWithOptions(application.WebviewWindowOptions{ + Title: "Settings", + Width: 400, + Height: 600, + Hidden: true, // Start hidden +}) +``` + +**Default behaviour varies by platform:** + +| Platform | Default when last window closes | +|----------|--------------------------------| +| macOS | App stays running (menu bar remains) | +| Windows | App quits | +| Linux | App quits | + +macOS follows native platform conventions where applications typically remain active in the menu bar even with no windows. Windows and Linux quit by default. + +**Make all platforms quit when last window closes:** + +```go +app := application.New(application.Options{ + Mac: application.MacOptions{ + ApplicationShouldTerminateAfterLastWindowClosed: true, + }, +}) +``` + +**Make all platforms stay running when last window closes:** + +This is useful for system tray applications or apps that should remain running in the background. + +```go +app := application.New(application.Options{ + Windows: application.WindowsOptions{ + DisableQuitOnLastWindowClosed: true, + }, + Linux: application.LinuxOptions{ + DisableQuitOnLastWindowClosed: true, + }, +}) +``` + +## Common Patterns + +### Pattern 1: Database Service + +```go +type DatabaseService struct { + db *sql.DB +} + +func (s *DatabaseService) ServiceStartup(ctx context.Context, options application.ServiceOptions) error { + var err error + s.db, err = sql.Open("sqlite3", "app.db") + if err != nil { + return fmt.Errorf("failed to open database: %w", err) + } + + if err := s.db.PingContext(ctx); err != nil { + return fmt.Errorf("failed to connect to database: %w", err) + } + + return nil +} + +func (s *DatabaseService) ServiceShutdown() error { + if s.db != nil { + return s.db.Close() + } + return nil +} + +// Exported methods are available to the frontend +func (s *DatabaseService) GetUsers() ([]User, error) { + // Query implementation +} +``` + +### Pattern 2: Configuration Service + +```go +type ConfigService struct { + config *Config + path string +} + +func (s *ConfigService) ServiceStartup(ctx context.Context, options application.ServiceOptions) error { + s.path = "config.json" + + data, err := os.ReadFile(s.path) + if err != nil { + if os.IsNotExist(err) { + s.config = &Config{} // Default config + return nil + } + return err + } + + return json.Unmarshal(data, &s.config) +} + +func (s *ConfigService) ServiceShutdown() error { + data, err := json.MarshalIndent(s.config, "", " ") + if err != nil { + return err + } + return os.WriteFile(s.path, data, 0644) +} +``` + +### Pattern 3: Background Worker + +```go +type WorkerService struct { + cancel context.CancelFunc +} + +func (s *WorkerService) ServiceStartup(ctx context.Context, options application.ServiceOptions) error { + workerCtx, cancel := context.WithCancel(ctx) + s.cancel = cancel + + go s.runWorker(workerCtx) + + return nil +} + +func (s *WorkerService) ServiceShutdown() error { + if s.cancel != nil { + s.cancel() + } + return nil +} + +func (s *WorkerService) runWorker(ctx context.Context) { + ticker := time.NewTicker(time.Minute) + defer ticker.Stop() + + for { + select { + case <-ticker.C: + s.doWork() + case <-ctx.Done(): + return + } + } +} +``` + +## Lifecycle Reference + +| Hook/Interface | When Called | Can Cancel? | Use For | +|----------------|-------------|-------------|---------| +| `ServiceStartup` | During `app.Run()`, before event loop | No (return error to abort) | Initialisation | +| `ServiceShutdown` | During shutdown, after `OnShutdown` | No | Cleanup | +| `OnShutdown` | When quit confirmed | No | Application cleanup | +| `ShouldQuit` | When quit requested | Yes (return false) | Confirm quit | +| `RegisterHook(WindowClosing)` | When window close requested | Yes (`e.Cancel()`) | Prevent window close | +| `OnWindowEvent` | When event occurs | No | React to events | +| `OnApplicationEvent` | When event occurs | No | React to events | + +## Platform Differences + +### macOS + +- **Application menu** persists even with no windows +- **Cmd+Q** triggers quit (goes through `ShouldQuit`) +- **Dock icon** remains unless hidden +- Use `ApplicationShouldTerminateAfterLastWindowClosed` to control quit behaviour + +### Windows + +- **No application menu** without a window +- **Alt+F4** closes window (can be prevented with `RegisterHook`) +- **System tray** can keep app running + +### Linux + +- **Behaviour varies** by desktop environment +- **Generally similar to Windows** + +## Debugging Lifecycle Issues + +### Problem: Application Won't Quit + +**Causes:** +1. `ShouldQuit` returning `false` +2. `OnShutdown` taking too long +3. Background goroutines not stopping + +**Solution:** + +```go +// 1. Check ShouldQuit logic +ShouldQuit: func() bool { + log.Println("ShouldQuit called") + return true +} + +// 2. Keep OnShutdown fast +OnShutdown: func() { + log.Println("OnShutdown started") + // Fast cleanup only + log.Println("OnShutdown finished") +} + +// 3. Use context for background tasks +func (s *MyService) ServiceStartup(ctx context.Context, options application.ServiceOptions) error { + go func() { + <-ctx.Done() + log.Println("Context cancelled, stopping background work") + }() + return nil +} +``` + +### Problem: Service Startup Fails + +**Solution:** Return descriptive errors: + +```go +func (s *MyService) ServiceStartup(ctx context.Context, options application.ServiceOptions) error { + if err := s.init(); err != nil { + return fmt.Errorf("failed to initialise: %w", err) + } + return nil +} +``` + +The error will be logged and the application will not start. + +## Best Practices + +### Do + +- **Use services for lifecycle management** - They provide proper startup/shutdown hooks +- **Keep shutdown fast** - Target under 1 second for all cleanup +- **Use context for cancellation** - Stop background tasks properly +- **Handle errors in startup** - Return errors to abort cleanly +- **Log lifecycle events** - Helps with debugging + +### Don't + +- **Don't block in service startup** - Keep initialisation fast (under 2 seconds) +- **Don't show dialogs in shutdown** - App is quitting, UI may not work +- **Don't ignore the context** - Always check `ctx.Done()` in goroutines +- **Don't leak resources** - Always implement `ServiceShutdown` + +## Next Steps + +**Services** - Learn more about the service system +[Learn More →](/features/services) + +**Events System** - Use events for communication +[Learn More →](/features/events/system) + +**Window Management** - Create and manage windows +[Learn More →](/features/windows/basics) + +--- + +**Questions about lifecycle?** Ask in [Discord](https://discord.gg/JDdSxwjhGf) or check the [examples](https://github.com/wailsapp/wails/tree/v3-alpha/v3/examples). diff --git a/docs/src/content/docs/concepts/manager-api.mdx b/docs/src/content/docs/concepts/manager-api.mdx new file mode 100644 index 000000000..26f6de918 --- /dev/null +++ b/docs/src/content/docs/concepts/manager-api.mdx @@ -0,0 +1,266 @@ +--- +title: Manager API +description: Organized API structure with focused manager interfaces +sidebar: + order: 2 +--- + +import { Tabs, TabItem } from "@astrojs/starlight/components"; + +The Wails v3 Manager API provides an organized and discoverable way to access application functionality through focused manager structs. This new API structure groups related methods together while maintaining full backward compatibility with the traditional App API. + +## Overview + +The Manager API organizes application functionality into eleven focused areas: + +- **`app.Window`** - Window creation, management, and callbacks +- **`app.ContextMenu`** - Context menu registration and management +- **`app.KeyBinding`** - Global key binding management +- **`app.Browser`** - Browser integration (opening URLs and files) +- **`app.Env`** - Environment information and system state +- **`app.Dialog`** - File and message dialog operations +- **`app.Event`** - Custom event handling and application events +- **`app.Menu`** - Application menu management +- **`app.Screen`** - Screen management and coordinate transformations +- **`app.Clipboard`** - Clipboard text operations +- **`app.SystemTray`** - System tray icon creation and management + +## Benefits + +- **Better discoverability** - IDE autocomplete shows organized API surface +- **Improved code organization** - Related methods grouped together +- **Enhanced maintainability** - Separation of concerns across managers +- **Future extensibility** - Easier to add new features to specific areas + +## Usage + +The Manager API provides organized access to all application functionality: + +```go +// Events and custom event handling +app.Event.Emit("custom", data) +app.Event.On("custom", func(e *CustomEvent) { ... }) + +// Window management +window, _ := app.Window.GetByName("main") +app.Window.OnCreate(func(window Window) { ... }) + +// Browser integration +app.Browser.OpenURL("https://wails.io") + +// Menu management +menu := app.Menu.New() +app.Menu.Set(menu) + +// System tray +systray := app.SystemTray.New() +``` + +## Manager Reference + +### Window Manager + +Manages window creation, retrieval, and lifecycle callbacks. + +```go +// Create windows +window := app.Window.New() +window := app.Window.NewWithOptions(options) +current := app.Window.Current() + +// Find windows +window, exists := app.Window.GetByName("main") +windows := app.Window.GetAll() + +// Window callbacks +app.Window.OnCreate(func(window Window) { + // Handle window creation +}) +``` + +### Event Manager + +Handles custom events and application event listening. + +```go +// Custom events +app.Event.Emit("userAction", data) +cancelFunc := app.Event.On("userAction", func(e *CustomEvent) { + // Handle event +}) +app.Event.Off("userAction") +app.Event.Reset() // Remove all listeners + +// Application events +app.Event.OnApplicationEvent(events.Common.ThemeChanged, func(e *ApplicationEvent) { + // Handle system theme change +}) +``` + +### Browser Manager + +Provides browser integration for opening URLs and files. + +```go +// Open URLs and files in default browser +err := app.Browser.OpenURL("https://wails.io") +err := app.Browser.OpenFile("/path/to/document.pdf") +``` + +### Environment Manager + +Access to system environment information. + +```go +// Get environment info +env := app.Env.Info() +fmt.Printf("OS: %s, Arch: %s\n", env.OS, env.Arch) + +// Check system theme +if app.Env.IsDarkMode() { + // Dark mode is active +} + +// Open file manager +err := app.Env.OpenFileManager("/path/to/folder", false) +``` + +### Dialog Manager + +Organized access to file and message dialogs. + +```go +// File dialogs +result, err := app.Dialog.OpenFile(). + AddFilter("Text Files", "*.txt"). + PromptForSingleSelection() + +result, err = app.Dialog.SaveFile(). + SetDefaultFilename("document.txt"). + PromptForSingleSelection() + +// Message dialogs +app.Dialog.Info(). + SetTitle("Information"). + SetMessage("Operation completed successfully"). + Show() + +app.Dialog.Error(). + SetTitle("Error"). + SetMessage("An error occurred"). + Show() +``` + +### Menu Manager + +Application menu creation and management. + +```go +// Create and set application menu +menu := app.Menu.New() +fileMenu := menu.AddSubmenu("File") +fileMenu.Add("New").OnClick(func(ctx *Context) { + // Handle menu click +}) + +app.Menu.Set(menu) + +// Show about dialog +app.Menu.ShowAbout() +``` + +### Key Binding Manager + +Dynamic management of global key bindings. + +```go +// Add key bindings +app.KeyBinding.Add("ctrl+n", func(window *WebviewWindow) { + // Handle Ctrl+N +}) + +app.KeyBinding.Add("ctrl+q", func(window *WebviewWindow) { + app.Quit() +}) + +// Remove key bindings +app.KeyBinding.Remove("ctrl+n") + +// Get all bindings +bindings := app.KeyBinding.GetAll() +``` + +### Context Menu Manager + +Advanced context menu management (for library authors). + +```go +// Create and register context menu +menu := app.ContextMenu.New() +app.ContextMenu.Add("myMenu", menu) + +// Retrieve context menu +menu, exists := app.ContextMenu.Get("myMenu") + +// Remove context menu +app.ContextMenu.Remove("myMenu") +``` + +### Screen Manager + +Screen management and coordinate transformations for multi-monitor setups. + +```go +// Get screen information +screens := app.Screen.GetAll() +primary := app.Screen.GetPrimary() + +// Coordinate transformations +physicalPoint := app.Screen.DipToPhysicalPoint(logicalPoint) +logicalPoint := app.Screen.PhysicalToDipPoint(physicalPoint) + +// Screen detection +screen := app.Screen.ScreenNearestDipPoint(point) +screen = app.Screen.ScreenNearestDipRect(rect) +``` + +### Clipboard Manager + +Clipboard operations for reading and writing text. + +```go +// Set text to clipboard +success := app.Clipboard.SetText("Hello World") +if !success { + // Handle error +} + +// Get text from clipboard +text, ok := app.Clipboard.Text() +if !ok { + // Handle error +} else { + // Use the text +} +``` + +### SystemTray Manager + +System tray icon creation and management. + +```go +// Create system tray +systray := app.SystemTray.New() +systray.SetLabel("My App") +systray.SetIcon(iconBytes) + +// Add menu to system tray +menu := app.Menu.New() +menu.Add("Open").OnClick(func(ctx *Context) { + // Handle click +}) +systray.SetMenu(menu) + +// Destroy system tray when done +systray.Destroy() +``` \ No newline at end of file diff --git a/docs/src/content/docs/contributing.mdx b/docs/src/content/docs/contributing.mdx new file mode 100644 index 000000000..841c30282 --- /dev/null +++ b/docs/src/content/docs/contributing.mdx @@ -0,0 +1,275 @@ +--- +title: Contributing +description: Contribute to Wails +sidebar: + order: 100 +--- + +import { Card, CardGrid } from "@astrojs/starlight/components"; + +## Welcome Contributors! + +We welcome contributions to Wails! Whether you're fixing bugs, adding features, or improving documentation, your help is appreciated. + +## Ways to Contribute + +### 1. Report Issues + +Found a bug? [Open an issue](https://github.com/wailsapp/wails/issues/new) with: +- Clear description +- Steps to reproduce +- Expected vs actual behaviour +- System information +- Code samples + +### 2. Improve Documentation + +Documentation improvements are always welcome: +- Fix typos and errors +- Add examples +- Clarify explanations +- Translate content + +### 3. Submit Code + +Contribute code through pull requests: +- Bug fixes +- New features +- Performance improvements +- Tests + +## Getting Started + +### Fork and Clone + +```bash +# Fork the repository on GitHub +# Then clone your fork +git clone https://github.com/YOUR_USERNAME/wails.git +cd wails + +# Add upstream remote +git remote add upstream https://github.com/wailsapp/wails.git +``` + +### Build from Source + +```bash +# Install dependencies +go mod download + +# Build Wails CLI +cd v3/cmd/wails3 +go build + +# Test your build +./wails3 version +``` + +### Run Tests + +```bash +# Run all tests +go test ./... + +# Run specific package tests +go test ./v3/pkg/application + +# Run with coverage +go test -cover ./... +``` + +## Making Changes + +### Create a Branch + +```bash +# Update main +git checkout main +git pull upstream main + +# Create feature branch +git checkout -b feature/my-feature +``` + +### Make Your Changes + +1. **Write code** following Go conventions +2. **Add tests** for new functionality +3. **Update documentation** if needed +4. **Run tests** to ensure nothing breaks +5. **Commit changes** with clear messages + +### Commit Guidelines + +```bash +# Good commit messages +git commit -m "fix: resolve window focus issue on macOS" +git commit -m "feat: add support for custom window chrome" +git commit -m "docs: improve bindings documentation" + +# Use conventional commits: +# - feat: New feature +# - fix: Bug fix +# - docs: Documentation +# - test: Tests +# - refactor: Code refactoring +# - chore: Maintenance +``` + +### Submit Pull Request + +```bash +# Push to your fork +git push origin feature/my-feature + +# Open pull request on GitHub +# Provide clear description +# Reference related issues +``` + +## Pull Request Guidelines + +### Good PR Description + +```markdown +## Description +Brief description of changes + +## Changes +- Added feature X +- Fixed bug Y +- Updated documentation + +## Testing +- Tested on macOS 14 +- Tested on Windows 11 +- All tests passing + +## Related Issues +Fixes #123 +``` + +### PR Checklist + +- [ ] Code follows Go conventions +- [ ] Tests added/updated +- [ ] Documentation updated +- [ ] All tests passing +- [ ] No breaking changes (or documented) +- [ ] Commit messages clear + +## Code Guidelines + +### Go Code Style + +```go +// ✅ Good: Clear, documented, tested +// ProcessData processes the input data and returns the result. +// It returns an error if the data is invalid. +func ProcessData(data string) (string, error) { + if data == "" { + return "", errors.New("data cannot be empty") + } + + result := process(data) + return result, nil +} + +// ❌ Bad: No docs, no error handling +func ProcessData(data string) string { + return process(data) +} +``` + +### Testing + +```go +func TestProcessData(t *testing.T) { + tests := []struct { + name string + input string + want string + wantErr bool + }{ + {"valid input", "test", "processed", false}, + {"empty input", "", "", true}, + } + + for _, tt := range tests { + t.Run(tt.name, func(t *testing.T) { + got, err := ProcessData(tt.input) + if (err != nil) != tt.wantErr { + t.Errorf("ProcessData() error = %v, wantErr %v", err, tt.wantErr) + return + } + if got != tt.want { + t.Errorf("ProcessData() = %v, want %v", got, tt.want) + } + }) + } +} +``` + +## Documentation + +### Writing Docs + +Documentation uses Starlight (Astro): + +```bash +cd docs +npm install +npm run dev +``` + +### Documentation Style + +- Use International English spelling +- Start with the problem +- Provide working examples +- Include troubleshooting +- Cross-reference related content + +## Community + +### Get Help + +- **Discord:** [Join our community](https://discord.gg/JDdSxwjhGf) +- **GitHub Discussions:** Ask questions +- **GitHub Issues:** Report bugs + +### Code of Conduct + +Be respectful, inclusive, and professional. We're all here to build great software together. + +## Recognition + +Contributors are recognised in: +- Release notes +- Contributors list +- GitHub insights + +Thank you for contributing to Wails! 🎉 + +## Next Steps + + + + Visit the Wails repository. + + [View on GitHub →](https://github.com/wailsapp/wails) + + + + Join the community. + + [Join Discord →](https://discord.gg/JDdSxwjhGf) + + + + Read the docs. + + [Browse Docs →](/quick-start/why-wails) + + diff --git a/docs/src/content/docs/contributing/_category_.json b/docs/src/content/docs/contributing/_category_.json new file mode 100644 index 000000000..5f76b677d --- /dev/null +++ b/docs/src/content/docs/contributing/_category_.json @@ -0,0 +1,9 @@ +{ + "label": "Technical Documentation", + "link": { + "type": "generated-index", + "description": "Deep dive into Wails v3 internals for developers who want to understand or contribute to the codebase." + }, + "order": 50, + "collapsed": false +} diff --git a/docs/src/content/docs/contributing/architecture.mdx b/docs/src/content/docs/contributing/architecture.mdx new file mode 100644 index 000000000..ed4dab2d0 --- /dev/null +++ b/docs/src/content/docs/contributing/architecture.mdx @@ -0,0 +1,99 @@ +--- +title: Wails v3 Architecture +description: Deep-dive diagrams and explanations of every moving part inside Wails v3 +sidebar: + order: 1 +--- + + +Wails v3 is a **full-stack desktop framework** consisting of a Go runtime, +a JavaScript bridge, a task-driven tool-chain and a collection of templates that +let you ship native applications powered by modern web tech. + +This page presents the *big picture* in four diagrams: + +1. **Overall Architecture** – how every subsystem connects +2. **Runtime Flow** – what happens when JS calls Go and vice-versa +3. **Development vs Production** – two modes of the asset server +4. **Platform Implementations** – where OS-specific code lives + +--- + +## 1 · Overall Architecture + +**Wails v3 – High-Level Stack** + +{/* +TODO: Fix D2 diagram generation (triple quotes for multi-line strings) or embed as image. +The previous D2 code block was causing MDX parsing errors in the build pipeline. +*/} + +**[High-Level Stack Diagram Placeholder]** + +--- + +## 2 · Runtime Call Flow + +**Runtime – JavaScript ⇄ Go Calling Path** + +{/* +TODO: Fix D2 diagram generation (triple quotes for multi-line strings) or embed as image. +The previous D2 code block was causing MDX parsing errors in the build pipeline. +*/} + +**[Runtime Call Flow Diagram Placeholder]** + +Key points: + +* **No HTTP / IPC** – the bridge uses the native WebView’s in-memory channel +* **Method IDs** – deterministic FNV-hash enables O(1) lookup in Go +* **Promises** – errors propagate as rejections with stack & code + +--- + +## 3 · Development vs Production Asset Flow + +**Dev ↔ Prod Asset Server** + +{/* +TODO: Fix D2 diagram generation (triple quotes for multi-line strings) or embed as image. +The previous D2 code block was causing MDX parsing errors in the build pipeline. +*/} + +**[Asset Flow Diagram Placeholder]** + +* In **dev** the server proxies unknown paths to the framework’s live-reload + server and serves static assets from disk. +* In **prod** the same API is backed by `go:embed`, producing a zero-dependency + binary. + +--- + +## 4 · Platform-Specific Runtime Split + +**Per-OS Runtime Files** + +{/* +TODO: Fix D2 diagram generation (triple quotes for multi-line strings) or embed as image. +The previous D2 code block was causing MDX parsing errors in the build pipeline. +*/} + +**[Platform Split Diagram Placeholder]** + +Every feature follows this pattern: + +1. **Common interface** in `pkg/application` +2. **Message processor** entry in `pkg/application/messageprocessor_*.go` +3. **Implementation** per OS under `internal/runtime/*.go` guarded by build tags + +Missing functionality on an OS should return `ErrCapability` and register +availability via `internal/capabilities`. + +--- + +## Summary + +These diagrams outline **where the code lives**, **how data moves**, and +**which layers own which responsibilities**. +Keep them handy while exploring the detailed pages that follow – they are your +map to the Wails v3 source tree. diff --git a/docs/src/content/docs/contributing/architecture/bindings.mdx b/docs/src/content/docs/contributing/architecture/bindings.mdx new file mode 100644 index 000000000..9cfcfa2b6 --- /dev/null +++ b/docs/src/content/docs/contributing/architecture/bindings.mdx @@ -0,0 +1,156 @@ +--- +title: Binding System +description: How the binding system collects, processes, and generates JavaScript/TypeScript code +sidebar: + order: 1 +--- + +import { FileTree } from "@astrojs/starlight/components"; + +This guide explains how the Wails binding system works internally, providing insights for developers who want to understand the mechanics behind the automatic code generation. + +## Architecture Overview + +The Wails binding system consists of three main components: + +1. **Collection**: Analyzes Go code to extract information about services, models, and other declarations +2. **Configuration**: Manages settings and options for the binding generation process +3. **Rendering**: Generates JavaScript/TypeScript code based on the collected information + + +- internal/generator/ + - collect/ # Package analysis and information extraction + - config/ # Configuration structures and interfaces + - render/ # Code generation for JS/TS + + +## Collection Process + +The collection process is responsible for analyzing Go packages and extracting information about services, models, and other declarations. This is handled by the `collect` package. + +### Key Components + +- **Collector**: Manages package information and caches collected data +- **Package**: Represents a Go package being analyzed and stores collected services, models, and directives +- **Service**: Collects information about service types and their methods +- **Model**: Collects detailed information about model types, including fields, values, and type parameters +- **Directive**: Parses and interprets `//wails:` directives in Go source code + +### Collection Flow + +1. The collector scans the Go packages specified in the project +2. It identifies service types (structs with methods that will be exposed to the frontend) +3. For each service, it collects information about its methods +4. It identifies model types (structs used as parameters or return values in service methods) +5. For each model, it collects information about its fields and type parameters +6. It processes any `//wails:` directives found in the code + +## Rendering Process + +The rendering process is responsible for generating JavaScript/TypeScript code based on the collected information. This is handled by the `render` package. + +### Key Components + +- **Renderer**: Orchestrates the rendering of service, model, and index files +- **Module**: Represents a single generated JavaScript/TypeScript module +- **Templates**: Text templates used for code generation + +### Rendering Flow + +1. For each service, the renderer generates a JavaScript/TypeScript file with functions that mirror the service methods +2. For each model, the renderer generates a JavaScript/TypeScript class that mirrors the model struct +3. The renderer generates index files that re-export all services and models +4. The renderer applies any custom code injections specified by `//wails:inject` directives + +## Type Mapping + +One of the most important aspects of the binding system is how Go types are mapped to JavaScript/TypeScript types. Here's a summary of the mapping: + +| Go Type | JavaScript Type | TypeScript Type | +|---------|----------------|----------------| +| `bool` | `boolean` | `boolean` | +| `int`, `int8`, `int16`, `int32`, `int64`, `uint`, `uint8`, `uint16`, `uint32`, `uint64`, `float32`, `float64` | `number` | `number` | +| `string` | `string` | `string` | +| `[]byte` | `Uint8Array` | `Uint8Array` | +| `[]T` | `Array` | `T[]` | +| `map[K]V` | `Object` | `Record` | +| `struct` | `Object` | Custom class | +| `interface{}` | `any` | `any` | +| `*T` | `T \| null` | `T \| null` | +| `func` | Not supported | Not supported | +| `chan` | Not supported | Not supported | + +## Directives System + +The binding system supports several directives that can be used to customize the generated code. These directives are added as comments in your Go code. + +### Available Directives + +- `//wails:inject`: Injects custom JavaScript/TypeScript code into the generated bindings +- `//wails:include`: Includes additional files with the generated bindings +- `//wails:internal`: Marks a type or method as internal, preventing it from being exported to the frontend +- `//wails:ignore`: Completely ignores a method during binding generation +- `//wails:id`: Specifies a custom ID for a method, overriding the default hash-based ID + +### Directive Processing + +1. During the collection phase, the collector identifies and parses directives in the Go code +2. The directives are stored with the corresponding declarations (services, methods, models, etc.) +3. During the rendering phase, the renderer applies the directives to customize the generated code + +## Advanced Features + +### Conditional Code Generation + +The binding system supports conditional code generation using a two-character condition prefix for `include` and `inject` directives: + +``` + + + +
+

Application Report

+

Generated: {{.Timestamp}}

+
+
+ + {{range .Items}} +

{{.}}

+ {{end}} +
+ +` + + // Write report to file + file, err := os.Create(reportPath) + if err != nil { + return err + } + defer file.Close() + + t, err := template.New("report").Parse(tmpl) + if err != nil { + return err + } + + err = t.Execute(file, data) + if err != nil { + return err + } + + // Open in browser + return app.Browser.OpenFile(reportPath) +} +``` + +### Development Tools + +Open development resources during development: + +```go +func setupDevelopmentMenu(app *application.App) { + if !app.Env.Info().Debug { + return // Only show in debug mode + } + + menu := app.Menu.New() + devMenu := menu.AddSubmenu("Development") + + devMenu.Add("Open DevTools").OnClick(func(ctx *application.Context) { + // This would open browser devtools if available + window := app.Window.Current() + if window != nil { + window.OpenDevTools() + } + }) + + devMenu.Add("View Source").OnClick(func(ctx *application.Context) { + // Open source code repository + app.Browser.OpenURL("https://github.com/youruser/yourapp") + }) + + devMenu.Add("API Documentation").OnClick(func(ctx *application.Context) { + // Open local API docs + app.Browser.OpenURL("http://localhost:8080/docs") + }) +} +``` + +## Error Handling + +### Graceful Error Handling + +Always handle potential errors when opening URLs or files: + +```go +func openURLWithFallback(app *application.App, url string, fallbackMessage string) { + err := app.Browser.OpenURL(url) + if err != nil { + app.Logger.Error("Failed to open URL", "url", url, "error", err) + + // Show fallback dialog with URL + dialog := app.Dialog.Info() + dialog.SetTitle("Unable to Open Link") + dialog.SetMessage(fmt.Sprintf("%s\n\nURL: %s", fallbackMessage, url)) + dialog.Show() + } +} + +// Usage +openURLWithFallback(app, + "https://docs.example.com", + "Please open the following URL manually in your browser:") +``` + +### User Feedback + +Provide feedback when operations succeed or fail: + +```go +func openURLWithFeedback(app *application.App, url string) { + err := app.Browser.OpenURL(url) + if err != nil { + // Show error dialog + app.Dialog.Error(). + SetTitle("Browser Error"). + SetMessage(fmt.Sprintf("Could not open URL: %s", err.Error())). + Show() + } else { + // Optionally show success notification + app.Logger.Info("URL opened successfully", "url", url) + } +} +``` + +## Platform Considerations + + + + + On macOS: + + - Uses the `open` command to launch the default browser + - Respects user's default browser setting in System Preferences + - May prompt for permission if the application is sandboxed + - Handles `file://` URLs correctly for local files + + + + + + On Windows: + + - Uses Windows Shell API to open URLs + - Respects default browser setting in Windows Settings + - Handles Windows path formats correctly + - May show security warnings for untrusted URLs + + + + + + On Linux: + + - Attempts to use `xdg-open` first, falls back to other methods + - Behavior varies by desktop environment + - Respects `BROWSER` environment variable if set + - May require additional packages in minimal installations + + + + +## Best Practices + +1. **Always Handle Errors**: Browser operations can fail for various reasons: + ```go + if err := app.Browser.OpenURL(url); err != nil { + app.Logger.Error("Failed to open browser", "error", err) + // Provide fallback or user notification + } + ``` + +2. **Validate URLs**: Ensure URLs are well-formed before opening: + ```go + func isValidHTTPURL(str string) bool { + u, err := url.Parse(str) + return err == nil && (u.Scheme == "http" || u.Scheme == "https") + } + ``` + +3. **User Confirmation**: For external links, consider asking user permission: + ```go + // Show confirmation dialog before opening external links + confirmAndOpen(app, "https://external-site.com") + ``` + +4. **Secure File Paths**: When opening files, ensure paths are safe: + ```go + func openSafeFile(app *application.App, filename string) error { + // Ensure file exists and is readable + if _, err := os.Stat(filename); err != nil { + return err + } + return app.Browser.OpenFile(filename) + } + ``` + +## Complete Example + +Here's a complete example showing various browser integration patterns: + +```go +package main + +import ( + "fmt" + "os" + "path/filepath" + "github.com/wailsapp/wails/v3/pkg/application" +) + +func main() { + app := application.New(application.Options{ + Name: "Browser Integration Demo", + }) + + // Setup menu with browser actions + setupMenu(app) + + // Create main window + window := app.Window.New() + window.SetTitle("Browser Integration") + + err := app.Run() + if err != nil { + panic(err) + } +} + +func setupMenu(app *application.App) { + menu := app.Menu.New() + + // File menu + fileMenu := menu.AddSubmenu("File") + fileMenu.Add("Generate Report").OnClick(func(ctx *application.Context) { + generateHTMLReport(app) + }) + + // Help menu + helpMenu := menu.AddSubmenu("Help") + helpMenu.Add("Documentation").OnClick(func(ctx *application.Context) { + openWithConfirmation(app, "https://docs.example.com") + }) + helpMenu.Add("Support").OnClick(func(ctx *application.Context) { + openWithConfirmation(app, "https://support.example.com") + }) + + app.Menu.Set(menu) +} + +func openWithConfirmation(app *application.App, url string) { + dialog := app.Dialog.Question() + dialog.SetTitle("Open External Link") + dialog.SetMessage(fmt.Sprintf("Open %s in your browser?", url)) + + dialog.AddButton("Open").OnClick(func() { + if err := app.Browser.OpenURL(url); err != nil { + showError(app, "Failed to open URL", err) + } + }) + + dialog.AddButton("Cancel") + dialog.Show() +} + +func generateHTMLReport(app *application.App) { + // Create temporary HTML file + tmpDir := os.TempDir() + reportPath := filepath.Join(tmpDir, "demo_report.html") + + html := ` + + + + Demo Report + + + +
+

Application Report

+

This is a sample report generated by the application.

+
+
+

Report Details

+

This report was generated to demonstrate browser integration.

+
+ +` + + err := os.WriteFile(reportPath, []byte(html), 0644) + if err != nil { + showError(app, "Failed to create report", err) + return + } + + // Open in browser + err = app.Browser.OpenFile(reportPath) + if err != nil { + showError(app, "Failed to open report", err) + } +} + +func showError(app *application.App, message string, err error) { + app.Dialog.Error(). + SetTitle("Error"). + SetMessage(fmt.Sprintf("%s: %v", message, err)). + Show() +} +``` + +:::tip[Pro Tip] +Consider providing fallback mechanisms for when browser operations fail, such as copying URLs to clipboard or showing them in a dialog for manual opening. +::: + +:::danger[Warning] +Always validate URLs and file paths before opening them to prevent security issues. Be cautious about opening user-provided URLs without validation. +::: \ No newline at end of file diff --git a/docs/src/content/docs/features/clipboard/basics.mdx b/docs/src/content/docs/features/clipboard/basics.mdx new file mode 100644 index 000000000..b75570aca --- /dev/null +++ b/docs/src/content/docs/features/clipboard/basics.mdx @@ -0,0 +1,493 @@ +--- +title: Clipboard Operations +description: Copy and paste text with the system clipboard +sidebar: + order: 1 +--- + +import { Card, CardGrid } from "@astrojs/starlight/components"; + +## Clipboard Operations + +Wails provides a **unified clipboard API** that works across all platforms. Copy and paste text with simple, consistent methods on Windows, macOS, and Linux. + +## Quick Start + +```go +// Copy text to clipboard +app.Clipboard.SetText("Hello, World!") + +// Get text from clipboard +text, ok := app.Clipboard.Text() +if ok { + fmt.Println("Clipboard:", text) +} +``` + +**That's it!** Cross-platform clipboard access. + +## Copying Text + +### Basic Copy + +```go +success := app.Clipboard.SetText("Text to copy") +if !success { + app.Logger.Error("Failed to copy to clipboard") +} +``` + +**Returns:** `bool` - `true` if successful, `false` otherwise + +### Copy from Service + +```go +type ClipboardService struct { + app *application.Application +} + +func (c *ClipboardService) CopyToClipboard(text string) bool { + return c.app.Clipboard.SetText(text) +} +``` + +**Call from JavaScript:** + +```javascript +import { CopyToClipboard } from './bindings/myapp/clipboardservice' + +await CopyToClipboard("Text to copy") +``` + +### Copy with Feedback + +```go +func copyWithFeedback(text string) { + if app.Clipboard.SetText(text) { + app.Dialog.Info(). + SetTitle("Copied"). + SetMessage("Text copied to clipboard!"). + Show() + } else { + app.Dialog.Error(). + SetTitle("Copy Failed"). + SetMessage("Failed to copy to clipboard."). + Show() + } +} +``` + +## Pasting Text + +### Basic Paste + +```go +text, ok := app.Clipboard.Text() +if !ok { + app.Logger.Error("Failed to read clipboard") + return +} + +fmt.Println("Clipboard text:", text) +``` + +**Returns:** `(string, bool)` - Text and success flag + +### Paste from Service + +```go +func (c *ClipboardService) PasteFromClipboard() string { + text, ok := c.app.Clipboard.Text() + if !ok { + return "" + } + return text +} +``` + +**Call from JavaScript:** + +```javascript +import { PasteFromClipboard } from './bindings/myapp/clipboardservice' + +const text = await PasteFromClipboard() +console.log("Pasted:", text) +``` + +### Paste with Validation + +```go +func pasteText() (string, error) { + text, ok := app.Clipboard.Text() + if !ok { + return "", errors.New("clipboard empty or unavailable") + } + + // Validate + if len(text) == 0 { + return "", errors.New("clipboard is empty") + } + + if len(text) > 10000 { + return "", errors.New("clipboard text too large") + } + + return text, nil +} +``` + +## Complete Examples + +### Copy Button + +**Go:** + +```go +type TextService struct { + app *application.Application +} + +func (t *TextService) CopyText(text string) error { + if !t.app.Clipboard.SetText(text) { + return errors.New("failed to copy") + } + return nil +} +``` + +**JavaScript:** + +```javascript +import { CopyText } from './bindings/myapp/textservice' + +async function copyToClipboard(text) { + try { + await CopyText(text) + showNotification("Copied to clipboard!") + } catch (error) { + showError("Failed to copy: " + error) + } +} + +// Usage +document.getElementById('copy-btn').addEventListener('click', () => { + const text = document.getElementById('text').value + copyToClipboard(text) +}) +``` + +### Paste and Process + +**Go:** + +```go +type DataService struct { + app *application.Application +} + +func (d *DataService) PasteAndProcess() (string, error) { + // Get clipboard text + text, ok := d.app.Clipboard.Text() + if !ok { + return "", errors.New("clipboard unavailable") + } + + // Process text + processed := strings.TrimSpace(text) + processed = strings.ToUpper(processed) + + return processed, nil +} +``` + +**JavaScript:** + +```javascript +import { PasteAndProcess } from './bindings/myapp/dataservice' + +async function pasteAndProcess() { + try { + const result = await PasteAndProcess() + document.getElementById('output').value = result + } catch (error) { + showError("Failed to paste: " + error) + } +} +``` + +### Copy Multiple Formats + +```go +type CopyService struct { + app *application.Application +} + +func (c *CopyService) CopyAsPlainText(text string) bool { + return c.app.Clipboard.SetText(text) +} + +func (c *CopyService) CopyAsJSON(data interface{}) bool { + jsonBytes, err := json.MarshalIndent(data, "", " ") + if err != nil { + return false + } + return c.app.Clipboard.SetText(string(jsonBytes)) +} + +func (c *CopyService) CopyAsCSV(rows [][]string) bool { + var buf bytes.Buffer + writer := csv.NewWriter(&buf) + + for _, row := range rows { + if err := writer.Write(row); err != nil { + return false + } + } + + writer.Flush() + return c.app.Clipboard.SetText(buf.String()) +} +``` + +### Clipboard Monitor + +```go +type ClipboardMonitor struct { + app *application.Application + lastText string + ticker *time.Ticker + stopChan chan bool +} + +func NewClipboardMonitor(app *application.Application) *ClipboardMonitor { + return &ClipboardMonitor{ + app: app, + stopChan: make(chan bool), + } +} + +func (cm *ClipboardMonitor) Start() { + cm.ticker = time.NewTicker(1 * time.Second) + + go func() { + for { + select { + case <-cm.ticker.C: + cm.checkClipboard() + case <-cm.stopChan: + return + } + } + }() +} + +func (cm *ClipboardMonitor) Stop() { + if cm.ticker != nil { + cm.ticker.Stop() + } + cm.stopChan <- true +} + +func (cm *ClipboardMonitor) checkClipboard() { + text, ok := cm.app.Clipboard.Text() + if !ok { + return + } + + if text != cm.lastText { + cm.lastText = text + cm.app.Event.Emit("clipboard-changed", text) + } +} +``` + +### Copy with History + +```go +type ClipboardHistory struct { + app *application.Application + history []string + maxSize int +} + +func NewClipboardHistory(app *application.Application) *ClipboardHistory { + return &ClipboardHistory{ + app: app, + history: make([]string, 0), + maxSize: 10, + } +} + +func (ch *ClipboardHistory) Copy(text string) bool { + if !ch.app.Clipboard.SetText(text) { + return false + } + + // Add to history + ch.history = append([]string{text}, ch.history...) + + // Limit size + if len(ch.history) > ch.maxSize { + ch.history = ch.history[:ch.maxSize] + } + + return true +} + +func (ch *ClipboardHistory) GetHistory() []string { + return ch.history +} + +func (ch *ClipboardHistory) RestoreFromHistory(index int) bool { + if index < 0 || index >= len(ch.history) { + return false + } + + return ch.app.Clipboard.SetText(ch.history[index]) +} +``` + +## Frontend Integration + +### Using Browser Clipboard API + +For simple text, you can use the browser's clipboard API: + +```javascript +// Copy +async function copyText(text) { + try { + await navigator.clipboard.writeText(text) + console.log("Copied!") + } catch (error) { + console.error("Copy failed:", error) + } +} + +// Paste +async function pasteText() { + try { + const text = await navigator.clipboard.readText() + return text + } catch (error) { + console.error("Paste failed:", error) + return "" + } +} +``` + +**Note:** Browser clipboard API requires HTTPS or localhost, and user permission. + +### Using Wails Clipboard + +For system-wide clipboard access: + +```javascript +import { CopyToClipboard, PasteFromClipboard } from './bindings/myapp/clipboardservice' + +// Copy +async function copy(text) { + const success = await CopyToClipboard(text) + if (success) { + console.log("Copied!") + } +} + +// Paste +async function paste() { + const text = await PasteFromClipboard() + return text +} +``` + +## Best Practices + +### ✅ Do + +- **Check return values** - Handle failures gracefully +- **Provide feedback** - Let users know copy succeeded +- **Validate pasted text** - Check format and size +- **Use appropriate method** - Browser API vs Wails API +- **Handle empty clipboard** - Check before using +- **Trim whitespace** - Clean pasted text + +### ❌ Don't + +- **Don't ignore failures** - Always check success +- **Don't copy sensitive data** - Clipboard is shared +- **Don't assume format** - Validate pasted data +- **Don't poll too frequently** - If monitoring clipboard +- **Don't copy large data** - Use files instead +- **Don't forget security** - Sanitise pasted content + +## Platform Differences + +### macOS + +- Uses NSPasteboard +- Supports rich text (future) +- System-wide clipboard +- Clipboard history (system feature) + +### Windows + +- Uses Windows Clipboard API +- Supports multiple formats (future) +- System-wide clipboard +- Clipboard history (Windows 10+) + +### Linux + +- Uses X11/Wayland clipboard +- Primary and clipboard selections +- Varies by desktop environment +- May require clipboard manager + +## Limitations + +### Current Version + +- **Text only** - Images not yet supported +- **No format detection** - Plain text only +- **No clipboard events** - Must poll for changes +- **No clipboard history** - Implement yourself + +### Future Features + +- Image support +- Rich text support +- Multiple formats +- Clipboard change events +- Clipboard history API + +## Next Steps + + + + Call Go functions from JavaScript. + + [Learn More →](/features/bindings/methods) + + + + Use events for clipboard notifications. + + [Learn More →](/features/events/system) + + + + Show copy/paste feedback. + + [Learn More →](/features/dialogs/message) + + + + Organise clipboard code. + + [Learn More →](/features/bindings/services) + + + +--- + +**Questions?** Ask in [Discord](https://discord.gg/JDdSxwjhGf) or check the [clipboard examples](https://github.com/wailsapp/wails/tree/v3-alpha/v3/examples). diff --git a/docs/src/content/docs/features/dialogs/custom.mdx b/docs/src/content/docs/features/dialogs/custom.mdx new file mode 100644 index 000000000..591d68db2 --- /dev/null +++ b/docs/src/content/docs/features/dialogs/custom.mdx @@ -0,0 +1,626 @@ +--- +title: Custom dialogs +sidebar: + order: 4 +--- + +import { Card, CardGrid } from "@astrojs/starlight/components"; + +## Custom dialogs + +Create **custom dialog windows** using regular Wails windows with dialog-like behaviour. Build custom forms, complex input validation, branded appearance, and rich content (images, videos) whilst maintaining familiar dialog patterns. + +## Quick Start + +```go +// Create custom dialog window +dialog := app.Window.NewWithOptions(application.WebviewWindowOptions{ + Title: "Custom dialog", + Width: 400, + Height: 300, + AlwaysOnTop: true, + Frameless: true, + Hidden: true, +}) + +// Load custom UI +dialog.SetURL("http://wails.localhost/dialog.html") + +// Show as modal +dialog.Show() +dialog.SetFocus() +``` + +**That's it!** Custom UI with dialog behaviour. + +## Creating Custom dialogs + +### Basic Custom dialog + +```go +type Customdialog struct { + window *application.WebviewWindow + result chan string +} + +func NewCustomdialog(app *application.Application) *Customdialog { + dialog := &Customdialog{ + result: make(chan string, 1), + } + + dialog.window = app.Window.NewWithOptions(application.WebviewWindowOptions{ + Title: "Custom dialog", + Width: 400, + Height: 300, + AlwaysOnTop: true, + Resizable: false, + Hidden: true, + }) + + return dialog +} + +func (d *Customdialog) Show() string { + d.window.Show() + d.window.SetFocus() + + // Wait for result + return <-d.result +} + +func (d *Customdialog) Close(result string) { + d.result <- result + d.window.Close() +} +``` + +### Modal dialog + +```go +func ShowModaldialog(parent *application.WebviewWindow, title string) string { + // Create dialog + dialog := app.Window.NewWithOptions(application.WebviewWindowOptions{ + Title: title, + Width: 400, + Height: 200, + Parent: parent, + AlwaysOnTop: true, + Resizable: false, + }) + + // Disable parent + parent.SetEnabled(false) + + // Re-enable parent on close + dialog.OnClose(func() bool { + parent.SetEnabled(true) + parent.SetFocus() + return true + }) + + dialog.Show() + + return waitForResult(dialog) +} +``` + +### Form dialog + +```go +type Formdialog struct { + window *application.WebviewWindow + data map[string]interface{} + done chan bool +} + +func NewFormdialog(app *application.Application) *Formdialog { + fd := &Formdialog{ + data: make(map[string]interface{}), + done: make(chan bool, 1), + } + + fd.window = app.Window.NewWithOptions(application.WebviewWindowOptions{ + Title: "Enter Information", + Width: 500, + Height: 400, + Frameless: true, + Hidden: true, + }) + + return fd +} + +func (fd *Formdialog) Show() (map[string]interface{}, bool) { + fd.window.Show() + fd.window.SetFocus() + + ok := <-fd.done + return fd.data, ok +} + +func (fd *Formdialog) Submit(data map[string]interface{}) { + fd.data = data + fd.done <- true + fd.window.Close() +} + +func (fd *Formdialog) Cancel() { + fd.done <- false + fd.window.Close() +} +``` + +## dialog Patterns + +### Confirmation dialog + +```go +func ShowConfirmdialog(message string) bool { + dialog := app.Window.NewWithOptions(application.WebviewWindowOptions{ + Title: "Confirm", + Width: 400, + Height: 150, + AlwaysOnTop: true, + Frameless: true, + }) + + // Pass message to dialog + dialog.OnReady(func() { + dialog.EmitEvent("set-message", message) + }) + + result := make(chan bool, 1) + + // Handle responses + app.Event.On("confirm-yes", func(e *application.CustomEvent) { + result <- true + dialog.Close() + }) + + app.Event.On("confirm-no", func(e *application.CustomEvent) { + result <- false + dialog.Close() + }) + + dialog.Show() + return <-result +} +``` + +**Frontend (HTML/JS):** + +```html +
+

+
+ + +
+
+ + +``` + +### Input dialog + +```go +func ShowInputdialog(prompt string, defaultValue string) (string, bool) { + dialog := app.Window.NewWithOptions(application.WebviewWindowOptions{ + Title: "Input", + Width: 400, + Height: 150, + Frameless: true, + }) + + result := make(chan struct { + value string + ok bool + }, 1) + + dialog.OnReady(func() { + dialog.EmitEvent("set-prompt", map[string]string{ + "prompt": prompt, + "default": defaultValue, + }) + }) + + app.Event.On("input-submit", func(e *application.CustomEvent) { + result <- struct { + value string + ok bool + }{e.Data.(string), true} + dialog.Close() + }) + + app.Event.On("input-cancel", func(e *application.CustomEvent) { + result <- struct { + value string + ok bool + }{"", false} + dialog.Close() + }) + + dialog.Show() + r := <-result + return r.value, r.ok +} +``` + +### Progress dialog + +```go +type Progressdialog struct { + window *application.WebviewWindow +} + +func NewProgressdialog(title string) *Progressdialog { + pd := &Progressdialog{} + + pd.window = app.Window.NewWithOptions(application.WebviewWindowOptions{ + Title: title, + Width: 400, + Height: 150, + Frameless: true, + }) + + return pd +} + +func (pd *Progressdialog) Show() { + pd.window.Show() +} + +func (pd *Progressdialog) UpdateProgress(current, total int, message string) { + pd.window.EmitEvent("progress-update", map[string]interface{}{ + "current": current, + "total": total, + "message": message, + }) +} + +func (pd *Progressdialog) Close() { + pd.window.Close() +} +``` + +**Usage:** + +```go +func processFiles(files []string) { + progress := NewProgressdialog("Processing Files") + progress.Show() + + for i, file := range files { + progress.UpdateProgress(i+1, len(files), + fmt.Sprintf("Processing %s...", filepath.Base(file))) + + processFile(file) + } + + progress.Close() +} +``` + +## Complete Examples + +### Login dialog + +**Go:** + +```go +type Logindialog struct { + window *application.WebviewWindow + result chan struct { + username string + password string + ok bool + } +} + +func NewLogindialog(app *application.Application) *Logindialog { + ld := &Logindialog{ + result: make(chan struct { + username string + password string + ok bool + }, 1), + } + + ld.window = app.Window.NewWithOptions(application.WebviewWindowOptions{ + Title: "Login", + Width: 400, + Height: 250, + Frameless: true, + }) + + return ld +} + +func (ld *Logindialog) Show() (string, string, bool) { + ld.window.Show() + ld.window.SetFocus() + + r := <-ld.result + return r.username, r.password, r.ok +} + +func (ld *Logindialog) Submit(username, password string) { + ld.result <- struct { + username string + password string + ok bool + }{username, password, true} + ld.window.Close() +} + +func (ld *Logindialog) Cancel() { + ld.result <- struct { + username string + password string + ok bool + }{"", "", false} + ld.window.Close() +} +``` + +**Frontend:** + +```html + + + +``` + +### Settings dialog + +**Go:** + +```go +type Settingsdialog struct { + window *application.WebviewWindow + settings map[string]interface{} + done chan bool +} + +func NewSettingsdialog(app *application.Application, current map[string]interface{}) *Settingsdialog { + sd := &Settingsdialog{ + settings: current, + done: make(chan bool, 1), + } + + sd.window = app.Window.NewWithOptions(application.WebviewWindowOptions{ + Title: "Settings", + Width: 600, + Height: 500, + }) + + sd.window.OnReady(func() { + sd.window.EmitEvent("load-settings", current) + }) + + return sd +} + +func (sd *Settingsdialog) Show() (map[string]interface{}, bool) { + sd.window.Show() + + ok := <-sd.done + return sd.settings, ok +} + +func (sd *Settingsdialog) Save(settings map[string]interface{}) { + sd.settings = settings + sd.done <- true + sd.window.Close() +} + +func (sd *Settingsdialog) Cancel() { + sd.done <- false + sd.window.Close() +} +``` + +### Wizard dialog + +```go +type Wizarddialog struct { + window *application.WebviewWindow + currentStep int + data map[string]interface{} + done chan bool +} + +func NewWizarddialog(app *application.Application) *Wizarddialog { + wd := &Wizarddialog{ + currentStep: 0, + data: make(map[string]interface{}), + done: make(chan bool, 1), + } + + wd.window = app.Window.NewWithOptions(application.WebviewWindowOptions{ + Title: "Setup Wizard", + Width: 600, + Height: 400, + Resizable: false, + }) + + return wd +} + +func (wd *Wizarddialog) Show() (map[string]interface{}, bool) { + wd.window.Show() + + ok := <-wd.done + return wd.data, ok +} + +func (wd *Wizarddialog) NextStep(stepData map[string]interface{}) { + // Merge step data + for k, v := range stepData { + wd.data[k] = v + } + + wd.currentStep++ + wd.window.EmitEvent("next-step", wd.currentStep) +} + +func (wd *Wizarddialog) PreviousStep() { + if wd.currentStep > 0 { + wd.currentStep-- + wd.window.EmitEvent("previous-step", wd.currentStep) + } +} + +func (wd *Wizarddialog) Finish(finalData map[string]interface{}) { + for k, v := range finalData { + wd.data[k] = v + } + + wd.done <- true + wd.window.Close() +} + +func (wd *Wizarddialog) Cancel() { + wd.done <- false + wd.window.Close() +} +``` + +## Best Practices + +### ✅ Do + +- **Use appropriate window options** - AlwaysOnTop, Frameless, etc. +- **Handle cancellation** - Always provide a way to cancel +- **Validate input** - Check data before accepting +- **Provide feedback** - Loading states, errors +- **Use events for communication** - Clean separation +- **Clean up resources** - Close windows, remove listeners + +### ❌ Don't + +- **Don't block the main thread** - Use channels for results +- **Don't forget to close** - Memory leaks +- **Don't skip validation** - Always validate input +- **Don't ignore errors** - Handle all error cases +- **Don't make it too complex** - Keep dialogs simple +- **Don't forget accessibility** - Keyboard navigation + +## Styling Custom dialogs + +### Modern dialog Style + +```css +.dialog { + display: flex; + flex-direction: column; + height: 100vh; + background: white; + font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', sans-serif; +} + +.dialog-header { + --wails-draggable: drag; + padding: 16px; + background: #f5f5f5; + border-bottom: 1px solid #e0e0e0; +} + +.dialog-content { + flex: 1; + padding: 24px; + overflow: auto; +} + +.dialog-footer { + padding: 16px; + background: #f5f5f5; + border-top: 1px solid #e0e0e0; + display: flex; + justify-content: flex-end; + gap: 8px; +} + +button { + padding: 8px 16px; + border: none; + border-radius: 4px; + cursor: pointer; + font-size: 14px; +} + +button.primary { + background: #007aff; + color: white; +} + +button.secondary { + background: #e0e0e0; + color: #333; +} +``` + +## Next Steps + + + + Standard info, warning, error dialogs. + + [Learn More →](/features/dialogs/message) + + + + Open, save, folder selection. + + [Learn More →](/features/dialogs/file) + + + + Learn about window management. + + [Learn More →](/features/windows/basics) + + + + Use events for dialog communication. + + [Learn More →](/features/events/system) + + + +--- + +**Questions?** Ask in [Discord](https://discord.gg/JDdSxwjhGf) or check the [custom dialog examples](https://github.com/wailsapp/wails/tree/v3-alpha/v3/examples/dialogs). diff --git a/docs/src/content/docs/features/dialogs/file.mdx b/docs/src/content/docs/features/dialogs/file.mdx new file mode 100644 index 000000000..bba6e3f03 --- /dev/null +++ b/docs/src/content/docs/features/dialogs/file.mdx @@ -0,0 +1,568 @@ +--- +title: File dialogs +description: Open, save, and folder selection dialogs +sidebar: + order: 3 +--- + +import { Card, CardGrid } from "@astrojs/starlight/components"; + +## File dialogs + +Wails provides **native file dialogs** with platform-appropriate appearance for opening files, saving files, and selecting folders. Simple API with file type filtering, multiple selection support, and default locations. + +## Creating File Dialogs + +File dialogs are accessed through the `app.Dialog` manager: + +```go +app.Dialog.OpenFile() +app.Dialog.SaveFile() +``` + +## Open File dialog + +Select files to open: + +```go +path, err := app.Dialog.OpenFile(). + SetTitle("Select Image"). + AddFilter("Images", "*.png;*.jpg;*.gif"). + AddFilter("All Files", "*.*"). + PromptForSingleSelection() + +if err != nil || path == "" { + return +} + +openFile(path) +``` + +**Use cases:** +- Open documents +- Import files +- Load images +- Select configuration files + +### Single File Selection + +```go +path, err := app.Dialog.OpenFile(). + SetTitle("Open Document"). + AddFilter("Text Files", "*.txt"). + AddFilter("All Files", "*.*"). + PromptForSingleSelection() + +if err != nil || path == "" { + // User cancelled or error occurred + return +} + +// Use selected file +data, _ := os.ReadFile(path) +``` + +### Multiple File Selection + +```go +paths, err := app.Dialog.OpenFile(). + SetTitle("Select Images"). + AddFilter("Images", "*.png;*.jpg;*.jpeg;*.gif"). + PromptForMultipleSelection() + +if err != nil { + return +} + +// Process all selected files +for _, path := range paths { + processFile(path) +} +``` + +### With Default Directory + +```go +path, err := app.Dialog.OpenFile(). + SetTitle("Open File"). + SetDirectory("/Users/me/Documents"). + PromptForSingleSelection() +``` + +## Save File dialog + +Choose where to save: + +```go +path, err := app.Dialog.SaveFile(). + SetFilename("document.txt"). + AddFilter("Text Files", "*.txt"). + AddFilter("All Files", "*.*"). + PromptForSingleSelection() + +if err != nil || path == "" { + return +} + +saveFile(path, data) +``` + +**Use cases:** +- Save documents +- Export data +- Create new files +- Save as... + +### With Default Filename + +```go +path, err := app.Dialog.SaveFile(). + SetFilename("export.csv"). + AddFilter("CSV Files", "*.csv"). + PromptForSingleSelection() +``` + +### With Default Directory + +```go +path, err := app.Dialog.SaveFile(). + SetDirectory("/Users/me/Documents"). + SetFilename("untitled.txt"). + PromptForSingleSelection() +``` + +### Overwrite Confirmation + +```go +path, err := app.Dialog.SaveFile(). + SetFilename("document.txt"). + PromptForSingleSelection() + +if err != nil || path == "" { + return +} + +// Check if file exists +if _, err := os.Stat(path); err == nil { + dialog := app.Dialog.Question(). + SetTitle("Confirm Overwrite"). + SetMessage("File already exists. Overwrite?") + + overwriteBtn := dialog.AddButton("Overwrite") + overwriteBtn.OnClick(func() { + saveFile(path, data) + }) + + cancelBtn := dialog.AddButton("Cancel") + dialog.SetDefaultButton(cancelBtn) + dialog.SetCancelButton(cancelBtn) + dialog.Show() + return +} + +saveFile(path, data) +``` + +## Select Folder dialog + +Choose a directory using the open file dialog with directory selection enabled: + +```go +path, err := app.Dialog.OpenFile(). + SetTitle("Select Output Folder"). + CanChooseDirectories(true). + CanChooseFiles(false). + PromptForSingleSelection() + +if err != nil || path == "" { + return +} + +exportToFolder(path) +``` + +**Use cases:** +- Choose output directory +- Select workspace +- Pick backup location +- Choose installation directory + +### With Default Directory + +```go +path, err := app.Dialog.OpenFile(). + SetTitle("Select Folder"). + SetDirectory("/Users/me/Documents"). + CanChooseDirectories(true). + CanChooseFiles(false). + PromptForSingleSelection() +``` + +## File Filters + +Use the `AddFilter()` method to add file type filters to dialogs. Each call adds a new filter option. + +### Basic Filters + +```go +path, _ := app.Dialog.OpenFile(). + AddFilter("Text Files", "*.txt"). + AddFilter("All Files", "*.*"). + PromptForSingleSelection() +``` + +### Multiple Extensions + +Use semicolons to specify multiple extensions in a single filter: + +```go +dialog := app.Dialog.OpenFile(). + AddFilter("Images", "*.png;*.jpg;*.jpeg;*.gif;*.bmp"). + AddFilter("Documents", "*.txt;*.doc;*.docx;*.pdf"). + AddFilter("All Files", "*.*") +``` + +### Pattern Format + +Use **semicolons** to separate multiple extensions in a single filter: + +```go +// Multiple extensions separated by semicolons +AddFilter("Images", "*.png;*.jpg;*.gif") +``` + +## Complete Examples + +### Open Image File + +```go +func openImage(app *application.App) (image.Image, error) { + path, err := app.Dialog.OpenFile(). + SetTitle("Select Image"). + AddFilter("Images", "*.png;*.jpg;*.jpeg;*.gif;*.bmp"). + PromptForSingleSelection() + + if err != nil { + return nil, err + } + + if path == "" { + return nil, errors.New("no file selected") + } + + // Open and decode image + file, err := os.Open(path) + if err != nil { + app.Dialog.Error(). + SetTitle("Open Failed"). + SetMessage(err.Error()). + Show() + return nil, err + } + defer file.Close() + + img, _, err := image.Decode(file) + if err != nil { + app.Dialog.Error(). + SetTitle("Invalid Image"). + SetMessage("Could not decode image file."). + Show() + return nil, err + } + + return img, nil +} +``` + +### Save Document with Validation + +```go +func saveDocument(app *application.App, content string) { + path, err := app.Dialog.SaveFile(). + SetFilename("document.txt"). + AddFilter("Text Files", "*.txt"). + AddFilter("Markdown Files", "*.md"). + AddFilter("All Files", "*.*"). + PromptForSingleSelection() + + if err != nil || path == "" { + return + } + + // Validate extension + ext := filepath.Ext(path) + if ext != ".txt" && ext != ".md" { + dialog := app.Dialog.Question(). + SetTitle("Confirm Extension"). + SetMessage(fmt.Sprintf("Save as %s file?", ext)) + + saveBtn := dialog.AddButton("Save") + saveBtn.OnClick(func() { + doSave(app, path, content) + }) + + cancelBtn := dialog.AddButton("Cancel") + dialog.SetDefaultButton(cancelBtn) + dialog.SetCancelButton(cancelBtn) + dialog.Show() + return + } + + doSave(app, path, content) +} + +func doSave(app *application.App, path, content string) { + if err := os.WriteFile(path, []byte(content), 0644); err != nil { + app.Dialog.Error(). + SetTitle("Save Failed"). + SetMessage(err.Error()). + Show() + return + } + + app.Dialog.Info(). + SetTitle("Saved"). + SetMessage("Document saved successfully!"). + Show() +} +``` + +### Batch File Processing + +```go +func processMultipleFiles(app *application.App) { + paths, err := app.Dialog.OpenFile(). + SetTitle("Select Files to Process"). + AddFilter("Images", "*.png;*.jpg"). + PromptForMultipleSelection() + + if err != nil || len(paths) == 0 { + return + } + + // Confirm processing + dialog := app.Dialog.Question(). + SetTitle("Confirm Processing"). + SetMessage(fmt.Sprintf("Process %d file(s)?", len(paths))) + + processBtn := dialog.AddButton("Process") + processBtn.OnClick(func() { + // Process files + var errs []error + for i, path := range paths { + if err := processFile(path); err != nil { + errs = append(errs, err) + } + + // Update progress + // app.Event.Emit("progress", map[string]interface{}{ + // "current": i + 1, + // "total": len(paths), + // }) + _ = i // suppress unused variable warning in example + } + + // Show results + if len(errs) > 0 { + app.Dialog.Warning(). + SetTitle("Processing Complete"). + SetMessage(fmt.Sprintf("Processed %d files with %d errors.", + len(paths), len(errs))). + Show() + } else { + app.Dialog.Info(). + SetTitle("Success"). + SetMessage(fmt.Sprintf("Processed %d files successfully!", len(paths))). + Show() + } + }) + + cancelBtn := dialog.AddButton("Cancel") + dialog.SetCancelButton(cancelBtn) + dialog.Show() +} +``` + +### Export with Folder Selection + +```go +func exportData(app *application.App, data []byte) { + // Select output folder + folder, err := app.Dialog.OpenFile(). + SetTitle("Select Export Folder"). + SetDirectory(getDefaultExportFolder()). + CanChooseDirectories(true). + CanChooseFiles(false). + PromptForSingleSelection() + + if err != nil || folder == "" { + return + } + + // Generate filename + filename := fmt.Sprintf("export_%s.csv", + time.Now().Format("2006-01-02_15-04-05")) + path := filepath.Join(folder, filename) + + // Save file + if err := os.WriteFile(path, data, 0644); err != nil { + app.Dialog.Error(). + SetTitle("Export Failed"). + SetMessage(err.Error()). + Show() + return + } + + // Show success with option to open folder + dialog := app.Dialog.Question(). + SetTitle("Export Complete"). + SetMessage(fmt.Sprintf("Exported to %s", filename)) + + openBtn := dialog.AddButton("Open Folder") + openBtn.OnClick(func() { + openFolder(folder) + }) + + dialog.AddButton("OK") + dialog.Show() +} +``` + +### Import with Validation + +```go +func importConfiguration(app *application.App) { + path, err := app.Dialog.OpenFile(). + SetTitle("Import Configuration"). + AddFilter("JSON Files", "*.json"). + AddFilter("YAML Files", "*.yaml;*.yml"). + PromptForSingleSelection() + + if err != nil || path == "" { + return + } + + // Read file + data, err := os.ReadFile(path) + if err != nil { + app.Dialog.Error(). + SetTitle("Read Failed"). + SetMessage(err.Error()). + Show() + return + } + + // Validate configuration + config, err := parseConfig(data) + if err != nil { + app.Dialog.Error(). + SetTitle("Invalid Configuration"). + SetMessage("File is not a valid configuration."). + Show() + return + } + + // Confirm import + dialog := app.Dialog.Question(). + SetTitle("Confirm Import"). + SetMessage("Import this configuration?") + + importBtn := dialog.AddButton("Import") + importBtn.OnClick(func() { + // Apply configuration + if err := applyConfig(config); err != nil { + app.Dialog.Error(). + SetTitle("Import Failed"). + SetMessage(err.Error()). + Show() + return + } + + app.Dialog.Info(). + SetTitle("Success"). + SetMessage("Configuration imported successfully!"). + Show() + }) + + cancelBtn := dialog.AddButton("Cancel") + dialog.SetCancelButton(cancelBtn) + dialog.Show() +} +``` + +## Best Practices + +### ✅ Do + +- **Provide file filters** - Help users find files +- **Set appropriate titles** - Clear context +- **Use default directories** - Start in logical location +- **Validate selections** - Check file types +- **Handle cancellation** - User might cancel +- **Show confirmation** - For destructive actions +- **Provide feedback** - Success/error messages + +### ❌ Don't + +- **Don't skip validation** - Check file types +- **Don't ignore errors** - Handle cancellation +- **Don't use generic filters** - Be specific +- **Don't forget "All Files"** - Always include as option +- **Don't hardcode paths** - Use user's home directory +- **Don't assume file exists** - Check before opening + +## Platform Differences + +### macOS + +- Native NSOpenPanel/NSSavePanel +- Sheet-style when attached to window +- Follows system theme +- Supports Quick Look preview +- Tags and favourites integration + +### Windows + +- Native File Open/Save dialogs +- Follows system theme +- Recent files integration +- Network location support + +### Linux + +- GTK file chooser +- Varies by desktop environment +- Follows desktop theme +- Recent files support + +## Next Steps + + + + Info, warning, and error dialogs. + + [Learn More →](/features/dialogs/message) + + + + Create custom dialog windows. + + [Learn More →](/features/dialogs/custom) + + + + Call Go functions from JavaScript. + + [Learn More →](/features/bindings/methods) + + + + Use events for progress updates. + + [Learn More →](/features/events/system) + + + +--- + +**Questions?** Ask in [Discord](https://discord.gg/JDdSxwjhGf) or check the [file dialog examples](https://github.com/wailsapp/wails/tree/v3-alpha/v3/examples/dialogs). diff --git a/docs/src/content/docs/features/dialogs/message.mdx b/docs/src/content/docs/features/dialogs/message.mdx new file mode 100644 index 000000000..4b718aaa6 --- /dev/null +++ b/docs/src/content/docs/features/dialogs/message.mdx @@ -0,0 +1,516 @@ +--- +title: Message dialogs +description: Display information, warnings, errors, and questions +sidebar: + order: 2 +--- + +import { Card, CardGrid } from "@astrojs/starlight/components"; + +## Message dialogs + +Wails provides **native message dialogs** with platform-appropriate appearance: info, warning, error, and question dialogs with customisable titles, messages, and buttons. Simple API, native behaviour, accessible by default. + +## Creating Dialogs + +Message dialogs are accessed through the `app.Dialog` manager: + +```go +app.Dialog.Info() +app.Dialog.Question() +app.Dialog.Warning() +app.Dialog.Error() +``` + +All methods return a `*MessageDialog` that can be configured using method chaining. + +## Information dialog + +Display informational messages: + +```go +app.Dialog.Info(). + SetTitle("Success"). + SetMessage("File saved successfully!"). + Show() +``` + +**Use cases:** +- Success confirmations +- Completion notices +- Informational messages +- Status updates + +**Example - Save confirmation:** + +```go +func saveFile(app *application.App, path string, data []byte) error { + if err := os.WriteFile(path, data, 0644); err != nil { + return err + } + + app.Dialog.Info(). + SetTitle("File Saved"). + SetMessage(fmt.Sprintf("Saved to %s", filepath.Base(path))). + Show() + + return nil +} +``` + +## Warning dialog + +Show warnings: + +```go +app.Dialog.Warning(). + SetTitle("Warning"). + SetMessage("This action cannot be undone."). + Show() +``` + +**Use cases:** +- Non-critical warnings +- Deprecation notices +- Caution messages +- Potential issues + +**Example - Disk space warning:** + +```go +func checkDiskSpace(app *application.App) { + available := getDiskSpace() + + if available < 100*1024*1024 { // Less than 100MB + app.Dialog.Warning(). + SetTitle("Low Disk Space"). + SetMessage(fmt.Sprintf("Only %d MB available.", available/(1024*1024))). + Show() + } +} +``` + +## Error dialog + +Display errors: + +```go +app.Dialog.Error(). + SetTitle("Error"). + SetMessage("Failed to connect to server."). + Show() +``` + +**Use cases:** +- Error messages +- Failure notifications +- Exception handling +- Critical issues + +**Example - Network error:** + +```go +func fetchData(app *application.App, url string) ([]byte, error) { + resp, err := http.Get(url) + if err != nil { + app.Dialog.Error(). + SetTitle("Network Error"). + SetMessage(fmt.Sprintf("Failed to connect: %v", err)). + Show() + return nil, err + } + defer resp.Body.Close() + + return io.ReadAll(resp.Body) +} +``` + +## Question dialog + +Ask users questions and handle responses via button callbacks: + +```go +dialog := app.Dialog.Question(). + SetTitle("Confirm"). + SetMessage("Save changes before closing?") + +save := dialog.AddButton("Save") +save.OnClick(func() { + saveChanges() +}) + +dontSave := dialog.AddButton("Don't Save") +dontSave.OnClick(func() { + // Continue without saving +}) + +cancel := dialog.AddButton("Cancel") +cancel.OnClick(func() { + // Don't close +}) + +dialog.SetDefaultButton(save) +dialog.SetCancelButton(cancel) +dialog.Show() +``` + +**Use cases:** +- Confirm actions +- Yes/No questions +- Multiple choice +- User decisions + +**Example - Unsaved changes:** + +```go +func closeDocument(app *application.App) { + if !hasUnsavedChanges() { + doClose() + return + } + + dialog := app.Dialog.Question(). + SetTitle("Unsaved Changes"). + SetMessage("Do you want to save your changes?") + + save := dialog.AddButton("Save") + save.OnClick(func() { + if saveDocument() { + doClose() + } + }) + + dontSave := dialog.AddButton("Don't Save") + dontSave.OnClick(func() { + doClose() + }) + + cancel := dialog.AddButton("Cancel") + // Cancel button has no callback - just closes the dialog + + dialog.SetDefaultButton(save) + dialog.SetCancelButton(cancel) + dialog.Show() +} +``` + +## dialog Options + +### Title and Message + +```go +dialog := app.Dialog.Info(). + SetTitle("Operation Complete"). + SetMessage("All files have been processed successfully.") +``` + +**Best practices:** +- **Title:** Short, descriptive (2-5 words) +- **Message:** Clear, specific, actionable +- **Avoid jargon:** Use plain language + +### Buttons + +**Single button (Info/Warning/Error):** + +Info, warning, and error dialogs display a default "OK" button: + +```go +app.Dialog.Info(). + SetMessage("Done!"). + Show() +``` + +You can also add custom buttons: + +```go +dialog := app.Dialog.Info(). + SetMessage("Done!") +ok := dialog.AddButton("Got it!") +dialog.SetDefaultButton(ok) +dialog.Show() +``` + +**Multiple buttons (Question):** + +Use `AddButton()` to add buttons, which returns a `*Button` you can configure: + +```go +dialog := app.Dialog.Question(). + SetMessage("Choose an action") + +option1 := dialog.AddButton("Option 1") +option1.OnClick(func() { + handleOption1() +}) + +option2 := dialog.AddButton("Option 2") +option2.OnClick(func() { + handleOption2() +}) + +option3 := dialog.AddButton("Option 3") +option3.OnClick(func() { + handleOption3() +}) + +dialog.Show() +``` + +**Default and Cancel buttons:** + +Use `SetDefaultButton()` to specify which button is highlighted and triggered by Enter. +Use `SetCancelButton()` to specify which button is triggered by Escape. + +```go +dialog := app.Dialog.Question(). + SetMessage("Delete file?") + +deleteBtn := dialog.AddButton("Delete") +deleteBtn.OnClick(func() { + performDelete() +}) + +cancelBtn := dialog.AddButton("Cancel") +// No callback needed - just dismisses dialog + +dialog.SetDefaultButton(cancelBtn) // Safe option as default +dialog.SetCancelButton(cancelBtn) // Escape triggers Cancel +dialog.Show() +``` + +You can also use the fluent `SetAsDefault()` and `SetAsCancel()` methods on buttons: + +```go +dialog := app.Dialog.Question(). + SetMessage("Delete file?") + +dialog.AddButton("Delete").OnClick(func() { + performDelete() +}) + +dialog.AddButton("Cancel").SetAsDefault().SetAsCancel() + +dialog.Show() +``` + +**Best practices:** +- **1-3 buttons:** Don't overwhelm users +- **Clear labels:** "Save" not "OK" +- **Safe default:** Non-destructive action +- **Order matters:** Most likely action first (except Cancel) + +### Custom Icon + +Set a custom icon for the dialog: + +```go +app.Dialog.Info(). + SetTitle("Custom Icon Example"). + SetMessage("Using a custom icon"). + SetIcon(myIconBytes). + Show() +``` + +### Window Attachment + +Attach to specific window: + +```go +dialog := app.Dialog.Question(). + SetMessage("Window-specific question"). + AttachToWindow(window) + +dialog.AddButton("OK") +dialog.Show() +``` + +**Benefits:** +- dialog appears on correct window +- Parent window disabled whilst shown +- Better multi-window UX + +## Complete Examples + +### Confirm Destructive Action + +```go +func deleteFiles(app *application.App, paths []string) { + // Confirm deletion + message := fmt.Sprintf("Delete %d file(s)?", len(paths)) + if len(paths) == 1 { + message = fmt.Sprintf("Delete %s?", filepath.Base(paths[0])) + } + + dialog := app.Dialog.Question(). + SetTitle("Confirm Delete"). + SetMessage(message) + + deleteBtn := dialog.AddButton("Delete") + deleteBtn.OnClick(func() { + // Perform deletion + var errs []error + for _, path := range paths { + if err := os.Remove(path); err != nil { + errs = append(errs, err) + } + } + + // Show result + if len(errs) > 0 { + app.Dialog.Error(). + SetTitle("Delete Failed"). + SetMessage(fmt.Sprintf("Failed to delete %d file(s)", len(errs))). + Show() + } else { + app.Dialog.Info(). + SetTitle("Delete Complete"). + SetMessage(fmt.Sprintf("Deleted %d file(s)", len(paths))). + Show() + } + }) + + cancelBtn := dialog.AddButton("Cancel") + dialog.SetDefaultButton(cancelBtn) + dialog.SetCancelButton(cancelBtn) + dialog.Show() +} +``` + +### Quit Confirmation + +```go +func confirmQuit(app *application.App) { + dialog := app.Dialog.Question(). + SetTitle("Quit"). + SetMessage("You have unsaved work. Are you sure you want to quit?") + + yes := dialog.AddButton("Yes") + yes.OnClick(func() { + app.Quit() + }) + + no := dialog.AddButton("No") + dialog.SetDefaultButton(no) + dialog.Show() +} +``` + +### Update Dialog with Download Option + +```go +func showUpdateDialog(app *application.App) { + dialog := app.Dialog.Question(). + SetTitle("Update"). + SetMessage("A new version is available. The cancel button is selected when pressing escape.") + + download := dialog.AddButton("📥 Download") + download.OnClick(func() { + app.Dialog.Info().SetMessage("Downloading...").Show() + }) + + cancel := dialog.AddButton("Cancel") + + dialog.SetDefaultButton(download) + dialog.SetCancelButton(cancel) + dialog.Show() +} +``` + +### Custom Icon Question + +```go +func showCustomIconQuestion(app *application.App, iconBytes []byte) { + dialog := app.Dialog.Question(). + SetTitle("Custom Icon Example"). + SetMessage("Using a custom icon"). + SetIcon(iconBytes) + + likeIt := dialog.AddButton("I like it!") + likeIt.OnClick(func() { + app.Dialog.Info().SetMessage("Thanks!").Show() + }) + + notKeen := dialog.AddButton("Not so keen...") + notKeen.OnClick(func() { + app.Dialog.Info().SetMessage("Too bad!").Show() + }) + + dialog.SetDefaultButton(likeIt) + dialog.Show() +} + +## Best Practices + +### ✅ Do + +- **Be specific** - "File saved to Documents" not "Success" +- **Use appropriate type** - Error for errors, Warning for warnings +- **Provide context** - Include relevant details +- **Use clear button labels** - "Delete" not "OK" +- **Set safe defaults** - Non-destructive action +- **Handle cancellation** - User might close dialog + +### ❌ Don't + +- **Don't overuse** - Interrupts workflow +- **Don't use for frequent updates** - Use notifications instead +- **Don't use generic messages** - "Error" tells nothing +- **Don't ignore errors** - Handle dialog.Show() errors +- **Don't block unnecessarily** - Consider async alternatives +- **Don't use technical jargon** - Plain language + +## Platform Differences + +### macOS + +- Sheet-style when attached to window +- Standard keyboard shortcuts (⌘. for Cancel) +- Follows system theme automatically +- Accessibility built-in + +### Windows + +- Modal dialogs +- TaskDialog appearance +- Esc for Cancel +- Follows system theme + +### Linux + +- GTK dialogs +- Varies by desktop environment +- Follows desktop theme +- Standard keyboard navigation + +## Next Steps + + + + Open, save, and folder selection. + + [Learn More →](/features/dialogs/file) + + + + Create custom dialog windows. + + [Learn More →](/features/dialogs/custom) + + + + Non-intrusive notifications. + + [Learn More →](/features/notifications) + + + + Use events for non-blocking communication. + + [Learn More →](/features/events/system) + + + +--- + +**Questions?** Ask in [Discord](https://discord.gg/JDdSxwjhGf) or check the [dialog examples](https://github.com/wailsapp/wails/tree/v3-alpha/v3/examples/dialogs). diff --git a/docs/src/content/docs/features/dialogs/overview.mdx b/docs/src/content/docs/features/dialogs/overview.mdx new file mode 100644 index 000000000..25dcaf901 --- /dev/null +++ b/docs/src/content/docs/features/dialogs/overview.mdx @@ -0,0 +1,518 @@ +--- +title: dialogs Overview +description: Display native system dialogs in your application +sidebar: + order: 1 +--- + +import { Tabs, TabItem, Card, CardGrid } from "@astrojs/starlight/components"; + +## Native dialogs + +Wails provides **native system dialogs** that work across all platforms: message dialogs (info, warning, error, question), file dialogs (open, save, folder), and custom dialog windows with platform-native appearance and behaviour. + +## Quick Start + +```go +// Information dialog +app.Dialog.Info(). + SetTitle("Success"). + SetMessage("File saved successfully!"). + Show() + +// Question dialog with button callbacks +dialog := app.Dialog.Question(). + SetTitle("Confirm"). + SetMessage("Delete this file?") + +deleteBtn := dialog.AddButton("Delete") +deleteBtn.OnClick(func() { + deleteFile() +}) + +cancelBtn := dialog.AddButton("Cancel") +dialog.SetDefaultButton(cancelBtn) +dialog.SetCancelButton(cancelBtn) +dialog.Show() + +// File open dialog +path, _ := app.Dialog.OpenFile(). + SetTitle("Select Image"). + AddFilter("Images", "*.png;*.jpg"). + PromptForSingleSelection() +``` + +**That's it!** Native dialogs with minimal code. + +## Accessing Dialogs + +Dialogs are accessed through the `app.Dialog` manager: + +```go +app.Dialog.Info() +app.Dialog.Question() +app.Dialog.Warning() +app.Dialog.Error() +app.Dialog.OpenFile() +app.Dialog.SaveFile() +``` + +## dialog Types + +### Information dialog + +Display simple messages: + +```go +app.Dialog.Info(). + SetTitle("Welcome"). + SetMessage("Welcome to our application!"). + Show() +``` + +**Use cases:** +- Success messages +- Informational notices +- Completion confirmations + +### Warning dialog + +Show warnings: + +```go +app.Dialog.Warning(). + SetTitle("Warning"). + SetMessage("This action cannot be undone."). + Show() +``` + +**Use cases:** +- Non-critical warnings +- Deprecation notices +- Caution messages + +### Error dialog + +Display errors: + +```go +app.Dialog.Error(). + SetTitle("Error"). + SetMessage("Failed to save file: " + err.Error()). + Show() +``` + +**Use cases:** +- Error messages +- Failure notifications +- Exception handling + +### Question dialog + +Ask users questions and handle responses via button callbacks: + +```go +dialog := app.Dialog.Question(). + SetTitle("Confirm Delete"). + SetMessage("Are you sure you want to delete this file?") + +deleteBtn := dialog.AddButton("Delete") +deleteBtn.OnClick(func() { + deleteFile() +}) + +cancelBtn := dialog.AddButton("Cancel") +dialog.SetDefaultButton(cancelBtn) +dialog.SetCancelButton(cancelBtn) +dialog.Show() +``` + +**Use cases:** +- Confirm actions +- Yes/No questions +- Multiple choice + +## File dialogs + +### Open File dialog + +Select files to open: + +```go +path, err := app.Dialog.OpenFile(). + SetTitle("Select Image"). + AddFilter("Images", "*.png;*.jpg;*.gif"). + AddFilter("All Files", "*.*"). + PromptForSingleSelection() + +if err == nil && path != "" { + openFile(path) +} +``` + +**Multiple selection:** + +```go +paths, err := app.Dialog.OpenFile(). + SetTitle("Select Images"). + AddFilter("Images", "*.png;*.jpg"). + PromptForMultipleSelection() + +if err == nil { + for _, path := range paths { + processFile(path) + } +} +``` + +### Save File dialog + +Choose where to save: + +```go +path, err := app.Dialog.SaveFile(). + SetFilename("document.txt"). + AddFilter("Text Files", "*.txt"). + AddFilter("All Files", "*.*"). + PromptForSingleSelection() + +if err == nil && path != "" { + saveFile(path) +} +``` + +### Select Folder dialog + +Choose a directory using the open file dialog with directory selection enabled: + +```go +path, err := app.Dialog.OpenFile(). + SetTitle("Select Output Folder"). + CanChooseDirectories(true). + CanChooseFiles(false). + PromptForSingleSelection() + +if err == nil && path != "" { + exportToFolder(path) +} +``` + +## dialog Options + +### Title and Message + +```go +dialog := app.Dialog.Info(). + SetTitle("Success"). + SetMessage("Operation completed successfully!") +``` + +### Buttons + +**Default button for simple dialogs:** + +Info, warning, and error dialogs display a default "OK" button: + +```go +app.Dialog.Info(). + SetMessage("Done!"). + Show() +``` + +**Custom buttons for question dialogs:** + +Use `AddButton()` to add buttons, which returns a `*Button` you can configure with callbacks: + +```go +dialog := app.Dialog.Question(). + SetMessage("Choose action") + +save := dialog.AddButton("Save") +save.OnClick(func() { + saveDocument() +}) + +dontSave := dialog.AddButton("Don't Save") +dontSave.OnClick(func() { + discardChanges() +}) + +cancel := dialog.AddButton("Cancel") +// No callback needed - just dismisses dialog + +dialog.SetDefaultButton(save) +dialog.SetCancelButton(cancel) +dialog.Show() +``` + +**Default and Cancel buttons:** + +Use `SetDefaultButton()` to specify which button is highlighted and triggered by Enter. +Use `SetCancelButton()` to specify which button is triggered by Escape. + +```go +dialog := app.Dialog.Question(). + SetMessage("Delete file?") + +deleteBtn := dialog.AddButton("Delete") +deleteBtn.OnClick(func() { + performDelete() +}) + +cancelBtn := dialog.AddButton("Cancel") +dialog.SetDefaultButton(cancelBtn) // Safe option highlighted by default +dialog.SetCancelButton(cancelBtn) // Escape triggers Cancel +dialog.Show() +``` + +### Window Attachment + +Attach dialog to specific window: + +```go +dialog := app.Dialog.Info(). + SetMessage("Window-specific message"). + AttachToWindow(window) + +dialog.Show() +``` + +**Behaviour:** +- dialog appears centred on parent window +- Parent window disabled whilst dialog shown +- dialog moves with parent window (macOS) + +## Platform Behaviour + + + + **macOS dialogs:** + + - Native NSAlert appearance + - Follow system theme (light/dark) + - Support keyboard navigation + - Standard shortcuts (⌘. for Cancel) + - Accessibility features built-in + - Sheet-style when attached to window + + **Example:** + ```go + // Appears as sheet on macOS + dialog := app.Dialog.Question(). + SetMessage("Save changes?"). + AttachToWindow(window) + dialog.AddButton("Yes") + dialog.AddButton("No") + dialog.Show() + ``` + + + + **Windows dialogs:** + + - Native TaskDialog appearance + - Follow system theme + - Support keyboard navigation + - Standard shortcuts (Esc for Cancel) + - Accessibility features built-in + - Modal to parent window + + **Example:** + ```go + // Modal dialog on Windows + app.Dialog.Error(). + SetTitle("Error"). + SetMessage("Operation failed"). + Show() + ``` + + + + **Linux dialogs:** + + - GTK dialog appearance + - Follow desktop theme + - Support keyboard navigation + - Desktop environment integration + - Varies by DE (GNOME, KDE, etc.) + + **Example:** + ```go + // GTK dialog on Linux + app.Dialog.Info(). + SetMessage("Update complete"). + Show() + ``` + + + +## Common Patterns + +### Confirm Before Destructive Action + +```go +func deleteFile(app *application.App, path string) { + dialog := app.Dialog.Question(). + SetTitle("Confirm Delete"). + SetMessage(fmt.Sprintf("Delete %s?", filepath.Base(path))) + + deleteBtn := dialog.AddButton("Delete") + deleteBtn.OnClick(func() { + if err := os.Remove(path); err != nil { + app.Dialog.Error(). + SetTitle("Delete Failed"). + SetMessage(err.Error()). + Show() + } + }) + + cancelBtn := dialog.AddButton("Cancel") + dialog.SetDefaultButton(cancelBtn) + dialog.SetCancelButton(cancelBtn) + dialog.Show() +} +``` + +### Error Handling with dialog + +```go +func saveDocument(app *application.App, path string, data []byte) { + if err := os.WriteFile(path, data, 0644); err != nil { + app.Dialog.Error(). + SetTitle("Save Failed"). + SetMessage(fmt.Sprintf("Could not save file: %v", err)). + Show() + return + } + + app.Dialog.Info(). + SetTitle("Success"). + SetMessage("File saved successfully!"). + Show() +} +``` + +### File Selection with Validation + +```go +func selectImageFile(app *application.App) (string, error) { + path, err := app.Dialog.OpenFile(). + SetTitle("Select Image"). + AddFilter("Images", "*.png;*.jpg;*.jpeg;*.gif"). + PromptForSingleSelection() + + if err != nil { + return "", err + } + + if path == "" { + return "", errors.New("no file selected") + } + + // Validate file + if !isValidImage(path) { + app.Dialog.Error(). + SetTitle("Invalid File"). + SetMessage("Selected file is not a valid image."). + Show() + return "", errors.New("invalid image") + } + + return path, nil +} +``` + +### Multi-Step dialog Flow + +```go +func exportData(app *application.App) { + // Step 1: Confirm export + dialog := app.Dialog.Question(). + SetTitle("Export Data"). + SetMessage("Export all data to CSV?") + + exportBtn := dialog.AddButton("Export") + exportBtn.OnClick(func() { + // Step 2: Select destination + path, err := app.Dialog.SaveFile(). + SetFilename("export.csv"). + AddFilter("CSV Files", "*.csv"). + PromptForSingleSelection() + + if err != nil || path == "" { + return + } + + // Step 3: Perform export + if err := performExport(path); err != nil { + app.Dialog.Error(). + SetTitle("Export Failed"). + SetMessage(err.Error()). + Show() + return + } + + // Step 4: Success + app.Dialog.Info(). + SetTitle("Export Complete"). + SetMessage("Data exported successfully!"). + Show() + }) + + cancelBtn := dialog.AddButton("Cancel") + dialog.SetCancelButton(cancelBtn) + dialog.Show() +} +``` + +## Best Practices + +### ✅ Do + +- **Use native dialogs** - Better UX than custom +- **Provide clear messages** - Be specific +- **Set appropriate titles** - Context matters +- **Use default buttons wisely** - Safe option as default +- **Handle cancellation** - User might cancel +- **Validate file selections** - Check file types + +### ❌ Don't + +- **Don't overuse dialogs** - Interrupts workflow +- **Don't use for frequent messages** - Use notifications +- **Don't forget error handling** - User might cancel +- **Don't block unnecessarily** - Consider alternatives +- **Don't use generic messages** - Be specific +- **Don't ignore platform differences** - Test on all platforms + +## Next Steps + + + + Info, warning, and error dialogs. + + [Learn More →](/features/dialogs/message) + + + + Open, save, and folder selection. + + [Learn More →](/features/dialogs/file) + + + + Create custom dialog windows. + + [Learn More →](/features/dialogs/custom) + + + + Learn about window management. + + [Learn More →](/features/windows/basics) + + + +--- + +**Questions?** Ask in [Discord](https://discord.gg/JDdSxwjhGf) or check the [dialog examples](https://github.com/wailsapp/wails/tree/v3-alpha/v3/examples/dialogs). diff --git a/docs/src/content/docs/features/drag-and-drop/files.mdx b/docs/src/content/docs/features/drag-and-drop/files.mdx new file mode 100644 index 000000000..ffc75093a --- /dev/null +++ b/docs/src/content/docs/features/drag-and-drop/files.mdx @@ -0,0 +1,212 @@ +--- +title: File Drop +description: Accept files dragged from the operating system into your application +sidebar: + order: 1 +--- + +Wails lets users drag files from the operating system (file manager, desktop) into your application. Unlike HTML5 drag-and-drop which only works within the browser, this gives you access to actual file paths on disk. + +## Enable File Drop + +File drop is disabled by default. To enable it, set `EnableFileDrop: true` in your window options: + +```go +window := app.Window.NewWithOptions(application.WebviewWindowOptions{ + Title: "My App", + Width: 800, + Height: 600, + EnableFileDrop: true, +}) +``` + +When `EnableFileDrop` is `false` (the default), files dragged from the OS are blocked - they won't open in the webview or trigger any events. This prevents accidental navigation when users drag files over your app. + +## Define Drop Zones + +Drop zones tell Wails which elements should accept files. Files dropped outside a drop zone are ignored. + +Add the `data-file-drop-target` attribute to any element: + +```html +
+ Drop files here +
+``` + +You can have multiple drop zones. The element's `id` and CSS classes are passed to your Go code, so you can handle drops differently depending on where files land. + +## Style Drag Hover + +When files are dragged over a drop zone, Wails adds the `file-drop-target-active` class. This lets you provide visual feedback so users know where they can drop: + +```css +.drop-zone { + border: 2px dashed #ccc; + padding: 40px; + text-align: center; + transition: all 0.2s ease; +} + +.drop-zone.file-drop-target-active { + border-color: #007bff; + background-color: rgba(0, 123, 255, 0.1); +} +``` + +The class is removed automatically when files leave the zone or are dropped. + +## Detect Dropped Files + +When files are dropped on a valid drop zone, Wails fires a `WindowFilesDropped` event. The event context contains the full filesystem paths of all dropped files: + +```go +import "github.com/wailsapp/wails/v3/pkg/events" + +window.OnWindowEvent(events.Common.WindowFilesDropped, func(event *application.WindowEvent) { + files := event.Context().DroppedFiles() + + for _, file := range files { + fmt.Println("Dropped:", file) + } +}) +``` + +The paths are absolute, like `/home/user/documents/report.pdf` or `C:\Users\Name\Documents\report.pdf`. + +## Get Drop Target Info + +When you have multiple drop zones, you can find out which one received the files using `DropTargetDetails()`: + +```go +window.OnWindowEvent(events.Common.WindowFilesDropped, func(event *application.WindowEvent) { + files := event.Context().DroppedFiles() + details := event.Context().DropTargetDetails() + + fmt.Printf("Dropped on element: id=%s, classes=%v\n", + details.ElementID, details.ClassList) + fmt.Printf("Position: x=%d, y=%d\n", details.X, details.Y) +}) +``` + +This lets you route files to different handlers: + +```go +switch details.ElementID { +case "images": + handleImageUpload(files) +case "documents": + handleDocumentUpload(files) +} +``` + +## Complete Example + +**Go:** + +```go +window := app.Window.NewWithOptions(application.WebviewWindowOptions{ + Title: "File Uploader", + EnableFileDrop: true, +}) + +window.OnWindowEvent(events.Common.WindowFilesDropped, func(event *application.WindowEvent) { + files := event.Context().DroppedFiles() + details := event.Context().DropTargetDetails() + + // Send to frontend + app.Event.Emit("files-dropped", map[string]any{ + "files": files, + "target": details.ElementID, + }) +}) +``` + +**HTML:** + +```html +
+ Drop images here +
+ +
+ Drop documents here +
+ + +``` + +## Full Window Drop + +If you want files to be droppable anywhere in your app, add the attribute to the body element: + +```html + + + +``` + +You can use a CSS overlay to indicate the entire window is a drop target: + +```css +body.file-drop-target-active::after { + content: "Drop files anywhere"; + position: fixed; + inset: 0; + display: flex; + align-items: center; + justify-content: center; + font-size: 24px; + color: #007bff; + background: rgba(255, 255, 255, 0.9); + pointer-events: none; +} +``` + +## Combining with HTML Drag & Drop + +You can use both external file drops and internal HTML drag-and-drop in the same application. When `EnableFileDrop` is `true`, Wails intercepts external file drags but lets internal HTML5 drags pass through normally. + +To distinguish between them in your HTML drop zone handlers, check if the drag contains files: + +```javascript +zone.addEventListener('dragenter', (e) => { + // Skip external file drags - Wails handles these + if (e.dataTransfer?.types.includes('Files')) { + return; + } + // Handle internal HTML5 drags + zone.classList.add('drag-over'); +}); + +zone.addEventListener('drop', (e) => { + // Skip external file drops - Wails handles these + if (e.dataTransfer?.types.includes('Files')) { + return; + } + e.preventDefault(); + zone.classList.remove('drag-over'); + // Handle internal drop +}); +``` + +This ensures your HTML drop handlers only respond to internal drags (like moving list items), while Wails handles external file drops separately via the `WindowFilesDropped` event. + +## Next Steps + +- [HTML Drag & Drop](./html) - Drag elements within your app +- [Window Options](/features/windows/options) - All window configuration options diff --git a/docs/src/content/docs/features/drag-and-drop/html.mdx b/docs/src/content/docs/features/drag-and-drop/html.mdx new file mode 100644 index 000000000..7eeebc7be --- /dev/null +++ b/docs/src/content/docs/features/drag-and-drop/html.mdx @@ -0,0 +1,232 @@ +--- +title: HTML Drag & Drop +description: Drag and drop elements within your application +sidebar: + order: 2 +--- + +HTML5 drag-and-drop lets users drag elements within your app's UI - for example, reordering a list or moving items between columns. This is standard web functionality that works in Wails without any special setup. + +## Make an Element Draggable + +By default, most elements can't be dragged. To make an element draggable, add `draggable="true"`: + +```html +
Drag me
+``` + +The element will now show a drag preview when the user clicks and drags it. + +## Define a Drop Zone + +Elements don't accept drops by default. To make an element accept drops, you need to cancel the default behaviour on `dragover`: + +```html +
Drop here
+ + +``` + +Calling `preventDefault()` on `dragover` is required - it signals that this element accepts drops. Without it, the drop event won't fire. + +## Style Drag Hover + +To show users where they can drop, add visual feedback when dragging over a drop zone. The `dragenter` event fires when something enters the zone, and `dragleave` fires when it leaves: + +```css +.drop-zone { + border: 2px dashed #ccc; + padding: 40px; + transition: all 0.2s ease; +} + +.drop-zone.drag-over { + border-color: #007bff; + background-color: rgba(0, 123, 255, 0.1); +} +``` + +```javascript +const target = document.getElementById('target'); + +target.addEventListener('dragenter', () => { + target.classList.add('drag-over'); +}); + +target.addEventListener('dragleave', () => { + target.classList.remove('drag-over'); +}); + +target.addEventListener('drop', (e) => { + e.preventDefault(); + target.classList.remove('drag-over'); + // Handle the drop +}); +``` + +Note: `dragleave` also fires when entering a child element, which can cause flickering. The complete example below shows how to handle this. + +## Complete Example + +A task list where items can be dragged between priority columns. This tracks the dragged element in a variable, which is the simplest approach when everything is on the same page: + +```html +
+
Fix login bug
+
Update docs
+
Add dark mode
+
+ +
+
+

High Priority

+
    +
    +
    +

    Low Priority

    +
      +
      +
      + + + + +``` + +## Combining with File Drop + +If your app uses both HTML drag-and-drop and [File Drop](./files), your HTML drop zones will also receive events when users drag files from the operating system. To prevent confusion, filter out file drags in your handlers: + +```javascript +zone.addEventListener('dragenter', (e) => { + // Ignore external file drags + if (e.dataTransfer?.types.includes('Files')) return; + + zone.classList.add('drag-over'); +}); + +zone.addEventListener('dragover', (e) => { + // Ignore external file drags + if (e.dataTransfer?.types.includes('Files')) return; + + e.preventDefault(); +}); + +zone.addEventListener('drop', (e) => { + // Ignore external file drags + if (e.dataTransfer?.types.includes('Files')) return; + + e.preventDefault(); + zone.classList.remove('drag-over'); + // Handle the internal drop +}); +``` + +The `dataTransfer.types` array contains `'Files'` when the user is dragging files from the OS, but contains types like `'text/plain'` for internal HTML drags. This lets you distinguish between the two. + +## Passing Data with dataTransfer + +The example above tracks the dragged element in a JavaScript variable. This works well when everything is on the same page. But if you need to drag between iframes or pass data that isn't tied to a DOM element, use the `dataTransfer` API: + +```javascript +// When drag starts, store data +item.addEventListener('dragstart', (e) => { + e.dataTransfer.setData('text/plain', item.id); +}); + +// When dropped, retrieve the data +target.addEventListener('drop', (e) => { + e.preventDefault(); + const itemId = e.dataTransfer.getData('text/plain'); + const item = document.getElementById(itemId); + // Move or copy the item +}); +``` + +The data is stored as strings, so you'll need to serialize objects with `JSON.stringify()` if needed. + +## Next Steps + +- [File Drop](./files) - Accept files from the operating system +- [MDN Drag and Drop API](https://developer.mozilla.org/en-US/docs/Web/API/HTML_Drag_and_Drop_API) - Full browser API reference diff --git a/docs/src/content/docs/features/environment/info.mdx b/docs/src/content/docs/features/environment/info.mdx new file mode 100644 index 000000000..d03fb5f70 --- /dev/null +++ b/docs/src/content/docs/features/environment/info.mdx @@ -0,0 +1,620 @@ +--- +title: Environment +sidebar: + order: 59 +--- + +import { Tabs, TabItem } from "@astrojs/starlight/components"; + +Wails provides comprehensive environment information through the EnvironmentManager API. This allows your application to detect system properties, theme preferences, and integrate with the operating system's file manager. + +## Accessing the Environment Manager + +The environment manager is accessed through the `Env` property on your application instance: + +```go +app := application.New(application.Options{ + Name: "Environment Demo", +}) + +// Access the environment manager +env := app.Env +``` + +## System Information + +### Get Environment Information + +Retrieve comprehensive information about the runtime environment: + +```go +envInfo := app.Env.Info() + +app.Logger.Info("Environment information", + "os", envInfo.OS, // "windows", "darwin", "linux" + "arch", envInfo.Arch, // "amd64", "arm64", etc. + "debug", envInfo.Debug, // Debug mode flag +) + +// Operating system details +if envInfo.OSInfo != nil { + app.Logger.Info("OS details", + "name", envInfo.OSInfo.Name, + "version", envInfo.OSInfo.Version, + ) +} + +// Platform-specific information +for key, value := range envInfo.PlatformInfo { + app.Logger.Info("Platform info", "key", key, "value", value) +} +``` + +### Environment Structure + +The environment information includes several important fields: + +```go +type EnvironmentInfo struct { + OS string // Operating system: "windows", "darwin", "linux" + Arch string // Architecture: "amd64", "arm64", "386", etc. + Debug bool // Whether running in debug mode + OSInfo *operatingsystem.OS // Detailed OS information + PlatformInfo map[string]any // Platform-specific details +} +``` + +## Theme Detection + +### Dark Mode Detection + +Detect whether the system is using dark mode: + +```go +if app.Env.IsDarkMode() { + app.Logger.Info("System is in dark mode") + // Apply dark theme to your application + applyDarkTheme() +} else { + app.Logger.Info("System is in light mode") + // Apply light theme to your application + applyLightTheme() +} +``` + +### Theme Change Monitoring + +Listen for theme changes to update your application dynamically: + +```go +import "github.com/wailsapp/wails/v3/pkg/events" + +// Listen for theme changes +app.Event.OnApplicationEvent(events.Common.ThemeChanged, func(event *application.ApplicationEvent) { + if app.Env.IsDarkMode() { + app.Logger.Info("Switched to dark mode") + updateApplicationTheme("dark") + } else { + app.Logger.Info("Switched to light mode") + updateApplicationTheme("light") + } +}) + +func updateApplicationTheme(theme string) { + // Update your application's theme + // This could emit an event to the frontend + app.Event.Emit("theme:changed", theme) +} +``` + +## File Manager Integration + +### Open File Manager + +Open the system's file manager at a specific location: + +```go +// Open file manager at a directory +err := app.Env.OpenFileManager("/Users/username/Documents", false) +if err != nil { + app.Logger.Error("Failed to open file manager", "error", err) +} + +// Open file manager and select a specific file +err = app.Env.OpenFileManager("/Users/username/Documents/report.pdf", true) +if err != nil { + app.Logger.Error("Failed to open file manager with selection", "error", err) +} +``` + +### Common Use Cases + +Show files or folders in the file manager from your application: + +```go +func showInFileManager(app *application.App, path string) { + err := app.Env.OpenFileManager(path, true) + if err != nil { + // Fallback: try opening just the directory + dir := filepath.Dir(path) + err = app.Env.OpenFileManager(dir, false) + if err != nil { + app.Logger.Error("Could not open file manager", "path", path, "error", err) + + // Show error to user + app.Dialog.Error(). + SetTitle("File Manager Error"). + SetMessage("Could not open file manager"). + Show() + } + } +} + +// Usage examples +func setupFileMenu(app *application.App) { + menu := app.Menu.New() + fileMenu := menu.AddSubmenu("File") + + fileMenu.Add("Show Downloads Folder").OnClick(func(ctx *application.Context) { + homeDir, _ := os.UserHomeDir() + downloadsDir := filepath.Join(homeDir, "Downloads") + showInFileManager(app, downloadsDir) + }) + + fileMenu.Add("Show Application Data").OnClick(func(ctx *application.Context) { + configDir, _ := os.UserConfigDir() + appDir := filepath.Join(configDir, "MyApp") + showInFileManager(app, appDir) + }) +} +``` + +## Platform-Specific Behavior + +### Adaptive Application Behavior + +Use environment information to adapt your application's behavior: + +```go +func configureForPlatform(app *application.App) { + envInfo := app.Env.Info() + + switch envInfo.OS { + case "darwin": + configureMacOS(app) + case "windows": + configureWindows(app) + case "linux": + configureLinux(app) + } + + // Adapt to architecture + if envInfo.Arch == "arm64" { + app.Logger.Info("Running on ARM architecture") + // Potentially optimize for ARM + } +} + +func configureMacOS(app *application.App) { + app.Logger.Info("Configuring for macOS") + + // macOS-specific configuration + menu := app.Menu.New() + menu.AddRole(application.AppMenu) // Add standard macOS app menu + + // Handle dark mode + if app.Env.IsDarkMode() { + setMacOSDarkTheme() + } +} + +func configureWindows(app *application.App) { + app.Logger.Info("Configuring for Windows") + + // Windows-specific configuration + // Set up Windows-style menus, key bindings, etc. +} + +func configureLinux(app *application.App) { + app.Logger.Info("Configuring for Linux") + + // Linux-specific configuration + // Adapt to different desktop environments +} +``` + +## Debug Mode Handling + +### Development vs Production + +Use debug mode information to enable development features: + +```go +func setupApplicationMode(app *application.App) { + envInfo := app.Env.Info() + + if envInfo.Debug { + app.Logger.Info("Running in debug mode") + setupDevelopmentFeatures(app) + } else { + app.Logger.Info("Running in production mode") + setupProductionFeatures(app) + } +} + +func setupDevelopmentFeatures(app *application.App) { + // Enable development-only features + menu := app.Menu.New() + + // Add development menu + devMenu := menu.AddSubmenu("Development") + devMenu.Add("Reload Application").OnClick(func(ctx *application.Context) { + // Reload the application + window := app.Window.Current() + if window != nil { + window.Reload() + } + }) + + devMenu.Add("Open DevTools").OnClick(func(ctx *application.Context) { + window := app.Window.Current() + if window != nil { + window.OpenDevTools() + } + }) + + devMenu.Add("Show Environment").OnClick(func(ctx *application.Context) { + showEnvironmentDialog(app) + }) +} + +func setupProductionFeatures(app *application.App) { + // Production-only features + // Disable debug logging, enable analytics, etc. +} +``` + +## Environment Information Dialog + +### Display System Information + +Create a dialog showing environment information: + +```go +func showEnvironmentDialog(app *application.App) { + envInfo := app.Env.Info() + + details := fmt.Sprintf(`Environment Information: + +Operating System: %s +Architecture: %s +Debug Mode: %t + +Dark Mode: %t + +Platform Information:`, + envInfo.OS, + envInfo.Arch, + envInfo.Debug, + app.Env.IsDarkMode()) + + // Add platform-specific details + for key, value := range envInfo.PlatformInfo { + details += fmt.Sprintf("\n%s: %v", key, value) + } + + if envInfo.OSInfo != nil { + details += fmt.Sprintf("\n\nOS Details:\nName: %s\nVersion: %s", + envInfo.OSInfo.Name, + envInfo.OSInfo.Version) + } + + dialog := app.Dialog.Info() + dialog.SetTitle("Environment Information") + dialog.SetMessage(details) + dialog.Show() +} +``` + +## Platform Considerations + + + + + On macOS: + + - Dark mode detection uses system appearance settings + - File manager operations use Finder + - Platform info includes macOS version details + - Architecture may be "arm64" on Apple Silicon Macs + + ```go + if envInfo.OS == "darwin" { + // macOS-specific handling + if envInfo.Arch == "arm64" { + app.Logger.Info("Running on Apple Silicon") + } + } + ``` + + + + + + On Windows: + + - Dark mode detection uses Windows theme settings + - File manager operations use Windows Explorer + - Platform info includes Windows version details + - May include additional Windows-specific information + + ```go + if envInfo.OS == "windows" { + // Windows-specific handling + for key, value := range envInfo.PlatformInfo { + if key == "windows_version" { + app.Logger.Info("Windows version", "version", value) + } + } + } + ``` + + + + + + On Linux: + + - Dark mode detection varies by desktop environment + - File manager operations use system default file manager + - Platform info includes distribution details + - Behavior may vary between different Linux distributions + + ```go + if envInfo.OS == "linux" { + // Linux-specific handling + if distro, ok := envInfo.PlatformInfo["distribution"]; ok { + app.Logger.Info("Linux distribution", "distro", distro) + } + } + ``` + + + + +## Best Practices + +1. **Cache Environment Information**: Environment info rarely changes during runtime: + ```go + type App struct { + envInfo *application.EnvironmentInfo + } + + func (a *App) getEnvInfo() application.EnvironmentInfo { + if a.envInfo == nil { + info := a.app.Env.Info() + a.envInfo = &info + } + return *a.envInfo + } + ``` + +2. **Handle Theme Changes**: Listen for system theme changes: + ```go + app.Event.OnApplicationEvent(events.Common.ThemeChanged, func(event *application.ApplicationEvent) { + updateTheme(app.Env.IsDarkMode()) + }) + ``` + +3. **Graceful File Manager Failures**: Always handle file manager errors: + ```go + func openFileManagerSafely(app *application.App, path string) { + err := app.Env.OpenFileManager(path, false) + if err != nil { + // Provide fallback or user notification + app.Logger.Warn("Could not open file manager", "path", path) + } + } + ``` + +4. **Platform-Specific Features**: Use environment info to enable platform features: + ```go + envInfo := app.Env.Info() + if envInfo.OS == "darwin" { + // Enable macOS-specific features + } + ``` + +## Complete Example + +Here's a complete example demonstrating environment management: + +```go +package main + +import ( + "fmt" + "os" + "path/filepath" + "runtime" + "github.com/wailsapp/wails/v3/pkg/application" + "github.com/wailsapp/wails/v3/pkg/events" +) + +func main() { + app := application.New(application.Options{ + Name: "Environment Demo", + }) + + // Setup application based on environment + setupForEnvironment(app) + + // Monitor theme changes + monitorThemeChanges(app) + + // Create menu with environment features + setupEnvironmentMenu(app) + + // Create main window + window := app.Window.New() + window.SetTitle("Environment Demo") + + err := app.Run() + if err != nil { + panic(err) + } +} + +func setupForEnvironment(app *application.App) { + envInfo := app.Env.Info() + + app.Logger.Info("Application environment", + "os", envInfo.OS, + "arch", envInfo.Arch, + "debug", envInfo.Debug, + "darkMode", app.Env.IsDarkMode(), + ) + + // Configure for platform + switch envInfo.OS { + case "darwin": + app.Logger.Info("Configuring for macOS") + // macOS-specific setup + case "windows": + app.Logger.Info("Configuring for Windows") + // Windows-specific setup + case "linux": + app.Logger.Info("Configuring for Linux") + // Linux-specific setup + } + + // Apply initial theme + if app.Env.IsDarkMode() { + applyDarkTheme(app) + } else { + applyLightTheme(app) + } +} + +func monitorThemeChanges(app *application.App) { + app.Event.OnApplicationEvent(events.Common.ThemeChanged, func(event *application.ApplicationEvent) { + if app.Env.IsDarkMode() { + app.Logger.Info("System switched to dark mode") + applyDarkTheme(app) + } else { + app.Logger.Info("System switched to light mode") + applyLightTheme(app) + } + }) +} + +func setupEnvironmentMenu(app *application.App) { + menu := app.Menu.New() + + // Add platform-specific app menu + if runtime.GOOS == "darwin" { + menu.AddRole(application.AppMenu) + } + + // Tools menu + toolsMenu := menu.AddSubmenu("Tools") + + toolsMenu.Add("Show Environment Info").OnClick(func(ctx *application.Context) { + showEnvironmentInfo(app) + }) + + toolsMenu.Add("Open Downloads Folder").OnClick(func(ctx *application.Context) { + openDownloadsFolder(app) + }) + + toolsMenu.Add("Toggle Theme").OnClick(func(ctx *application.Context) { + // This would typically be handled by the system + // but shown here for demonstration + toggleTheme(app) + }) + + app.Menu.Set(menu) +} + +func showEnvironmentInfo(app *application.App) { + envInfo := app.Env.Info() + + message := fmt.Sprintf(`Environment Information: + +Operating System: %s +Architecture: %s +Debug Mode: %t +Dark Mode: %t + +Platform Details:`, + envInfo.OS, + envInfo.Arch, + envInfo.Debug, + app.Env.IsDarkMode()) + + for key, value := range envInfo.PlatformInfo { + message += fmt.Sprintf("\n%s: %v", key, value) + } + + if envInfo.OSInfo != nil { + message += fmt.Sprintf("\n\nOS Information:\nName: %s\nVersion: %s", + envInfo.OSInfo.Name, + envInfo.OSInfo.Version) + } + + dialog := app.Dialog.Info() + dialog.SetTitle("Environment Information") + dialog.SetMessage(message) + dialog.Show() +} + +func openDownloadsFolder(app *application.App) { + homeDir, err := os.UserHomeDir() + if err != nil { + app.Logger.Error("Could not get home directory", "error", err) + return + } + + downloadsDir := filepath.Join(homeDir, "Downloads") + err = app.Env.OpenFileManager(downloadsDir, false) + if err != nil { + app.Logger.Error("Could not open Downloads folder", "error", err) + + app.Dialog.Error(). + SetTitle("File Manager Error"). + SetMessage("Could not open Downloads folder"). + Show() + } +} + +func applyDarkTheme(app *application.App) { + app.Logger.Info("Applying dark theme") + // Emit theme change to frontend + app.Event.Emit("theme:apply", "dark") +} + +func applyLightTheme(app *application.App) { + app.Logger.Info("Applying light theme") + // Emit theme change to frontend + app.Event.Emit("theme:apply", "light") +} + +func toggleTheme(app *application.App) { + // This is just for demonstration + // Real theme changes should come from the system + currentlyDark := app.Env.IsDarkMode() + if currentlyDark { + applyLightTheme(app) + } else { + applyDarkTheme(app) + } +} +``` + +:::tip[Pro Tip] +Use environment information to provide platform-appropriate user experiences. For example, use Command key shortcuts on macOS and Control key shortcuts on Windows/Linux. +::: + +:::danger[Warning] +Environment information is generally stable during application runtime, but theme preferences can change. Always listen for theme change events to keep your UI synchronized. +::: \ No newline at end of file diff --git a/docs/src/content/docs/features/events/system.mdx b/docs/src/content/docs/features/events/system.mdx new file mode 100644 index 000000000..678abff2f --- /dev/null +++ b/docs/src/content/docs/features/events/system.mdx @@ -0,0 +1,591 @@ +--- +title: Event System +description: Communicate between components with the event system +sidebar: + order: 1 +--- + +import { Tabs, TabItem, Card, CardGrid } from "@astrojs/starlight/components"; + +## Event System + +Wails provides a **unified event system** for pub/sub communication. Emit events from anywhere, listen from anywhere—Go to JavaScript, JavaScript to Go, window to window—enabling decoupled architecture with typed events and lifecycle hooks. + +## Quick Start + +**Go (emit):** + +```go +app.Event.Emit("user-logged-in", map[string]interface{}{ + "userId": 123, + "name": "Alice", +}) +``` + +**JavaScript (listen):** + +```javascript +import { Events } from '@wailsio/runtime' + +Events.On("user-logged-in", (event) => { + console.log(`User ${event.data.name} logged in`) +}) +``` + +**That's it!** Cross-language pub/sub. + +## Event Types + +### Custom Events + +Your application-specific events: + +```go +// Emit from Go +app.Event.Emit("order-created", order) +app.Event.Emit("payment-processed", payment) +app.Event.Emit("notification", message) +``` + +```javascript +// Listen in JavaScript +Events.On("order-created", handleOrder) +Events.On("payment-processed", handlePayment) +Events.On("notification", showNotification) +``` + +### System Events + +Built-in OS and application events: + +```go +import "github.com/wailsapp/wails/v3/pkg/events" + +// Theme changes +app.Event.OnApplicationEvent(events.Common.ThemeChanged, func(e *application.ApplicationEvent) { + if e.Context().IsDarkMode() { + app.Logger.Info("Dark mode enabled") + } +}) + +// Application lifecycle +app.Event.OnApplicationEvent(events.Common.ApplicationStarted, func(e *application.ApplicationEvent) { + app.Logger.Info("Application started") +}) +``` + +### Window Events + +Window-specific events: + +```go +window.OnWindowEvent(events.Common.WindowFocus, func(e *application.WindowEvent) { + app.Logger.Info("Window focused") +}) + +window.OnWindowEvent(events.Common.WindowClosing, func(e *application.WindowEvent) { + app.Logger.Info("Window closing") +}) +``` + +## Emitting Events + +### From Go + +**Basic emit:** + +```go +app.Event.Emit("event-name", data) +``` + +**With different data types:** + +```go +// String +app.Event.Emit("message", "Hello") + +// Number +app.Event.Emit("count", 42) + +// Struct +app.Event.Emit("user", User{ID: 1, Name: "Alice"}) + +// Map +app.Event.Emit("config", map[string]interface{}{ + "theme": "dark", + "fontSize": 14, +}) + +// Array +app.Event.Emit("items", []string{"a", "b", "c"}) +``` + +**To specific window:** + +```go +window.EmitEvent("window-specific-event", data) +``` + +### From JavaScript + +```javascript +import { Emit } from '@wailsio/runtime' + +// Emit to Go +Emit("button-clicked", { buttonId: "submit" }) + +// Emit to all windows +Emit("broadcast-message", "Hello everyone") +``` + +## Listening to Events + +### In Go + +**Application events:** + +```go +app.Event.On("custom-event", func(e *application.CustomEvent) { + data := e.Data + // Handle event +}) +``` + +**With type assertion:** + +```go +app.Event.On("user-updated", func(e *application.CustomEvent) { + user := e.Data.(User) + app.Logger.Info("User updated", "name", user.Name) +}) +``` + +**Multiple handlers:** + +```go +// All handlers will be called +app.Event.On("order-created", logOrder) +app.Event.On("order-created", sendEmail) +app.Event.On("order-created", updateInventory) +``` + +### In JavaScript + +**Basic listener:** + +```javascript +import { Events } from '@wailsio/runtime' + +Events.On("event-name", (event) => { + console.log("Event received:", event.data) +}) +``` + +**With cleanup:** + +```javascript +const unsubscribe = Events.On("event-name", handleEvent) + +// Later, stop listening +unsubscribe() +``` + +**Multiple handlers:** + +```javascript +Events.On("data-updated", updateUI) +Events.On("data-updated", saveToCache) +Events.On("data-updated", logChange) +``` + +**One Time handlers:** + +```javascript +Events.Once("data-updated", updateVariable) +``` + +## System Events + +### Application Events + +**Common events (cross-platform):** + +```go +import "github.com/wailsapp/wails/v3/pkg/events" + +// Application started +app.Event.OnApplicationEvent(events.Common.ApplicationStarted, func(e *application.ApplicationEvent) { + app.Logger.Info("App started") +}) + +// Theme changed +app.Event.OnApplicationEvent(events.Common.ThemeChanged, func(e *application.ApplicationEvent) { + isDark := e.Context().IsDarkMode() + app.Event.Emit("theme-changed", isDark) +}) + +// File opened +app.Event.OnApplicationEvent(events.Common.ApplicationOpenedWithFile, func(e *application.ApplicationEvent) { + filePath := e.Context().OpenedFile() + openFile(filePath) +}) +``` + +**Platform-specific events:** + + + + ```go + // Application became active + app.Event.OnApplicationEvent(events.Mac.ApplicationDidBecomeActive, func(e *application.ApplicationEvent) { + app.Logger.Info("App became active") + }) + + // Application will terminate + app.Event.OnApplicationEvent(events.Mac.ApplicationWillTerminate, func(e *application.ApplicationEvent) { + cleanup() + }) + ``` + + + + ```go + // Power status changed + app.Event.OnApplicationEvent(events.Windows.APMPowerStatusChange, func(e *application.ApplicationEvent) { + app.Logger.Info("Power status changed") + }) + + // System suspending + app.Event.OnApplicationEvent(events.Windows.APMSuspend, func(e *application.ApplicationEvent) { + saveState() + }) + ``` + + + + ```go + // Application startup + app.Event.OnApplicationEvent(events.Linux.ApplicationStartup, func(e *application.ApplicationEvent) { + app.Logger.Info("App starting") + }) + + // Theme changed + app.Event.OnApplicationEvent(events.Linux.SystemThemeChanged, func(e *application.ApplicationEvent) { + updateTheme() + }) + ``` + + + +### Window Events + +**Common window events:** + +```go +// Window focus +window.OnWindowEvent(events.Common.WindowFocus, func(e *application.WindowEvent) { + app.Logger.Info("Window focused") +}) + +// Window blur +window.OnWindowEvent(events.Common.WindowBlur, func(e *application.WindowEvent) { + app.Logger.Info("Window blurred") +}) + +// Window closing +window.OnWindowEvent(events.Common.WindowClosing, func(e *application.WindowEvent) { + if hasUnsavedChanges() { + e.Cancel() // Prevent close + } +}) + +// Window closed +window.OnWindowEvent(events.Common.WindowClosed, func(e *application.WindowEvent) { + cleanup() +}) +``` + +## Event Hooks + +Hooks run **before** standard listeners and can **cancel** events: + +```go +// Hook - runs first, can cancel +window.RegisterHook(events.Common.WindowClosing, func(e *application.WindowEvent) { + if hasUnsavedChanges() { + result := showConfirmdialog("Unsaved changes. Close anyway?") + if result != "yes" { + e.Cancel() // Prevent window close + } + } +}) + +// Standard listener - runs after hooks +window.OnWindowEvent(events.Common.WindowClosing, func(e *application.WindowEvent) { + app.Logger.Info("Window closing") +}) +``` + +**Key differences:** + +| Feature | Hooks | Standard Listeners | +|---------|-------|-------------------| +| Execution order | First, in registration order | After hooks, no guaranteed order | +| Blocking | Synchronous, blocks next hook | Asynchronous, non-blocking | +| Can cancel | Yes | No (already propagated) | +| Use case | Control flow, validation | Logging, side effects | + +## Event Patterns + +### Pub/Sub Pattern + +```go +// Publisher (service) +type OrderService struct { + app *application.Application +} + +func (o *OrderService) CreateOrder(items []Item) (*Order, error) { + order := &Order{Items: items} + + if err := o.saveOrder(order); err != nil { + return nil, err + } + + // Publish event + o.app.Event.Emit("order-created", order) + + return order, nil +} + +// Subscribers +app.Event.On("order-created", func(e *application.CustomEvent) { + order := e.Data.(*Order) + sendConfirmationEmail(order) +}) + +app.Event.On("order-created", func(e *application.CustomEvent) { + order := e.Data.(*Order) + updateInventory(order) +}) + +app.Event.On("order-created", func(e *application.CustomEvent) { + order := e.Data.(*Order) + logOrder(order) +}) +``` + +### Request/Response Pattern + +```go +// Frontend requests data +Emit("get-user-data", { userId: 123 }) + +// Backend responds +app.Event.On("get-user-data", func(e *application.CustomEvent) { + data := e.Data.(map[string]interface{}) + userId := int(data["userId"].(float64)) + + user := getUserFromDB(userId) + + // Send response + app.Event.Emit("user-data-response", user) +}) +``` + +```javascript +// Frontend receives response +Events.On("user-data-response", (event) => { + const user = event.data + displayUser(user) +}) +``` + +**Note:** For request/response, **bindings are better**. Use events for notifications. + +### Broadcast Pattern + +```go +// Broadcast to all windows +app.Event.Emit("global-notification", "System update available") + +// Each window handles it +Events.On("global-notification", (event) => { + const message = event.data + showNotification(message) +}) +``` + +### Event Aggregation + +```go +type EventAggregator struct { + events []Event + mu sync.Mutex +} + +func (ea *EventAggregator) Add(event Event) { + ea.mu.Lock() + defer ea.mu.Unlock() + + ea.events = append(ea.events, event) + + // Emit batch every 100 events + if len(ea.events) >= 100 { + app.Event.Emit("event-batch", ea.events) + ea.events = nil + } +} +``` + +## Complete Example + +**Go:** + +```go +package main + +import ( + "github.com/wailsapp/wails/v3/pkg/application" + "github.com/wailsapp/wails/v3/pkg/events" +) + +type NotificationService struct { + app *application.Application +} + +func (n *NotificationService) Notify(message string) { + // Emit to all windows + n.app.Event.Emit("notification", map[string]interface{}{ + "message": message, + "timestamp": time.Now(), + }) +} + +func main() { + app := application.New(application.Options{ + Name: "Event Demo", + }) + + notifService := &NotificationService{app: app} + + // System events + app.Event.OnApplicationEvent(events.Common.ThemeChanged, func(e *application.ApplicationEvent) { + isDark := e.Context().IsDarkMode() + app.Event.Emit("theme-changed", isDark) + }) + + // Custom events from frontend + app.Event.On("user-action", func(e *application.CustomEvent) { + data := e.Data.(map[string]interface{}) + action := data["action"].(string) + + app.Logger.Info("User action", "action", action) + + // Respond + notifService.Notify("Action completed: " + action) + }) + + // Window events + window := app.Window.New() + + window.OnWindowEvent(events.Common.WindowFocus, func(e *application.WindowEvent) { + app.Event.Emit("window-focused", window.Name()) + }) + + window.RegisterHook(events.Common.WindowClosing, func(e *application.WindowEvent) { + // Confirm before close + app.Event.Emit("confirm-close", nil) + e.Cancel() // Wait for confirmation + }) + + app.Run() +} +``` + +**JavaScript:** + +```javascript +import { Events, Emit } from '@wailsio/runtime' + +// Listen for notifications +Events.On("notification", (event) => { + showNotification(event.data.message) +}) + +// Listen for theme changes +Events.On("theme-changed", (event) => { + const isDark = event.data + document.body.classList.toggle('dark', isDark) +}) + +// Listen for window focus +Events.On("window-focused", (event) => { + const windowName = event.data + console.log(`Window ${windowName} focused`) +}) + +// Handle close confirmation +Events.On("confirm-close", (event) => { + if (confirm("Close window?")) { + Emit("close-confirmed", true) + } +}) + +// Emit user actions +document.getElementById('button').addEventListener('click', () => { + Emit("user-action", { action: "button-clicked" }) +}) +``` + +## Best Practices + +### ✅ Do + +- **Use events for notifications** - One-way communication +- **Use bindings for requests** - Two-way communication +- **Keep event names consistent** - Use kebab-case +- **Document event data** - What fields are included? +- **Unsubscribe when done** - Prevent memory leaks +- **Use hooks for validation** - Control event flow + +### ❌ Don't + +- **Don't use events for RPC** - Use bindings instead +- **Don't emit too frequently** - Batch if needed +- **Don't block in handlers** - Keep them fast +- **Don't forget to unsubscribe** - Memory leaks +- **Don't use events for large data** - Use bindings +- **Don't create event loops** - A emits B, B emits A + +## Next Steps + + + + Create your own event types. + + [Learn More →](/features/events/custom) + + + + Common event patterns and best practices. + + [Learn More →](/features/events/patterns) + + + + Use bindings for request/response. + + [Learn More →](/features/bindings/methods) + + + + Handle window lifecycle events. + + [Learn More →](/features/windows/events) + + + +--- + +**Questions?** Ask in [Discord](https://discord.gg/JDdSxwjhGf) or check the [event examples](https://github.com/wailsapp/wails/tree/v3-alpha/v3/examples/events). diff --git a/docs/src/content/docs/features/keyboard/shortcuts.mdx b/docs/src/content/docs/features/keyboard/shortcuts.mdx new file mode 100644 index 000000000..ba83603f8 --- /dev/null +++ b/docs/src/content/docs/features/keyboard/shortcuts.mdx @@ -0,0 +1,438 @@ +--- +title: Keyboard Shortcuts +description: Register global keyboard shortcuts for quick access to functionality +sidebar: + order: 1 +--- + +import { Tabs, TabItem } from "@astrojs/starlight/components"; + +Wails provides a powerful key binding system that allows you to register global keyboard shortcuts that work across all windows in your application. This enables users to quickly access functionality without navigating through menus. + +## Accessing the Key Binding Manager + +The key binding manager is accessed through the `KeyBindings` property on your application instance: + +```go +app := application.New(application.Options{ + Name: "Keyboard Shortcuts Demo", +}) + +// Access the key binding manager +keyBindings := app.KeyBinding +``` + +## Adding Key Bindings + +### Basic Key Binding + +Register a simple keyboard shortcut: + +```go +app.KeyBinding.Add("Ctrl+S", func(window application.Window) { + // Handle save action + app.Logger.Info("Save shortcut triggered") + // Perform save operation... +}) +``` + +### Multiple Key Bindings + +Register multiple shortcuts for common operations: + +```go +// File operations +app.KeyBinding.Add("Ctrl+N", func(window application.Window) { + // New file + window.EmitEvent("file:new", nil) +}) + +app.KeyBinding.Add("Ctrl+O", func(window application.Window) { + // Open file + dialog := app.Dialog.OpenFile() + if file, err := dialog.PromptForSingleSelection(); err == nil { + window.EmitEvent("file:open", file) + } +}) + +app.KeyBinding.Add("Ctrl+S", func(window application.Window) { + // Save file + window.EmitEvent("file:save", nil) +}) + +// Edit operations +app.KeyBinding.Add("Ctrl+Z", func(window application.Window) { + // Undo + window.EmitEvent("edit:undo", nil) +}) + +app.KeyBinding.Add("Ctrl+Y", func(window application.Window) { + // Redo (Windows/Linux) + window.EmitEvent("edit:redo", nil) +}) + +app.KeyBinding.Add("Cmd+Shift+Z", func(window application.Window) { + // Redo (macOS) + window.EmitEvent("edit:redo", nil) +}) +``` + +## Key Binding Accelerators + +### Accelerator Format + +Key bindings use a standard accelerator format with modifiers and keys: + +```go +// Modifier keys +"Ctrl+S" // Control + S +"Cmd+S" // Command + S (macOS) +"Alt+F4" // Alt + F4 +"Shift+Ctrl+Z" // Shift + Control + Z + +// Function keys +"F1" // F1 key +"Ctrl+F5" // Control + F5 + +// Special keys +"Escape" // Escape key +"Enter" // Enter key +"Space" // Spacebar +"Tab" // Tab key +"Backspace" // Backspace key +"Delete" // Delete key + +// Arrow keys +"Up" // Up arrow +"Down" // Down arrow +"Left" // Left arrow +"Right" // Right arrow +``` + +### Platform-Specific Accelerators + +Handle platform differences for common shortcuts: + +```go +import "runtime" + +// Cross-platform save shortcut +if runtime.GOOS == "darwin" { + app.KeyBinding.Add("Cmd+S", saveHandler) +} else { + app.KeyBinding.Add("Ctrl+S", saveHandler) +} + +// Or register both +app.KeyBinding.Add("Ctrl+S", saveHandler) +app.KeyBinding.Add("Cmd+S", saveHandler) +``` + +## Managing Key Bindings + +### Removing Key Bindings + +Remove key bindings when they're no longer needed: + +```go +// Remove a specific key binding +app.KeyBinding.Remove("Ctrl+S") + +// Example: Temporary key binding for a modal +app.KeyBinding.Add("Escape", func(window application.Window) { + // Close modal + window.EmitEvent("modal:close", nil) + // Remove this temporary binding + app.KeyBinding.Remove("Escape") +}) +``` + +### Getting All Key Bindings + +Retrieve all registered key bindings: + +```go +allBindings := app.KeyBinding.GetAll() +for _, binding := range allBindings { + app.Logger.Info("Key binding", "accelerator", binding.Accelerator) +} +``` + +## Advanced Usage + +### Context-Aware Key Bindings + +Make key bindings context-aware by checking application state: + +```go +app.KeyBinding.Add("Ctrl+S", func(window application.Window) { + // Check current application state + if isEditMode() { + // Save document + saveDocument() + } else if isInSettings() { + // Save settings + saveSettings() + } else { + app.Logger.Info("Save not available in current context") + } +}) +``` + +### Window-Specific Actions + +Key bindings receive the active window, allowing window-specific behavior: + +```go +app.KeyBinding.Add("F11", func(window application.Window) { + // Toggle fullscreen for the active window + if window.Fullscreen() { + window.SetFullscreen(false) + } else { + window.SetFullscreen(true) + } +}) + +app.KeyBinding.Add("Ctrl+W", func(window application.Window) { + // Close the active window + window.Close() +}) +``` + +### Dynamic Key Binding Management + +Dynamically add and remove key bindings based on application state: + +```go +func enableEditMode() { + // Add edit-specific key bindings + app.KeyBinding.Add("Ctrl+B", func(window application.Window) { + window.EmitEvent("format:bold", nil) + }) + + app.KeyBinding.Add("Ctrl+I", func(window application.Window) { + window.EmitEvent("format:italic", nil) + }) + + app.KeyBinding.Add("Ctrl+U", func(window application.Window) { + window.EmitEvent("format:underline", nil) + }) +} + +func disableEditMode() { + // Remove edit-specific key bindings + app.KeyBinding.Remove("Ctrl+B") + app.KeyBinding.Remove("Ctrl+I") + app.KeyBinding.Remove("Ctrl+U") +} +``` + +## Platform Considerations + + + + + On macOS: + + - Use `Cmd` instead of `Ctrl` for standard shortcuts + - `Cmd+Q` is typically reserved for quitting the application + - `Cmd+H` hides the application + - `Cmd+M` minimizes windows + - Consider standard macOS keyboard shortcuts + + Common macOS patterns: + ```go + app.KeyBinding.Add("Cmd+N", newFileHandler) // New + app.KeyBinding.Add("Cmd+O", openFileHandler) // Open + app.KeyBinding.Add("Cmd+S", saveFileHandler) // Save + app.KeyBinding.Add("Cmd+Z", undoHandler) // Undo + app.KeyBinding.Add("Cmd+Shift+Z", redoHandler) // Redo + app.KeyBinding.Add("Cmd+C", copyHandler) // Copy + app.KeyBinding.Add("Cmd+V", pasteHandler) // Paste + ``` + + + + + + On Windows: + + - Use `Ctrl` for standard shortcuts + - `Alt+F4` closes applications + - `F1` typically opens help + - Consider Windows keyboard conventions + + Common Windows patterns: + ```go + app.KeyBinding.Add("Ctrl+N", newFileHandler) // New + app.KeyBinding.Add("Ctrl+O", openFileHandler) // Open + app.KeyBinding.Add("Ctrl+S", saveFileHandler) // Save + app.KeyBinding.Add("Ctrl+Z", undoHandler) // Undo + app.KeyBinding.Add("Ctrl+Y", redoHandler) // Redo + app.KeyBinding.Add("Ctrl+C", copyHandler) // Copy + app.KeyBinding.Add("Ctrl+V", pasteHandler) // Paste + app.KeyBinding.Add("F1", helpHandler) // Help + ``` + + + + + + On Linux: + + - Generally follows Windows conventions with `Ctrl` + - May vary by desktop environment + - Consider GNOME/KDE standard shortcuts + - Some desktop environments reserve certain shortcuts + + Common Linux patterns: + ```go + app.KeyBinding.Add("Ctrl+N", newFileHandler) // New + app.KeyBinding.Add("Ctrl+O", openFileHandler) // Open + app.KeyBinding.Add("Ctrl+S", saveFileHandler) // Save + app.KeyBinding.Add("Ctrl+Z", undoHandler) // Undo + app.KeyBinding.Add("Ctrl+Shift+Z", redoHandler) // Redo + app.KeyBinding.Add("Ctrl+C", copyHandler) // Copy + app.KeyBinding.Add("Ctrl+V", pasteHandler) // Paste + ``` + + + + +## Best Practices + +1. **Use Standard Shortcuts**: Follow platform conventions for common operations: + ```go + // Cross-platform save + if runtime.GOOS == "darwin" { + app.KeyBinding.Add("Cmd+S", saveHandler) + } else { + app.KeyBinding.Add("Ctrl+S", saveHandler) + } + ``` + +2. **Provide Visual Feedback**: Let users know when shortcuts are triggered: + ```go + app.KeyBinding.Add("Ctrl+S", func(window application.Window) { + saveDocument() + // Show brief notification + window.EmitEvent("notification:show", "Document saved") + }) + ``` + +3. **Handle Conflicts**: Be careful not to override important system shortcuts: + ```go + // Avoid overriding system shortcuts like: + // Ctrl+Alt+Del (Windows) + // Cmd+Space (macOS Spotlight) + // Alt+Tab (Window switching) + ``` + +4. **Document Shortcuts**: Provide help or documentation for available shortcuts: + ```go + app.KeyBinding.Add("F1", func(window application.Window) { + // Show help dialog with available shortcuts + showKeyboardShortcutsHelp() + }) + ``` + +5. **Clean Up**: Remove temporary key bindings when they're no longer needed: + ```go + func enterEditMode() { + app.KeyBinding.Add("Escape", exitEditModeHandler) + } + + func exitEditModeHandler(window application.Window) { + exitEditMode() + app.KeyBinding.Remove("Escape") // Clean up temporary binding + } + ``` + +## Complete Example + +Here's a complete example of a text editor with keyboard shortcuts: + +```go +package main + +import ( + "runtime" + "github.com/wailsapp/wails/v3/pkg/application" +) + +func main() { + app := application.New(application.Options{ + Name: "Text Editor with Shortcuts", + }) + + // File operations + if runtime.GOOS == "darwin" { + app.KeyBinding.Add("Cmd+N", func(window application.Window) { + window.EmitEvent("file:new", nil) + }) + app.KeyBinding.Add("Cmd+O", func(window application.Window) { + openFile(app, window) + }) + app.KeyBinding.Add("Cmd+S", func(window application.Window) { + window.EmitEvent("file:save", nil) + }) + } else { + app.KeyBinding.Add("Ctrl+N", func(window application.Window) { + window.EmitEvent("file:new", nil) + }) + app.KeyBinding.Add("Ctrl+O", func(window application.Window) { + openFile(app, window) + }) + app.KeyBinding.Add("Ctrl+S", func(window application.Window) { + window.EmitEvent("file:save", nil) + }) + } + + // View operations + app.KeyBinding.Add("F11", func(window application.Window) { + window.SetFullscreen(!window.Fullscreen()) + }) + + app.KeyBinding.Add("F1", func(window application.Window) { + showKeyboardShortcuts(window) + }) + + // Create main window + window := app.Window.New() + window.SetTitle("Text Editor") + + err := app.Run() + if err != nil { + panic(err) + } +} + +func openFile(app *application.App, window application.Window) { + dialog := app.Dialog.OpenFile() + dialog.AddFilter("Text Files", "*.txt;*.md") + + if file, err := dialog.PromptForSingleSelection(); err == nil { + window.EmitEvent("file:open", file) + } +} + +func showKeyboardShortcuts(window application.Window) { + shortcuts := ` +Keyboard Shortcuts: +- Ctrl/Cmd+N: New file +- Ctrl/Cmd+O: Open file +- Ctrl/Cmd+S: Save file +- F11: Toggle fullscreen +- F1: Show this help +` + window.EmitEvent("help:show", shortcuts) +} +``` + +:::tip[Pro Tip] +Test your key bindings on all target platforms to ensure they work correctly and don't conflict with system shortcuts. +::: + +:::danger[Warning] +Be careful not to override critical system shortcuts. Some key combinations are reserved by the operating system and cannot be captured by applications. +::: diff --git a/docs/src/content/docs/features/menus/application.mdx b/docs/src/content/docs/features/menus/application.mdx new file mode 100644 index 000000000..26b7e71a0 --- /dev/null +++ b/docs/src/content/docs/features/menus/application.mdx @@ -0,0 +1,683 @@ +--- +title: Application Menus +description: Create native menu bars for your desktop application +sidebar: + order: 1 +--- + +import { Card, CardGrid, Tabs, TabItem } from "@astrojs/starlight/components"; + +## The Problem + +Professional desktop applications need menu bars—File, Edit, View, Help. But menus work differently on each platform: +- **macOS**: Global menu bar at top of screen +- **Windows**: Menu bar in window title bar +- **Linux**: Varies by desktop environment + +Building platform-appropriate menus manually is tedious and error-prone. + +## The Wails Solution + +Wails provides a **unified API** that creates platform-native menus automatically. Write once, get native behaviour on all platforms. + +{/* VISUAL PLACEHOLDER: Menu Bar Comparison +Description: Three screenshots side-by-side showing the same Wails menu on: +1. macOS - Global menu bar at top of screen with app name +2. Windows - Menu bar in window title bar +3. Linux (GNOME) - Menu bar in window +All showing identical menu structure: File, Edit, View, Tools, Help +Style: Clean screenshots with subtle borders, labels indicating platform +*/} + +## Quick Start + +```go +package main + +import ( + "runtime" + "github.com/wailsapp/wails/v3/pkg/application" +) + +func main() { + app := application.New(application.Options{ + Name: "My App", + }) + + // Create menu + menu := app.NewMenu() + + // Add standard menus (platform-appropriate) + if runtime.GOOS == "darwin" { + menu.AddRole(application.AppMenu) // macOS only + } + menu.AddRole(application.FileMenu) + menu.AddRole(application.EditMenu) + menu.AddRole(application.WindowMenu) + menu.AddRole(application.HelpMenu) + + // Set the application menu + app.Menu.Set(menu) + + // Create window with UseApplicationMenu to inherit the menu on Windows/Linux + app.Window.NewWithOptions(application.WebviewWindowOptions{ + UseApplicationMenu: true, + }) + + app.Run() +} +``` + +**That's it!** You now have platform-native menus with standard items. The `UseApplicationMenu` option ensures Windows and Linux windows display the menu without additional code. + +## Creating Menus + +### Basic Menu Creation + +```go +// Create a new menu +menu := app.NewMenu() + +// Add a top-level menu +fileMenu := menu.AddSubmenu("File") + +// Add menu items +fileMenu.Add("New").OnClick(func(ctx *application.Context) { + // Handle New +}) + +fileMenu.Add("Open").OnClick(func(ctx *application.Context) { + // Handle Open +}) + +fileMenu.AddSeparator() + +fileMenu.Add("Quit").OnClick(func(ctx *application.Context) { + app.Quit() +}) +``` + +### Setting the Menu + +**Recommended approach** — Use `UseApplicationMenu` for cross-platform consistency: + +```go +// Set the application menu once +app.Menu.Set(menu) + +// Create windows that inherit the menu on Windows/Linux +app.Window.NewWithOptions(application.WebviewWindowOptions{ + UseApplicationMenu: true, // Window uses the app menu +}) +``` + +This approach: +- On **macOS**: The menu appears at the top of screen (standard behaviour) +- On **Windows/Linux**: Each window with `UseApplicationMenu: true` displays the app menu + +**Platform-specific details:** + + + + **Global menu bar** (one per application): + + ```go + app.Menu.Set(menu) + ``` + + The menu appears at the top of the screen and persists even when all windows are closed. The `UseApplicationMenu` option has no effect on macOS since all apps use the global menu. + + + + **Per-window menu bar**: + + ```go + // Option 1: Use application menu (recommended) + app.Menu.Set(menu) + window := app.Window.NewWithOptions(application.WebviewWindowOptions{ + UseApplicationMenu: true, + }) + + // Option 2: Set menu directly on window + window.SetMenu(menu) + ``` + + Each window can have its own menu, or inherit the application menu. The menu appears in the window's title bar. + + + + **Per-window menu bar** (usually): + + ```go + // Option 1: Use application menu (recommended) + app.Menu.Set(menu) + window := app.Window.NewWithOptions(application.WebviewWindowOptions{ + UseApplicationMenu: true, + }) + + // Option 2: Set menu directly on window + window.SetMenu(menu) + ``` + + Behaviour varies by desktop environment. Some (like Unity) support global menus. + + + +:::tip[Simplify Cross-Platform Menus] +Using `UseApplicationMenu: true` eliminates the need for platform-specific code like: +```go +// Old approach - no longer needed +if runtime.GOOS == "darwin" { + app.Menu.Set(menu) +} else { + window.SetMenu(menu) +} +``` +::: + +**Per-window custom menus:** + +If a window needs a different menu than the application menu, set it directly: + +```go +window.SetMenu(customMenu) // Overrides UseApplicationMenu +``` + +## Menu Roles + +Wails provides **predefined menu roles** that create platform-appropriate menu structures automatically. + +### Available Roles + +| Role | Description | Platform Notes | +|------|-------------|----------------| +| `AppMenu` | Application menu with About, Preferences, Quit | **macOS only** | +| `FileMenu` | File operations (New, Open, Save, etc.) | All platforms | +| `EditMenu` | Text editing (Undo, Redo, Cut, Copy, Paste) | All platforms | +| `WindowMenu` | Window management (Minimise, Zoom, etc.) | All platforms | +| `HelpMenu` | Help and information | All platforms | + +### Using Roles + +```go +menu := app.NewMenu() + +// macOS: Add application menu +if runtime.GOOS == "darwin" { + menu.AddRole(application.AppMenu) +} + +// All platforms: Add standard menus +menu.AddRole(application.FileMenu) +menu.AddRole(application.EditMenu) +menu.AddRole(application.WindowMenu) +menu.AddRole(application.HelpMenu) +``` + +**What you get:** + + + + **AppMenu** (with app name): + - About [App Name] + - Preferences... (⌘,) + - --- + - Services + - --- + - Hide [App Name] (⌘H) + - Hide Others (⌥⌘H) + - Show All + - --- + - Quit [App Name] (⌘Q) + + **FileMenu**: + - New (⌘N) + - Open... (⌘O) + - --- + - Close Window (⌘W) + + **EditMenu**: + - Undo (⌘Z) + - Redo (⇧⌘Z) + - --- + - Cut (⌘X) + - Copy (⌘C) + - Paste (⌘V) + - Select All (⌘A) + + **WindowMenu**: + - Minimise (⌘M) + - Zoom + - --- + - Bring All to Front + + **HelpMenu**: + - [App Name] Help + + + + **FileMenu**: + - New (Ctrl+N) + - Open... (Ctrl+O) + - --- + - Exit (Alt+F4) + + **EditMenu**: + - Undo (Ctrl+Z) + - Redo (Ctrl+Y) + - --- + - Cut (Ctrl+X) + - Copy (Ctrl+C) + - Paste (Ctrl+V) + - Select All (Ctrl+A) + + **WindowMenu**: + - Minimise + - Maximise + + **HelpMenu**: + - About [App Name] + + + + Similar to Windows, but keyboard shortcuts may vary by desktop environment. + + + +### Customising Role Menus + +Add items to role menus: + +```go +fileMenu := menu.AddRole(application.FileMenu) + +// Add custom items +fileMenu.Add("Import...").OnClick(handleImport) +fileMenu.Add("Export...").OnClick(handleExport) +``` + +## Custom Menus + +Create your own menus for application-specific features: + +```go +// Add a custom top-level menu +toolsMenu := menu.AddSubmenu("Tools") + +// Add items +toolsMenu.Add("Settings").OnClick(func(ctx *application.Context) { + showSettingsWindow() +}) + +toolsMenu.AddSeparator() + +// Add checkbox +toolsMenu.AddCheckbox("Dark Mode", false).OnClick(func(ctx *application.Context) { + isDark := ctx.ClickedMenuItem().Checked() + setTheme(isDark) +}) + +// Add radio group +toolsMenu.AddRadio("Small", true).OnClick(handleFontSize) +toolsMenu.AddRadio("Medium", false).OnClick(handleFontSize) +toolsMenu.AddRadio("Large", false).OnClick(handleFontSize) + +// Add submenu +advancedMenu := toolsMenu.AddSubmenu("Advanced") +advancedMenu.Add("Configure...").OnClick(showAdvancedSettings) +``` + +**For more menu item types**, see [Menu Reference](/features/menus/reference). + +## Dynamic Menus + +Update menus based on application state: + +### Enable/Disable Items + +```go +var saveMenuItem *application.MenuItem + +func createMenu() { + menu := app.NewMenu() + fileMenu := menu.AddSubmenu("File") + + saveMenuItem = fileMenu.Add("Save") + saveMenuItem.SetEnabled(false) // Initially disabled + saveMenuItem.OnClick(handleSave) + + app.SetMenu(menu) +} + +func onDocumentChanged() { + saveMenuItem.SetEnabled(hasUnsavedChanges()) + menu.Update() // Important! +} +``` + +:::caution[Always Call menu.Update()] +After changing menu state (enable/disable, label, checked), **always call `menu.Update()`**. This is especially critical on Windows where menus are reconstructed. + +See [Menu Reference](/features/menus/reference#enabled-state) for details. +::: + +### Change Labels + +```go +updateMenuItem := menu.Add("Check for Updates") + +updateMenuItem.OnClick(func(ctx *application.Context) { + updateMenuItem.SetLabel("Checking...") + menu.Update() + + checkForUpdates() + + updateMenuItem.SetLabel("Check for Updates") + menu.Update() +}) +``` + +### Rebuild Menus + +For major changes, rebuild the entire menu: + +```go +func rebuildFileMenu() { + menu := app.NewMenu() + fileMenu := menu.AddSubmenu("File") + + fileMenu.Add("New").OnClick(handleNew) + fileMenu.Add("Open").OnClick(handleOpen) + + // Add recent files dynamically + if hasRecentFiles() { + recentMenu := fileMenu.AddSubmenu("Open Recent") + for _, file := range getRecentFiles() { + filePath := file // Capture for closure + recentMenu.Add(filepath.Base(file)).OnClick(func(ctx *application.Context) { + openFile(filePath) + }) + } + recentMenu.AddSeparator() + recentMenu.Add("Clear Recent").OnClick(clearRecentFiles) + } + + fileMenu.AddSeparator() + fileMenu.Add("Quit").OnClick(func(ctx *application.Context) { + app.Quit() + }) + + app.SetMenu(menu) +} +``` + +## Window Control from Menus + +Menu items can control windows: + +```go +viewMenu := menu.AddSubmenu("View") + +// Toggle fullscreen +viewMenu.Add("Toggle Fullscreen").OnClick(func(ctx *application.Context) { + window := app.GetWindowByName("main") + window.SetFullscreen(!window.IsFullscreen()) +}) + +// Zoom controls +viewMenu.Add("Zoom In").SetAccelerator("CmdOrCtrl++").OnClick(func(ctx *application.Context) { + // Increase zoom +}) + +viewMenu.Add("Zoom Out").SetAccelerator("CmdOrCtrl+-").OnClick(func(ctx *application.Context) { + // Decrease zoom +}) + +viewMenu.Add("Reset Zoom").SetAccelerator("CmdOrCtrl+0").OnClick(func(ctx *application.Context) { + // Reset zoom +}) +``` + +**Get the active window:** + +```go +menuItem.OnClick(func(ctx *application.Context) { + window := application.ContextWindow(ctx) + // Use window +}) +``` + +## Platform-Specific Considerations + +### macOS + +**Menu bar behaviour:** +- Appears at **top of screen** (global) +- Persists when all windows closed +- First menu is **always the application menu** +- Use `menu.AddRole(application.AppMenu)` for standard items + +**Standard locations:** +- **About**: Application menu +- **Preferences**: Application menu (⌘,) +- **Quit**: Application menu (⌘Q) +- **Help**: Help menu + +**Example:** + +```go +if runtime.GOOS == "darwin" { + menu.AddRole(application.AppMenu) // Adds About, Preferences, Quit + + // Don't add Quit to File menu on macOS + // Don't add About to Help menu on macOS +} +``` + +### Windows + +**Menu bar behaviour:** +- Appears in **window title bar** +- Each window has its own menu +- No application menu + +**Standard locations:** +- **Exit**: File menu (Alt+F4) +- **Settings**: Tools or Edit menu +- **About**: Help menu + +**Example:** + +```go +if runtime.GOOS == "windows" { + fileMenu := menu.AddRole(application.FileMenu) + // Exit is added automatically + + helpMenu := menu.AddRole(application.HelpMenu) + // About is added automatically +} +``` + +### Linux + +**Menu bar behaviour:** +- Usually per-window (like Windows) +- Some DEs support global menus (Unity, GNOME with extension) +- Appearance varies by desktop environment + +**Best practice:** Follow Windows conventions, test on target DEs. + +## Complete Example + +Here's a production-ready menu structure: + +```go +package main + +import ( + "runtime" + "github.com/wailsapp/wails/v3/pkg/application" +) + +func main() { + app := application.New(application.Options{ + Name: "My Application", + }) + + // Create and set menu + createMenu(app) + + // Create main window with UseApplicationMenu for cross-platform menu support + app.Window.NewWithOptions(application.WebviewWindowOptions{ + UseApplicationMenu: true, + }) + + app.Run() +} + +func createMenu(app *application.Application) { + menu := app.NewMenu() + + // Platform-specific application menu (macOS only) + if runtime.GOOS == "darwin" { + menu.AddRole(application.AppMenu) + } + + // File menu + fileMenu := menu.AddRole(application.FileMenu) + fileMenu.Add("Import...").SetAccelerator("CmdOrCtrl+I").OnClick(handleImport) + fileMenu.Add("Export...").SetAccelerator("CmdOrCtrl+E").OnClick(handleExport) + + // Edit menu + menu.AddRole(application.EditMenu) + + // View menu + viewMenu := menu.AddSubmenu("View") + viewMenu.Add("Toggle Fullscreen").SetAccelerator("F11").OnClick(toggleFullscreen) + viewMenu.AddSeparator() + viewMenu.AddCheckbox("Show Sidebar", true).OnClick(toggleSidebar) + viewMenu.AddCheckbox("Show Toolbar", true).OnClick(toggleToolbar) + + // Tools menu + toolsMenu := menu.AddSubmenu("Tools") + + // Settings location varies by platform + if runtime.GOOS == "darwin" { + // On macOS, Preferences is in Application menu (added by AppMenu role) + } else { + toolsMenu.Add("Settings").SetAccelerator("CmdOrCtrl+,").OnClick(showSettings) + } + + toolsMenu.AddSeparator() + toolsMenu.AddCheckbox("Dark Mode", false).OnClick(toggleDarkMode) + + // Window menu + menu.AddRole(application.WindowMenu) + + // Help menu + helpMenu := menu.AddRole(application.HelpMenu) + helpMenu.Add("Documentation").OnClick(openDocumentation) + + // About location varies by platform + if runtime.GOOS == "darwin" { + // On macOS, About is in Application menu (added by AppMenu role) + } else { + helpMenu.AddSeparator() + helpMenu.Add("About").OnClick(showAbout) + } + + // Set the application menu + app.Menu.Set(menu) +} + +func handleImport(ctx *application.Context) { + // Implementation +} + +func handleExport(ctx *application.Context) { + // Implementation +} + +func toggleFullscreen(ctx *application.Context) { + window := application.ContextWindow(ctx) + window.SetFullscreen(!window.IsFullscreen()) +} + +func toggleSidebar(ctx *application.Context) { + // Implementation +} + +func toggleToolbar(ctx *application.Context) { + // Implementation +} + +func showSettings(ctx *application.Context) { + // Implementation +} + +func toggleDarkMode(ctx *application.Context) { + isDark := ctx.ClickedMenuItem().Checked() + // Apply theme +} + +func openDocumentation(ctx *application.Context) { + // Open browser +} + +func showAbout(ctx *application.Context) { + // Show about dialog +} +``` + +## Best Practices + +### ✅ Do + +- **Use menu roles** for standard menus (File, Edit, etc.) +- **Follow platform conventions** for menu structure +- **Add keyboard shortcuts** to common actions +- **Call menu.Update()** after changing menu state +- **Test on all platforms** - behaviour varies +- **Keep menus shallow** - 2-3 levels maximum +- **Use clear labels** - "Save Project" not "Save" + +### ❌ Don't + +- **Don't hardcode platform shortcuts** - Use `CmdOrCtrl` +- **Don't put Quit in File menu on macOS** - It's in Application menu +- **Don't put About in Help menu on macOS** - It's in Application menu +- **Don't forget menu.Update()** - Menus won't work properly +- **Don't nest too deeply** - Users get lost +- **Don't use jargon** - Keep labels user-friendly + +## Next Steps + + + + Complete reference for menu item types and properties. + + [Learn More →](/features/menus/reference) + + + + Create right-click context menus. + + [Learn More →](/features/menus/context) + + + + Add system tray/menu bar integration. + + [Learn More →](/features/menus/systray) + + + + Common menu patterns and best practices. + + [Learn More →](/guides/patterns/menus) + + + +--- + +**Questions?** Ask in [Discord](https://discord.gg/JDdSxwjhGf) or check the [menu example](https://github.com/wailsapp/wails/tree/v3-alpha/v3/examples/menu). diff --git a/docs/src/content/docs/features/menus/context.mdx b/docs/src/content/docs/features/menus/context.mdx new file mode 100644 index 000000000..ab7eb630a --- /dev/null +++ b/docs/src/content/docs/features/menus/context.mdx @@ -0,0 +1,728 @@ +--- +title: Context Menus +description: Create right-click context menus for your application +sidebar: + order: 2 +--- + +import { Card, CardGrid, Tabs, TabItem } from "@astrojs/starlight/components"; + +## The Problem + +Users expect right-click menus with context-specific actions. Different elements need different menus: +- **Text**: Cut, Copy, Paste +- **Images**: Save, Copy, Open +- **Custom elements**: Application-specific actions + +Building context menus manually means handling mouse events, positioning, and platform differences. + +## The Wails Solution + +Wails provides **declarative context menus** using CSS properties. Associate menus with HTML elements, pass data, and handle clicks—all with native platform behaviour. + +## Quick Start + +**Go code:** + +```go +// Create context menu +contextMenu := app.NewContextMenu() +contextMenu.Add("Cut").OnClick(handleCut) +contextMenu.Add("Copy").OnClick(handleCopy) +contextMenu.Add("Paste").OnClick(handlePaste) + +// Register with ID +app.RegisterContextMenu("editor-menu", contextMenu) +``` + +**HTML:** + +```html + +``` + +**That's it!** Right-clicking the textarea shows your custom menu. + +## Creating Context Menus + +### Basic Context Menu + +```go +// Create menu +contextMenu := app.NewContextMenu() + +// Add items +contextMenu.Add("Cut").SetAccelerator("CmdOrCtrl+X").OnClick(func(ctx *application.Context) { + // Handle cut +}) + +contextMenu.Add("Copy").SetAccelerator("CmdOrCtrl+C").OnClick(func(ctx *application.Context) { + // Handle copy +}) + +contextMenu.Add("Paste").SetAccelerator("CmdOrCtrl+V").OnClick(func(ctx *application.Context) { + // Handle paste +}) + +// Register with unique ID +app.RegisterContextMenu("text-menu", contextMenu) +``` + +**Menu ID:** Must be unique. Used to associate menu with HTML elements. + +### With Submenus + +```go +contextMenu := app.NewContextMenu() + +// Add regular items +contextMenu.Add("Open").OnClick(handleOpen) +contextMenu.Add("Delete").OnClick(handleDelete) + +contextMenu.AddSeparator() + +// Add submenu +exportMenu := contextMenu.AddSubmenu("Export As") +exportMenu.Add("PNG").OnClick(exportPNG) +exportMenu.Add("JPEG").OnClick(exportJPEG) +exportMenu.Add("SVG").OnClick(exportSVG) + +app.RegisterContextMenu("image-menu", contextMenu) +``` + +### With Checkboxes and Radio Groups + +```go +contextMenu := app.NewContextMenu() + +// Checkbox +contextMenu.AddCheckbox("Show Grid", true).OnClick(func(ctx *application.Context) { + showGrid := ctx.ClickedMenuItem().Checked() + // Toggle grid +}) + +contextMenu.AddSeparator() + +// Radio group +contextMenu.AddRadio("Small", false).OnClick(handleSize) +contextMenu.AddRadio("Medium", true).OnClick(handleSize) +contextMenu.AddRadio("Large", false).OnClick(handleSize) + +app.RegisterContextMenu("view-menu", contextMenu) +``` + +**For all menu item types**, see [Menu Reference](/features/menus/reference). + +## Associating with HTML Elements + +Use CSS custom properties to attach context menus: + +### Basic Association + +```html +
      + Right-click me! +
      +``` + +**CSS property:** `--custom-contextmenu: ` + +### With Context Data + +Pass data from HTML to Go: + +```html +
      + Right-click this file +
      +``` + +**Go handler:** + +```go +contextMenu := app.NewContextMenu() +contextMenu.Add("Open").OnClick(func(ctx *application.Context) { + fileID := ctx.ContextMenuData() // "file-123" + openFile(fileID) +}) + +app.RegisterContextMenu("file-menu", contextMenu) +``` + +**CSS properties:** +- `--custom-contextmenu: ` - Which menu to show +- `--custom-contextmenu-data: ` - Data to pass to handlers + +### Dynamic Data + +Generate data dynamically in JavaScript: + +```html +
      + File.txt +
      + + +``` + +### Multiple Elements, Same Menu + +```html +
      + Document.pdf +
      + +
      + Image.png +
      + +
      + Video.mp4 +
      +``` + +**One menu, different data for each element.** + +## Context Data + +### Accessing Context Data + +```go +contextMenu.Add("Process").OnClick(func(ctx *application.Context) { + data := ctx.ContextMenuData() // Get data from HTML + + // Use the data + processItem(data) +}) +``` + +**Data type:** Always `string`. Parse as needed. + +### Passing Complex Data + +Use JSON for complex data: + +```html +
      + Image.png +
      +``` + +**Go handler:** + +```go +import "encoding/json" + +type ItemData struct { + ID int `json:"id"` + Type string `json:"type"` +} + +contextMenu.Add("Process").OnClick(func(ctx *application.Context) { + dataStr := ctx.ContextMenuData() + + var data ItemData + if err := json.Unmarshal([]byte(dataStr), &data); err != nil { + log.Printf("Invalid data: %v", err) + return + } + + processItem(data.ID, data.Type) +}) +``` + +:::caution[Security] +**Always validate context data** from the frontend. Users can manipulate CSS properties, so treat data as untrusted input. +::: + +### Validation Example + +```go +contextMenu.Add("Delete").OnClick(func(ctx *application.Context) { + fileID := ctx.ContextMenuData() + + // Validate + if !isValidFileID(fileID) { + log.Printf("Invalid file ID: %s", fileID) + return + } + + // Check permissions + if !canDeleteFile(fileID) { + showError("Permission denied") + return + } + + // Safe to proceed + deleteFile(fileID) +}) +``` + +## Default Context Menu + +The WebView provides a built-in context menu for standard operations (copy, paste, inspect). Control it with `--default-contextmenu`: + +### Hide Default Menu + +```html +
      + No default menu here +
      +``` + +**Use case:** Custom UI elements where default menu doesn't make sense. + +### Show Default Menu + +```html +
      + Default menu always shown +
      +``` + +**Use case:** Text areas, input fields, editable content. + +### Auto (Smart) Mode + +```html +
      + Smart context menu +
      +``` + +**Default behaviour.** Shows default menu when: +- Text is selected +- In text input fields +- In editable content (`contenteditable`) + +Hides default menu otherwise. + +### Combining Custom and Default + +```html + + +``` + +**Behaviour:** +1. Custom menu shows first +2. If custom menu is empty or not found, default menu shows +3. Both can coexist (platform-dependent) + +## Dynamic Context Menus + +Update menus based on application state: + +### Enable/Disable Items + +```go +var cutMenuItem *application.MenuItem +var copyMenuItem *application.MenuItem + +func createContextMenu() { + contextMenu := app.NewContextMenu() + + cutMenuItem = contextMenu.Add("Cut") + cutMenuItem.SetEnabled(false) // Initially disabled + cutMenuItem.OnClick(handleCut) + + copyMenuItem = contextMenu.Add("Copy") + copyMenuItem.SetEnabled(false) + copyMenuItem.OnClick(handleCopy) + + app.RegisterContextMenu("editor-menu", contextMenu) +} + +func onSelectionChanged(hasSelection bool) { + cutMenuItem.SetEnabled(hasSelection) + copyMenuItem.SetEnabled(hasSelection) + contextMenu.Update() // Important! +} +``` + +:::caution[Always Call Update()] +After changing menu state, **call `contextMenu.Update()`**. This is critical on Windows. + +See [Menu Reference](/features/menus/reference#enabled-state) for details. +::: + +### Change Labels + +```go +playMenuItem := contextMenu.Add("Play") + +playMenuItem.OnClick(func(ctx *application.Context) { + if isPlaying { + playMenuItem.SetLabel("Pause") + } else { + playMenuItem.SetLabel("Play") + } + contextMenu.Update() +}) +``` + +### Rebuild Menus + +For major changes, rebuild the entire menu: + +```go +func rebuildContextMenu(fileType string) { + contextMenu := app.NewContextMenu() + + // Common items + contextMenu.Add("Open").OnClick(handleOpen) + contextMenu.Add("Delete").OnClick(handleDelete) + + contextMenu.AddSeparator() + + // Type-specific items + switch fileType { + case "image": + contextMenu.Add("Edit Image").OnClick(editImage) + contextMenu.Add("Set as Wallpaper").OnClick(setWallpaper) + case "video": + contextMenu.Add("Play").OnClick(playVideo) + contextMenu.Add("Extract Audio").OnClick(extractAudio) + case "document": + contextMenu.Add("Print").OnClick(printDocument) + contextMenu.Add("Export PDF").OnClick(exportPDF) + } + + app.RegisterContextMenu("file-menu", contextMenu) +} +``` + +## Platform Behaviour + +Context menus are **platform-native**: + + + + **Native macOS context menus:** + - System animations and transitions + - Right-click = Control+Click (automatic) + - Adapts to system appearance (light/dark) + - Standard text operations in default menu + - Native scrolling for long menus + + **macOS conventions:** + - Use sentence case for menu items + - Use ellipsis (...) for items that open dialogs + - Common shortcuts: ⌘C (Copy), ⌘V (Paste) + + + + **Native Windows context menus:** + - Windows native style + - Follows Windows theme + - Standard Windows operations in default menu + - Touch and pen input support + + **Windows conventions:** + - Use title case for menu items + - Use ellipsis (...) for items that open dialogs + - Common shortcuts: Ctrl+C (Copy), Ctrl+V (Paste) + + + + **Desktop environment integration:** + - Adapts to desktop theme (GTK, Qt, etc.) + - Right-click behaviour follows system settings + - Default menu content varies by environment + - Positioning follows DE conventions + + **Linux considerations:** + - Test on target desktop environments + - GTK and Qt have different behaviours + - Some DEs customise context menus + + + +## Complete Example + +**Go code:** + +```go +package main + +import ( + "encoding/json" + "log" + "github.com/wailsapp/wails/v3/pkg/application" +) + +type FileData struct { + ID string `json:"id"` + Type string `json:"type"` + Name string `json:"name"` +} + +func main() { + app := application.New(application.Options{ + Name: "Context Menu Demo", + }) + + // Create file context menu + fileMenu := createFileMenu(app) + app.RegisterContextMenu("file-menu", fileMenu) + + // Create image context menu + imageMenu := createImageMenu(app) + app.RegisterContextMenu("image-menu", imageMenu) + + // Create text context menu + textMenu := createTextMenu(app) + app.RegisterContextMenu("text-menu", textMenu) + + app.Window.New() + app.Run() +} + +func createFileMenu(app *application.Application) *application.ContextMenu { + menu := app.NewContextMenu() + + menu.Add("Open").OnClick(func(ctx *application.Context) { + data := parseFileData(ctx.ContextMenuData()) + openFile(data.ID) + }) + + menu.Add("Rename").OnClick(func(ctx *application.Context) { + data := parseFileData(ctx.ContextMenuData()) + renameFile(data.ID) + }) + + menu.AddSeparator() + + menu.Add("Delete").OnClick(func(ctx *application.Context) { + data := parseFileData(ctx.ContextMenuData()) + deleteFile(data.ID) + }) + + return menu +} + +func createImageMenu(app *application.Application) *application.ContextMenu { + menu := app.NewContextMenu() + + menu.Add("View").OnClick(func(ctx *application.Context) { + data := parseFileData(ctx.ContextMenuData()) + viewImage(data.ID) + }) + + menu.Add("Edit").OnClick(func(ctx *application.Context) { + data := parseFileData(ctx.ContextMenuData()) + editImage(data.ID) + }) + + menu.AddSeparator() + + exportMenu := menu.AddSubmenu("Export As") + exportMenu.Add("PNG").OnClick(exportPNG) + exportMenu.Add("JPEG").OnClick(exportJPEG) + exportMenu.Add("WebP").OnClick(exportWebP) + + return menu +} + +func createTextMenu(app *application.Application) *application.ContextMenu { + menu := app.NewContextMenu() + + menu.Add("Cut").SetAccelerator("CmdOrCtrl+X").OnClick(handleCut) + menu.Add("Copy").SetAccelerator("CmdOrCtrl+C").OnClick(handleCopy) + menu.Add("Paste").SetAccelerator("CmdOrCtrl+V").OnClick(handlePaste) + + return menu +} + +func parseFileData(dataStr string) FileData { + var data FileData + if err := json.Unmarshal([]byte(dataStr), &data); err != nil { + log.Printf("Invalid file data: %v", err) + } + return data +} + +// Handler implementations... +func openFile(id string) { /* ... */ } +func renameFile(id string) { /* ... */ } +func deleteFile(id string) { /* ... */ } +func viewImage(id string) { /* ... */ } +func editImage(id string) { /* ... */ } +func exportPNG(ctx *application.Context) { /* ... */ } +func exportJPEG(ctx *application.Context) { /* ... */ } +func exportWebP(ctx *application.Context) { /* ... */ } +func handleCut(ctx *application.Context) { /* ... */ } +func handleCopy(ctx *application.Context) { /* ... */ } +func handlePaste(ctx *application.Context) { /* ... */ } +``` + +**HTML:** + +```html + + + + + + +

      Files

      + + +
      + 📄 Report.pdf +
      + + +
      + 🖼️ Photo.jpg +
      + +

      Text Editor

      + + + + +

      No Context Menu

      + + +
      + Right-click here - no menu appears +
      + + +``` + +## Best Practices + +### ✅ Do + +- **Keep menus focused** - Only relevant actions for the element +- **Validate context data** - Treat as untrusted input +- **Use clear labels** - "Delete File" not "Delete" +- **Call menu.Update()** - After changing menu state +- **Test on all platforms** - Behaviour varies +- **Provide keyboard shortcuts** - For common actions +- **Group related items** - Use separators + +### ❌ Don't + +- **Don't trust context data** - Always validate +- **Don't make menus too long** - 7-10 items maximum +- **Don't forget menu.Update()** - Menus won't work properly +- **Don't nest too deeply** - 2 levels maximum +- **Don't use jargon** - Keep labels user-friendly +- **Don't block handlers** - Keep them fast + +## Troubleshooting + +### Context Menu Not Appearing + +**Possible causes:** +1. Menu ID mismatch +2. CSS property typo +3. Runtime not initialised + +**Solution:** + +```go +// Check menu is registered +app.RegisterContextMenu("my-menu", contextMenu) +``` + +```html + +
      +``` + +### Context Data Not Received + +**Possible causes:** +1. CSS property not set +2. Data contains special characters + +**Solution:** + +```html + +
      +``` + +Or use JavaScript: + +```javascript +element.style.setProperty('--custom-contextmenu-data', JSON.stringify(data)) +``` + +### Menu Items Not Responding + +**Cause:** Forgot to call `menu.Update()` after enabling + +**Solution:** + +```go +menuItem.SetEnabled(true) +contextMenu.Update() // Add this! +``` + +## Next Steps + + + + Complete reference for menu item types and properties. + + [Learn More →](/features/menus/reference) + + + + Create application menu bars. + + [Learn More →](/features/menus/application) + + + + Add system tray/menu bar integration. + + [Learn More →](/features/menus/systray) + + + + Common menu patterns and best practices. + + [Learn More →](/guides/patterns/menus) + + + +--- + +**Questions?** Ask in [Discord](https://discord.gg/JDdSxwjhGf) or check the [context menu example](https://github.com/wailsapp/wails/tree/v3-alpha/v3/examples/contextmenus). diff --git a/docs/src/content/docs/features/menus/reference.mdx b/docs/src/content/docs/features/menus/reference.mdx new file mode 100644 index 000000000..93cc6b45a --- /dev/null +++ b/docs/src/content/docs/features/menus/reference.mdx @@ -0,0 +1,562 @@ +--- +title: Menu Reference +description: Complete reference for menu item types, properties, and methods +sidebar: + order: 4 +--- + +import { Tabs, TabItem } from "@astrojs/starlight/components"; + +## Menu Reference + +Complete reference for menu item types, properties, and dynamic behaviour. Build professional, responsive menus with checkboxes, radio groups, separators, and dynamic updates. + +## Menu Item Types + +### Regular Menu Items + +The most common type—displays text and triggers an action: + +```go +menuItem := menu.Add("Click Me") +menuItem.OnClick(func(ctx *application.Context) { + fmt.Println("Menu item clicked!") +}) +``` + +**Use for:** Commands, actions, opening windows + +### Checkboxes + +Toggle-able menu items with checked/unchecked state: + +```go +checkbox := menu.AddCheckbox("Enable Feature", true) // true = initially checked +checkbox.OnClick(func(ctx *application.Context) { + isChecked := ctx.ClickedMenuItem().Checked() + fmt.Printf("Feature is now: %v\n", isChecked) +}) +``` + +**Use for:** Boolean settings, feature toggles, view options + +**Important:** The checked state toggles automatically when clicked. + +### Radio Groups + +Mutually exclusive options—only one can be selected: + +```go +menu.AddRadio("Small", true) // true = initially selected +menu.AddRadio("Medium", false) +menu.AddRadio("Large", false) +``` + +**Use for:** Mutually exclusive choices (size, theme, mode) + +**How grouping works:** +- Adjacent radio items form a group automatically +- Selecting one deselects others in the group +- Separate groups with a separator or regular item + +**Example with multiple groups:** + +```go +// Group 1: Size +menu.AddRadio("Small", true) +menu.AddRadio("Medium", false) +menu.AddRadio("Large", false) + +menu.AddSeparator() + +// Group 2: Theme +menu.AddRadio("Light", true) +menu.AddRadio("Dark", false) +``` + +### Submenus + +Nested menu structures for organisation: + +```go +submenu := menu.AddSubmenu("More Options") +submenu.Add("Submenu Item 1").OnClick(func(ctx *application.Context) { + // Handle click +}) +submenu.Add("Submenu Item 2") +``` + +**Use for:** Grouping related items, reducing clutter + +**Nesting limit:** Most platforms support 2-3 levels. Avoid deeper nesting. + +### Separators + +Visual dividers between menu items: + +```go +menu.Add("Item 1") +menu.AddSeparator() +menu.Add("Item 2") +``` + +**Use for:** Grouping related items visually + +**Best practice:** Don't start or end menus with separators. + +## Menu Item Properties + +### Label + +The text displayed for the menu item: + +```go +menuItem := menu.Add("Initial Label") +menuItem.SetLabel("New Label") + +// Get current label +label := menuItem.Label() +``` + +**Dynamic labels:** + +```go +updateMenuItem := menu.Add("Check for Updates") +updateMenuItem.OnClick(func(ctx *application.Context) { + updateMenuItem.SetLabel("Checking...") + menu.Update() // Important on Windows! + + // Perform update check + checkForUpdates() + + updateMenuItem.SetLabel("Check for Updates") + menu.Update() +}) +``` + +### Enabled State + +Control whether the menu item can be interacted with: + +```go +menuItem := menu.Add("Save") +menuItem.SetEnabled(false) // Greyed out, can't click + +// Enable it later +menuItem.SetEnabled(true) +menu.Update() // Important: Call this after changing enabled state! + +// Check current state +isEnabled := menuItem.Enabled() +``` + +:::caution[Windows Menu Behaviour] +On Windows, menus need to be reconstructed when their state changes. **Always call `menu.Update()` after enabling/disabling menu items**, especially if the item was created whilst disabled. + +**Why:** Windows menus are rebuilt from scratch when updated. If you don't call `Update()`, click handlers won't fire properly. +::: + +**Example: Dynamic enable/disable** + +```go +var hasSelection bool + +cutMenuItem := menu.Add("Cut") +cutMenuItem.SetEnabled(false) // Initially disabled + +copyMenuItem := menu.Add("Copy") +copyMenuItem.SetEnabled(false) + +// When selection changes +func onSelectionChanged(selected bool) { + hasSelection = selected + cutMenuItem.SetEnabled(hasSelection) + copyMenuItem.SetEnabled(hasSelection) + menu.Update() // Critical on Windows! +} +``` + +**Common pattern: Enable on condition** + +```go +saveMenuItem := menu.Add("Save") + +func updateSaveMenuItem() { + canSave := hasUnsavedChanges() && !isSaving() + saveMenuItem.SetEnabled(canSave) + menu.Update() +} + +// Call whenever state changes +onDocumentChanged(func() { + updateSaveMenuItem() +}) +``` + +### Checked State + +For checkbox and radio items, control or query their checked state: + +```go +checkbox := menu.AddCheckbox("Feature", false) +checkbox.SetChecked(true) +menu.Update() + +// Query state +isChecked := checkbox.Checked() +``` + +**Auto-toggle:** Checkboxes toggle automatically when clicked. You don't need to call `SetChecked()` in the click handler. + +**Manual control:** + +```go +checkbox := menu.AddCheckbox("Auto-save", false) + +// Sync with external state +func syncAutoSave(enabled bool) { + checkbox.SetChecked(enabled) + menu.Update() +} +``` + +### Accelerators (Keyboard Shortcuts) + +Add keyboard shortcuts to menu items: + +```go +saveMenuItem := menu.Add("Save") +saveMenuItem.SetAccelerator("CmdOrCtrl+S") + +quitMenuItem := menu.Add("Quit") +quitMenuItem.SetAccelerator("CmdOrCtrl+Q") +``` + +**Accelerator format:** +- `CmdOrCtrl` - Cmd on macOS, Ctrl on Windows/Linux +- `Shift`, `Alt`, `Option` - Modifier keys +- `A-Z`, `0-9` - Letter/number keys +- `F1-F12` - Function keys +- `Enter`, `Space`, `Backspace`, etc. - Special keys + +**Examples:** + +```go +"CmdOrCtrl+S" // Save +"CmdOrCtrl+Shift+S" // Save As +"CmdOrCtrl+W" // Close Window +"CmdOrCtrl+Q" // Quit +"F5" // Refresh +"CmdOrCtrl+," // Preferences (macOS convention) +"Alt+F4" // Close (Windows convention) +``` + +**Platform-specific accelerators:** + +```go +if runtime.GOOS == "darwin" { + prefsMenuItem.SetAccelerator("Cmd+,") +} else { + prefsMenuItem.SetAccelerator("Ctrl+P") +} +``` + +### Tooltip + +Add hover text to menu items (platform support varies): + +```go +menuItem := menu.Add("Advanced Options") +menuItem.SetTooltip("Configure advanced settings") +``` + +**Platform support:** +- **Windows:** ✅ Supported +- **macOS:** ❌ Not supported (tooltips not standard for menus) +- **Linux:** ⚠️ Varies by desktop environment + +### Hidden State + +Hide menu items without removing them: + +```go +debugMenuItem := menu.Add("Debug Mode") +debugMenuItem.SetHidden(true) // Hidden + +// Show in debug builds +if isDebugBuild { + debugMenuItem.SetHidden(false) + menu.Update() +} +``` + +**Use for:** Debug options, feature flags, conditional features + +## Event Handling + +### OnClick Handler + +Execute code when menu item is clicked: + +```go +menuItem := menu.Add("Click Me") +menuItem.OnClick(func(ctx *application.Context) { + // Handle click + fmt.Println("Clicked!") +}) +``` + +**Context provides:** +- `ctx.ClickedMenuItem()` - The menu item that was clicked +- Window context (if from window menu) +- Application context + +**Example: Access menu item in handler** + +```go +checkbox := menu.AddCheckbox("Feature", false) +checkbox.OnClick(func(ctx *application.Context) { + item := ctx.ClickedMenuItem() + isChecked := item.Checked() + fmt.Printf("Feature is now: %v\n", isChecked) +}) +``` + +### Multiple Handlers + +You can set multiple handlers (last one wins): + +```go +menuItem := menu.Add("Action") +menuItem.OnClick(func(ctx *application.Context) { + fmt.Println("First handler") +}) + +// This replaces the first handler +menuItem.OnClick(func(ctx *application.Context) { + fmt.Println("Second handler - this one runs") +}) +``` + +**Best practice:** Set handler once, use conditional logic inside if needed. + +## Dynamic Menus + +### Updating Menu Items + +**The golden rule:** Always call `menu.Update()` after changing menu state. + +```go +// ✅ Correct +menuItem.SetEnabled(true) +menu.Update() + +// ❌ Wrong (especially on Windows) +menuItem.SetEnabled(true) +// Forgot to call Update() - click handlers may not work! +``` + +**Why this matters:** +- **Windows:** Menus are reconstructed when updated +- **macOS/Linux:** Less critical but still recommended +- **Click handlers:** Won't fire properly without Update() + +### Rebuilding Menus + +For major changes, rebuild the entire menu: + +```go +func rebuildFileMenu() { + menu := app.Menu.New() + + menu.Add("New").OnClick(handleNew) + menu.Add("Open").OnClick(handleOpen) + + if hasRecentFiles() { + recentMenu := menu.AddSubmenu("Open Recent") + for _, file := range getRecentFiles() { + recentMenu.Add(file).OnClick(func(ctx *application.Context) { + openFile(file) + }) + } + } + + menu.AddSeparator() + menu.Add("Quit").OnClick(handleQuit) + + // Set the new menu + window.SetMenu(menu) +} +``` + +**When to rebuild:** +- Recent files list changes +- Plugin menus change +- Major state transitions + +**When to update:** +- Enable/disable items +- Change labels +- Toggle checkboxes + +### Context-Sensitive Menus + +Adjust menus based on application state: + +```go +func updateEditMenu() { + cutMenuItem.SetEnabled(hasSelection()) + copyMenuItem.SetEnabled(hasSelection()) + pasteMenuItem.SetEnabled(hasClipboardContent()) + undoMenuItem.SetEnabled(canUndo()) + redoMenuItem.SetEnabled(canRedo()) + menu.Update() +} + +// Call whenever state changes +onSelectionChanged(updateEditMenu) +onClipboardChanged(updateEditMenu) +onUndoStackChanged(updateEditMenu) +``` + +## Platform Differences + +### Menu Bar Location + +| Platform | Location | Notes | +|----------|----------|-------| +| **macOS** | Top of screen | Global menu bar | +| **Windows** | Top of window | Per-window menu | +| **Linux** | Top of window | Per-window (usually) | + +### Standard Menus + +**macOS:** +- Has "Application" menu (with app name) +- "Preferences" in Application menu +- "Quit" in Application menu + +**Windows/Linux:** +- No Application menu +- "Preferences" in Edit or Tools menu +- "Exit" in File menu + +**Example: Platform-appropriate structure** + +```go +menu := app.Menu.New() + +// macOS gets Application menu +if runtime.GOOS == "darwin" { + menu.AddRole(application.AppMenu) +} + +// File menu +fileMenu := menu.AddSubmenu("File") +fileMenu.Add("New") +fileMenu.Add("Open") + +// Preferences location varies +if runtime.GOOS == "darwin" { + // On macOS, preferences are in Application menu (added by AppMenu role) +} else { + // On Windows/Linux, add to Edit or Tools menu + editMenu := menu.AddSubmenu("Edit") + editMenu.Add("Preferences") +} +``` + +### Accelerator Conventions + +**macOS:** +- `Cmd+` for most shortcuts +- `Cmd+,` for Preferences +- `Cmd+Q` for Quit + +**Windows:** +- `Ctrl+` for most shortcuts +- `Ctrl+P` or `Ctrl+,` for Preferences +- `Alt+F4` for Exit (or `Ctrl+Q`) + +**Linux:** +- Generally follows Windows conventions +- Desktop environment may override + +## Best Practices + +### ✅ Do + +- **Call menu.Update()** after changing menu state (especially on Windows) +- **Use radio groups** for mutually exclusive options +- **Use checkboxes** for toggleable features +- **Add accelerators** to common actions +- **Group related items** with separators +- **Test on all platforms** - behaviour varies + +### ❌ Don't + +- **Don't forget menu.Update()** - Click handlers won't work properly +- **Don't nest too deeply** - 2-3 levels maximum +- **Don't start/end with separators** - Looks unprofessional +- **Don't use tooltips on macOS** - Not supported +- **Don't hardcode platform shortcuts** - Use `CmdOrCtrl` + +## Troubleshooting + +### Menu Items Not Responding + +**Symptom:** Click handlers don't fire + +**Cause:** Forgot to call `menu.Update()` after enabling item + +**Solution:** + +```go +menuItem.SetEnabled(true) +menu.Update() // Add this! +``` + +### Menu Items Greyed Out + +**Symptom:** Can't click menu items + +**Cause:** Items are disabled + +**Solution:** + +```go +menuItem.SetEnabled(true) +menu.Update() +``` + +### Accelerators Not Working + +**Symptom:** Keyboard shortcuts don't trigger menu items + +**Causes:** +1. Accelerator format incorrect +2. Conflict with system shortcuts +3. Window doesn't have focus + +**Solution:** + +```go +// Check format +menuItem.SetAccelerator("CmdOrCtrl+S") // ✅ Correct +menuItem.SetAccelerator("Ctrl+S") // ❌ Wrong (macOS uses Cmd) + +// Avoid conflicts +// ❌ Cmd+H (Hide Window on macOS - system shortcut) +// ✅ Cmd+Shift+H (Custom shortcut) +``` + +## Next Steps + +- [Application Menus](/features/menus/application) - Create application menu bars +- [Context Menus](/features/menus/context) - Right-click context menus +- [System Tray Menus](/features/menus/systray) - System tray/menu bar menus +- [Menu Patterns](/guides/patterns/menus) - Common menu patterns and best practices + +--- + +**Questions?** Ask in [Discord](https://discord.gg/JDdSxwjhGf) or check the [menu examples](https://github.com/wailsapp/wails/tree/v3-alpha/v3/examples/menu). diff --git a/docs/src/content/docs/features/menus/systray.mdx b/docs/src/content/docs/features/menus/systray.mdx new file mode 100644 index 000000000..a0c8a722b --- /dev/null +++ b/docs/src/content/docs/features/menus/systray.mdx @@ -0,0 +1,713 @@ +--- +title: System Tray Menus +description: Add system tray (notification area) integration to your application +sidebar: + order: 3 +--- + +import { Tabs, TabItem, Card, CardGrid } from "@astrojs/starlight/components"; + +## System Tray Menus + +Wails provides **unified system tray APIs** that work across all platforms. Create tray icons with menus, attach windows, and handle clicks with native platform behaviour for background applications, services, and quick-access utilities. +{/* VISUAL PLACEHOLDER: System Tray Comparison +Description: Three screenshots showing the same Wails system tray icon on: +1. Windows - Notification area (bottom-right) +2. macOS - Menu bar (top-right) with label +3. Linux (GNOME) - Top bar +All showing the same icon and menu structure +Style: Clean screenshots with arrows pointing to tray icon, menu expanded +*/} + +## Quick Start + +```go +package main + +import ( + _ "embed" + "github.com/wailsapp/wails/v3/pkg/application" +) + +//go:embed assets/icon.png +var icon []byte + +func main() { + app := application.New(application.Options{ + Name: "Tray App", + }) + + // Create system tray + systray := app.SystemTray.New() + systray.SetIcon(icon) + systray.SetLabel("My App") + + // Add menu + menu := app.NewMenu() + menu.Add("Show").OnClick(func(ctx *application.Context) { + // Show main window + }) + menu.Add("Quit").OnClick(func(ctx *application.Context) { + app.Quit() + }) + systray.SetMenu(menu) + + // Create hidden window + window := app.Window.New() + window.Hide() + + app.Run() +} +``` + +**Result:** System tray icon with menu on all platforms. + +## Creating a System Tray + +### Basic System Tray + +```go +// Create system tray +systray := app.SystemTray.New() + +// Set icon +systray.SetIcon(iconBytes) + +// Set label (macOS) / tooltip (Windows) +systray.SetLabel("My Application") +``` + +### With Icon + +Icons should be embedded: + +```go +import _ "embed" + +//go:embed assets/icon.png +var icon []byte + +//go:embed assets/icon-dark.png +var iconDark []byte + +func main() { + app := application.New(application.Options{ + Name: "My App", + }) + + systray := app.SystemTray.New() + systray.SetIcon(icon) + systray.SetDarkModeIcon(iconDark) // macOS dark mode + + app.Run() +} +``` + +**Icon requirements:** + +| Platform | Size | Format | Notes | +|----------|------|--------|-------| +| **Windows** | 16x16 or 32x32 | PNG, ICO | Notification area | +| **macOS** | 18x18 to 22x22 | PNG | Menu bar, template recommended | +| **Linux** | 22x22 to 48x48 | PNG, SVG | Varies by DE | + +### Template Icons (macOS) + +Template icons adapt to light/dark mode automatically: + +```go +systray.SetTemplateIcon(iconBytes) +``` + +**Template icon guidelines:** +- Use black and clear (transparent) colours only +- Black becomes white in dark mode +- Name file with `Template` suffix: `iconTemplate.png` +- [Design guide](https://bjango.com/articles/designingmenubarextras/) + +## Adding Menus + +System tray menus work like application menus: + +```go +menu := app.NewMenu() + +// Add items +menu.Add("Open").OnClick(func(ctx *application.Context) { + showMainWindow() +}) + +menu.AddSeparator() + +menu.AddCheckbox("Start at Login", false).OnClick(func(ctx *application.Context) { + enabled := ctx.ClickedMenuItem().Checked() + setStartAtLogin(enabled) +}) + +menu.AddSeparator() + +menu.Add("Quit").OnClick(func(ctx *application.Context) { + app.Quit() +}) + +// Set menu +systray.SetMenu(menu) +``` + +**For all menu item types**, see [Menu Reference](/features/menus/reference). + +## Attaching Windows + +Attach a window to the tray icon for automatic show/hide: + +```go +// Create window +window := app.Window.New() + +// Attach to tray +systray.AttachWindow(window) + +// Configure behaviour +systray.SetWindowOffset(10) // Pixels from tray icon +systray.SetWindowDebounce(200 * time.Millisecond) // Click debounce +``` + +**Behaviour:** +- Window starts hidden +- **Left-click tray icon** → Toggle window visibility +- **Right-click tray icon** → Show menu (if set) +- Window positioned near tray icon + +**Example: Popup window** + +```go +window := app.Window.NewWithOptions(application.WebviewWindowOptions{ + Title: "Quick Access", + Width: 300, + Height: 400, + Frameless: true, // No title bar + AlwaysOnTop: true, // Stay on top +}) + +systray.AttachWindow(window) +systray.SetWindowOffset(5) +``` + +## Click Handlers + +Handle tray icon clicks: + +```go +systray := app.SystemTray.New() + +// Left click +systray.OnClick(func() { + fmt.Println("Tray icon clicked") +}) + +// Right click +systray.OnRightClick(func() { + fmt.Println("Tray icon right-clicked") +}) + +// Double click +systray.OnDoubleClick(func() { + fmt.Println("Tray icon double-clicked") +}) + +// Mouse enter/leave +systray.OnMouseEnter(func() { + fmt.Println("Mouse entered tray icon") +}) + +systray.OnMouseLeave(func() { + fmt.Println("Mouse left tray icon") +}) +``` + +**Platform support:** + +| Event | Windows | macOS | Linux | +|-------|---------|-------|-------| +| OnClick | ✅ | ✅ | ✅ | +| OnRightClick | ✅ | ✅ | ✅ | +| OnDoubleClick | ✅ | ✅ | ⚠️ Varies | +| OnMouseEnter | ✅ | ✅ | ⚠️ Varies | +| OnMouseLeave | ✅ | ✅ | ⚠️ Varies | + +## Dynamic Updates + +Update tray icon and menu dynamically: + +### Change Icon + +```go +var isActive bool + +func updateTrayIcon() { + if isActive { + systray.SetIcon(activeIcon) + systray.SetLabel("Active") + } else { + systray.SetIcon(inactiveIcon) + systray.SetLabel("Inactive") + } +} +``` + +### Update Menu + +```go +var isPaused bool + +pauseMenuItem := menu.Add("Pause") + +pauseMenuItem.OnClick(func(ctx *application.Context) { + isPaused = !isPaused + + if isPaused { + pauseMenuItem.SetLabel("Resume") + } else { + pauseMenuItem.SetLabel("Pause") + } + + menu.Update() // Important! +}) +``` + +:::caution[Always Call Update()] +After changing menu state, **call `menu.Update()`**. See [Menu Reference](/features/menus/reference#enabled-state). +::: + +### Rebuild Menu + +For major changes, rebuild the entire menu: + +```go +func rebuildTrayMenu(status string) { + menu := app.NewMenu() + + // Status-specific items + switch status { + case "syncing": + menu.Add("Syncing...").SetEnabled(false) + menu.Add("Pause Sync").OnClick(pauseSync) + case "synced": + menu.Add("Up to date ✓").SetEnabled(false) + menu.Add("Sync Now").OnClick(startSync) + case "error": + menu.Add("Sync Error").SetEnabled(false) + menu.Add("Retry").OnClick(retrySync) + } + + menu.AddSeparator() + menu.Add("Quit").OnClick(func(ctx *application.Context) { + app.Quit() + }) + + systray.SetMenu(menu) +} +``` + +## Platform-Specific Features + + + + **Menu bar integration:** + + ```go + // Set label (appears next to icon) + systray.SetLabel("My App") + + // Use template icon (adapts to dark mode) + systray.SetTemplateIcon(iconBytes) + + // Set icon position + systray.SetIconPosition(application.IconPositionRight) + ``` + + **Icon positions:** + - `IconPositionLeft` - Icon left of label + - `IconPositionRight` - Icon right of label + - `IconPositionOnly` - Icon only, no label + - `IconPositionNone` - Label only, no icon + + **Best practices:** + - Use template icons (black + transparent) + - Keep labels short (3-5 characters) + - 18x18 to 22x22 pixels for Retina displays + - Test in both light and dark modes + + + + **Notification area integration:** + + ```go + // Set tooltip (appears on hover) + systray.SetTooltip("My Application") + + // Or use SetLabel (same as tooltip on Windows) + systray.SetLabel("My Application") + + // Show/Hide functionality (fully functional) + systray.Show() // Show tray icon + systray.Hide() // Hide tray icon + ``` + + **Icon requirements:** + - 16x16 or 32x32 pixels + - PNG or ICO format + - Transparent background + + **Tooltip limits:** + - Maximum 127 UTF-16 characters + - Longer tooltips will be truncated + - Keep concise for best experience + + **Platform features:** + - Tray icon survives Windows Explorer restarts + - Show() and Hide() methods fully functional + - Proper lifecycle management + + **Best practices:** + - Use 32x32 for high-DPI displays + - Keep tooltips under 127 characters + - Test on different Windows versions + - Consider notification area overflow + - Use Show/Hide for conditional tray visibility + + + + **System tray integration:** + + Uses StatusNotifierItem specification (most modern DEs). + + ```go + systray.SetIcon(iconBytes) + systray.SetLabel("My App") + ``` + + **Desktop environment support:** + - **GNOME**: Top bar (with extension) + - **KDE Plasma**: System tray + - **XFCE**: Notification area + - **Others**: Varies + + **Best practices:** + - Use 22x22 or 24x24 pixels + - SVG icons scale better + - Test on target desktop environments + - Provide fallback for unsupported DEs + + + +## Complete Example + +Here's a production-ready system tray application: + +```go +package main + +import ( + _ "embed" + "fmt" + "time" + "github.com/wailsapp/wails/v3/pkg/application" +) + +//go:embed assets/icon.png +var icon []byte + +//go:embed assets/icon-active.png +var iconActive []byte + +type TrayApp struct { + app *application.Application + systray *application.SystemTray + window *application.WebviewWindow + menu *application.Menu + isActive bool +} + +func main() { + app := application.New(application.Options{ + Name: "Tray Application", + Mac: application.MacOptions{ + ApplicationShouldTerminateAfterLastWindowClosed: false, + }, + }) + + trayApp := &TrayApp{app: app} + trayApp.setup() + + app.Run() +} + +func (t *TrayApp) setup() { + // Create system tray + t.systray = t.app.SystemTray.New() + t.systray.SetIcon(icon) + t.systray.SetLabel("Inactive") + + // Create menu + t.createMenu() + + // Create window (hidden by default) + t.window = t.app.Window.NewWithOptions(application.WebviewWindowOptions{ + Title: "Tray Application", + Width: 400, + Height: 600, + Hidden: true, + }) + + // Attach window to tray + t.systray.AttachWindow(t.window) + t.systray.SetWindowOffset(10) + + // Handle tray clicks + t.systray.OnRightClick(func() { + t.systray.OpenMenu() + }) + + // Start background task + go t.backgroundTask() +} + +func (t *TrayApp) createMenu() { + t.menu = t.app.NewMenu() + + // Status item (disabled) + statusItem := t.menu.Add("Status: Inactive") + statusItem.SetEnabled(false) + + t.menu.AddSeparator() + + // Toggle active + t.menu.Add("Start").OnClick(func(ctx *application.Context) { + t.toggleActive() + }) + + // Show window + t.menu.Add("Show Window").OnClick(func(ctx *application.Context) { + t.window.Show() + t.window.SetFocus() + }) + + t.menu.AddSeparator() + + // Settings + t.menu.AddCheckbox("Start at Login", false).OnClick(func(ctx *application.Context) { + enabled := ctx.ClickedMenuItem().Checked() + t.setStartAtLogin(enabled) + }) + + t.menu.AddSeparator() + + // Quit + t.menu.Add("Quit").OnClick(func(ctx *application.Context) { + t.app.Quit() + }) + + t.systray.SetMenu(t.menu) +} + +func (t *TrayApp) toggleActive() { + t.isActive = !t.isActive + t.updateTray() +} + +func (t *TrayApp) updateTray() { + if t.isActive { + t.systray.SetIcon(iconActive) + t.systray.SetLabel("Active") + } else { + t.systray.SetIcon(icon) + t.systray.SetLabel("Inactive") + } + + // Rebuild menu with new status + t.createMenu() +} + +func (t *TrayApp) backgroundTask() { + ticker := time.NewTicker(5 * time.Second) + defer ticker.Stop() + + for range ticker.C { + if t.isActive { + fmt.Println("Background task running...") + // Do work + } + } +} + +func (t *TrayApp) setStartAtLogin(enabled bool) { + // Implementation varies by platform + fmt.Printf("Start at login: %v\n", enabled) +} +``` + +## Visibility Control + +Show/hide the tray icon dynamically: + +```go +// Hide tray icon +systray.Hide() + +// Show tray icon +systray.Show() + +// Check visibility +if systray.IsVisible() { + fmt.Println("Tray icon is visible") +} +``` + +**Platform Support:** + +| Platform | Hide() | Show() | Notes | +|----------|--------|--------|-------| +| **Windows** | ✅ | ✅ | Fully functional - icon appears/disappears from notification area | +| **macOS** | ✅ | ✅ | Menu bar item shows/hides | +| **Linux** | ✅ | ✅ | Varies by desktop environment | + +**Use cases:** +- Temporarily hide tray icon based on user preference +- Headless mode with tray icon appearing only when needed +- Toggle visibility based on application state + +**Example - Conditional Tray Visibility:** + +```go +func (t *TrayApp) setTrayVisibility(visible bool) { + if visible { + t.systray.Show() + } else { + t.systray.Hide() + } +} + +// Show tray only when updates are available +func (t *TrayApp) checkForUpdates() { + if hasUpdates { + t.systray.Show() + t.systray.SetLabel("Update Available") + } else { + t.systray.Hide() + } +} +``` + +## Cleanup + +Destroy the tray icon when done: + +```go +// In OnShutdown +app := application.New(application.Options{ + OnShutdown: func() { + if systray != nil { + systray.Destroy() + } + }, +}) +``` + +**Important:** Always destroy system tray on shutdown to release resources. + +## Best Practices + +### ✅ Do + +- **Use template icons on macOS** - Adapts to dark mode +- **Keep labels short** - 3-5 characters maximum +- **Provide tooltips on Windows** - Helps users identify your app +- **Test on all platforms** - Behaviour varies +- **Handle clicks appropriately** - Left-click for main action, right-click for menu +- **Update icon for status** - Visual feedback is important +- **Destroy on shutdown** - Release resources + +### ❌ Don't + +- **Don't use large icons** - Follow platform guidelines +- **Don't use long labels** - Gets truncated +- **Don't forget dark mode** - Test on macOS dark mode +- **Don't block click handlers** - Keep them fast +- **Don't forget menu.Update()** - After changing menu state +- **Don't assume tray support** - Some Linux DEs don't support it + +## Troubleshooting + +### Tray Icon Not Appearing + +**Possible causes:** +1. Icon format not supported +2. Icon size too large/small +3. System tray not supported (Linux) + +**Solution:** + +```go +// Check if system tray is supported +if !application.SystemTraySupported() { + fmt.Println("System tray not supported") + // Fallback to window-only mode +} +``` + +### Icon Looks Wrong on macOS + +**Cause:** Not using template icon + +**Solution:** + +```go +// Use template icon +systray.SetTemplateIcon(iconBytes) + +// Or design icon as template (black + transparent) +``` + +### Menu Not Updating + +**Cause:** Forgot to call `menu.Update()` + +**Solution:** + +```go +menuItem.SetLabel("New Label") +menu.Update() // Add this! +``` + +## Next Steps + + + + Complete reference for menu item types and properties. + + [Learn More →](/features/menus/reference) + + + + Create application menu bars. + + [Learn More →](/features/menus/application) + + + + Create right-click context menus. + + [Learn More →](/features/menus/context) + + + + Build a complete system tray application. + + [Learn More →](/tutorials/system-tray) + + + +--- + +**Questions?** Ask in [Discord](https://discord.gg/JDdSxwjhGf) or check the [system tray examples](https://github.com/wailsapp/wails/tree/v3-alpha/v3/examples/systray-basic). diff --git a/docs/src/content/docs/features/notifications/overview.mdx b/docs/src/content/docs/features/notifications/overview.mdx new file mode 100644 index 000000000..efacdd74f --- /dev/null +++ b/docs/src/content/docs/features/notifications/overview.mdx @@ -0,0 +1,307 @@ +--- +title: Notifications +description: Display native system notifications with action buttons and text input +sidebar: + order: 1 +--- + +import { Tabs, TabItem } from "@astrojs/starlight/components"; + +## Introduction + +Wails provides a comprehensive cross-platform notification system for desktop applications. This service allows you to display native system notifications, with support for interactive elements like action buttons and text input fields. + +## Basic Usage + +### Creating the Service + +First, initialize the notifications service: + +```go +import "github.com/wailsapp/wails/v3/pkg/application" +import "github.com/wailsapp/wails/v3/pkg/services/notifications" + +// Create a new notification service +notifier := notifications.New() + +//Register the service with the application +app := application.New(application.Options{ + Services: []application.Service{ + application.NewService(notifier), + }, +}) +``` + +## Notification Authorization + +Notifications on macOS require user authorization. Request and check authorization: + +```go +authorized, err := notifier.CheckNotificationAuthorization() +if err != nil { + // Handle authorization error +} +if authorized { + // Send notifications +} else { + // Request authorization + authorized, err = notifier.RequestNotificationAuthorization() +} +``` +On Windows and Linux this always returns `true`. + +## Notification Types + +### Basic Notifications + +Send a basic notification with a unique id, title, optional subtitle (macOS and Linux), and body text to users: + +```go +notifier.SendNotification(notifications.NotificationOptions{ + ID: "unique-id", + Title: "New Calendar Invite", + Subtitle: "From: Jane Doe", // Optional + Body: "Tap to view the event", +}) + +``` + +### Interactive Notifications +Send a notification with action buttons and text inputs. These notifications require a notification category to be resgistered first: + +```go +// Define a unique category id +categoryID := "unique-category-id" + +// Define a category with actions +category := notifications.NotificationCategory{ + ID: categoryID, + Actions: []notifications.NotificationAction{ + { + ID: "OPEN", + Title: "Open", + }, + { + ID: "ARCHIVE", + Title: "Archive", + Destructive: true, /* macOS-specific */ + }, + }, + HasReplyField: true, + ReplyPlaceholder: "message...", + ReplyButtonTitle: "Reply", +} + +// Register the category +notifier.RegisterNotificationCategory(category) + +// Send an interactive notification with the actions registered in the provided category +notifier.SendNotificationWithActions(notifications.NotificationOptions{ + ID: "unique-id", + Title: "New Message", + Subtitle: "From: Jane Doe", + Body: "Are you able to make it?", + CategoryID: categoryID, +}) +``` + +## Notification Responses + +Process user interactions with notifications: + +```go +notifier.OnNotificationResponse(func(result notifications.NotificationResult) { + response := result.Response + fmt.Printf("Notification %s was actioned with: %s\n", response.ID, response.ActionIdentifier) + + if response.ActionIdentifier == "TEXT_REPLY" { + fmt.Printf("User replied: %s\n", response.UserText) + } + + if data, ok := response.UserInfo["sender"].(string); ok { + fmt.Printf("Original sender: %s\n", data) + } + + // Emit an event to the frontend + app.Event.Emit("notification", result.Response) +}) +``` + +## Notification Customisation + +### Custom Metadata + +Basic and interactive notifications can include custom data: + +```go +notifier.SendNotification(notifications.NotificationOptions{ + ID: "unique-id", + Title: "New Calendar Invite", + Subtitle: "From: Jane Doe", // Optional + Body: "Tap to view the event", + Data: map[string]interface{}{ + "sender": "jane.doe@example.com", + "timestamp": "2025-03-10T15:30:00Z", + } +}) + +``` + +## Platform Considerations + + + + + On macOS, notifications: + + - Require user authorization + - Require the app to be notorized for distribution + - Use system-standard notification appearances + - Support `subtitle` + - Support user text input + - Support the `Destructive` action option + - Automatically handle dark/light mode + + + + + + On Windows, notifications: + + - Use Windows system toast styles + - Adapt to Windows theme settings + - Support user text input + - Support high DPI displays + - Do not support `subtitle` + + + + + + On Linux, dialog behaviour depends on the desktop environment: + + - Use native notifications when available + - Follow desktop environment theme + - Position according to desktop environment rules + - Support `subtitle` + - Do not support user text input + + + + +## Best Practices + +1. Check and request for authorization: + - macOS requires user authorization + +2. Provide clear and concise notifications: + - Use descriptive titles, subtitles, text, and action titles + +3. Handle dialog responses appropriately: + - Check for errors in notification responses + - Provide feedback for user actions + +4. Consider platform conventions: + - Follow platform-specific notification patterns + - Respect system settings + +## Examples + +Explore this example: + +- [Notifications](/examples/notifications) + +## API Reference + +### Service Management +| Method | Description | +|--------------------------------------------|-------------------------------------------------------| +| `New()` | Creates a new notifications service | + +### Notification Authorization +| Method | Description | +|----------------------------------------------|------------------------------------------------------------| +| `RequestNotificationAuthorization()` | Requests permission to display notifications (macOS) | +| `CheckNotificationAuthorization()` | Checks current notification authorization status (macOS) | + +### Sending Notifications +| Method | Description | +|------------------------------------------------------------|---------------------------------------------------| +| `SendNotification(options NotificationOptions)` | Sends a basic notification | +| `SendNotificationWithActions(options NotificationOptions)` | Sends an interactive notification with actions | + +### Notification Categories +| Method | Description | +|---------------------------------------------------------------|---------------------------------------------------| +| `RegisterNotificationCategory(category NotificationCategory)` | Registers a reusable notification category | +| `RemoveNotificationCategory(categoryID string)` | Removes a previously registered category | + +### Managing Notifications +| Method | Description | +|-------------------------------------------------|---------------------------------------------------------------------| +| `RemoveAllPendingNotifications()` | Removes all pending notifications (macOS and Linux only) | +| `RemovePendingNotification(identifier string)` | Removes a specific pending notification (macOS and Linux only) | +| `RemoveAllDeliveredNotifications()` | Removes all delivered notifications (macOS and Linux only) | +| `RemoveDeliveredNotification(identifier string)`| Removes a specific delivered notification (macOS and Linux only) | +| `RemoveNotification(identifier string)` | Removes a notification (Linux-specific) | + +### Event Handling +| Method | Description | +|--------------------------------------------------------------------|-------------------------------------------------| +| `OnNotificationResponse(callback func(result NotificationResult))` | Registers a callback for notification responses | + +### Structs and Types + +#### NotificationOptions +```go +type NotificationOptions struct { + ID string // Unique identifier for the notification + Title string // Main notification title + Subtitle string // Subtitle text (macOS and Linux only) + Body string // Main notification content + CategoryID string // Category identifier for interactive notifications + Data map[string]interface{} // Custom data to associate with the notification +} +``` + +#### NotificationCategory +```go +type NotificationCategory struct { + ID string // Unique identifier for the category + Actions []NotificationAction // Button actions for the notification + HasReplyField bool // Whether to include a text input field + ReplyPlaceholder string // Placeholder text for the input field + ReplyButtonTitle string // Text for the reply button +} +``` + +#### NotificationAction +```go +type NotificationAction struct { + ID string // Unique identifier for the action + Title string // Button text + Destructive bool // Whether the action is destructive (macOS-specific) +} +``` + +#### NotificationResponse +```go +type NotificationResponse struct { + ID string // Notification identifier + ActionIdentifier string // Action that was triggered + CategoryID string // Category of the notification + Title string // Title of the notification + Subtitle string // Subtitle of the notification + Body string // Body text of the notification + UserText string // Text entered by the user + UserInfo map[string]interface{} // Custom data from the notification +} +``` + +#### NotificationResult +```go +type NotificationResult struct { + Response NotificationResponse // Response data + Error error // Any error that occurred +} +``` \ No newline at end of file diff --git a/docs/src/content/docs/features/platform/dock.mdx b/docs/src/content/docs/features/platform/dock.mdx new file mode 100644 index 000000000..3cc5d9a92 --- /dev/null +++ b/docs/src/content/docs/features/platform/dock.mdx @@ -0,0 +1,241 @@ +--- +title: Dock & Taskbar +description: Manage dock icon visibility and display badges on macOS and Windows +sidebar: + order: 1 +--- + +import { Tabs, TabItem } from "@astrojs/starlight/components"; + +## Introduction + +Wails provides a cross-platform Dock service for desktop applications. This service allows you to: + +- Hide and show the application icon in the macOS Dock +- Display badges on your application tile or dock/taskbar icon (macOS and Windows) + +## Basic Usage + +### Creating the Service + +First, initialize the dock service: + +```go +import "github.com/wailsapp/wails/v3/pkg/application" +import "github.com/wailsapp/wails/v3/pkg/services/dock" + +// Create a new Dock service +dockService := dock.New() + +// Register the service with the application +app := application.New(application.Options{ + Services: []application.Service{ + application.NewService(dockService), + }, +}) +``` + +### Creating the Service with Custom Badge Options (Windows Only) + +On Windows, you can customize the badge appearance with various options: + +```go +import "github.com/wailsapp/wails/v3/pkg/application" +import "github.com/wailsapp/wails/v3/pkg/services/dock" +import "image/color" + +// Create a dock service with custom badge options +options := dock.BadgeOptions{ + TextColour: color.RGBA{255, 255, 255, 255}, // White text + BackgroundColour: color.RGBA{0, 0, 255, 255}, // Blue background + FontName: "consolab.ttf", // Bold Consolas font + FontSize: 20, // Font size for single character + SmallFontSize: 14, // Font size for multiple characters +} + +dockService := dock.NewWithOptions(options) + +// Register the service with the application +app := application.New(application.Options{ + Services: []application.Service{ + application.NewService(dockService), + }, +}) +``` + +## Dock Operations + +### Hiding the dock app icon + +Hide the app icon from the macOS Dock: + +```go +// Hide the app icon +dockService.HideAppIcon() +``` + +### Showing the dock app icon + +Show the app icon in the macOS Dock: + +```go +// Show the app icon +dockService.ShowAppIcon() +``` + +## Badge Operations + +### Setting a Badge + +Set a badge on the application tile/dock icon: + +```go +// Set a default badge +dockService.SetBadge("") + +// Set a numeric badge +dockService.SetBadge("3") + +// Set a text badge +dockService.SetBadge("New") +``` + +### Setting a Custom Badge (Windows Only) + +Set a badge with one-off options applied: + +```go +options := dock.BadgeOptions{ + BackgroundColour: color.RGBA{0, 255, 255, 255}, + FontName: "arialb.ttf", // System font + FontSize: 16, + SmallFontSize: 10, + TextColour: color.RGBA{0, 0, 0, 255}, +} + +// Set a default badge +dockService.SetCustomBadge("", options) + +// Set a numeric badge +dockService.SetCustomBadge("3", options) + +// Set a text badge +dockService.SetCustomBadge("New", options) +``` + +### Removing a Badge + +Remove the badge from the application icon: + +```go +dockService.RemoveBadge() +``` + +### Getting the set badge +```go +dockService.GetBadge() +``` + +## Platform Considerations + + + + + On macOS: + + - The dock icon can be **hidden** and **shown** + - Badges are displayed directly on the dock icon + - Badge options are **not customizable** (any options passed to `NewWithOptions`/`SetCustomBadge` are ignored) + - The standard macOS dock badge styling is used and automatically adapts to appearance + - Label overflow is handled by the system + - Providing an empty label displays a default badge of "●" + + + + + + On Windows: + + - Hiding/showing the taskbar icon is not currently supported by this service + - Badges are displayed as an overlay icon in the taskbar + - Badges support text values + - Badge appearance can be customized via `BadgeOptions` + - The application must have a window for badges to display + - A smaller font size is automatically used for multi-character labels + - Label overflow is not handled + - Customization options: + - **TextColour**: Text color (default: white) + - **BackgroundColour**: Badge background color (default: red) + - **FontName**: Font file name (default: "segoeuib.ttf") + - **FontSize**: Font size for single character (default: 18) + - **SmallFontSize**: Font size for multiple characters (default: 14) + + + + + + On Linux: + + - Dock icon visibility and badge functionality are not available + + + + +## Best Practices + +1. **When hiding the dock icon (macOS):** + - Ensure users can still access your app (e.g., via [system tray](https://v3alpha.wails.io/learn/systray/)) + - Include a "Quit" option in your alternative UI + - The app won't appear in Command+Tab switcher + - Open windows remain visible and functional + - Closing all windows may not quit the app (macOS behavior varies) + - Users lose the standard way to quit via Dock right-click + +2. **Use badges sparingly:** + - Too many badge updates can distract users + - Reserve badges for important notifications + +3. **Keep badge text short:** + - Numeric badges are most effective + - On macOS, text badges should be brief + +4. **For Windows badge customization:** + - Ensure high contrast between text and background colors + - Test with different text lengths as font size decreases with length + - Use common system fonts to ensure availability + + +## API Reference + +### Service Management +| Method | Description | +|--------------------------------------------|-------------------------------------------------------| +| `New()` | Creates a new dock service | +| `NewWithOptions(options BadgeOptions)` | Creates a new dock service with custom badge options (Windows only; options are ignored on macOS and Linux) | + +### Dock Operations +| Method | Description | +|--------------------------------|-------------------------------------------------------------| +| `HideAppIcon()` | Hides the app icon from the macOS Dock (macOS only) | +| `ShowAppIcon()` | Shows the app icon in the macOS Dock (macOS only) | + +### Badge Operations +| Method | Description | +|---------------------------------------------------|------------------------------------------------------------| +| `SetBadge(label string) error` | Sets a badge with the specified label | +| `SetCustomBadge(label string, options BadgeOptions) error` | Sets a badge with the specified label and custom styling options (Windows only) | +| `RemoveBadge() error` | Removes the badge from the application icon | +| `GetBadge() *string` | Gets the current badge | + +### Structs and Types + +```go +// Options for customizing badge appearance (Windows only) +type BadgeOptions struct { + TextColour color.RGBA // Color of the badge text + BackgroundColour color.RGBA // Color of the badge background + FontName string // Font file name (e.g., "segoeuib.ttf") + FontSize int // Font size for single character + SmallFontSize int // Font size for multiple characters +} +``` diff --git a/docs/src/content/docs/features/screens/info.mdx b/docs/src/content/docs/features/screens/info.mdx new file mode 100644 index 000000000..a1ade0a27 --- /dev/null +++ b/docs/src/content/docs/features/screens/info.mdx @@ -0,0 +1,466 @@ +--- +title: Screen Information +description: Get information about displays and monitors +sidebar: + order: 1 +--- + +import { Card, CardGrid } from "@astrojs/starlight/components"; + +## Screen Information + +Wails provides a **unified screen API** that works across all platforms. Get screen information, detect multiple monitors, query screen properties (size, position, DPI), identify the primary display, and handle DPI scaling with consistent code. + +## Quick Start + +```go +// Get all screens +screens := app.Screen.GetAll() + +for _, screen := range screens { + fmt.Printf("Screen: %s (%dx%d)\n", + screen.Name, screen.Width, screen.Height) +} + +// Get primary screen +primary := app.Screens.GetPrimary() +fmt.Printf("Primary: %s\n", primary.Name) +``` + +**That's it!** Cross-platform screen information. + +## Getting Screen Information + +### All Screens + +```go +screens := app.Screen.GetAll() + +for _, screen := range screens { + fmt.Printf("ID: %s\n", screen.ID) + fmt.Printf("Name: %s\n", screen.Name) + fmt.Printf("Size: %dx%d\n", screen.Width, screen.Height) + fmt.Printf("Position: %d,%d\n", screen.X, screen.Y) + fmt.Printf("Scale: %.2f\n", screen.ScaleFactor) + fmt.Printf("Primary: %v\n", screen.IsPrimary) + fmt.Println("---") +} +``` + +### Primary Screen + +```go +primary := app.Screens.GetPrimary() + +fmt.Printf("Primary screen: %s\n", primary.Name) +fmt.Printf("Resolution: %dx%d\n", primary.Width, primary.Height) +fmt.Printf("Scale factor: %.2f\n", primary.ScaleFactor) +``` + +### Current Screen + +Get the screen containing a window: + +```go +screen := app.Screens.GetCurrent(window) + +fmt.Printf("Window is on: %s\n", screen.Name) +``` + +### Screen by ID + +```go +screen := app.Screens.GetByID("screen-id") +if screen != nil { + fmt.Printf("Found screen: %s\n", screen.Name) +} +``` + +## Screen Properties + +### Screen Structure + +```go +type Screen struct { + ID string // Unique identifier + Name string // Display name + X int // X position + Y int // Y position + Width int // Width in pixels + Height int // Height in pixels + ScaleFactor float32 // DPI scale (1.0, 1.5, 2.0, etc.) + IsPrimary bool // Is this the primary screen? +} +``` + +### Physical vs Logical Pixels + +```go +screen := app.Screens.GetPrimary() + +// Logical pixels (what you use) +logicalWidth := screen.Width +logicalHeight := screen.Height + +// Physical pixels (actual display) +physicalWidth := int(float32(screen.Width) * screen.ScaleFactor) +physicalHeight := int(float32(screen.Height) * screen.ScaleFactor) + +fmt.Printf("Logical: %dx%d\n", logicalWidth, logicalHeight) +fmt.Printf("Physical: %dx%d\n", physicalWidth, physicalHeight) +fmt.Printf("Scale: %.2f\n", screen.ScaleFactor) +``` + +**Common scale factors:** +- `1.0` - Standard DPI (96 DPI) +- `1.25` - 125% scaling (120 DPI) +- `1.5` - 150% scaling (144 DPI) +- `2.0` - 200% scaling (192 DPI) - Retina +- `3.0` - 300% scaling (288 DPI) - 4K/5K + +## Window Positioning + +### Centre on Screen + +```go +func centreOnScreen(window *application.WebviewWindow, screen *Screen) { + windowWidth, windowHeight := window.Size() + + x := screen.X + (screen.Width-windowWidth)/2 + y := screen.Y + (screen.Height-windowHeight)/2 + + window.SetPosition(x, y) +} +``` + +### Position on Specific Screen + +```go +func moveToScreen(window *application.WebviewWindow, screenIndex int) { + screens := app.Screen.GetAll() + + if screenIndex < 0 || screenIndex >= len(screens) { + return + } + + screen := screens[screenIndex] + + // Centre on target screen + centreOnScreen(window, screen) +} +``` + +### Position Relative to Screen + +```go +// Top-left corner +func positionTopLeft(window *application.WebviewWindow, screen *Screen) { + window.SetPosition(screen.X+10, screen.Y+10) +} + +// Top-right corner +func positionTopRight(window *application.WebviewWindow, screen *Screen) { + windowWidth, _ := window.Size() + window.SetPosition(screen.X+screen.Width-windowWidth-10, screen.Y+10) +} + +// Bottom-right corner +func positionBottomRight(window *application.WebviewWindow, screen *Screen) { + windowWidth, windowHeight := window.Size() + window.SetPosition( + screen.X+screen.Width-windowWidth-10, + screen.Y+screen.Height-windowHeight-10, + ) +} +``` + +## Multi-Monitor Support + +### Detect Multiple Monitors + +```go +func hasMultipleMonitors() bool { + return len(app.Screen.GetAll()) > 1 +} + +func getMonitorCount() int { + return len(app.Screen.GetAll()) +} +``` + +### List All Monitors + +```go +func listMonitors() { + screens := app.Screen.GetAll() + + fmt.Printf("Found %d monitor(s):\n", len(screens)) + + for i, screen := range screens { + primary := "" + if screen.IsPrimary { + primary = " (Primary)" + } + + fmt.Printf("%d. %s%s\n", i+1, screen.Name, primary) + fmt.Printf(" Resolution: %dx%d\n", screen.Width, screen.Height) + fmt.Printf(" Position: %d,%d\n", screen.X, screen.Y) + fmt.Printf(" Scale: %.2fx\n", screen.ScaleFactor) + } +} +``` + +### Choose Monitor + +```go +func chooseMonitor() (*Screen, error) { + screens := app.Screen.GetAll() + + if len(screens) == 1 { + return screens[0], nil + } + + // Show dialog to choose + var options []string + for i, screen := range screens { + primary := "" + if screen.IsPrimary { + primary = " (Primary)" + } + options = append(options, + fmt.Sprintf("%d. %s%s - %dx%d", + i+1, screen.Name, primary, screen.Width, screen.Height)) + } + + // Use dialog to select + // (Implementation depends on your dialog system) + + return screens[0], nil +} +``` + +## Complete Examples + +### Multi-Monitor Window Manager + +```go +type MultiMonitorManager struct { + app *application.Application + windows map[int]*application.WebviewWindow +} + +func NewMultiMonitorManager(app *application.Application) *MultiMonitorManager { + return &MultiMonitorManager{ + app: app, + windows: make(map[int]*application.WebviewWindow), + } +} + +func (m *MultiMonitorManager) CreateWindowOnScreen(screenIndex int) error { + screens := m.app.Screen.GetAll() + + if screenIndex < 0 || screenIndex >= len(screens) { + return errors.New("invalid screen index") + } + + screen := screens[screenIndex] + + // Create window + window := m.app.Window.NewWithOptions(application.WebviewWindowOptions{ + Title: fmt.Sprintf("Window on %s", screen.Name), + Width: 800, + Height: 600, + }) + + // Centre on screen + x := screen.X + (screen.Width-800)/2 + y := screen.Y + (screen.Height-600)/2 + window.SetPosition(x, y) + + window.Show() + + m.windows[screenIndex] = window + return nil +} + +func (m *MultiMonitorManager) CreateWindowOnEachScreen() { + screens := m.app.Screen.GetAll() + + for i := range screens { + m.CreateWindowOnScreen(i) + } +} +``` + +### Screen Change Detection + +```go +type ScreenMonitor struct { + app *application.Application + lastScreens []*Screen + changeHandler func([]*Screen) +} + +func NewScreenMonitor(app *application.Application) *ScreenMonitor { + return &ScreenMonitor{ + app: app, + lastScreens: app.Screen.GetAll(), + } +} + +func (sm *ScreenMonitor) OnScreenChange(handler func([]*Screen)) { + sm.changeHandler = handler +} + +func (sm *ScreenMonitor) Start() { + ticker := time.NewTicker(2 * time.Second) + + go func() { + for range ticker.C { + sm.checkScreens() + } + }() +} + +func (sm *ScreenMonitor) checkScreens() { + current := sm.app.Screen.GetAll() + + if len(current) != len(sm.lastScreens) { + sm.lastScreens = current + if sm.changeHandler != nil { + sm.changeHandler(current) + } + } +} +``` + +### DPI-Aware Window Sizing + +```go +func createDPIAwareWindow(screen *Screen) *application.WebviewWindow { + // Base size at 1.0 scale + baseWidth := 800 + baseHeight := 600 + + // Adjust for DPI + width := int(float32(baseWidth) * screen.ScaleFactor) + height := int(float32(baseHeight) * screen.ScaleFactor) + + window := app.Window.NewWithOptions(application.WebviewWindowOptions{ + Title: "DPI-Aware Window", + Width: width, + Height: height, + }) + + // Centre on screen + x := screen.X + (screen.Width-width)/2 + y := screen.Y + (screen.Height-height)/2 + window.SetPosition(x, y) + + return window +} +``` + +### Screen Layout Visualiser + +```go +func visualiseScreenLayout() string { + screens := app.Screen.GetAll() + + var layout strings.Builder + layout.WriteString("Screen Layout:\n\n") + + for i, screen := range screens { + primary := "" + if screen.IsPrimary { + primary = " [PRIMARY]" + } + + layout.WriteString(fmt.Sprintf("Screen %d: %s%s\n", i+1, screen.Name, primary)) + layout.WriteString(fmt.Sprintf(" Position: (%d, %d)\n", screen.X, screen.Y)) + layout.WriteString(fmt.Sprintf(" Size: %dx%d\n", screen.Width, screen.Height)) + layout.WriteString(fmt.Sprintf(" Scale: %.2fx\n", screen.ScaleFactor)) + layout.WriteString(fmt.Sprintf(" Physical: %dx%d\n", + int(float32(screen.Width)*screen.ScaleFactor), + int(float32(screen.Height)*screen.ScaleFactor))) + layout.WriteString("\n") + } + + return layout.String() +} +``` + +## Best Practices + +### ✅ Do + +- **Check screen count** - Handle single and multiple monitors +- **Use logical pixels** - Wails handles DPI automatically +- **Centre windows** - Better UX than fixed positions +- **Validate positions** - Ensure windows are visible +- **Handle screen changes** - Monitors can be added/removed +- **Test on different DPI** - 100%, 125%, 150%, 200% + +### ❌ Don't + +- **Don't hardcode positions** - Use screen dimensions +- **Don't assume primary screen** - User might have multiple +- **Don't ignore scale factor** - Important for DPI awareness +- **Don't position off-screen** - Validate coordinates +- **Don't forget screen changes** - Laptops dock/undock +- **Don't use physical pixels** - Use logical pixels + +## Platform Differences + +### macOS + +- Retina displays (2x scale factor) +- Multiple displays common +- Coordinate system: (0,0) at bottom-left +- Spaces (virtual desktops) affect positioning + +### Windows + +- Various DPI scaling (100%, 125%, 150%, 200%) +- Multiple displays common +- Coordinate system: (0,0) at top-left +- Per-monitor DPI awareness + +### Linux + +- Varies by desktop environment +- X11 vs Wayland differences +- DPI scaling support varies +- Multiple displays supported + +## Next Steps + + + + Learn about window management. + + [Learn More →](/features/windows/basics) + + + + Configure window appearance. + + [Learn More →](/features/windows/options) + + + + Multi-window patterns. + + [Learn More →](/features/windows/multiple) + + + + Call Go functions from JavaScript. + + [Learn More →](/features/bindings/methods) + + + +--- + +**Questions?** Ask in [Discord](https://discord.gg/JDdSxwjhGf) or check the [screen examples](https://github.com/wailsapp/wails/tree/v3-alpha/v3/examples). diff --git a/docs/src/content/docs/features/windows/basics.mdx b/docs/src/content/docs/features/windows/basics.mdx new file mode 100644 index 000000000..deed35602 --- /dev/null +++ b/docs/src/content/docs/features/windows/basics.mdx @@ -0,0 +1,616 @@ +--- +title: Window Basics +description: Creating and managing application windows in Wails +sidebar: + order: 1 +--- + +import { Tabs, TabItem, Card, CardGrid } from "@astrojs/starlight/components"; + +## Window Management + +Wails provides a **unified window management API** that works across all platforms. Create windows, control their behaviour, and manage multiple windows with full control over creation, appearance, behaviour, and lifecycle. + +## Quick Start + +```go +package main + +import "github.com/wailsapp/wails/v3/pkg/application" + +func main() { + app := application.New(application.Options{ + Name: "My App", + }) + + // Create a window + window := app.Window.New() + + // Configure it + window.SetTitle("Hello Wails") + window.SetSize(800, 600) + window.Center() + + // Show it + window.Show() + + app.Run() +} +``` + +**That's it!** You have a cross-platform window. + +## Creating Windows + +### Basic Window + +The simplest way to create a window: + +```go +window := app.Window.New() +``` + +**What you get:** +- Default size (800x600) +- Default title (application name) +- WebView ready for your frontend +- Platform-native appearance + +### Window with Options + +Create a window with custom configuration: + +```go +window := app.Window.NewWithOptions(application.WebviewWindowOptions{ + Title: "My Application", + Width: 1200, + Height: 800, + X: 100, // Position from left + Y: 100, // Position from top + AlwaysOnTop: false, + Frameless: false, + Hidden: false, + MinWidth: 400, + MinHeight: 300, + MaxWidth: 1920, + MaxHeight: 1080, +}) +``` + +**Common options:** + +| Option | Type | Description | +|--------|------|-------------| +| `Title` | `string` | Window title | +| `Width` | `int` | Window width in pixels | +| `Height` | `int` | Window height in pixels | +| `X` | `int` | X position (from left) | +| `Y` | `int` | Y position (from top) | +| `AlwaysOnTop` | `bool` | Keep window above others | +| `Frameless` | `bool` | Remove title bar and borders | +| `Hidden` | `bool` | Start hidden | +| `MinWidth` | `int` | Minimum width | +| `MinHeight` | `int` | Minimum height | +| `MaxWidth` | `int` | Maximum width | +| `MaxHeight` | `int` | Maximum height | + +**See [Window Options](/features/windows/options) for complete list.** + +### Named Windows + +Give windows names for easy retrieval: + +```go +window := app.Window.NewWithOptions(application.WebviewWindowOptions{ + Name: "main-window", + Title: "Main Application", +}) + +// Later, find it by name +mainWindow := app.GetWindowByName("main-window") +if mainWindow != nil { + mainWindow.Show() +} +``` + +**Use cases:** +- Multiple windows (main, settings, about) +- Finding windows from different parts of your code +- Window communication + +## Controlling Windows + +### Show and Hide + +```go +// Show window +window.Show() + +// Hide window +window.Hide() + +// Check if visible +if window.IsVisible() { + fmt.Println("Window is visible") +} +``` + +**Use cases:** +- Splash screens (show, then hide) +- Settings windows (hide when not needed) +- Popup windows (show on demand) + +### Position and Size + +```go +// Set size +window.SetSize(1024, 768) + +// Set position +window.SetPosition(100, 100) + +// Centre on screen +window.Center() + +// Get current size +width, height := window.Size() + +// Get current position +x, y := window.Position() +``` + +**Coordinate system:** +- (0, 0) is top-left of primary screen +- Positive X goes right +- Positive Y goes down + +### Window State + +```go +// Minimise +window.Minimise() + +// Maximise +window.Maximise() + +// Fullscreen +window.Fullscreen() + +// Restore to normal +window.Restore() + +// Check state +if window.IsMinimised() { + fmt.Println("Window is minimised") +} + +if window.IsMaximised() { + fmt.Println("Window is maximised") +} + +if window.IsFullscreen() { + fmt.Println("Window is fullscreen") +} +``` + +**State transitions:** + +``` +Normal ←→ Minimised +Normal ←→ Maximised +Normal ←→ Fullscreen +``` + +### Title and Appearance + +```go +// Set title +window.SetTitle("My Application - Document.txt") + +// Set background colour +window.SetBackgroundColour(0, 0, 0, 255) // RGBA + +// Set always on top +window.SetAlwaysOnTop(true) + +// Set resizable +window.SetResizable(false) +``` + +### Closing Windows + +```go +// Close window +window.Close() + +// Destroy window (force close) +window.Destroy() +``` + +**Difference:** +- `Close()` - Triggers close event, can be cancelled +- `Destroy()` - Immediate destruction, cannot be cancelled + +## Finding Windows + +### By Name + +```go +window := app.GetWindowByName("settings") +if window != nil { + window.Show() +} +``` + +### By ID + +Every window has a unique ID: + +```go +id := window.ID() +fmt.Printf("Window ID: %d\n", id) + +// Find by ID +foundWindow := app.GetWindowByID(id) +``` + +### Current Window + +Get the currently focused window: + +```go +current := app.Window.Current() +if current != nil { + current.SetTitle("Active Window") +} +``` + +### All Windows + +Get all windows: + +```go +windows := app.Window.GetAll() +fmt.Printf("Total windows: %d\n", len(windows)) + +for _, w := range windows { + fmt.Printf("Window: %s (ID: %d)\n", w.Name(), w.ID()) +} +``` + +## Window Lifecycle + +### Creation + +```go +app.OnWindowCreation(func(window *application.WebviewWindow) { + fmt.Printf("Window created: %s\n", window.Name()) + + // Configure new windows + window.SetMinSize(400, 300) +}) +``` + +### Closing + +```go +window.OnClose(func() bool { + // Return false to cancel close + // Return true to allow close + + if hasUnsavedChanges() { + result := showConfirmdialog("Unsaved changes. Close anyway?") + return result == "yes" + } + return true +}) +``` + +**Important:** `OnClose` only works for user-initiated closes (clicking X button). It doesn't prevent `window.Destroy()`. + +### Destruction + +```go +window.OnDestroy(func() { + fmt.Println("Window destroyed") + // Cleanup resources +}) +``` + +## Multiple Windows + +### Creating Multiple Windows + +```go +// Main window +mainWindow := app.Window.NewWithOptions(application.WebviewWindowOptions{ + Name: "main", + Title: "Main Application", + Width: 1200, + Height: 800, +}) + +// Settings window +settingsWindow := app.Window.NewWithOptions(application.WebviewWindowOptions{ + Name: "settings", + Title: "Settings", + Width: 600, + Height: 400, + Hidden: true, // Start hidden +}) + +// Show settings when needed +settingsWindow.Show() +``` + +### Window Communication + +Windows can communicate via events: + +```go +// In main window +app.Event.Emit("data-updated", map[string]interface{}{ + "value": 42, +}) + +// In settings window +app.Event.On("data-updated", func(event *application.WailsEvent) { + data := event.Data.(map[string]interface{}) + value := data["value"].(int) + fmt.Printf("Received: %d\n", value) +}) +``` + +**See [Events](/features/events/system) for more.** + +### Parent-Child Windows + +```go +// Create child window +childWindow := app.Window.NewWithOptions(application.WebviewWindowOptions{ + Title: "Child Window", + Parent: mainWindow, // Set parent +}) +``` + +**Behaviour:** +- Child closes when parent closes +- Child stays above parent (on some platforms) +- Child minimises with parent (on some platforms) + +**Platform support:** +- **macOS:** Full support +- **Windows:** Partial support +- **Linux:** Varies by desktop environment + +## Platform-Specific Features + + + + **Windows-specific features:** + + ```go + // Flash taskbar button + window.Flash(true) // Start flashing + window.Flash(false) // Stop flashing + + // Trigger Windows 11 Snap Assist (Win+Z) + window.SnapAssist() + + // Set window icon + window.SetIcon(iconBytes) + ``` + + **Snap Assist:** + Shows Windows 11 snap layout options for the window. + + **Taskbar flashing:** + Useful for notifications when window is minimised. + + + + **macOS-specific features:** + + ```go + // Transparent title bar + window := app.Window.NewWithOptions(application.WebviewWindowOptions{ + Mac: application.MacWindow{ + TitleBar: application.MacTitleBar{ + AppearsTransparent: true, + }, + Backdrop: application.MacBackdropTranslucent, + }, + }) + ``` + + **Backdrop types:** + - `MacBackdropNormal` - Standard window + - `MacBackdropTranslucent` - Translucent background + - `MacBackdropTransparent` - Fully transparent + + **Collection behavior:** + Control how windows behave across Spaces: + - `MacWindowCollectionBehaviorCanJoinAllSpaces` - Visible on all Spaces + - `MacWindowCollectionBehaviorFullScreenAuxiliary` - Can overlay fullscreen apps + + **Native fullscreen:** + macOS fullscreen creates a new Space (virtual desktop). + + + + **Linux-specific features:** + + ```go + // Set window icon + window := app.Window.NewWithOptions(application.WebviewWindowOptions{ + Linux: application.LinuxOptions{ + Icon: iconBytes, + }, + }) + ``` + + **Desktop environment notes:** + - GNOME: Full support + - KDE Plasma: Full support + - XFCE: Partial support + - Others: Varies + + **Tiling window managers (Hyprland, Sway, i3, etc.):** + - `Minimise()` and `Maximise()` may not work as expected - the WM controls window geometry + - `SetSize()` and `SetPosition()` requests are advisory and may be ignored + - `Fullscreen()` typically works as expected + - Some WMs don't support always-on-top + + + +## Common Patterns + +### Splash Screen + +```go +// Create splash screen +splash := app.Window.NewWithOptions(application.WebviewWindowOptions{ + Title: "Loading...", + Width: 400, + Height: 300, + Frameless: true, + AlwaysOnTop: true, +}) + +// Show splash +splash.Show() + +// Initialise application +time.Sleep(2 * time.Second) + +// Hide splash, show main window +splash.Close() +mainWindow.Show() +``` + +### Settings Window + +```go +var settingsWindow *application.WebviewWindow + +func showSettings() { + if settingsWindow == nil { + settingsWindow = app.Window.NewWithOptions(application.WebviewWindowOptions{ + Name: "settings", + Title: "Settings", + Width: 600, + Height: 400, + }) + } + + settingsWindow.Show() + settingsWindow.SetFocus() +} +``` + +### Confirm Before Close + +```go +window.OnClose(func() bool { + if hasUnsavedChanges() { + // Show dialog + result := showConfirmdialog("Unsaved changes. Close anyway?") + return result == "yes" + } + return true +}) +``` + +## Best Practices + +### ✅ Do + +- **Name important windows** - Easier to find later +- **Set minimum size** - Prevent unusable layouts +- **Centre windows** - Better UX than random position +- **Handle close events** - Prevent data loss +- **Test on all platforms** - Behaviour varies +- **Use appropriate sizes** - Consider different screen sizes + +### ❌ Don't + +- **Don't create too many windows** - Confusing for users +- **Don't forget to close windows** - Memory leaks +- **Don't hardcode positions** - Different screen sizes +- **Don't ignore platform differences** - Test thoroughly +- **Don't block the UI thread** - Use goroutines for long operations + +## Troubleshooting + +### Window Not Showing + +**Possible causes:** +1. Window created as hidden +2. Window off-screen +3. Window behind other windows + +**Solution:** + +```go +window.Show() +window.Center() +window.SetFocus() +``` + +### Window Wrong Size + +**Cause:** DPI scaling on Windows/Linux + +**Solution:** + +```go +// Wails handles DPI automatically +// Just use logical pixels +window.SetSize(800, 600) +``` + +### Window Closes Immediately + +**Cause:** Application exits when last window closes + +**Solution:** + +```go +app := application.New(application.Options{ + Mac: application.MacOptions{ + ApplicationShouldTerminateAfterLastWindowClosed: false, + }, +}) +``` + +## Next Steps + + + + Complete reference for all window options. + + [Learn More →](/features/windows/options) + + + + Patterns for multi-window applications. + + [Learn More →](/features/windows/multiple) + + + + Create custom window chrome. + + [Learn More →](/features/windows/frameless) + + + + Handle window lifecycle events. + + [Learn More →](/features/windows/events) + + + +--- + +**Questions?** Ask in [Discord](https://discord.gg/JDdSxwjhGf) or check the [window examples](https://github.com/wailsapp/wails/tree/v3-alpha/v3/examples). diff --git a/docs/src/content/docs/features/windows/events.mdx b/docs/src/content/docs/features/windows/events.mdx new file mode 100644 index 000000000..b45c6596c --- /dev/null +++ b/docs/src/content/docs/features/windows/events.mdx @@ -0,0 +1,693 @@ +--- +title: Window Events +description: Handle window lifecycle and state change events +sidebar: + order: 5 +--- + +import { Tabs, TabItem } from "@astrojs/starlight/components"; + +## Window Events + +Wails provides **comprehensive event hooks** for window lifecycle and state changes: creation, focus/blur, resize/move, minimise/maximise, and close events. Register callbacks, handle events, and coordinate between windows with simple, consistent APIs. + +## Lifecycle Events + +### OnCreate + +Called when a window is created: + +```go +app.OnWindowCreation(func(window *application.WebviewWindow) { + fmt.Printf("Window created: %s (ID: %d)\n", window.Name(), window.ID()) + + // Configure all new windows + window.SetMinSize(400, 300) + + // Register window-specific handlers + window.OnClose(func() bool { + return confirmClose() + }) +}) +``` + +**Use cases:** +- Configure all windows consistently +- Register event handlers +- Track window creation +- Initialise window-specific resources + +### OnClose + +Called when user attempts to close window: + +```go +window.OnClose(func() bool { + // Return false to cancel close + // Return true to allow close + + if hasUnsavedChanges() { + result := showConfirmdialog("Unsaved changes. Close anyway?") + return result == "yes" + } + return true +}) +``` + +**Important:** +- Only triggered by user actions (clicking X button) +- NOT triggered by `window.Destroy()` +- Can cancel the close by returning `false` + +**Use cases:** +- Confirm before closing +- Save state +- Prevent accidental closure +- Cleanup before close + +**Example with dialog:** + +```go +window.OnClose(func() bool { + if !hasUnsavedChanges() { + return true + } + + // Show confirmation dialog + dialog := app.Window.NewWithOptions(application.WebviewWindowOptions{ + Title: "Confirm Close", + Width: 400, + Height: 150, + Parent: window, + AlwaysOnTop: true, + }) + + // Wait for user response + result := waitFordialogResult(dialog) + + return result == "yes" +}) +``` + +### OnDestroy + +Called when window is destroyed: + +```go +window.OnDestroy(func() { + fmt.Printf("Window destroyed: %s\n", window.Name()) + + // Cleanup resources + closeDatabase() + + // Remove from tracking + removeWindowFromRegistry(window.ID()) + + // Update application state + updateWindowCount() +}) +``` + +**Important:** +- Always called when window is destroyed +- Cannot be cancelled +- Last chance to cleanup + +**Use cases:** +- Release resources +- Close connections +- Update application state +- Remove from tracking + +**Example with resource cleanup:** + +```go +type ManagedWindow struct { + window *application.WebviewWindow + db *sql.DB + listeners []func() +} + +func (mw *ManagedWindow) Setup() { + mw.window.OnDestroy(func() { + // Close database + if mw.db != nil { + mw.db.Close() + } + + // Remove event listeners + for _, listener := range mw.listeners { + listener() + } + + // Clear references + mw.db = nil + mw.listeners = nil + }) +} +``` + +## Focus Events + +### OnFocus + +Called when window gains focus: + +```go +window.OnFocus(func() { + fmt.Println("Window gained focus") + + // Update UI + updateTitleBar(true) + + // Refresh data + refreshContent() + + // Notify other windows + app.Event.Emit("window-focused", window.ID()) +}) +``` + +**Use cases:** +- Update UI appearance +- Refresh data +- Resume operations +- Coordinate with other windows + +### OnBlur + +Called when window loses focus: + +```go +window.OnBlur(func() { + fmt.Println("Window lost focus") + + // Update UI + updateTitleBar(false) + + // Pause operations + pauseAnimations() + + // Save state + saveCurrentState() +}) +``` + +**Use cases:** +- Update UI appearance +- Pause operations +- Save state +- Reduce resource usage + +**Example: Focus-aware UI:** + +```go +type FocusAwareWindow struct { + window *application.WebviewWindow + focused bool +} + +func (fw *FocusAwareWindow) Setup() { + fw.window.OnFocus(func() { + fw.focused = true + fw.updateAppearance() + }) + + fw.window.OnBlur(func() { + fw.focused = false + fw.updateAppearance() + }) +} + +func (fw *FocusAwareWindow) updateAppearance() { + if fw.focused { + fw.window.EmitEvent("update-theme", "active") + } else { + fw.window.EmitEvent("update-theme", "inactive") + } +} +``` + +## State Change Events + +### OnMinimise / OnUnMinimise + +Called when window is minimised or restored: + +```go +window.OnMinimise(func() { + fmt.Println("Window minimised") + + // Pause expensive operations + pauseRendering() + + // Save state + saveWindowState() +}) + +window.OnUnMinimise(func() { + fmt.Println("Window restored from minimised") + + // Resume operations + resumeRendering() + + // Refresh data + refreshContent() +}) +``` + +**Use cases:** +- Pause/resume operations +- Save/restore state +- Reduce resource usage +- Update UI + +### OnMaximise / OnUnMaximise + +Called when window is maximised or restored: + +```go +window.OnMaximise(func() { + fmt.Println("Window maximised") + + // Adjust layout + window.EmitEvent("layout-mode", "maximised") + + // Update button icon + updateMaximiseButton("restore") +}) + +window.OnUnMaximise(func() { + fmt.Println("Window restored from maximised") + + // Adjust layout + window.EmitEvent("layout-mode", "normal") + + // Update button icon + updateMaximiseButton("maximise") +}) +``` + +**Use cases:** +- Adjust layout +- Update UI +- Save window state +- Coordinate with other windows + +### OnFullscreen / OnUnFullscreen + +Called when window enters or exits fullscreen: + +```go +window.OnFullscreen(func() { + fmt.Println("Window entered fullscreen") + + // Hide UI chrome + window.EmitEvent("chrome-visibility", false) + + // Adjust layout + window.EmitEvent("layout-mode", "fullscreen") +}) + +window.OnUnFullscreen(func() { + fmt.Println("Window exited fullscreen") + + // Show UI chrome + window.EmitEvent("chrome-visibility", true) + + // Restore layout + window.EmitEvent("layout-mode", "normal") +}) +``` + +**Use cases:** +- Show/hide UI elements +- Adjust layout +- Update controls +- Save preferences + +## Position and Size Events + +### OnMove + +Called when window is moved: + +```go +window.OnMove(func(x, y int) { + fmt.Printf("Window moved to: %d, %d\n", x, y) + + // Save position + saveWindowPosition(x, y) + + // Update related windows + updateRelatedWindowPositions(x, y) +}) +``` + +**Use cases:** +- Save window position +- Update related windows +- Snap to edges +- Multi-monitor handling + +### OnResize + +Called when window is resized: + +```go +window.OnResize(func(width, height int) { + fmt.Printf("Window resized to: %dx%d\n", width, height) + + // Save size + saveWindowSize(width, height) + + // Adjust layout + window.EmitEvent("window-size", map[string]int{ + "width": width, + "height": height, + }) +}) +``` + +**Use cases:** +- Save window size +- Adjust layout +- Update UI +- Responsive design + +**Example: Responsive layout:** + +```go +window.OnResize(func(width, height int) { + var layout string + + if width < 600 { + layout = "compact" + } else if width < 1200 { + layout = "normal" + } else { + layout = "wide" + } + + window.EmitEvent("layout-changed", layout) +}) +``` + +## Complete Example + +Here's a production-ready window with full event handling: + +```go +package main + +import ( + "encoding/json" + "fmt" + "os" + "github.com/wailsapp/wails/v3/pkg/application" +) + +type WindowState struct { + X int `json:"x"` + Y int `json:"y"` + Width int `json:"width"` + Height int `json:"height"` + Maximised bool `json:"maximised"` + Fullscreen bool `json:"fullscreen"` +} + +type ManagedWindow struct { + app *application.Application + window *application.WebviewWindow + state WindowState + dirty bool +} + +func main() { + app := application.New(application.Options{ + Name: "Event Demo", + }) + + mw := &ManagedWindow{app: app} + mw.CreateWindow() + mw.LoadState() + mw.SetupEventHandlers() + + app.Run() +} + +func (mw *ManagedWindow) CreateWindow() { + mw.window = mw.app.Window.NewWithOptions(application.WebviewWindowOptions{ + Name: "main", + Title: "Event Demo", + Width: 800, + Height: 600, + }) +} + +func (mw *ManagedWindow) SetupEventHandlers() { + // Focus events + mw.window.OnFocus(func() { + fmt.Println("Window focused") + mw.window.EmitEvent("focus-state", true) + }) + + mw.window.OnBlur(func() { + fmt.Println("Window blurred") + mw.window.EmitEvent("focus-state", false) + }) + + // State change events + mw.window.OnMinimise(func() { + fmt.Println("Window minimised") + mw.SaveState() + }) + + mw.window.OnUnMinimise(func() { + fmt.Println("Window restored") + }) + + mw.window.OnMaximise(func() { + fmt.Println("Window maximised") + mw.state.Maximised = true + mw.dirty = true + }) + + mw.window.OnUnMaximise(func() { + fmt.Println("Window restored from maximised") + mw.state.Maximised = false + mw.dirty = true + }) + + mw.window.OnFullscreen(func() { + fmt.Println("Window fullscreen") + mw.state.Fullscreen = true + mw.dirty = true + }) + + mw.window.OnUnFullscreen(func() { + fmt.Println("Window exited fullscreen") + mw.state.Fullscreen = false + mw.dirty = true + }) + + // Position and size events + mw.window.OnMove(func(x, y int) { + mw.state.X = x + mw.state.Y = y + mw.dirty = true + }) + + mw.window.OnResize(func(width, height int) { + mw.state.Width = width + mw.state.Height = height + mw.dirty = true + }) + + // Lifecycle events + mw.window.OnClose(func() bool { + if mw.dirty { + mw.SaveState() + } + return true + }) + + mw.window.OnDestroy(func() { + fmt.Println("Window destroyed") + if mw.dirty { + mw.SaveState() + } + }) +} + +func (mw *ManagedWindow) LoadState() { + data, err := os.ReadFile("window-state.json") + if err != nil { + return + } + + if err := json.Unmarshal(data, &mw.state); err != nil { + return + } + + // Restore window state + mw.window.SetPosition(mw.state.X, mw.state.Y) + mw.window.SetSize(mw.state.Width, mw.state.Height) + + if mw.state.Maximised { + mw.window.Maximise() + } + + if mw.state.Fullscreen { + mw.window.Fullscreen() + } +} + +func (mw *ManagedWindow) SaveState() { + data, err := json.Marshal(mw.state) + if err != nil { + return + } + + os.WriteFile("window-state.json", data, 0644) + mw.dirty = false + + fmt.Println("Window state saved") +} +``` + +## Event Coordination + +### Cross-Window Events + +Coordinate between multiple windows: + +```go +// In main window +mainWindow.OnFocus(func() { + // Notify all windows + app.Event.Emit("main-window-focused", nil) +}) + +// In other windows +app.Event.On("main-window-focused", func(event *application.WailsEvent) { + // Update UI + updateRelativeToMain() +}) +``` + +### Event Chains + +Chain events together: + +```go +window.OnMaximise(func() { + // Save state + saveWindowState() + + // Update layout + window.EmitEvent("layout-changed", "maximised") + + // Notify other windows + app.Event.Emit("window-maximised", window.ID()) +}) +``` + +### Debounced Events + +Debounce frequent events: + +```go +var resizeTimer *time.Timer + +window.OnResize(func(width, height int) { + if resizeTimer != nil { + resizeTimer.Stop() + } + + resizeTimer = time.AfterFunc(500*time.Millisecond, func() { + // Save after resize stops + saveWindowSize(width, height) + }) +}) +``` + +## Best Practices + +### ✅ Do + +- **Save state on close** - Restore window position/size +- **Cleanup on destroy** - Release resources +- **Debounce frequent events** - Resize, move +- **Handle focus changes** - Update UI appropriately +- **Coordinate windows** - Use events for communication +- **Test all events** - Ensure handlers work correctly + +### ❌ Don't + +- **Don't block event handlers** - Keep them fast +- **Don't forget cleanup** - Memory leaks +- **Don't ignore errors** - Log or handle them +- **Don't save on every event** - Debounce first +- **Don't create circular events** - Infinite loops +- **Don't forget platform differences** - Test thoroughly + +## Troubleshooting + +### OnClose Not Firing + +**Cause:** Using `window.Destroy()` instead of `window.Close()` + +**Solution:** + +```go +// ✅ Triggers OnClose +window.Close() + +// ❌ Doesn't trigger OnClose +window.Destroy() +``` + +### Events Not Firing + +**Cause:** Handler registered after event occurred + +**Solution:** + +```go +// Register handlers immediately after creation +window := app.Window.New() +window.OnClose(func() bool { return true }) +``` + +### Memory Leaks + +**Cause:** Not cleaning up in OnDestroy + +**Solution:** + +```go +window.OnDestroy(func() { + // Always cleanup + closeResources() + removeReferences() +}) +``` + +## Next Steps + +**Window Basics** - Learn the fundamentals of window management +[Learn More →](/features/windows/basics) + +**Multiple Windows** - Patterns for multi-window applications +[Learn More →](/features/windows/multiple) + +**Events System** - Deep dive into the event system +[Learn More →](/features/events/system) + +**Application Lifecycle** - Understand the application lifecycle +[Learn More →](/concepts/lifecycle) + +--- + +**Questions?** Ask in [Discord](https://discord.gg/JDdSxwjhGf) or check the [examples](https://github.com/wailsapp/wails/tree/v3-alpha/v3/examples). diff --git a/docs/src/content/docs/features/windows/frameless.mdx b/docs/src/content/docs/features/windows/frameless.mdx new file mode 100644 index 000000000..361cced18 --- /dev/null +++ b/docs/src/content/docs/features/windows/frameless.mdx @@ -0,0 +1,870 @@ +--- +title: Frameless Windows +description: Create custom window chrome with frameless windows +sidebar: + order: 4 +--- + +import { Tabs, TabItem, Card, CardGrid } from "@astrojs/starlight/components"; + +## Frameless Windows + +Wails provides **frameless window support** with CSS-based drag regions and platform-native behaviour. Remove the platform-native title bar for complete control over window chrome, custom designs, and unique user experiences whilst maintaining essential functionality like dragging, resizing, and system controls. + +## Quick Start + +```go +window := app.Window.NewWithOptions(application.WebviewWindowOptions{ + Title: "Frameless App", + Width: 800, + Height: 600, + Frameless: true, +}) +``` + +**CSS for draggable title bar:** + +```css +.titlebar { + --wails-draggable: drag; + height: 40px; + background: #333; +} + +.titlebar button { + --wails-draggable: no-drag; +} +``` + +**HTML:** + +```html +
      + My Application + +
      +``` + +**That's it!** You have a custom title bar. + +## Creating Frameless Windows + +### Basic Frameless Window + +```go +window := app.Window.NewWithOptions(application.WebviewWindowOptions{ + Frameless: true, + Width: 800, + Height: 600, +}) +``` + +**What you get:** +- No title bar +- No window borders +- No system buttons +- Transparent background (optional) + +**What you need to implement:** +- Draggable area +- Close/minimise/maximise buttons +- Resize handles (if resizable) + +### With Transparent Background + +```go +window := app.Window.NewWithOptions(application.WebviewWindowOptions{ + Frameless: true, + BackgroundType: application.BackgroundTypeTransparent, +}) +``` + +**Use cases:** +- Rounded corners +- Custom shapes +- Overlay windows +- Splash screens + +## Drag Regions + +### CSS-Based Dragging + +Use the `--wails-draggable` CSS property: + +```css +/* Draggable area */ +.titlebar { + --wails-draggable: drag; +} + +/* Non-draggable elements within draggable area */ +.titlebar button { + --wails-draggable: no-drag; +} +``` + +**Values:** +- `drag` - Area is draggable +- `no-drag` - Area is not draggable (even if parent is) + +### Complete Title Bar Example + +```html +
      +
      My Application
      +
      + + + +
      +
      +``` + +```css +.titlebar { + --wails-draggable: drag; + display: flex; + justify-content: space-between; + align-items: center; + height: 40px; + background: #2c2c2c; + color: white; + padding: 0 16px; +} + +.title { + font-size: 14px; + user-select: none; +} + +.controls { + display: flex; + gap: 8px; +} + +.controls button { + --wails-draggable: no-drag; + width: 32px; + height: 32px; + border: none; + background: transparent; + color: white; + font-size: 16px; + cursor: pointer; + border-radius: 4px; +} + +.controls button:hover { + background: rgba(255, 255, 255, 0.1); +} + +.controls .close:hover { + background: #e81123; +} +``` + +**JavaScript for buttons:** + +```javascript +import { WindowMinimise, WindowMaximise, WindowClose } from '@wailsio/runtime' + +document.querySelector('.minimize').addEventListener('click', WindowMinimise) +document.querySelector('.maximize').addEventListener('click', WindowMaximise) +document.querySelector('.close').addEventListener('click', WindowClose) +``` + +## System Buttons + +### Implementing Close/Minimise/Maximise + +**Go side:** + +```go +type WindowControls struct { + window *application.WebviewWindow +} + +func (wc *WindowControls) Minimise() { + wc.window.Minimise() +} + +func (wc *WindowControls) Maximise() { + if wc.window.IsMaximised() { + wc.window.UnMaximise() + } else { + wc.window.Maximise() + } +} + +func (wc *WindowControls) Close() { + wc.window.Close() +} +``` + +**JavaScript side:** + +```javascript +import { Minimise, Maximise, Close } from './bindings/WindowControls' + +document.querySelector('.minimize').addEventListener('click', Minimise) +document.querySelector('.maximize').addEventListener('click', Maximise) +document.querySelector('.close').addEventListener('click', Close) +``` + +**Or use runtime methods:** + +```javascript +import { + WindowMinimise, + WindowMaximise, + WindowClose +} from '@wailsio/runtime' + +document.querySelector('.minimize').addEventListener('click', WindowMinimise) +document.querySelector('.maximize').addEventListener('click', WindowMaximise) +document.querySelector('.close').addEventListener('click', WindowClose) +``` + +### Toggle Maximise State + +Track maximise state for button icon: + +```javascript +import { WindowIsMaximised, WindowMaximise, WindowUnMaximise } from '@wailsio/runtime' + +async function toggleMaximise() { + const isMaximised = await WindowIsMaximised() + + if (isMaximised) { + await WindowUnMaximise() + } else { + await WindowMaximise() + } + + updateMaximiseButton() +} + +async function updateMaximiseButton() { + const isMaximised = await WindowIsMaximised() + const button = document.querySelector('.maximize') + button.textContent = isMaximised ? '❐' : '□' +} +``` + +## Resize Handles + +### CSS-Based Resize + +Wails provides automatic resize handles for frameless windows: + +```css +/* Enable resize on all edges */ +body { + --wails-resize: all; +} + +/* Or specific edges */ +.resize-top { + --wails-resize: top; +} + +.resize-bottom { + --wails-resize: bottom; +} + +.resize-left { + --wails-resize: left; +} + +.resize-right { + --wails-resize: right; +} + +/* Corners */ +.resize-top-left { + --wails-resize: top-left; +} + +.resize-top-right { + --wails-resize: top-right; +} + +.resize-bottom-left { + --wails-resize: bottom-left; +} + +.resize-bottom-right { + --wails-resize: bottom-right; +} +``` + +**Values:** +- `all` - Resize from all edges +- `top`, `bottom`, `left`, `right` - Specific edges +- `top-left`, `top-right`, `bottom-left`, `bottom-right` - Corners +- `none` - No resize + +### Resize Handle Example + +```html +
      +
      ...
      +
      ...
      +
      +
      +``` + +```css +.resize-handle { + position: absolute; + width: 16px; + height: 16px; +} + +.resize-bottom-right { + --wails-resize: bottom-right; + bottom: 0; + right: 0; + cursor: nwse-resize; +} +``` + +## Platform-Specific Behaviour + + + + **Windows frameless windows:** + + ```go + window := app.Window.NewWithOptions(application.WebviewWindowOptions{ + Frameless: true, + Windows: application.WindowsOptions{ + DisableFramelessWindowDecorations: false, + }, + }) + ``` + + **Features:** + - Automatic drop shadow + - Snap layouts support (Windows 11) + - Aero Snap support + - DPI scaling + + **Disable decorations:** + ```go + Windows: application.WindowsOptions{ + DisableFramelessWindowDecorations: true, + }, + ``` + + **Snap Assist:** + ```go + // Trigger Windows 11 Snap Assist + window.SnapAssist() + ``` + + **Custom title bar height:** + Windows automatically detects drag regions from CSS. + + + + **macOS frameless windows:** + + ```go + window := app.Window.NewWithOptions(application.WebviewWindowOptions{ + Frameless: true, + Mac: application.MacOptions{ + TitleBarAppearsTransparent: true, + InvisibleTitleBarHeight: 40, + }, + }) + ``` + + **Features:** + - Native fullscreen support + - Traffic light buttons (optional) + - Vibrancy effects + - Transparent title bar + + **Hide traffic lights:** + ```go + Mac: application.MacOptions{ + TitleBarStyle: application.MacTitleBarStyleHidden, + }, + ``` + + **Invisible title bar:** + Allows dragging whilst hiding the title bar. This only takes effect when the window is frameless or uses `AppearsTransparent`: + ```go + Mac: application.MacOptions{ + InvisibleTitleBarHeight: 40, + }, + ``` + + + + **Linux frameless windows:** + + ```go + window := app.Window.NewWithOptions(application.WebviewWindowOptions{ + Frameless: true, + }) + ``` + + **Features:** + - Basic frameless support + - CSS drag regions + - Varies by desktop environment + + **Desktop environment notes:** + - **GNOME:** Good support + - **KDE Plasma:** Good support + - **XFCE:** Basic support + - **Tiling WMs:** Limited support + + **Compositor required:** + Transparency requires a compositor (most modern DEs have one). + + + +## Common Patterns + +### Pattern 1: Modern Title Bar + +```html +
      +
      + App Icon +
      +
      My Application
      +
      + + + +
      +
      +``` + +```css +.modern-titlebar { + --wails-draggable: drag; + display: flex; + align-items: center; + height: 40px; + background: linear-gradient(to bottom, #3a3a3a, #2c2c2c); + border-bottom: 1px solid #1a1a1a; + padding: 0 16px; +} + +.app-icon { + --wails-draggable: no-drag; + width: 24px; + height: 24px; + margin-right: 12px; +} + +.title { + flex: 1; + font-size: 13px; + color: #e0e0e0; + user-select: none; +} + +.controls { + display: flex; + gap: 1px; +} + +.controls button { + --wails-draggable: no-drag; + width: 46px; + height: 32px; + border: none; + background: transparent; + color: #e0e0e0; + font-size: 14px; + cursor: pointer; + transition: background 0.2s; +} + +.controls button:hover { + background: rgba(255, 255, 255, 0.1); +} + +.controls .close:hover { + background: #e81123; + color: white; +} +``` + +### Pattern 2: Splash Screen + +```go +splash := app.Window.NewWithOptions(application.WebviewWindowOptions{ + Title: "Loading...", + Width: 400, + Height: 300, + Frameless: true, + AlwaysOnTop: true, + BackgroundType: application.BackgroundTypeTransparent, +}) +``` + +```css +body { + background: transparent; + display: flex; + justify-content: center; + align-items: center; +} + +.splash { + background: white; + border-radius: 12px; + box-shadow: 0 8px 32px rgba(0, 0, 0, 0.3); + padding: 40px; + text-align: center; +} +``` + +### Pattern 3: Rounded Window + +```go +window := app.Window.NewWithOptions(application.WebviewWindowOptions{ + Frameless: true, + BackgroundType: application.BackgroundTypeTransparent, +}) +``` + +```css +body { + background: transparent; + margin: 8px; +} + +.window { + background: white; + border-radius: 16px; + box-shadow: 0 4px 24px rgba(0, 0, 0, 0.15); + overflow: hidden; + height: calc(100vh - 16px); +} + +.titlebar { + --wails-draggable: drag; + background: #f5f5f5; + border-bottom: 1px solid #e0e0e0; +} +``` + +### Pattern 4: Overlay Window + +```go +overlay := app.Window.NewWithOptions(application.WebviewWindowOptions{ + Frameless: true, + AlwaysOnTop: true, + BackgroundType: application.BackgroundTypeTransparent, +}) +``` + +```css +body { + background: transparent; +} + +.overlay { + background: rgba(0, 0, 0, 0.8); + backdrop-filter: blur(10px); + border-radius: 8px; + padding: 20px; +} +``` + +## Complete Example + +Here's a production-ready frameless window: + +**Go:** + +```go +package main + +import ( + _ "embed" + "github.com/wailsapp/wails/v3/pkg/application" +) + +//go:embed frontend/dist +var assets embed.FS + +func main() { + app := application.New(application.Options{ + Name: "Frameless App", + }) + + window := app.Window.NewWithOptions(application.WebviewWindowOptions{ + Title: "Frameless Application", + Width: 1000, + Height: 700, + MinWidth: 800, + MinHeight: 600, + Frameless: true, + + Assets: application.AssetOptions{ + Handler: application.AssetFileServerFS(assets), + }, + + Mac: application.MacOptions{ + TitleBarAppearsTransparent: true, + InvisibleTitleBarHeight: 40, + }, + + Windows: application.WindowsOptions{ + DisableFramelessWindowDecorations: false, + }, + }) + + window.Center() + window.Show() + + app.Run() +} +``` + +**HTML:** + +```html + + + + + + +
      +
      +
      Frameless Application
      +
      + + + +
      +
      +
      +

      Hello from Frameless Window!

      +
      +
      + + + +``` + +**CSS:** + +```css +* { + margin: 0; + padding: 0; + box-sizing: border-box; +} + +body { + font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, sans-serif; + background: #f5f5f5; +} + +.window { + height: 100vh; + display: flex; + flex-direction: column; +} + +.titlebar { + --wails-draggable: drag; + display: flex; + justify-content: space-between; + align-items: center; + height: 40px; + background: #ffffff; + border-bottom: 1px solid #e0e0e0; + padding: 0 16px; +} + +.title { + font-size: 13px; + font-weight: 500; + color: #333; + user-select: none; +} + +.controls { + display: flex; + gap: 8px; +} + +.controls button { + --wails-draggable: no-drag; + width: 32px; + height: 32px; + border: none; + background: transparent; + color: #666; + font-size: 16px; + cursor: pointer; + border-radius: 4px; + display: flex; + align-items: center; + justify-content: center; + transition: all 0.2s; +} + +.controls button:hover { + background: #f0f0f0; + color: #333; +} + +.controls .close:hover { + background: #e81123; + color: white; +} + +.content { + flex: 1; + padding: 40px; + overflow: auto; +} +``` + +**JavaScript:** + +```javascript +import { + WindowMinimise, + WindowMaximise, + WindowUnMaximise, + WindowIsMaximised, + WindowClose +} from '@wailsio/runtime' + +// Minimise button +document.querySelector('.minimize').addEventListener('click', () => { + WindowMinimise() +}) + +// Maximise/restore button +const maximiseBtn = document.querySelector('.maximize') +maximiseBtn.addEventListener('click', async () => { + const isMaximised = await WindowIsMaximised() + + if (isMaximised) { + await WindowUnMaximise() + } else { + await WindowMaximise() + } + + updateMaximiseButton() +}) + +// Close button +document.querySelector('.close').addEventListener('click', () => { + WindowClose() +}) + +// Update maximise button icon +async function updateMaximiseButton() { + const isMaximised = await WindowIsMaximised() + maximiseBtn.textContent = isMaximised ? '❐' : '□' + maximiseBtn.title = isMaximised ? 'Restore' : 'Maximise' +} + +// Initial state +updateMaximiseButton() +``` + +## Best Practices + +### ✅ Do + +- **Provide draggable area** - Users need to move the window +- **Implement system buttons** - Close, minimise, maximise +- **Set minimum size** - Prevent unusable layouts +- **Test on all platforms** - Behaviour varies +- **Use CSS for drag regions** - Flexible and maintainable +- **Provide visual feedback** - Hover states on buttons + +### ❌ Don't + +- **Don't forget resize handles** - If window is resizable +- **Don't make entire window draggable** - Prevents interaction +- **Don't forget no-drag on buttons** - They won't work +- **Don't use tiny drag areas** - Hard to grab +- **Don't forget platform differences** - Test thoroughly + +## Troubleshooting + +### Window Won't Drag + +**Cause:** Missing `--wails-draggable: drag` + +**Solution:** + +```css +.titlebar { + --wails-draggable: drag; +} +``` + +### Buttons Don't Work + +**Cause:** Buttons are in draggable area + +**Solution:** + +```css +.titlebar button { + --wails-draggable: no-drag; +} +``` + +### Can't Resize Window + +**Cause:** Missing resize handles + +**Solution:** + +```css +body { + --wails-resize: all; +} +``` + +## Next Steps + + + + Learn the fundamentals of window management. + + [Learn More →](/features/windows/basics) + + + + Complete reference for window options. + + [Learn More →](/features/windows/options) + + + + Handle window lifecycle events. + + [Learn More →](/features/windows/events) + + + + Patterns for multi-window applications. + + [Learn More →](/features/windows/multiple) + + + +--- + +**Questions?** Ask in [Discord](https://discord.gg/JDdSxwjhGf) or check the [frameless example](https://github.com/wailsapp/wails/tree/v3-alpha/v3/examples/frameless). diff --git a/docs/src/content/docs/features/windows/multiple.mdx b/docs/src/content/docs/features/windows/multiple.mdx new file mode 100644 index 000000000..41d5a18fe --- /dev/null +++ b/docs/src/content/docs/features/windows/multiple.mdx @@ -0,0 +1,814 @@ +--- +title: Multiple Windows +description: Patterns and best practices for multi-window applications +sidebar: + order: 3 +--- + +import { Tabs, TabItem } from "@astrojs/starlight/components"; + +## Multi-Window Applications + +Wails v3 provides **native multi-window support** for creating settings windows, document windows, tool palettes, and inspector windows. Track windows, enable communication between them, and manage their lifecycle with simple, consistent APIs. + +### Main + Settings Window + +```go +package main + +import "github.com/wailsapp/wails/v3/pkg/application" + +type App struct { + app *application.Application + mainWindow *application.WebviewWindow + settingsWindow *application.WebviewWindow +} + +func main() { + app := &App{} + + app.app = application.New(application.Options{ + Name: "Multi-Window App", + }) + + // Create main window + app.mainWindow = app.app.Window.NewWithOptions(application.WebviewWindowOptions{ + Name: "main", + Title: "Main Application", + Width: 1200, + Height: 800, + }) + + // Create settings window (hidden initially) + app.settingsWindow = app.app.Window.NewWithOptions(application.WebviewWindowOptions{ + Name: "settings", + Title: "Settings", + Width: 600, + Height: 400, + Hidden: true, + }) + + app.app.Run() +} + +// Show settings from main window +func (a *App) ShowSettings() { + if a.settingsWindow != nil { + a.settingsWindow.Show() + a.settingsWindow.SetFocus() + } +} +``` + +**Key points:** +- Main window always visible +- Settings window created but hidden +- Show settings on demand +- Reuse same window (don't create multiple) + +## Window Tracking + +### Get All Windows + +```go +windows := app.Window.GetAll() +fmt.Printf("Total windows: %d\n", len(windows)) + +for _, window := range windows { + fmt.Printf("- %s (ID: %d)\n", window.Name(), window.ID()) +} +``` + +### Find Specific Window + +```go +// By name +settings := app.GetWindowByName("settings") +if settings != nil { + settings.Show() +} + +// By ID +window := app.GetWindowByID(123) + +// Current (focused) window +current := app.Window.Current() +``` + +### Window Registry Pattern + +Track windows in your application: + +```go +type WindowManager struct { + windows map[string]*application.WebviewWindow + mu sync.RWMutex +} + +func (wm *WindowManager) Register(name string, window *application.WebviewWindow) { + wm.mu.Lock() + defer wm.mu.Unlock() + wm.windows[name] = window +} + +func (wm *WindowManager) Get(name string) *application.WebviewWindow { + wm.mu.RLock() + defer wm.mu.RUnlock() + return wm.windows[name] +} + +func (wm *WindowManager) Remove(name string) { + wm.mu.Lock() + defer wm.mu.Unlock() + delete(wm.windows, name) +} +``` + +## Window Communication + +### Using Events + +Windows communicate via the event system: + +```go +// In main window - emit event +app.Event.Emit("settings-changed", map[string]interface{}{ + "theme": "dark", + "fontSize": 14, +}) + +// In settings window - listen for event +app.Event.On("settings-changed", func(event *application.WailsEvent) { + data := event.Data.(map[string]interface{}) + theme := data["theme"].(string) + fontSize := data["fontSize"].(int) + + // Update UI + updateSettings(theme, fontSize) +}) +``` + +### Shared State Pattern + +Use a shared state manager: + +```go +type AppState struct { + theme string + fontSize int + mu sync.RWMutex +} + +var state = &AppState{ + theme: "light", + fontSize: 12, +} + +func (s *AppState) SetTheme(theme string) { + s.mu.Lock() + s.theme = theme + s.mu.Unlock() + + // Notify all windows + app.Event.Emit("theme-changed", theme) +} + +func (s *AppState) GetTheme() string { + s.mu.RLock() + defer s.mu.RUnlock() + return s.theme +} +``` + +### Window-to-Window Messages + +Send messages between specific windows: + +```go +// Get target window +targetWindow := app.GetWindowByName("preview") + +// Emit event to specific window +targetWindow.EmitEvent("update-preview", previewData) +``` + +## Common Patterns + +### Pattern 1: Singleton Windows + +Ensure only one instance of a window exists: + +```go +var settingsWindow *application.WebviewWindow + +func ShowSettings(app *application.Application) { + // Create if doesn't exist + if settingsWindow == nil { + settingsWindow = app.Window.NewWithOptions(application.WebviewWindowOptions{ + Name: "settings", + Title: "Settings", + Width: 600, + Height: 400, + }) + + // Cleanup on close + settingsWindow.OnDestroy(func() { + settingsWindow = nil + }) + } + + // Show and focus + settingsWindow.Show() + settingsWindow.SetFocus() +} +``` + +### Pattern 2: Document Windows + +Multiple instances of the same window type: + +```go +type DocumentWindow struct { + window *application.WebviewWindow + filePath string + modified bool +} + +var documents = make(map[string]*DocumentWindow) + +func OpenDocument(app *application.Application, filePath string) { + // Check if already open + if doc, exists := documents[filePath]; exists { + doc.window.Show() + doc.window.SetFocus() + return + } + + // Create new document window + window := app.Window.NewWithOptions(application.WebviewWindowOptions{ + Title: filepath.Base(filePath), + Width: 800, + Height: 600, + }) + + doc := &DocumentWindow{ + window: window, + filePath: filePath, + modified: false, + } + + documents[filePath] = doc + + // Cleanup on close + window.OnDestroy(func() { + delete(documents, filePath) + }) + + // Load document + loadDocument(window, filePath) +} +``` + +### Pattern 3: Tool Palettes + +Floating windows that stay on top: + +```go +func CreateToolPalette(app *application.Application) *application.WebviewWindow { + palette := app.Window.NewWithOptions(application.WebviewWindowOptions{ + Name: "tools", + Title: "Tools", + Width: 200, + Height: 400, + AlwaysOnTop: true, + Resizable: false, + }) + + return palette +} +``` + +### Pattern 4: Modal dialogs + +Child windows that block parent: + +```go +func ShowModaldialog(parent *application.WebviewWindow, title string) { + dialog := app.Window.NewWithOptions(application.WebviewWindowOptions{ + Title: title, + Width: 400, + Height: 200, + Parent: parent, + AlwaysOnTop: true, + Resizable: false, + }) + + // Disable parent (platform-specific) + parent.SetEnabled(false) + + // Re-enable parent on close + dialog.OnDestroy(func() { + parent.SetEnabled(true) + parent.SetFocus() + }) +} +``` + +### Pattern 5: Inspector/Preview Windows + +Linked windows that update together: + +```go +type EditorApp struct { + editor *application.WebviewWindow + preview *application.WebviewWindow +} + +func (e *EditorApp) UpdatePreview(content string) { + if e.preview != nil && e.preview.IsVisible() { + e.preview.EmitEvent("content-changed", content) + } +} + +func (e *EditorApp) TogglePreview() { + if e.preview == nil { + e.preview = app.Window.NewWithOptions(application.WebviewWindowOptions{ + Name: "preview", + Title: "Preview", + Width: 600, + Height: 800, + }) + + e.preview.OnDestroy(func() { + e.preview = nil + }) + } + + if e.preview.IsVisible() { + e.preview.Hide() + } else { + e.preview.Show() + } +} +``` + +## Parent-Child Relationships + +### Creating Child Windows + +```go +childWindow := app.Window.NewWithOptions(application.WebviewWindowOptions{ + Title: "Child Window", + Parent: parentWindow, +}) +``` + +**Behaviour:** +- Child closes when parent closes +- Child stays above parent (on some platforms) +- Child minimises with parent (on some platforms) + +**Platform support:** + +| Feature | macOS | Windows | Linux | +|---------|-------|---------|-------| +| Auto-close | ✅ | ✅ | ⚠️ Varies | +| Stay above | ✅ | ⚠️ Partial | ⚠️ Varies | +| Minimise together | ✅ | ❌ | ⚠️ Varies | + +### Modal Behaviour + +Create modal-like behaviour: + +```go +func ShowModal(parent *application.WebviewWindow) { + modal := app.Window.NewWithOptions(application.WebviewWindowOptions{ + Title: "Modal dialog", + Width: 400, + Height: 200, + Parent: parent, + AlwaysOnTop: true, + }) + + // Disable parent interaction + parent.SetEnabled(false) + + // Re-enable on close + modal.OnClose(func() bool { + parent.SetEnabled(true) + parent.SetFocus() + return true + }) +} +``` + +**Note:** True modal behaviour (blocking) varies by platform. + +## Window Lifecycle Management + +### Creation Callbacks + +Be notified when windows are created: + +```go +app.OnWindowCreation(func(window *application.WebviewWindow) { + fmt.Printf("Window created: %s\n", window.Name()) + + // Configure all new windows + window.SetMinSize(400, 300) +}) +``` + +### Destruction Callbacks + +Cleanup when windows are destroyed: + +```go +window.OnDestroy(func() { + fmt.Printf("Window %s destroyed\n", window.Name()) + + // Cleanup resources + cleanup(window.ID()) + + // Remove from tracking + removeFromRegistry(window.Name()) +}) +``` + +### Application Quit Behaviour + +Control when application quits: + +```go +app := application.New(application.Options{ + Mac: application.MacOptions{ + // Don't quit when last window closes + ApplicationShouldTerminateAfterLastWindowClosed: false, + }, +}) +``` + +**Use cases:** +- System tray applications +- Background services +- Menu bar applications (macOS) + +## Memory Management + +### Preventing Leaks + +Always clean up window references: + +```go +var windows = make(map[string]*application.WebviewWindow) + +func CreateWindow(name string) { + window := app.Window.New() + windows[name] = window + + // IMPORTANT: Clean up on destroy + window.OnDestroy(func() { + delete(windows, name) + }) +} +``` + +### Closing vs Destroying + +```go +// Close - triggers OnClose, can be cancelled +window.Close() + +// Destroy - immediate, cannot be cancelled +window.Destroy() +``` + +**Best practice:** Use `Close()` for user-initiated closes, `Destroy()` for cleanup. + +### Resource Cleanup + +```go +type ManagedWindow struct { + window *application.WebviewWindow + resources []io.Closer +} + +func (mw *ManagedWindow) Destroy() { + // Close all resources + for _, resource := range mw.resources { + resource.Close() + } + + // Destroy window + mw.window.Destroy() +} +``` + +## Advanced Patterns + +### Window Pool + +Reuse windows instead of creating new ones: + +```go +type WindowPool struct { + available []*application.WebviewWindow + inUse map[uint]*application.WebviewWindow + mu sync.Mutex +} + +func (wp *WindowPool) Acquire() *application.WebviewWindow { + wp.mu.Lock() + defer wp.mu.Unlock() + + // Reuse available window + if len(wp.available) > 0 { + window := wp.available[0] + wp.available = wp.available[1:] + wp.inUse[window.ID()] = window + return window + } + + // Create new window + window := app.Window.New() + wp.inUse[window.ID()] = window + return window +} + +func (wp *WindowPool) Release(window *application.WebviewWindow) { + wp.mu.Lock() + defer wp.mu.Unlock() + + delete(wp.inUse, window.ID()) + window.Hide() + wp.available = append(wp.available, window) +} +``` + +### Window Groups + +Manage related windows together: + +```go +type WindowGroup struct { + name string + windows []*application.WebviewWindow +} + +func (wg *WindowGroup) Add(window *application.WebviewWindow) { + wg.windows = append(wg.windows, window) +} + +func (wg *WindowGroup) ShowAll() { + for _, window := range wg.windows { + window.Show() + } +} + +func (wg *WindowGroup) HideAll() { + for _, window := range wg.windows { + window.Hide() + } +} + +func (wg *WindowGroup) CloseAll() { + for _, window := range wg.windows { + window.Close() + } +} +``` + +### Workspace Management + +Save and restore window layouts: + +```go +type WindowLayout struct { + Windows []WindowState `json:"windows"` +} + +type WindowState struct { + Name string `json:"name"` + X int `json:"x"` + Y int `json:"y"` + Width int `json:"width"` + Height int `json:"height"` +} + +func SaveLayout() *WindowLayout { + layout := &WindowLayout{} + + for _, window := range app.Window.GetAll() { + x, y := window.Position() + width, height := window.Size() + + layout.Windows = append(layout.Windows, WindowState{ + Name: window.Name(), + X: x, + Y: y, + Width: width, + Height: height, + }) + } + + return layout +} + +func RestoreLayout(layout *WindowLayout) { + for _, state := range layout.Windows { + window := app.GetWindowByName(state.Name) + if window != nil { + window.SetPosition(state.X, state.Y) + window.SetSize(state.Width, state.Height) + } + } +} +``` + +## Complete Example + +Here's a production-ready multi-window application: + +```go +package main + +import ( + "encoding/json" + "os" + "sync" + "github.com/wailsapp/wails/v3/pkg/application" +) + +type MultiWindowApp struct { + app *application.Application + windows map[string]*application.WebviewWindow + mu sync.RWMutex +} + +func main() { + mwa := &MultiWindowApp{ + windows: make(map[string]*application.WebviewWindow), + } + + mwa.app = application.New(application.Options{ + Name: "Multi-Window Application", + Mac: application.MacOptions{ + ApplicationShouldTerminateAfterLastWindowClosed: false, + }, + }) + + // Create main window + mwa.CreateMainWindow() + + // Load saved layout + mwa.LoadLayout() + + mwa.app.Run() +} + +func (mwa *MultiWindowApp) CreateMainWindow() { + window := mwa.app.Window.NewWithOptions(application.WebviewWindowOptions{ + Name: "main", + Title: "Main Application", + Width: 1200, + Height: 800, + }) + + mwa.RegisterWindow("main", window) +} + +func (mwa *MultiWindowApp) ShowSettings() { + if window := mwa.GetWindow("settings"); window != nil { + window.Show() + window.SetFocus() + return + } + + window := mwa.app.Window.NewWithOptions(application.WebviewWindowOptions{ + Name: "settings", + Title: "Settings", + Width: 600, + Height: 400, + }) + + mwa.RegisterWindow("settings", window) +} + +func (mwa *MultiWindowApp) OpenDocument(path string) { + name := "doc-" + path + + if window := mwa.GetWindow(name); window != nil { + window.Show() + window.SetFocus() + return + } + + window := mwa.app.Window.NewWithOptions(application.WebviewWindowOptions{ + Name: name, + Title: path, + Width: 800, + Height: 600, + }) + + mwa.RegisterWindow(name, window) +} + +func (mwa *MultiWindowApp) RegisterWindow(name string, window *application.WebviewWindow) { + mwa.mu.Lock() + mwa.windows[name] = window + mwa.mu.Unlock() + + window.OnDestroy(func() { + mwa.UnregisterWindow(name) + }) +} + +func (mwa *MultiWindowApp) UnregisterWindow(name string) { + mwa.mu.Lock() + delete(mwa.windows, name) + mwa.mu.Unlock() +} + +func (mwa *MultiWindowApp) GetWindow(name string) *application.WebviewWindow { + mwa.mu.RLock() + defer mwa.mu.RUnlock() + return mwa.windows[name] +} + +func (mwa *MultiWindowApp) SaveLayout() { + layout := make(map[string]WindowState) + + mwa.mu.RLock() + for name, window := range mwa.windows { + x, y := window.Position() + width, height := window.Size() + + layout[name] = WindowState{ + X: x, + Y: y, + Width: width, + Height: height, + } + } + mwa.mu.RUnlock() + + data, _ := json.Marshal(layout) + os.WriteFile("layout.json", data, 0644) +} + +func (mwa *MultiWindowApp) LoadLayout() { + data, err := os.ReadFile("layout.json") + if err != nil { + return + } + + var layout map[string]WindowState + if err := json.Unmarshal(data, &layout); err != nil { + return + } + + for name, state := range layout { + if window := mwa.GetWindow(name); window != nil { + window.SetPosition(state.X, state.Y) + window.SetSize(state.Width, state.Height) + } + } +} + +type WindowState struct { + X int `json:"x"` + Y int `json:"y"` + Width int `json:"width"` + Height int `json:"height"` +} +``` + +## Best Practices + +### ✅ Do + +- **Track windows** - Keep references for easy access +- **Clean up on destroy** - Prevent memory leaks +- **Use events for communication** - Decoupled architecture +- **Reuse windows** - Don't create duplicates +- **Save/restore layouts** - Better UX +- **Handle window close** - Confirm before closing with unsaved data + +### ❌ Don't + +- **Don't create unlimited windows** - Memory and performance issues +- **Don't forget to clean up** - Memory leaks +- **Don't use global variables carelessly** - Thread-safety issues +- **Don't block window creation** - Create asynchronously if needed +- **Don't ignore platform differences** - Test on all platforms + +## Next Steps + +- [Window Basics](/features/windows/basics) - Learn the fundamentals of window management +- [Window Events](/features/windows/events) - Handle window lifecycle events +- [Events System](/features/events/system) - Deep dive into the event system +- [Frameless Windows](/features/windows/frameless) - Create custom window chrome + +--- + +**Questions?** Ask in [Discord](https://discord.gg/JDdSxwjhGf) or check the [multi-window example](https://github.com/wailsapp/wails/tree/v3-alpha/v3/examples/multi-window). diff --git a/docs/src/content/docs/features/windows/options.mdx b/docs/src/content/docs/features/windows/options.mdx new file mode 100644 index 000000000..9b38d5e2b --- /dev/null +++ b/docs/src/content/docs/features/windows/options.mdx @@ -0,0 +1,1095 @@ +--- +title: Window Options +description: Complete reference for WebviewWindowOptions +sidebar: + order: 2 +--- + +import { Tabs, TabItem } from "@astrojs/starlight/components"; + +## Window Configuration Options + +Wails provides comprehensive window configuration with dozens of options for size, position, appearance, and behaviour. This reference covers all available options across Windows, macOS, and Linux as the **complete reference** for `WebviewWindowOptions`. Every option, every platform, with examples and constraints. + +## WebviewWindowOptions Structure + +```go +type WebviewWindowOptions struct { + // Identity + Name string + Title string + + // Size and Position + Width int + Height int + X int + Y int + MinWidth int + MinHeight int + MaxWidth int + MaxHeight int + + // Initial State + Hidden bool + Frameless bool + Resizable bool + AlwaysOnTop bool + Fullscreen bool + Minimised bool + Maximised bool + WindowState WindowState + + // Appearance + BackgroundColour RGBA + BackgroundType BackgroundType + + // Content + URL string + HTML string + + // Assets + Assets application.AssetOptions + + // Security + ContentProtectionEnabled bool + + // Menu + UseApplicationMenu bool + + // Lifecycle + OnClose func() bool + OnDestroy func() + + // Platform-Specific + Mac MacOptions + Windows WindowsOptions + Linux LinuxOptions +} +``` + +## Core Options + +### Name + +**Type:** `string` +**Default:** Auto-generated UUID +**Platform:** All + +```go +Name: "main-window" +``` + +**Purpose:** Unique identifier for finding windows later. + +**Best practices:** +- Use descriptive names: `"main"`, `"settings"`, `"about"` +- Use kebab-case: `"file-browser"`, `"color-picker"` +- Keep it short and memorable + +**Example:** + +```go +window := app.Window.NewWithOptions(application.WebviewWindowOptions{ + Name: "settings-window", +}) + +// Later... +settings := app.GetWindowByName("settings-window") +``` + +### Title + +**Type:** `string` +**Default:** Application name +**Platform:** All + +```go +Title: "My Application" +``` + +**Purpose:** Text shown in title bar and taskbar. + +**Dynamic updates:** + +```go +window.SetTitle("My Application - Document.txt") +``` + +### Width / Height + +**Type:** `int` (pixels) +**Default:** 800 x 600 +**Platform:** All +**Constraints:** Must be positive + +```go +Width: 1200, +Height: 800, +``` + +**Purpose:** Initial window size in logical pixels. + +**Notes:** +- Wails handles DPI scaling automatically +- Use logical pixels, not physical pixels +- Consider minimum screen resolution (1024x768) + +**Example sizes:** + +| Use Case | Width | Height | +|----------|-------|--------| +| Small utility | 400 | 300 | +| Standard app | 1024 | 768 | +| Large app | 1440 | 900 | +| Full HD | 1920 | 1080 | + +### X / Y + +**Type:** `int` (pixels) +**Default:** Centred on screen +**Platform:** All + +```go +X: 100, // 100px from left edge +Y: 100, // 100px from top edge +``` + +**Purpose:** Initial window position. + +**Coordinate system:** +- (0, 0) is top-left of primary screen +- Positive X goes right +- Positive Y goes down + +**Example:** + +```go +settings := app.Window.NewWithOptions(application.WebviewWindowOptions{ + Name: "coordinate-window", + InitialPosition: application.WindowXY, // use coordinate system + X: 100, + Y: 100, +}) + +**Best practice:** Use `Center()` to center the window: + +```go +window := app.Window.New() +window.Center() +``` + +### MinWidth / MinHeight + +**Type:** `int` (pixels) +**Default:** 0 (no minimum) +**Platform:** All + +```go +MinWidth: 400, +MinHeight: 300, +``` + +**Purpose:** Prevent window from being too small. + +**Use cases:** +- Prevent broken layouts +- Ensure usability +- Maintain aspect ratio + +**Example:** + +```go +// Prevent window smaller than 400x300 +MinWidth: 400, +MinHeight: 300, +``` + +### MaxWidth / MaxHeight + +**Type:** `int` (pixels) +**Default:** 0 (no maximum) +**Platform:** All + +```go +MaxWidth: 1920, +MaxHeight: 1080, +``` + +**Purpose:** Prevent window from being too large. + +**Use cases:** +- Fixed-size applications +- Prevent excessive resource usage +- Maintain design constraints + +## State Options + +### Hidden + +**Type:** `bool` +**Default:** `false` +**Platform:** All + +```go +Hidden: true, +``` + +**Purpose:** Create window without showing it. + +**Use cases:** +- Background windows +- Windows shown on demand +- Splash screens (create, load, then show) +- Prevent white flash while loading content + +**Platform improvements:** +- **Windows:** Fixed white window flash - window stays invisible until `Show()` is called +- **macOS:** Full support +- **Linux:** Full support + +**Recommended pattern for smooth loading:** + +```go +// Create hidden window +window := app.Window.NewWithOptions(application.WebviewWindowOptions{ + Name: "main-window", + Hidden: true, + BackgroundColour: application.RGBA{R: 30, G: 30, B: 30, A: 255}, // Match your theme +}) + +// Load content while hidden +// ... content loads ... + +// Show when ready (no flash!) +window.Show() +``` + +**Example:** + +```go +settings := app.Window.NewWithOptions(application.WebviewWindowOptions{ + Name: "settings", + Hidden: true, +}) + +// Show when needed +settings.Show() +``` + +### Frameless + +**Type:** `bool` +**Default:** `false` +**Platform:** All + +```go +Frameless: true, +``` + +**Purpose:** Remove title bar and window borders. + +**Use cases:** +- Custom window chrome +- Splash screens +- Kiosk applications +- Custom-designed windows + +**Important:** You'll need to implement: +- Window dragging +- Close/minimise/maximise buttons +- Resize handles (if resizable) + +**See [Frameless Windows](/features/windows/frameless) for details.** + +### Resizable + +**Type:** `bool` +**Default:** `true` +**Platform:** All + +```go +Resizable: false, +``` + +**Purpose:** Allow/prevent window resizing. + +**Use cases:** +- Fixed-size applications +- Splash screens +- dialogs + +**Note:** Users can still maximise/fullscreen unless you prevent those too. + +### AlwaysOnTop + +**Type:** `bool` +**Default:** `false` +**Platform:** All + +```go +AlwaysOnTop: true, +``` + +**Purpose:** Keep window above all other windows. + +**Use cases:** +- Floating toolbars +- Notifications +- Picture-in-picture +- Timers + +**Platform notes:** +- **macOS:** Full support +- **Windows:** Full support +- **Linux:** Depends on window manager + +### Fullscreen + +**Type:** `bool` +**Default:** `false` +**Platform:** All + +```go +Fullscreen: true, +``` + +**Purpose:** Start in fullscreen mode. + +**Platform behaviour:** +- **macOS:** Creates new Space (virtual desktop) +- **Windows:** Covers taskbar +- **Linux:** Varies by desktop environment + +**Toggle at runtime:** + +```go +window.Fullscreen() +window.UnFullscreen() +``` + +### Minimised / Maximised + +**Type:** `bool` +**Default:** `false` +**Platform:** All + +```go +Minimised: true, // Start minimised +Maximised: true, // Start maximised +``` + +**Purpose:** Set initial window state. + +**Note:** Don't set both to `true` - behaviour is undefined. + +### WindowState + +**Type:** `WindowState` enum +**Default:** `WindowStateNormal` +**Platform:** All + +```go +WindowState: application.WindowStateMaximised, +``` + +**Values:** +- `WindowStateNormal` - Normal window +- `WindowStateMinimised` - Minimised +- `WindowStateMaximised` - Maximised +- `WindowStateFullscreen` - Fullscreen +- `WindowStateHidden` - Hidden + +**Preferred over individual flags:** + +```go +// ✅ Preferred +WindowState: application.WindowStateMaximised, + +// ❌ Avoid +Maximised: true, +``` + +## Appearance Options + +### BackgroundColour + +**Type:** `RGBA` struct +**Default:** White (255, 255, 255, 255) +**Platform:** All + +```go +BackgroundColour: application.RGBA{R: 0, G: 0, H: 0, A: 255}, +``` + +**Purpose:** Window background colour before content loads. + +**Use cases:** +- Match your app's theme +- Prevent white flash on dark themes +- Smooth loading experience + +**Example:** + +```go +// Dark theme +BackgroundColour: application.RGBA{R: 30, G: 30, B: 30, A: 255}, + +// Light theme +BackgroundColour: application.RGBA{R: 255, G: 255, B: 255, A: 255}, +``` + +**Helper method:** + +```go +window.SetBackgroundColour(30, 30, 30, 255) +``` + +### BackgroundType + +**Type:** `BackgroundType` enum +**Default:** `BackgroundTypeSolid` +**Platform:** macOS, Windows (partial) + +```go +BackgroundType: application.BackgroundTypeTranslucent, +``` + +**Values:** +- `BackgroundTypeSolid` - Solid colour +- `BackgroundTypeTransparent` - Fully transparent +- `BackgroundTypeTranslucent` - Semi-transparent blur + +**Platform support:** +- **macOS:** All types supported +- **Windows:** Transparent and Translucent (Windows 11+) +- **Linux:** Solid only + +**Example (macOS):** + +```go +BackgroundType: application.BackgroundTypeTranslucent, +Mac: application.MacOptions{ + Backdrop: application.MacBackdropTranslucent, +}, +``` + +## Content Options + +### URL + +**Type:** `string` +**Default:** Empty (loads from Assets) +**Platform:** All + +```go +URL: "https://example.com", +``` + +**Purpose:** Load external URL instead of embedded assets. + +**Use cases:** +- Development (load from dev server) +- Web-based applications +- Hybrid applications + +**Example:** + +```go +// Development +URL: "http://localhost:5173", + +// Production +Assets: application.AssetOptions{ + Handler: application.AssetFileServerFS(assets), +}, +``` + +### HTML + +**Type:** `string` +**Default:** Empty +**Platform:** All + +```go +HTML: "

      Hello World

      ", +``` + +**Purpose:** Load HTML string directly. + +**Use cases:** +- Simple windows +- Generated content +- Testing + +**Example:** + +```go +HTML: ` + + +Simple Window +

      Hello from Wails!

      + +`, +``` + +### Assets + +**Type:** `AssetOptions` +**Default:** Inherited from application +**Platform:** All + +```go +Assets: application.AssetOptions{ + Handler: application.AssetFileServerFS(assets), +}, +``` + +**Purpose:** Serve embedded frontend assets. + +**See [Build System](/concepts/build-system) for details.** + +### UseApplicationMenu + +**Type:** `bool` +**Default:** `false` +**Platform:** Windows, Linux (no effect on macOS) + +```go +UseApplicationMenu: true, +``` + +**Purpose:** Use the application menu (set via `app.Menu.Set()`) for this window. + +On **macOS**, this option has no effect because macOS always uses a global application menu at the top of the screen. + +On **Windows** and **Linux**, windows don't display a menu by default. Setting `UseApplicationMenu: true` tells the window to use the application-level menu, providing a simple cross-platform solution. + +**Example:** + +```go +// Set the application menu once +menu := app.NewMenu() +menu.AddRole(application.FileMenu) +menu.AddRole(application.EditMenu) +app.Menu.Set(menu) + +// All windows with UseApplicationMenu will display this menu +app.Window.NewWithOptions(application.WebviewWindowOptions{ + Title: "Main Window", + UseApplicationMenu: true, +}) + +app.Window.NewWithOptions(application.WebviewWindowOptions{ + Title: "Second Window", + UseApplicationMenu: true, // Also gets the app menu +}) +``` + +**Notes:** +- If both `UseApplicationMenu` and a window-specific menu are set, the window-specific menu takes priority +- This simplifies cross-platform code by eliminating the need for runtime OS checks +- See [Application Menus](/features/menus/application) for complete menu documentation + +## Input Options + +### EnableFileDrop + +**Type:** `bool` +**Default:** `false` +**Platform:** All + +```go +EnableFileDrop: true, +``` + +**Purpose:** Enable drag-and-drop of files from the operating system into the window. + +When enabled: +- Files dragged from file managers can be dropped into your application +- The `WindowFilesDropped` event fires with the dropped file paths +- Elements with `data-file-drop-target` attribute provide detailed drop information + +**Use cases:** +- File upload interfaces +- Document editors +- Media importers +- Any app that accepts files + +**Example:** + +```go +window := app.Window.NewWithOptions(application.WebviewWindowOptions{ + Title: "File Uploader", + EnableFileDrop: true, +}) + +// Handle dropped files +window.OnWindowEvent(events.Common.WindowFilesDropped, func(event *application.WindowEvent) { + files := event.Context().DroppedFiles() + details := event.Context().DropTargetDetails() + + for _, file := range files { + fmt.Println("Dropped:", file) + } +}) +``` + +**HTML drop zones:** + +```html + +
      + Drop files here +
      +``` + +**See [File Drop](/features/drag-and-drop/files) for complete documentation.** + +## Security Options + +### ContentProtectionEnabled + +**Type:** `bool` +**Default:** `false` +**Platform:** Windows (10+), macOS + +```go +ContentProtectionEnabled: true, +``` + +**Purpose:** Prevent screen capture of window contents. + +**Platform support:** +- **Windows:** Windows 10 build 19041+ (full), older versions (partial) +- **macOS:** Full support +- **Linux:** Not supported + +**Use cases:** +- Banking applications +- Password managers +- Medical records +- Confidential documents + +**Important notes:** +1. Doesn't prevent physical photography +2. Some tools may bypass protection +3. Part of comprehensive security, not sole protection +4. DevTools windows not protected automatically + +**Example:** + +```go +window := app.Window.NewWithOptions(application.WebviewWindowOptions{ + Title: "Secure Window", + ContentProtectionEnabled: true, +}) + +// Toggle at runtime +window.SetContentProtection(true) +``` + +## Lifecycle Options + +### OnClose + +**Type:** `func() bool` +**Default:** `nil` (always allow close) +**Platform:** All + +```go +OnClose: func() bool { + // Return false to cancel close + // Return true to allow close + return true +}, +``` + +**Purpose:** Handle window close events, optionally prevent closing. + +**Use cases:** +- Confirm before closing with unsaved changes +- Save state before closing +- Prevent accidental closure + +**Example:** + +```go +OnClose: func() bool { + if hasUnsavedChanges() { + result := showConfirmdialog("Unsaved changes. Close anyway?") + return result == "yes" + } + return true +}, +``` + +**Important:** Only triggered by user actions (clicking X), not `window.Destroy()`. + +### OnDestroy + +**Type:** `func()` +**Default:** `nil` +**Platform:** All + +```go +OnDestroy: func() { + // Cleanup code + fmt.Println("Window destroyed") +}, +``` + +**Purpose:** Cleanup when window is destroyed. + +**Use cases:** +- Release resources +- Close connections +- Update application state + +**Example:** + +```go +OnDestroy: func() { + // Close database connection + if db != nil { + db.Close() + } + + // Remove from window list + removeWindow(window.ID()) +}, +``` + +## Platform-Specific Options + +### Mac Options + +```go +Mac: application.MacWindow{ + TitleBar: application.MacTitleBar{ + AppearsTransparent: true, + Hide: false, + HideTitle: true, + FullSizeContent: true, + }, + Backdrop: application.MacBackdropTranslucent, + InvisibleTitleBarHeight: 50, + WindowLevel: application.MacWindowLevelNormal, + CollectionBehavior: application.MacWindowCollectionBehaviorDefault, +}, +``` + +**TitleBar** (`MacTitleBar`) +- `AppearsTransparent` - Makes title bar transparent, content extends into title bar area +- `Hide` - Hides the title bar completely +- `HideTitle` - Hides only the title text +- `FullSizeContent` - Extends content to full window size + +**Backdrop** (`MacBackdrop`) +- `MacBackdropNormal` - Standard opaque background +- `MacBackdropTranslucent` - Blurred translucent background +- `MacBackdropTransparent` - Fully transparent background + +**InvisibleTitleBarHeight** (`int`) +- Height of invisible title bar area (for dragging) +- Only takes effect when the native title bar drag area is hidden — i.e. when the window is frameless (`Frameless: true`) or uses a transparent title bar (`AppearsTransparent: true`) +- Has no effect on standard windows with a visible title bar + +**WindowLevel** (`MacWindowLevel`) +- `MacWindowLevelNormal` - Standard window level (default) +- `MacWindowLevelFloating` - Floats above normal windows +- `MacWindowLevelTornOffMenu` - Torn-off menu level +- `MacWindowLevelModalPanel` - Modal panel level +- `MacWindowLevelMainMenu` - Main menu level +- `MacWindowLevelStatus` - Status window level +- `MacWindowLevelPopUpMenu` - Pop-up menu level +- `MacWindowLevelScreenSaver` - Screen saver level + +**CollectionBehavior** (`MacWindowCollectionBehavior`) + +Controls how the window behaves across macOS Spaces and fullscreen. These are bitmask values that can be combined using bitwise OR (`|`). + +**Space behavior:** +- `MacWindowCollectionBehaviorDefault` - Uses FullScreenPrimary (default, backwards compatible) +- `MacWindowCollectionBehaviorCanJoinAllSpaces` - Window appears on all Spaces +- `MacWindowCollectionBehaviorMoveToActiveSpace` - Moves to active Space when shown +- `MacWindowCollectionBehaviorManaged` - Default managed window behavior +- `MacWindowCollectionBehaviorTransient` - Temporary/transient window +- `MacWindowCollectionBehaviorStationary` - Stays stationary during Space switches + +**Window cycling:** +- `MacWindowCollectionBehaviorParticipatesInCycle` - Included in Cmd+` cycling +- `MacWindowCollectionBehaviorIgnoresCycle` - Excluded from Cmd+` cycling + +**Fullscreen behavior:** +- `MacWindowCollectionBehaviorFullScreenPrimary` - Can enter fullscreen mode +- `MacWindowCollectionBehaviorFullScreenAuxiliary` - Can overlay fullscreen apps +- `MacWindowCollectionBehaviorFullScreenNone` - Disables fullscreen capability +- `MacWindowCollectionBehaviorFullScreenAllowsTiling` - Allows side-by-side tiling (macOS 10.11+) +- `MacWindowCollectionBehaviorFullScreenDisallowsTiling` - Prevents tiling (macOS 10.11+) + +**Example - Spotlight-like window:** + +```go +// Window that appears on all Spaces AND can overlay fullscreen apps +Mac: application.MacWindow{ + CollectionBehavior: application.MacWindowCollectionBehaviorCanJoinAllSpaces | + application.MacWindowCollectionBehaviorFullScreenAuxiliary, + WindowLevel: application.MacWindowLevelFloating, +}, +``` + +**Example - Single behavior:** + +```go +// Window that can appear over fullscreen applications +Mac: application.MacWindow{ + CollectionBehavior: application.MacWindowCollectionBehaviorFullScreenAuxiliary, +}, +``` + +### Windows Options + +```go +Windows: application.WindowsOptions{ + DisableWindowIcon: false, + WindowBackdropType: application.WindowsBackdropTypeAuto, + CustomTheme: nil, + DisableFramelessWindowDecorations: false, +}, +``` + +**DisableWindowIcon** (`bool`) +- Remove icon from title bar +- Cleaner appearance + +**WindowBackdropType** (`WindowsBackdropType`) +- `WindowsBackdropTypeAuto` - System default +- `WindowsBackdropTypeNone` - No backdrop +- `WindowsBackdropTypeMica` - Mica material (Windows 11) +- `WindowsBackdropTypeAcrylic` - Acrylic material (Windows 11) +- `WindowsBackdropTypeTabbed` - Tabbed material (Windows 11) + +**CustomTheme** (`*WindowsTheme`) +- Custom colour theme +- Override system colours + +**DisableFramelessWindowDecorations** (`bool`) +- Disable default frameless decorations +- For custom window chrome + +**Example:** + +```go +Windows: application.WindowsOptions{ + WindowBackdropType: application.WindowsBackdropTypeMica, + DisableWindowIcon: true, +}, +``` + +### Linux Options + +```go +Linux: application.LinuxOptions{ + Icon: []byte{/* PNG data */}, + WindowIsTranslucent: false, +}, +``` + +**Icon** (`[]byte`) +- Window icon (PNG format) +- Shown in title bar and taskbar + +**WindowIsTranslucent** (`bool`) +- Enable window translucency +- Requires compositor support + +**Example:** + +```go +//go:embed icon.png +var icon []byte + +Linux: application.LinuxOptions{ + Icon: icon, +}, +``` + +## Application-Level Windows Options + +Some Windows-specific options must be configured at the application level rather than per-window. This is because WebView2 shares a single browser environment per user data path. + +### Browser Flags + +WebView2 browser flags control experimental features and behavior across **all windows** in your application. These must be set in `application.Options.Windows`: + +```go +app := application.New(application.Options{ + Name: "My App", + Windows: application.WindowsOptions{ + // Enable experimental WebView2 features + EnabledFeatures: []string{ + "msWebView2EnableDraggableRegions", + }, + + // Disable specific features + DisabledFeatures: []string{ + "msSmartScreenProtection", // Always disabled by Wails + }, + + // Additional Chromium command-line arguments + AdditionalBrowserArgs: []string{ + "--disable-gpu", + "--remote-debugging-port=9222", + }, + }, +}) +``` + +**EnabledFeatures** (`[]string`) +- List of WebView2 feature flags to enable +- See [WebView2 browser flags](https://learn.microsoft.com/en-us/microsoft-edge/webview2/concepts/webview-features-flags) for available flags +- Example: `"msWebView2EnableDraggableRegions"` + +**DisabledFeatures** (`[]string`) +- List of WebView2 feature flags to disable +- Wails automatically disables `msSmartScreenProtection` +- Example: `"msExperimentalFeature"` + +**AdditionalBrowserArgs** (`[]string`) +- Chromium command-line arguments passed to the browser process +- Must include the `--` prefix (e.g., `"--remote-debugging-port=9222"`) +- See [Chromium command line switches](https://peter.sh/experiments/chromium-command-line-switches/) for available arguments + +:::caution[Important] +These flags apply globally to ALL windows because WebView2 shares a single browser environment per user data path. You cannot have different browser flags for different windows. +::: + +**Complete Example:** + +```go +package main + +import ( + "github.com/wailsapp/wails/v3/pkg/application" +) + +func main() { + app := application.New(application.Options{ + Name: "My App", + Windows: application.WindowsOptions{ + // Enable draggable regions feature + EnabledFeatures: []string{ + "msWebView2EnableDraggableRegions", + }, + // Enable remote debugging + AdditionalBrowserArgs: []string{ + "--remote-debugging-port=9222", + }, + }, + }) + + // All windows will use the browser flags configured above + window := app.Window.NewWithOptions(application.WebviewWindowOptions{ + Title: "Main Window", + Width: 1024, + Height: 768, + }) + + window.Show() + app.Run() +} +``` + +## Complete Example + +Here's a production-ready window configuration: + +```go +package main + +import ( + _ "embed" + "github.com/wailsapp/wails/v3/pkg/application" +) + +//go:embed frontend/dist +var assets embed.FS + +//go:embed icon.png +var icon []byte + +func main() { + app := application.New(application.Options{ + Name: "My Application", + }) + + window := app.Window.NewWithOptions(application.WebviewWindowOptions{ + // Identity + Name: "main-window", + Title: "My Application", + + // Size and Position + Width: 1200, + Height: 800, + MinWidth: 800, + MinHeight: 600, + + // Initial State + WindowState: application.WindowStateNormal, + Resizable: true, + + // Appearance + BackgroundColour: application.RGBA{R: 255, G: 255, B: 255, A: 255}, + + // Content + Assets: application.AssetOptions{ + Handler: application.AssetFileServerFS(assets), + }, + + // Lifecycle + OnClose: func() bool { + if hasUnsavedChanges() { + result := showConfirmdialog("Unsaved changes. Close anyway?") + return result == "yes" + } + return true + }, + + OnDestroy: func() { + cleanup() + }, + + // Platform-Specific + Mac: application.MacOptions{ + TitleBarAppearsTransparent: true, + Backdrop: application.MacBackdropTranslucent, + }, + + Windows: application.WindowsOptions{ + WindowBackdropType: application.WindowsBackdropTypeMica, + DisableWindowIcon: false, + }, + + Linux: application.LinuxOptions{ + Icon: icon, + }, + }) + + window.Center() + window.Show() + + app.Run() +} +``` + +## Next Steps + +- [Window Basics](/features/windows/basics) - Creating and controlling windows +- [Multiple Windows](/features/windows/multiple) - Multi-window patterns +- [Frameless Windows](/features/windows/frameless) - Custom window chrome +- [Window Events](/features/windows/events) - Lifecycle events + +--- + +**Questions?** Ask in [Discord](https://discord.gg/JDdSxwjhGf) or check the [examples](https://github.com/wailsapp/wails/tree/v3-alpha/v3/examples). diff --git a/docs/src/content/docs/feedback.mdx b/docs/src/content/docs/feedback.mdx new file mode 100644 index 000000000..afe4a8bfb --- /dev/null +++ b/docs/src/content/docs/feedback.mdx @@ -0,0 +1,86 @@ +--- +title: v3 Alpha Feedback +sidebar: + order: 40 +--- + +import { Tabs, TabItem } from "@astrojs/starlight/components"; + +We welcome (and encourage) your feedback! Please search for existing tickets or +posts before creating new ones. Here are the different ways to provide feedback: + + + + + If you find a bug, please let us know by posting into the [v3 Alpha Feedback](https://discord.gg/bdj28QNHmT) channel on Discord. + + - The post should clearly state what the bug is and have a simple reproducible example. If the docs are unclear what *should* happen, please include that in the post. + - The post should be given the `Bug` tag. + - Please include the output of `wails doctor` in your post. + - If the bug is behavior that does not align with current documentation, e.g. a window does not resize properly, please do the following: + - Update an existing example in the `v3/example` directory or create a new example in the `v3/examples` folder that clearly shows the issue. + - Open a [PR](https://github.com/wailsapp/wails/pulls) with the title `[v3 alpha test] `. + - Please include a link to the PR in your post. + + :::caution + + _Remember_, unexpected behavior isn't necessarily a bug - it might just not do + what you expect it to do. Use `Suggestions` for this. + + ::: + + + + + + If you have a fix for a bug or an update for documentation, please do the following: + + - Open a pull request on the [Wails repository](https://github.com/wailsapp/wails). The title of the PR should start with `[v3 alpha]`. + - Create a post in the [v3 Alpha Feedback](https://discord.gg/bdj28QNHmT) channel. + - The post should be given the `PR` tag. + - Please include a link to the PR in your post. + + + + + + If you have a suggestion, please let us know by posting into the [v3 Alpha Feedback](https://discord.gg/bdj28QNHmT) channel on Discord: + + - The post should be given the `Suggestion` tag. + + Please feel free to reach out to us on [Discord](https://discord.gg/bdj28QNHmT) if you have any questions. + + + + + + - Posts can be "upvoted" by using the :thumbsup: emoji. Please apply to any posts that are a priority for you. + - Please *don't* just add comments like "+1" or "me too". + - Please feel free to comment if there is more to add to the post, such as "this bug also affect ARM builds" or "Another option would be to ....." + + + + + +There is a list of known issues & work in progress can be found +[here](https://github.com/orgs/wailsapp/projects/6). + +## Things we are looking for feedback on + +- The API + - Is it easy to use? + - Does it do what you expect? + - Is it missing anything? + - Is there anything that should be removed? + - Is it consistent between Go and JS? +- The build system + - Is it easy to use? + - Can we improve it? +- The examples + - Are they clear? + - Do they cover the basics? +- Features + - What features are missing? + - What features are not needed? +- Documentation + - What could be clearer? diff --git a/docs/src/content/docs/getting-started/installation.mdx b/docs/src/content/docs/getting-started/installation.mdx new file mode 100644 index 000000000..9c9d87885 --- /dev/null +++ b/docs/src/content/docs/getting-started/installation.mdx @@ -0,0 +1,114 @@ +--- +title: Installation +sidebar: + order: 10 +--- + +import { Tabs, TabItem } from "@astrojs/starlight/components"; + +## Supported Platforms + +- Windows 10/11 AMD64/ARM64 +- macOS 10.15+ AMD64 (Can deploy to macOS 10.13+) +- macOS 11.0+ ARM64 +- Ubuntu 24.04 AMD64/ARM64 (other Linux may work too!) + +## Dependencies + +Wails has a number of common dependencies that are required before installation: + + + + + Download Go from the [Go Downloads Page](https://go.dev/dl/). + + Ensure that you follow the official [Go installation instructions](https://go.dev/doc/install). You will also need to ensure that your `PATH` environment variable also includes the path to your `~/go/bin` directory. Restart your terminal and do the following checks: + + - Check Go is installed correctly: `go version` + - Check `~/go/bin` is in your PATH variable + - Mac / Linux: `echo $PATH | grep go/bin` + - Windows: `$env:PATH -split ';' | Where-Object { $_ -like '*\go\bin' }` + + + + + + Although Wails doesn't require npm to be installed, it is needed by most of the bundled templates. + + Download the latest node installer from the [Node Downloads Page](https://nodejs.org/en/download/). It is best to use the latest release as that is what we generally test against. + + Run `npm --version` to verify. + + :::note + If you prefer a different package manager to npm, feel free to use it. You will need to update the project Taskfiles to use it. + ::: + + + + + +## Platform Specific Dependencies + +You will also need to install platform specific dependencies: + + + + + Wails requires that the xcode command line tools are installed. This can be + done by running: + + ```sh + xcode-select --install + ``` + + + + + Wails requires that the [WebView2 Runtime](https://developer.microsoft.com/en-us/microsoft-edge/webview2/) is installed. Almost all Windows installations will already have this installed. You can check using the `wails doctor` command. + + + + + Linux requires the standard `gcc` build tools plus `gtk3` and `webkit2gtk`. Run wails doctor after installation to be shown how to install the dependencies. If your distro/package manager is not supported, please let us know on discord. + + + + + +## Installation + +To install the Wails CLI using Go Modules, run the following commands: + +```shell +go install -v github.com/wailsapp/wails/v3/cmd/wails3@latest +``` + +If you would like to install the latest development version, run the following +commands: + +```shell +git clone https://github.com/wailsapp/wails.git +cd wails +git checkout v3-alpha +cd v3/cmd/wails3 +go install +``` + +When using the development version, all generated projects will use Go's +[replace](https://go.dev/ref/mod#go-mod-file-replace) directive to ensure +projects use the development version of Wails. + +## System Check + +Running `wails3 doctor` will check if you have the correct dependencies +installed. If not, it will advise on what is missing and help on how to rectify +any problems. + +## The `wails3` command appears to be missing? + +If your system is reporting that the `wails3` command is missing, check the +following: + +- Make sure you have followed the above `Go installation guide` correctly and + that the `go/bin` directory is in the `PATH` environment variable. +- Close/Reopen current terminals to pick up the new `PATH` variable. diff --git a/docs/src/content/docs/getting-started/your-first-app.mdx b/docs/src/content/docs/getting-started/your-first-app.mdx new file mode 100644 index 000000000..143e66256 --- /dev/null +++ b/docs/src/content/docs/getting-started/your-first-app.mdx @@ -0,0 +1,272 @@ +--- +title: Your First Application +sidebar: + order: 20 +--- + +import { Tabs, TabItem } from "@astrojs/starlight/components"; +import { Badge } from '@astrojs/starlight/components'; +import { Steps } from "@astrojs/starlight/components"; +import { FileTree } from '@astrojs/starlight/components'; + +import wails_init from '../../../assets/wails_init.mp4'; +import wails_build from '../../../assets/wails_build.mp4'; +import wails_dev from '../../../assets/wails_dev.mp4'; + + +This guide shows you how to create your first Wails v3 application, covering project setup, building, and development workflow. + +
      +
      + + + +1. ## Creating a New Project + + Open your terminal and run the following command to create a new Wails + project: + + ```bash + wails3 init -n myfirstapp + ``` + + This command creates a new directory called `myfirstapp` with all the + necessary files. + + + +2. ## Exploring the Project Structure + + Navigate to the `myfirstapp` directory. You'll find several files and + folders: + + + - build/ Contains files used by the build process + - appicon.png The application icon + - config.yml Build configuration + - Taskfile.yml Build tasks + - darwin/ macOS specific build files + - Info.dev.plist Development configuration + - Info.plist Production configuration + - Taskfile.yml macOS build tasks + - icons.icns macOS application icon + - linux/ Linux specific build files + - Taskfile.yml Linux build tasks + - appimage/ AppImage packaging + - build.sh AppImage build script + - nfpm/ NFPM packaging + - nfpm.yaml Package configuration + - scripts/ Build scripts + - windows/ Windows specific build files + - Taskfile.yml Windows build tasks + - icon.ico Windows application icon + - info.json Application metadata + - wails.exe.manifest Windows manifest file + - nsis/ NSIS installer files + - project.nsi NSIS project file + - wails_tools.nsh NSIS helper scripts + - frontend/ Frontend application files + - index.html Main HTML file + - main.js Main JavaScript file + - package.json NPM package configuration + - public/ Static assets + - Inter Font License.txt Font license + - .gitignore Git ignore file + - README.md Project documentation + - Taskfile.yml Project tasks + - go.mod Go module file + - go.sum Go module checksums + - greetservice.go Greeting service + - main.go Main application code + + + Take a moment to explore these files and familiarize yourself with the + structure. + + :::note + Although Wails v3 uses [Task](https://taskfile.dev/) as its + default build system, there is nothing stopping you from using `make` or any other + alternative build system. + ::: + +3. ## Building Your Application + + To build your application, execute: + + ```bash + wails3 build + ``` + + This command compiles a debug version of your application and saves it in a + new `bin` directory. + + :::note + `wails3 build` is shorthand for `wails3 task build` and will run the `build` task in `Taskfile.yml`. + ::: + + + + + Once built, you can run this like you would any normal application: + + + + + + + ```sh + ./bin/myfirstapp + ``` + + + + + + ```sh + bin\myfirstapp.exe + ``` + + + + + + ```sh + ./bin/myfirstapp + ``` + + + + + + You'll see a simple UI, the starting point for your application. As it is + the debug version, you'll also see logs in the console window. This is + useful for debugging purposes. + +4. ## Dev Mode + + We can also run the application in development mode. This mode allows you to + make changes to your frontend code and see the changes reflected in the + running application without having to rebuild the entire application. + + 1. Open a new terminal window. + 2. Run `wails3 dev`. The application will compile and run in debug mode. + 3. Open `frontend/index.html` in your editor of choice. + 4. Edit the code and change `Please enter your name below` to + `Please enter your name below!!!`. + 5. Save the file. + + This change will reflect in your application immediately. + + Any changes to backend code will trigger a rebuild: + + 1. Open `greetservice.go`. + 2. Change the line that has `return "Hello " + name + "!"` to + `return "Hello there " + name + "!"`. + 3. Save the file. + + The application will update within a matter of seconds. + + + +5. ## Packaging Your Application + + Once your application is ready for distribution, you can create + platform-specific packages: + + + + + + To create a `.app` bundle: + + ```bash + wails3 package + ``` + + This will create a production build and package it into a `.app` bundle in the `bin` directory. + + + + + To create an NSIS installer: + + ```bash + wails3 package + ``` + + This will create a production build and package it into an NSIS installer in the `bin` directory. + + + + + Wails supports multiple package formats for Linux distribution: + + ```bash + # Create all package types (AppImage, deb, rpm, and Arch Linux) + wails3 package + + # Or create specific package types + wails3 task linux:create:appimage # AppImage format + wails3 task linux:create:deb # Debian package + wails3 task linux:create:rpm # Red Hat package + wails3 task linux:create:aur # Arch Linux package + ``` + + + + + + For more detailed information about packaging options and configuration, + check out our [Packaging Guide](/guides/packaging). + +6. ## Setting up Version Control and Module Name + + Your project is created with the placeholder module name `changeme`. It's recommended to update this to match your repository URL: + + 1. Create a new repository on GitHub (or your preferred Git host) + 2. Initialize git in your project directory: + ```bash + git init + git add . + git commit -m "Initial commit" + ``` + 3. Set your remote repository (replace with your repository URL): + ```bash + git remote add origin https://github.com/username/myfirstapp.git + ``` + 4. Update your module name in `go.mod` to match your repository URL: + ```bash + go mod edit -module github.com/username/myfirstapp + ``` + 5. Push your code: + ```bash + git push -u origin main + ``` + + This ensures your Go module name aligns with Go's module naming conventions and makes it easier to share your code. + + :::tip[Pro Tip] + You can automate all of the initialisation steps by using the `-git` flag when creating your project: + ```bash + wails3 init -n myfirstapp -git github.com/username/myfirstapp + ``` + This supports various Git URL formats: + - HTTPS: `https://github.com/username/project` + - SSH: `git@github.com:username/project` or `ssh://git@github.com/username/project` + - Git protocol: `git://github.com/username/project` + - Filesystem: `file:///path/to/project.git` + ::: + + + +## Congratulations! + +You've just created, developed and packaged your first Wails application. +This is just the beginning of what you can achieve with Wails v3. + +## Next Steps + +If you are new to Wails, we recommend reading through our Tutorials next which will be a practical guide through +the various features of Wails. The first tutorial is [Creating a Service](/tutorials/01-creating-a-service). + +If you are a more advanced user, check out our [Guides](/guides) for more detailed information on how to use Wails. diff --git a/docs/src/content/docs/guides/_category_.json b/docs/src/content/docs/guides/_category_.json new file mode 100644 index 000000000..edc4bf6e3 --- /dev/null +++ b/docs/src/content/docs/guides/_category_.json @@ -0,0 +1,8 @@ +{ + "label": "Guides", + "position": 3, + "link": { + "type": "generated-index", + "description": "Comprehensive guides for developing Wails applications" + } +} diff --git a/docs/src/content/docs/guides/architecture.mdx b/docs/src/content/docs/guides/architecture.mdx new file mode 100644 index 000000000..72678befd --- /dev/null +++ b/docs/src/content/docs/guides/architecture.mdx @@ -0,0 +1,199 @@ +--- +title: Architecture Patterns +description: Design patterns for Wails applications +sidebar: + order: 7 +--- + +## Overview + +Proven patterns for organising your Wails application. + +## Service Layer Pattern + +### Structure + +``` +app/ +├── main.go +├── services/ +│ ├── user_service.go +│ ├── data_service.go +│ └── file_service.go +└── models/ + └── user.go +``` + +### Implementation + +```go +// Service interface +type UserService interface { + Create(email, password string) (*User, error) + GetByID(id int) (*User, error) + Update(user *User) error + Delete(id int) error +} + +// Implementation +type userService struct { + app *application.Application + db *sql.DB +} + +func NewUserService(app *application.Application, db *sql.DB) UserService { + return &userService{app: app, db: db} +} +``` + +## Repository Pattern + +### Structure + +```go +// Repository interface +type UserRepository interface { + Create(user *User) error + FindByID(id int) (*User, error) + Update(user *User) error + Delete(id int) error +} + +// Service uses repository +type UserService struct { + repo UserRepository +} + +func (s *UserService) Create(email, password string) (*User, error) { + user := &User{Email: email} + return user, s.repo.Create(user) +} +``` + +## Event-Driven Architecture + +### Event Bus + +```go +type EventBus struct { + app *application.Application + listeners map[string][]func(interface{}) + mu sync.RWMutex +} + +func (eb *EventBus) Subscribe(event string, handler func(interface{})) { + eb.mu.Lock() + defer eb.mu.Unlock() + eb.listeners[event] = append(eb.listeners[event], handler) +} + +func (eb *EventBus) Publish(event string, data interface{}) { + eb.mu.RLock() + handlers := eb.listeners[event] + eb.mu.RUnlock() + + for _, handler := range handlers { + go handler(data) + } +} +``` + +### Usage + +```go +// Subscribe +eventBus.Subscribe("user.created", func(data interface{}) { + user := data.(*User) + sendWelcomeEmail(user) +}) + +// Publish +eventBus.Publish("user.created", user) +``` + +## Dependency Injection + +### Manual DI + +```go +type App struct { + userService *UserService + fileService *FileService + db *sql.DB +} + +func NewApp() *App { + db := openDatabase() + + return &App{ + db: db, + userService: NewUserService(db), + fileService: NewFileService(db), + } +} +``` + +### Using Wire + +```go +// wire.go +//go:build wireinject + +func InitializeApp() (*App, error) { + wire.Build( + openDatabase, + NewUserService, + NewFileService, + NewApp, + ) + return nil, nil +} +``` + +## State Management + +### Centralised State + +```go +type AppState struct { + currentUser *User + settings *Settings + mu sync.RWMutex +} + +func (s *AppState) SetUser(user *User) { + s.mu.Lock() + defer s.mu.Unlock() + s.currentUser = user +} + +func (s *AppState) GetUser() *User { + s.mu.RLock() + defer s.mu.RUnlock() + return s.currentUser +} +``` + +## Best Practices + +### ✅ Do + +- Separate concerns +- Use interfaces +- Inject dependencies +- Handle errors properly +- Keep services focused +- Document architecture + +### ❌ Don't + +- Don't create god objects +- Don't tightly couple components +- Don't skip error handling +- Don't ignore concurrency +- Don't over-engineer + +## Next Steps + +- [Security](/guides/security) - Security best practices +- [Best Practices](/features/bindings/best-practices) - Bindings best practices diff --git a/docs/src/content/docs/guides/build/building.mdx b/docs/src/content/docs/guides/build/building.mdx new file mode 100644 index 000000000..64a82b552 --- /dev/null +++ b/docs/src/content/docs/guides/build/building.mdx @@ -0,0 +1,104 @@ +--- +title: Building Applications +description: Build and package your Wails application +sidebar: + order: 1 +--- + +import { Tabs, TabItem, Aside } from "@astrojs/starlight/components"; + +Wails v3 uses [Task](https://taskfile.dev) as its build system. The `wails3 build` and `wails3 package` commands are convenient wrappers around Task. + +## Building + +Build for the current platform: + +```bash +wails3 build +``` + +Build for a specific platform: + +```bash +wails3 build GOOS=windows +wails3 build GOOS=darwin +wails3 build GOOS=linux + +# With architecture +wails3 build GOOS=darwin GOARCH=arm64 + +# Environment variable style works too +GOOS=windows wails3 build +``` + +Output goes to the `bin/` directory. + + + +## Development + +Run your application with hot reload: + +```bash +wails3 dev +``` + +This starts a file watcher that rebuilds and restarts your app on changes. The frontend dev server runs on port 9245 by default. + +```bash +# Custom port +wails3 dev -port 3000 + +# Enable HTTPS +wails3 dev -s +``` + +## Packaging + +Package your app for distribution: + +```bash +wails3 package +wails3 package GOOS=windows +wails3 package GOOS=darwin +wails3 package GOOS=linux +``` + +This creates platform-specific packages: +- **Windows**: NSIS installer — see [Windows Packaging](/guides/build/windows) +- **macOS**: Application bundle (`.app`) — see [macOS Packaging](/guides/build/macos) +- **Linux**: AppImage, deb, and rpm — see [Linux Packaging](/guides/build/linux) + +## Using Task Directly + +For more control, use Task directly: + +```bash +# List available tasks +wails3 task --list + +# Verbose output +wails3 task build -v + +# Dry run +wails3 task --dry + +# Force rebuild +wails3 task build -f + +# Pass variables +wails3 task darwin:build ARCH=amd64 +``` + +Platform-specific tasks like `linux:create:deb` or `darwin:build:universal` are only available through Task. + +## Generating Assets + +Regenerate icons or update build configuration: + +```bash +wails3 generate icons -input build/appicon.png +wails3 update build-assets -name "MyApp" -config build/config.yml -dir build +``` diff --git a/docs/src/content/docs/guides/build/cross-platform.mdx b/docs/src/content/docs/guides/build/cross-platform.mdx new file mode 100644 index 000000000..0685834d4 --- /dev/null +++ b/docs/src/content/docs/guides/build/cross-platform.mdx @@ -0,0 +1,298 @@ +--- +title: Cross-Platform Building +description: Build for multiple platforms from a single machine +sidebar: + order: 2 +--- + +import { Tabs, TabItem, Aside } from "@astrojs/starlight/components"; + +## Quick Start + +Wails v3 supports building for Windows, macOS, and Linux from any host operating system. The build system automatically detects your environment and chooses the right compilation method. + +**Want to cross-compile to macOS and Linux?** Run this once to set up the Docker images (~800MB download): + +```bash +wails3 task setup:docker +``` + +Then build for any platform: + +```bash +# Build for current platform (production by default) +wails3 build + +# Build for specific platforms +wails3 build GOOS=windows +wails3 build GOOS=darwin +wails3 build GOOS=linux + +# Build for ARM64 architecture +wails3 build GOOS=windows GOARCH=arm64 +wails3 build GOOS=darwin GOARCH=arm64 +wails3 build GOOS=linux GOARCH=arm64 + +# Environment variable style also works +GOOS=darwin GOARCH=arm64 wails3 build +``` + +### Windows + +Windows is the simplest cross-compilation target because it doesn't require CGO by default. + +```bash +wails3 build GOOS=windows +``` + +This works from any host OS with no additional setup. Go's built-in cross-compilation handles everything. + +**If your app requires CGO** (e.g., you're using a C library or CGO-dependent package), you'll need Docker when building from macOS or Linux: + +```bash +# One-time setup +wails3 task setup:docker + +# Build with CGO enabled +wails3 task windows:build CGO_ENABLED=1 +``` + +The Taskfile detects `CGO_ENABLED=1` on non-Windows hosts and automatically uses the Docker image. + +### macOS + +macOS builds require CGO for WebView integration, which means cross-compilation needs special tooling. + +```bash +# Build for Apple Silicon (arm64) - default +wails3 build GOOS=darwin + +# Build for Intel (amd64) +wails3 build GOOS=darwin GOARCH=amd64 + +# Build universal binary (both architectures) +wails3 task darwin:build:universal +``` + +**From Linux or Windows**, you'll need to set up Docker first: + +```bash +wails3 task setup:docker +``` + +Once the images are built, the build system detects that you're not on macOS and uses Docker automatically. You don't need to change your build commands. + +Note that cross-compiled macOS binaries are not code-signed. You'll need to sign them on macOS or in CI before distribution. + +### Linux + +Linux builds require CGO for WebView integration. + +```bash +wails3 build GOOS=linux + +# Build for specific architecture +wails3 build GOOS=linux GOARCH=amd64 +wails3 build GOOS=linux GOARCH=arm64 +``` + +**From macOS or Windows**, you'll need to set up Docker first: + +```bash +wails3 task setup:docker +``` + +The build system detects that you're not on Linux and uses Docker automatically. + +**On Linux without a C compiler**, the build system checks for `gcc` or `clang`. If neither is found, it falls back to Docker. This is useful for minimal containers or systems without build tools installed. You can either: + +1. Install a C compiler: `sudo apt install build-essential` (Debian/Ubuntu) or `sudo pacman -S base-devel` (Arch) +2. Build the Docker image and let it be used automatically + +### ARM Architecture + +All platforms support ARM64 cross-compilation using `GOARCH`: + +```bash +# Windows ARM64 (Surface Pro X, Windows on ARM) +wails3 build GOOS=windows GOARCH=arm64 + +# Linux ARM64 (Raspberry Pi 4/5, AWS Graviton) +wails3 build GOOS=linux GOARCH=arm64 + +# macOS ARM64 (Apple Silicon - this is the default on macOS) +wails3 build GOOS=darwin GOARCH=arm64 + +# macOS Intel (amd64) +wails3 build GOOS=darwin GOARCH=amd64 +``` + +The Docker image includes Zig cross-compiler targets for both amd64 and arm64 on all platforms, so ARM builds work from any host: + +| Build ARM64 for | From Windows | From macOS | From Linux | +|-----------------|--------------|------------|------------| +| **Windows ARM64** | Native Go | Native Go | Native Go | +| **macOS ARM64** | Docker | Native | Docker | +| **Linux ARM64** | Docker | Docker | Docker* | + +*Linux ARM64 from Linux x86_64 uses Docker because CGO cross-compilation requires a different toolchain. + +## How It Works + +### Cross-Compilation Matrix + +| Host → Target | Windows | macOS | Linux | +|---------------|---------|-------|-------| +| **Windows** | Native | Docker | Docker | +| **macOS** | Native Go | Native | Docker | +| **Linux** | Native Go | Docker | Native | + +- **Native** = Platform's native toolchain, no additional setup +- **Native Go** = Go's built-in cross-compilation (`CGO_ENABLED=0`) +- **Docker** = Docker image with Zig cross-compiler + +### CGO Requirements + +| Target | CGO Required | Cross-Compilation Method | +|--------|--------------|--------------------------| +| Windows | No (default) | Native Go. Docker only if `CGO_ENABLED=1` | +| macOS | Yes | Docker with macOS SDK | +| Linux | Yes | Docker, or native if C compiler available | + +### Auto-Detection + +The Taskfiles automatically choose the right build method based on your environment: + +- **Windows target:** Uses native Go cross-compilation by default. If you explicitly set `CGO_ENABLED=1` on a non-Windows host, it switches to Docker. +- **macOS target:** Uses Docker automatically when not on macOS. No manual intervention needed. +- **Linux target:** Checks for `gcc` or `clang`. Uses native compilation if found, otherwise falls back to Docker. + +### Docker Image + +Wails uses a single Docker image (`wails-cross`) that can build for all platforms. It uses [Zig](https://ziglang.org/) as the cross-compiler, which can target any platform from any host. The macOS SDK is included for darwin targets. + +```bash +wails3 task setup:docker +``` + +You can check if the image is ready by running `wails3 doctor`. + +### macOS SDK + +The Docker image downloads the macOS SDK from [joseluisq/macosx-sdks](https://github.com/joseluisq/macosx-sdks) during the image build process. This is required because macOS headers are needed for CGO compilation. + +By default, the image uses **macOS SDK 14.5** (Sonoma). To use a different version, rebuild with: + +```bash +docker build -t wails-cross \ + --build-arg MACOS_SDK_VERSION=15.0 \ + -f build/docker/Dockerfile.cross build/docker/ +``` + +See the [available SDK versions](https://github.com/joseluisq/macosx-sdks/releases) for options. + +**Important:** Wails does not distribute the macOS SDK. Users are responsible for reviewing Apple's SDK license terms before using this feature. + +## CI/CD Integration + +For production releases, we recommend using CI/CD with native runners for each platform. This avoids cross-compilation entirely and ensures you get properly signed binaries. + +```yaml +name: Build + +on: + push: + branches: [main] + +jobs: + build: + strategy: + matrix: + include: + - os: ubuntu-latest + goos: linux + - os: macos-latest + goos: darwin + - os: windows-latest + goos: windows + + runs-on: ${{ matrix.os }} + + steps: + - uses: actions/checkout@v4 + + - uses: actions/setup-go@v5 + with: + go-version: '1.24' + + - uses: actions/setup-node@v4 + with: + node-version: '20' + + - name: Install Wails CLI + run: go install github.com/wailsapp/wails/v3/cmd/wails3@latest + + - name: Install Task + uses: arduino/setup-task@v2 + + - name: Build + run: wails3 build + + - uses: actions/upload-artifact@v4 + with: + name: app-${{ matrix.goos }} + path: bin/ +``` + +## Troubleshooting + +### Docker image not found + +``` +Docker image 'wails-cross' not found. +``` + +Run `wails3 task setup:docker` to build the Docker image. You only need to do this once. + +### Docker daemon not running + +``` +Docker is required for cross-compilation. Please install Docker. +``` + +Start Docker Desktop or the Docker daemon. On Linux, you may need to run `sudo systemctl start docker`. + +### No C compiler on Linux + +If you see CGO-related errors when building on Linux, you have two options: + +1. **Install a C compiler:** + - Debian/Ubuntu: `sudo apt install build-essential` + - Arch Linux: `sudo pacman -S base-devel` + - Fedora: `sudo dnf install gcc` + +2. **Use Docker instead:** Run `wails3 task setup:docker` and the Taskfile will use it automatically when no compiler is detected. + +### macOS binaries not signed + +Cross-compiled macOS binaries are not code-signed. Apple requires code signing for distribution, so you'll need to: + +1. Sign the binary on a macOS machine, or +2. Sign in CI using a macOS runner + +See [Signing Applications](/guides/build/signing) for details. + +### Universal binary creation + +Universal binaries (arm64 + amd64 combined) can be built on any platform: + +```bash +wails3 task darwin:build:universal +``` + +On Linux and Windows, Wails uses its built-in `wails3 tool lipo` command (powered by [konoui/lipo](https://github.com/konoui/lipo)) to combine the binaries. This creates a single binary that runs natively on both Apple Silicon and Intel Macs. + +## Next Steps + +- [Building Applications](/guides/build/building) - Basic build commands and options +- [Signing Applications](/guides/build/signing) - Code signing for distribution diff --git a/docs/src/content/docs/guides/build/customization.mdx b/docs/src/content/docs/guides/build/customization.mdx new file mode 100644 index 000000000..993fb1ee5 --- /dev/null +++ b/docs/src/content/docs/guides/build/customization.mdx @@ -0,0 +1,282 @@ +--- +title: Build Customization +description: Customize your build process using Task and Taskfile.yml +sidebar: + order: 7 +--- + +import { FileTree } from "@astrojs/starlight/components"; + +## Overview + +The Wails build system is a flexible and powerful tool designed to streamline +the build process for your Wails applications. It leverages +[Task](https://taskfile.dev), a task runner that allows you to define and run +tasks easily. While the v3 build system is the default, Wails encourages a +"bring your own tooling" approach, allowing developers to customize their build +process as needed. + +Learn more about how to use Task in the +[official documentation](https://taskfile.dev/usage/). + +## Task: The Heart of the Build System + +[Task](https://taskfile.dev) is a modern alternative to Make, written in Go. It +uses a YAML file to define tasks and their dependencies. In the Wails build +system, [Task](https://taskfile.dev) plays a central role in orchestrating the +build process. + +The main `Taskfile.yml` is located in the project root, while platform-specific +tasks are defined in `build//Taskfile.yml` files. A common `Taskfile.yml` +file in the `build` directory contains common tasks that are shared across +platforms. + + + +- Project Root + - Taskfile.yml + - build + - windows/Taskfile.yml + - darwin/Taskfile.yml + - linux/Taskfile.yml + - Taskfile.yml + + + +## Taskfile.yml + +The `Taskfile.yml` file in the project root is the main entry point for the build system. It defines +the tasks and their dependencies. Here's the default `Taskfile.yml` file: + +```yaml +version: '3' + +includes: + common: ./build/Taskfile.yml + windows: ./build/windows/Taskfile.yml + darwin: ./build/darwin/Taskfile.yml + linux: ./build/linux/Taskfile.yml + +vars: + APP_NAME: "myproject" + BIN_DIR: "bin" + VITE_PORT: '{{.WAILS_VITE_PORT | default 9245}}' + +tasks: + build: + summary: Builds the application + cmds: + - task: "{{OS}}:build" + + package: + summary: Packages a production build of the application + cmds: + - task: "{{OS}}:package" + + run: + summary: Runs the application + cmds: + - task: "{{OS}}:run" + + dev: + summary: Runs the application in development mode + cmds: + - wails3 dev -config ./build/config.yml -port {{.VITE_PORT}} + + +``` + +## Platform-Specific Taskfiles + +Each platform has its own Taskfile, located in the platform directories beneath the `build` directory. These +files define the core tasks for that platform. Each taskfile includes common tasks from the `build/Taskfile.yml` file. + +### Windows + +Location: `build/windows/Taskfile.yml` + +The Windows-specific Taskfile includes tasks for building, packaging, and +running the application on Windows. Key features include: + +- Building with optional production flags +- Generating `.ico` icon file +- Generating Windows `.syso` file +- Creating an NSIS installer for packaging + +### Linux + +Location: `build/linux/Taskfile.yml` + +The Linux-specific Taskfile includes tasks for building, packaging, and running +the application on Linux. Key features include: + +- Building with optional production flags +- Creating an AppImage, deb, rpm, and Arch Linux packages +- Generating `.desktop` file for Linux applications + +### macOS + +Location: `build/darwin/Taskfile.yml` + +The macOS-specific Taskfile includes tasks for building, packaging, and running +the application on macOS. Key features include: + +- Building binaries for amd64, arm64 and universal (both) architectures +- Generating `.icns` icon file +- Creating an `.app` bundle for distributing +- Ad-hoc signing `.app` bundles +- Setting macOS-specific build flags and environment variables + +## Task Execution and Command Aliases + +The `wails3 task` command is an embedded version of [Taskfile](https://taskfile.dev), which executes +the tasks defined in your `Taskfile.yml`. + +The `wails3 build` and `wails3 package` commands are aliases for +`wails3 task build` and `wails3 task package` respectively. When you run these +commands, Wails internally translates them to the appropriate task execution: + +- `wails3 build` → `wails3 task build` +- `wails3 package` → `wails3 task package` + +### Passing Parameters to Tasks + +You can pass CLI variables to tasks using the `KEY=VALUE` format. These variables are forwarded through the alias commands: + +```bash +# These are equivalent: +wails3 build PLATFORM=linux CONFIG=production +wails3 task build PLATFORM=linux CONFIG=production + +# Package with custom version: +wails3 package VERSION=2.0.0 OUTPUT=myapp.pkg +``` + +In your `Taskfile.yml`, you can access these variables using Go template syntax: + +```yaml +tasks: + build: + cmds: + - echo "Building for {{.PLATFORM | default "darwin"}}" + - go build -tags {{.CONFIG | default "debug"}} -o myapp +``` + +## Common Build Process + +Across all platforms, the build process typically includes the following steps: + +1. Tidying Go modules +2. Building the frontend +3. Generating icons +4. Compiling the Go code with platform-specific flags +5. Packaging the application (platform-specific) + +## Customising the Build Process + +While the v3 build system provides a solid default configuration, you can easily +customise it to fit your project's needs. By modifying the `Taskfile.yml` and +platform-specific Taskfiles, you can: + +- Add new tasks +- Modify existing tasks +- Change the order of task execution +- Integrate with other tools and scripts + +This flexibility allows you to tailor the build process to your specific +requirements while still benefiting from the structure provided by the Wails +build system. + +:::tip[Learning Taskfile] +We highly recommend reading the [Taskfile](https://taskfile.dev) documentation to +understand how to use Taskfile effectively. +You can find out which version of Taskfile is embedded in the Wails CLI by running `wails3 task --version`. +::: + +## Development Mode + +The Wails build system includes a powerful development mode that enhances the +developer experience by providing live reloading and hot module replacement. +This mode is activated using the `wails3 dev` command. + +### How It Works + +When you run `wails3 dev`, the following process occurs: + +1. The command checks for an available port, defaulting to 9245 if not + specified. +2. It sets up the environment variables for the frontend dev server (Vite). +3. It starts the file watcher using the [refresh](https://github.com/atterpac/refresh) library. + +The [refresh](https://github.com/atterpac/refresh) library is responsible for +monitoring file changes and triggering rebuilds. It uses the configuration defined under the `dev_mode` key in the `./build/config.yaml` file. +It may be configured to ignore certain directories and files, to determine which files to watch and what actions to take when changes are detected. +The default configuration works pretty well, but feel free to customise it to your needs. + +### Configuration + +Here's an example of its structure: + +```yaml +dev_mode: + root_path: . + log_level: warn + debounce: 1000 + ignore: + dir: + - .git + - node_modules + - frontend + - bin + file: + - .DS_Store + - .gitignore + - .gitkeep + watched_extension: + - "*.go" + git_ignore: true + executes: + - cmd: wails3 task common:install:frontend:deps + type: once + - cmd: wails3 task common:dev:frontend + type: background + - cmd: go mod tidy + type: blocking + - cmd: wails3 task build + type: blocking + - cmd: wails3 task run + type: primary +``` + +This configuration file allows you to: + +- Set the root path for file watching +- Configure logging level +- Set a debounce time for file change events +- Ignore specific directories, files, or file extensions +- Define commands to execute on file changes + +### Customising Development Mode + +You can customise the development mode experience by modifying these values in the `config.yaml` file. + +Some ways to customise include: + +1. Changing the watched directories or files +2. Adjusting the debounce time to control how quickly the system responds to + changes +3. Adding or modifying the execute commands to fit your project's needs + +### Using a browser for development + +Whilst Wails v2 fully supported the use of a browser for development, it caused a lot +of confusion. Applications that would work in the browser would not necessarily +work in the desktop application, as not all browser APIs are available in webviews. + +For UI-focused development work, you still have the flexibility to use a browser +in v3, by accessing the Vite URL at `http://localhost:9245` in dev mode. This +gives you access to powerful browser dev tools while working on styling and +layout. Be aware that Go bindings *will not work* in this mode. +When you're ready to test functionality like bindings and events, simply +switch to the desktop view to ensure everything works perfectly in the +production environment. diff --git a/docs/src/content/docs/guides/build/linux.mdx b/docs/src/content/docs/guides/build/linux.mdx new file mode 100644 index 000000000..18666c2aa --- /dev/null +++ b/docs/src/content/docs/guides/build/linux.mdx @@ -0,0 +1,160 @@ +--- +title: Linux Packaging +description: Package your Wails application for Linux distribution +sidebar: + order: 5 +--- + +import { Aside } from '@astrojs/starlight/components'; + +## Package Formats + +Package your app for Linux distribution: + +```bash +wails3 package GOOS=linux +``` + +This creates multiple formats in the `bin/` directory: +- **AppImage**: Portable, runs on any Linux distribution +- **DEB**: For Debian, Ubuntu, and derivatives +- **RPM**: For Fedora, RHEL, and derivatives +- **Arch**: For Arch Linux and derivatives + +### Individual Formats + +Build specific formats: + +```bash +wails3 task linux:create:appimage +wails3 task linux:create:deb +wails3 task linux:create:rpm +wails3 task linux:create:aur +``` + +## Customizing Packages + +### Desktop Entry + +The `.desktop` file controls how your app appears in application menus. It's generated from values in `build/linux/Taskfile.yml`: + +```yaml +vars: + APP_NAME: 'MyApp' + EXEC: 'MyApp' + ICON: 'MyApp' + CATEGORIES: 'Development;' +``` + +### Package Metadata + +Edit `build/linux/nfpm/nfpm.yaml` to customize DEB and RPM packages: + +```yaml +name: myapp +version: 1.0.0 +maintainer: Your Name +description: My awesome Wails application +homepage: https://example.com +license: MIT +``` + +### AppImage + +AppImage configuration is in `build/linux/appimage/`. The app icon comes from `build/appicon.png`. + +## Signing Packages + +Sign DEB and RPM packages with a PGP key: + +```bash +# Using the wrapper (auto-detects platform) +wails3 sign GOOS=linux + +# Or using tasks directly +wails3 task linux:sign:deb +wails3 task linux:sign:rpm +wails3 task linux:sign:packages # Both +``` + +Configure signing in `build/linux/Taskfile.yml`: + +```yaml +vars: + PGP_KEY: "path/to/signing-key.asc" + SIGN_ROLE: "builder" # origin, maint, archive, or builder +``` + +Store your key password: + +```bash +wails3 setup signing +``` + +See [Signing Applications](/guides/build/signing) for details. + +## Building for ARM + +```bash +wails3 build GOOS=linux GOARCH=arm64 +wails3 package GOOS=linux GOARCH=arm64 +``` + + + +## Troubleshooting + +### AppImage won't run + +Make it executable: + +```bash +chmod +x MyApp-x86_64.AppImage +``` + +### Missing dependencies + +If the app fails to start, check for missing WebKit dependencies: + +```bash +# Debian/Ubuntu +sudo apt install libwebkit2gtk-4.1-0 + +# Fedora +sudo dnf install webkit2gtk4.1 + +# Arch +sudo pacman -S webkit2gtk-4.1 +``` + +### No C compiler found + +The build system needs GCC or Clang for CGO: + +```bash +# Debian/Ubuntu +sudo apt install build-essential + +# Fedora +sudo dnf install gcc + +# Arch +sudo pacman -S base-devel +``` + +Alternatively, run `wails3 task setup:docker` and the build system will use Docker automatically. + +### AppImage strip compatibility + +On modern Linux distributions (Arch Linux, Fedora 39+, Ubuntu 24.04+), system libraries are compiled with `.relr.dyn` ELF sections for more efficient relocations. The `linuxdeploy` tool used to create AppImages bundles an older `strip` binary that cannot process these modern sections. + +Wails automatically detects this situation by checking system GTK libraries before building the AppImage. When detected, stripping is disabled (`NO_STRIP=1`) to ensure compatibility. + +**What this means:** +- AppImages will be slightly larger (~20-40%) on affected systems +- The application functionality is not affected +- This is handled automatically—no action required + +If you need smaller AppImages on modern systems, you can install a newer `strip` binary and configure `linuxdeploy` to use it instead of its bundled version. diff --git a/docs/src/content/docs/guides/build/macos.mdx b/docs/src/content/docs/guides/build/macos.mdx new file mode 100644 index 000000000..3271b2faa --- /dev/null +++ b/docs/src/content/docs/guides/build/macos.mdx @@ -0,0 +1,145 @@ +--- +title: macOS Packaging +description: Package your Wails application for macOS distribution +sidebar: + order: 4 +--- + +import { Aside } from '@astrojs/starlight/components'; + +## Application Bundle + +Package your app as a standard macOS `.app` bundle: + +```bash +wails3 package GOOS=darwin +``` + +This creates `bin/.app` containing: +- The compiled binary in `Contents/MacOS/` +- App icon in `Contents/Resources/` (from `icons.icns` or, when present, from an asset catalog `Assets.car`) +- `Info.plist` with app metadata + +### Universal Binary + +Build for both Apple Silicon and Intel Macs: + +```bash +wails3 task darwin:package:universal +``` + +This creates a single `.app` that runs natively on both architectures. Universal binaries can be built on any platform — on Linux and Windows, `wails3 tool lipo` is used automatically. + +## Customizing the Bundle + +Edit `build/darwin/Info.plist` to customize: + +- Bundle identifier (`CFBundleIdentifier`) +- App name and version +- Minimum macOS version +- File associations +- URL schemes + +The app icon is generated from assets in the `build/` directory. Use the `generate:icons` task: + +```bash +wails3 task generate:icons +``` + +This uses `build/appicon.png` to produce `darwin/icons.icns` and `windows/icon.ico`. On macOS you can also provide `build/appicon.icon` (Icon Composer format): the task passes `-iconcomposerinput appicon.icon -macassetdir darwin`, which produces `Assets.car` and `darwin/icons.icns` from the `.icon` file (skipped on non-macOS platforms). When `Assets.car` is present, run the `update:build-assets` task so that `Info.plist` and `CFBundleIconName` are updated accordingly: + +```bash +wails3 task update:build-assets +``` + +To run the icon command manually from the `build/` directory: + +```bash +cd build +wails3 generate icons -input appicon.png -macfilename darwin/icons.icns -windowsfilename windows/icon.ico -iconcomposerinput appicon.icon -macassetdir darwin +``` + +## Code Signing + +Sign your app for distribution: + +```bash +# Using the wrapper (auto-detects platform) +wails3 sign GOOS=darwin + +# Or using the task directly +wails3 task darwin:sign +``` + +Configure signing in `build/darwin/Taskfile.yml`: + +```yaml +vars: + SIGN_IDENTITY: "Developer ID Application: Your Company (TEAMID)" + ENTITLEMENTS: "build/darwin/entitlements.plist" +``` + +### Notarization + +For apps distributed outside the Mac App Store, Apple requires notarization: + +```bash +wails3 task darwin:sign:notarize +``` + +First, store your credentials: + +```bash +wails3 signing credentials \ + --apple-id "you@email.com" \ + --team-id "TEAMID" \ + --password "app-specific-password" \ + --profile "my-notarize-profile" +``` + +Configure in `build/darwin/Taskfile.yml`: + +```yaml +vars: + SIGN_IDENTITY: "Developer ID Application: Your Company (TEAMID)" + KEYCHAIN_PROFILE: "my-notarize-profile" +``` + +See [Signing Applications](/guides/build/signing) for details. + +## DMG Installer + +Create a DMG disk image for distribution: + +```bash +wails3 task darwin:create:dmg +``` + + + +## Troubleshooting + +### "App is damaged and can't be opened" + +The app isn't signed. Either sign it with a Developer ID certificate, or users can bypass Gatekeeper: + +```bash +xattr -cr /path/to/YourApp.app +``` + +### Notarization fails + +Common issues: +- **Invalid credentials**: Re-run `wails3 signing credentials` +- **Hardened runtime required**: Ensure entitlements include `com.apple.security.cs.allow-unsigned-executable-memory` if needed +- **Missing timestamp**: The signing process should include a timestamp automatically + +### Cross-compiled app won't run + +Cross-compiled macOS binaries aren't signed. Transfer to a Mac and sign before testing: + +```bash +codesign --force --deep --sign - YourApp.app +``` diff --git a/docs/src/content/docs/guides/build/signing.mdx b/docs/src/content/docs/guides/build/signing.mdx new file mode 100644 index 000000000..3f6a03382 --- /dev/null +++ b/docs/src/content/docs/guides/build/signing.mdx @@ -0,0 +1,823 @@ +--- +title: Code Signing +description: Guide for signing your Wails applications on all platforms +sidebar: + order: 6 +--- + +import { Tabs, TabItem, Steps, Aside } from '@astrojs/starlight/components'; + +# Code Signing Your Application + +This guide covers how to sign your Wails applications for macOS, Windows, and Linux. Wails v3 provides built-in CLI tools for code signing, notarization, and PGP key management. + +- **macOS** - Sign and notarize your macOS applications +- **Windows** - Sign your Windows executables and packages +- **Linux** - Sign DEB and RPM packages with PGP keys + +## Cross-Platform Signing Matrix + +This matrix shows what you can sign from each source platform: + +| Target Format | From Windows | From macOS | From Linux | +|---------------|:------------:|:----------:|:----------:| +| Windows EXE/MSI | ✅ | ✅ | ✅ | +| macOS .app bundle | ❌ | ✅ | ❌ | +| macOS notarization | ❌ | ✅ | ❌ | +| Linux DEB | ✅ | ✅ | ✅ | +| Linux RPM | ✅ | ✅ | ✅ | + + + +### Signing Backends + +Wails automatically selects the best available signing backend: + +| Platform | Native Backend | Cross-Platform Backend | +|----------|----------------|------------------------| +| Windows | `signtool.exe` (Windows SDK) | Built-in | +| macOS | `codesign` (Xcode) | Not available | +| Linux | N/A | Built-in | + +When running on the native platform, Wails uses the native tools for maximum compatibility. When cross-compiling, it uses the built-in signing support. + +## Quick Start + +The easiest way to configure signing is using the interactive setup wizard: + +```bash +wails3 setup signing +``` + +This command: +- Walks you through configuring signing credentials for each platform +- On macOS, lists available Developer ID certificates from your keychain +- For Linux, can generate a new PGP key if you don't have one +- **Stores passwords securely in your system keychain** (not in Taskfiles) +- Updates the `vars` section in each platform's Taskfile with non-sensitive config + + + +To configure only specific platforms: + +```bash +wails3 setup signing --platform darwin +wails3 setup signing --platform windows --platform linux +``` + +### Manual Configuration + +Alternatively, you can manually edit the platform-specific Taskfiles. Edit the `vars` section at the top of each file: + + + +Edit `build/darwin/Taskfile.yml`: + +```yaml +vars: + SIGN_IDENTITY: "Developer ID Application: Your Company (TEAMID)" + KEYCHAIN_PROFILE: "my-notarize-profile" + # ENTITLEMENTS: "build/darwin/entitlements.plist" +``` + +Then run: + +```bash +wails3 task darwin:sign # Sign only +wails3 task darwin:sign:notarize # Sign and notarize +``` + + +Edit `build/windows/Taskfile.yml`: + +```yaml +vars: + SIGN_CERTIFICATE: "path/to/certificate.pfx" + # Or use thumbprint instead: + # SIGN_THUMBPRINT: "certificate-thumbprint" + # TIMESTAMP_SERVER: "http://timestamp.digicert.com" +``` + +Password is retrieved from system keychain (run `wails3 setup signing` to configure). + +Then run: + +```bash +wails3 task windows:sign # Sign executable +wails3 task windows:sign:installer # Sign NSIS installer +``` + + +Edit `build/linux/Taskfile.yml`: + +```yaml +vars: + PGP_KEY: "path/to/signing-key.asc" + # SIGN_ROLE: "builder" # Options: origin, maint, archive, builder +``` + +Password is retrieved from system keychain (run `wails3 setup signing` to configure). + +Then run: + +```bash +wails3 task linux:sign:deb # Sign DEB package +wails3 task linux:sign:rpm # Sign RPM package +wails3 task linux:sign:packages # Sign all packages +``` + + + +You can also use the CLI directly: + +```bash +# Check signing capabilities on your system +wails3 signing info + +# List available signing identities (macOS/Windows) +wails3 signing list +``` + +## macOS Code Signing + +### Prerequisites + +- Apple Developer Account ($99/year) +- Developer ID Application certificate +- Xcode Command Line Tools installed + +### Signing Identities + +Check available signing identities: + +```bash +wails3 signing list +``` + +Output: + +``` +Found 2 signing identities: + + Developer ID Application: Your Company (ABCD1234) [valid] + Hash: ABC123DEF456... + + Apple Development: your@email.com (XYZ789) [valid] + Hash: DEF789ABC123... +``` + + + +### Configuration + +Edit `build/darwin/Taskfile.yml` and set the signing variables: + +```yaml +vars: + SIGN_IDENTITY: "Developer ID Application: Your Company (TEAMID)" + KEYCHAIN_PROFILE: "my-notarize-profile" + ENTITLEMENTS: "build/darwin/entitlements.plist" +``` + +| Variable | Required | Description | +|----------|----------|-------------| +| `SIGN_IDENTITY` | Yes | Your Developer ID (e.g., "Developer ID Application: Your Company (TEAMID)") | +| `KEYCHAIN_PROFILE` | For notarization | Keychain profile name with stored credentials | +| `ENTITLEMENTS` | No | Path to entitlements file | + +Then run: + +```bash +wails3 task darwin:sign # Build, package, and sign +wails3 task darwin:sign:notarize # Build, package, sign, and notarize +``` + +### Entitlements + +Entitlements control what capabilities your app has access to. Wails apps typically need different entitlements for development vs production: + +- **Development**: Requires JIT, unsigned memory, and debugging entitlements +- **Production**: Minimal entitlements (just network access) + +Use the interactive setup wizard to generate both files: + +```bash +wails3 setup entitlements +``` + +This creates: +- `build/darwin/entitlements.dev.plist` - For development builds +- `build/darwin/entitlements.plist` - For production/signed builds + +**Presets available:** +| Preset | Description | +|--------|-------------| +| Development | JIT, unsigned memory, debugging, network | +| Production | Network only (minimal, most secure) | +| Both | Creates both dev and production files (recommended) | +| App Store | Sandbox enabled with network and file access | +| Custom | Choose individual entitlements | + + + +Then set `ENTITLEMENTS` in your Taskfile vars to point to the appropriate file. + +### Notarization + +Apple requires all distributed apps to be notarized. + + +1. **Store your credentials in the keychain** (one-time setup): + ```bash + wails3 signing credentials \ + --apple-id "your@email.com" \ + --team-id "ABCD1234" \ + --password "app-specific-password" \ + --profile "my-notarize-profile" + ``` + +2. **Set KEYCHAIN_PROFILE in your Taskfile** to match the profile name above. + +3. **Sign and notarize your app**: + ```bash + wails3 task darwin:sign:notarize + ``` + +4. **Verify notarization**: + ```bash + spctl --assess --verbose=2 bin/MyApp.app + ``` + + + + +## Windows Code Signing + +### Prerequisites + +- Code signing certificate (from DigiCert, Sectigo, etc.) +- For native signing: Windows SDK installed (for signtool.exe) +- For cross-platform: Just the certificate file + +### Configuration + +Edit `build/windows/Taskfile.yml` and set the signing variables: + +```yaml +vars: + SIGN_CERTIFICATE: "path/to/certificate.pfx" + # Or use thumbprint instead: + # SIGN_THUMBPRINT: "certificate-thumbprint" + # TIMESTAMP_SERVER: "http://timestamp.digicert.com" +``` + +| Variable | Required | Description | +|----------|----------|-------------| +| `SIGN_CERTIFICATE` | One of these | Path to .pfx/.p12 certificate file | +| `SIGN_THUMBPRINT` | One of these | Certificate thumbprint in Windows cert store | +| `TIMESTAMP_SERVER` | No | Timestamp server URL (default: http://timestamp.digicert.com) | + + + +Then run: + +```bash +wails3 task windows:sign # Build and sign executable +wails3 task windows:sign:installer # Build and sign NSIS installer +``` + +### Cross-Platform Signing + +Windows executables can be signed from any platform. The same Taskfile configuration and commands work on macOS and Linux. + +### Supported Windows Formats + +| Format | Extension | Notes | +|--------|-----------|-------| +| Executables | .exe | Standard PE signing | +| Installers | .msi | Windows Installer packages | +| App Packages | .msix, .appx | Modern Windows apps | + +## Linux Package Signing + +Linux packages (DEB and RPM) are signed using PGP/GPG keys. Unlike Windows and macOS code signing, Linux package signing proves the package came from a trusted source rather than that the code is trusted by the OS. + +### Prerequisites + +- PGP key pair (can be generated with Wails) + +### Generating a PGP Key + +If you don't have a PGP key, Wails can generate one for you: + +```bash +wails3 signing generate-key \ + --name "Your Name" \ + --email "your@email.com" \ + --comment "Package Signing Key" \ + --output-private signing-key.asc \ + --output-public signing-key.pub.asc +``` + +Options: +- `--bits`: Key size (default: 4096) +- `--expiry`: Key expiry duration (e.g., "1y", "6m", "0" for no expiry) +- `--password`: Password to protect the private key + + + +### Configuration + +Edit `build/linux/Taskfile.yml` and set the signing variables: + +```yaml +vars: + PGP_KEY: "path/to/signing-key.asc" + # SIGN_ROLE: "builder" # Options: origin, maint, archive, builder +``` + +| Variable | Required | Description | +|----------|----------|-------------| +| `PGP_KEY` | Yes | Path to PGP private key file | +| `SIGN_ROLE` | No | DEB signing role (default: builder) | + + + +Then run: + +```bash +wails3 task linux:sign:deb # Build and sign DEB package +wails3 task linux:sign:rpm # Build and sign RPM package +wails3 task linux:sign:packages # Build and sign all packages +``` + +### DEB Signing Roles + +For DEB packages, you can specify the signing role via `SIGN_ROLE`: + +- `origin`: Signature from the package origin +- `maint`: Signature from the package maintainer +- `archive`: Signature from the archive maintainer +- `builder`: Signature from the package builder (default) + +### Cross-Platform Signing + +Linux packages can be signed from any platform. The same Taskfile configuration and commands work on Windows and macOS. + +### Viewing Key Information + +```bash +wails3 signing key-info --key signing-key.asc +``` + +Output: + +``` +PGP Key Information: + Key ID: ABC123DEF456 + Fingerprint: 1234 5678 90AB CDEF ... + User IDs: Your Name + Created: 2024-01-15 + Expires: 2025-01-15 + Has Private: Yes + Encrypted: Yes +``` + +### Verifying Linux Packages + +```bash +# Verify DEB signature +dpkg-sig --verify myapp_1.0.0_amd64.deb + +# Verify RPM signature +rpm --checksig myapp-1.0.0.x86_64.rpm +``` + +### Distributing Your Public Key + +Users need your public key to verify packages: + +```bash +# Export public key for distribution +wails3 signing key-info --key signing-key.asc --export-public > myapp-signing.pub.asc + +# Users can import it: +# For DEB (apt): +sudo apt-key add myapp-signing.pub.asc +# Or for modern apt: +sudo cp myapp-signing.pub.asc /etc/apt/trusted.gpg.d/ + +# For RPM: +sudo rpm --import myapp-signing.pub.asc +``` + +## GitHub Actions Integration + +In CI environments, passwords are provided via environment variables instead of the system keychain: + +| Environment Variable | Description | +|---------------------|-------------| +| `WAILS_WINDOWS_CERT_PASSWORD` | Windows certificate password | +| `WAILS_PGP_PASSWORD` | PGP key password for Linux packages | + +You can also pass Taskfile variables directly: + +```bash +wails3 task darwin:sign SIGN_IDENTITY="$SIGN_IDENTITY" KEYCHAIN_PROFILE="$KEYCHAIN_PROFILE" +``` + +### macOS Workflow + +```yaml +name: Build and Sign macOS + +on: + push: + tags: ['v*'] + +jobs: + build: + runs-on: macos-latest + steps: + - uses: actions/checkout@v4 + + - name: Setup Go + uses: actions/setup-go@v5 + with: + go-version: '1.23' + + - name: Install Wails + run: go install github.com/wailsapp/wails/v3/cmd/wails3@latest + + - name: Import Certificate + env: + CERTIFICATE_BASE64: ${{ secrets.MACOS_CERTIFICATE }} + CERTIFICATE_PASSWORD: ${{ secrets.MACOS_CERTIFICATE_PASSWORD }} + run: | + echo $CERTIFICATE_BASE64 | base64 --decode > certificate.p12 + security create-keychain -p "" build.keychain + security default-keychain -s build.keychain + security unlock-keychain -p "" build.keychain + security import certificate.p12 -k build.keychain -P "$CERTIFICATE_PASSWORD" -T /usr/bin/codesign + security set-key-partition-list -S apple-tool:,apple:,codesign: -s -k "" build.keychain + + - name: Store Notarization Credentials + env: + APPLE_ID: ${{ secrets.APPLE_ID }} + APPLE_TEAM_ID: ${{ secrets.APPLE_TEAM_ID }} + APPLE_APP_PASSWORD: ${{ secrets.APPLE_APP_PASSWORD }} + run: | + wails3 signing credentials \ + --apple-id "$APPLE_ID" \ + --team-id "$APPLE_TEAM_ID" \ + --password "$APPLE_APP_PASSWORD" \ + --profile "notarize-profile" + + - name: Build, Sign, and Notarize + env: + SIGN_IDENTITY: ${{ secrets.MACOS_SIGN_IDENTITY }} + run: | + wails3 task darwin:sign:notarize \ + SIGN_IDENTITY="$SIGN_IDENTITY" \ + KEYCHAIN_PROFILE="notarize-profile" + + - name: Upload Artifact + uses: actions/upload-artifact@v4 + with: + name: MyApp-macOS + path: bin/*.app +``` + +### Windows Workflow + +```yaml +name: Build and Sign Windows + +on: + push: + tags: ['v*'] + +jobs: + build: + runs-on: windows-latest + steps: + - uses: actions/checkout@v4 + + - name: Setup Go + uses: actions/setup-go@v5 + with: + go-version: '1.23' + + - name: Install Wails + run: go install github.com/wailsapp/wails/v3/cmd/wails3@latest + + - name: Import Certificate + env: + CERTIFICATE_BASE64: ${{ secrets.WINDOWS_CERTIFICATE }} + run: | + $certBytes = [Convert]::FromBase64String($env:CERTIFICATE_BASE64) + [IO.File]::WriteAllBytes("certificate.pfx", $certBytes) + + - name: Build and Sign + env: + WAILS_WINDOWS_CERT_PASSWORD: ${{ secrets.WINDOWS_CERTIFICATE_PASSWORD }} + run: | + wails3 task windows:sign SIGN_CERTIFICATE=certificate.pfx + + - name: Upload Artifact + uses: actions/upload-artifact@v4 + with: + name: MyApp-Windows + path: bin/*.exe +``` + +### Cross-Platform Workflow (Linux Runner) + +Sign Windows and Linux packages from a single Linux runner: + +```yaml +name: Build and Sign (Cross-Platform) + +on: + push: + tags: ['v*'] + +jobs: + build-and-sign: + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v4 + + - name: Setup Go + uses: actions/setup-go@v5 + with: + go-version: '1.23' + + - name: Install Wails + run: go install github.com/wailsapp/wails/v3/cmd/wails3@latest + + - name: Install Build Dependencies + run: | + sudo apt-get update + sudo apt-get install -y nsis rpm + + # Import certificates + - name: Import Certificates + env: + WINDOWS_CERT_BASE64: ${{ secrets.WINDOWS_CERTIFICATE }} + PGP_KEY_BASE64: ${{ secrets.PGP_PRIVATE_KEY }} + run: | + echo "$WINDOWS_CERT_BASE64" | base64 -d > certificate.pfx + echo "$PGP_KEY_BASE64" | base64 -d > signing-key.asc + + # Build and sign Windows + - name: Build and Sign Windows + env: + WAILS_WINDOWS_CERT_PASSWORD: ${{ secrets.WINDOWS_CERTIFICATE_PASSWORD }} + run: | + wails3 task windows:sign SIGN_CERTIFICATE=certificate.pfx + + # Build and sign Linux packages + - name: Build and Sign Linux Packages + env: + WAILS_PGP_PASSWORD: ${{ secrets.PGP_PASSWORD }} + run: | + wails3 task linux:sign:packages PGP_KEY=signing-key.asc + + # Cleanup secrets + - name: Cleanup + if: always() + run: rm -f certificate.pfx signing-key.asc + + - name: Upload Artifacts + uses: actions/upload-artifact@v4 + with: + name: signed-binaries + path: | + bin/*.exe + bin/*.deb + bin/*.rpm +``` + + + +## CLI Reference + +### wails3 setup signing + +Interactive wizard to configure signing for your project. + +```bash +wails3 setup signing [flags] + +Flags: + --platform Platform(s) to configure (darwin, windows, linux) + If not specified, configures all platforms +``` + +The wizard guides you through: +- **macOS**: Selecting a Developer ID certificate, configuring notarization profile +- **Windows**: Choosing between certificate file or thumbprint, setting password and timestamp server +- **Linux**: Using an existing PGP key or generating a new one, configuring signing role + +### wails3 setup entitlements + +Interactive wizard to configure macOS entitlements. + +```bash +wails3 setup entitlements [flags] + +Flags: + --output Output directory (default: build/darwin) +``` + +**Presets:** +- **Development**: Creates `entitlements.dev.plist` with JIT, debugging, and network +- **Production**: Creates `entitlements.plist` with minimal entitlements +- **Both**: Creates both files (recommended) +- **App Store**: Creates sandboxed entitlements for Mac App Store +- **Custom**: Choose individual entitlements and target file + +### wails3 sign + +Sign binaries and packages for the current or specified platform. This is a wrapper that calls the appropriate platform-specific signing task. + +```bash +wails3 sign +wails3 sign GOOS=darwin +wails3 sign GOOS=windows +wails3 sign GOOS=linux +``` + +This runs the corresponding `:sign` task which uses the signing configuration from your Taskfile. + +### wails3 tool sign + +Low-level command to sign a specific file directly. Used internally by the Taskfiles. + +```bash +wails3 tool sign [flags] +``` + +**Common Flags:** +| Flag | Description | +|------|-------------| +| `--input` | Path to the file to sign | +| `--output` | Output path (optional, defaults to in-place) | +| `--verbose` | Enable verbose output | + +**Windows/macOS Flags:** +| Flag | Description | +|------|-------------| +| `--certificate` | Path to PKCS#12 (.pfx/.p12) certificate | +| `--password` | Certificate password | +| `--timestamp` | Timestamp server URL | + +**macOS-Specific Flags:** +| Flag | Description | +|------|-------------| +| `--identity` | Signing identity (use '-' for ad-hoc) | +| `--entitlements` | Path to entitlements plist | +| `--hardened-runtime` | Enable hardened runtime (default: true) | +| `--notarize` | Submit for notarization | +| `--keychain-profile` | Keychain profile for notarization | + +**Windows-Specific Flags:** +| Flag | Description | +|------|-------------| +| `--thumbprint` | Certificate thumbprint in Windows store | +| `--description` | Application description | +| `--url` | Application URL | + +**Linux-Specific Flags:** +| Flag | Description | +|------|-------------| +| `--pgp-key` | Path to PGP private key | +| `--pgp-password` | PGP key password | +| `--role` | DEB signing role (origin/maint/archive/builder) | + +### wails3 signing info + +Display signing capabilities on the current system. + +```bash +wails3 signing info +``` + +### wails3 signing list + +List available signing identities. + +```bash +wails3 signing list +``` + +### wails3 signing credentials + +Store notarization credentials in keychain (macOS only). + +```bash +wails3 signing credentials [flags] + +Flags: + --apple-id Apple ID email + --team-id Apple Developer Team ID + --password App-specific password + --profile Keychain profile name +``` + +### wails3 signing generate-key + +Generate a PGP key pair for Linux package signing. + +```bash +wails3 signing generate-key [flags] + +Flags: + --name Name for the key (required) + --email Email for the key (required) + --comment Comment for the key + --bits Key size in bits (default: 4096) + --expiry Key expiry (e.g., "1y", "6m", "0" for never) + --password Password to encrypt private key + --output-private Path for private key output + --output-public Path for public key output +``` + +### wails3 signing key-info + +Display information about a PGP key. + +```bash +wails3 signing key-info --key +``` + +## Troubleshooting + +### macOS Issues + +**"No Developer ID certificate found"** +- Ensure your certificate is installed in the Keychain +- Check it hasn't expired with `wails3 signing list` +- Make sure you have a "Developer ID Application" certificate (not just "Apple Development") + +**"Notarization failed"** +- Check the notarization log: `xcrun notarytool log --keychain-profile ` +- Ensure hardened runtime is enabled +- Verify your app doesn't include unsigned binaries + +**"Codesign failed"** +- Make sure the keychain is unlocked: `security unlock-keychain` +- Check file permissions on the app bundle + +### Windows Issues + +**"Certificate not found"** +- Verify the certificate path is correct +- Check the certificate password +- Ensure the certificate is valid (not expired or revoked) + +**"Timestamp server error"** +- Try a different timestamp server: + - `http://timestamp.digicert.com` + - `http://timestamp.sectigo.com` + - `http://timestamp.comodoca.com` + +### Linux Issues + +**"Invalid PGP key"** +- Ensure the key file is in ASCII-armored format +- Check the key hasn't expired with `wails3 signing key-info` +- Verify the password is correct + +**"Signature verification failed"** +- Ensure the public key is properly imported +- Check that the package wasn't modified after signing + +## Additional Resources + +### Official Documentation +- [Apple Code Signing Guide](https://developer.apple.com/support/code-signing/) +- [Apple Notarization Documentation](https://developer.apple.com/documentation/security/notarizing_macos_software_before_distribution) +- [Microsoft Code Signing](https://docs.microsoft.com/en-us/windows-hardware/drivers/dashboard/get-a-code-signing-certificate) +- [Debian Package Signing](https://wiki.debian.org/SecureApt) +- [RPM Package Signing](https://rpm-software-management.github.io/rpm/manual/signatures.html) diff --git a/docs/src/content/docs/guides/build/windows.mdx b/docs/src/content/docs/guides/build/windows.mdx new file mode 100644 index 000000000..fe4183cb4 --- /dev/null +++ b/docs/src/content/docs/guides/build/windows.mdx @@ -0,0 +1,124 @@ +--- +title: Windows Packaging +description: Package your Wails application for Windows distribution +sidebar: + order: 3 +--- + +import { Aside } from '@astrojs/starlight/components'; + +## NSIS Installer + +The default packaging format creates an NSIS installer: + +```bash +wails3 package GOOS=windows +``` + +This runs `wails3 task windows:package` which: +1. Builds the application +2. Generates the WebView2 bootstrapper +3. Creates an NSIS installer + +Output: `build/windows/nsis/-installer.exe` + +### MSIX Package + +For Microsoft Store distribution or modern Windows deployment: + +```bash +wails3 package GOOS=windows FORMAT=msix +``` + +Output: `bin/-.msix` + + + +## Customizing the Installer + +NSIS configuration is in `build/windows/nsis/project.nsi`. Edit this file to customize: + +- Installer UI and branding +- Installation directory +- Start menu and desktop shortcuts +- File associations +- License agreement + +Application metadata comes from `build/windows/info.json`: + +```json +{ + "fixed": { + "file_version": "1.0.0" + }, + "info": { + "0000": { + "ProductVersion": "1.0.0", + "CompanyName": "My Company", + "FileDescription": "My Application", + "ProductName": "MyApp" + } + } +} +``` + +## Code Signing + +Sign your executable and installer to avoid SmartScreen warnings: + +```bash +# Using the wrapper (auto-detects platform) +wails3 sign GOOS=windows + +# Or using tasks directly +wails3 task windows:sign +wails3 task windows:sign:installer +``` + +Configure signing in `build/windows/Taskfile.yml`: + +```yaml +vars: + SIGN_CERTIFICATE: "path/to/certificate.pfx" + # Or use thumbprint for certificates in Windows store + SIGN_THUMBPRINT: "certificate-thumbprint" + TIMESTAMP_SERVER: "http://timestamp.digicert.com" +``` + +Store your certificate password securely: + +```bash +wails3 setup signing +``` + +See [Signing Applications](/guides/build/signing) for details. + +## Building for ARM + +```bash +wails3 build GOOS=windows GOARCH=arm64 +wails3 package GOOS=windows GOARCH=arm64 +``` + +## Troubleshooting + +### makensis not found + +Install NSIS: + +```bash +# Windows +winget install NSIS.NSIS + +# Or download from https://nsis.sourceforge.io/ +``` + +### SmartScreen warning + +Your executable isn't signed. See [Code Signing](#code-signing) above. + +### WebView2 missing + +The installer includes a WebView2 bootstrapper that downloads the runtime if needed. If you need offline installation, download the Evergreen Standalone Installer from Microsoft. diff --git a/docs/src/content/docs/guides/cli.mdx b/docs/src/content/docs/guides/cli.mdx new file mode 100644 index 000000000..fb9f23969 --- /dev/null +++ b/docs/src/content/docs/guides/cli.mdx @@ -0,0 +1,539 @@ +--- +title: CLI Reference +description: Complete reference for the Wails CLI commands +sidebar: + order: 1 +--- + +The Wails CLI provides a comprehensive set of commands to help you develop, build, and maintain your Wails applications. + +## Core Commands + +Core commands are the primary commands used for project creation, development, and building. + +All CLI commands are of the following format: `wails3 `. + +### `init` +Initializes a new Wails project. During this initialization, the `go mod tidy` command is run to bring the project packages up to date. This can be bypassed by using the `-skipgomodtidy` flag with the `init` command. + +```bash +wails3 init [flags] +``` + +#### Flags +| Flag | Description | Default | +|-----------------------|----------------------|--------------------------| +| `-p` | Package name | `main` | +| `-t` | Template name or URL | `vanilla` | +| `-n` | Project name | | +| `-d` | Project directory | `.` | +| `-q` | Suppress output | `false` | +| `-l` | List templates | `false` | +| `-git` | Git repository URL | | +| `-productname` | Product name | `My Product` | +| `-productdescription` | Product description | `My Product Description` | +| `-productversion` | Product version | `0.1.0` | +| `-productcompany` | Company name | `My Company` | +| `-productcopyright` | Copyright notice | ` now, My Company` | +| `-productcomments` | File comments | `This is a comment` | +| `-productidentifier` | Product identifier | | +| `-skipgomodtidy` | Skip go mod tidy | `false` | + +The `-git` flag accepts various Git URL formats: +- HTTPS: `https://github.com/username/project` +- SSH: `git@github.com:username/project` or `ssh://git@github.com/username/project` +- Git protocol: `git://github.com/username/project` +- Filesystem: `file:///path/to/project.git` + +When provided, this flag will: +1. Initialize a git repository in the project directory +2. Set the specified URL as the remote origin +3. Update the module name in `go.mod` to match the repository URL +4. Add all files + +### `dev` +Runs the application in development mode. This will give you a live view of your frontend code, and you can make changes and see them reflected +in the running application without having to rebuild the entire application. Changes to your Go code will also be detected and the application +will automatically rebuild and relaunch. + +```bash +wails3 dev [flags] +``` + +#### Flags +| Flag | Description | Default | +|-----------|----------------------|----------------------| +| `-config` | Config file path | `./build/config.yml` | +| `-port` | Vite dev server port | `9245` | +| `-s` | Enable HTTPS | `false` | + + + :::note + This is equivalent to running `wails3 task dev` and runs the `dev` task in the project's main Taskfile. You can customise this by editing the `Taskfile.yml` file. + ::: + + +### `build` +Builds a debug version of your application. It defaults to building for the current platform and architecture. + +```bash +wails3 build [CLI variables...] +``` + +You can pass CLI variables to customize the build: +```bash +wails3 build PLATFORM=linux CONFIG=production +``` + + :::note + This is equivalent to running `wails3 task build` which runs the `build` task in the project's main Taskfile. Any CLI variables passed to `build` are forwarded to the underlying task. You can customise the build process by editing the `Taskfile.yml` file. + ::: + +### `package` + +Creates platform-specific packages for distribution. + +```bash +wails3 package [CLI variables...] +``` + +You can pass CLI variables to customize the packaging: +```bash +wails3 package VERSION=2.0.0 OUTPUT=myapp.pkg +``` + +#### Package Types + +The following package types are available for each platform: + +| Platform | Package Type | +|----------|-------------------------------------------| +| Windows | `.exe` | +| macOS | `.app`, | +| Linux | `.AppImage`, `.deb`, `.rpm`, `.archlinux` | + + :::note + This is equivalent to `wails3 task package` which runs the `package` task in the project's main Taskfile. Any CLI variables passed to `package` are forwarded to the underlying task. You can customise the packaging process by editing the `Taskfile.yml` file. + ::: + + +### `task` +Runs tasks defined in your project's Taskfile.yml. This is an embedded version of [Taskfile](https://taskfile.dev) that allows you to define and run custom build, test, and deployment tasks. + +```bash +wails3 task [taskname] [CLI variables...] [flags] +``` + +#### CLI Variables +You can pass variables to tasks in the format `KEY=VALUE`: +```bash +wails3 task build PLATFORM=linux CONFIG=production +wails3 task deploy ENV=staging VERSION=1.2.3 +``` + +These variables can be accessed in your Taskfile.yml using Go template syntax: +```yaml +tasks: + build: + cmds: + - echo "Building for {{.PLATFORM | default "darwin"}}" + - echo "Config: {{.CONFIG | default "debug"}}" +``` + +#### Flags +| Flag | Description | Default | +|--------------|-------------------------------------------|----------| +| `-h` | Shows Task usage | `false` | +| `-i` | Creates a new Taskfile.yml | `false` | +| `-list` | Lists tasks with descriptions | `false` | +| `-list-all` | Lists all tasks (with or without descriptions) | `false` | +| `-json` | Formats task list as JSON | `false` | +| `-status` | Exits with non-zero if task is not up-to-date | `false` | +| `-f` | Forces execution even when task is up-to-date | `false` | +| `-w` | Enables watch mode for the given task | `false` | +| `-v` | Enables verbose mode | `false` | +| `-version` | Prints Task version | `false` | +| `-s` | Disables echoing | `false` | +| `-p` | Executes tasks in parallel | `false` | +| `-dry` | Compiles and prints tasks without executing | `false` | +| `-summary` | Shows summary about a task | `false` | +| `-x` | Pass-through the exit code of the task | `false` | +| `-dir` | Sets directory of execution | | +| `-taskfile` | Choose which Taskfile to run | | +| `-output` | Sets output style: [interleaved|group|prefixed] | | +| `-c` | Colored output (enabled by default) | `true` | +| `-C` | Limit number of tasks to run concurrently | | +| `-interval` | Interval to watch for changes (in seconds) | | + +#### Examples +```bash +# Run the default task +wails3 task + +# Run a specific task +wails3 task test + +# Run a task with variables +wails3 task build PLATFORM=windows ARCH=amd64 + +# List all available tasks +wails3 task --list + +# Run multiple tasks in parallel +wails3 task -p task1 task2 task3 + +# Watch for changes and re-run task +wails3 task -w dev +``` + +### `doctor` +Performs a system check and displays a status report. + +```bash +wails3 doctor +``` + +## Generate Commands + +Generate commands help create various project assets like bindings, icons, and build files. All generate commands use the base command: `wails3 generate `. + +### `generate bindings` +Generates bindings and models for your Go code. + +```bash +wails3 generate bindings [flags] [patterns...] +``` + +#### Flags +| Flag | Description | Default | +|-------------|---------------------------|---------------------| +| `-f` | Additional Go build flags | | +| `-d` | Output directory | `frontend/bindings` | +| `-models` | Models filename | `models` | +| `-index` | Index filename | `index` | +| `-ts` | Generate TypeScript | `false` | +| `-i` | Use TS interfaces | `false` | +| `-b` | Use bundled runtime | `false` | +| `-names` | Use names instead of IDs | `false` | +| `-noindex` | Skip index files | `false` | +| `-dry` | Dry run | `false` | +| `-silent` | Silent mode | `false` | +| `-v` | Debug output | `false` | +| `-clean` | Clean output directory | `false` | + +### `generate build-assets` +Generates build assets for your application. + +```bash +wails3 generate build-assets [flags] +``` + +#### Flags +| Flag | Description | Default | +|----------------|---------------------|--------------------| +| `-name` | Project name | | +| `-dir` | Output directory | `build` | +| `-silent` | Suppress output | `false` | +| `-company` | Company name | | +| `-productname` | Product name | | +| `-description` | Product description | | +| `-version` | Product version | | +| `-identifier` | Product identifier | `com.wails.[name]` | +| `-copyright` | Copyright notice | | +| `-comments` | File comments | | + +### `generate icons` +Generates application icons. + +```bash +wails3 generate icons [flags] +``` + +#### Flags +| Flag | Description | Default | +|--------------------|------------------------------|-----------------------| +| `-input` | Input PNG file | Required | +| `-windowsfilename` | Windows output filename | | +| `-macfilename` | macOS output filename | | +| `-sizes` | Icon sizes (comma-separated) | `256,128,64,48,32,16` | +| `-example` | Generate example icon | `false` | + +### `generate syso` +Generates Windows .syso file. + +```bash +wails3 generate syso [flags] +``` + +#### Flags +| Flag | Description | Default | +|-------------|---------------------------|----------------------------| +| `-manifest` | Path to manifest file | Required | +| `-icon` | Path to icon file | Required | +| `-info` | Path to version info file | | +| `-arch` | Target architecture | Current GOARCH | +| `-out` | Output filename | `rsrc_windows_[arch].syso` | + +### `generate .desktop` +Generates a Linux .desktop file. + +```bash +wails3 generate .desktop [flags] +``` + +#### Flags +| Flag | Description | Default | +|------------------|---------------------------|------------------| +| `-name` | Application name | Required | +| `-exec` | Executable path | Required | +| `-icon` | Icon path | | +| `-categories` | Application categories | `Utility` | +| `-comment` | Application comment | | +| `-terminal` | Run in terminal | `false` | +| `-keywords` | Search keywords | | +| `-version` | Application version | | +| `-genericname` | Generic name | | +| `-startupnotify` | Show startup notification | `false` | +| `-mimetype` | Supported MIME types | | +| `-output` | Output filename | `[name].desktop` | + +### `generate runtime` +Generates the pre-built version of the runtime. + +```bash +wails3 generate runtime +``` + +### `generate constants` +Generates JavaScript constants from Go code. + +```bash +wails3 generate constants +``` + +### `generate appimage` +Generates a Linux AppImage. + +```bash +wails3 generate appimage [flags] +``` + +#### Flags +| Flag | Description | Default | +|-------------|-----------------------|----------------| +| `-binary` | Path to binary | Required | +| `-icon` | Path to icon file | Required | +| `-desktop` | Path to .desktop file | Required | +| `-builddir` | Build directory | Temp directory | +| `-output` | Output directory | `.` | + +Base command: `wails3 service` + +## Service Commands + +Service commands help manage Wails services. All service commands use the base command: `wails3 service `. + +### `service init` +Initializes a new service. + +```bash +wails3 service init [flags] +``` + +#### Flags +| Flag | Description | Default | +|------|---------------------|-------------------| +| `-n` | Service name | `example_service` | +| `-d` | Service description | `Example service` | +| `-p` | Package name | | +| `-o` | Output directory | `.` | +| `-q` | Suppress output | `false` | +| `-a` | Author name | | +| `-v` | Version | | +| `-w` | Website URL | | +| `-r` | Repository URL | | +| `-l` | License | | + +Base command: `wails3 tool` + +## Tool Commands + +Tool commands provide utilities for development and debugging. All tool commands use the base command: `wails3 tool `. + +### `tool checkport` +Checks if a port is open. Useful for testing if vite is running. + +```bash +wails3 tool checkport [flags] +``` + +#### Flags +| Flag | Description | Default | +|---------|---------------|-------------| +| `-port` | Port to check | `9245` | +| `-host` | Host to check | `localhost` | + +### `tool watcher` +Watches files and runs a command when they change. + +```bash +wails3 tool watcher [flags] +``` + +#### Flags +| Flag | Description | Default | +|------------|---------------------|----------------------| +| `-config` | Config file path | `./build/config.yml` | +| `-ignore` | Patterns to ignore | | +| `-include` | Patterns to include | | + +### `tool cp` +Copies files. + +```bash +wails3 tool cp +``` + +### `tool buildinfo` +Shows build information about the application. + +```bash +wails3 tool buildinfo +``` + +### `tool version` +Bumps a semantic version based on the provided flags. + +```bash +wails3 tool version [flags] +``` + +#### Flags +| Flag | Description | Default | +|---------------|--------------------------------------------------|---------| +| `-v` | Current version to bump | | +| `-major` | Bump major version | `false` | +| `-minor` | Bump minor version | `false` | +| `-patch` | Bump patch version | `false` | +| `-prerelease` | Bump prerelease version (e.g., alpha.5 to alpha.6) | `false` | + +The command follows the precedence order: major > minor > patch > prerelease. It preserves the "v" prefix if present in the input version, as well as any prerelease and metadata components. + +Example usage: +```bash +wails3 tool version -v 1.2.3 -major # Output: 2.0.0 +wails3 tool version -v v1.2.3 -minor # Output: v1.3.0 +wails3 tool version -v 1.2.3-alpha -patch # Output: 1.2.4-alpha +wails3 tool version -v v3.0.0-alpha.5 -prerelease # Output: v3.0.0-alpha.6 +``` + +### `tool package` +Generates Linux packages (deb, rpm, archlinux). + +```bash +wails3 tool package [flags] +``` + +#### Flags +| Flag | Description | Default | +|-----------|--------------------------------------|----------| +| `-format` | Package format (deb, rpm, archlinux) | `deb` | +| `-name` | Executable name | Required | +| `-config` | Config file path | Required | +| `-out` | Output directory | `.` | + +#### Flags +| Flag | Description | Default | +|-----------|--------------------------------------|---------| +| `-format` | Package format (deb, rpm, archlinux) | `deb` | +| `-name` | Executable name | `myapp` | +| `-config` | Config file path | | +| `-out` | Output directory | `.` | + +Base command: `wails3 update` + +## Update Commands + +Update commands help manage and update project assets. All update commands use the base command: `wails3 update `. + +### `update cli` +Updates the Wails CLI to a new version. + +```bash +wails3 update cli [flags] +``` + +#### Flags +| Flag | Description | Default | +|-------------|---------------------------------|---------| +| `-pre` | Update to latest pre-release | `false` | +| `-version` | Update to specific version | | +| `-nocolour` | Disable colored output | `false` | + +The update cli command allows you to update your Wails CLI installation. By default, it updates to the latest stable release. +You can use the `-pre` flag to update to the latest pre-release version, or specify a particular version using the `-version` flag. + +After updating, remember to update your project's go.mod file to use the same version: +```bash +require github.com/wailsapp/wails/v3 v3.x.x +``` + +### `update build-assets` +Updates the build assets using the given config file. + +```bash +wails3 update build-assets [flags] +``` + +#### Flags +| Flag | Description | Default | +|----------------|---------------------|---------| +| `-config` | Config file path | | +| `-dir` | Output directory | `build` | +| `-silent` | Suppress output | `false` | +| `-company` | Company name | | +| `-productname` | Product name | | +| `-description` | Product description | | +| `-version` | Product version | | +| `-identifier` | Product identifier | | +| `-copyright` | Copyright notice | | +| `-comments` | File comments | | + +Base command: `wails3` + +## Utility Commands + +Utility commands provide helpful shortcuts for common tasks. Use these commands directly with the base command: `wails3 `. + +### `docs` +Opens the Wails documentation in your default browser. + +```bash +wails3 docs +``` + +### `releasenotes` +Shows the release notes for the current or specified version. + +```bash +wails3 releasenotes [flags] +``` + +#### Flags +| Flag | Description | Default | +|------|-----------------------------------|---------| +| `-v` | Version to show release notes for | | +| `-n` | Disable colour output | `false` | + +### `version` +Prints the current version of Wails. + +```bash +wails3 version +``` + +### `sponsor` +Opens the Wails sponsorship page in your default browser. + +```bash +wails3 sponsor diff --git a/docs/src/content/docs/guides/custom-templates.mdx b/docs/src/content/docs/guides/custom-templates.mdx new file mode 100644 index 000000000..3da561b35 --- /dev/null +++ b/docs/src/content/docs/guides/custom-templates.mdx @@ -0,0 +1,293 @@ +--- +title: Creating Custom Templates +description: Learn how to create and customise your own Wails v3 templates +sidebar: + order: 50 +--- + +This guide will walk you through the process of creating a custom template for Wails v3. + +## Why would I make a custom template? + +Wails comes with a number of pre-configured templates that allow you to get your application up and running quickly. But if you need a more customised setup, you can create your own template to suit your needs. This can then be shared with the Wails community for others to use. + +### 1. Generating a Template + +To create a custom template, you can use the `wails generate template` command: + +```bash +wails3 generate template -name mytemplate +``` + +This will create a new directory called "mytemplate" in your current directory. + +The `wails3 generate template` command supports the following options: + +| Option | Description | Default | +|----------------|---------------------------------------------------|-------------------| +| `-name` | The name of your template (required) | - | +| `-frontend` | Path to an existing frontend directory to include | - | +| `-author` | The author of the template | - | +| `-description` | A description of the template | - | +| `-helpurl` | URL for template documentation | - | +| `-dir` | Directory to generate the template in | Current directory | +| `-version` | Template version | v0.0.1 | + +For example, to create a template with all options: + +```bash +wails3 generate template \ + -name "My Custom Template" \ + -frontend ./my-existing-frontend \ + -author "Your Name" \ + -description "A template with my preferred setup" \ + -helpurl "https://github.com/yourusername/template-docs" \ + -dir ./templates \ + -version "v1.0.0" +``` + + :::tip + Using the `-frontend` option will copy an existing web frontend project into the template. + ::: + +### 2. Configure Template Metadata + +If you didn't specify the template configuration when generating the template, you can update the `template.json` file in the template directory: + +```json5 +{ + "name": "Your Template Name", // Display name of your template + "shortname": "template-shortname", // Used when referencing your template + "author": "Your Name", // Template author + "description": "Template description", // Template description + "helpurl": "https://your-docs.com", // Documentation URL + "version": "v0.0.1", // Template version + "schema": 3 // Must be kept as 3 for Wails v3 +} +``` +:::caution +The `schema` field must remain set to `3` for compatibility with Wails v3. +::: + +### 3. Set Up Build Tasks + +In the `build` directory is `Taskfile.yml` where you can define your template's build process. +This file uses [Task](https://taskfile.dev) for build automation. The key steps are: + +```yaml +tasks: + install:frontend:deps: + summary: Install frontend dependencies + dir: frontend + sources: + - package.json + - package-lock.json + generates: + - node_modules/* + preconditions: + - sh: npm version + msg: "Looks like npm isn't installed. Npm is part of the Node installer: https://nodejs.org/en/download/" + cmds: + - npm install + + build:frontend: + summary: Build the frontend project + dir: frontend + sources: + - "**/*" + generates: + - dist/* + deps: + - task: install:frontend:deps + - task: generate:bindings + cmds: + - npm run build -q + + +``` + +### 4. Frontend Setup + +If you did not use `-frontend` when generating the template, you need to add frontend files to your template. + +There are a number of ways to set up your frontend: starting from scratch or using an existing framework. + +import { Tabs, TabItem } from '@astrojs/starlight/components'; + + + + If you want to start from scratch, you can create your frontend project just like you would for any web application. + The `frontend` directory in your template is just a regular directory where you can set up your preferred + development environment. You might want to use build tools like Vite, webpack, or even just plain HTML, CSS, and + JavaScript - it's entirely up to you! + + For example, if you're using Vite, you could navigate to the `frontend` directory and run: + + ```bash + npm create vite@latest . + ``` + + Then follow the prompts to set up your project exactly how you want it. The key thing to remember is that this is just a regular frontend project - you can use any tools, frameworks, or libraries you're familiar with. + + + For this example, we'll use [Vite](https://vitejs.dev/) to set up a React frontend project: + + ```bash + npm create vite@latest frontend -- --template react + cd frontend + npm install + ``` + + + + + +Now you have the frontend files in place, update `common/Taskfile.yml` with the appropriate commands: + ```yaml + tasks: + install:frontend:deps: + summary: Install frontend dependencies + dir: frontend + sources: + - package.json + - package-lock.json + generates: + - node_modules/* + preconditions: + - sh: npm version + msg: "Looks like npm isn't installed. Npm is part of the Node installer: https://nodejs.org/en/download/" + cmds: + - npm install + + build:frontend: + summary: Build the frontend project + dir: frontend + sources: + - "**/*" + generates: + - dist/* + deps: + - task: install:frontend:deps + - task: generate:bindings + cmds: + - npm run build -q + ``` + + :::note + For this example, the default Tasks do not need updating as they use the standard `npm install` and `npm run build` commands. + ::: + +### 5. Configure the Go Application + +The default files in the template directory are sufficient to get users started. However, you may want to provide some additional functionality to demonstrate your template's capabilities. The best way to do this is to rename `main.go.tmpl` to `main.go` and edit it like any other Go file. Once finished, ensure you rename it back to `main.go.tmpl` before committing your changes. If you do not care about having a templated `main.go` file (the default template injests the project name into the `Name` field of the application), you can skip this step. + +#### Template Variables + +Wails uses Go's templating engine to process files with the `.tmpl` extension. During template generation, several variables are available for use in your template files: + +| Variable | Description | Example | +|----------------------|----------------------------------|-----------------------------------| +| `Name` | The name of the project | `"MyApp"` | +| `BinaryName` | The name of the generated binary | `"myapp"` | +| `ProductName` | The product name | `"My Application"` | +| `ProductDescription` | Description of the product | `"An awesome application"` | +| `ProductVersion` | Version of the product | `"1.0.0"` | +| `ProductCompany` | Company name | `"My Company Ltd"` | +| `ProductCopyright` | Copyright information | `"Copyright 2024 My Company Ltd"` | +| `ProductComments` | Additional product comments | `"Built with Wails"` | +| `ProductIdentifier` | Unique product identifier | `"com.mycompany.myapp"` | +| `Typescript` | Whether TypeScript is being used | `true` or `false` | +| `WailsVersion` | The version of Wails being used | `"3.0.0"` | + +You can use these variables in your template files using Go's template syntax: + +```go +// main.go.tmpl +package main + +import ( + "github.com/wailsapp/wails/v3/pkg/application" +) + +func main() { + app := application.New(application.Options{ + Name: "{{.ProductName}}", + Description: "{{.ProductDescription}}", + }) + // ... +} +``` + + :::tip + Templating can be applied to any file in your template, even html files, so long as the filename has `.tmpl` in its name. + ::: + +### 6. Testing Your Template + +To test your template: + +1. Generate a project using your template: `wails3 init -n testproject -t path/to/your/template` +2. Run `wails3 build` to generate the production build and make sure the binary in `bin` runs correctly +3. Run `wails3 dev` to start the development server. +4. Test that changes to the frontend code are reflected in the application. +5. Test that changes to the Go code rebuild and relaunch the application + +### 7. Sharing Your Template + +Once your template is ready, you can share it with the community by hosting it on GitHub. Here's how: + +1. Create a new GitHub repository for your template +2. Push your template code to the repository +3. Tag your releases using semantic versioning (e.g., v1.0.0) + +Users can then use your template directly from GitHub using the HTTPS URL: + +```bash +wails3 init -n myapp -t https://github.com/yourusername/your-template +``` + +You can also specify a particular version using the URL format: + +```bash +# Use a specific version tag +wails3 init -n myapp -t https://github.com/yourusername/your-template/releases/tag/v1.0.0 + +# Use a specific branch +wails3 init -n myapp -t https://github.com/yourusername/your-template/tree/main +``` + +To test your template before sharing: + +1. Push your changes to GitHub +2. Create a new test project using the HTTPS URL: + ```bash + wails3 init -n testapp -t https://github.com/yourusername/your-template + ``` +3. Verify that all files are correctly generated +4. Test the build and development workflow as described in the testing section + + :::note + Make sure your repository is public if you want others to use your template. + ::: + +For more information, visit the [Wails documentation](https://wails.io) + + +## Best Practices + +Let's talk about some key practices that will help make your template more useful and maintainable. Here are the main areas to focus on: + +1. **Make Your Template Easy to Understand** + - Write a clear, helpful README.md that gets users started quickly + - Add comments in your config files to explain the "why" behind your choices + - Show examples of common customisations - users love to see real-world use cases! + +2. **Keep Dependencies Happy** + - Stay on top of your frontend package updates + - Lock down specific versions in package.json to avoid surprises + - Let users know upfront what they'll need to have installed + +3. **Love Your Template** + - Keep it fresh with regular updates + - Give it a thorough test drive before sharing + - Share it with the Wails community - we'd love to see what you create! diff --git a/docs/src/content/docs/guides/custom-transport.mdx b/docs/src/content/docs/guides/custom-transport.mdx new file mode 100644 index 000000000..ef72302a4 --- /dev/null +++ b/docs/src/content/docs/guides/custom-transport.mdx @@ -0,0 +1,172 @@ +--- +title: Creating Custom Transport Layer +description: Learn how to create and customize your own Wails v3 custom IPC transport layer +sidebar: + order: 51 +--- + +Wails v3 allows you to provide a custom IPC transport layer while retaining all generated bindings and event communication. This enables you to replace the default HTTP fetch-based transport with WebSockets, custom protocols, or any other transport mechanism. + +## Overview + +By default, Wails uses HTTP fetch requests from the frontend to communicate with the backend via `/wails/runtime`. The custom transport API allows you to: + +- Replace the HTTP transport with WebSockets, gRPC, or any custom protocol +- Maintain full compatibility with Wails code generation +- Keep all existing bindings, events, dialogs, and other Wails features +- Implement your own connection management, authentication, and error handling + +## Architecture + +```text +┌─────────────────────────────────────────────────┐ +│ Frontend (TypeScript) │ +│ - Generated bindings still work │ +│ - Your custom client transport │ +└──────────────────┬──────────────────────────────┘ + │ + │ Your Protocol (WebSocket/etc) + │ +┌──────────────────▼──────────────────────────────┐ +│ Backend (Go) │ +│ - Your Transport implementation │ +│ - Wails MessageProcessor │ +│ - All existing Wails infrastructure │ +└─────────────────────────────────────────────────┘ +``` + +## Usage + +### 1. Implement the Transport Interface + +Create a custom transport by implementing the `Transport` interface: + +```go +package main + +import ( + "context" + "github.com/wailsapp/wails/v3/pkg/application" +) + +type MyCustomTransport struct { + // Your fields +} + +func (t *MyCustomTransport) Start(ctx context.Context, processor *application.MessageProcessor) error { + // Initialize your transport (WebSocket server, gRPC server, etc.) + // When you receive requests, call processor.HandleRuntimeCallWithIDs() + return nil +} + +func (t *MyCustomTransport) Stop() error { + // Clean up your transport + return nil +} +``` + +### 2. Configure Your Application + +Pass your custom transport to the application options: + +```go +func main() { + app := application.New(application.Options{ + Name: "My App", + Transport: &MyCustomTransport{}, + // ... other options + }) + + err := app.Run() + if err != nil { + log.Fatal(err) + } +} +``` + +### 3. Modify Frontend Runtime + +If using a custom transport, you'll need to modify the frontend runtime to use your transport instead of HTTP fetch. Implement `RuntimeTransport` interface that will be used to handle requests: + +```typescript +const { setTransport } = await import('/wails/runtime.js'); + +class MyRuntimeTransport { + call(objectID: number, method: number, windowName: string, args: any): Promise { + // TODO: implement IPC call with your transport protocol + + return resp; + } +} + +const myTransport = new MyRuntimeTransport(); +setTransport(myTransport); +``` + +## Notes + +- The default HTTP transport continues to work if no custom transport is specified +- Generated bindings remain unchanged - only the transport layer changes +- Events, dialogs, clipboard, and all other Wails features work transparently +- You're responsible for error handling, reconnection logic, and security in your custom transport +- The WebSocket example provided is for demonstration and may need hardening for production use + +## API Reference + +### Transport Interface + +```go +type Transport interface { + Start(ctx context.Context, messageProcessor *application.MessageProcessor) error + Stop() error +} +``` + +### AssetServerTransport Interface (Optional) + +For browser-based deployments or when you want to serve both assets and IPC through your custom transport, implement the `AssetServerTransport` interface: + +```go +type AssetServerTransport interface { + Transport + + // ServeAssets configures the transport to serve assets alongside IPC. + // The assetHandler is Wails' internal asset server that handles all assets, + // runtime.js, capabilities, flags, etc. + ServeAssets(assetHandler http.Handler) error +} +``` + +**When to implement this interface:** +- Running the app in a browser instead of a webview +- Serving assets over HTTP alongside your custom IPC transport +- Building network-accessible applications + +**Example implementation:** + +```go +func (t *MyTransport) ServeAssets(assetHandler http.Handler) error { + mux := http.NewServeMux() + + // Mount your IPC endpoint + mux.HandleFunc("/my/ipc/endpoint", t.handleIPC) + + // Mount Wails asset server for everything else + mux.Handle("/", assetHandler) + + // Start HTTP server + t.httpServer.Handler = mux + go t.httpServer.ListenAndServe() + + return nil +} +``` + +When `ServeAssets()` is called, the assetHandler provides: +- All static assets (HTML, CSS, JS, images, etc.) +- `/wails/runtime.js` - The Wails runtime library + +## See Also + +- `transport.go` - Core transport interfaces and types +- `messageprocessor.go` - The underlying message processor that handles all Wails IPC diff --git a/docs/src/content/docs/guides/customising-windows.mdx b/docs/src/content/docs/guides/customising-windows.mdx new file mode 100644 index 000000000..915439a28 --- /dev/null +++ b/docs/src/content/docs/guides/customising-windows.mdx @@ -0,0 +1,129 @@ +--- +title: Customising Windows in Wails +sidebar: + order: 10 +--- + +import {Badge} from '@astrojs/starlight/components'; + +Relevant Platforms: +
      + +Wails provides an API to control the appearance and functionality of the +controls of a window. This functionality is available on Windows and macOS, but +not on Linux. + +## Setting the Window Button States + +The button states are defined by the `ButtonState` enum: + +```go +type ButtonState int + +const ( + ButtonEnabled ButtonState = 0 + ButtonDisabled ButtonState = 1 + ButtonHidden ButtonState = 2 +) +``` + +- `ButtonEnabled`: The button is enabled and visible. +- `ButtonDisabled`: The button is visible but disabled (grayed out). +- `ButtonHidden`: The button is hidden from the titlebar. + +The button states can be set during window creation or at runtime. + +### Setting Button States During Window Creation + +When creating a new window, you can set the initial state of the buttons using +the `WebviewWindowOptions` struct: + +```go title="main.go" +package main + +import ( + "github.com/wailsapp/wails/v3/pkg/application" +) + +func main() { + app := application.New(application.Options{ + Name: "My Application", + }) + + app.Window.NewWithOptions(application.WebviewWindowOptions{ + MinimiseButtonState: application.ButtonHidden, + MaximiseButtonState: application.ButtonDisabled, + CloseButtonState: application.ButtonEnabled, + }) + + app.Run() +} +``` + +In the example above, the minimise button is hidden, the maximise button is +inactive (grayed out), and the close button is active. + +### Setting Button States at Runtime + +You can also change the button states at runtime using the following methods on +the `Window` interface: + +```go +window.SetMinimiseButtonState(wails.ButtonHidden) +window.SetMaximiseButtonState(wails.ButtonEnabled) +window.SetCloseButtonState(wails.ButtonDisabled) +``` + +### Platform Differences + +The button state functionality behaves slightly differently on Windows and +macOS: + +| | Windows | Mac | +|-----------------------|------------------------|------------------------| +| Disable Min/Max/Close | Disables Min/Max/Close | Disables Min/Max/Close | +| Hide Min | Disables Min | Hides Min button | +| Hide Max | Disables Max | Hides Max button | +| Hide Close | Hides all controls | Hides Close | + +Note: On Windows, it is not possible to hide the Min/Max buttons individually. +However, disabling both will hide both of the controls and only show the close +button. + +### Controlling Window Style (Windows) + +To control the style of the titlebar on Windows, you can use the `ExStyle` field +in the `WebviewWindowOptions` struct: + +Example: + +```go title="main.go" +package main + +import ( + "github.com/wailsapp/wails/v3/pkg/application" + "github.com/wailsapp/wails/v3/pkg/w32" +) + +func main() { + app := application.New(application.Options{ + Name: "My Application", + }) + + app.Window.NewWithOptions(application.WebviewWindowOptions{ + Windows: application.WindowsWindow{ + ExStyle: w32.WS_EX_TOOLWINDOW | w32.WS_EX_NOREDIRECTIONBITMAP | w32.WS_EX_TOPMOST, + }, + }) + + app.Run() +} +``` + +Other options that affect the Extended Style of a window will be overridden by +this setting: + +- HiddenOnTaskbar +- AlwaysOnTop +- IgnoreMouseEvents +- BackgroundType diff --git a/docs/src/content/docs/guides/distribution/auto-updates.mdx b/docs/src/content/docs/guides/distribution/auto-updates.mdx new file mode 100644 index 000000000..273915653 --- /dev/null +++ b/docs/src/content/docs/guides/distribution/auto-updates.mdx @@ -0,0 +1,564 @@ +--- +title: Auto-Updates +description: Implement automatic application updates with Wails v3 +sidebar: + order: 5 +--- + +import { Tabs, TabItem } from '@astrojs/starlight/components'; +import { Steps } from '@astrojs/starlight/components'; +import { Card, CardGrid } from '@astrojs/starlight/components'; +import { Aside } from '@astrojs/starlight/components'; + +# Automatic Updates + +Wails v3 provides a built-in updater system that supports automatic update checking, downloading, and installation. The updater includes support for binary delta updates (patches) for minimal download sizes. + + + + Configure periodic update checks in the background + + + Download only what changed with bsdiff patches + + + Works on macOS, Windows, and Linux + + + SHA256 checksums and optional signature verification + + + +## Quick Start + +Add the updater service to your application: + +```go title="main.go" +package main + +import ( + "github.com/wailsapp/wails/v3/pkg/application" + "time" +) + +func main() { + // Create the updater service + updater, err := application.CreateUpdaterService( + "1.0.0", // Current version + application.WithUpdateURL("https://updates.example.com/myapp/"), + application.WithCheckInterval(24 * time.Hour), + ) + if err != nil { + panic(err) + } + + app := application.New(application.Options{ + Name: "MyApp", + Services: []application.Service{ + application.NewService(updater), + }, + }) + + // ... rest of your app + app.Run() +} +``` + +Then use it from your frontend: + +```typescript title="App.tsx" +import { updater } from './bindings/myapp'; + +async function checkForUpdates() { + const update = await updater.CheckForUpdate(); + + if (update) { + console.log(`New version available: ${update.version}`); + console.log(`Release notes: ${update.releaseNotes}`); + + // Download and install + await updater.DownloadAndApply(); + } +} +``` + +## Configuration Options + +The updater supports various configuration options: + +```go +updater, err := application.CreateUpdaterService( + "1.0.0", + // Required: URL where update manifests are hosted + application.WithUpdateURL("https://updates.example.com/myapp/"), + + // Optional: Check for updates automatically every 24 hours + application.WithCheckInterval(24 * time.Hour), + + // Optional: Allow pre-release versions + application.WithAllowPrerelease(true), + + // Optional: Update channel (stable, beta, canary) + application.WithChannel("stable"), + + // Optional: Require signed updates + application.WithRequireSignature(true), + application.WithPublicKey("your-ed25519-public-key"), +) +``` + +## Update Manifest Format + +Host an `update.json` file on your server: + +```json title="update.json" +{ + "version": "1.2.0", + "release_date": "2025-01-15T00:00:00Z", + "release_notes": "## What's New\n\n- Feature A\n- Bug fix B", + "platforms": { + "macos-arm64": { + "url": "https://updates.example.com/myapp/myapp-1.2.0-macos-arm64.tar.gz", + "size": 12582912, + "checksum": "sha256:abc123...", + "patches": [ + { + "from": "1.1.0", + "url": "https://updates.example.com/myapp/patches/1.1.0-to-1.2.0-macos-arm64.patch", + "size": 14336, + "checksum": "sha256:def456..." + } + ] + }, + "macos-amd64": { + "url": "https://updates.example.com/myapp/myapp-1.2.0-macos-amd64.tar.gz", + "size": 13107200, + "checksum": "sha256:789xyz..." + }, + "windows-amd64": { + "url": "https://updates.example.com/myapp/myapp-1.2.0-windows-amd64.zip", + "size": 14680064, + "checksum": "sha256:ghi789..." + }, + "linux-amd64": { + "url": "https://updates.example.com/myapp/myapp-1.2.0-linux-amd64.tar.gz", + "size": 11534336, + "checksum": "sha256:jkl012..." + } + }, + "minimum_version": "1.0.0", + "mandatory": false +} +``` + +### Platform Keys + +| Platform | Key | +|----------|-----| +| macOS (Apple Silicon) | `macos-arm64` | +| macOS (Intel) | `macos-amd64` | +| Windows (64-bit) | `windows-amd64` | +| Linux (64-bit) | `linux-amd64` | +| Linux (ARM64) | `linux-arm64` | + +## Frontend API + +The updater exposes methods that are automatically bound to your frontend: + +### TypeScript Types + +```typescript +interface UpdateInfo { + version: string; + releaseDate: Date; + releaseNotes: string; + size: number; + patchSize?: number; + mandatory: boolean; + hasPatch: boolean; +} + +interface Updater { + // Get the current application version + GetCurrentVersion(): string; + + // Check if an update is available + CheckForUpdate(): Promise; + + // Download the update (emits progress events) + DownloadUpdate(): Promise; + + // Apply the downloaded update (restarts app) + ApplyUpdate(): Promise; + + // Download and apply in one call + DownloadAndApply(): Promise; + + // Get current state: idle, checking, available, downloading, ready, installing, error + GetState(): string; + + // Get the available update info + GetUpdateInfo(): UpdateInfo | null; + + // Get the last error message + GetLastError(): string; + + // Reset the updater state + Reset(): void; +} +``` + +### Progress Events + +Listen for download progress events: + +```typescript +import { Events } from '@wailsio/runtime'; + +Events.On('updater:progress', (data) => { + console.log(`Downloaded: ${data.downloaded} / ${data.total}`); + console.log(`Progress: ${data.percentage.toFixed(1)}%`); + console.log(`Speed: ${(data.bytesPerSecond / 1024 / 1024).toFixed(2)} MB/s`); +}); +``` + +## Complete Example + +Here's a complete example with a React component: + +```tsx title="UpdateChecker.tsx" +import { useState, useEffect } from 'react'; +import { updater } from './bindings/myapp'; +import { Events } from '@wailsio/runtime'; + +interface Progress { + downloaded: number; + total: number; + percentage: number; + bytesPerSecond: number; +} + +export function UpdateChecker() { + const [checking, setChecking] = useState(false); + const [updateInfo, setUpdateInfo] = useState(null); + const [downloading, setDownloading] = useState(false); + const [progress, setProgress] = useState(null); + const [error, setError] = useState(null); + + useEffect(() => { + // Listen for progress events + const cleanup = Events.On('updater:progress', (data: Progress) => { + setProgress(data); + }); + + // Check for updates on mount + checkForUpdates(); + + return () => cleanup(); + }, []); + + async function checkForUpdates() { + setChecking(true); + setError(null); + + try { + const info = await updater.CheckForUpdate(); + setUpdateInfo(info); + } catch (err) { + setError(err.message); + } finally { + setChecking(false); + } + } + + async function downloadAndInstall() { + setDownloading(true); + setError(null); + + try { + await updater.DownloadAndApply(); + // App will restart automatically + } catch (err) { + setError(err.message); + setDownloading(false); + } + } + + if (checking) { + return
      Checking for updates...
      ; + } + + if (error) { + return ( +
      +

      Error: {error}

      + +
      + ); + } + + if (!updateInfo) { + return ( +
      +

      You're up to date! (v{updater.GetCurrentVersion()})

      + +
      + ); + } + + if (downloading) { + return ( +
      +

      Downloading update...

      + {progress && ( +
      + +

      {progress.percentage.toFixed(1)}%

      +

      {(progress.bytesPerSecond / 1024 / 1024).toFixed(2)} MB/s

      +
      + )} +
      + ); + } + + return ( +
      +

      Update Available!

      +

      Version {updateInfo.version} is available

      +

      Size: {updateInfo.hasPatch + ? `${(updateInfo.patchSize / 1024).toFixed(0)} KB (patch)` + : `${(updateInfo.size / 1024 / 1024).toFixed(1)} MB`} +

      +
      + + +
      + ); +} +``` + +## Update Strategies + +### Check on Startup + +```go +func (a *App) OnStartup(ctx context.Context) { + // Check for updates after a short delay + go func() { + time.Sleep(5 * time.Second) + info, err := a.updater.CheckForUpdate() + if err == nil && info != nil { + // Emit event to frontend + application.Get().EmitEvent("update-available", info) + } + }() +} +``` + +### Background Checking + +Configure automatic background checks: + +```go +updater, _ := application.CreateUpdaterService( + "1.0.0", + application.WithUpdateURL("https://updates.example.com/myapp/"), + application.WithCheckInterval(6 * time.Hour), // Check every 6 hours +) +``` + +### Manual Check Menu Item + +```go +menu := application.NewMenu() +menu.Add("Check for Updates...").OnClick(func(ctx *application.Context) { + info, err := updater.CheckForUpdate() + if err != nil { + application.InfoDialog().SetMessage("Error checking for updates").Show() + return + } + if info == nil { + application.InfoDialog().SetMessage("You're up to date!").Show() + return + } + // Show update dialog... +}) +``` + +## Delta Updates (Patches) + +Delta updates (patches) allow users to download only the changes between versions, dramatically reducing download sizes. + +### How It Works + +1. When building a new version, generate patches from previous versions +2. Host patches alongside full updates on your server +3. The updater automatically downloads patches when available +4. If patching fails, it falls back to the full download + +### Generating Patches + +Patches are generated using the bsdiff algorithm. You'll need the `bsdiff` tool: + +```bash +# Install bsdiff (macOS) +brew install bsdiff + +# Install bsdiff (Ubuntu/Debian) +sudo apt-get install bsdiff + +# Generate a patch +bsdiff old-binary new-binary patch.bsdiff +``` + +### Patch File Naming + +Organize your patches in your update directory: + +``` +updates/ +├── update.json +├── myapp-1.2.0-macos-arm64.tar.gz +├── myapp-1.2.0-windows-amd64.zip +└── patches/ + ├── 1.0.0-to-1.2.0-macos-arm64.patch + ├── 1.1.0-to-1.2.0-macos-arm64.patch + ├── 1.0.0-to-1.2.0-windows-amd64.patch + └── 1.1.0-to-1.2.0-windows-amd64.patch +``` + + + +## Hosting Updates + +### Static File Hosting + +Updates can be hosted on any static file server: + +- **Amazon S3** / **Cloudflare R2** +- **Google Cloud Storage** +- **GitHub Releases** +- **Any CDN or web server** + +Example S3 bucket structure: + +``` +s3://my-updates-bucket/myapp/ +├── stable/ +│ ├── update.json +│ ├── myapp-1.2.0-macos-arm64.tar.gz +│ └── patches/ +│ └── 1.1.0-to-1.2.0-macos-arm64.patch +└── beta/ + └── update.json +``` + +### CORS Configuration + +If hosting on a different domain, configure CORS: + +```json +{ + "CORSRules": [ + { + "AllowedOrigins": ["*"], + "AllowedMethods": ["GET"], + "AllowedHeaders": ["*"] + } + ] +} +``` + +## Security + +### Checksum Verification + +All downloads are verified against SHA256 checksums in the manifest: + +```json +{ + "checksum": "sha256:e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855" +} +``` + +### Signature Verification + +For additional security, enable signature verification: + + +1. **Generate a key pair**: + ```bash + # Generate Ed25519 key pair + openssl genpkey -algorithm Ed25519 -out private.pem + openssl pkey -in private.pem -pubout -out public.pem + ``` + +2. **Sign your update manifest**: + ```bash + openssl pkeyutl -sign -inkey private.pem -in update.json -out update.json.sig + ``` + +3. **Configure the updater**: + ```go + updater, _ := application.CreateUpdaterService( + "1.0.0", + application.WithUpdateURL("https://updates.example.com/myapp/"), + application.WithRequireSignature(true), + application.WithPublicKey("MCowBQYDK2VwAyEA..."), // Base64-encoded public key + ) + ``` + + +## Best Practices + +### Do + +- Test updates thoroughly before deploying +- Keep previous versions available for rollback +- Show release notes to users +- Allow users to skip non-mandatory updates +- Use HTTPS for all downloads +- Verify checksums before applying updates +- Handle errors gracefully + +### Don't + +- Force immediate restarts without warning +- Skip checksum verification +- Interrupt users during important work +- Delete the previous version immediately +- Ignore update failures + +## Troubleshooting + +### Update Not Found + +- Verify the manifest URL is correct +- Check the platform key matches (e.g., `macos-arm64`) +- Ensure the version in the manifest is newer + +### Download Fails + +- Check network connectivity +- Verify the download URL is accessible +- Check CORS configuration if cross-origin + +### Patch Fails + +- The updater automatically falls back to full download +- Ensure `bspatch` is available on the system +- Verify the patch checksum is correct + +### Application Won't Restart + +- On macOS, ensure the app is properly code-signed +- On Windows, check for file locks +- On Linux, verify file permissions + +## Next Steps + +- [Code Signing](/guides/build/signing) - Sign your updates +- [Creating Installers](/guides/installers) - Package your application +- [CI/CD Integration](/guides/ci-cd) - Automate your release process diff --git a/docs/src/content/docs/guides/distribution/custom-protocols.mdx b/docs/src/content/docs/guides/distribution/custom-protocols.mdx new file mode 100644 index 000000000..39a9b157c --- /dev/null +++ b/docs/src/content/docs/guides/distribution/custom-protocols.mdx @@ -0,0 +1,664 @@ +--- +title: Custom URL Protocols +description: Register custom URL schemes to launch your application from links +sidebar: + order: 3 +--- + +import { Tabs, TabItem, Aside } from '@astrojs/starlight/components'; + +Custom URL protocols (also called URL schemes) allow your application to be launched when users click links with your custom protocol, such as `myapp://action` or `myapp://open/document`. + +## Overview + +Custom protocols enable: +- **Deep linking**: Launch your app with specific data +- **Browser integration**: Handle links from web pages +- **Email links**: Open your app from email clients +- **Inter-app communication**: Launch from other applications + +**Example**: `myapp://open/document?id=123` launches your app and opens document 123. + +## Configuration + +Define custom protocols in your application options: + +```go +package main + +import "github.com/wailsapp/wails/v3/pkg/application" + +func main() { + app := application.New(application.Options{ + Name: "My Application", + Description: "My awesome application", + Protocols: []application.Protocol{ + { + Scheme: "myapp", + Description: "My Application Protocol", + Role: "Editor", // macOS only + }, + }, + }) + + // Register handler for protocol events + app.Event.On(application.Events.ApplicationOpenedWithURL, func(event *application.ApplicationEvent) { + url := event.Context().ClickedURL() + handleCustomURL(url) + }) + + app.Run() +} + +func handleCustomURL(url string) { + // Parse and handle the custom URL + // Example: myapp://open/document?id=123 + println("Received URL:", url) +} +``` + +## Protocol Handler + +Listen for protocol events to handle incoming URLs: + +```go +app.Event.On(application.Events.ApplicationOpenedWithURL, func(event *application.ApplicationEvent) { + url := event.Context().ClickedURL() + + // Parse the URL + parsedURL, err := parseCustomURL(url) + if err != nil { + app.Logger.Error("Failed to parse URL:", err) + return + } + + // Handle different actions + switch parsedURL.Action { + case "open": + openDocument(parsedURL.DocumentID) + case "settings": + showSettings() + case "user": + showUser Profile(parsedURL.UserID) + default: + app.Logger.Warn("Unknown action:", parsedURL.Action) + } +}) +``` + +## URL Structure + +Design clear, hierarchical URL structures: + +``` +myapp://action/resource?param=value + +Examples: +myapp://open/document?id=123 +myapp://settings/theme?mode=dark +myapp://user/profile?username=john +``` + +**Best practices:** +- Use lowercase scheme names +- Keep schemes short and memorable +- Use hierarchical paths for resources +- Include query parameters for optional data +- URL-encode special characters + +## Platform Registration + +Custom protocols are registered differently on each platform. + + + + +### Windows NSIS Installer + +**Wails v3 automatically registers custom protocols** when using NSIS installers. + +#### Automatic Registration + +When you build your application with `wails3 build`, the NSIS installer: +1. Automatically registers all protocols defined in `application.Options.Protocols` +2. Associates protocols with your application executable +3. Sets up proper registry entries +4. Removes protocol associations during uninstall + +**No additional configuration required!** + +#### How It Works + +The NSIS template includes built-in macros: +- `wails.associateCustomProtocols` - Registers protocols during installation +- `wails.unassociateCustomProtocols` - Removes protocols during uninstall + +These macros are automatically called based on your `Protocols` configuration. + +#### Manual Registry (Advanced) + +If you need manual registration (outside NSIS): + +```batch +@echo off +REM Register custom protocol +REG ADD "HKEY_CURRENT_USER\SOFTWARE\Classes\myapp" /ve /d "URL:My Application Protocol" /f +REG ADD "HKEY_CURRENT_USER\SOFTWARE\Classes\myapp" /v "URL Protocol" /t REG_SZ /d "" /f +REG ADD "HKEY_CURRENT_USER\SOFTWARE\Classes\myapp\shell\open\command" /ve /d "\"%1\"" /f +``` + +#### Testing + +Test your protocol registration: + +```powershell +# Open protocol URL from PowerShell +Start-Process "myapp://test/action" + +# Or from command prompt +start myapp://test/action +``` + +### Windows MSIX Package + +Custom protocols are also automatically registered when using MSIX packaging. + +#### Automatic Registration + +When you build your application with MSIX, the manifest automatically includes protocol registrations from your `build/config.yml` protocols configuration. + +The generated manifest includes: + +```xml + + + My Application Protocol + + +``` + +#### Universal Links (Web-to-App Linking) + +Windows supports **Web-to-App linking**, which works similarly to Universal Links on macOS. When deploying your application as an MSIX package, you can enable HTTPS links to launch your app directly. + + + +To enable Web-to-App linking, follow the [Microsoft guide on web-to-app linking](https://learn.microsoft.com/en-us/windows/apps/develop/launch/web-to-app-linking). You'll need to: + +1. **Manually add App URI Handler to your MSIX manifest** (`build/windows/msix/app_manifest.xml`): + ```xml + + + + + + ``` + +2. **Configure `windows-app-web-link` on your website:** Host a `windows-app-web-link` file at `https://myawesomeapp.com/.well-known/windows-app-web-link`. This file should contain your app's package information and the paths it handles. + +When a Web-to-App link launches your application, you'll receive the same `ApplicationOpenedWithURL` event as with custom protocol schemes. + + + + + +### Info.plist Configuration + +On macOS, protocols are registered via your `Info.plist` file. + +#### Automatic Configuration + +Wails automatically generates the `Info.plist` with your protocols when you build with `wails3 build`. + +The protocols from `application.Options.Protocols` are added to: + +```xml +CFBundleURLTypes + + + CFBundleURLName + My Application Protocol + CFBundleURLSchemes + + myapp + + CFBundleTypeRole + Editor + + +``` + +#### Testing + +```bash +# Open protocol URL from terminal +open "myapp://test/action" + +# Check registered handlers +/System/Library/Frameworks/CoreServices.framework/Versions/A/Frameworks/LaunchServices.framework/Versions/A/Support/lsregister -dump | grep myapp +``` + +#### Universal Links + +In addition to custom protocol schemes, macOS also supports **Universal Links**, which allow your app to be launched by regular HTTPS links (e.g., `https://myawesomeapp.com/path`). Universal Links provide a seamless user experience between your web and desktop app. + + + +To enable Universal Links, follow the [Apple guide on supporting Universal Links in your app](https://developer.apple.com/documentation/xcode/supporting-universal-links-in-your-app). You'll need to: + +1. **Add entitlements** in your `entitlements.plist`: + ```xml + com.apple.developer.associated-domains + + applinks:myawesomeapp.com + + ``` + +2. **Add NSUserActivityTypes to Info.plist**: + ```xml + NSUserActivityTypes + + NSUserActivityTypeBrowsingWeb + + ``` + +3. **Configure `apple-app-site-association` on your website:** Host an `apple-app-site-association` file at `https://myawesomeapp.com/.well-known/apple-app-site-association`. + +When a Universal Link triggers your app, you'll receive the same `ApplicationOpenedWithURL` event, making the handling code identical to custom protocol schemes. + + + + + +### Desktop Entry + +On Linux, protocols are registered via `.desktop` files. + +#### Automatic Configuration + +Wails generates a desktop entry file with protocol handlers when you build with `wails3 build`. + +**Fixed in v3**: Linux desktop template now properly includes protocol handling. + +The generated desktop file includes: + +```ini +[Desktop Entry] +Type=Application +Name=My Application +Exec=/usr/bin/myapp %u +MimeType=x-scheme-handler/myapp; +``` + +#### Manual Registration + +If needed, manually install the desktop file: + +```bash +# Copy desktop file +cp myapp.desktop ~/.local/share/applications/ + +# Update desktop database +update-desktop-database ~/.local/share/applications/ + +# Register protocol handler +xdg-mime default myapp.desktop x-scheme-handler/myapp +``` + +#### Testing + +```bash +# Open protocol URL +xdg-open "myapp://test/action" + +# Check registered handler +xdg-mime query default x-scheme-handler/myapp +``` + + + + +## Complete Example + +Here's a complete example handling multiple protocol actions: + +```go +package main + +import ( + "fmt" + "net/url" + "strings" + "github.com/wailsapp/wails/v3/pkg/application" +) + +type App struct { + app *application.Application + window *application.WebviewWindow +} + +func main() { + app := application.New(application.Options{ + Name: "DeepLink Demo", + Description: "Custom protocol demonstration", + Protocols: []application.Protocol{ + { + Scheme: "deeplink", + Description: "DeepLink Demo Protocol", + Role: "Editor", + }, + }, + }) + + myApp := &App{app: app} + myApp.setup() + + app.Run() +} + +func (a *App) setup() { + // Create window + a.window = a.app.Window.NewWithOptions(application.WebviewWindowOptions{ + Title: "DeepLink Demo", + Width: 800, + Height: 600, + URL: "http://wails.localhost/", + }) + + // Handle custom protocol URLs + a.app.Event.On(application.Events.ApplicationOpenedWithURL, func(event *application.ApplicationEvent) { + customURL := event.Context().ClickedURL() + a.handleDeepLink(customURL) + }) +} + +func (a *App) handleDeepLink(rawURL string) { + // Parse URL + parsedURL, err := url.Parse(rawURL) + if err != nil { + a.app.Logger.Error("Failed to parse URL:", err) + return + } + + // Bring window to front + a.window.Show() + a.window.SetFocus() + + // Extract path and query + path := strings.Trim(parsedURL.Path, "/") + query := parsedURL.Query() + + // Handle different actions + parts := strings.Split(path, "/") + if len(parts) == 0 { + return + } + + action := parts[0] + + switch action { + case "open": + if len(parts) >= 2 { + resource := parts[1] + id := query.Get("id") + a.openResource(resource, id) + } + + case "settings": + section := "" + if len(parts) >= 2 { + section = parts[1] + } + a.openSettings(section) + + case "user": + if len(parts) >= 2 { + username := parts[1] + a.openUserProfile(username) + } + + default: + a.app.Logger.Warn("Unknown action:", action) + } +} + +func (a *App) openResource(resourceType, id string) { + fmt.Printf("Opening %s with ID: %s\n", resourceType, id) + // Emit event to frontend + a.app.Event.Emit("navigate", map[string]string{ + "type": resourceType, + "id": id, + }) +} + +func (a *App) openSettings(section string) { + fmt.Printf("Opening settings section: %s\n", section) + a.app.Event.Emit("navigate", map[string]string{ + "page": "settings", + "section": section, + }) +} + +func (a *App) openUserProfile(username string) { + fmt.Printf("Opening user profile: %s\n", username) + a.app.Event.Emit("navigate", map[string]string{ + "page": "user", + "user": username, + }) +} +``` + +## Frontend Integration + +Handle navigation events in your frontend: + +```javascript +import { Events } from '@wailsio/runtime' + +// Listen for navigation events from protocol handler +Events.On('navigate', (event) => { + const { type, id, page, section, user } = event.data + + if (type === 'document') { + // Open document with ID + router.push(`/document/${id}`) + } else if (page === 'settings') { + // Open settings + router.push(`/settings/${section}`) + } else if (page === 'user') { + // Open user profile + router.push(`/user/${user}`) + } +}) +``` + +## Security Considerations + +### Validate All Input + +Always validate and sanitize URLs from external sources: + +```go +func (a *App) handleDeepLink(rawURL string) { + // Parse URL + parsedURL, err := url.Parse(rawURL) + if err != nil { + a.app.Logger.Error("Invalid URL:", err) + return + } + + // Validate scheme + if parsedURL.Scheme != "myapp" { + a.app.Logger.Warn("Invalid scheme:", parsedURL.Scheme) + return + } + + // Validate path + path := strings.Trim(parsedURL.Path, "/") + if !isValidPath(path) { + a.app.Logger.Warn("Invalid path:", path) + return + } + + // Sanitize parameters + params := sanitizeQueryParams(parsedURL.Query()) + + // Process validated URL + a.processDeepLink(path, params) +} + +func isValidPath(path string) bool { + // Only allow alphanumeric and forward slashes + validPath := regexp.MustCompile(`^[a-zA-Z0-9/]+$`) + return validPath.MatchString(path) +} + +func sanitizeQueryParams(query url.Values) map[string]string { + sanitized := make(map[string]string) + for key, values := range query { + if len(values) > 0 { + // Take first value and sanitize + sanitized[key] = sanitizeString(values[0]) + } + } + return sanitized +} +``` + +### Prevent Injection Attacks + +Never execute URLs directly as code or SQL: + +```go +// ❌ DON'T: Execute URL content +func badHandler(url string) { + exec.Command("sh", "-c", url).Run() // DANGEROUS! +} + +// ✅ DO: Parse and validate +func goodHandler(url string) { + parsed, _ := url.Parse(url) + action := parsed.Query().Get("action") + + // Whitelist allowed actions + allowed := map[string]bool{ + "open": true, + "settings": true, + "help": true, + } + + if allowed[action] { + handleAction(action) + } +} +``` + +## Testing + +### Manual Testing + +Test protocol handlers during development: + +**Windows:** +```powershell +Start-Process "myapp://test/action?id=123" +``` + +**macOS:** +```bash +open "myapp://test/action?id=123" +``` + +**Linux:** +```bash +xdg-open "myapp://test/action?id=123" +``` + +### HTML Testing + +Create a test HTML page: + +```html + + + + Protocol Test + + +

      Custom Protocol Test Links

      + +
      + + +``` + +## Troubleshooting + +### Protocol Not Registered + +**Windows:** +- Check registry: `HKEY_CURRENT_USER\SOFTWARE\Classes\` +- Reinstall with NSIS installer +- Verify installer ran with proper permissions + +**macOS:** +- Rebuild application with `wails3 build` +- Check `Info.plist` in app bundle: `MyApp.app/Contents/Info.plist` +- Reset Launch Services: `/System/Library/Frameworks/CoreServices.framework/Frameworks/LaunchServices.framework/Support/lsregister -kill` + +**Linux:** +- Check desktop file: `~/.local/share/applications/myapp.desktop` +- Update database: `update-desktop-database ~/.local/share/applications/` +- Verify handler: `xdg-mime query default x-scheme-handler/myapp` + +### Application Not Launching + +**Check logs:** +```go +app := application.New(application.Options{ + Logger: application.NewLogger(application.LogLevelDebug), + // ... +}) +``` + +**Common issues:** +- Application not installed in expected location +- Executable path in registration doesn't match actual location +- Permissions issues + +## Best Practices + +### ✅ Do + +- **Use descriptive scheme names** - `mycompany-myapp` instead of `mca` +- **Validate all input** - Never trust URLs from external sources +- **Handle errors gracefully** - Log invalid URLs, don't crash +- **Provide user feedback** - Show what action was triggered +- **Test on all platforms** - Protocol handling varies +- **Document your URL structure** - Help users and integrators + +### ❌ Don't + +- **Don't use common scheme names** - Avoid `http`, `file`, `app`, etc. +- **Don't execute URLs as code** - Huge security risk +- **Don't expose sensitive operations** - Require confirmation for destructive actions +- **Don't assume protocols work everywhere** - Have fallback mechanisms +- **Don't forget URL encoding** - Handle special characters properly + +## Next Steps + +- [Windows Packaging](/guides/build/windows) - Learn about NSIS installer options +- [File Associations](/guides/distribution/file-associations) - Open files with your app +- [Single Instance](/guides/distribution/single-instance) - Prevent multiple app instances + +--- + +**Questions?** Ask in [Discord](https://discord.gg/JDdSxwjhGf) or check the [examples](https://github.com/wailsapp/wails/tree/v3-alpha/v3/examples). diff --git a/docs/src/content/docs/guides/e2e-testing.mdx b/docs/src/content/docs/guides/e2e-testing.mdx new file mode 100644 index 000000000..f461afa2e --- /dev/null +++ b/docs/src/content/docs/guides/e2e-testing.mdx @@ -0,0 +1,173 @@ +--- +title: End-to-End Testing +description: Test complete user workflows +sidebar: + order: 6 +--- + +## Overview + +End-to-end testing validates complete user workflows in your application. + +## Using Playwright + +### Setup + +```bash +# Install Playwright +npm install -D @playwright/test + +# Initialize +npx playwright install +``` + +### Configuration + +```javascript +// playwright.config.js +import { defineConfig } from '@playwright/test' + +export default defineConfig({ + testDir: './e2e', + use: { + baseURL: 'http://localhost:34115', // Wails dev server + }, +}) +``` + +### Writing Tests + +```javascript +// e2e/app.spec.js +import { test, expect } from '@playwright/test' + +test('create note', async ({ page }) => { + await page.goto('/') + + // Click new note button + await page.click('#new-note-btn') + + // Fill in title + await page.fill('#note-title', 'Test Note') + + // Fill in content + await page.fill('#note-content', 'Test content') + + // Verify note appears in list + await expect(page.locator('.note-item')).toContainText('Test Note') +}) + +test('delete note', async ({ page }) => { + await page.goto('/') + + // Create a note first + await page.click('#new-note-btn') + await page.fill('#note-title', 'To Delete') + + // Delete it + await page.click('#delete-btn') + + // Confirm dialog + page.on('dialog', dialog => dialog.accept()) + + // Verify it's gone + await expect(page.locator('.note-item')).not.toContainText('To Delete') +}) +``` + +## Testing dialogs + +```javascript +test('file save dialog', async ({ page }) => { + await page.goto('/') + + // Intercept file dialog + page.on('filechooser', async (fileChooser) => { + await fileChooser.setFiles('/path/to/test/file.json') + }) + + // Trigger save + await page.click('#save-btn') + + // Verify success message + await expect(page.locator('.success-message')).toBeVisible() +}) +``` + +## Testing Window Behaviour + +```javascript +test('window state', async ({ page }) => { + await page.goto('/') + + // Test window title + await expect(page).toHaveTitle('My App') + + // Test window size + const size = await page.viewportSize() + expect(size.width).toBe(800) + expect(size.height).toBe(600) +}) +``` + +## Best Practices + +### ✅ Do + +- Test critical user flows +- Use data-testid attributes +- Clean up test data +- Run tests in CI/CD +- Test error scenarios +- Keep tests independent + +### ❌ Don't + +- Don't test implementation details +- Don't write brittle selectors +- Don't skip cleanup +- Don't ignore flaky tests +- Don't test everything + +## Running E2E Tests + +```bash +# Run all tests +npx playwright test + +# Run in headed mode +npx playwright test --headed + +# Run specific test +npx playwright test e2e/app.spec.js + +# Debug mode +npx playwright test --debug +``` + +## CI/CD Integration + +```yaml +# .github/workflows/e2e.yml +name: E2E Tests + +on: [push] + +jobs: + test: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v3 + - uses: actions/setup-node@v3 + - name: Install dependencies + run: npm ci + - name: Install Playwright + run: npx playwright install --with-deps + - name: Run tests + run: npx playwright test +``` + +## Next Steps + +- [Testing](/guides/testing) - Learn unit testing +- [Building](/guides/building) - Build your application diff --git a/docs/src/content/docs/guides/events-reference.mdx b/docs/src/content/docs/guides/events-reference.mdx new file mode 100644 index 000000000..afa61fc3e --- /dev/null +++ b/docs/src/content/docs/guides/events-reference.mdx @@ -0,0 +1,569 @@ +--- +title: Events Guide +description: A practical guide to using events in Wails v3 for application communication and lifecycle management +--- + +**NOTE: This guide is a work in progress** + +# Events Guide + +Events are the heartbeat of communication in Wails applications. They allow different parts of your application to talk to each other without being tightly coupled. This guide will walk you through everything you need to know about using events effectively in your Wails application. + +## Understanding Wails Events + +Think of events as messages that get broadcast throughout your application. Any part of your application can listen for these messages and react accordingly. This is particularly useful for: + +- **Responding to window changes**: Know when your window is minimized, maximized, or moved +- **Handling system events**: React to theme changes or power events +- **Custom application logic**: Create your own events for features like data updates or user actions +- **Cross-component communication**: Let different parts of your app communicate without direct dependencies + +## Event Naming Convention + +All Wails events follow a namespace pattern to clearly indicate their origin: + +- `common:` - Cross-platform events that work on Windows, macOS, and Linux +- `windows:` - Windows-specific events +- `mac:` - macOS-specific events +- `linux:` - Linux-specific events + +For example: +- `common:WindowFocus` - Window gained focus (works everywhere) +- `windows:APMSuspend` - System is suspending (Windows only) +- `mac:ApplicationDidBecomeActive` - App became active (macOS only) + +## Getting Started with Events + +### Listening to Events (Frontend) + +The most common use case is listening for events in your frontend code: + +```javascript +import { Events } from '@wailsio/runtime'; + +// Listen for when the window gains focus +Events.On('common:WindowFocus', () => { + console.log('Window is now focused!'); + // Maybe refresh some data or resume animations +}); + +// Listen for theme changes +Events.On('common:ThemeChanged', (event) => { + console.log('Theme changed:', event.data); + // Update your app's theme accordingly +}); + +// Listen for custom events from your Go backend +Events.On('my-app:data-updated', (event) => { + console.log('Data updated:', event.data); + // Update your UI with the new data +}); +``` + +### Emitting Events (Backend) + +From your Go code, you can emit events that your frontend can listen to: + +```go +package main + +import ( + "github.com/wailsapp/wails/v3/pkg/application" + "time" +) + +func (s *Service) UpdateData() { + // Do some data processing... + + // Notify the frontend + app := application.Get() + app.Event.Emit("my-app:data-updated", + map[string]interface{}{ + "timestamp": time.Now(), + "count": 42, + }, + ) +} +``` + +### Emitting Events (Frontend) + +While not as commonly used, you can also emit events from your frontend that your Go code can listen to: + +```javascript +import { Events } from '@wailsio/runtime'; + +// Event without data +Events.Emit('myapp:close-window') + +// Event with data +Events.Emit('myapp:disconnect-requested', 'id-123') +``` + +If you are using TypeScript in your frontend and [registering typed events](#typed-events-with-typecheck) in your Go code, you will get event name autocomplete/checking and data type checking. + +### Removing Event Listeners + +Always clean up your event listeners when they're no longer needed: + +```javascript +import { Events } from '@wailsio/runtime'; + +// Store the handler reference +const focusHandler = () => { + console.log('Window focused'); +}; + +// Add the listener +Events.On('common:WindowFocus', focusHandler); + +// Later, remove it when no longer needed +Events.Off('common:WindowFocus', focusHandler); + +// Or remove all listeners for an event +Events.Off('common:WindowFocus'); +``` + +## Common Use Cases + +### 1. Pause/Resume on Window Focus + +Many applications need to pause certain activities when the window loses focus: + +```javascript +import { Events } from '@wailsio/runtime'; + +let animationRunning = true; + +Events.On('common:WindowLostFocus', () => { + animationRunning = false; + pauseBackgroundTasks(); +}); + +Events.On('common:WindowFocus', () => { + animationRunning = true; + resumeBackgroundTasks(); +}); +``` + +### 2. Responding to Theme Changes + +Keep your app in sync with the system theme: + +```javascript +import { Events } from '@wailsio/runtime'; + +Events.On('common:ThemeChanged', (event) => { + const isDarkMode = event.data.isDark; + + if (isDarkMode) { + document.body.classList.add('dark-theme'); + document.body.classList.remove('light-theme'); + } else { + document.body.classList.add('light-theme'); + document.body.classList.remove('dark-theme'); + } +}); +``` + +### 3. Handling File Drops + +Make your app accept dragged files: + +```javascript +import { Events } from '@wailsio/runtime'; + +Events.On('common:WindowFilesDropped', (event) => { + const files = event.data.files; + + files.forEach(file => { + console.log('File dropped:', file); + // Process the dropped files + handleFileUpload(file); + }); +}); +``` + +### 4. Window Lifecycle Management + +Respond to window state changes: + +```javascript +import { Events } from '@wailsio/runtime'; + +Events.On('common:WindowClosing', () => { + // Save user data before closing + saveApplicationState(); + + // You could also prevent closing by returning false + // from a registered window close handler +}); + +Events.On('common:WindowMaximise', () => { + // Adjust UI for maximized view + adjustLayoutForMaximized(); +}); + +Events.On('common:WindowRestore', () => { + // Return UI to normal state + adjustLayoutForNormal(); +}); +``` + +### 5. Platform-Specific Features + +Handle platform-specific events when needed: + +```javascript +import { Events } from '@wailsio/runtime'; + +// Windows-specific power management +Events.On('windows:APMSuspend', () => { + console.log('System is going to sleep'); + saveState(); +}); + +Events.On('windows:APMResumeSuspend', () => { + console.log('System woke up'); + refreshData(); +}); + +// macOS-specific app lifecycle +Events.On('mac:ApplicationWillTerminate', () => { + console.log('App is about to quit'); + performCleanup(); +}); +``` + +## Creating Custom Events + +You can create your own events for application-specific needs. + +### Backend (Go) + +```go +// Emit a custom event when data changes + +func (s *Service) ProcessUserData(userData UserData) error { + // Process the data... + + app := application.Get() + // Notify all listeners + app.Event.Emit("user:data-processed", + map[string]interface{}{ + "userId": userData.ID, + "status": "completed", + "timestamp": time.Now(), + }, + ) + return nil +} + +// Emit periodic updates +func (s *Service) StartMonitoring() { + app := application.Get() + ticker := time.NewTicker(5 * time.Second) + go func() { + for range ticker.C { + stats := s.collectStats() + app.Event.Emit("monitor:stats-updated", stats) + } + }() +} +``` + +### Frontend (JavaScript) + +```javascript +import { Events } from '@wailsio/runtime'; + +// Listen for your custom events +Events.On('user:data-processed', (event) => { + const { userId, status, timestamp } = event.data; + + showNotification(`User ${userId} processing ${status}`); + updateUIWithNewData(); +}); + +Events.On('monitor:stats-updated', (event) => { + updateDashboard(event.data); +}); +``` + +## Typed Events with Type Safety + +Wails v3 supports typed events with full TypeScript type safety through event registration and automatic binding generation. + +### Registering Custom Events + +Call `application.RegisterEvent` at init time to register custom event names with their data types: + +```go +package main + +import "github.com/wailsapp/wails/v3/pkg/application" + +type UserLoginData struct { + UserID string + Username string + LoginTime string +} + +type MonitorStats struct { + CPUUsage float64 + MemoryUsage float64 +} + +func init() { + // Register events with their data types + application.RegisterEvent[UserLoginData]("user:login") + application.RegisterEvent[MonitorStats]("monitor:stats") + + // Register events without data (void events) + application.RegisterEvent[application.Void]("app:ready") +} +``` + +:::caution +`RegisterEvent` is meant to be called at init time and will panic if: +- Arguments are not valid +- The same event name is registered twice with different data types +::: + +:::note +It is safe to register the same event multiple times as long as the data type is always the same. This can be useful to ensure an event is registered when any of multiple packages is loaded. +::: + +### Benefits of Event Registration + +Once registered, data arguments passed to `Event.Emit` are type-checked against the specified type. On mismatch: +- An error is emitted and logged (or passed to the registered error handler) +- The offending event will not be propagated +- This ensures the data field of registered events is always assignable to the declared type + +### Strict Mode + +Use the `strictevents` build tag to enable warnings for unregistered events in development: + +```bash +go build -tags strictevents +``` + +With strict mode enabled, the runtime emits at most one warning per unregistered event name to avoid spamming logs. + +### TypeScript Binding Generation + +The binding generator outputs TypeScript definitions and glue code for transparent typed event support in the frontend. + +#### 1. Set up the Vite Plugin + +In your `vite.config.ts`: + +```typescript +import { defineConfig } from 'vite' +import wails from '@wailsio/runtime/plugins/vite' + +export default defineConfig({ + plugins: [wails()], +}) +``` + +#### 2. Generate Bindings + +Run the binding generator: + +```bash +wails3 generate bindings +``` + +This creates TypeScript files in your frontend directory with typed event creators and data interfaces. + +#### 3. Use Typed Events in Frontend + +```typescript +import { Events } from '@wailsio/runtime' +import { UserLogin, MonitorStats } from './bindings/events' + +// Type-safe event emission with autocomplete +Events.Emit(UserLogin({ + UserID: "123", + Username: "john_doe", + LoginTime: new Date().toISOString() +})) + +// Type-safe event listening +Events.On(UserLogin, (event) => { + // event.data is typed as UserLoginData + console.log(`User ${event.data.Username} logged in`) +}) + +Events.On(MonitorStats, (event) => { + // event.data is typed as MonitorStats + updateDashboard({ + cpu: event.data.CPUUsage, + memory: event.data.MemoryUsage + }) +}) +``` + +The typed events provide: +- **Autocomplete** for event names +- **Type checking** for event data +- **Compile-time errors** for mismatched data types +- **IntelliSense** documentation + +## Event Reference + +### Common Events (Cross-platform) + +These events work on all platforms: + +| Event | Description | When to Use | +|-------|-------------|-------------| +| `common:ApplicationStarted` | Application has fully started | Initialize your app, load saved state | +| `common:WindowRuntimeReady` | Wails runtime is ready | Start making Wails API calls | +| `common:ThemeChanged` | System theme changed | Update app appearance | +| `common:WindowFocus` | Window gained focus | Resume activities, refresh data | +| `common:WindowLostFocus` | Window lost focus | Pause activities, save state | +| `common:WindowMinimise` | Window was minimized | Pause rendering, reduce resource usage | +| `common:WindowMaximise` | Window was maximized | Adjust layout for full screen | +| `common:WindowRestore` | Window restored from min/max | Return to normal layout | +| `common:WindowClosing` | Window is about to close | Save data, cleanup resources | +| `common:WindowFilesDropped` | Files dropped on window | Handle file imports | +| `common:WindowDidResize` | Window was resized | Adjust layout, rerender charts | +| `common:WindowDidMove` | Window was moved | Update position-dependent features | + +### Platform-Specific Events + +#### Windows Events + +Key events for Windows applications: + +| Event | Description | Use Case | +|-------|-------------|----------| +| `windows:SystemThemeChanged` | Windows theme changed | Update app colors | +| `windows:APMSuspend` | System suspending | Save state, pause operations | +| `windows:APMResumeSuspend` | System resumed | Restore state, refresh data | +| `windows:APMPowerStatusChange` | Power status changed | Adjust performance settings | + +#### macOS Events + +Important macOS application events: + +| Event | Description | Use Case | +|-------|-------------|----------| +| `mac:ApplicationDidBecomeActive` | App became active | Resume operations | +| `mac:ApplicationDidResignActive` | App became inactive | Pause operations | +| `mac:ApplicationWillTerminate` | App will quit | Final cleanup | +| `mac:WindowDidEnterFullScreen` | Entered fullscreen | Adjust UI for fullscreen | +| `mac:WindowDidExitFullScreen` | Exited fullscreen | Restore normal UI | + +#### Linux Events + +Core Linux window events: + +| Event | Description | Use Case | +|-------|-------------|----------| +| `linux:SystemThemeChanged` | Desktop theme changed | Update app theme | +| `linux:WindowFocusIn` | Window gained focus | Resume activities | +| `linux:WindowFocusOut` | Window lost focus | Pause activities | +| `linux:WindowLoadStarted` | WebView started loading | Show loading indicator | +| `linux:WindowLoadRedirected` | WebView redirected | Track navigation redirects | +| `linux:WindowLoadCommitted` | WebView committed load | Content is being received | +| `linux:WindowLoadFinished` | WebView finished loading | Hide loading indicator, inject JS/CSS | + +## Best Practices + +### 1. Use Event Namespaces + +When creating custom events, use namespaces to avoid conflicts: + +```javascript +import { Events } from '@wailsio/runtime'; + +// Good - namespaced events +Events.Emit('myapp:user:login'); +Events.Emit('myapp:data:updated'); +Events.Emit('myapp:network:connected'); + +// Avoid - generic names that might conflict +Events.Emit('login'); +Events.Emit('update'); +``` + +### 2. Clean Up Listeners + +Always remove event listeners when components unmount: + +```javascript +import { Events } from '@wailsio/runtime'; + +// React example +useEffect(() => { + const handler = (event) => { + // Handle event + }; + + Events.On('common:WindowResize', handler); + + // Cleanup + return () => { + Events.Off('common:WindowResize', handler); + }; +}, []); +``` + +### 3. Handle Platform Differences + +Check platform availability when using platform-specific events: + +```javascript +import { Platform, Events } from '@wailsio/runtime'; + +if (Platform.isWindows) { + Events.On('windows:APMSuspend', handleSuspend); +} else if (Platform.isMac) { + Events.On('mac:ApplicationWillTerminate', handleTerminate); +} +``` + +### 4. Don't Overuse Events + +While events are powerful, don't use them for everything: + +- ✅ Use events for: System notifications, lifecycle changes, broadcast updates +- ❌ Avoid events for: Direct function returns, single component updates, synchronous operations + +## Debugging Events + +To debug event issues: + +```javascript +import { Events } from '@wailsio/runtime'; + +// Log all events (development only) +if (isDevelopment) { + const originalOn = Events.On; + Events.On = function(eventName, handler) { + console.log(`[Event Registered] ${eventName}`); + return originalOn.call(this, eventName, function(event) { + console.log(`[Event Fired] ${eventName}`, event); + return handler(event); + }); + }; +} +``` + +## Source of Truth + +The complete list of available events can be found in the Wails source code: +- Frontend events: [`v3/internal/runtime/desktop/@wailsio/runtime/src/event_types.ts`](https://github.com/wailsapp/wails/blob/main/v3/internal/runtime/desktop/@wailsio/runtime/src/event_types.ts) +- Backend events: [`v3/pkg/events/events.go`](https://github.com/wailsapp/wails/blob/main/v3/pkg/events/events.go) + +Always refer to these files for the most up-to-date event names and availability. + +## Summary + +Events in Wails provide a powerful, decoupled way to handle communication in your application. By following the patterns and practices in this guide, you can build responsive, platform-aware applications that react smoothly to system changes and user interactions. + +Remember: start with common events for cross-platform compatibility, add platform-specific events when needed, and always clean up your event listeners to prevent memory leaks. \ No newline at end of file diff --git a/docs/src/content/docs/guides/file-associations.mdx b/docs/src/content/docs/guides/file-associations.mdx new file mode 100644 index 000000000..ba37d9f35 --- /dev/null +++ b/docs/src/content/docs/guides/file-associations.mdx @@ -0,0 +1,178 @@ +--- +title: File Associations +sidebar: + order: 20 +--- + +import { Steps } from "@astrojs/starlight/components"; +import {Badge} from '@astrojs/starlight/components'; + +Relevant Platforms: +
      + +File associations allow your application to handle specific file types when +users open them. This is particularly useful for text editors, image viewers, or +any application that works with specific file formats. This guide explains how +to implement file associations in your Wails v3 application. + +## Overview + +File association support in Wails v3 is currently available for: + +- Windows (NSIS installer packages) +- macOS (application bundles) + +## Configuration + +File associations are configured in the `config.yml` file located in your +project's `build` directory. + +### Basic Configuration + +To set up file associations: + +1. Open `build/config.yml` +2. Add your file associations under the `fileAssociations` section +3. Run `wails3 update build-assets` to update the build assets +4. Set the `FileAssociations` field in the application options +5. Package your application using `wails3 package` + +Here's an example configuration: + +```yaml +fileAssociations: + - ext: myapp + name: MyApp Document + description: MyApp Document File + iconName: myappFileIcon + role: Editor + - ext: custom + name: Custom Format + description: Custom File Format + iconName: customFileIcon + role: Editor +``` + +### Configuration Properties + +| Property | Description | Platform | +|-------------|------------------------------------------------------------------|----------| +| ext | File extension without the leading period (e.g., `txt`) | All | +| name | Display name for the file type | All | +| description | Description shown in file properties | Windows | +| iconName | Name of the icon file (without extension) in the build folder | All | +| role | Application's role for this file type (e.g., `Editor`, `Viewer`) | macOS | +| mimeType | MIME type for the file (e.g., `image/jpeg`) | macOS | + +## Listening for File Open Events + +To handle file open events in your application, you can listen for the +`events.Common.ApplicationOpenedWithFile` event: + +```go title="main.go" +package main + +import ( + "github.com/wailsapp/wails/v3/pkg/application" + "github.com/wailsapp/wails/v3/pkg/events" +) + +func main() { + app := application.New(application.Options{ + Name: "MyApp", + FileAssociations: []string{".txt", ".md"}, // Specify supported extensions + }) + + // Listen for files being used to open the application + app.Event.OnApplicationEvent(events.Common.ApplicationOpenedWithFile, func(event *application.ApplicationEvent) { + associatedFile := event.Context().Filename() + application.InfoDialog().SetMessage("Application opened with file: " + associatedFile).Show() + }) + + // Create your window and run the app... +} + +``` + +## Step-by-Step Tutorial + +Let's walk through setting up file associations for a simple text editor: + + + +1. ### Create Icons + + - Create icons for your file type (recommended sizes: 16x16, 32x32, 48x48, + 256x256) + - Save the icons in your project's `build` folder + - Name them according to your `iconName` configuration (e.g., + `textFileIcon.png`) + + :::tip + You can use `wails3 generate icons` to generate the required icons for you. + Run `wails3 generate icons --help` for more information. + ::: + + - For macOS add copy statement like `cp build/darwin/documenticon.icns {{.BIN_DIR}}/{{.APP_NAME}}.app/Contents/Resources` in the `create:app:bundle:` task. + +2. ### Configure File Associations + + Edit the `build/config.yml` file to add your file associations: + + ```yaml + # build/config.yml + fileAssociations: + - ext: txt + name: Text Document + description: Plain Text Document + iconName: textFileIcon + role: Editor + ``` + +3. ### Update Build Assets + + Run the following command to update the build assets: + + ```bash + wails3 update build-assets + ``` + +4. ### Set File Associations in the Application Options + + In your `main.go` file, set the `FileAssociations` field in the application + options: + + ```go + app := application.New(application.Options{ + Name: "MyApp", + FileAssociations: []string{".txt", ".md"}, // Specify supported extensions + }) + ``` + + :::tip[Why are file extensions required in both the application config and config.yml?] + + On Windows, when a file is opened with a file association, the application is + launched with the filename as the first argument to the application. The + application has no way of knowing if the first argument is a file or a command + line argument, so it uses the `FileAssociations` field in the application + options to determine if the first argument is an associated file or not. + + ::: + +5. ### Package Your Application + + Package your application using the following command: + + ```bash + wails3 package + ``` + + The packaged application will be created in the `bin` directory. You can then + install and test the application. + + ## Additional Notes + + - Icons should be provided in PNG format in the build folder + - Testing file associations requires installing the packaged application + + \ No newline at end of file diff --git a/docs/src/content/docs/guides/gin-routing.mdx b/docs/src/content/docs/guides/gin-routing.mdx new file mode 100644 index 000000000..fc3ce289a --- /dev/null +++ b/docs/src/content/docs/guides/gin-routing.mdx @@ -0,0 +1,263 @@ +--- +title: Using Gin for Routing +description: A comprehensive guide to integrating Gin web framework with Wails v3 applications +--- + +This guide demonstrates how to integrate the [Gin web framework](https://github.com/gin-gonic/gin) with Wails v3. Gin is a high-performance HTTP web framework written in Go that makes it easy to build web applications and APIs. + +## Introduction + +Wails v3 provides a flexible asset system that allows you to use any HTTP handler, including popular web frameworks like Gin. This integration enables you to: + +- Serve web content using Gin's routing and middleware +- Create RESTful APIs accessible from your Wails application +- Use Gin's features while maintaining Wails desktop integration + +## Setting Up Gin with Wails + +To integrate Gin with Wails, you need to create a Gin router and configure it as the asset handler in your Wails application. Here's a step-by-step guide: + +### 1. Install Dependencies + +First, ensure you have the Gin package installed: + +```bash +go get -u github.com/gin-gonic/gin +``` + +### 2. Create a Middleware for Gin + +Create a middleware function that will handle the integration between Wails and Gin: + +```go +// GinMiddleware creates a middleware that passes requests to Gin if they're not handled by Wails +func GinMiddleware(ginEngine *gin.Engine) application.Middleware { + return func(next http.Handler) http.Handler { + return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { + // Let Wails handle the `/wails` route + if strings.HasPrefix(r.URL.Path, "/wails") { + next.ServeHTTP(w, r) + return + } + // Let Gin handle everything else + ginEngine.ServeHTTP(w, r) + }) + } +} +``` + +This middleware passes all HTTP requests to the Gin router. + +### 3. Configure Your Gin Router + +Set up your Gin router with routes, middlewares, and handlers: + +```go +// Create a new Gin router +ginEngine := gin.New() // Using New() instead of Default() to add custom middleware + +// Add middlewares +ginEngine.Use(gin.Recovery()) +ginEngine.Use(LoggingMiddleware()) // Your custom middleware + +// Define routes +ginEngine.GET("/", func(c *gin.Context) { + // Serve your main page +}) + +ginEngine.GET("/api/hello", func(c *gin.Context) { + c.JSON(http.StatusOK, gin.H{ + "message": "Hello from Gin API!", + "time": time.Now().Format(time.RFC3339), + }) +}) +``` + +### 4. Integrate with Wails Application + +Configure your Wails application to use the Gin router as its asset handler: + +```go +// Create a new Wails application +app := application.New(application.Options{ + Name: "Gin Example", + Description: "A demo of using Gin with Wails", + Mac: application.MacOptions{ + ApplicationShouldTerminateAfterLastWindowClosed: true, + }, + Assets: application.AssetOptions{ + Handler: ginEngine, + Middleware: GinMiddleware(ginEngine), + }, +}) + +// Create window +app.Window.NewWithOptions(application.WebviewWindowOptions{ + Title: "Wails + Gin Example", + Width: 900, + Height: 700, + URL: "/", // This will load the route handled by Gin +}) +``` + +## Serving Static Content + +Use Go's `embed` package to embed static files into your binary: + +```go +//go:embed static +var staticFiles embed.FS + +ginEngine.StaticFS("/static", http.FS(staticFiles)) +ginEngine.GET("/", func(c *gin.Context) { + file, _ := staticFiles.ReadFile("static/index.html") + c.Data(http.StatusOK, "text/html; charset=utf-8", file) +}) +``` + +For development, serve files directly from disk using `ginEngine.Static("/static", "./static")`. + +## Custom Middleware + +Gin allows you to create custom middleware for various purposes. Here's an example of a logging middleware: + +```go +// LoggingMiddleware is a Gin middleware that logs request details +func LoggingMiddleware() gin.HandlerFunc { + return func(c *gin.Context) { + // Start timer + startTime := time.Now() + + // Process request + c.Next() + + // Calculate latency + latency := time.Since(startTime) + + // Log request details + log.Printf("[GIN] %s | %s | %s | %d | %s", + c.Request.Method, + c.Request.URL.Path, + c.ClientIP(), + c.Writer.Status(), + latency, + ) + } +} +``` + +## Handling API Requests + +Gin makes it easy to create RESTful APIs. Here's how to define API endpoints: + +```go +// GET endpoint +ginEngine.GET("/api/users", func(c *gin.Context) { + c.JSON(http.StatusOK, users) +}) + +// POST endpoint with JSON binding +ginEngine.POST("/api/users", func(c *gin.Context) { + var newUser User + if err := c.ShouldBindJSON(&newUser); err != nil { + c.JSON(http.StatusBadRequest, gin.H{"error": err.Error()}) + return + } + // Process the new user... + c.JSON(http.StatusCreated, newUser) +}) + +// Path parameters +ginEngine.GET("/api/users/:id", func(c *gin.Context) { + id := c.Param("id") + // Find user by ID... + c.JSON(http.StatusOK, user) +}) + +// Query parameters +ginEngine.GET("/api/search", func(c *gin.Context) { + query := c.DefaultQuery("q", "") + limit := c.DefaultQuery("limit", "10") + // Perform search... + c.JSON(http.StatusOK, results) +}) +``` + +## Using Wails Features + +Your Gin-served web content can interact with Wails features using the `@wailsio/runtime` package. + +### Event Handling + +Register event handlers in Go: + +```go +app.Event.On("my-event", func(event *application.CustomEvent) { + log.Printf("Received event: %v", event.Data) +}) +``` + +Call from JavaScript using the runtime: + +```html + +``` + +## Advanced Configuration + +### Customising Gin's Mode + +Set Gin to release mode for production: + +```go +gin.SetMode(gin.ReleaseMode) // Use gin.DebugMode for development +ginEngine := gin.New() +``` + +### Handling WebSockets + +You can integrate WebSockets with Gin using libraries like Gorilla WebSocket: + +```go +import "github.com/gorilla/websocket" + +var upgrader = websocket.Upgrader{ + ReadBufferSize: 1024, + WriteBufferSize: 1024, + CheckOrigin: func(r *http.Request) bool { + return true // Allow all connections + }, +} + +// In your route handler: +ginEngine.GET("/ws", func(c *gin.Context) { + conn, err := upgrader.Upgrade(c.Writer, c.Request, nil) + if err != nil { + log.Println(err) + return + } + defer conn.Close() + + // Handle WebSocket connection... +}) +``` + +## Best Practices + +- **Use Go's embed Package:** Embed static files into your binary for better distribution. +- **Separate Concerns:** Keep your API logic separate from your UI logic. +- **Error Handling:** Implement proper error handling in both Gin routes and frontend code. +- **Security:** Be mindful of security considerations, especially when handling user input. +- **Performance:** Use Gin's release mode in production for better performance. +- **Testing:** Write tests for your Gin routes using Gin's testing utilities. + +## Conclusion + +Integrating Gin with Wails provides a powerful combination for building desktop applications with web technologies. Gin's performance and feature set complement Wails' desktop integration capabilities, allowing you to create sophisticated applications that use the best of both worlds. + +For more information, refer to the [Gin documentation](https://github.com/gin-gonic/gin) and the [Wails documentation](https://wails.io). diff --git a/docs/src/content/docs/guides/gin-services.mdx b/docs/src/content/docs/guides/gin-services.mdx new file mode 100644 index 000000000..123f876eb --- /dev/null +++ b/docs/src/content/docs/guides/gin-services.mdx @@ -0,0 +1,556 @@ +--- +title: Using Gin for Services +description: A guide to integrating the Gin web framework with Wails v3 Services +--- + +# Using Gin for Services + +The Gin web framework is a popular choice for building HTTP services in Go. With Wails v3, you can easily integrate Gin-based services into your application, providing a powerful way to handle HTTP requests, implement RESTful APIs, and serve web content. + +This guide will walk you through creating a Gin-based service that can be mounted at a specific route in your Wails application. We'll build a complete example that demonstrates how to: + +1. Create a Gin-based service +2. Implement the Wails Service interface +3. Set up routes and middleware +4. Integrate with the Wails event system +5. Interact with the service from the frontend + +## Prerequisites + +Before you begin, make sure you have: + +- Wails v3 installed +- Basic knowledge of Go and the Gin framework +- Familiarity with HTTP concepts and RESTful APIs + +You'll need to add the Gin framework to your project: + +```bash +go get github.com/gin-gonic/gin +``` + +## Creating a Gin-Based Service + +Let's start by creating a Gin service that implements the Wails Service interface. Our service will manage a collection of users and provide API endpoints for retrieving and creating user records. + +### 1. Define Your Data Models + +First, define the data structures your service will work with: + +```go +package services + +import ( + "context" + "net/http" + "strconv" + "sync" + "time" + + "github.com/gin-gonic/gin" + "github.com/wailsapp/wails/v3/pkg/application" +) + +// User represents a user in the system +type User struct { + ID int `json:"id"` + Name string `json:"name"` + Email string `json:"email"` + CreatedAt time.Time `json:"createdAt"` +} + +// EventData represents data sent in events +type EventData struct { + Message string `json:"message"` + Timestamp string `json:"timestamp"` +} +``` + +### 2. Create Your Service Structure + +Next, define the service structure that will hold your Gin router and any state your service needs to maintain: + +```go +// GinService implements a Wails service that uses Gin for HTTP handling +type GinService struct { + ginEngine *gin.Engine + users []User + nextID int + mu sync.RWMutex + app *application.App +} + +// NewGinService creates a new GinService instance +func NewGinService() *GinService { + // Create a new Gin router + ginEngine := gin.New() + + // Add middlewares + ginEngine.Use(gin.Recovery()) + ginEngine.Use(LoggingMiddleware()) + + service := &GinService{ + ginEngine: ginEngine, + users: []User{ + {ID: 1, Name: "Alice", Email: "alice@example.com", CreatedAt: time.Now().Add(-72 * time.Hour)}, + {ID: 2, Name: "Bob", Email: "bob@example.com", CreatedAt: time.Now().Add(-48 * time.Hour)}, + {ID: 3, Name: "Charlie", Email: "charlie@example.com", CreatedAt: time.Now().Add(-24 * time.Hour)}, + }, + nextID: 4, + } + + // Define routes + service.setupRoutes() + + return service +} +``` + +### 3. Implement the Service Interface + +Implement the required methods for the Wails Service interface: + +```go +// ServiceName returns the name of the service +func (s *GinService) ServiceName() string { + return "Gin API Service" +} + +// ServiceStartup is called when the service starts +func (s *GinService) ServiceStartup(ctx context.Context, options application.ServiceOptions) error { + // Store the application instance for later use + s.app = application.Get() + + // Register an event handler that can be triggered from the frontend + s.app.Event.On("gin-api-event", func(event *application.CustomEvent) { + // Log the event data + s.app.Logger.Info("Received event from frontend", "data", event.Data) + + // Emit an event back to the frontend + s.app.Event.Emit("gin-api-response", + map[string]interface{}{ + "message": "Response from Gin API Service", + "time": time.Now().Format(time.RFC3339), + }, + ) + }) + + return nil +} + +// ServiceShutdown is called when the service shuts down +func (s *GinService) ServiceShutdown(ctx context.Context) error { + // Clean up resources if needed + return nil +} +``` + +### 3. Implement the http.Handler Interface + +To make your service mountable at a specific route, implement the `http.Handler` interface. This single method, `ServeHTTP`, is the gateway for all HTTP requests to your service. It delegates the request handling to the Gin router, allowing you to use all of Gin's powerful features for routing and middleware. + +```go +// ServeHTTP implements the http.Handler interface +func (s *GinService) ServeHTTP(w http.ResponseWriter, r *http.Request) { + // All requests go to the Gin router + s.ginEngine.ServeHTTP(w, r) +} +``` + +### 4. Set Up Your Routes + +Define your API routes in a separate method for better organisation. This approach keeps your code clean and makes it easier to understand the structure of your API. The Gin router provides a fluent API for defining routes, including support for route groups, which help organise related endpoints. + +```go +// setupRoutes configures the API routes +func (s *GinService) setupRoutes() { + // Basic info endpoint + s.ginEngine.GET("/info", func(c *gin.Context) { + c.JSON(http.StatusOK, gin.H{ + "service": "Gin API Service", + "version": "1.0.0", + "time": time.Now().Format(time.RFC3339), + }) + }) + + // Users group + users := s.ginEngine.Group("/users") + { + // Get all users + users.GET("", func(c *gin.Context) { + s.mu.RLock() + defer s.mu.RUnlock() + c.JSON(http.StatusOK, s.users) + }) + + // Get user by ID + users.GET("/:id", func(c *gin.Context) { + id, err := strconv.Atoi(c.Param("id")) + if err != nil { + c.JSON(http.StatusBadRequest, gin.H{"error": "Invalid user ID"}) + return + } + + s.mu.RLock() + defer s.mu.RUnlock() + + for _, user := range s.users { + if user.ID == id { + c.JSON(http.StatusOK, user) + return + } + } + + c.JSON(http.StatusNotFound, gin.H{"error": "User not found"}) + }) + + // Create a new user + users.POST("", func(c *gin.Context) { + var newUser User + if err := c.ShouldBindJSON(&newUser); err != nil { + c.JSON(http.StatusBadRequest, gin.H{"error": err.Error()}) + return + } + + s.mu.Lock() + defer s.mu.Unlock() + + // Set the ID and creation time + newUser.ID = s.nextID + newUser.CreatedAt = time.Now() + s.nextID++ + + // Add to the users slice + s.users = append(s.users, newUser) + + c.JSON(http.StatusCreated, newUser) + + // Emit an event to notify about the new user + s.app.Event.Emit("user-created", newUser) + }) + + // Delete a user + users.DELETE("/:id", func(c *gin.Context) { + id, err := strconv.Atoi(c.Param("id")) + if err != nil { + c.JSON(http.StatusBadRequest, gin.H{"error": "Invalid user ID"}) + return + } + + s.mu.Lock() + defer s.mu.Unlock() + + for i, user := range s.users { + if user.ID == id { + // Remove the user from the slice + s.users = append(s.users[:i], s.users[i+1:]...) + c.JSON(http.StatusOK, gin.H{"message": "User deleted"}) + return + } + } + + c.JSON(http.StatusNotFound, gin.H{"error": "User not found"}) + }) + } +} +``` + +### 5. Create Custom Middleware + +You can create custom Gin middleware to enhance your service. Middleware functions in Gin are executed in the order they are added to the router and can perform tasks such as logging, authentication, and error handling. This example shows a simple logging middleware that records request details. + +```go +// LoggingMiddleware is a Gin middleware that logs request details +func LoggingMiddleware() gin.HandlerFunc { + return func(c *gin.Context) { + // Start timer + start := time.Now() + + // Process request + c.Next() + + // Calculate latency + latency := time.Since(start) + + // Log request details + log.Printf("[GIN] %s %s %d %s", c.Request.Method, c.Request.URL.Path, c.Writer.Status(), latency) + } +} +``` + +## Registering Your Service + +To use your Gin-based service in a Wails application, you need to register it with the application and specify the route where it should be mounted. This is done when creating the Wails application instance. The route you specify becomes the base path for all endpoints defined in your Gin router. + +```go +app := application.New(application.Options{ + Name: "Gin Service Demo", + Description: "A demo of using Gin in Wails services", + Mac: application.MacOptions{ + ApplicationShouldTerminateAfterLastWindowClosed: true, + }, + LogLevel: slog.LevelDebug, + Services: []application.Service{ + application.NewServiceWithOptions(services.NewGinService(), application.ServiceOptions{ + Route: "/api", + }), + }, + Assets: application.AssetOptions{ + Handler: application.BundledAssetFileServer(assets), + }, +}) +``` + +In this example, the Gin service is mounted at the `/api` route. This means that if your Gin router has an endpoint defined as `/info`, it will be accessible at `/api/info` in your application. This approach allows you to organise your API endpoints logically and avoid conflicts with other parts of your application. + +## Integrating with the Wails Event System + +One of the powerful features of using Gin with Wails Services is the ability to seamlessly integrate with the Wails event system. This allows for real-time communication between your backend service and the frontend. + +In your service's `ServiceStartup` method, you can register event handlers to process events from the frontend: + +```go +s.app.Event.On("gin-api-event", func(event *application.CustomEvent) { + // Log the event data + s.app.Logger.Info("Received event from frontend", "data", event.Data) + + // Emit an event back to the frontend + s.app.Event.Emit("gin-api-response", + map[string]interface{}{ + "message": "Response from Gin API Service", + "time": time.Now().Format(time.RFC3339), + }, + ) +}) +``` + +You can also emit events to the frontend from your Gin routes or other parts of your service: + +```go +// After creating a new user +s.app.Event.Emit("user-created", newUser) +``` + +## Frontend Integration + +To interact with your Gin service from the frontend, you'll need to import the Wails runtime, make HTTP requests to your API endpoints, and use the Wails event system for real-time communication. + +For production use, it's recommended to use the `@wailsio/runtime` package instead of directly importing `/wails/runtime.js`. This ensures type safety, better IDE support, version management through npm, and compatibility with modern JavaScript tooling. + +Install the package: +```bash +npm install @wailsio/runtime +``` + +Then use it in your code: +```javascript +import * as wails from '@wailsio/runtime'; + +// Event emission +wails.Events.Emit('gin-api-event', eventData); +``` + +Here's an example of how to set up frontend integration: + +```html + + + + + + Gin Service Example + + + +

      Gin Service Example

      + +
      +

      API Endpoints

      +

      Try the Gin API endpoints mounted at /api:

      + + + + + + + +
      +
      Results will appear here...
      +
      +
      + +
      +

      Event Communication

      +

      Trigger an event to communicate with the Gin service:

      + + + +
      +
      Event responses will appear here...
      +
      +
      + + + + + + +``` + +## Closing Thoughts + +Integrating the Gin web framework with Wails v3 Services provides a powerful and flexible approach to building modular, maintainable web applications. By leveraging Gin's routing and middleware capabilities alongside the Wails event system, you can create rich, interactive applications with clean separation of concerns. + +The complete example code for this guide can be found in the Wails repository under `v3/examples/gin-service`. diff --git a/docs/src/content/docs/guides/installers.mdx b/docs/src/content/docs/guides/installers.mdx new file mode 100644 index 000000000..170b26865 --- /dev/null +++ b/docs/src/content/docs/guides/installers.mdx @@ -0,0 +1,160 @@ +--- +title: Creating Installers +description: Package your application for distribution +sidebar: + order: 3 +--- + +import { Tabs, TabItem } from "@astrojs/starlight/components"; + +## Overview + +Create professional installers for your Wails application on all platforms. + +## Platform Installers + + + + ### NSIS Installer + + ```bash + # Install NSIS + # Download from: https://nsis.sourceforge.io/ + + # Create installer script (installer.nsi) + makensis installer.nsi + ``` + + **installer.nsi:** + ```nsis + !define APPNAME "MyApp" + !define VERSION "1.0.0" + + Name "${APPNAME}" + OutFile "MyApp-Setup.exe" + InstallDir "$PROGRAMFILES\${APPNAME}" + + Section "Install" + SetOutPath "$INSTDIR" + File "build\bin\myapp.exe" + CreateShortcut "$DESKTOP\${APPNAME}.lnk" "$INSTDIR\myapp.exe" + SectionEnd + ``` + + ### WiX Toolset + + Alternative for MSI installers. + + + + ### DMG Creation + + ```bash + # Create DMG + hdiutil create -volname "MyApp" -srcfolder build/bin/MyApp.app -ov -format UDZO MyApp.dmg + ``` + + ### Code Signing + + ```bash + # Sign application + codesign --deep --force --verify --verbose --sign "Developer ID" MyApp.app + + # Notarize + xcrun notarytool submit MyApp.dmg --apple-id "email" --password "app-password" + ``` + + ### App Store + + Use Xcode for App Store distribution. + + + + ### DEB Package + + ```bash + # Create package structure + mkdir -p myapp_1.0.0/DEBIAN + mkdir -p myapp_1.0.0/usr/bin + + # Copy binary + cp build/bin/myapp myapp_1.0.0/usr/bin/ + + # Create control file + cat > myapp_1.0.0/DEBIAN/control << EOF + Package: myapp + Version: 1.0.0 + Architecture: amd64 + Maintainer: Your Name + Description: My Application + EOF + + # Build package + dpkg-deb --build myapp_1.0.0 + ``` + + ### RPM Package + + Use `rpmbuild` for RPM-based distributions. + + ### AppImage + + ```bash + # Use appimagetool + appimagetool myapp.AppDir + ``` + + + +## Automated Packaging + +### Using GoReleaser + +```yaml +# .goreleaser.yml +project_name: myapp + +builds: + - binary: myapp + goos: + - windows + - darwin + - linux + goarch: + - amd64 + - arm64 + +archives: + - format: zip + name_template: "{{ .ProjectName }}_{{ .Version }}_{{ .Os }}_{{ .Arch }}" + +nfpms: + - formats: + - deb + - rpm + vendor: Your Company + homepage: https://example.com + description: My Application +``` + +## Best Practices + +### ✅ Do + +- Code sign on all platforms +- Include version information +- Create uninstallers +- Test installation process +- Provide clear documentation + +### ❌ Don't + +- Don't skip code signing +- Don't forget file associations +- Don't hardcode paths +- Don't skip testing + +## Next Steps + +- [Auto-Updates](/guides/auto-updates) - Implement automatic updates +- [Cross-Platform Building](/guides/cross-platform) - Build for multiple platforms diff --git a/docs/src/content/docs/guides/menus.mdx b/docs/src/content/docs/guides/menus.mdx new file mode 100644 index 000000000..c16c40ff6 --- /dev/null +++ b/docs/src/content/docs/guides/menus.mdx @@ -0,0 +1,531 @@ +--- +title: Menus +description: A guide to creating and customising menus in Wails v3 +--- + +Wails v3 provides a powerful menu system that allows you to create both application menus and context menus. This guide will walk you through the various features and capabilities of the menu system. + +### Creating a Menu + +To create a new menu, use the `New()` method from the Menus manager: + +```go +menu := app.Menu.New() +``` + +### Adding Menu Items + +Wails supports several types of menu items, each serving a specific purpose: + +#### Regular Menu Items +Regular menu items are the basic building blocks of menus. They display text and can trigger actions when clicked: + +```go +menuItem := menu.Add("Click Me") +``` + +#### Checkboxes +Checkbox menu items provide a toggleable state, useful for enabling/disabling features or settings: + +```go +checkbox := menu.AddCheckbox("My checkbox", true) // true = initially checked +``` + +#### Radio Groups +Radio groups allow users to select one option from a set of mutually exclusive choices. They are automatically created when radio items are placed next to each other: + +```go +menu.AddRadio("Option 1", true) // true = initially selected +menu.AddRadio("Option 2", false) +menu.AddRadio("Option 3", false) +``` + +#### Separators +Separators are horizontal lines that help organise menu items into logical groups: + +```go +menu.AddSeparator() +``` + +#### Submenus +Submenus are nested menus that appear when hovering over or clicking a menu item. They're useful for organizing complex menu structures: + +```go +submenu := menu.AddSubmenu("File") +submenu.Add("Open") +submenu.Add("Save") +``` + +#### Combining menus +A menu can be added into another menu by appending or prepending it. +```go +menu := app.Menu.New() +menu.Add("First Menu") + +secondaryMenu := app.Menu.New() +secondaryMenu.Add("Second Menu") + +// insert 'secondaryMenu' after 'menu' +menu.Append(secondaryMenu) + +// insert 'secondaryMenu' before 'menu' +menu.Prepend(secondaryMenu) + +// update the menu +menu.Update() +``` + +:::note +By default, `prepend` and `append` will share state with the original menu. If you want to create a new menu with its own state, +you can call `.Clone()` on the menu. + +E.g: `menu.Append(secondaryMenu.Clone())` +::: + +#### Clearing a menu +In some cases it'll be better to construct a whole new menu if you are working with a variable amount of menu items. + +This will clear all items on an existing menu and allows you to add items again. + +```go +menu := app.Menu.New() +menu.Add("Waiting for update...") + +// after certain logic, the menu has to be updated +menu.Clear() +menu.Add("Update complete!") +menu.Update() +``` + +:::note +Clearing a menu simply clears the menu items at the top level. Whilst Submenus won't be visible, they will still occupy memory +so be sure to manage your menus carefully. +::: + +#### Destroying a menu + +If you want to clear and release a menu, use the `Destroy()` method: + +```go +menu := app.Menu.New() +menu.Add("Waiting for update...") + +// after certain logic, the menu has to be destroyed +menu.Destroy() +``` + + +### Menu Item Properties + +Menu items have several properties that can be configured: + +| Property | Method | Description | +|-------------|--------------------------|-----------------------------------------------------| +| Label | `SetLabel(string)` | Sets the display text | +| Enabled | `SetEnabled(bool)` | Enables/disables the item | +| Checked | `SetChecked(bool)` | Sets the checked state (for checkboxes/radio items) | +| Tooltip | `SetTooltip(string)` | Sets the tooltip text | +| Hidden | `SetHidden(bool)` | Shows/hides the item | +| Accelerator | `SetAccelerator(string)` | Sets the keyboard shortcut | + +### Menu Item States + +Menu items can be in different states that control their visibility and interactivity: + +#### Visibility + +Menu items can be shown or hidden dynamically using the `SetHidden()` method: + +```go +menuItem := menu.Add("Dynamic Item") + +// Hide the menu item +menuItem.SetHidden(true) + +// Show the menu item +menuItem.SetHidden(false) + +// Check current visibility +isHidden := menuItem.Hidden() +``` + +Hidden menu items are completely removed from the menu until shown again. This is useful for contextual menu items that should only appear in certain application states. + +#### Enabled State + +Menu items can be enabled or disabled using the `SetEnabled()` method: + +```go +menuItem := menu.Add("Save") + +// Disable the menu item +menuItem.SetEnabled(false) // Item appears grayed out and cannot be clicked + +// Enable the menu item +menuItem.SetEnabled(true) // Item becomes clickable again + +// Check current enabled state +isEnabled := menuItem.Enabled() +``` + +Disabled menu items remain visible but appear grayed out and cannot be clicked. This is commonly used to indicate that an action is currently unavailable, such as: +- Disabling "Save" when there are no changes to save +- Disabling "Copy" when nothing is selected +- Disabling "Undo" when there's no action to undo + +#### Dynamic State Management + +You can combine these states with event handlers to create dynamic menus: + +```go +saveMenuItem := menu.Add("Save") + +// Initially disable the Save menu item +saveMenuItem.SetEnabled(false) + +// Enable Save only when there are unsaved changes +documentChanged := func() { + saveMenuItem.SetEnabled(true) + menu.Update() // Remember to update the menu after changing states +} + +// Disable Save after saving +documentSaved := func() { + saveMenuItem.SetEnabled(false) + menu.Update() +} +``` + +### Event Handling + +Menu items can respond to click events using the `OnClick` method: + +```go +menuItem.OnClick(func(ctx *application.Context) { + // Handle the click event + println("Menu item clicked!") +}) +``` + +The context provides information about the clicked menu item: + +```go +menuItem.OnClick(func(ctx *application.Context) { + // Get the clicked menu item + clickedItem := ctx.ClickedMenuItem() + // Get its current state + isChecked := clickedItem.Checked() +}) +``` + +### Role-Based Menu Items + +Wails provides a set of predefined menu roles that automatically create menu items with standard functionality. Here are the supported menu roles: + +#### Complete Menu Structures +These roles create entire menu structures with common functionality: + +| Role | Description | Platform Notes | +|------|-------------|----------------| +| `AppMenu` | Application menu with About, Services, Hide/Show, and Quit | macOS only | +| `EditMenu` | Standard Edit menu with Undo, Redo, Cut, Copy, Paste, etc. | All platforms | +| `ViewMenu` | View menu with Reload, Zoom, and Fullscreen controls | All platforms | +| `WindowMenu` | Window controls (Minimise, Zoom, etc.) | All platforms | +| `HelpMenu` | Help menu with "Learn More" link to Wails website | All platforms | + +#### Individual Menu Items +These roles can be used to add individual menu items: + +| Role | Description | Platform Notes | +|------|-------------|----------------| +| `About` | Show application About dialog | All platforms | +| `Hide` | Hide application | macOS only | +| `HideOthers` | Hide other applications | macOS only | +| `UnHide` | Show hidden application | macOS only | +| `CloseWindow` | Close current window | All platforms | +| `Minimise` | Minimise window | All platforms | +| `Zoom` | Zoom window | macOS only | +| `Front` | Bring window to front | macOS only | +| `Quit` | Quit application | All platforms | +| `Undo` | Undo last action | All platforms | +| `Redo` | Redo last action | All platforms | +| `Cut` | Cut selection | All platforms | +| `Copy` | Copy selection | All platforms | +| `Paste` | Paste from clipboard | All platforms | +| `PasteAndMatchStyle` | Paste and match style | macOS only | +| `SelectAll` | Select all | All platforms | +| `Delete` | Delete selection | All platforms | +| `Reload` | Reload current page | All platforms | +| `ForceReload` | Force reload current page | All platforms | +| `ToggleFullscreen` | Toggle fullscreen mode | All platforms | +| `ResetZoom` | Reset zoom level | All platforms | +| `ZoomIn` | Increase zoom | All platforms | +| `ZoomOut` | Decrease zoom | All platforms | + +Here's an example showing how to use both complete menus and individual roles: + +```go +menu := app.Menu.New() + +// Add complete menu structures +menu.AddRole(application.AppMenu) // macOS only +menu.AddRole(application.EditMenu) // Common edit operations +menu.AddRole(application.ViewMenu) // View controls +menu.AddRole(application.WindowMenu) // Window controls + +// Add individual role-based items to a custom menu +fileMenu := menu.AddSubmenu("File") +fileMenu.AddRole(application.CloseWindow) +fileMenu.AddSeparator() +fileMenu.AddRole(application.Quit) +``` + +## Application Menus + +Application menus are the menus that appear at the top of your application window (Windows/Linux) or at the top of the screen (macOS). + + +### Application Menu Behaviour + +When you set an application menu using `app.Menu.Set()`, it becomes the main menu on macOS. +Menus are set on a per-window basis for Windows/Linux. + +```go +app.Window.NewWithOptions(application.WebviewWindowOptions{ + Title: "Custom Menu Window", + Windows: application.WindowsWindow{ + Menu: customMenu, // Override application menu for this window + }, +}) +``` + +Here's a complete example showing these different menu behaviours: + +```go +func main() { + app := application.New(application.Options{}) + + // Create application menu + appMenu := app.Menu.New() + fileMenu := appMenu.AddSubmenu("File") + fileMenu.Add("New").OnClick(func(ctx *application.Context) { + // This will be available in all windows unless overridden + window := app.Windows.Current() + window.SetTitle("New Window") + }) + + // Set as application menu - this is for macOS + app.Menu.Set(appMenu) + + // Window with custom menu on Windows + customMenu := app.Menu.New() + customMenu.Add("Custom Action") + app.Window.NewWithOptions(application.WebviewWindowOptions{ + Title: "Custom Menu", + Windows: application.WindowsWindow{ + Menu: customMenu, + }, + }) + + app.Run() +} +``` + +## Context Menus + +Context menus are popup menus that appear when right-clicking elements in your application. They provide quick access to relevant actions for the clicked element. + +### Default Context Menu + +The default context menu is the webview's built-in context menu that provides system-level operations such as: +- Copy, Cut, and Paste for text manipulation +- Text selection controls +- Spell checking options + +#### Controlling the Default Context Menu + +You can control when the default context menu appears using the `--default-contextmenu` CSS property: + +```html + +
      + + +
      + + +
      +
      Custom context menu only
      +
      + + +
      + +

      Select this text to see the default menu

      + +
      +``` + +:::note +This feature will only work as expected after the runtime [has been initialised](../../learn/runtime#initialisation). +::: + +#### Nested Context Menu Behavior + +When using the `--default-contextmenu` property on nested elements, the following rules apply: + +1. Child elements inherit their parent's context menu setting unless explicitly overridden +2. The most specific (closest) setting takes precedence +3. The `auto` value can be used to reset to default behaviour + +Example of nested context menu behaviour: + +```html + +
      + +

      No context menu here

      + + +
      +

      Context menu shown here

      + + + Also has context menu + + +
      +

      Shows menu only when text is selected

      +
      +
      +
      +``` + +### Custom Context Menus + +Custom context menus allow you to provide application-specific actions that are relevant to the element being clicked. They're particularly useful for: +- File operations in a document manager +- Image manipulation tools +- Custom actions in a data grid +- Component-specific operations + +#### Creating a Custom Context Menu + +When creating a custom context menu, you provide a unique identifier (name) that links the menu to HTML elements: + +```go +// Create a context menu with identifier "imageMenu" +contextMenu := application.NewContextMenu() +app.ContextMenus.Add("imageMenu", contextMenu) +``` + +The name parameter ("imageMenu" in this example) serves as a unique identifier that will be used to: +1. Link HTML elements to this specific context menu +2. Identify which menu should be shown when right-clicking +3. Allow menu updates and cleanup + +#### Context Data + +When handling context menu events, you can access both the clicked menu item and its associated context data: + +```go +contextMenu.Add("Process").OnClick(func(ctx *application.Context) { + // Get the clicked menu item + menuItem := ctx.ClickedMenuItem() + + // Get the context data as a string + contextData := ctx.ContextMenuData() + + // Check if the menu item is checked (for checkbox/radio items) + isChecked := ctx.IsChecked() + + // Use the data + if contextData != "" { + processItem(contextData) + } +}) +``` + +The context data is passed from the HTML element's `--custom-contextmenu-data` property and is available in the click handler through `ctx.ContextMenuData()`. This is particularly useful when: + +- Working with lists or grids where each item needs unique identification +- Handling operations on specific components or elements +- Passing state or metadata from the frontend to the backend + +#### Context Menu Management + +After making changes to a context menu, call the `Update()` method to apply the changes: + +```go +contextMenu.Update() +``` + +When you no longer need a context menu, you can destroy it: + +```go +contextMenu.Destroy() +``` +:::danger[Warning] +After calling `Destroy()`, using the context menu reference again will result in a panic. +::: + +### Real-World Example: Image Gallery + +Here's a complete example of implementing a custom context menu for an image gallery: + +```go +// Backend: Create the context menu +imageMenu := application.NewContextMenu() +app.ContextMenus.Add("imageMenu", imageMenu) + +// Add relevant operations +imageMenu.Add("View Full Size").OnClick(func(ctx *application.Context) { + // Get the image ID from context data + if imageID := ctx.ContextMenuData(); imageID != "" { + openFullSizeImage(imageID) + } +}) + +imageMenu.Add("Download").OnClick(func(ctx *application.Context) { + if imageID := ctx.ContextMenuData(); imageID != "" { + downloadImage(imageID) + } +}) + +imageMenu.Add("Share").OnClick(func(ctx *application.Context) { + if imageID := ctx.ContextMenuData(); imageID != "" { + showShareDialog(imageID) + } +}) +``` + +```html + + +``` + +In this example: +1. The context menu is created with the identifier "imageMenu" +2. Each image container is linked to the menu using `--custom-contextmenu: imageMenu` +3. Each container provides its image ID as context data using `--custom-contextmenu-data` +4. The backend receives the image ID in click handlers and can perform specific operations +5. The same menu is reused for all images, but the context data tells us which image to operate on + +This pattern is particularly powerful for: +- Data grids where rows need specific operations +- File managers where files need context-specific actions +- Design tools where different elements need different operations +- Any component where the same operations apply to multiple instances diff --git a/docs/src/content/docs/guides/panic-handling.mdx b/docs/src/content/docs/guides/panic-handling.mdx new file mode 100644 index 000000000..f252f0dc3 --- /dev/null +++ b/docs/src/content/docs/guides/panic-handling.mdx @@ -0,0 +1,116 @@ +--- +title: Handling Panics +description: How to handle panics in your Wails application +--- + +In Go applications, panics can occur during runtime when something unexpected happens. This guide explains how to handle panics both in general Go code and specifically in your Wails application. + +## Understanding Panics in Go + +Before diving into Wails-specific panic handling, it's essential to understand how panics work in Go: + +1. Panics are for unrecoverable errors that shouldn't happen during normal operation +2. When a panic occurs in a goroutine, only that goroutine is affected +3. Panics can be recovered using `defer` and `recover()` + +Here's a basic example of panic handling in Go: + +```go +func doSomething() { + // Deferred functions run even when a panic occurs + defer func() { + if r := recover(); r != nil { + fmt.Printf("Recovered from panic: %v\n", r) + } + }() + + // Your code that might panic + panic("something went wrong") +} +``` + +For more detailed information about panic and recover in Go, see the [Go Blog: Defer, Panic, and Recover](https://go.dev/blog/defer-panic-and-recover). + +## Panic Handling in Wails + +Wails automatically handles panics that occur in your Service methods when they are called from the frontend. This means you don't need to add panic recovery to these methods - Wails will catch the panic and process it through your configured panic handler. + +The panic handler is specifically designed to catch: +- Panics in bound service methods called from the frontend +- Internal panics from the Wails runtime + +For other scenarios, such as background goroutines or standalone Go code, you should handle panics yourself using Go's standard panic recovery mechanisms. + +## The PanicDetails Struct + +When a panic occurs, Wails captures important information about the panic in a `PanicDetails` struct: + +```go +type PanicDetails struct { + StackTrace string // The stack trace of where the panic occurred. Potentially trimmed to provide more context + Error error // The error that caused the panic + Time time.Time // The time when the panic occurred + FullStackTrace string // The complete stack trace including runtime frames +} +``` + +This structure provides comprehensive information about the panic: +- `StackTrace`: A formatted string showing the call stack that led to the panic +- `Error`: The actual error or panic message +- `Time`: The exact time when the panic occurred +- `FullStackTrace`: The complete stack trace including runtime frames + +:::note[Panics in Service Code] + +When panics are caught in your Service code after being called from the frontend, the stack trace is trimmed to focus on exactly where in your code the panic occurred. +If you want to see the full stack trace, you can use the `FullStackTrace` field. + +::: + +## Default Panic Handler + +If you don't specify a custom panic handler, Wails will use its default handler which outputs error information in a formatted log message and then quits. +For example: + +``` +************************ FATAL ****************************** +* There has been a catastrophic failure in your application * +********************* Error Details ************************* +panic error: oh no! something went wrong deep in my service! :( +main.(*WindowService).call2 + at E:/wails/v3/examples/panic-handling/main.go:23 +main.(*WindowService).call1 + at E:/wails/v3/examples/panic-handling/main.go:19 +main.(*WindowService).GeneratePanic + at E:/wails/v3/examples/panic-handling/main.go:15 +************************************************************* +``` + +## Custom Panic Handler + +You can implement your own panic handler by setting the `PanicHandler` option when creating your application. Here's an example: + +```go +app := application.New(application.Options{ + Name: "My App", + PanicHandler: func(panicDetails *application.PanicDetails) { + fmt.Printf("*** Custom Panic Handler ***\n") + fmt.Printf("Time: %s\n", panicDetails.Time) + fmt.Printf("Error: %s\n", panicDetails.Error) + fmt.Printf("Stacktrace: %s\n", panicDetails.StackTrace) + fmt.Printf("Full Stacktrace: %s\n", panicDetails.FullStackTrace) + + // You could also: + // - Log to a file + // - Send to a crash reporting service + // - Show a user-friendly error dialog + // - Attempt to recover or restart the application + }, +}) +``` + +For a complete working example of panic handling in a Wails application, see the panic-handling example in `v3/examples/panic-handling`. + +## Final Notes + +Remember that the Wails panic handler is specifically for managing panics in bound methods and internal runtime errors. For other parts of your application, you should use Go's standard error handling patterns and panic recovery mechanisms where appropriate. As with all Go applications, it's better to prevent panics through proper error handling where possible. diff --git a/docs/src/content/docs/guides/performance.mdx b/docs/src/content/docs/guides/performance.mdx new file mode 100644 index 000000000..1d38a1ef4 --- /dev/null +++ b/docs/src/content/docs/guides/performance.mdx @@ -0,0 +1,341 @@ +--- +title: Performance Optimisation +description: Optimise your Wails application for maximum performance +sidebar: + order: 9 +--- + +## Overview + +Optimise your Wails application for speed, memory efficiency, and responsiveness. + +## Frontend Optimisation + +### Bundle Size + +```javascript +// vite.config.js +export default { + build: { + rollupOptions: { + output: { + manualChunks: { + vendor: ['react', 'react-dom'], + }, + }, + }, + minify: 'terser', + terserOptions: { + compress: { + drop_console: true, + }, + }, + }, +} +``` + +### Code Splitting + +```javascript +// Lazy load components +const Settings = lazy(() => import('./Settings')) + +function App() { + return ( + }> + + + ) +} +``` + +### Asset Optimisation + +```javascript +// Optimise images +import { defineConfig } from 'vite' +import imagemin from 'vite-plugin-imagemin' + +export default defineConfig({ + plugins: [ + imagemin({ + gifsicle: { optimizationLevel: 3 }, + optipng: { optimizationLevel: 7 }, + svgo: { plugins: [{ removeViewBox: false }] }, + }), + ], +}) +``` + +## Backend Optimisation + +### Efficient Bindings + +```go +// ❌ Bad: Return everything +func (s *Service) GetAllData() []Data { + return s.db.FindAll() // Could be huge +} + +// ✅ Good: Paginate +func (s *Service) GetData(page, size int) (*PagedData, error) { + return s.db.FindPaged(page, size) +} +``` + +### Caching + +```go +type CachedService struct { + cache *lru.Cache + ttl time.Duration +} + +func (s *CachedService) GetData(key string) (interface{}, error) { + // Check cache + if val, ok := s.cache.Get(key); ok { + return val, nil + } + + // Fetch and cache + data, err := s.fetchData(key) + if err != nil { + return nil, err + } + + s.cache.Add(key, data) + return data, nil +} +``` + +### Goroutines for Long Operations + +```go +func (s *Service) ProcessLargeFile(path string) error { + // Process in background + go func() { + result, err := s.process(path) + if err != nil { + s.app.Event.Emit("process-error", err.Error()) + return + } + s.app.Event.Emit("process-complete", result) + }() + + return nil +} +``` + +## Memory Optimisation + +### Avoid Memory Leaks + +```go +// ❌ Bad: Goroutine leak +func (s *Service) StartPolling() { + ticker := time.NewTicker(1 * time.Second) + go func() { + for range ticker.C { + s.poll() + } + }() + // ticker never stopped! +} + +// ✅ Good: Proper cleanup +func (s *Service) StartPolling() { + ticker := time.NewTicker(1 * time.Second) + s.stopChan = make(chan bool) + + go func() { + for { + select { + case <-ticker.C: + s.poll() + case <-s.stopChan: + ticker.Stop() + return + } + } + }() +} + +func (s *Service) StopPolling() { + close(s.stopChan) +} +``` + +### Pool Resources + +```go +var bufferPool = sync.Pool{ + New: func() interface{} { + return new(bytes.Buffer) + }, +} + +func processData(data []byte) []byte { + buf := bufferPool.Get().(*bytes.Buffer) + defer bufferPool.Put(buf) + + buf.Reset() + buf.Write(data) + // Process... + return buf.Bytes() +} +``` + +## Event Optimisation + +### Debounce Events + +```javascript +// Debounce frequent events +let debounceTimer +function handleInput(value) { + clearTimeout(debounceTimer) + debounceTimer = setTimeout(() => { + UpdateData(value) + }, 300) +} +``` + +### Batch Updates + +```go +type BatchProcessor struct { + items []Item + mu sync.Mutex + timer *time.Timer +} + +func (b *BatchProcessor) Add(item Item) { + b.mu.Lock() + defer b.mu.Unlock() + + b.items = append(b.items, item) + + if b.timer == nil { + b.timer = time.AfterFunc(100*time.Millisecond, b.flush) + } +} + +func (b *BatchProcessor) flush() { + b.mu.Lock() + items := b.items + b.items = nil + b.timer = nil + b.mu.Unlock() + + // Process batch + processBatch(items) +} +``` + +## Build Optimisation + +### Binary Size + +```bash +# Strip debug symbols +wails3 build -ldflags "-s -w" + +# Reduce binary size further +go build -ldflags="-s -w" -trimpath +``` + +### Compilation Speed + +```bash +# Use build cache +go build -buildmode=default + +# Parallel compilation +go build -p 8 +``` + +## Profiling + +### CPU Profiling + +```go +import "runtime/pprof" + +func profileCPU() { + f, _ := os.Create("cpu.prof") + defer f.Close() + + pprof.StartCPUProfile(f) + defer pprof.StopCPUProfile() + + // Code to profile +} +``` + +### Memory Profiling + +```go +import "runtime/pprof" + +func profileMemory() { + f, _ := os.Create("mem.prof") + defer f.Close() + + runtime.GC() + pprof.WriteHeapProfile(f) +} +``` + +### Analyse Profiles + +```bash +# View CPU profile +go tool pprof cpu.prof + +# View memory profile +go tool pprof mem.prof + +# Web interface +go tool pprof -http=:8080 cpu.prof +``` + +## Best Practices + +### ✅ Do + +- Profile before optimising +- Cache expensive operations +- Use pagination for large datasets +- Debounce frequent events +- Pool resources +- Clean up goroutines +- Optimise bundle size +- Use lazy loading + +### ❌ Don't + +- Don't optimise prematurely +- Don't ignore memory leaks +- Don't block the main thread +- Don't return huge datasets +- Don't skip profiling +- Don't forget cleanup + +## Performance Checklist + +- [ ] Frontend bundle optimised +- [ ] Images compressed +- [ ] Code splitting implemented +- [ ] Backend methods paginated +- [ ] Caching implemented +- [ ] Goroutines cleaned up +- [ ] Events debounced +- [ ] Binary size optimised +- [ ] Profiling done +- [ ] Memory leaks fixed + +## Next Steps + +- [Architecture](/guides/architecture) - Application architecture patterns +- [Testing](/guides/testing) - Test your application +- [Building](/guides/building) - Build optimised binaries diff --git a/docs/src/content/docs/guides/raw-messages.mdx b/docs/src/content/docs/guides/raw-messages.mdx new file mode 100644 index 000000000..5f2a7a653 --- /dev/null +++ b/docs/src/content/docs/guides/raw-messages.mdx @@ -0,0 +1,393 @@ +--- +title: Raw Messages +description: Implement custom frontend-to-backend communication for performance-critical applications +sidebar: + order: 10 +--- + +Raw messages provide a low-level communication channel between your frontend and backend, bypassing the standard binding system. This trades convenience for speed. + +## When to Use Raw Messages + +Raw messages are best suited for extreme edge cases: + +- **Ultra-high-frequency updates** - Thousands of messages per second where every microsecond matters +- **Custom message protocols** - When you need complete control over the wire format + +:::tip +For almost all use cases, standard [service bindings](/features/bindings/services) are recommended as they provide type safety, automatic serialization, and a better developer experience with negligible overhead. +::: + +## Backend Setup + +Configure the `RawMessageHandler` in your application options: + +```go +package main + +import ( + "encoding/json" + "fmt" + + "github.com/wailsapp/wails/v3/pkg/application" +) + +func main() { + app := application.New(application.Options{ + Name: "Raw Message Demo", + Assets: application.AssetOptions{ + Handler: application.BundledAssetFileServer(assets), + }, + RawMessageHandler: func(window application.Window, message string, originInfo *application.OriginInfo) { + fmt.Printf("Raw message from window '%s': %s (origin: %+v)\n", window.Name(), message, originInfo.Origin) + + // Process the message and respond via events + response := processMessage(message) + window.EmitEvent("raw-response", response) + }, + }) + + app.Window.NewWithOptions(application.WebviewWindowOptions{ + Title: "My App", + Name: "main", + }) + + app.Run() +} + +func processMessage(message string) map[string]any { + // Your custom message processing logic + return map[string]any{ + "received": message, + "status": "processed", + } +} +``` + +### Handler Signature + +```go +RawMessageHandler func(window Window, message string, originInfo *application.OriginInfo) +``` + +| Parameter | Type | Description | +|-----------|------|-------------| +| `window` | `Window` | The window that sent the message | +| `message` | `string` | The raw message content | +| `originInfo` | `*application.OriginInfo` | Origin information about the message source | + +#### OriginInfo Structure + +```go +type OriginInfo struct { + Origin string + TopOrigin string + IsMainFrame bool +} +``` + +| Field | Type | Description | +|-------|------|-------------| +| `Origin` | `string` | The origin URL of the document that sent the message | +| `TopOrigin` | `string` | The top-level origin URL (may differ from Origin in iframes) | +| `IsMainFrame` | `bool` | Whether the message originated from the main frame | + +#### Platform-Specific Availability + +- **macOS**: `Origin` and `IsMainFrame` are provided +- **Windows**: `Origin` and `TopOrigin` are provided +- **Linux**: Only `Origin` is provided + +### Origin Validation + +:::caution +Never assume a message is safe because it arrives in your handler. The origin information must be validated before processing sensitive operations or operations that modify state. +::: + +**Always verify the origin of incoming messages before processing them.** The `originInfo` parameter provides critical security information that must be validated to prevent unauthorized access. +Malicious content, compromised content, or unintended scripts could send raw messages. Without origin validation, you may process commands from untrusted sources. Use `originInfo` to ensure messages come from expected sources. + +### Key Validation Points + +- **Always check `Origin`** - Verify the origin matches your expected trusted sources (typically `wails://wails` or `http://wails.localhost` for local assets or your app's specific origin) +- **Validate `IsMainFrame`** (macOS) - Be aware if the message comes from an iframe, as this may indicate embedded content with different security contexts +- **Use `TopOrigin`** (Windows) - Verify the top-level origin when dealing with framed content +- **Reject unexpected origins** - Fail securely by rejecting messages from origins you don't explicitly allow + + +:::note +Messages prefixed with `wails:` are reserved for internal Wails communication and will not be passed to your handler. +::: + +## Frontend Setup + +Send raw messages using `System.invoke()`: + +```html + + + + + + + + + + +``` + +### Using the Pre-built Bundle + +If you're not using npm, access `invoke` via the global `wails` object: + +```html + + +``` + +## Structured Messages + +For complex data, serialize to JSON: + +### Frontend + +```javascript +import { System } from '@wailsio/runtime' + +const command = { + action: 'update', + payload: { + id: 123, + value: 'new value' + } +} + +System.invoke(JSON.stringify(command)) +``` + +### Backend + +```go +RawMessageHandler: func(window application.Window, message string, originInfo *application.OriginInfo) { + var cmd struct { + Action string `json:"action"` + Payload struct { + ID int `json:"id"` + Value string `json:"value"` + } `json:"payload"` + } + + if err := json.Unmarshal([]byte(message), &cmd); err != nil { + window.EmitEvent("error", err.Error()) + return + } + + switch cmd.Action { + case "update": + // Handle update + result := handleUpdate(cmd.Payload.ID, cmd.Payload.Value) + window.EmitEvent("update-complete", result) + default: + window.EmitEvent("error", "unknown action") + } +} +``` + +## Performance Comparison + +| Approach | Overhead | Type Safety | Use Case | +|----------|----------|-------------|----------| +| Service Bindings | Higher | Full | General purpose | +| Raw Messages | Minimal | Manual | High-frequency, performance-critical | + +### Benchmark Example + +Raw messages can process significantly more messages per second compared to service bindings for simple payloads: + +```go +// Raw message handler - minimal overhead +RawMessageHandler: func(window application.Window, message string, originInfo *application.OriginInfo) { + // Direct string processing, no reflection or marshaling + counter++ +} +``` + +## Complete Example + +Here's a full example implementing a simple command protocol: + +### main.go + +```go +package main + +import ( + "embed" + "encoding/json" + "fmt" + "time" + + "github.com/wailsapp/wails/v3/pkg/application" +) + +//go:embed assets +var assets embed.FS + +type Command struct { + Type string `json:"type"` + Data json.RawMessage `json:"data"` +} + +func main() { + app := application.New(application.Options{ + Name: "Raw Message Demo", + Assets: application.AssetOptions{ + Handler: application.BundledAssetFileServer(assets), + }, + Mac: application.MacOptions{ + ApplicationShouldTerminateAfterLastWindowClosed: true, + }, + RawMessageHandler: func(window application.Window, message string, originInfo *application.OriginInfo) { + var cmd Command + if err := json.Unmarshal([]byte(message), &cmd); err != nil { + window.EmitEvent("error", map[string]string{"error": err.Error()}) + return + } + + switch cmd.Type { + case "ping": + window.EmitEvent("pong", map[string]any{ + "time": time.Now().UnixMilli(), + "window": window.Name(), + }) + case "echo": + var text string + json.Unmarshal(cmd.Data, &text) + window.EmitEvent("echo", text) + default: + window.EmitEvent("error", map[string]string{ + "error": fmt.Sprintf("unknown command: %s", cmd.Type), + }) + } + }, + }) + + app.Window.NewWithOptions(application.WebviewWindowOptions{ + Title: "Raw Message Demo", + Name: "main", + Width: 400, + Height: 300, + }) + + app.Run() +} +``` + +### assets/index.html + +```html + + + + Raw Message Demo + + + +

      Raw Message Demo

      + + + + +
      Waiting for response...
      + + + + +``` + +## Best Practices + +### Do + +- Use raw messages for genuinely performance-critical paths +- Implement proper error handling in your handler +- Use events to send responses back to the frontend +- Consider JSON for structured data +- Keep message processing fast to avoid blocking + +### Don't + +- Use raw messages when service bindings would suffice +- Forget to validate incoming messages +- Block in the handler with long-running operations (use goroutines) +- Ignore the window parameter when responses need to target specific windows + +## Multi-Window Considerations + +The `window` parameter identifies which window sent the message, allowing you to: + +- Send responses to the correct window +- Implement window-specific behavior +- Track message sources for debugging + +```go +RawMessageHandler: func(window application.Window, message string, originInfo *application.OriginInfo) { + // Respond only to the sending window + window.EmitEvent("response", result) + + // Or broadcast to all windows + app.Event.Emit("broadcast", result) +} +``` + +## Next Steps + +- [Service Bindings](/features/bindings/services) - Standard approach for most applications +- [Events](/guides/events-reference) - Event system for backend-to-frontend communication +- [Performance](/guides/performance) - General performance optimization diff --git a/docs/src/content/docs/guides/security.mdx b/docs/src/content/docs/guides/security.mdx new file mode 100644 index 000000000..51bc21b3e --- /dev/null +++ b/docs/src/content/docs/guides/security.mdx @@ -0,0 +1,261 @@ +--- +title: Security Best Practices +description: Secure your Wails application +sidebar: + order: 8 +--- + +## Overview + +Security is critical for desktop applications. Follow these practices to keep your application secure. + +## Input Validation + +### Always Validate + +```go +func (s *UserService) CreateUser(email, password string) (*User, error) { + // Validate email + if !isValidEmail(email) { + return nil, errors.New("invalid email") + } + + // Validate password strength + if len(password) < 8 { + return nil, errors.New("password too short") + } + + // Sanitise input + email = strings.TrimSpace(email) + email = html.EscapeString(email) + + // Continue... +} +``` + +### Sanitise HTML + +```go +import "html" + +func (s *Service) SaveComment(text string) error { + // Escape HTML + text = html.EscapeString(text) + + // Validate length + if len(text) > 1000 { + return errors.New("comment too long") + } + + return s.db.Save(text) +} +``` + +## Authentication + +### Secure Password Storage + +```go +import "golang.org/x/crypto/bcrypt" + +func hashPassword(password string) (string, error) { + hash, err := bcrypt.GenerateFromPassword([]byte(password), bcrypt.DefaultCost) + return string(hash), err +} + +func verifyPassword(hash, password string) bool { + err := bcrypt.CompareHashAndPassword([]byte(hash), []byte(password)) + return err == nil +} +``` + +### Session Management + +```go +type Session struct { + UserID int + Token string + ExpiresAt time.Time +} + +func (a *AuthService) CreateSession(userID int) (*Session, error) { + token := generateSecureToken() + + session := &Session{ + UserID: userID, + Token: token, + ExpiresAt: time.Now().Add(24 * time.Hour), + } + + return session, a.saveSession(session) +} +``` + +## Data Protection + +### Encrypt Sensitive Data + +```go +import "crypto/aes" +import "crypto/cipher" + +func encrypt(data []byte, key []byte) ([]byte, error) { + block, err := aes.NewCipher(key) + if err != nil { + return nil, err + } + + gcm, err := cipher.NewGCM(block) + if err != nil { + return nil, err + } + + nonce := make([]byte, gcm.NonceSize()) + return gcm.Seal(nonce, nonce, data, nil), nil +} +``` + +### Secure Storage + +```go +// Use OS keychain for sensitive data +import "github.com/zalando/go-keyring" + +func saveAPIKey(key string) error { + return keyring.Set("myapp", "api_key", key) +} + +func getAPIKey() (string, error) { + return keyring.Get("myapp", "api_key") +} +``` + +## Network Security + +### Use HTTPS + +```go +func makeAPICall(url string) (*Response, error) { + // Always use HTTPS + if !strings.HasPrefix(url, "https://") { + return nil, errors.New("only HTTPS allowed") + } + + return http.Get(url) +} +``` + +### Verify Certificates + +```go +import "crypto/tls" + +func secureClient() *http.Client { + return &http.Client{ + Transport: &http.Transport{ + TLSClientConfig: &tls.Config{ + MinVersion: tls.VersionTLS12, + }, + }, + } +} +``` + +## File Operations + +### Validate Paths + +```go +func readFile(path string) ([]byte, error) { + // Prevent path traversal + if strings.Contains(path, "..") { + return nil, errors.New("invalid path") + } + + // Check file exists in allowed directory + absPath, err := filepath.Abs(path) + if err != nil { + return nil, err + } + + if !strings.HasPrefix(absPath, allowedDir) { + return nil, errors.New("access denied") + } + + return os.ReadFile(absPath) +} +``` + +## Rate Limiting + +```go +type RateLimiter struct { + requests map[string][]time.Time + mu sync.Mutex + limit int + window time.Duration +} + +func (r *RateLimiter) Allow(key string) bool { + r.mu.Lock() + defer r.mu.Unlock() + + now := time.Now() + + // Clean old requests + var recent []time.Time + for _, t := range r.requests[key] { + if now.Sub(t) < r.window { + recent = append(recent, t) + } + } + + if len(recent) >= r.limit { + return false + } + + r.requests[key] = append(recent, now) + return true +} +``` + +## Best Practices + +### ✅ Do + +- Validate all input +- Use HTTPS for network calls +- Encrypt sensitive data +- Use secure password hashing +- Implement rate limiting +- Keep dependencies updated +- Log security events +- Use OS keychains + +### ❌ Don't + +- Don't trust user input +- Don't store passwords in plain text +- Don't hardcode secrets +- Don't skip certificate verification +- Don't expose sensitive data in logs +- Don't use weak encryption +- Don't ignore security updates + +## Security Checklist + +- [ ] All user input validated +- [ ] Passwords hashed with bcrypt +- [ ] Sensitive data encrypted +- [ ] HTTPS used for all network calls +- [ ] Rate limiting implemented +- [ ] File paths validated +- [ ] Dependencies up to date +- [ ] Security logging enabled +- [ ] Error messages don't leak info +- [ ] Code reviewed for vulnerabilities + +## Next Steps + +- [Architecture](/guides/architecture) - Application architecture patterns +- [Best Practices](/features/bindings/best-practices) - Bindings best practices diff --git a/docs/src/content/docs/guides/server-build.mdx b/docs/src/content/docs/guides/server-build.mdx new file mode 100644 index 000000000..d0a9bcd73 --- /dev/null +++ b/docs/src/content/docs/guides/server-build.mdx @@ -0,0 +1,353 @@ +--- +title: Server Build +description: Run Wails applications as HTTP servers without a native GUI window +sidebar: + order: 52 + badge: + text: Experimental + variant: caution +--- + +import { Aside } from '@astrojs/starlight/components'; + + + +Wails v3 supports server mode, allowing you to run your application as a pure HTTP server without creating native windows or requiring GUI dependencies. This enables deploying the same Wails application to servers, containers, and web browsers. + +## Overview + +Server mode is useful for: + +- **Docker/Container deployments** - Run without X11/Wayland dependencies +- **Server-side applications** - Deploy as a web server accessible via browser +- **Web-only access** - Share the same codebase between desktop and web +- **CI/CD testing** - Run integration tests without a display server +- **Microservices** - Use Wails bindings in headless backend services + +## Quick Start + +Server mode is enabled via the `server` build tag. Your application code remains the same - you just build with the tag: + +```bash +# Using Taskfile (recommended) +wails3 task build:server +wails3 task run:server + +# Or build directly with Go +go build -tags server -o myapp-server . +``` + +Here's a minimal example: + +```go +package main + +import ( + "embed" + "log" + + "github.com/wailsapp/wails/v3/pkg/application" +) + +//go:embed frontend/dist +var assets embed.FS + +func main() { + app := application.New(application.Options{ + Name: "My App", + // Server options are used when built with -tags server + Server: application.ServerOptions{ + Host: "localhost", + Port: 8080, + }, + Services: []application.Service{ + application.NewService(&MyService{}), + }, + Assets: application.AssetOptions{ + Handler: application.AssetFileServerFS(assets), + }, + }) + + log.Println("Starting application...") + if err := app.Run(); err != nil { + log.Fatal(err) + } +} +``` + +The same code can be built for desktop (without the tag) or server mode (with `-tags server`). + +## Configuration + +### ServerOptions + +Configure the HTTP server with `ServerOptions`: + +```go +Server: application.ServerOptions{ + // Host to bind to. Default: "localhost" + // Use "0.0.0.0" to listen on all interfaces + Host: "localhost", + + // Port to listen on. Default: 8080 + Port: 8080, + + // Request read timeout. Default: 30s + ReadTimeout: 30 * time.Second, + + // Response write timeout. Default: 30s + WriteTimeout: 30 * time.Second, + + // Idle connection timeout. Default: 120s + IdleTimeout: 120 * time.Second, + + // Graceful shutdown timeout. Default: 30s + ShutdownTimeout: 30 * time.Second, + + // TLS configuration (optional) + TLS: &application.TLSOptions{ + CertFile: "/path/to/cert.pem", + KeyFile: "/path/to/key.pem", + }, +}, +``` + +## Features + +### Health Check Endpoint + +A health check endpoint is automatically available at `/health`: + +```bash +curl http://localhost:8080/health +# {"status":"ok"} +``` + +This is useful for: +- Kubernetes liveness/readiness probes +- Load balancer health checks +- Monitoring systems + +### Service Bindings + +All service bindings work identically to desktop mode: + +```go +type GreetService struct{} + +func (g *GreetService) Greet(name string) string { + return "Hello, " + name + "!" +} + +// Register in options +Services: []application.Service{ + application.NewService(&GreetService{}), +}, +``` + +The frontend can call these bindings using the standard Wails runtime: + +```javascript +const greeting = await wails.Call.ByName('main.GreetService.Greet', 'World'); +``` + +### Events + +Events work bidirectionally in server mode: + +- **Frontend to Backend**: Events emitted from the browser are sent via HTTP and received by your Go event handlers +- **Backend to Frontend**: Events emitted from Go are broadcast to all connected browsers via WebSocket + +Each browser tab is represented as a "window" with a unique name (`browser-1`, `browser-2`, etc.), accessible via `event.Sender`: + +```go +// Listen for events from browsers +app.Event.On("user-action", func(event *application.CustomEvent) { + log.Printf("Event from %s: %v", event.Sender, event.Data) + // event.Sender will be "browser-1", "browser-2", etc. +}) + +// Emit events to all connected browsers +app.Event.Emit("server-update", data) +``` + +From the frontend: + +```javascript +// Emit event to server (and all other browsers) +await wails.Events.Emit('user-action', { action: 'click' }); + +// Listen for events from server +wails.Events.On('server-update', (event) => { + console.log('Update from server:', event.data); +}); +``` + +### Graceful Shutdown + +The server handles `SIGINT` and `SIGTERM` signals gracefully: + +1. Stops accepting new connections +2. Waits for active requests to complete (up to `ShutdownTimeout`) +3. Runs `OnShutdown` hooks +4. Shuts down services in reverse order + +## Differences from Desktop Mode + +| Feature | Desktop Mode | Server Mode | +|---------|-------------|-------------| +| Native windows | Created | Browser windows (`browser-N`) | +| System tray | Available | Not available | +| Native dialogs | Available | Not available | +| Application menu | Available | Not available | +| Screen info | Available | Returns error | +| Service bindings | Works | Works | +| Events | Works | Works (via WebSocket) | +| Assets | Via webview | Via HTTP | +| CGO required | Yes | No | + +### Window API Behavior + +In server mode, window-related APIs are safely handled: + +- `app.Window.NewWithOptions()` - Logs a warning, returns nil +- `app.Hide()` / `app.Show()` - No-op +- `app.Screen.GetPrimary()` - Returns error + +This allows code that references windows to run without crashing, though window operations have no effect. + +## Building for Production + +### Using Task (Recommended) + +Projects created with `wails3 init` include a `build:server` task: + +```bash +# Build for server mode +wails3 task build:server + +# Build and run +wails3 task run:server +``` + +### Manual Build + +```bash +# Build with server mode +go build -tags server -o myapp-server . +``` + +### Docker + +Wails projects include a ready-to-use Docker setup. To build and run your application in a container: + +```bash +# Build the Docker image +wails3 task build:docker + +# Run it +wails3 task run:docker +``` + +That's it! Your application will be available at `http://localhost:8080`. + +You can customise the build with a few options: + +```bash +# Use a custom image tag +wails3 task build:docker TAG=myapp:v1.0.0 + +# Run on a different port +wails3 task run:docker PORT=3000 +``` + +The generated `Dockerfile.server` creates a minimal image based on distroless. It handles the network binding automatically, so your application will be accessible from outside the container. + +### Docker Compose + +For more complex deployments, here's a Docker Compose configuration with health checks: + +```yaml +services: + app: + build: . + ports: + - "8080:8080" + environment: + - WAILS_SERVER_HOST=0.0.0.0 + healthcheck: + test: ["CMD", "wget", "-q", "--spider", "http://localhost:8080/health"] + interval: 30s + timeout: 10s + retries: 3 +``` + +:::note +The healthcheck example uses `wget`. If you're using a distroless base image, you'll need to either include a healthcheck binary in your image or use an external health check mechanism (e.g., Docker's `curl` option or a sidecar container). +::: + +### Custom Dockerfile + +If you need more control, you can create your own Dockerfile. The key thing to remember is setting `WAILS_SERVER_HOST=0.0.0.0` so the server accepts connections from outside the container: + +```dockerfile +# Build stage +FROM golang:alpine AS builder +WORKDIR /app +RUN apk add --no-cache git +COPY . . +RUN go mod tidy +RUN go build -tags server -ldflags="-s -w" -o server . + +# Runtime stage +FROM gcr.io/distroless/static-debian12 +COPY --from=builder /app/server /server +COPY --from=builder /app/frontend/dist /frontend/dist +EXPOSE 8080 +ENV WAILS_SERVER_HOST=0.0.0.0 +ENTRYPOINT ["/server"] +``` + +## Security Considerations + +When deploying server mode applications: + +1. **Bind to localhost by default** - Only use `0.0.0.0` when needed +2. **Use TLS in production** - Configure `ServerOptions.TLS` +3. **Place behind reverse proxy** - Use nginx/traefik for additional security +4. **Validate all inputs** - Same security practices as any web application + +## Example + +A complete example is available at `v3/examples/server/`: + +```bash +cd v3/examples/server + +# Using Taskfile +task dev + +# Or run directly +go run -tags server . + +# Open http://localhost:8080 in browser +``` + +## Environment Variables + +For deployment scenarios where you need to override the server configuration without changing code, Wails recognises these environment variables: + +| Variable | Description | Default | +|----------|-------------|---------| +| `WAILS_SERVER_HOST` | Network interface to bind to | `localhost` | +| `WAILS_SERVER_PORT` | Port to listen on | `8080` | + +These take precedence over the `ServerOptions` in your code, which is why the Docker examples set `WAILS_SERVER_HOST=0.0.0.0` - it allows the container to accept external connections without requiring any changes to your application. + +## See Also + +- [Custom Transport](/docs/guides/custom-transport) - For advanced IPC customization +- [Services](/docs/concepts/services) - Service binding documentation +- [Events](/docs/guides/events-reference) - Event system documentation diff --git a/docs/src/content/docs/guides/single-instance.mdx b/docs/src/content/docs/guides/single-instance.mdx new file mode 100644 index 000000000..25b7fac47 --- /dev/null +++ b/docs/src/content/docs/guides/single-instance.mdx @@ -0,0 +1,119 @@ +--- +title: Single Instance +description: Limiting your app to a single running instance +sidebar: + order: 40 +--- + +import { Tabs, TabItem } from "@astrojs/starlight/components"; + +Single instance locking is a mechanism that prevents multiple instances of your app from running at the same time. +It is useful for apps that are designed to open files from the command line or from the OS file explorer. + + +## Usage + +To enable single instance functionality in your app, provide a `SingleInstanceOptions` struct when creating your application: + +```go +app := application.New(application.Options{ + // ... other options ... + SingleInstance: &application.SingleInstanceOptions{ + UniqueID: "com.myapp.unique-id", + OnSecondInstanceLaunch: func(data application.SecondInstanceData) { + log.Printf("Second instance launched with args: %v", data.Args) + log.Printf("Working directory: %s", data.WorkingDir) + log.Printf("Additional data: %v", data.AdditionalData) + }, + // Optional: Pass additional data to second instance + AdditionalData: map[string]string{ + "launchtime": time.Now().String(), + }, + }, +}) +``` + +The `SingleInstanceOptions` struct has the following fields: + +- `UniqueID`: A unique identifier for your application. This should be a unique string, typically in reverse domain notation (e.g., "com.company.appname"). +- `EncryptionKey`: Optional 32-byte array for encrypting data passed between instances using AES-256-GCM. If provided as a non-zero array, all communication between instances will be encrypted. +- `OnSecondInstanceLaunch`: A callback function that is called when a second instance of your app is launched. The callback receives a `SecondInstanceData` struct containing: + - `Args`: The command line arguments passed to the second instance + - `WorkingDir`: The working directory of the second instance + - `AdditionalData`: Any additional data passed from the second instance (if provided) +- `AdditionalData`: Optional map of string key-value pairs that will be passed to the first instance when subsequent instances are launched + +:::danger[Warning] +The Single Instance feature implements an optional encryption protocol using AES-256-GCM. Without encryption enabled, +data passed between instances is not secure. When using the single instance feature without encryption, +your app should treat any data passed to it from second instance callback as untrusted. +You should verify that args that you receive are valid and don't contain any malicious data. +::: + +### Secure Communication + +To enable secure communication between instances, provide a 32-byte encryption key. This key must be the same for all instances of your application: + +```go +// Define your encryption key (must be exactly 32 bytes) +var encryptionKey = [32]byte{ + 0x00, 0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07, + 0x08, 0x09, 0x0a, 0x0b, 0x0c, 0x0d, 0x0e, 0x0f, + 0x10, 0x11, 0x12, 0x13, 0x14, 0x15, 0x16, 0x17, + 0x18, 0x19, 0x1a, 0x1b, 0x1c, 0x1d, 0x1e, 0x1f, +} + +// Use the key in SingleInstanceOptions +SingleInstance: &application.SingleInstanceOptions{ + UniqueID: "com.myapp.unique-id", + // Enable encryption for instance communication + EncryptionKey: encryptionKey, + // ... other options ... +} +``` + +:::tip[Security Best Practices] +- Use a unique key for your application +- Store the key securely if loading it from configuration +- Do not use the example key shown above - create your own! +::: + +### Window Management + +When handling second instance launches, you'll often want to bring your application window to the front. You can do this using the window's `Focus()` method. If your window is minimized, you may need to restore it first: + +```go + + var mainWindow *application.WebviewWindow + + SingleInstance: &application.SingleInstanceOptions{ + // Other options... + OnSecondInstanceLaunch: func(data application.SecondInstanceData) { + // Focus the window if needed + if mainWindow != nil { + mainWindow.Restore() + mainWindow.Focus() + } + }, + } +``` + +## How it works + + + + + Single instance lock using a named mutex. The mutex name is generated from the unique id that you provide. Data is passed to the first instance via [NSDistributedNotificationCenter](https://developer.apple.com/documentation/foundation/nsdistributednotificationcenter) + + + + + Single instance lock using a named mutex. The mutex name is generated from the unique id that you provide. Data is passed to the first instance via a shared window using [SendMessage](https://learn.microsoft.com/en-us/windows/win32/api/winuser/nf-winuser-sendmessage) + + + + + Single instance lock using [dbus](https://www.freedesktop.org/wiki/Software/dbus/). The dbus name is generated from the unique id that you provide. Data is passed to the first instance via [dbus](https://www.freedesktop.org/wiki/Software/dbus/) + + + diff --git a/docs/src/content/docs/guides/testing.mdx b/docs/src/content/docs/guides/testing.mdx new file mode 100644 index 000000000..4bd3a07b8 --- /dev/null +++ b/docs/src/content/docs/guides/testing.mdx @@ -0,0 +1,175 @@ +--- +title: Testing +description: Test your Wails application +sidebar: + order: 5 +--- + +## Overview + +Testing ensures your application works correctly and prevents regressions. + +## Unit Testing + +### Testing Services + +```go +func TestUserService_Create(t *testing.T) { + service := &UserService{ + users: make(map[string]*User), + } + + user, err := service.Create("john@example.com", "password123") + if err != nil { + t.Fatalf("unexpected error: %v", err) + } + + if user.Email != "john@example.com" { + t.Errorf("expected email john@example.com, got %s", user.Email) + } +} +``` + +### Testing with Mocks + +```go +type MockDB struct { + users map[string]*User +} + +func (m *MockDB) Create(user *User) error { + m.users[user.ID] = user + return nil +} + +func TestUserService_WithMock(t *testing.T) { + mockDB := &MockDB{users: make(map[string]*User)} + service := &UserService{db: mockDB} + + user, err := service.Create("test@example.com", "pass") + if err != nil { + t.Fatal(err) + } + + if len(mockDB.users) != 1 { + t.Error("expected 1 user in mock") + } +} +``` + +## Integration Testing + +### Testing with Real Dependencies + +```go +func TestIntegration(t *testing.T) { + // Setup test database + db, err := sql.Open("sqlite3", ":memory:") + if err != nil { + t.Fatal(err) + } + defer db.Close() + + // Create schema + _, err = db.Exec(`CREATE TABLE users (...)`) + if err != nil { + t.Fatal(err) + } + + // Test service + service := &UserService{db: db} + user, err := service.Create("test@example.com", "password") + if err != nil { + t.Fatal(err) + } + + // Verify in database + var count int + db.QueryRow("SELECT COUNT(*) FROM users").Scan(&count) + if count != 1 { + t.Errorf("expected 1 user, got %d", count) + } +} +``` + +## Frontend Testing + +### JavaScript Unit Tests + +```javascript +// Using Vitest +import { describe, it, expect } from 'vitest' +import { formatDate } from './utils' + +describe('formatDate', () => { + it('formats date correctly', () => { + const date = new Date('2024-01-01') + expect(formatDate(date)).toBe('2024-01-01') + }) +}) +``` + +### Testing Bindings + +```javascript +import { vi } from 'vitest' +import { GetUser } from './bindings/myapp/userservice' + +// Mock the binding +vi.mock('./bindings/myapp/userservice', () => ({ + GetUser: vi.fn() +})) + +describe('User Component', () => { + it('loads user data', async () => { + GetUser.mockResolvedValue({ name: 'John', email: 'john@example.com' }) + + // Test your component + const user = await GetUser(1) + expect(user.name).toBe('John') + }) +}) +``` + +## Best Practices + +### ✅ Do + +- Write tests before fixing bugs +- Test edge cases +- Use table-driven tests +- Mock external dependencies +- Test error handling +- Keep tests fast + +### ❌ Don't + +- Don't skip error cases +- Don't test implementation details +- Don't write flaky tests +- Don't ignore test failures +- Don't skip integration tests + +## Running Tests + +```bash +# Run Go tests +go test ./... + +# Run with coverage +go test -cover ./... + +# Run specific test +go test -run TestUserService + +# Run frontend tests +cd frontend && npm test + +# Run with watch mode +cd frontend && npm test -- --watch +``` + +## Next Steps + +- [End-to-End Testing](/guides/e2e-testing) - Test complete user flows +- [Best Practices](/features/bindings/best-practices) - Learn best practices diff --git a/docs/src/content/docs/guides/windows-uac.mdx b/docs/src/content/docs/guides/windows-uac.mdx new file mode 100644 index 000000000..5bb380179 --- /dev/null +++ b/docs/src/content/docs/guides/windows-uac.mdx @@ -0,0 +1,151 @@ +--- +title: Windows UAC Configuration +sidebar: + order: 11 +--- + +import {Badge} from '@astrojs/starlight/components'; + +Relevant Platforms: +
      + +Windows User Account Control (UAC) determines the execution privileges of your Wails application. By default, Wails v3 applications include explicit UAC configuration in their Windows manifest, ensuring consistent behavior across different machines. + +## UAC Execution Levels + +Windows applications can request different execution levels through their manifest file. Wails v3 automatically includes UAC configuration with a default execution level that you can customize based on your application's needs. + +### Available Execution Levels + +| Level | Description | Use Case | +|-------|-------------|----------| +| `asInvoker` | Runs with the same privileges as the parent process | Default for most applications | +| `highestAvailable` | Runs with the highest privileges available to the user | Applications that may need elevated access | +| `requireAdministrator` | Always requires administrator privileges | System utilities, installers | + +### Default Configuration + +Wails v3 applications include a default UAC configuration in their Windows manifest: + +```xml + + + + + + + +``` + +This configuration ensures your application: +- Runs with the same privileges as the launching process +- Does not require elevation by default +- Works consistently across different machines +- Does not trigger UAC prompts for normal users + +## Customizing UAC Configuration + +Since Wails v3 encourages users to customize their build assets, you can modify the UAC configuration by editing your Windows manifest template directly. + +### Locating the Manifest Template + +The Windows manifest template is located at: +``` +build/windows/wails.exe.manifest +``` + +### Modifying the Execution Level + +To change the execution level, edit the `level` attribute in the `requestedExecutionLevel` element: + +```xml title="build/windows/wails.exe.manifest" + + + + + + + +``` + +### Examples + +#### Standard Application (Default) +Most applications should use the default `asInvoker` level: + +```xml + +``` + +#### System Utility +Applications that need elevated access when available: + +```xml + +``` + +#### Administrative Tool +Applications that always require administrator privileges: + +```xml + +``` + +## UI Access + +The `uiAccess` attribute controls whether your application can interact with higher-privilege UI elements. In most cases, this should remain `false`. + +Set to `true` only if your application needs to: +- Send input to other applications +- Drive the UI of other applications +- Access UI elements of higher-privilege processes + +:::caution[UI Access Requirements] +Setting `uiAccess="true"` requires your application to be: +- Digitally signed with a certificate from a trusted certificate authority +- Installed in a secure location (Program Files or Windows\System32) +::: + +## Building with Custom UAC Settings + +After modifying your manifest template, build your application normally: + +```bash +wails3 build +``` + +The build process will automatically embed your custom UAC configuration into the executable. + +## Verifying UAC Configuration + +You can verify that your UAC settings are properly embedded using the `go-winres` tool: + +```bash +go-winres extract --in your-app.exe --out extracted-resources/ +``` + +Then examine the extracted manifest file to confirm your UAC configuration is present. + +:::tip[Manifest Persistence] +Unlike some other frameworks, Wails v3's UAC configuration is embedded directly into the executable during compilation, ensuring it persists when the application is copied to other machines. +::: + +## Troubleshooting + +### UAC Prompts Not Appearing +If you set `requireAdministrator` but don't see UAC prompts: +- Verify the manifest is properly embedded in your executable +- Check that you're not running from an already-elevated process +- Ensure the manifest syntax is valid XML + +### Application Not Starting +If your application fails to start after UAC changes: +- Check the manifest syntax for XML errors +- Verify the execution level value is valid +- Try reverting to `asInvoker` to isolate the issue + +### Inconsistent Behavior Across Machines +If UAC behavior differs between machines: +- Ensure the manifest is embedded in the executable (not external) +- Check that the executable wasn't modified after building +- Verify Windows UAC settings are enabled on the target machine \ No newline at end of file diff --git a/docs/src/content/docs/index.mdx b/docs/src/content/docs/index.mdx new file mode 100644 index 000000000..c5f1c8790 --- /dev/null +++ b/docs/src/content/docs/index.mdx @@ -0,0 +1,294 @@ +--- +title: Build Desktop Apps with Go +description: "Native desktop applications using Go and web technologies" +banner: + content: | + Wails v3 is in ALPHA. v2 docs +template: splash +hero: + tagline: Build beautiful, performant desktop applications using Go and modern web technologies. One codebase. Three platforms. No browsers. + image: + dark: ../../assets/wails-logo-dark.svg + light: ../../assets/wails-logo-light.svg + alt: Wails Logo + actions: + - text: Get Started + link: /quick-start/installation + icon: right-arrow + variant: primary + - text: View Tutorial + link: /tutorials/03-notes-vanilla + icon: open-book + variant: secondary +--- +{/* Updated 2025-11-23 */} +import { Tabs, TabItem, Card, CardGrid } from "@astrojs/starlight/components"; + + + +## Quickstart + + + +```bash +# Install Wails +go install github.com/wailsapp/wails/v3/cmd/wails3@latest + +# Create your application +wails3 init -n myapp -t vanilla + +# Run with hot reload +cd myapp && wails3 dev +``` + + + +```powershell +# Install Wails +go install github.com/wailsapp/wails/v3/cmd/wails3@latest + +# Create your application +wails3 init -n myapp -t vanilla + +# Run with hot reload +cd myapp; wails3 dev +``` + + + +```bash +# Install Wails +go install github.com/wailsapp/wails/v3/cmd/wails3@latest + +# Create your application +wails3 init -n myapp -t vanilla + +# Run with hot reload +cd myapp && wails3 dev +``` + + + +**Your application is now running** with hot reload and type-safe Go-to-JS bindings. + + +## Why Wails? + + + + - ~15MB binaries vs Electron's 150MB + - ~10MB baseline memory vs 100MB+ + - <0.5s startup time vs 2-3s + - Native rendering using OS WebView + - No bundled browser overhead + + + + - One Go codebase for all platforms + - Any web framework - React, Vue, Svelte + - Hot reload during development + - Auto-generated bindings to easily call Go from Javascript + - In-memory IPC. No network ports + + + + - Multiple windows with lifecycles + - Native menus and system tray + - Platform-native file dialogs + - System integration and shortcuts + - Code signing and packaging tools + + + + - Single codebase for Windows, macOS, Linux + - Platform-specific features when needed + - No compromise on user experience + - Deploy to all platforms from one build + - Mobile coming soon... + + + + + + +## Next Steps + +Next: [Build a complete application](/tutorials/03-notes-vanilla), browse [examples](https://github.com/wailsapp/wails/tree/v3-alpha/v3/examples), or check the [API reference](/reference/application). Migrating from v2? See the [upgrade guide](/migration/v2-to-v3). + + +:::note[Production Ready] +Wails v3 is in **ALPHA**. The API is *reasonably* stable, and applications are running in production. We're refining documentation and tooling before the final release. +::: + + + Wails is free and open source, built by developers for developers. If Wails helps you build amazing applications, consider supporting its continued development. + + Your sponsorship helps maintain the project, improve documentation, and develop new features that benefit the entire community. + + [Become a Sponsor →](https://github.com/sponsors/leaanthony) + + diff --git a/docs/src/content/docs/migration/v2-to-v3.mdx b/docs/src/content/docs/migration/v2-to-v3.mdx new file mode 100644 index 000000000..5eb94ca67 --- /dev/null +++ b/docs/src/content/docs/migration/v2-to-v3.mdx @@ -0,0 +1,727 @@ +--- +title: Migrating from v2 to v3 +description: Complete guide to migrating your Wails v2 application to v3 +sidebar: + order: 1 +--- + +import { Card, CardGrid, Tabs, TabItem } from "@astrojs/starlight/components"; + +Wails v3 is a **complete rewrite** with significant improvements in architecture, performance, and developer experience. This guide helps you migrate your v2 application to v3. + +**Key changes:** +- New application structure +- Improved bindings system +- Enhanced window management +- Better event system +- Simplified configuration + +**Migration time:** 1-4 hours for typical applications + +## Breaking Changes + +### Application Initialisation + +In v2, application setup, window configuration, and execution were all combined into a single `wails.Run()` call. This monolithic approach made it difficult to create multiple windows, handle errors at different stages, or test individual components of your application. + +v3 separates these concerns into distinct phases: application creation, window creation, and execution. This separation gives you explicit control over each stage of your application's lifecycle and makes the code more modular and testable. + +**v2:** + +```go +err := wails.Run(&options.App{ + Title: "My App", + Width: 1024, + Height: 768, + Bind: []interface{}{ + &GreetService{}, + }, +}) +``` + +**v3:** + +```go +app := application.New(application.Options{ + Name: "My App", + Services: []application.Service{ + application.NewService(&GreetService{}), + }, +}) + +window := app.Window.NewWithOptions(application.WebviewWindowOptions{ + Title: "My App", + Width: 1024, + Height: 768, +}) + +app.Run() +``` + +**Why this is better:** + +- **Multi-window support**: You can create windows dynamically at any point, not just at startup +- **Better error handling**: Each phase can be validated separately with proper error handling +- **Clearer code**: The separation makes it obvious what's happening at each stage +- **More testable**: You can test application setup without running the event loop +- **More flexible**: Windows can be created, destroyed, and recreated throughout the application lifecycle + +### Bindings + +In v2, every bound struct required a context field and a `startup(ctx)` method to receive the runtime context. This created tight coupling between your business logic and the Wails runtime, making code harder to test and understand. + +v3 introduces the service pattern, where your structs are completely standalone and don't need to store runtime context. If a service needs access to the application instance, it explicitly receives it through dependency injection rather than implicit context threading. + +**v2:** + +```go +type App struct { + ctx context.Context +} + +func (a *App) startup(ctx context.Context) { + a.ctx = ctx +} + +func (a *App) Greet(name string) string { + return "Hello " + name +} +``` + +**v3:** + +```go +type GreetService struct{} + +func (g *GreetService) Greet(name string) string { + return "Hello " + name +} + +// Register as service +app := application.New(application.Options{ + Services: []application.Service{ + application.NewService(&GreetService{}), + }, +}) +``` + +**Why this is better:** + +- **No implicit dependencies**: Services are plain Go structs without hidden runtime dependencies +- **Easier testing**: You can test service methods without mocking a Wails context +- **Clearer code**: Dependencies are explicit (passed as constructor arguments) rather than hidden in a context field +- **Better organization**: Services can be grouped by domain rather than all living in a single `App` struct +- **Proper initialization**: Use `ServiceStartup()` method when you need initialization, making it explicit + +### Runtime + +In v2, all runtime operations required passing a context to global functions from the `runtime` package. This created tight coupling to the context object throughout your codebase and made the API feel procedural rather than object-oriented. + +v3 replaces the context-based runtime with direct method calls on application and window objects. Operations are called directly on the objects they affect, making the code more intuitive and object-oriented. + +**v2:** + +```go +import "github.com/wailsapp/wails/v2/pkg/runtime" + +runtime.WindowSetTitle(a.ctx, "New Title") +runtime.EventsEmit(a.ctx, "event-name", data) +``` + +**v3:** + +```go +// Store app reference +type MyService struct { + app *application.Application +} + +func (s *MyService) UpdateTitle() { + window := s.app.Window.Current() + window.SetTitle("New Title") +} + +func (s *MyService) EmitEvent() { + s.app.Event.Emit("event-name", data) +} +``` + +**Why this is better:** + +- **Object-oriented design**: Methods are called on the objects they affect (window, app, menu, etc.) +- **Clearer intent**: `window.SetTitle()` is more obvious than `runtime.WindowSetTitle(ctx, ...)` +- **Better IDE support**: Autocomplete works properly when methods are on objects +- **Multi-window clarity**: With multiple windows, you explicitly choose which window to operate on +- **No context threading**: You don't need to pass context through every function + +### Frontend Bindings + +In v2, bindings were organized by Go package and struct name, typically resulting in paths like `wailsjs/go/main/App`. This structure didn't reflect logical grouping and made it hard to find related functionality. + +v3 organizes bindings by service name and application module, creating a clearer logical structure. The bindings are generated into a `bindings` directory organized by your application name and service names, making it easier to understand what functionality is available. + +**v2:** + +```javascript +import { Greet } from '../wailsjs/go/main/App' + +const result = await Greet("World") +``` + +**v3:** + +```javascript +import { Greet } from './bindings/myapp/greetservice' + +const result = await Greet("World") +``` + +**Why this is better:** + +- **Logical organization**: Bindings are grouped by service name rather than Go package structure +- **Clearer imports**: The path reflects the domain logic (greetservice) not the file structure (main/App) +- **Better discoverability**: You can navigate bindings by feature rather than by technical structure +- **Consistent naming**: Service-based organization matches your backend architecture +- **Simpler paths**: No more `../wailsjs/go` prefix - just `./bindings` + +### Events + +In v2, events used variadic `interface{}` parameters and required passing context to every event function. Event handlers received untyped data that needed manual type assertions, making the event system error-prone and hard to debug. + +v3 introduces typed event objects and removes the context requirement. Event handlers receive a proper event object with typed data, making the event system more reliable and easier to use. + +**v2:** + +```go +runtime.EventsOn(ctx, "event-name", func(data ...interface{}) { + // Handle event +}) + +runtime.EventsEmit(ctx, "event-name", data) +``` + +**v3:** + +```go +app.Event.On("event-name", func(e *application.CustomEvent) { + data := e.Data + // Handle event +}) + +app.Event.Emit("event-name", data) +``` + +**Why this is better:** + +- **Type safety**: Events use proper event objects instead of `...interface{}` +- **Better debugging**: Event objects contain metadata like event name, making debugging easier +- **Clearer API**: `app.Event.On()` and `app.Event.Emit()` are more intuitive than runtime functions +- **No context needed**: Events work directly on the app object without threading context +- **Simpler handlers**: Event handlers have a clear signature instead of variadic parameters + +### Windows + +v2 supported only a single window per application. The window was created at startup and all window operations were performed through runtime functions that implicitly targeted that single window. + +v3 introduces native multi-window support as a core feature. Each window is a first-class object with its own methods and lifecycle. You can create, manage, and destroy multiple windows dynamically throughout your application's lifetime. + +**v2:** + +```go +// Single window only +runtime.WindowSetSize(ctx, 800, 600) +``` + +**v3:** + +```go +// Multiple windows supported +window1 := app.Window.New() +window1.SetSize(800, 600) + +window2 := app.Window.New() +window2.SetSize(1024, 768) +``` + +**Why this is better:** + +- **Multi-window applications**: Build apps with multiple independent windows (dashboards, preferences, tools, etc.) +- **Explicit window references**: Each window is an object you can store and manipulate directly +- **Dynamic window creation**: Create and destroy windows at any time during runtime +- **Independent window state**: Each window has its own events, properties, and lifecycle +- **Better architecture**: Window management is object-oriented rather than context-based + +## Migration Steps + +### Step 1: Update Dependencies + +**go.mod:** + +```go +module myapp + +go 1.21 + +require ( + github.com/wailsapp/wails/v3 v3.0.0-alpha.1 +) +``` + +**Update:** + +```bash +go get github.com/wailsapp/wails/v3@latest +go mod tidy +``` + +### Step 2: Update main.go + +**v2:** + +```go +package main + +import ( + "embed" + "github.com/wailsapp/wails/v2/pkg/options" + "github.com/wailsapp/wails/v2/pkg/options/assetserver" + "github.com/wailsapp/wails/v2/pkg/options/windows" +) + +//go:embed all:frontend/dist +var assets embed.FS + +func main() { + app := NewApp() + + err := wails.Run(&options.App{ + Title: "My App", + Width: 1024, + Height: 768, + AssetServer: &assetserver.Options{ + Assets: assets, + }, + Bind: []interface{}{ + app, + }, + Windows: &windows.Options{ + WebviewIsTransparent: false, + }, + }) + + if err != nil { + println("Error:", err.Error()) + } +} +``` + +**v3:** + +```go +package main + +import ( + "embed" + "github.com/wailsapp/wails/v3/pkg/application" +) + +//go:embed frontend/dist +var assets embed.FS + +func main() { + app := application.New(application.Options{ + Name: "My App", + Services: []application.Service{ + application.NewService(&MyService{}), + }, + Assets: application.AssetOptions{ + Handler: application.AssetFileServerFS(assets), + }, + }) + + app.Window.NewWithOptions(application.WebviewWindowOptions{ + Title: "My App", + Width: 1024, + Height: 768, + }) + + err := app.Run() + if err != nil { + panic(err) + } +} +``` + +### Step 3: Convert App Struct to Service + +**v2:** + +```go +type App struct { + ctx context.Context +} + +func NewApp() *App { + return &App{} +} + +func (a *App) startup(ctx context.Context) { + a.ctx = ctx + // Initialisation +} + +func (a *App) Greet(name string) string { + return "Hello " + name +} +``` + +**v3:** + +```go +type MyService struct { + app *application.Application +} + +func NewMyService(app *application.Application) *MyService { + return &MyService{app: app} +} + +func (s *MyService) ServiceStartup(ctx context.Context, options application.ServiceOptions) error { + // Initialisation + return nil +} + +func (s *MyService) Greet(name string) string { + return "Hello " + name +} + +// Register after app creation +app := application.New(application.Options{}) +app.RegisterService(application.NewService(NewMyService(app))) +``` + +### Step 4: Update Runtime Calls + +**v2:** + +```go +func (a *App) DoSomething() { + runtime.WindowSetTitle(a.ctx, "New Title") + runtime.EventsEmit(a.ctx, "update", data) + runtime.LogInfo(a.ctx, "Message") +} +``` + +**v3:** + +```go +func (s *MyService) DoSomething() { + window := s.app.Window.Current() + window.SetTitle("New Title") + + s.app.Event.Emit("update", data) + + s.app.Logger.Info("Message") +} +``` + +### Step 5: Update Frontend + +**Generate new bindings:** + +```bash +wails3 generate bindings +``` + +**Update imports:** + +```javascript +// v2 +import { Greet } from '../wailsjs/go/main/App' + +// v3 +import { Greet } from './bindings/myapp/myservice' +``` + +**Update event handling:** + +```javascript +// v2 +import { EventsOn, EventsEmit } from '../wailsjs/runtime/runtime' + +EventsOn("update", (data) => { + console.log(data) +}) + +EventsEmit("action", data) + +// v3 +import { OnEvent, Emit } from '@wailsio/runtime' + +OnEvent("update", (data) => { + console.log(data) +}) + +Emit("action", data) +``` + +### Step 6: Update Configuration + +**v2 (wails.json):** + +```json +{ + "name": "myapp", + "outputfilename": "myapp", + "frontend:install": "npm install", + "frontend:build": "npm run build", + "frontend:dev:watcher": "npm run dev", + "frontend:dev:serverUrl": "auto" +} +``` + +**v3 (wails.json):** + +```json +{ + "name": "myapp", + "frontend": { + "dir": "./frontend", + "install": "npm install", + "build": "npm run build", + "dev": "npm run dev", + "devServerUrl": "http://localhost:5173" + } +} +``` + +## Feature Mapping + +### dialogs + +**v2:** + +```go +selection, err := runtime.OpenFileDialog(ctx, runtime.OpenDialogOptions{ + Title: "Select File", +}) +``` + +**v3:** + +```go +selection, err := app.Dialog.OpenFile(application.OpenFileDialogOptions{ + Title: "Select File", +}) +``` + +### Menus + +**v2:** + +```go +menu := menu.NewMenu() +menu.Append(menu.Text("File", nil, []*menu.MenuItem{ + menu.Text("Quit", nil, func(_ *menu.CallbackData) { + runtime.Quit(ctx) + }), +})) +``` + +**v3:** + +```go +menu := app.NewMenu() +fileMenu := menu.AddSubmenu("File") +fileMenu.Add("Quit").OnClick(func(ctx *application.Context) { + app.Quit() +}) +``` + +### System Tray + +**v2:** + +```go +// Not available in v2 +``` + +**v3:** + +```go +systray := app.SystemTray.New() +systray.SetIcon(iconBytes) +systray.SetLabel("My App") + +menu := app.NewMenu() +menu.Add("Show").OnClick(showWindow) +menu.Add("Quit").OnClick(app.Quit) +systray.SetMenu(menu) +``` + +## Common Issues + +### Issue: Bindings not found + +**Problem:** Import errors after migration + +**Solution:** + +```bash +# Regenerate bindings +wails3 generate bindings + +# Check output directory +ls frontend/bindings +``` + +### Issue: Context errors + +**Problem:** `ctx` not available + +**Solution:** + +Store app reference instead: + +```go +type MyService struct { + app *application.Application +} + +func NewMyService(app *application.Application) *MyService { + return &MyService{app: app} +} +``` + +### Issue: Window methods not working + +**Problem:** `runtime.WindowSetTitle()` doesn't exist + +**Solution:** + +Use window methods directly: + +```go +window := s.app.Window.Current() +window.SetTitle("New Title") +``` + +### Issue: Events not firing + +**Problem:** Events registered but not received + +**Solution:** + +Check event names match exactly: + +```go +// Go +app.Event.Emit("my-event", data) + +// JavaScript +OnEvent("my-event", handler) // Must match exactly +``` + +## Testing Migration + +### Checklist + +- [ ] Application starts without errors +- [ ] All bindings work +- [ ] Events are sent and received +- [ ] Windows open and close correctly +- [ ] Menus work (if applicable) +- [ ] dialogs work (if applicable) +- [ ] System tray works (if applicable) +- [ ] Build process works +- [ ] Production build works + +### Test Commands + +```bash +# Development +wails3 dev + +# Build +wails3 build + +# Generate bindings +wails3 generate bindings +``` + +## Benefits of v3 + +### Performance + +- **Faster startup** - Optimised initialisation +- **Lower memory** - Efficient resource usage +- **Better bridge** - <1ms call overhead + +### Features + +- **Multi-window** - Native support +- **System tray** - Built-in +- **Better events** - Typed, simpler API +- **Services** - Better code organisation + +### Developer Experience + +- **Type safety** - Full TypeScript support +- **Better errors** - Clear error messages +- **Hot reload** - Faster development +- **Better docs** - Comprehensive guides + +## Getting Help + +### Resources + +- [Documentation](/quick-start/why-wails) +- [Discord Community](https://discord.gg/JDdSxwjhGf) +- [GitHub Issues](https://github.com/wailsapp/wails/issues) +- [Examples](https://github.com/wailsapp/wails/tree/v3-alpha/v3/examples) + +### Common Questions + +**Q: Can I run v2 and v3 side by side?** +A: Yes, they use different import paths. + +**Q: Is v3 production-ready?** +A: v3 is in alpha/beta. Test thoroughly before production. + +**Q: Will v2 be maintained?** +A: Yes, v2 will receive critical updates. + +**Q: How long does migration take?** +A: 1-4 hours for typical applications. + +## Next Steps + + + + Get started with Wails v3. + + [Learn More →](/quick-start/installation) + + + + Understand v3 architecture. + + [Learn More →](/concepts/architecture) + + + + Learn the new bindings system. + + [Learn More →](/features/bindings/methods) + + + + See complete v3 examples. + + [View Examples →](https://github.com/wailsapp/wails/tree/v3-alpha/v3/examples) + + + +--- + +**Questions?** Ask in [Discord](https://discord.gg/JDdSxwjhGf) or [open an issue](https://github.com/wailsapp/wails/issues). diff --git a/docs/src/content/docs/quick-start/first-app.mdx b/docs/src/content/docs/quick-start/first-app.mdx new file mode 100644 index 000000000..204fed2f8 --- /dev/null +++ b/docs/src/content/docs/quick-start/first-app.mdx @@ -0,0 +1,270 @@ +--- +title: Your First App +description: Build a working Wails application in 10 minutes +sidebar: + order: 3 +--- + +import { Tabs, TabItem, Steps } from "@astrojs/starlight/components"; + +We will build a simple greeting application that demonstrates the core Wails concepts: +- Go backend managing logic +- Frontend calling Go functions +- Type-safe bindings +- Hot reload during development + +**Time to complete:** 10 minutes + +:::tip[Performance Tip for Windows 11 Users] +Consider using [Dev Drive](https://learn.microsoft.com/en-us/windows/dev-drive/) to store your projects. Dev Drives are optimized for developer workloads and can significantly improve build times and disk access speeds by up to 30% compared to regular NTFS drives. +::: + +## Create Your Project + + + +1. **Generate the project** + + ```bash + wails3 init -n myapp + cd myapp + ``` + + This creates a new project with the default Vanilla + Vite template (plain HTML/CSS/JS with Vite bundler). + + :::tip[Other Templates] + Try `-t react`, `-t vue`, or `-t svelte` for your preferred framework. + Run `wails3 init -l` to see all available templates. + ::: + +2. **Understand the project structure** + + ``` + myapp/ + ├── main.go # Application entry point + ├── greetservice.go # Greet service + ├── frontend/ # Your UI code + │ ├── index.html # HTML entry point + │ ├── src/ + │ │ └── main.js # Frontend JavaScript + │ ├── public/ + │ │ └── style.css # Styles + │ ├── package.json # Frontend dependencies + │ └── vite.config.js # Vite bundler config + ├── build/ # Build configuration + └── Taskfile.yml # Build tasks + ``` + +3. **Run the app** + + ```bash + wails3 dev + ``` + + :::note[First Run] + The first run may take longer than expected as it installs frontend dependencies, generates bindings, etc. Subsequent runs are much faster. + ::: + + The app opens showing a greeting interface. Enter your name and click "Greet" - the Go backend processes your input and returns a greeting. + + + +## How It Works + +Let's understand the code that makes this work. + +### The Go Backend + +Open `greetservice.go`: + +```go title="greetservice.go" +package main + +import ( + "fmt" +) + +type GreetService struct{} + +func (g *GreetService) Greet(name string) string { + return fmt.Sprintf("Hello %s, It's show time!", name) +} +``` + +**Key concepts:** + +1. **Service** - A Go struct with exported methods +2. **Exported method** - `Greet` is capitalized, making it available to the frontend +3. **Simple logic** - Takes a name, returns a greeting +4. **Type safety** - Input and output types are defined + +:::tip[Understanding Services and Bindings] +**Services** are self-contained Go modules that expose functionality to your frontend. They're just regular Go structs with exported methods that you register in the `Services` field of your application config. + +**Bindings** are the auto-generated TypeScript/JavaScript SDK that lets your frontend call these services. When you run `wails3 dev` or `wails3 build`, Wails analyzes your registered services and generates type-safe bindings in `frontend/bindings/`. + +Think of services as your backend API, and bindings as the client library that talks to it. +::: + +### Registering the Service + +Open `main.go` and find the service registration: + +```go title="main.go" {4-6} +err := application.New(application.Options{ + Name: "myapp", + Services: []application.Service{ + application.NewService(&GreetService{}), + }, + // ... other options +}) +``` + +This registers your `GreetService` with Wails, making all its exported methods available to the frontend. + +### The Frontend + +Open `frontend/src/main.js`: + +```javascript title="frontend/src/main.js" +import {GreetService} from "../bindings/changeme"; + +window.greet = async () => { + const nameElement = document.getElementById('name'); + const resultElement = document.getElementById('result'); + + const name = nameElement.value; + if (!name) { + return; + } + + try { + const result = await GreetService.Greet(name); + resultElement.innerText = result; + } catch (err) { + console.error(err); + } +}; +``` + +**Key concepts:** + +1. **Auto-generated bindings** - `GreetService` is imported from generated code +2. **Type-safe calls** - Method names and signatures match your Go code +3. **Async by default** - All Go calls return Promises +4. **Error handling** - Errors from Go are caught in try/catch + +:::note[Where are the bindings?] +Generated bindings are in `frontend/bindings/`. They're created automatically when you run `wails3 dev` or `wails3 build`. + +**Never edit these files manually**—they're regenerated on every build. +::: + +## Customize Your App + +Let's add a new feature to understand the workflow. + +### Add a "Greet Many" Feature + + + +1. **Add the method to GreetService** + + Add this to `greetservice.go`: + + ```go title="greetservice.go" + func (g *GreetService) GreetMany(names []string) []string { + greetings := make([]string, len(names)) + for i, name := range names { + greetings[i] = fmt.Sprintf("Hello %s!", name) + } + return greetings + } + ``` + +2. **The app will auto-rebuild** + + Save the file and `wails3 dev` will automatically rebuild your Go code and restart the app. + + :::note[Auto-Rebuild] + Go code changes trigger an automatic rebuild and restart. Frontend changes hot-reload without restart. + ::: + +3. **Use it in the frontend** + + Add this to `frontend/src/main.js`: + + ```javascript title="frontend/src/main.js" + window.greetMany = async () => { + const names = ['Alice', 'Bob', 'Charlie']; + const greetings = await GreetService.GreetMany(names); + console.log(greetings); + }; + ``` + + Open the browser console and call `greetMany()` - you'll see the array of greetings. + + + +## Build for Production + +When you're ready to distribute your app: + +```bash +wails3 build +``` + +**What this does:** +- Compiles Go code with optimizations +- Builds frontend for production (minified) +- Creates a native executable in `build/bin/` + + + + **Output:** `build/bin/myapp.exe` + + Double-click to run. No dependencies needed (WebView2 is part of Windows). + + + + **Output:** `build/bin/myapp.app` + + Drag to Applications folder or double-click to run. + + + + **Output:** `build/bin/myapp` + + Run with `./build/bin/myapp` or create a `.desktop` file for your launcher. + + + +:::tip[Cross-Platform Builds] +Want to build for other platforms? See [Cross-Platform Builds →](/guides/build/cross-platform) +::: + +## What we've learned + +**Project Structure** +- `main.go` for Go backend +- `frontend/` for UI code +- `Taskfile.yml` for build tasks + +**Services** +- Create Go structs with exported methods +- Register with `application.NewService()` +- Methods automatically available in frontend + +**Bindings** +- Auto-generated TypeScript definitions +- Type-safe function calls +- Async by default (Promises) + +**Development Workflow** +- `wails3 dev` for hot reload +- Go changes auto-rebuild and restart +- Frontend changes hot-reload instantly + +--- + +**Questions?** Join [Discord](https://discord.gg/JDdSxwjhGf) and ask the community. diff --git a/docs/src/content/docs/quick-start/installation.mdx b/docs/src/content/docs/quick-start/installation.mdx new file mode 100644 index 000000000..20bdc51ba --- /dev/null +++ b/docs/src/content/docs/quick-start/installation.mdx @@ -0,0 +1,402 @@ +--- +title: Installation +description: Get Wails installed and ready to build applications +sidebar: + order: 2 +--- + +import { Card, CardGrid, Tabs, TabItem, Steps } from "@astrojs/starlight/components"; + +## Quick Install (5 Minutes) + +:::tip[TL;DR - Experienced Developers] +```bash +# Install Go 1.25+, then: +go install github.com/wailsapp/wails/v3/cmd/wails3@latest +wails3 doctor # Verify installation +``` + +If `wails3 doctor` passes, you're done. [Skip to First App →](/quick-start/first-app) +::: + +## Step-by-Step Installation + + + +1. **Install Go (Required)** + + Wails requires Go 1.25 or later. + + + + Download the Windows installer from **[go.dev/dl](https://go.dev/dl/)** and run it. + + **Verify installation:** + ```powershell + go version # Should show 1.25 or later + ``` + + **Check PATH:** + ```powershell + $env:PATH -split ';' | Where-Object { $_ -like '*\go\bin' } + ``` + + If empty, add `C:\Users\YourName\go\bin` to your PATH. + + + + **Option 1: Official Installer** + + Download the macOS installer (.pkg file) from **[go.dev/dl](https://go.dev/dl/)** and run it. + + **Option 2: Homebrew** + ```bash + brew install go + ``` + + **Verify installation:** + ```bash + go version # Should show 1.25 or later + echo $PATH | grep go/bin # Should show ~/go/bin + ``` + + If `~/go/bin` isn't in PATH, add to `~/.zshrc` or `~/.bash_profile`: + ```bash + export PATH=$PATH:~/go/bin + ``` + + + + **Option 1: Official Tarball** + + Download the Linux tarball from **[go.dev/dl](https://go.dev/dl/)**, then: + ```bash + sudo rm -rf /usr/local/go + sudo tar -C /usr/local -xzf go1.25.linux-amd64.tar.gz + ``` + + **Option 2: Package Manager** + ```bash + # Ubuntu/Debian + sudo apt install golang-go + + # Fedora + sudo dnf install golang + + # Arch + sudo pacman -S go + ``` + + **Add to PATH** (add to `~/.bashrc` or `~/.zshrc`): + ```bash + export PATH=$PATH:/usr/local/go/bin:~/go/bin + source ~/.bashrc # Reload + ``` + + **Verify:** + ```bash + go version + echo $PATH | grep go/bin + ``` + + + +2. **Install Platform Dependencies** + + + + **WebView2 Runtime** (usually pre-installed) + + Windows 10/11 includes WebView2 by default. If missing: + - Download from [Microsoft](https://developer.microsoft.com/microsoft-edge/webview2/) + - Or run `wails3 doctor` later—it will guide you + + **That's it!** No other dependencies needed. + + :::tip[Performance Tip for Windows 11] + Consider using [Dev Drive](https://learn.microsoft.com/en-us/windows/dev-drive/) to store your projects. Dev Drives are optimized for developer workloads and can significantly improve build times and disk access speeds by up to 30%. + ::: + + + + **Xcode Command Line Tools** (required) + + ```bash + xcode-select --install + ``` + + Click "Install" in the dialog that appears. + + **Verify:** + ```bash + xcode-select -p # Should show /Library/Developer/CommandLineTools + ``` + + **That's it!** macOS includes WebKit by default. + + + + **Build tools and WebKit** + + + + ```bash + sudo apt update + sudo apt install build-essential pkg-config libgtk-3-dev libwebkit2gtk-4.0-dev + ``` + + + + ```bash + sudo dnf install gcc pkg-config gtk3-devel webkit2gtk4.0-devel + ``` + + + + ```bash + sudo pacman -S base-devel gtk3 webkit2gtk + ``` + + + + Run `wails3 doctor` after installing Wails—it will show the exact packages needed for your distribution. + + + + + +3. **Install Wails CLI** + + ```bash + go install github.com/wailsapp/wails/v3/cmd/wails3@latest + ``` + + This installs the `wails3` command to `~/go/bin` (or `%USERPROFILE%\go\bin` on Windows). + +4. **Verify Installation** + + ```bash + wails3 doctor + ``` + + **Expected output (or similar):** + ``` + Wails (v3.0.0-dev) Wails Doctor + + # System + + ┌──────────────────────────────────────────────────┐ + | Name | MacOS | + | Version | 26.0 | + | ID | 25A354 | + | Branding | MacOS 26.0 | + | Platform | darwin | + | Architecture | arm64 | + | Apple Silicon | true | + | CPU | Apple M2 Pro | + | CPU 1 | Apple M2 Pro | + | CPU 2 | Apple M2 Pro | + | GPU | 16 cores, Metal Support: Metal 4 | + | Memory | 16 GB | + └──────────────────────────────────────────────────┘ + + # Build Environment + + ┌─────────────┬─────────────────┐ + | Wails CLI | v3.0.0-alpha.40 | + | Go Version | go1.24.6 | + └─────────────┴─────────────────┘ + + # Dependencies + + ┌─────────────────┬─────────────────────────────────────────────────┐ + | npm | 11.6.2 | + | *NSIS | Not Installed. Install with `brew install...`. | + | Xcode cli tools | 2412 | + └─────────────────┴─────────────────────────────────────────────────┘ + + # Checking for issues + + SUCCESS No issues found + + # Diagnosis + + SUCCESS Your system is ready for Wails development! + ``` + + :::note[If `wails3` command not found] + Your `~/go/bin` isn't in PATH. See step 1 above to fix this, then restart your terminal. + ::: + +5. **Install npm (Optional but Recommended)** + + Most Wails templates use npm for frontend tooling. + + + + Download from [nodejs.org](https://nodejs.org/) and run the installer. + + **Verify:** + ```powershell + npm --version + ``` + + + + **Option 1: Official Installer** + Download from [nodejs.org](https://nodejs.org/) + + **Option 2: Homebrew** + ```bash + brew install node + ``` + + **Verify:** + ```bash + npm --version + ``` + + + + **Option 1: NodeSource** + ```bash + curl -fsSL https://deb.nodesource.com/setup_lts.x | sudo -E bash - + sudo apt-get install -y nodejs # Ubuntu/Debian + ``` + + **Option 2: Package Manager** + ```bash + sudo dnf install nodejs # Fedora + sudo pacman -S nodejs npm # Arch + ``` + + **Verify:** + ```bash + npm --version + ``` + + + + :::tip[Alternative Package Managers] + Prefer `pnpm`, `yarn`, or `bun`? No problem! Just update the `Taskfile.yml` in your project to use your preferred tool. + ::: + + + +## Troubleshooting + +#### `wails3` command not found + +**Cause:** `~/go/bin` (or `%USERPROFILE%\go\bin`) isn't in your PATH. + +**Solution:** + + + + 1. Open "Environment Variables" (search in Start menu) + 2. Under "User variables", find `Path` + 3. Click "Edit" → "New" + 4. Add: `C:\Users\YourName\go\bin` (replace `YourName`) + 5. Click "OK" on all dialogs + 6. **Restart your terminal** + + **Verify:** + ```powershell + $env:PATH -split ';' | Where-Object { $_ -like '*\go\bin' } + ``` + + + + Add to `~/.zshrc` (macOS) or `~/.bashrc` (Linux): + ```bash + export PATH=$PATH:~/go/bin + ``` + + Reload: + ```bash + source ~/.zshrc # or ~/.bashrc + ``` + + **Verify:** + ```bash + echo $PATH | grep go/bin + wails3 version + ``` + + +--- + +#### `wails3 doctor` reports missing dependencies + +**Linux:** The output tells you exactly which packages to install. Example: +``` +❌ webkit2gtk not found + Install with: sudo apt install libwebkit2gtk-4.0-dev +``` + +**Windows:** If WebView2 is missing: +- Download from [Microsoft](https://developer.microsoft.com/microsoft-edge/webview2/) +- Or it will be installed automatically when you run your first app + +**macOS:** If Xcode tools are missing: +```bash +xcode-select --install +``` +--- +#### Go version too old + +Wails v3 requires Go 1.25+. If you have an older version: + + + + Download the latest from [go.dev/dl](https://go.dev/dl/) and reinstall. + + + + Download the latest tarball from [go.dev/dl](https://go.dev/dl/), then: + ```bash + sudo rm -rf /usr/local/go + sudo tar -C /usr/local -xzf go1.25.linux-amd64.tar.gz + ``` + + + +## Development Version (Bleeding Edge) + +Want to use the absolute latest code from the main development branch? This gives you access to new features and fixes before they're released, but comes with the risk of bugs and breaking changes. Only recommended for contributors or those who need to test upcoming features. + +```bash +git clone https://github.com/wailsapp/wails.git +cd wails +git checkout v3 +cd v3/cmd/wails3 +go install +``` + +:::caution[Development Version] +- May have bugs or breaking changes +- Projects created will use `replace` directive to point to local Wails +- Only recommended for contributors or testing new features +::: + +## Next Steps + +**Installation Complete!** Your system is ready for Wails development. + + + Create a working application in 10 minutes. + + [First App Tutorial →](/quick-start/first-app) + + + + See what's available out of the box. + + ```bash + wails3 init -l # List templates + ``` + + +--- + +**Having issues?** Ask in [Discord](https://discord.gg/JDdSxwjhGf) or [open an issue](https://github.com/wailsapp/wails/issues). diff --git a/docs/src/content/docs/quick-start/next-steps.mdx b/docs/src/content/docs/quick-start/next-steps.mdx new file mode 100644 index 000000000..394d8e69a --- /dev/null +++ b/docs/src/content/docs/quick-start/next-steps.mdx @@ -0,0 +1,34 @@ +--- +title: Next Steps +description: Where to go after building your first app +sidebar: + order: 4 +--- + +You've built your first Wails app and understand the basics. Here's where to go next. + +## Learn More + +Practice by building complete applications: + +- [TODO App](/tutorials/02-todo-vanilla) - CRUD operations, state management, modern UI +- [All Tutorials](/tutorials/overview) - Notes apps, dashboards, system tray apps, and more + +## Features + +Wails provides native desktop capabilities: + +- [Windows](/features/windows/basics) - Multiple windows, frameless windows, positioning +- [Menus](/features/menus/application) - Application menus, context menus, system tray +- [Dialogs](/features/dialogs/file) - File open/save, message dialogs +- [Events](/features/events/system) - Communication between components +- [Bindings](/features/bindings/methods) - Type-safe Go ↔ JavaScript calls +- [Clipboard](/features/clipboard) - Copy/paste operations +- [Drag & Drop](/features/drag-and-drop/files) - File drag and drop +- [Keyboard](/features/keyboard) - Global shortcuts + +## Get Help + +- [Discord](https://discord.gg/JDdSxwjhGf) - Ask questions, share projects +- [Examples](https://github.com/wailsapp/wails/tree/v3-alpha/v3/examples) - 50+ working examples +- [API Reference](/reference/overview) - Complete documentation diff --git a/docs/src/content/docs/quick-start/why-wails.mdx b/docs/src/content/docs/quick-start/why-wails.mdx new file mode 100644 index 000000000..a99c299d2 --- /dev/null +++ b/docs/src/content/docs/quick-start/why-wails.mdx @@ -0,0 +1,133 @@ +--- +title: Why Wails? +description: Understand why Wails is the right choice for your desktop application +sidebar: + order: 1 +--- + + +Wails combines **Go's performance and simplicity** with **modern web UI flexibility**, enabling you to build beautiful, native desktop applications with the tools you already know. + +## Performance That Users Notice + +**Wails Applications:** +- **~15MB binaries** (vs Electron's 150MB) +- **~10MB baseline memory** (vs Electron's 100MB+) +- **<0.5s startup time** (vs Electron's 2-3s) +- **Native rendering** using the OS-provided WebView + +Users perceive your application as fast, lightweight, and professional. + +## Developer Experience + +**Write Once, Run Everywhere:** +- One Go codebase for Windows, macOS, and Linux +- Use any web framework (React, Vue, Svelte, vanilla JS) +- Hot reload during development +- TypeScript bindings auto-generated from Go code + +Ship faster with less code to maintain. + +## Production-Ready Features + +**Everything you need:** +- Multiple windows with independent lifecycles +- Native menus (application, context, system tray) +- File dialogs with platform-native UI +- System integration (notifications, clipboard, keyboard shortcuts) +- Code signing and packaging for all platforms + +Build professional applications, not prototypes. + +## Faster Development + +- **One codebase, three platforms** - Write once, build for Windows, macOS, and Linux +- **Use existing skills** - Go for backend, HTML/CSS/JS for UI +- **Instant feedback** - Hot reload during development, compile times measured in seconds +- **Small binaries** - 15MB apps mean faster builds, faster downloads, faster iteration + +## When to Choose Wails + +**Wails is Perfect For:** + +- **Business applications** (CRM, inventory, dashboards, admin tools) +- **Developer tools** (database clients, API testers, deployment tools) +- **Productivity apps** (note-taking, task managers, time trackers) +- **Creative tools** (image editors, video processors, design utilities) +- **Internal tools** (company-specific applications, automation tools) + +## Real-World Success Stories + +:::tip[Production Applications] +Wails powers real applications used by thousands of users: +- **Database management tools** with complex UIs +- **Financial dashboards** processing real-time data +- **Video editing tools** with native performance +- **Development utilities** used by engineering teams + +[See the showcase →](/community/showcase) +::: + +## How Wails Works + +Unlike Electron which bundles an entire browser and Node.js runtime, Wails takes a fundamentally different approach: your Go code compiles to a native binary, and your UI runs in the operating system's built-in WebView. This architecture delivers the small binaries, fast startup, and low memory usage that make Wails applications feel native. + +### Architecture + +Wails applications consist of two main parts that communicate seamlessly: a Go backend handling business logic and system operations, and a web-based frontend for your user interface. The OS-provided WebView renders your UI without bundling a browser, while the bindings layer provides type-safe communication between Go and JavaScript. + +
      +
      + +```d2 +direction: down + +Application: { +Go: "Go Backend" { + shape: rectangle + style.fill: "#00ADD8" +} +WebView: "Native WebView" { + shape: rectangle + style.fill: "#3B82F6" + + Frontend: "Your UI\n(React/Vue/etc)" { + shape: rectangle + style.fill: "#8B5CF6" + } + +} +Go <-> WebView: "Bindings & Events" +} + + + +``` + +
      +
      + +This simple architecture enables JavaScript code to call Go functions directly (through auto-generated bindings), while Go can send events and data back to the frontend. Both layers communicate through an efficient in-memory bridge with sub-millisecond overhead. + +**How Wails achieves performance:** +1. **No runtime bundled** - Uses Go's compiled binary +2. **Native WebView** - OS-provided rendering engine +3. **Direct Go ↔ JS bridge** - In-memory communication, no network overhead +4. **Compiled binary** - Instant startup, no JIT compilation + +## Next Steps + +Now that you understand what Wails provides, let's get you set up: + +1. **Install Wails** - Set up your development environment in 5 minutes + [Installation Guide →](/quick-start/installation) + +2. **Build Your First App** - Create a working application and understand the basics + [First App Tutorial →](/quick-start/first-app) + +3. **Explore Features** - Discover what Wails can do for your application + [Feature Overview →](/quick-start/next-steps) + +--- + +**Still have questions?** Join our [Discord community](https://discord.gg/JDdSxwjhGf) and ask the team directly. diff --git a/docs/src/content/docs/reference/application.mdx b/docs/src/content/docs/reference/application.mdx new file mode 100644 index 000000000..cab3a279d --- /dev/null +++ b/docs/src/content/docs/reference/application.mdx @@ -0,0 +1,489 @@ +--- +title: Application API +description: Complete reference for the Application API +sidebar: + order: 1 +--- + +import { Card, CardGrid } from "@astrojs/starlight/components"; + +## Overview + +The `Application` is the core of your Wails app. It manages windows, services, events, and provides access to all platform features. + +## Creating an Application + +```go +import "github.com/wailsapp/wails/v3/pkg/application" + +app := application.New(application.Options{ + Name: "My App", + Description: "My awesome application", + Services: []application.Service{ + application.NewService(&MyService{}), + }, +}) +``` + +## Core Methods + +### Run() + +Starts the application event loop. + +```go +func (a *App) Run() error +``` + +**Example:** + +```go +err := app.Run() +if err != nil { + log.Fatal(err) +} +``` + +**Returns:** Error if startup fails + +### Quit() + +Gracefully shuts down the application. + +```go +func (a *App) Quit() +``` + +**Example:** + +```go +// In a menu handler +menu.Add("Quit").OnClick(func(ctx *application.Context) { + app.Quit() +}) +``` + +### Config() + +Returns the application configuration. + +```go +func (a *App) Config() Options +``` + +**Example:** + +```go +config := app.Config() +fmt.Println("App name:", config.Name) +``` + +## Window Management + +### app.Window.New() + +Creates a new webview window with default options. + +```go +func (wm *WindowManager) New() *WebviewWindow +``` + +**Example:** + +```go +window := app.Window.New() +window.Show() +``` + +### app.Window.NewWithOptions() + +Creates a new webview window with custom options. + +```go +func (wm *WindowManager) NewWithOptions(options WebviewWindowOptions) *WebviewWindow +``` + +**Example:** + +```go +window := app.Window.NewWithOptions(application.WebviewWindowOptions{ + Title: "My Window", + Width: 800, + Height: 600, + BackgroundColour: application.NewRGB(255, 255, 255), +}) +``` + +### app.Window.GetByName() + +Gets a window by its name. + +```go +func (wm *WindowManager) GetByName(name string) Window +``` + +**Example:** + +```go +window := app.Window.GetByName("main") +if window != nil { + window.Show() +} +``` + +### app.Window.GetAll() + +Returns all application windows. + +```go +func (wm *WindowManager) GetAll() []Window +``` + +**Example:** + +```go +windows := app.Window.GetAll() +for _, window := range windows { + fmt.Println("Window:", window.Name()) +} +``` + +## Managers + +The Application provides access to various managers through properties: + +```go +app.Window // Window management +app.Menu // Menu management +app.Dialog // dialog management +app.Event // Event management +app.Clipboard // Clipboard operations +app.Screen // Screen information +app.SystemTray // System tray +app.Browser // Browser operations +app.Env // Environment variables +``` + +### Example Usage + +```go +// Create window +window := app.Window.New() + +// Show dialog +app.Dialog.Info().SetMessage("Hello!").Show() + +// Copy to clipboard +app.Clipboard.SetText("Copied text") + +// Get screens +screens := app.Screen.GetAll() +``` + +## Service Management + +### RegisterService() + +Registers a service with the application. + +```go +func (a *App) RegisterService(service Service) error +``` + +**Example:** + +```go +type MyService struct { + app *application.Application +} + +func NewMyService(app *application.Application) *MyService { + return &MyService{app: app} +} + +// Register after app creation +app.RegisterService(application.NewService(NewMyService(app))) +``` + +## Event Management + +### app.Event.Emit() + +Emits a custom event. + +```go +func (em *EventManager) Emit(name string, data ...interface{}) +``` + +**Example:** + +```go +// Emit event with data +app.Event.Emit("user-logged-in", map[string]interface{}{ + "username": "john", + "timestamp": time.Now(), +}) +``` + +### app.Event.On() + +Listens for custom events. + +```go +func (em *EventManager) On(name string, callback func(*CustomEvent)) +``` + +**Example:** + +```go +app.Event.On("user-logged-in", func(e *application.CustomEvent) { + data := e.Data.(map[string]interface{}) + username := data["username"].(string) + fmt.Println("User logged in:", username) +}) +``` + +### app.Event.OnApplicationEvent() + +Listens for application lifecycle events. + +```go +func (em *EventManager) OnApplicationEvent(eventType ApplicationEventType, callback func(*ApplicationEvent)) func() +``` + +**Example:** + +```go +// Listen for shutdown +app.Event.OnApplicationEvent(application.EventApplicationShutdown, func(e *application.ApplicationEvent) { + fmt.Println("Application shutting down") + // Cleanup +}) +``` + +## Dialog Methods + +Dialogs are accessed through the `app.Dialog` manager. See [Dialogs API](/reference/dialogs/) for complete reference. + +### Message Dialogs + +```go +// Information dialog +app.Dialog.Info(). + SetTitle("Success"). + SetMessage("Operation completed!"). + Show() + +// Error dialog +app.Dialog.Error(). + SetTitle("Error"). + SetMessage("Something went wrong."). + Show() + +// Warning dialog +app.Dialog.Warning(). + SetTitle("Warning"). + SetMessage("This action cannot be undone."). + Show() +``` + +### Question Dialogs + +Question dialogs use button callbacks to handle user responses: + +```go +dialog := app.Dialog.Question(). + SetTitle("Confirm"). + SetMessage("Continue?") + +yes := dialog.AddButton("Yes") +yes.OnClick(func() { + // Handle yes +}) + +no := dialog.AddButton("No") +no.OnClick(func() { + // Handle no +}) + +dialog.SetDefaultButton(yes) +dialog.SetCancelButton(no) +dialog.Show() +``` + +### File Dialogs + +```go +// Open file dialog +path, err := app.Dialog.OpenFile(). + SetTitle("Select File"). + AddFilter("Images", "*.png;*.jpg"). + PromptForSingleSelection() + +// Save file dialog +path, err := app.Dialog.SaveFile(). + SetTitle("Save File"). + SetFilename("document.pdf"). + AddFilter("PDF", "*.pdf"). + PromptForSingleSelection() + +// Folder selection (use OpenFile with directory options) +path, err := app.Dialog.OpenFile(). + SetTitle("Select Folder"). + CanChooseDirectories(true). + CanChooseFiles(false). + PromptForSingleSelection() +``` + +## Logger + +The application provides a structured logger: + +```go +app.Logger.Info("Message", "key", "value") +app.Logger.Error("Error occurred", "error", err) +app.Logger.Debug("Debug info") +app.Logger.Warn("Warning message") +``` + +**Example:** + +```go +func (s *MyService) ProcessData(data string) error { + s.app.Logger.Info("Processing data", "length", len(data)) + + if err := process(data); err != nil { + s.app.Logger.Error("Processing failed", "error", err) + return err + } + + s.app.Logger.Info("Processing complete") + return nil +} +``` + +## Raw Message Handling + +For applications that need direct, low-level control over frontend-to-backend communication, Wails provides the `RawMessageHandler` option. This bypasses the standard binding system. + +:::note +Raw messages should only be used as a last resort. The standard binding system is highly optimized and sufficient for almost all applications. Only use raw messages if you have profiled your application and confirmed that bindings are a bottleneck. +::: + +### RawMessageHandler + +The `RawMessageHandler` callback receives raw messages sent from the frontend using `System.invoke()`. + +```go +func (a *App) RawMessageHandler(window Window, message string) +``` + +**Example:** + +```go +app := application.New(application.Options{ + Name: "My App", + RawMessageHandler: func(window application.Window, message string) { + // Handle the raw message + fmt.Printf("Received from %s: %s\n", window.Name(), message) + + // You can respond using events + window.EmitEvent("response", processMessage(message)) + }, +}) +``` + + +For more details, see the [Raw Messages Guide](/guides/raw-messages). + +## Platform-Specific Options + +### Windows Options + +Configure Windows-specific behavior at the application level: + +```go +app := application.New(application.Options{ + Name: "My App", + Windows: application.WindowsOptions{ + // WebView2 browser flags (apply to ALL windows) + EnabledFeatures: []string{"msWebView2EnableDraggableRegions"}, + DisabledFeatures: []string{"msExperimentalFeature"}, + AdditionalBrowserArgs: []string{"--remote-debugging-port=9222"}, + + // Other Windows options + WndClass: "MyAppClass", + WebviewUserDataPath: "", // Default: %APPDATA%\[BinaryName.exe] + WebviewBrowserPath: "", // Default: system WebView2 + DisableQuitOnLastWindowClosed: false, + }, +}) +``` + +**Browser Flags:** +- `EnabledFeatures` - WebView2 feature flags to enable +- `DisabledFeatures` - WebView2 feature flags to disable +- `AdditionalBrowserArgs` - Chromium command-line arguments + +See [Window Options - Application-Level Windows Options](/features/windows/options#application-level-windows-options) for detailed documentation. + +### Mac Options + +```go +app := application.New(application.Options{ + Name: "My App", + Mac: application.MacOptions{ + ActivationPolicy: application.ActivationPolicyRegular, + ApplicationShouldTerminateAfterLastWindowClosed: true, + }, +}) +``` + +### Linux Options + +```go +app := application.New(application.Options{ + Name: "My App", + Linux: application.LinuxOptions{ + ProgramName: "my-app", + DisableQuitOnLastWindowClosed: false, + }, +}) +``` + +## Complete Application Example + +```go +package main + +import ( + "github.com/wailsapp/wails/v3/pkg/application" +) + +func main() { + app := application.New(application.Options{ + Name: "My Application", + Description: "A demo application", + Mac: application.MacOptions{ + ApplicationShouldTerminateAfterLastWindowClosed: true, + }, + }) + + // Create main window + window := app.Window.NewWithOptions(application.WebviewWindowOptions{ + Title: "My App", + Width: 1024, + Height: 768, + MinWidth: 800, + MinHeight: 600, + BackgroundColour: application.NewRGB(255, 255, 255), + URL: "http://wails.localhost/", + }) + + window.Centre() + window.Show() + + app.Run() +} +``` + diff --git a/docs/src/content/docs/reference/cli.mdx b/docs/src/content/docs/reference/cli.mdx new file mode 100644 index 000000000..9f37ff6bf --- /dev/null +++ b/docs/src/content/docs/reference/cli.mdx @@ -0,0 +1,28 @@ +--- +title: CLI Reference +description: Complete reference for the Wails CLI commands +sidebar: + order: 1 +--- + +## Overview + +The Wails CLI (`wails3`) provides commands for creating, developing, building, and managing Wails applications. + +## Coming Soon + +This section is under construction. For now, use `wails3 --help` or `wails3 [command] --help` for command documentation. + +**Common commands:** + +```bash +wails3 init # Create a new project +wails3 dev # Run in development mode +wails3 build # Build for production +wails3 generate # Generate bindings or runtime +wails3 doctor # Check development environment +``` + +--- + +**Questions?** Ask in [Discord](https://discord.gg/JDdSxwjhGf) or check the [examples](https://github.com/wailsapp/wails/tree/v3-alpha/v3/examples). diff --git a/docs/src/content/docs/reference/dialogs.mdx b/docs/src/content/docs/reference/dialogs.mdx new file mode 100644 index 000000000..799c453b8 --- /dev/null +++ b/docs/src/content/docs/reference/dialogs.mdx @@ -0,0 +1,844 @@ +--- +title: Dialogs API +description: Complete reference for native dialog APIs +sidebar: + order: 5 +--- + +import { Card, CardGrid } from "@astrojs/starlight/components"; + +## Overview + +The Dialogs API provides methods to show native file dialogs and message dialogs. Access dialogs through the `app.Dialog` manager. + +**Dialog Types:** +- **File Dialogs** - Open and Save dialogs +- **Message Dialogs** - Info, Error, Warning, and Question dialogs + +All dialogs are **native OS dialogs** that match the platform's look and feel. + +## Accessing Dialogs + +Dialogs are accessed through the `app.Dialog` manager: + +```go +app.Dialog.OpenFile() +app.Dialog.SaveFile() +app.Dialog.Info() +app.Dialog.Question() +app.Dialog.Warning() +app.Dialog.Error() +``` + +## File Dialogs + +### OpenFile() + +Creates a file open dialog. + +```go +func (dm *DialogManager) OpenFile() *OpenFileDialogStruct +``` + +**Example:** +```go +dialog := app.Dialog.OpenFile() +``` + +### OpenFileDialogStruct Methods + +#### SetTitle() + +Sets the dialog title. + +```go +func (d *OpenFileDialogStruct) SetTitle(title string) *OpenFileDialogStruct +``` + +**Example:** +```go +dialog.SetTitle("Select Image") +``` + +#### AddFilter() + +Adds a file type filter. + +```go +func (d *OpenFileDialogStruct) AddFilter(displayName, pattern string) *OpenFileDialogStruct +``` + +**Parameters:** +- `displayName` - Filter description shown to user (e.g., "Images", "Documents") +- `pattern` - Semicolon-separated list of extensions (e.g., "*.png;*.jpg") + +**Example:** +```go +dialog.AddFilter("Images", "*.png;*.jpg;*.gif"). + AddFilter("Documents", "*.pdf;*.docx"). + AddFilter("All Files", "*.*") +``` + +#### SetDirectory() + +Sets the initial directory. + +```go +func (d *OpenFileDialogStruct) SetDirectory(directory string) *OpenFileDialogStruct +``` + +**Example:** +```go +homeDir, _ := os.UserHomeDir() +dialog.SetDirectory(homeDir) +``` + +#### CanChooseDirectories() + +Enables or disables directory selection. + +```go +func (d *OpenFileDialogStruct) CanChooseDirectories(canChooseDirectories bool) *OpenFileDialogStruct +``` + +**Example (folder selection):** +```go +// Select folders instead of files +path, err := app.Dialog.OpenFile(). + SetTitle("Select Folder"). + CanChooseDirectories(true). + CanChooseFiles(false). + PromptForSingleSelection() +``` + +#### CanChooseFiles() + +Enables or disables file selection. + +```go +func (d *OpenFileDialogStruct) CanChooseFiles(canChooseFiles bool) *OpenFileDialogStruct +``` + +#### CanCreateDirectories() + +Enables or disables creating new directories. + +```go +func (d *OpenFileDialogStruct) CanCreateDirectories(canCreateDirectories bool) *OpenFileDialogStruct +``` + +#### ShowHiddenFiles() + +Shows or hides hidden files. + +```go +func (d *OpenFileDialogStruct) ShowHiddenFiles(showHiddenFiles bool) *OpenFileDialogStruct +``` + +#### AttachToWindow() + +Attaches the dialog to a specific window. + +```go +func (d *OpenFileDialogStruct) AttachToWindow(window Window) *OpenFileDialogStruct +``` + +#### PromptForSingleSelection() + +Shows the dialog and returns the selected file. + +```go +func (d *OpenFileDialogStruct) PromptForSingleSelection() (string, error) +``` + +**Returns:** +- `string` - Selected file path (empty if cancelled) +- `error` - Error if dialog failed + +**Example:** +```go +path, err := app.Dialog.OpenFile(). + SetTitle("Select Image"). + AddFilter("Images", "*.png;*.jpg;*.gif"). + PromptForSingleSelection() + +if err != nil { + // User cancelled or error occurred + return +} + +// Use the selected file +processFile(path) +``` + +#### PromptForMultipleSelection() + +Shows the dialog and returns multiple selected files. + +```go +func (d *OpenFileDialogStruct) PromptForMultipleSelection() ([]string, error) +``` + +**Returns:** +- `[]string` - Array of selected file paths +- `error` - Error if dialog failed + +**Example:** +```go +paths, err := app.Dialog.OpenFile(). + SetTitle("Select Images"). + AddFilter("Images", "*.png;*.jpg"). + PromptForMultipleSelection() + +if err != nil { + return +} + +for _, path := range paths { + processFile(path) +} +``` + +### SaveFile() + +Creates a file save dialog. + +```go +func (dm *DialogManager) SaveFile() *SaveFileDialogStruct +``` + +**Example:** +```go +dialog := app.Dialog.SaveFile() +``` + +### SaveFileDialogStruct Methods + +#### SetTitle() + +Sets the dialog title. + +```go +func (d *SaveFileDialogStruct) SetTitle(title string) *SaveFileDialogStruct +``` + +#### SetFilename() + +Sets the default filename. + +```go +func (d *SaveFileDialogStruct) SetFilename(filename string) *SaveFileDialogStruct +``` + +**Example:** +```go +dialog.SetFilename("document.pdf") +``` + +#### AddFilter() + +Adds a file type filter. + +```go +func (d *SaveFileDialogStruct) AddFilter(displayName, pattern string) *SaveFileDialogStruct +``` + +**Example:** +```go +dialog.AddFilter("PDF Document", "*.pdf"). + AddFilter("Text Document", "*.txt") +``` + +#### SetDirectory() + +Sets the initial directory. + +```go +func (d *SaveFileDialogStruct) SetDirectory(directory string) *SaveFileDialogStruct +``` + +#### AttachToWindow() + +Attaches the dialog to a specific window. + +```go +func (d *SaveFileDialogStruct) AttachToWindow(window Window) *SaveFileDialogStruct +``` + +#### PromptForSingleSelection() + +Shows the dialog and returns the save path. + +```go +func (d *SaveFileDialogStruct) PromptForSingleSelection() (string, error) +``` + +**Example:** +```go +path, err := app.Dialog.SaveFile(). + SetTitle("Save Document"). + SetFilename("untitled.pdf"). + AddFilter("PDF Document", "*.pdf"). + PromptForSingleSelection() + +if err != nil { + // User cancelled + return +} + +// Save to the selected path +saveDocument(path) +``` + +### Folder Selection + +There is no separate `SelectFolderDialog`. Use `OpenFile()` with directory options: + +```go +path, err := app.Dialog.OpenFile(). + SetTitle("Select Output Folder"). + CanChooseDirectories(true). + CanChooseFiles(false). + PromptForSingleSelection() + +if err != nil { + // User cancelled + return +} + +// Use the selected folder +outputDir = path +``` + +## Message Dialogs + +All message dialogs return `*MessageDialog` and share the same methods. + +### Info() + +Creates an information dialog. + +```go +func (dm *DialogManager) Info() *MessageDialog +``` + +**Example:** +```go +app.Dialog.Info(). + SetTitle("Success"). + SetMessage("File saved successfully!"). + Show() +``` + +### Error() + +Creates an error dialog. + +```go +func (dm *DialogManager) Error() *MessageDialog +``` + +**Example:** +```go +app.Dialog.Error(). + SetTitle("Error"). + SetMessage("Failed to save file: " + err.Error()). + Show() +``` + +### Warning() + +Creates a warning dialog. + +```go +func (dm *DialogManager) Warning() *MessageDialog +``` + +**Example:** +```go +app.Dialog.Warning(). + SetTitle("Warning"). + SetMessage("This action cannot be undone."). + Show() +``` + +### Question() + +Creates a question dialog with custom buttons. + +```go +func (dm *DialogManager) Question() *MessageDialog +``` + +**Example:** +```go +dialog := app.Dialog.Question(). + SetTitle("Confirm"). + SetMessage("Do you want to save changes?") + +save := dialog.AddButton("Save") +save.OnClick(func() { + saveDocument() +}) + +dontSave := dialog.AddButton("Don't Save") +dontSave.OnClick(func() { + // Continue without saving +}) + +cancel := dialog.AddButton("Cancel") +cancel.OnClick(func() { + // Do nothing +}) + +dialog.SetDefaultButton(save) +dialog.SetCancelButton(cancel) +dialog.Show() +``` + +### MessageDialog Methods + +#### SetTitle() + +Sets the dialog title. + +```go +func (d *MessageDialog) SetTitle(title string) *MessageDialog +``` + +#### SetMessage() + +Sets the dialog message. + +```go +func (d *MessageDialog) SetMessage(message string) *MessageDialog +``` + +#### SetIcon() + +Sets a custom icon for the dialog. + +```go +func (d *MessageDialog) SetIcon(icon []byte) *MessageDialog +``` + +#### AddButton() + +Adds a button to the dialog and returns the button for configuration. + +```go +func (d *MessageDialog) AddButton(label string) *Button +``` + +**Returns:** `*Button` - The button instance for further configuration + +**Example:** +```go +button := dialog.AddButton("OK") +button.OnClick(func() { + // Handle click +}) +``` + +#### SetDefaultButton() + +Sets which button is the default (activated by pressing Enter). + +```go +func (d *MessageDialog) SetDefaultButton(button *Button) *MessageDialog +``` + +**Example:** +```go +yes := dialog.AddButton("Yes") +no := dialog.AddButton("No") +dialog.SetDefaultButton(yes) +``` + +#### SetCancelButton() + +Sets which button is the cancel button (activated by pressing Escape). + +```go +func (d *MessageDialog) SetCancelButton(button *Button) *MessageDialog +``` + +**Example:** +```go +ok := dialog.AddButton("OK") +cancel := dialog.AddButton("Cancel") +dialog.SetCancelButton(cancel) +``` + +#### AttachToWindow() + +Attaches the dialog to a specific window. + +```go +func (d *MessageDialog) AttachToWindow(window Window) *MessageDialog +``` + +#### Show() + +Shows the dialog. Button callbacks handle user responses. + +```go +func (d *MessageDialog) Show() +``` + +**Note:** `Show()` does not return a value. Use button callbacks to handle user responses. + +### Button Methods + +#### OnClick() + +Sets the callback function for when the button is clicked. + +```go +func (b *Button) OnClick(callback func()) *Button +``` + +#### SetAsDefault() + +Marks this button as the default button. + +```go +func (b *Button) SetAsDefault() *Button +``` + +#### SetAsCancel() + +Marks this button as the cancel button. + +```go +func (b *Button) SetAsCancel() *Button +``` + +## Complete Examples + +### File Selection Example + +```go +type FileService struct { + app *application.App +} + +func (s *FileService) OpenImage() (string, error) { + path, err := s.app.Dialog.OpenFile(). + SetTitle("Select Image"). + AddFilter("Images", "*.png;*.jpg;*.jpeg;*.gif"). + AddFilter("All Files", "*.*"). + PromptForSingleSelection() + + if err != nil { + return "", err + } + + return path, nil +} + +func (s *FileService) SaveDocument(defaultName string) (string, error) { + path, err := s.app.Dialog.SaveFile(). + SetTitle("Save Document"). + SetFilename(defaultName). + AddFilter("PDF Document", "*.pdf"). + AddFilter("Text Document", "*.txt"). + PromptForSingleSelection() + + if err != nil { + return "", err + } + + return path, nil +} + +func (s *FileService) SelectOutputFolder() (string, error) { + path, err := s.app.Dialog.OpenFile(). + SetTitle("Select Output Folder"). + CanChooseDirectories(true). + CanChooseFiles(false). + PromptForSingleSelection() + + if err != nil { + return "", err + } + + return path, nil +} +``` + +### Confirmation Dialog Example + +```go +func (s *Service) DeleteItem(app *application.App, id string) { + dialog := app.Dialog.Question(). + SetTitle("Confirm Delete"). + SetMessage("Are you sure you want to delete this item?") + + deleteBtn := dialog.AddButton("Delete") + deleteBtn.OnClick(func() { + deleteFromDatabase(id) + }) + + cancelBtn := dialog.AddButton("Cancel") + // Cancel does nothing + + dialog.SetDefaultButton(cancelBtn) // Default to Cancel for safety + dialog.SetCancelButton(cancelBtn) + dialog.Show() +} +``` + +### Save Changes Dialog + +```go +func (s *Editor) PromptSaveChanges(app *application.App) { + dialog := app.Dialog.Question(). + SetTitle("Unsaved Changes"). + SetMessage("Do you want to save your changes before closing?") + + save := dialog.AddButton("Save") + save.OnClick(func() { + s.Save() + s.Close() + }) + + dontSave := dialog.AddButton("Don't Save") + dontSave.OnClick(func() { + s.Close() + }) + + cancel := dialog.AddButton("Cancel") + // Cancel does nothing, dialog closes + + dialog.SetDefaultButton(save) + dialog.SetCancelButton(cancel) + dialog.Show() +} +``` + +### Multi-File Processing + +```go +func (s *Service) ProcessMultipleFiles(app *application.App) error { + // Select multiple files + paths, err := app.Dialog.OpenFile(). + SetTitle("Select Files to Process"). + AddFilter("Images", "*.png;*.jpg"). + PromptForMultipleSelection() + + if err != nil { + return err + } + + if len(paths) == 0 { + app.Dialog.Info(). + SetTitle("No Files Selected"). + SetMessage("Please select at least one file."). + Show() + return nil + } + + // Process files + for _, path := range paths { + err := processFile(path) + if err != nil { + app.Dialog.Error(). + SetTitle("Processing Error"). + SetMessage(fmt.Sprintf("Failed to process %s: %v", path, err)). + Show() + continue + } + } + + // Show completion + app.Dialog.Info(). + SetTitle("Complete"). + SetMessage(fmt.Sprintf("Successfully processed %d files", len(paths))). + Show() + + return nil +} +``` + +### Error Handling with Dialogs + +```go +func (s *Service) SaveFile(app *application.App, data []byte) error { + // Select save location + path, err := app.Dialog.SaveFile(). + SetTitle("Save File"). + SetFilename("data.json"). + AddFilter("JSON File", "*.json"). + PromptForSingleSelection() + + if err != nil { + // User cancelled - not an error + return nil + } + + // Attempt to save + err = os.WriteFile(path, data, 0644) + if err != nil { + // Show error dialog + app.Dialog.Error(). + SetTitle("Save Failed"). + SetMessage(fmt.Sprintf("Could not save file: %v", err)). + Show() + return err + } + + // Show success + app.Dialog.Info(). + SetTitle("Success"). + SetMessage("File saved successfully!"). + Show() + + return nil +} +``` + +### Platform-Specific Defaults + +```go +import ( + "os" + "path/filepath" + "runtime" +) + +func (s *Service) GetDefaultDirectory() string { + homeDir, _ := os.UserHomeDir() + + switch runtime.GOOS { + case "windows": + return filepath.Join(homeDir, "Documents") + case "darwin": + return filepath.Join(homeDir, "Documents") + case "linux": + return filepath.Join(homeDir, "Documents") + default: + return homeDir + } +} + +func (s *Service) OpenWithDefaults(app *application.App) (string, error) { + return app.Dialog.OpenFile(). + SetTitle("Open File"). + SetDirectory(s.GetDefaultDirectory()). + AddFilter("All Files", "*.*"). + PromptForSingleSelection() +} +``` + +## Best Practices + +### Do + +- **Use native dialogs** - They match the platform's look and feel +- **Provide clear titles** - Help users understand the purpose +- **Set appropriate filters** - Guide users to correct file types +- **Handle cancellation** - Check for errors (user may cancel) +- **Show confirmation for destructive actions** - Use Question dialogs +- **Provide feedback** - Use Info dialogs for success messages +- **Set sensible defaults** - Default directory, filename, etc. +- **Use callbacks for button actions** - Handle user responses properly + +### Don't + +- **Don't ignore errors** - User cancellation returns an error +- **Don't use ambiguous button labels** - Be specific: "Save"/"Cancel" +- **Don't overuse dialogs** - They interrupt workflow +- **Don't show errors for cancellation** - It's a normal action +- **Don't forget file filters** - Help users find the right files +- **Don't hardcode paths** - Use os.UserHomeDir() or similar + +## Dialog Types by Platform + +### macOS + +- Dialogs slide down from title bar +- "Sheet" style attached to parent window +- Native macOS appearance + +### Windows + +- Standard Windows dialogs +- Follows Windows design guidelines +- Modern Windows 10/11 appearance + +### Linux + +- GTK dialogs on GTK-based systems +- Qt dialogs on Qt-based systems +- Matches desktop environment + +#### Linux GTK4 Limitations + +On Linux with GTK4 (the default for modern distributions), file dialogs use the **xdg-desktop-portal** +for native integration. This provides better desktop integration but means some options have no effect: + +| Option | GTK3 | GTK4 | Notes | +|--------|------|------|-------| +| `ShowHiddenFiles()` | ✅ Works | ❌ No effect | User controls via dialog's UI toggle (Ctrl+H or menu) | +| `CanCreateDirectories()` | ✅ Works | ❌ No effect | Always enabled in the portal | +| `ResolvesAliases()` | ✅ Works | ❌ No effect | Portal handles symlink resolution | +| `SetButtonText()` | ✅ Works | ✅ Works | Custom accept button text works | + +**Why these limitations exist:** GTK4's portal-based dialogs delegate UI control to the desktop +environment (GNOME, KDE, etc.). This is by design - the portal provides consistent UX across +applications and respects user preferences. + +:::note +The table above shows GTK4 behavior when building with `-tags gtk4`. By default, Wails uses GTK3 +which provides full control over these dialog options. +::: + +## Common Patterns + +### "Save As" Pattern + +```go +func (s *Service) SaveAs(app *application.App, currentPath string) (string, error) { + // Extract filename from current path + filename := filepath.Base(currentPath) + + // Show save dialog + path, err := app.Dialog.SaveFile(). + SetTitle("Save As"). + SetFilename(filename). + PromptForSingleSelection() + + if err != nil { + return "", err + } + + return path, nil +} +``` + +### "Open Recent" Pattern + +```go +func (s *Service) OpenRecent(app *application.App, recentPath string) error { + // Check if file still exists + if _, err := os.Stat(recentPath); os.IsNotExist(err) { + dialog := app.Dialog.Question(). + SetTitle("File Not Found"). + SetMessage("The file no longer exists. Remove from recent files?") + + remove := dialog.AddButton("Remove") + remove.OnClick(func() { + s.removeFromRecent(recentPath) + }) + + cancel := dialog.AddButton("Cancel") + dialog.SetCancelButton(cancel) + dialog.Show() + + return err + } + + return s.openFile(recentPath) +} +``` diff --git a/docs/src/content/docs/reference/events.mdx b/docs/src/content/docs/reference/events.mdx new file mode 100644 index 000000000..d6286018e --- /dev/null +++ b/docs/src/content/docs/reference/events.mdx @@ -0,0 +1,801 @@ +--- +title: Events API +description: Complete reference for the Events API +sidebar: + order: 4 +--- + +import { Card, CardGrid } from "@astrojs/starlight/components"; + +## Overview + +The Events API provides methods to emit and listen to events, enabling communication between different parts of your application. + +**Event Types:** +- **Application Events** - App lifecycle events (startup, shutdown) +- **Window Events** - Window state changes (focus, blur, resize) +- **Custom Events** - User-defined events for app-specific communication + +**Communication Patterns:** +- **Go to Frontend** - Emit events from Go, listen in JavaScript +- **Frontend to Go** - Not directly (use service bindings instead) +- **Frontend to Frontend** - Via Go or local runtime events +- **Window to Window** - Target specific windows or broadcast to all + +## Event Methods (Go) + +### app.Event.Emit() + +Emits a custom event to all windows. + +```go +func (em *EventManager) Emit(name string, data ...interface{}) +``` + +**Parameters:** +- `name` - Event name +- `data` - Optional data to send with the event + +**Example:** +```go +// Emit simple event +app.Event.Emit("user-logged-in") + +// Emit with data +app.Event.Emit("data-updated", map[string]interface{}{ + "count": 42, + "status": "success", +}) + +// Emit multiple values +app.Event.Emit("progress", 75, "Processing files...") +``` + +### app.Event.On() + +Listens for custom events in Go. + +```go +func (em *EventManager) On(name string, callback func(*CustomEvent)) func() +``` + +**Parameters:** +- `name` - Event name to listen for +- `callback` - Function called when event is emitted + +**Returns:** Cleanup function to remove the event listener + +**Example:** +```go +// Listen for events +cleanup := app.Event.On("user-action", func(e *application.CustomEvent) { + data := e.Data.(map[string]interface{}) + action := data["action"].(string) + app.Logger.Info("User action", "action", action) +}) + +// Later, remove listener +cleanup() +``` + +### Window-Specific Events + +Emit events to a specific window: + +```go +// Emit to specific window +window.EmitEvent("notification", "Hello from Go!") + +// Emit to all windows +app.Event.Emit("global-update", data) +``` + +## Event Methods (Frontend) + +### On() + +Listens for events from Go. + +```javascript +import { On } from '@wailsio/runtime' + +On(eventName, callback) +``` + +**Parameters:** +- `eventName` - Name of the event to listen for +- `callback` - Function called when event is received + +**Returns:** Cleanup function + +**Example:** +```javascript +import { On } from '@wailsio/runtime' + +// Listen for events +const cleanup = On('data-updated', (data) => { + console.log('Count:', data.count) + console.log('Status:', data.status) + updateUI(data) +}) + +// Later, remove listener +cleanup() +``` + +### Once() + +Listens for a single event occurrence. + +```javascript +import { Once } from '@wailsio/runtime' + +Once(eventName, callback) +``` + +**Example:** +```javascript +import { Once } from '@wailsio/runtime' + +// Listen for first occurrence only +Once('initialization-complete', (data) => { + console.log('App initialized!', data) + // This will only fire once +}) +``` + +### Off() + +Removes an event listener. + +```javascript +import { Off } from '@wailsio/runtime' + +Off(eventName, callback) +``` + +**Example:** +```javascript +import { On, Off } from '@wailsio/runtime' + +const handler = (data) => { + console.log('Event received:', data) +} + +// Start listening +On('my-event', handler) + +// Stop listening +Off('my-event', handler) +``` + +### OffAll() + +Removes all listeners for an event. + +```javascript +import { OffAll } from '@wailsio/runtime' + +OffAll(eventName) +``` + +**Example:** +```javascript +// Remove all listeners for this event +OffAll('data-updated') +``` + +## Application Events + +### app.Event.OnApplicationEvent() + +Listens for application lifecycle events. + +```go +func (em *EventManager) OnApplicationEvent(eventType ApplicationEventType, callback func(*ApplicationEvent)) func() +``` + +**Event Types:** +- `EventApplicationStarted` - Application has started +- `EventApplicationShutdown` - Application is shutting down +- `EventApplicationDebug` - Debug event (dev mode only) + +**Example:** +```go +// Handle application startup +app.Event.OnApplicationEvent(application.EventApplicationStarted, func(e *application.ApplicationEvent) { + app.Logger.Info("Application started") + // Initialize resources +}) + +// Handle application shutdown +app.Event.OnApplicationEvent(application.EventApplicationShutdown, func(e *application.ApplicationEvent) { + app.Logger.Info("Application shutting down") + // Cleanup resources, save state + database.Close() + saveSettings() +}) +``` + +## Window Events + +### OnWindowEvent() + +Listens for window-specific events. + +```go +func (w *Window) OnWindowEvent(eventType WindowEventType, callback func(*WindowEvent)) func() +``` + +**Event Types:** +- `EventWindowFocus` - Window gained focus +- `EventWindowBlur` - Window lost focus +- `EventWindowClose` - Window is closing +- `EventWindowResize` - Window was resized +- `EventWindowMove` - Window was moved + +**Example:** +```go +// Handle window focus +window.OnWindowEvent(application.EventWindowFocus, func(e *application.WindowEvent) { + app.Logger.Info("Window focused") +}) + +// Handle window resize +window.OnWindowEvent(application.EventWindowResize, func(e *application.WindowEvent) { + width, height := window.Size() + app.Logger.Info("Window resized", "width", width, "height", height) +}) +``` + +## Common Patterns + +These patterns demonstrate proven approaches for using events in real-world applications. Each pattern solves a specific communication challenge between your Go backend and frontend, helping you build responsive, well-structured applications. + +### Request/Response Pattern + +Use this when you want to notify the frontend about the completion of backend operations, such as after data fetching, file processing, or background tasks. The service binding returns data directly, while events provide additional notifications for UI updates like showing toast messages or refreshing lists. + +**Go:** + +```go +// Service method +type DataService struct { + app *application.Application +} + +func (s *DataService) FetchData(query string) ([]Item, error) { + items := fetchFromDatabase(query) + + // Emit event when done + s.app.Event.Emit("data-fetched", map[string]interface{}{ + "query": query, + "count": len(items), + }) + + return items, nil +} +``` + +**JavaScript:** + +```javascript +import { FetchData } from './bindings/DataService' +import { On } from '@wailsio/runtime' + +// Listen for completion event +On('data-fetched', (data) => { + console.log(`Fetched ${data.count} items for query: ${data.query}`) + showNotification(`Found ${data.count} results`) +}) + +// Call service method +const items = await FetchData("search term") +displayItems(items) +``` + +### Progress Updates + +Ideal for long-running operations like file uploads, batch processing, large data imports, or video encoding. Emit progress events during the operation to update progress bars, status text, or step indicators in the UI, providing users with real-time feedback. + +**Go:** + +```go +func (s *Service) ProcessFiles(files []string) error { + total := len(files) + + for i, file := range files { + // Process file + processFile(file) + + // Emit progress event + s.app.Event.Emit("progress", map[string]interface{}{ + "current": i + 1, + "total": total, + "percent": float64(i+1) / float64(total) * 100, + "file": file, + }) + } + + s.app.Event.Emit("processing-complete") + return nil +} +``` + +**JavaScript:** + +```javascript +import { On, Once } from '@wailsio/runtime' + +// Update progress bar +On('progress', (data) => { + progressBar.style.width = `${data.percent}%` + statusText.textContent = `Processing ${data.file}... (${data.current}/${data.total})` +}) + +// Handle completion +Once('processing-complete', () => { + progressBar.style.width = '100%' + statusText.textContent = 'Complete!' + setTimeout(() => hideProgressBar(), 2000) +}) +``` + +### Multi-Window Communication + +Perfect for applications with multiple windows like settings panels, dashboards, or document viewers. Broadcast events to synchronize state across all windows (theme changes, user preferences) or send targeted events to specific windows for window-specific updates. + +**Go:** + +```go +// Broadcast to all windows +app.Event.Emit("theme-changed", "dark") + +// Send to specific window +preferencesWindow.EmitEvent("settings-updated", settings) + +// Window-specific listener +window1.OnEvent("request-data", func(e *application.CustomEvent) { + // Only this window will receive this event + window1.EmitEvent("data-response", data) +}) +``` + +**JavaScript:** + +```javascript +import { On } from '@wailsio/runtime' + +// Listen in any window +On('theme-changed', (theme) => { + document.body.className = theme +}) +``` + +### State Synchronization + +Use when you need to keep frontend and backend state in sync, such as user sessions, application configuration, or collaborative features. When state changes on the backend, emit events to update all connected frontends, ensuring consistency across your application. + +**Go:** + +```go +type StateService struct { + app *application.Application + state map[string]interface{} + mu sync.RWMutex +} + +func (s *StateService) UpdateState(key string, value interface{}) { + s.mu.Lock() + s.state[key] = value + s.mu.Unlock() + + // Notify all windows + s.app.Event.Emit("state-updated", map[string]interface{}{ + "key": key, + "value": value, + }) +} + +func (s *StateService) GetState(key string) interface{} { + s.mu.RLock() + defer s.mu.RUnlock() + return s.state[key] +} +``` + +**JavaScript:** + +```javascript +import { On } from '@wailsio/runtime' +import { GetState } from './bindings/StateService' + +// Keep local state in sync +let localState = {} + +On('state-updated', async (data) => { + localState[data.key] = data.value + updateUI(data.key, data.value) +}) + +// Initialize state +const initialState = await GetState("all") +localState = initialState +``` + +### Event-Driven Notifications + +Best for displaying user feedback like success confirmations, error alerts, or info messages. Instead of calling UI code directly from services, emit notification events that the frontend handles consistently, making it easy to change notification styles or add features like notification history. + +**Go:** + +```go +type NotificationService struct { + app *application.Application +} + +func (s *NotificationService) Success(message string) { + s.app.Event.Emit("notification", map[string]interface{}{ + "type": "success", + "message": message, + }) +} + +func (s *NotificationService) Error(message string) { + s.app.Event.Emit("notification", map[string]interface{}{ + "type": "error", + "message": message, + }) +} + +func (s *NotificationService) Info(message string) { + s.app.Event.Emit("notification", map[string]interface{}{ + "type": "info", + "message": message, + }) +} +``` + +**JavaScript:** + +```javascript +import { On } from '@wailsio/runtime' + +// Unified notification handler +On('notification', (data) => { + const toast = document.createElement('div') + toast.className = `toast toast-${data.type}` + toast.textContent = data.message + + document.body.appendChild(toast) + + setTimeout(() => { + toast.classList.add('fade-out') + setTimeout(() => toast.remove(), 300) + }, 3000) +}) +``` + +## Complete Example + +**Go:** + +```go +package main + +import ( + "sync" + "time" + "github.com/wailsapp/wails/v3/pkg/application" +) + +type EventDemoService struct { + app *application.Application + mu sync.Mutex +} + +func NewEventDemoService(app *application.Application) *EventDemoService { + service := &EventDemoService{app: app} + + // Listen for custom events + app.Event.On("user-action", func(e *application.CustomEvent) { + data := e.Data.(map[string]interface{}) + app.Logger.Info("User action received", "data", data) + }) + + return service +} + +func (s *EventDemoService) StartLongTask() { + go func() { + s.app.Event.Emit("task-started") + + for i := 1; i <= 10; i++ { + time.Sleep(500 * time.Millisecond) + + s.app.Event.Emit("task-progress", map[string]interface{}{ + "step": i, + "total": 10, + "percent": i * 10, + }) + } + + s.app.Event.Emit("task-completed", map[string]interface{}{ + "message": "Task finished successfully!", + }) + }() +} + +func (s *EventDemoService) BroadcastMessage(message string) { + s.app.Event.Emit("broadcast", message) +} + +func main() { + app := application.New(application.Options{ + Name: "Event Demo", + }) + + // Handle application lifecycle + app.Event.OnApplicationEvent(application.EventApplicationStarted, func(e *application.ApplicationEvent) { + app.Logger.Info("Application started!") + }) + + app.Event.OnApplicationEvent(application.EventApplicationShutdown, func(e *application.ApplicationEvent) { + app.Logger.Info("Application shutting down...") + }) + + // Register service + service := NewEventDemoService(app) + app.RegisterService(application.NewService(service)) + + // Create window + window := app.Window.New() + + // Handle window events + window.OnWindowEvent(events.Common.WindowFocus, func(e *application.WindowEvent) { + window.EmitEvent("window-state", "focused") + }) + + window.OnWindowEvent(events.Common.WindowLostFocus, func(e *application.WindowEvent) { + window.EmitEvent("window-state", "blurred") + }) + + window.Show() + app.Run() +} +``` + +**JavaScript:** + +```javascript +import { On, Once } from '@wailsio/runtime' +import { StartLongTask, BroadcastMessage } from './bindings/EventDemoService' + +// Task events +On('task-started', () => { + console.log('Task started...') + document.getElementById('status').textContent = 'Running...' +}) + +On('task-progress', (data) => { + const progressBar = document.getElementById('progress') + progressBar.style.width = `${data.percent}%` + console.log(`Step ${data.step} of ${data.total}`) +}) + +Once('task-completed', (data) => { + console.log('Task completed!', data.message) + document.getElementById('status').textContent = data.message +}) + +// Broadcast events +On('broadcast', (message) => { + console.log('Broadcast:', message) + alert(message) +}) + +// Window state events +On('window-state', (state) => { + console.log('Window is now:', state) + document.body.dataset.windowState = state +}) + +// Trigger long task +document.getElementById('startTask').addEventListener('click', async () => { + await StartLongTask() +}) + +// Send broadcast +document.getElementById('broadcast').addEventListener('click', async () => { + const message = document.getElementById('message').value + await BroadcastMessage(message) +}) +``` + +## Built-in Events + +Wails provides built-in system events for application and window lifecycle. These events are emitted automatically by the framework. + +### Common Events vs Platform-Native Events + +Wails provides two types of system events: + +**Common Events** (`events.Common.*`) are cross-platform abstractions that work consistently across macOS, Windows, and Linux. These are the events you should use in your application for maximum portability. + +**Platform-Native Events** (`events.Mac.*`, `events.Windows.*`, `events.Linux.*`) are the underlying OS-specific events that Common Events are mapped from. These provide access to platform-specific behaviors and edge cases. + +**How They Work:** + +```go +import "github.com/wailsapp/wails/v3/pkg/events" + +// ✅ RECOMMENDED: Use Common Events for cross-platform code +window.OnWindowEvent(events.Common.WindowClosing, func(e *application.WindowEvent) { + // This works on all platforms +}) + +// Platform-specific events for advanced use cases +window.OnWindowEvent(events.Mac.WindowWillClose, func(e *application.WindowEvent) { + // macOS-specific "will close" event (before WindowClosing) +}) + +window.OnWindowEvent(events.Windows.WindowClosing, func(e *application.WindowEvent) { + // Windows-specific close event +}) +``` + +**Event Mapping:** + +Platform-native events are automatically mapped to Common Events: + +- macOS: `events.Mac.WindowShouldClose` → `events.Common.WindowClosing` +- Windows: `events.Windows.WindowClosing` → `events.Common.WindowClosing` +- Linux: `events.Linux.WindowDeleteEvent` → `events.Common.WindowClosing` + +This mapping happens automatically in the background, so when you listen for `events.Common.WindowClosing`, you'll receive it regardless of the platform. + +**When to Use Each:** + +- **Use Common Events** for 99% of your application code - they provide consistent behavior across platforms +- **Use Platform-Native Events** only when you need platform-specific functionality that isn't available in Common Events (e.g., macOS-specific window lifecycle events, Windows power management events) + +### Application Events + +| Event | Description | When Emitted | Cancellable | +|-------|-------------|--------------|-------------| +| `ApplicationOpenedWithFile` | Application opened with a file | When app is launched with a file (e.g., from file association) | No | +| `ApplicationStarted` | Application has finished launching | After app initialization is complete and app is ready | No | +| `ApplicationLaunchedWithUrl` | Application launched with a URL | When app is launched via URL scheme | No | +| `ThemeChanged` | System theme changed | When OS theme switches between light/dark mode | No | + +**Usage:** + +```go +import "github.com/wailsapp/wails/v3/pkg/events" + +app.Event.OnApplicationEvent(events.Common.ApplicationStarted, func(e *application.ApplicationEvent) { + app.Logger.Info("Application ready!") +}) + +app.Event.OnApplicationEvent(events.Common.ThemeChanged, func(e *application.ApplicationEvent) { + // Update app theme +}) +``` + +### Window Events + +| Event | Description | When Emitted | Cancellable | +|-------|-------------|--------------|-------------| +| `WindowClosing` | Window is about to close | Before window closes (user clicked X, Close() called) | Yes | +| `WindowDidMove` | Window moved to new position | After window position changes (debounced) | No | +| `WindowDidResize` | Window was resized | After window size changes | No | +| `WindowDPIChanged` | Window DPI scaling changed | When moving between monitors with different DPI (Windows) | No | +| `WindowFilesDropped` | Files dropped via native OS drag-drop | After files are dropped from OS onto window | No | +| `WindowFocus` | Window gained focus | When window becomes active | No | +| `WindowFullscreen` | Window entered fullscreen | After Fullscreen() or user enters fullscreen | No | +| `WindowHide` | Window was hidden | After Hide() or window becomes occluded | No | +| `WindowLostFocus` | Window lost focus | When window becomes inactive | No | +| `WindowMaximise` | Window was maximized | After Maximise() or user maximizes | Yes (macOS) | +| `WindowMinimise` | Window was minimized | After Minimise() or user minimizes | Yes (macOS) | +| `WindowRestore` | Window restored from min/max state | After Restore() (Windows primarily) | No | +| `WindowRuntimeReady` | Wails runtime loaded and ready | When JavaScript runtime initialization completes | No | +| `WindowShow` | Window became visible | After Show() or window becomes visible | No | +| `WindowUnFullscreen` | Window exited fullscreen | After UnFullscreen() or user exits fullscreen | No | +| `WindowUnMaximise` | Window exited maximized state | After UnMaximise() or user unmaximizes | Yes (macOS) | +| `WindowUnMinimise` | Window exited minimized state | After UnMinimise()/Restore() or user restores | Yes (macOS) | +| `WindowZoomIn` | Window content zoom increased | After ZoomIn() called (macOS primarily) | Yes (macOS) | +| `WindowZoomOut` | Window content zoom decreased | After ZoomOut() called (macOS primarily) | Yes (macOS) | +| `WindowZoomReset` | Window content zoom reset to 100% | After ZoomReset() called (macOS primarily) | Yes (macOS) | +| `WindowDropZoneFilesDropped` | Files dropped on JS-defined drop zone | When files dropped onto element with drop zone | No | + +**Usage:** + +```go +import "github.com/wailsapp/wails/v3/pkg/events" + +// Listen for window events +window.OnWindowEvent(events.Common.WindowFocus, func(e *application.WindowEvent) { + app.Logger.Info("Window focused") +}) + +// Cancel window close +window.RegisterHook(events.Common.WindowClosing, func(e *application.WindowEvent) { + result, _ := app.Dialog.Question(). + SetMessage("Close window?"). + SetButtons("Yes", "No"). + Show() + + if result == "No" { + e.Cancel() // Prevent close + } +}) + +// Wait for runtime ready +window.OnWindowEvent(events.Common.WindowRuntimeReady, func(e *application.WindowEvent) { + app.Logger.Info("Runtime ready, safe to emit events to frontend") + window.EmitEvent("app-initialized", data) +}) +``` + +**Important Notes:** + +- **WindowRuntimeReady** is critical - wait for this event before emitting events to the frontend +- **WindowDidMove** and **WindowDidResize** are debounced (50ms default) to prevent event flooding +- **Cancellable events** can be prevented by calling `event.Cancel()` in a `RegisterHook()` handler +- **WindowFilesDropped** is for native OS file drops; **WindowDropZoneFilesDropped** is for web-based drop zones +- Some events are platform-specific (e.g., WindowDPIChanged on Windows, zoom events primarily on macOS) + +## Event Naming Conventions + +```go +// Good - descriptive and specific +app.Event.Emit("user:logged-in", user) +app.Event.Emit("data:fetch:complete", results) +app.Event.Emit("ui:theme:changed", theme) + +// Bad - vague and unclear +app.Event.Emit("event1", data) +app.Event.Emit("update", stuff) +app.Event.Emit("e", value) +``` + +## Performance Considerations + +### Debouncing High-Frequency Events + +```go +type Service struct { + app *application.Application + lastEmit time.Time + debounceWindow time.Duration +} + +func (s *Service) EmitWithDebounce(event string, data interface{}) { + now := time.Now() + if now.Sub(s.lastEmit) < s.debounceWindow { + return // Skip this emission + } + + s.app.Event.Emit(event, data) + s.lastEmit = now +} +``` + +### Throttling Events + +```javascript +import { On } from '@wailsio/runtime' + +let lastUpdate = 0 +const throttleMs = 100 + +On('high-frequency-event', (data) => { + const now = Date.now() + if (now - lastUpdate < throttleMs) { + return // Skip this update + } + + processUpdate(data) + lastUpdate = now +}) +``` diff --git a/docs/src/content/docs/reference/frontend-runtime.mdx b/docs/src/content/docs/reference/frontend-runtime.mdx new file mode 100644 index 000000000..4d56667fc --- /dev/null +++ b/docs/src/content/docs/reference/frontend-runtime.mdx @@ -0,0 +1,953 @@ +--- +title: Frontend Runtime +description: The Wails JavaScript runtime package for frontend integration +sidebar: + order: 1 +--- + +The Wails frontend runtime is the standard library for Wails applications. It provides a +number of features that may be used in your applications, including: + +- Window management +- Dialogs +- Browser integration +- Clipboard +- Menus +- System information +- Events +- Context Menus +- Screens +- WML (Wails Markup Language) + +The runtime is required for integration between Go and the frontend. There are 2 +ways to integrate the runtime: + +- Using the `@wailsio/runtime` package +- Using a pre-built bundle + +## Using the npm package + +The `@wailsio/runtime` package is a JavaScript package that provides access to +the Wails runtime from the frontend. It is used by all standard templates +and is the recommended way to integrate the runtime into your application. +By using the `@wailsio/runtime` package, you will only include the parts of the runtime that you use. + +The package is available on npm and can be installed using: + +```shell +npm install --save @wailsio/runtime +``` + +## Using a pre-built bundle + +Some projects will not use a Javascript bundler and may prefer to use a +pre-built bundled version of the runtime. This version can be generated locally +using the following command: + +```shell +wails3 generate runtime +``` + +The command will output a `runtime.js` (and `runtime.debug.js`) file in the current +directory. This file is an ES module that can be imported by your application scripts +just like the npm package, but the API is also exported to the global window object, +so for simpler applications you can use it as follows: + +```html + + + + + + + +``` + +:::caution +It is important to include the `type="module"` attribute on the ` + + + ``` + + Run `wails3 dev` to start the dev server. After a few seconds, the application should open. + + Type in some text and click the "Generate QR Code" button. You should see a QR code in the center of the page: + + QR Code + +
      +
      + +7. ## Alternative Approach: HTTP Handler + + So far, we have covered the following areas: + - Creating a new Service + - Generating Bindings + - Using the Bindings in our Frontend code + + **Why use an HTTP handler?** + + Method bindings work great for data operations, but there's an alternative approach for serving files, images, or other media. Instead of converting everything to base64 and sending it through bindings, you can make your service act like a mini web server. + + This is useful when: + - You're serving images, videos, or large files + - You want to use standard HTML `` or `
      -`; -document.getElementById('logo').src = logo; - -let nameElement = document.getElementById("name"); -nameElement.focus(); -let resultElement = document.getElementById("result"); - -// Setup the greet function -window.greet = function () { - // Get name - let name = nameElement.value; - - // Check if the input is empty - if (name === "") return; - - // Call App.Greet(name) - try { - Greet(name) - .then((result) => { - // Update result with data back from App.Greet() - resultElement.innerText = result; - }) - .catch((err) => { - console.error(err); - }); - } catch (err) { - console.error(err); - } -}; - -// Auto-call Greet after 5 seconds to trigger the panic test -setTimeout(() => { - console.log("Auto-calling Greet to trigger panic test..."); - Greet("PanicTest") - .then((result) => { - resultElement.innerText = result + " (auto-called - panic will occur in 5s)"; - }) - .catch((err) => { - console.error("Error:", err); - }); -}, 5000); diff --git a/v2/examples/panic-recovery-test/frontend/src/style.css b/v2/examples/panic-recovery-test/frontend/src/style.css deleted file mode 100644 index 3940d6c63..000000000 --- a/v2/examples/panic-recovery-test/frontend/src/style.css +++ /dev/null @@ -1,26 +0,0 @@ -html { - background-color: rgba(27, 38, 54, 1); - text-align: center; - color: white; -} - -body { - margin: 0; - color: white; - font-family: "Nunito", -apple-system, BlinkMacSystemFont, "Segoe UI", "Roboto", - "Oxygen", "Ubuntu", "Cantarell", "Fira Sans", "Droid Sans", "Helvetica Neue", - sans-serif; -} - -@font-face { - font-family: "Nunito"; - font-style: normal; - font-weight: 400; - src: local(""), - url("assets/fonts/nunito-v16-latin-regular.woff2") format("woff2"); -} - -#app { - height: 100vh; - text-align: center; -} diff --git a/v2/examples/panic-recovery-test/frontend/wailsjs/go/main/App.d.ts b/v2/examples/panic-recovery-test/frontend/wailsjs/go/main/App.d.ts deleted file mode 100755 index 02a3bb988..000000000 --- a/v2/examples/panic-recovery-test/frontend/wailsjs/go/main/App.d.ts +++ /dev/null @@ -1,4 +0,0 @@ -// Cynhyrchwyd y ffeil hon yn awtomatig. PEIDIWCH Â MODIWL -// This file is automatically generated. DO NOT EDIT - -export function Greet(arg1:string):Promise; diff --git a/v2/examples/panic-recovery-test/frontend/wailsjs/go/main/App.js b/v2/examples/panic-recovery-test/frontend/wailsjs/go/main/App.js deleted file mode 100755 index c71ae77cb..000000000 --- a/v2/examples/panic-recovery-test/frontend/wailsjs/go/main/App.js +++ /dev/null @@ -1,7 +0,0 @@ -// @ts-check -// Cynhyrchwyd y ffeil hon yn awtomatig. PEIDIWCH Â MODIWL -// This file is automatically generated. DO NOT EDIT - -export function Greet(arg1) { - return window['go']['main']['App']['Greet'](arg1); -} diff --git a/v2/examples/panic-recovery-test/frontend/wailsjs/runtime/package.json b/v2/examples/panic-recovery-test/frontend/wailsjs/runtime/package.json deleted file mode 100644 index 1e7c8a5d7..000000000 --- a/v2/examples/panic-recovery-test/frontend/wailsjs/runtime/package.json +++ /dev/null @@ -1,24 +0,0 @@ -{ - "name": "@wailsapp/runtime", - "version": "2.0.0", - "description": "Wails Javascript runtime library", - "main": "runtime.js", - "types": "runtime.d.ts", - "scripts": { - }, - "repository": { - "type": "git", - "url": "git+https://github.com/wailsapp/wails.git" - }, - "keywords": [ - "Wails", - "Javascript", - "Go" - ], - "author": "Lea Anthony ", - "license": "MIT", - "bugs": { - "url": "https://github.com/wailsapp/wails/issues" - }, - "homepage": "https://github.com/wailsapp/wails#readme" -} diff --git a/v2/examples/panic-recovery-test/frontend/wailsjs/runtime/runtime.d.ts b/v2/examples/panic-recovery-test/frontend/wailsjs/runtime/runtime.d.ts deleted file mode 100644 index 4445dac21..000000000 --- a/v2/examples/panic-recovery-test/frontend/wailsjs/runtime/runtime.d.ts +++ /dev/null @@ -1,249 +0,0 @@ -/* - _ __ _ __ -| | / /___ _(_) /____ -| | /| / / __ `/ / / ___/ -| |/ |/ / /_/ / / (__ ) -|__/|__/\__,_/_/_/____/ -The electron alternative for Go -(c) Lea Anthony 2019-present -*/ - -export interface Position { - x: number; - y: number; -} - -export interface Size { - w: number; - h: number; -} - -export interface Screen { - isCurrent: boolean; - isPrimary: boolean; - width : number - height : number -} - -// Environment information such as platform, buildtype, ... -export interface EnvironmentInfo { - buildType: string; - platform: string; - arch: string; -} - -// [EventsEmit](https://wails.io/docs/reference/runtime/events#eventsemit) -// emits the given event. Optional data may be passed with the event. -// This will trigger any event listeners. -export function EventsEmit(eventName: string, ...data: any): void; - -// [EventsOn](https://wails.io/docs/reference/runtime/events#eventson) sets up a listener for the given event name. -export function EventsOn(eventName: string, callback: (...data: any) => void): () => void; - -// [EventsOnMultiple](https://wails.io/docs/reference/runtime/events#eventsonmultiple) -// sets up a listener for the given event name, but will only trigger a given number times. -export function EventsOnMultiple(eventName: string, callback: (...data: any) => void, maxCallbacks: number): () => void; - -// [EventsOnce](https://wails.io/docs/reference/runtime/events#eventsonce) -// sets up a listener for the given event name, but will only trigger once. -export function EventsOnce(eventName: string, callback: (...data: any) => void): () => void; - -// [EventsOff](https://wails.io/docs/reference/runtime/events#eventsoff) -// unregisters the listener for the given event name. -export function EventsOff(eventName: string, ...additionalEventNames: string[]): void; - -// [EventsOffAll](https://wails.io/docs/reference/runtime/events#eventsoffall) -// unregisters all listeners. -export function EventsOffAll(): void; - -// [LogPrint](https://wails.io/docs/reference/runtime/log#logprint) -// logs the given message as a raw message -export function LogPrint(message: string): void; - -// [LogTrace](https://wails.io/docs/reference/runtime/log#logtrace) -// logs the given message at the `trace` log level. -export function LogTrace(message: string): void; - -// [LogDebug](https://wails.io/docs/reference/runtime/log#logdebug) -// logs the given message at the `debug` log level. -export function LogDebug(message: string): void; - -// [LogError](https://wails.io/docs/reference/runtime/log#logerror) -// logs the given message at the `error` log level. -export function LogError(message: string): void; - -// [LogFatal](https://wails.io/docs/reference/runtime/log#logfatal) -// logs the given message at the `fatal` log level. -// The application will quit after calling this method. -export function LogFatal(message: string): void; - -// [LogInfo](https://wails.io/docs/reference/runtime/log#loginfo) -// logs the given message at the `info` log level. -export function LogInfo(message: string): void; - -// [LogWarning](https://wails.io/docs/reference/runtime/log#logwarning) -// logs the given message at the `warning` log level. -export function LogWarning(message: string): void; - -// [WindowReload](https://wails.io/docs/reference/runtime/window#windowreload) -// Forces a reload by the main application as well as connected browsers. -export function WindowReload(): void; - -// [WindowReloadApp](https://wails.io/docs/reference/runtime/window#windowreloadapp) -// Reloads the application frontend. -export function WindowReloadApp(): void; - -// [WindowSetAlwaysOnTop](https://wails.io/docs/reference/runtime/window#windowsetalwaysontop) -// Sets the window AlwaysOnTop or not on top. -export function WindowSetAlwaysOnTop(b: boolean): void; - -// [WindowSetSystemDefaultTheme](https://wails.io/docs/next/reference/runtime/window#windowsetsystemdefaulttheme) -// *Windows only* -// Sets window theme to system default (dark/light). -export function WindowSetSystemDefaultTheme(): void; - -// [WindowSetLightTheme](https://wails.io/docs/next/reference/runtime/window#windowsetlighttheme) -// *Windows only* -// Sets window to light theme. -export function WindowSetLightTheme(): void; - -// [WindowSetDarkTheme](https://wails.io/docs/next/reference/runtime/window#windowsetdarktheme) -// *Windows only* -// Sets window to dark theme. -export function WindowSetDarkTheme(): void; - -// [WindowCenter](https://wails.io/docs/reference/runtime/window#windowcenter) -// Centers the window on the monitor the window is currently on. -export function WindowCenter(): void; - -// [WindowSetTitle](https://wails.io/docs/reference/runtime/window#windowsettitle) -// Sets the text in the window title bar. -export function WindowSetTitle(title: string): void; - -// [WindowFullscreen](https://wails.io/docs/reference/runtime/window#windowfullscreen) -// Makes the window full screen. -export function WindowFullscreen(): void; - -// [WindowUnfullscreen](https://wails.io/docs/reference/runtime/window#windowunfullscreen) -// Restores the previous window dimensions and position prior to full screen. -export function WindowUnfullscreen(): void; - -// [WindowIsFullscreen](https://wails.io/docs/reference/runtime/window#windowisfullscreen) -// Returns the state of the window, i.e. whether the window is in full screen mode or not. -export function WindowIsFullscreen(): Promise; - -// [WindowSetSize](https://wails.io/docs/reference/runtime/window#windowsetsize) -// Sets the width and height of the window. -export function WindowSetSize(width: number, height: number): void; - -// [WindowGetSize](https://wails.io/docs/reference/runtime/window#windowgetsize) -// Gets the width and height of the window. -export function WindowGetSize(): Promise; - -// [WindowSetMaxSize](https://wails.io/docs/reference/runtime/window#windowsetmaxsize) -// Sets the maximum window size. Will resize the window if the window is currently larger than the given dimensions. -// Setting a size of 0,0 will disable this constraint. -export function WindowSetMaxSize(width: number, height: number): void; - -// [WindowSetMinSize](https://wails.io/docs/reference/runtime/window#windowsetminsize) -// Sets the minimum window size. Will resize the window if the window is currently smaller than the given dimensions. -// Setting a size of 0,0 will disable this constraint. -export function WindowSetMinSize(width: number, height: number): void; - -// [WindowSetPosition](https://wails.io/docs/reference/runtime/window#windowsetposition) -// Sets the window position relative to the monitor the window is currently on. -export function WindowSetPosition(x: number, y: number): void; - -// [WindowGetPosition](https://wails.io/docs/reference/runtime/window#windowgetposition) -// Gets the window position relative to the monitor the window is currently on. -export function WindowGetPosition(): Promise; - -// [WindowHide](https://wails.io/docs/reference/runtime/window#windowhide) -// Hides the window. -export function WindowHide(): void; - -// [WindowShow](https://wails.io/docs/reference/runtime/window#windowshow) -// Shows the window, if it is currently hidden. -export function WindowShow(): void; - -// [WindowMaximise](https://wails.io/docs/reference/runtime/window#windowmaximise) -// Maximises the window to fill the screen. -export function WindowMaximise(): void; - -// [WindowToggleMaximise](https://wails.io/docs/reference/runtime/window#windowtogglemaximise) -// Toggles between Maximised and UnMaximised. -export function WindowToggleMaximise(): void; - -// [WindowUnmaximise](https://wails.io/docs/reference/runtime/window#windowunmaximise) -// Restores the window to the dimensions and position prior to maximising. -export function WindowUnmaximise(): void; - -// [WindowIsMaximised](https://wails.io/docs/reference/runtime/window#windowismaximised) -// Returns the state of the window, i.e. whether the window is maximised or not. -export function WindowIsMaximised(): Promise; - -// [WindowMinimise](https://wails.io/docs/reference/runtime/window#windowminimise) -// Minimises the window. -export function WindowMinimise(): void; - -// [WindowUnminimise](https://wails.io/docs/reference/runtime/window#windowunminimise) -// Restores the window to the dimensions and position prior to minimising. -export function WindowUnminimise(): void; - -// [WindowIsMinimised](https://wails.io/docs/reference/runtime/window#windowisminimised) -// Returns the state of the window, i.e. whether the window is minimised or not. -export function WindowIsMinimised(): Promise; - -// [WindowIsNormal](https://wails.io/docs/reference/runtime/window#windowisnormal) -// Returns the state of the window, i.e. whether the window is normal or not. -export function WindowIsNormal(): Promise; - -// [WindowSetBackgroundColour](https://wails.io/docs/reference/runtime/window#windowsetbackgroundcolour) -// Sets the background colour of the window to the given RGBA colour definition. This colour will show through for all transparent pixels. -export function WindowSetBackgroundColour(R: number, G: number, B: number, A: number): void; - -// [ScreenGetAll](https://wails.io/docs/reference/runtime/window#screengetall) -// Gets the all screens. Call this anew each time you want to refresh data from the underlying windowing system. -export function ScreenGetAll(): Promise; - -// [BrowserOpenURL](https://wails.io/docs/reference/runtime/browser#browseropenurl) -// Opens the given URL in the system browser. -export function BrowserOpenURL(url: string): void; - -// [Environment](https://wails.io/docs/reference/runtime/intro#environment) -// Returns information about the environment -export function Environment(): Promise; - -// [Quit](https://wails.io/docs/reference/runtime/intro#quit) -// Quits the application. -export function Quit(): void; - -// [Hide](https://wails.io/docs/reference/runtime/intro#hide) -// Hides the application. -export function Hide(): void; - -// [Show](https://wails.io/docs/reference/runtime/intro#show) -// Shows the application. -export function Show(): void; - -// [ClipboardGetText](https://wails.io/docs/reference/runtime/clipboard#clipboardgettext) -// Returns the current text stored on clipboard -export function ClipboardGetText(): Promise; - -// [ClipboardSetText](https://wails.io/docs/reference/runtime/clipboard#clipboardsettext) -// Sets a text on the clipboard -export function ClipboardSetText(text: string): Promise; - -// [OnFileDrop](https://wails.io/docs/reference/runtime/draganddrop#onfiledrop) -// OnFileDrop listens to drag and drop events and calls the callback with the coordinates of the drop and an array of path strings. -export function OnFileDrop(callback: (x: number, y: number ,paths: string[]) => void, useDropTarget: boolean) :void - -// [OnFileDropOff](https://wails.io/docs/reference/runtime/draganddrop#dragandddropoff) -// OnFileDropOff removes the drag and drop listeners and handlers. -export function OnFileDropOff() :void - -// Check if the file path resolver is available -export function CanResolveFilePaths(): boolean; - -// Resolves file paths for an array of files -export function ResolveFilePaths(files: File[]): void \ No newline at end of file diff --git a/v2/examples/panic-recovery-test/frontend/wailsjs/runtime/runtime.js b/v2/examples/panic-recovery-test/frontend/wailsjs/runtime/runtime.js deleted file mode 100644 index 7cb89d750..000000000 --- a/v2/examples/panic-recovery-test/frontend/wailsjs/runtime/runtime.js +++ /dev/null @@ -1,242 +0,0 @@ -/* - _ __ _ __ -| | / /___ _(_) /____ -| | /| / / __ `/ / / ___/ -| |/ |/ / /_/ / / (__ ) -|__/|__/\__,_/_/_/____/ -The electron alternative for Go -(c) Lea Anthony 2019-present -*/ - -export function LogPrint(message) { - window.runtime.LogPrint(message); -} - -export function LogTrace(message) { - window.runtime.LogTrace(message); -} - -export function LogDebug(message) { - window.runtime.LogDebug(message); -} - -export function LogInfo(message) { - window.runtime.LogInfo(message); -} - -export function LogWarning(message) { - window.runtime.LogWarning(message); -} - -export function LogError(message) { - window.runtime.LogError(message); -} - -export function LogFatal(message) { - window.runtime.LogFatal(message); -} - -export function EventsOnMultiple(eventName, callback, maxCallbacks) { - return window.runtime.EventsOnMultiple(eventName, callback, maxCallbacks); -} - -export function EventsOn(eventName, callback) { - return EventsOnMultiple(eventName, callback, -1); -} - -export function EventsOff(eventName, ...additionalEventNames) { - return window.runtime.EventsOff(eventName, ...additionalEventNames); -} - -export function EventsOffAll() { - return window.runtime.EventsOffAll(); -} - -export function EventsOnce(eventName, callback) { - return EventsOnMultiple(eventName, callback, 1); -} - -export function EventsEmit(eventName) { - let args = [eventName].slice.call(arguments); - return window.runtime.EventsEmit.apply(null, args); -} - -export function WindowReload() { - window.runtime.WindowReload(); -} - -export function WindowReloadApp() { - window.runtime.WindowReloadApp(); -} - -export function WindowSetAlwaysOnTop(b) { - window.runtime.WindowSetAlwaysOnTop(b); -} - -export function WindowSetSystemDefaultTheme() { - window.runtime.WindowSetSystemDefaultTheme(); -} - -export function WindowSetLightTheme() { - window.runtime.WindowSetLightTheme(); -} - -export function WindowSetDarkTheme() { - window.runtime.WindowSetDarkTheme(); -} - -export function WindowCenter() { - window.runtime.WindowCenter(); -} - -export function WindowSetTitle(title) { - window.runtime.WindowSetTitle(title); -} - -export function WindowFullscreen() { - window.runtime.WindowFullscreen(); -} - -export function WindowUnfullscreen() { - window.runtime.WindowUnfullscreen(); -} - -export function WindowIsFullscreen() { - return window.runtime.WindowIsFullscreen(); -} - -export function WindowGetSize() { - return window.runtime.WindowGetSize(); -} - -export function WindowSetSize(width, height) { - window.runtime.WindowSetSize(width, height); -} - -export function WindowSetMaxSize(width, height) { - window.runtime.WindowSetMaxSize(width, height); -} - -export function WindowSetMinSize(width, height) { - window.runtime.WindowSetMinSize(width, height); -} - -export function WindowSetPosition(x, y) { - window.runtime.WindowSetPosition(x, y); -} - -export function WindowGetPosition() { - return window.runtime.WindowGetPosition(); -} - -export function WindowHide() { - window.runtime.WindowHide(); -} - -export function WindowShow() { - window.runtime.WindowShow(); -} - -export function WindowMaximise() { - window.runtime.WindowMaximise(); -} - -export function WindowToggleMaximise() { - window.runtime.WindowToggleMaximise(); -} - -export function WindowUnmaximise() { - window.runtime.WindowUnmaximise(); -} - -export function WindowIsMaximised() { - return window.runtime.WindowIsMaximised(); -} - -export function WindowMinimise() { - window.runtime.WindowMinimise(); -} - -export function WindowUnminimise() { - window.runtime.WindowUnminimise(); -} - -export function WindowSetBackgroundColour(R, G, B, A) { - window.runtime.WindowSetBackgroundColour(R, G, B, A); -} - -export function ScreenGetAll() { - return window.runtime.ScreenGetAll(); -} - -export function WindowIsMinimised() { - return window.runtime.WindowIsMinimised(); -} - -export function WindowIsNormal() { - return window.runtime.WindowIsNormal(); -} - -export function BrowserOpenURL(url) { - window.runtime.BrowserOpenURL(url); -} - -export function Environment() { - return window.runtime.Environment(); -} - -export function Quit() { - window.runtime.Quit(); -} - -export function Hide() { - window.runtime.Hide(); -} - -export function Show() { - window.runtime.Show(); -} - -export function ClipboardGetText() { - return window.runtime.ClipboardGetText(); -} - -export function ClipboardSetText(text) { - return window.runtime.ClipboardSetText(text); -} - -/** - * Callback for OnFileDrop returns a slice of file path strings when a drop is finished. - * - * @export - * @callback OnFileDropCallback - * @param {number} x - x coordinate of the drop - * @param {number} y - y coordinate of the drop - * @param {string[]} paths - A list of file paths. - */ - -/** - * OnFileDrop listens to drag and drop events and calls the callback with the coordinates of the drop and an array of path strings. - * - * @export - * @param {OnFileDropCallback} callback - Callback for OnFileDrop returns a slice of file path strings when a drop is finished. - * @param {boolean} [useDropTarget=true] - Only call the callback when the drop finished on an element that has the drop target style. (--wails-drop-target) - */ -export function OnFileDrop(callback, useDropTarget) { - return window.runtime.OnFileDrop(callback, useDropTarget); -} - -/** - * OnFileDropOff removes the drag and drop listeners and handlers. - */ -export function OnFileDropOff() { - return window.runtime.OnFileDropOff(); -} - -export function CanResolveFilePaths() { - return window.runtime.CanResolveFilePaths(); -} - -export function ResolveFilePaths(files) { - return window.runtime.ResolveFilePaths(files); -} \ No newline at end of file diff --git a/v2/examples/panic-recovery-test/go.mod b/v2/examples/panic-recovery-test/go.mod deleted file mode 100644 index 026042cbf..000000000 --- a/v2/examples/panic-recovery-test/go.mod +++ /dev/null @@ -1,5 +0,0 @@ -module panic-recovery-test - -go 1.21 - -require github.com/wailsapp/wails/v2 v2.11.0 diff --git a/v2/examples/panic-recovery-test/main.go b/v2/examples/panic-recovery-test/main.go deleted file mode 100644 index f6a38e86c..000000000 --- a/v2/examples/panic-recovery-test/main.go +++ /dev/null @@ -1,36 +0,0 @@ -package main - -import ( - "embed" - - "github.com/wailsapp/wails/v2" - "github.com/wailsapp/wails/v2/pkg/options" - "github.com/wailsapp/wails/v2/pkg/options/assetserver" -) - -//go:embed all:frontend/dist -var assets embed.FS - -func main() { - // Create an instance of the app structure - app := NewApp() - - // Create application with options - err := wails.Run(&options.App{ - Title: "panic-test", - Width: 1024, - Height: 768, - AssetServer: &assetserver.Options{ - Assets: assets, - }, - BackgroundColour: &options.RGBA{R: 27, G: 38, B: 54, A: 1}, - OnStartup: app.startup, - Bind: []interface{}{ - app, - }, - }) - - if err != nil { - println("Error:", err.Error()) - } -} diff --git a/v2/examples/panic-recovery-test/wails.json b/v2/examples/panic-recovery-test/wails.json deleted file mode 100644 index 56770f091..000000000 --- a/v2/examples/panic-recovery-test/wails.json +++ /dev/null @@ -1,13 +0,0 @@ -{ - "$schema": "https://wails.io/schemas/config.v2.json", - "name": "panic-recovery-test", - "outputfilename": "panic-recovery-test", - "frontend:install": "npm install", - "frontend:build": "npm run build", - "frontend:dev:watcher": "npm run dev", - "frontend:dev:serverUrl": "auto", - "author": { - "name": "Lea Anthony", - "email": "lea.anthony@gmail.com" - } -} diff --git a/v2/go.mod b/v2/go.mod index 2eb753ee2..375f6ee6f 100644 --- a/v2/go.mod +++ b/v2/go.mod @@ -1,112 +1,109 @@ module github.com/wailsapp/wails/v2 -go 1.22.0 +go 1.21 require ( github.com/Masterminds/semver v1.5.0 github.com/acarl005/stripansi v0.0.0-20180116102854-5a71ef0e047d github.com/bep/debounce v1.2.1 - github.com/bitfield/script v0.24.0 - github.com/charmbracelet/glamour v0.8.0 - github.com/flytam/filenamify v1.2.0 - github.com/fsnotify/fsnotify v1.9.0 - github.com/go-git/go-git/v5 v5.13.2 - github.com/go-ole/go-ole v1.3.0 + github.com/bitfield/script v0.19.0 + github.com/charmbracelet/glamour v0.5.0 + github.com/flytam/filenamify v1.0.0 + github.com/fsnotify/fsnotify v1.4.9 + github.com/go-git/go-git/v5 v5.11.0 + github.com/go-ole/go-ole v1.2.6 github.com/godbus/dbus/v5 v5.1.0 github.com/google/shlex v0.0.0-20191202100458-e7afc7fbc510 - github.com/google/uuid v1.6.0 - github.com/gorilla/websocket v1.5.3 + github.com/google/uuid v1.3.0 github.com/jackmordaunt/icns v1.0.0 - github.com/jaypipes/ghw v0.21.3 - github.com/labstack/echo/v4 v4.13.3 - github.com/labstack/gommon v0.4.2 + github.com/jaypipes/ghw v0.12.0 + github.com/labstack/echo/v4 v4.10.2 + github.com/labstack/gommon v0.4.0 github.com/leaanthony/clir v1.3.0 github.com/leaanthony/debme v1.2.1 - github.com/leaanthony/go-ansi-parser v1.6.1 - github.com/leaanthony/gosod v1.0.4 + github.com/leaanthony/go-ansi-parser v1.6.0 + github.com/leaanthony/gosod v1.0.3 github.com/leaanthony/slicer v1.6.0 - github.com/leaanthony/u v1.1.1 + github.com/leaanthony/u v1.1.0 github.com/leaanthony/winicon v1.0.0 - github.com/matryer/is v1.4.1 - github.com/pkg/browser v0.0.0-20240102092130-5ac0b6a4141c + github.com/matryer/is v1.4.0 + github.com/pkg/browser v0.0.0-20210911075715-681adbf594b8 github.com/pkg/errors v0.9.1 - github.com/pterm/pterm v0.12.80 + github.com/pterm/pterm v0.12.49 github.com/sabhiram/go-gitignore v0.0.0-20210923224102-525f6e181f06 - github.com/samber/lo v1.49.1 - github.com/stretchr/testify v1.10.0 - github.com/tc-hib/winres v0.3.1 - github.com/tidwall/sjson v1.2.5 - github.com/tkrajina/go-reflector v0.5.8 - github.com/wailsapp/go-webview2 v1.0.22 + github.com/samber/lo v1.38.1 + github.com/stretchr/testify v1.8.4 + github.com/tc-hib/winres v0.2.1 + github.com/tidwall/sjson v1.1.7 + github.com/tkrajina/go-reflector v0.5.6 + github.com/wailsapp/go-webview2 v1.0.10 github.com/wailsapp/mimetype v1.4.1 github.com/wzshiming/ctc v1.2.3 - golang.org/x/mod v0.23.0 - golang.org/x/net v0.35.0 - golang.org/x/sys v0.30.0 - golang.org/x/tools v0.30.0 + golang.org/x/mod v0.14.0 + golang.org/x/net v0.25.0 + golang.org/x/sys v0.20.0 + golang.org/x/tools v0.17.0 ) require ( - atomicgo.dev/cursor v0.2.0 // indirect - atomicgo.dev/keyboard v0.2.9 // indirect - atomicgo.dev/schedule v0.1.0 // indirect + atomicgo.dev/cursor v0.1.1 // indirect + atomicgo.dev/keyboard v0.2.8 // indirect + bitbucket.org/creachadair/shell v0.0.7 // indirect dario.cat/mergo v1.0.0 // indirect github.com/Microsoft/go-winio v0.6.1 // indirect - github.com/ProtonMail/go-crypto v1.1.5 // indirect - github.com/alecthomas/chroma/v2 v2.14.0 // indirect - github.com/aymanbagabas/go-osc52/v2 v2.0.1 // indirect + github.com/ProtonMail/go-crypto v0.0.0-20230828082145-3c4c8a2d2371 // indirect + github.com/StackExchange/wmi v1.2.1 // indirect + github.com/alecthomas/chroma v0.10.0 // indirect github.com/aymerick/douceur v0.2.0 // indirect - github.com/charmbracelet/lipgloss v0.12.1 // indirect - github.com/charmbracelet/x/ansi v0.1.4 // indirect github.com/cloudflare/circl v1.3.7 // indirect github.com/containerd/console v1.0.3 // indirect - github.com/cyphar/filepath-securejoin v0.3.6 // indirect + github.com/cyphar/filepath-securejoin v0.2.4 // indirect github.com/davecgh/go-spew v1.1.1 // indirect - github.com/dlclark/regexp2 v1.11.0 // indirect + github.com/dlclark/regexp2 v1.4.0 // indirect github.com/emirpasic/gods v1.18.1 // indirect + github.com/ghodss/yaml v1.0.0 // indirect github.com/go-git/gcfg v1.5.1-0.20230307220236-3a3c6141e376 // indirect - github.com/go-git/go-billy/v5 v5.6.2 // indirect + github.com/go-git/go-billy/v5 v5.5.0 // indirect github.com/golang/groupcache v0.0.0-20210331224755-41bb18bfe9da // indirect - github.com/gookit/color v1.5.4 // indirect - github.com/gorilla/css v1.0.1 // indirect - github.com/itchyny/gojq v0.12.13 // indirect - github.com/itchyny/timefmt-go v0.1.5 // indirect - github.com/jaypipes/pcidb v1.1.1 // indirect + github.com/gookit/color v1.5.2 // indirect + github.com/gorilla/css v1.0.0 // indirect + github.com/jaypipes/pcidb v1.0.0 // indirect github.com/jbenet/go-context v0.0.0-20150711004518-d14ea06fba99 // indirect github.com/jchv/go-winloader v0.0.0-20210711035445-715c2860da7e // indirect github.com/kevinburke/ssh_config v1.2.0 // indirect - github.com/lithammer/fuzzysearch v1.1.8 // indirect + github.com/lithammer/fuzzysearch v1.1.5 // indirect github.com/lucasb-eyer/go-colorful v1.2.0 // indirect github.com/mattn/go-colorable v0.1.13 // indirect - github.com/mattn/go-isatty v0.0.20 // indirect - github.com/mattn/go-runewidth v0.0.16 // indirect - github.com/microcosm-cc/bluemonday v1.0.27 // indirect + github.com/mattn/go-isatty v0.0.19 // indirect + github.com/mattn/go-runewidth v0.0.13 // indirect + github.com/microcosm-cc/bluemonday v1.0.17 // indirect + github.com/mitchellh/go-homedir v1.1.0 // indirect github.com/muesli/reflow v0.3.0 // indirect - github.com/muesli/termenv v0.15.3-0.20240618155329-98d742f6907a // indirect + github.com/muesli/termenv v0.9.0 // indirect github.com/nfnt/resize v0.0.0-20180221191011-83c6a9932646 // indirect - github.com/pjbgf/sha1cd v0.3.2 // indirect + github.com/olekukonko/tablewriter v0.0.5 // indirect + github.com/pjbgf/sha1cd v0.3.0 // indirect github.com/pmezard/go-difflib v1.0.0 // indirect - github.com/rivo/uniseg v0.4.7 // indirect - github.com/sergi/go-diff v1.3.2-0.20230802210424-5b0b94c5c0d3 // indirect - github.com/skeema/knownhosts v1.3.0 // indirect - github.com/tidwall/gjson v1.14.2 // indirect + github.com/rivo/uniseg v0.4.4 // indirect + github.com/sergi/go-diff v1.2.0 // indirect + github.com/skeema/knownhosts v1.2.1 // indirect + github.com/tidwall/gjson v1.9.3 // indirect github.com/tidwall/match v1.1.1 // indirect github.com/tidwall/pretty v1.2.0 // indirect github.com/valyala/bytebufferpool v1.0.0 // indirect github.com/valyala/fasttemplate v1.2.2 // indirect github.com/wzshiming/winseq v0.0.0-20200112104235-db357dc107ae // indirect github.com/xanzy/ssh-agent v0.3.3 // indirect - github.com/xo/terminfo v0.0.0-20220910002029-abceb7e1c41e // indirect - github.com/yuin/goldmark v1.7.4 // indirect - github.com/yuin/goldmark-emoji v1.0.3 // indirect - github.com/yusufpapurcu/wmi v1.2.4 // indirect - golang.org/x/crypto v0.33.0 // indirect + github.com/xo/terminfo v0.0.0-20210125001918-ca9a967f8778 // indirect + github.com/yuin/goldmark v1.4.13 // indirect + github.com/yuin/goldmark-emoji v1.0.1 // indirect + golang.org/x/crypto v0.23.0 // indirect + golang.org/x/exp v0.0.0-20230522175609-2e198f4a06a1 // indirect golang.org/x/image v0.12.0 // indirect - golang.org/x/sync v0.11.0 // indirect - golang.org/x/term v0.29.0 // indirect - golang.org/x/text v0.22.0 // indirect + golang.org/x/term v0.20.0 // indirect + golang.org/x/text v0.15.0 // indirect gopkg.in/warnings.v0 v0.1.2 // indirect + gopkg.in/yaml.v2 v2.4.0 // indirect gopkg.in/yaml.v3 v3.0.1 // indirect - howett.net/plist v1.0.2-0.20250314012144-ee69052608d9 // indirect - mvdan.cc/sh/v3 v3.7.0 // indirect + howett.net/plist v1.0.0 // indirect ) diff --git a/v2/go.sum b/v2/go.sum index f6df3507e..6e273e1ba 100644 --- a/v2/go.sum +++ b/v2/go.sum @@ -1,11 +1,9 @@ -atomicgo.dev/assert v0.0.2 h1:FiKeMiZSgRrZsPo9qn/7vmr7mCsh5SZyXY4YGYiYwrg= -atomicgo.dev/assert v0.0.2/go.mod h1:ut4NcI3QDdJtlmAxQULOmA13Gz6e2DWbSAS8RUOmNYQ= -atomicgo.dev/cursor v0.2.0 h1:H6XN5alUJ52FZZUkI7AlJbUc1aW38GWZalpYRPpoPOw= -atomicgo.dev/cursor v0.2.0/go.mod h1:Lr4ZJB3U7DfPPOkbH7/6TOtJ4vFGHlgj1nc+n900IpU= -atomicgo.dev/keyboard v0.2.9 h1:tOsIid3nlPLZ3lwgG8KZMp/SFmr7P0ssEN5JUsm78K8= -atomicgo.dev/keyboard v0.2.9/go.mod h1:BC4w9g00XkxH/f1HXhW2sXmJFOCWbKn9xrOunSFtExQ= -atomicgo.dev/schedule v0.1.0 h1:nTthAbhZS5YZmgYbb2+DH8uQIZcTlIrd4eYr3UQxEjs= -atomicgo.dev/schedule v0.1.0/go.mod h1:xeUa3oAkiuHYh8bKiQBRojqAMq3PXXbJujjb0hw8pEU= +atomicgo.dev/cursor v0.1.1 h1:0t9sxQomCTRh5ug+hAMCs59x/UmC9QL6Ci5uosINKD4= +atomicgo.dev/cursor v0.1.1/go.mod h1:Lr4ZJB3U7DfPPOkbH7/6TOtJ4vFGHlgj1nc+n900IpU= +atomicgo.dev/keyboard v0.2.8 h1:Di09BitwZgdTV1hPyX/b9Cqxi8HVuJQwWivnZUEqlj4= +atomicgo.dev/keyboard v0.2.8/go.mod h1:BC4w9g00XkxH/f1HXhW2sXmJFOCWbKn9xrOunSFtExQ= +bitbucket.org/creachadair/shell v0.0.7 h1:Z96pB6DkSb7F3Y3BBnJeOZH2gazyMTWlvecSD4vDqfk= +bitbucket.org/creachadair/shell v0.0.7/go.mod h1:oqtXSSvSYr4624lnnabXHaBsYW6RD80caLi2b3hJk0U= dario.cat/mergo v1.0.0 h1:AGCNq9Evsj31mOgNPcLyXc+4PNABt905YmuqPYYpBWk= dario.cat/mergo v1.0.0/go.mod h1:uNxQE+84aUszobStD9th8a29P2fMDhsBdgRYvZOxGmk= github.com/MarvinJWendt/testza v0.1.0/go.mod h1:7AxNvlfeHP7Z/hDQ5JtE3OKYT3XFUeLCDE2DQninSqs= @@ -15,110 +13,94 @@ github.com/MarvinJWendt/testza v0.2.10/go.mod h1:pd+VWsoGUiFtq+hRKSU1Bktnn+DMCSr github.com/MarvinJWendt/testza v0.2.12/go.mod h1:JOIegYyV7rX+7VZ9r77L/eH6CfJHHzXjB69adAhzZkI= github.com/MarvinJWendt/testza v0.3.0/go.mod h1:eFcL4I0idjtIx8P9C6KkAuLgATNKpX4/2oUqKc6bF2c= github.com/MarvinJWendt/testza v0.4.2/go.mod h1:mSdhXiKH8sg/gQehJ63bINcCKp7RtYewEjXsvsVUPbE= -github.com/MarvinJWendt/testza v0.5.2 h1:53KDo64C1z/h/d/stCYCPY69bt/OSwjq5KpFNwi+zB4= -github.com/MarvinJWendt/testza v0.5.2/go.mod h1:xu53QFE5sCdjtMCKk8YMQ2MnymimEctc4n3EjyIYvEY= +github.com/MarvinJWendt/testza v0.4.3 h1:u2XaM4IqGp9dsdUmML8/Z791fu4yjQYzOiufOtJwTII= +github.com/MarvinJWendt/testza v0.4.3/go.mod h1:CpXaOfceNEYnLDtNIyTrPPcCpDJYqzZnu2aiA2Wp33U= github.com/Masterminds/semver v1.5.0 h1:H65muMkzWKEuNDnfl9d70GUjFniHKHRbFPGBuZ3QEww= github.com/Masterminds/semver v1.5.0/go.mod h1:MB6lktGJrhw8PrUyiEoblNEGEQ+RzHPF078ddwwvV3Y= github.com/Microsoft/go-winio v0.5.2/go.mod h1:WpS1mjBmmwHBEWmogvA2mj8546UReBk4v8QkMxJ6pZY= github.com/Microsoft/go-winio v0.6.1 h1:9/kr64B9VUZrLm5YYwbGtUJnMgqWVOdUAXu6Migciow= github.com/Microsoft/go-winio v0.6.1/go.mod h1:LRdKpFKfdobln8UmuiYcKPot9D2v6svN5+sAH+4kjUM= -github.com/ProtonMail/go-crypto v1.1.5 h1:eoAQfK2dwL+tFSFpr7TbOaPNUbPiJj4fLYwwGE1FQO4= -github.com/ProtonMail/go-crypto v1.1.5/go.mod h1:rA3QumHc/FZ8pAHreoekgiAbzpNsfQAosU5td4SnOrE= +github.com/ProtonMail/go-crypto v0.0.0-20230828082145-3c4c8a2d2371 h1:kkhsdkhsCvIsutKu5zLMgWtgh9YxGCNAw8Ad8hjwfYg= +github.com/ProtonMail/go-crypto v0.0.0-20230828082145-3c4c8a2d2371/go.mod h1:EjAoLdwvbIOoOQr3ihjnSoLZRtE8azugULFRteWMNc0= +github.com/StackExchange/wmi v1.2.1 h1:VIkavFPXSjcnS+O8yTq7NI32k0R5Aj+v39y29VYDOSA= +github.com/StackExchange/wmi v1.2.1/go.mod h1:rcmrprowKIVzvc+NUiLncP2uuArMWLCbu9SBzvHz7e8= github.com/acarl005/stripansi v0.0.0-20180116102854-5a71ef0e047d h1:licZJFw2RwpHMqeKTCYkitsPqHNxTmd4SNR5r94FGM8= github.com/acarl005/stripansi v0.0.0-20180116102854-5a71ef0e047d/go.mod h1:asat636LX7Bqt5lYEZ27JNDcqxfjdBQuJ/MM4CN/Lzo= -github.com/alecthomas/assert/v2 v2.7.0 h1:QtqSACNS3tF7oasA8CU6A6sXZSBDqnm7RfpLl9bZqbE= -github.com/alecthomas/assert/v2 v2.7.0/go.mod h1:Bze95FyfUr7x34QZrjL+XP+0qgp/zg8yS+TtBj1WA3k= -github.com/alecthomas/chroma/v2 v2.14.0 h1:R3+wzpnUArGcQz7fCETQBzO5n9IMNi13iIs46aU4V9E= -github.com/alecthomas/chroma/v2 v2.14.0/go.mod h1:QolEbTfmUHIMVpBqxeDnNBj2uoeI4EbYP4i6n68SG4I= -github.com/alecthomas/repr v0.4.0 h1:GhI2A8MACjfegCPVq9f1FLvIBS+DrQ2KQBFZP1iFzXc= -github.com/alecthomas/repr v0.4.0/go.mod h1:Fr0507jx4eOXV7AlPV6AVZLYrLIuIeSOWtW57eE/O/4= +github.com/alecthomas/chroma v0.10.0 h1:7XDcGkCQopCNKjZHfYrNLraA+M7e0fMiJ/Mfikbfjek= +github.com/alecthomas/chroma v0.10.0/go.mod h1:jtJATyUxlIORhUOFNA9NZDWGAQ8wpxQQqNSB4rjA/1s= github.com/anmitsu/go-shlex v0.0.0-20200514113438-38f4b401e2be h1:9AeTilPcZAjCFIImctFaOjnTIavg87rW78vTPkQqLI8= github.com/anmitsu/go-shlex v0.0.0-20200514113438-38f4b401e2be/go.mod h1:ySMOLuWl6zY27l47sB3qLNK6tF2fkHG55UZxx8oIVo4= github.com/armon/go-socks5 v0.0.0-20160902184237-e75332964ef5 h1:0CwZNZbxp69SHPdPJAN/hZIm0C4OItdklCFmMRWYpio= github.com/armon/go-socks5 v0.0.0-20160902184237-e75332964ef5/go.mod h1:wHh0iHkYZB8zMSxRWpUBQtwG5a7fFgvEO+odwuTv2gs= github.com/atomicgo/cursor v0.0.1/go.mod h1:cBON2QmmrysudxNBFthvMtN32r3jxVRIvzkUiF/RuIk= -github.com/aymanbagabas/go-osc52/v2 v2.0.1 h1:HwpRHbFMcZLEVr42D4p7XBqjyuxQH5SMiErDT4WkJ2k= -github.com/aymanbagabas/go-osc52/v2 v2.0.1/go.mod h1:uYgXzlJ7ZpABp8OJ+exZzJJhRNQ2ASbcXHWsFqH8hp8= -github.com/aymanbagabas/go-udiff v0.2.0 h1:TK0fH4MteXUDspT88n8CKzvK0X9O2xu9yQjWpi6yML8= -github.com/aymanbagabas/go-udiff v0.2.0/go.mod h1:RE4Ex0qsGkTAJoQdQQCA0uG+nAzJO/pI/QwceO5fgrA= github.com/aymerick/douceur v0.2.0 h1:Mv+mAeH1Q+n9Fr+oyamOlAkUNPWPlA8PPGR0QAaYuPk= github.com/aymerick/douceur v0.2.0/go.mod h1:wlT5vV2O3h55X9m7iVYN0TBM0NH/MmbLnd30/FjWUq4= github.com/bep/debounce v1.2.1 h1:v67fRdBA9UQu2NhLFXrSg0Brw7CexQekrBwDMM8bzeY= github.com/bep/debounce v1.2.1/go.mod h1:H8yggRPQKLUhUoqrJC1bO2xNya7vanpDl7xR3ISbCJ0= -github.com/bitfield/script v0.24.0 h1:ic0Tbx+2AgRtkGGIcUyr+Un60vu4WXvqFrCSumf+T7M= -github.com/bitfield/script v0.24.0/go.mod h1:fv+6x4OzVsRs6qAlc7wiGq8fq1b5orhtQdtW0dwjUHI= -github.com/charmbracelet/glamour v0.8.0 h1:tPrjL3aRcQbn++7t18wOpgLyl8wrOHUEDS7IZ68QtZs= -github.com/charmbracelet/glamour v0.8.0/go.mod h1:ViRgmKkf3u5S7uakt2czJ272WSg2ZenlYEZXT2x7Bjw= -github.com/charmbracelet/lipgloss v0.12.1 h1:/gmzszl+pedQpjCOH+wFkZr/N90Snz40J/NR7A0zQcs= -github.com/charmbracelet/lipgloss v0.12.1/go.mod h1:V2CiwIuhx9S1S1ZlADfOj9HmxeMAORuz5izHb0zGbB8= -github.com/charmbracelet/x/ansi v0.1.4 h1:IEU3D6+dWwPSgZ6HBH+v6oUuZ/nVawMiWj5831KfiLM= -github.com/charmbracelet/x/ansi v0.1.4/go.mod h1:dk73KoMTT5AX5BsX0KrqhsTqAnhZZoCBjs7dGWp4Ktw= -github.com/charmbracelet/x/exp/golden v0.0.0-20240715153702-9ba8adf781c4 h1:6KzMkQeAF56rggw2NZu1L+TH7j9+DM1/2Kmh7KUxg1I= -github.com/charmbracelet/x/exp/golden v0.0.0-20240715153702-9ba8adf781c4/go.mod h1:wDlXFlCrmJ8J+swcL/MnGUuYnqgQdW9rhSD61oNMb6U= +github.com/bitfield/script v0.19.0 h1:W24f+FQuPab9gXcW8bhcbo5qO8AtrXyu3XOnR4zhHN0= +github.com/bitfield/script v0.19.0/go.mod h1:ana6F8YOSZ3ImT8SauIzuYSqXgFVkSUJ6kgja+WMmIY= +github.com/bwesterb/go-ristretto v1.2.3/go.mod h1:fUIoIZaG73pV5biE2Blr2xEzDoMj7NFEuV9ekS419A0= +github.com/charmbracelet/glamour v0.5.0 h1:wu15ykPdB7X6chxugG/NNfDUbyyrCLV9XBalj5wdu3g= +github.com/charmbracelet/glamour v0.5.0/go.mod h1:9ZRtG19AUIzcTm7FGLGbq3D5WKQ5UyZBbQsMQN0XIqc= +github.com/cloudflare/circl v1.3.3/go.mod h1:5XYMA4rFBvNIrhs50XuiBJ15vF2pZn4nnUKZrLbUZFA= github.com/cloudflare/circl v1.3.7 h1:qlCDlTPz2n9fu58M0Nh1J/JzcFpfgkFHHX3O35r5vcU= github.com/cloudflare/circl v1.3.7/go.mod h1:sRTcRWXGLrKw6yIGJ+l7amYJFfAXbZG0kBSc8r4zxgA= github.com/containerd/console v1.0.3 h1:lIr7SlA5PxZyMV30bDW0MGbiOPXwc63yRuCP0ARubLw= github.com/containerd/console v1.0.3/go.mod h1:7LqA/THxQ86k76b8c/EMSiaJ3h1eZkMkXar0TQ1gf3U= -github.com/cyphar/filepath-securejoin v0.3.6 h1:4d9N5ykBnSp5Xn2JkhocYDkOpURL/18CYMpo6xB9uWM= -github.com/cyphar/filepath-securejoin v0.3.6/go.mod h1:Sdj7gXlvMcPZsbhwhQ33GguGLDGQL7h7bg04C/+u9jI= +github.com/cyphar/filepath-securejoin v0.2.4 h1:Ugdm7cg7i6ZK6x3xDF1oEu1nfkyfH53EtKeQYTC3kyg= +github.com/cyphar/filepath-securejoin v0.2.4/go.mod h1:aPGpWjXOXUn2NCNjFvBE6aRxGGx79pTxQpKOJNYHHl4= github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c= github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= -github.com/dlclark/regexp2 v1.11.0 h1:G/nrcoOa7ZXlpoa/91N3X7mM3r8eIlMBBJZvsz/mxKI= -github.com/dlclark/regexp2 v1.11.0/go.mod h1:DHkYz0B9wPfa6wondMfaivmHpzrQ3v9q8cnmRbL6yW8= -github.com/elazarl/goproxy v1.4.0 h1:4GyuSbFa+s26+3rmYNSuUVsx+HgPrV1bk1jXI0l9wjM= -github.com/elazarl/goproxy v1.4.0/go.mod h1:X/5W/t+gzDyLfHW4DrMdpjqYjpXsURlBt9lpBDxZZZQ= +github.com/dlclark/regexp2 v1.4.0 h1:F1rxgk7p4uKjwIQxBs9oAXe5CqrXlCduYEJvrF4u93E= +github.com/dlclark/regexp2 v1.4.0/go.mod h1:2pZnwuY/m+8K6iRw6wQdMtk+rH5tNGR1i55kozfMjCc= +github.com/elazarl/goproxy v0.0.0-20230808193330-2592e75ae04a h1:mATvB/9r/3gvcejNsXKSkQ6lcIaNec2nyfOdlTBR2lU= +github.com/elazarl/goproxy v0.0.0-20230808193330-2592e75ae04a/go.mod h1:Ro8st/ElPeALwNFlcTpWmkr6IoMFfkjXAvTHpevnDsM= github.com/emirpasic/gods v1.18.1 h1:FXtiHYKDGKCW2KzwZKx0iC0PQmdlorYgdFG9jPXJ1Bc= github.com/emirpasic/gods v1.18.1/go.mod h1:8tpGGwCnJ5H4r6BWwaV6OrWmMoPhUl5jm/FMNAnJvWQ= -github.com/flytam/filenamify v1.2.0 h1:7RiSqXYR4cJftDQ5NuvljKMfd/ubKnW/j9C6iekChgI= -github.com/flytam/filenamify v1.2.0/go.mod h1:Dzf9kVycwcsBlr2ATg6uxjqiFgKGH+5SKFuhdeP5zu8= -github.com/frankban/quicktest v1.14.5 h1:dfYrrRyLtiqT9GyKXgdh+k4inNeTvmGbuSgZ3lx3GhA= -github.com/frankban/quicktest v1.14.5/go.mod h1:4ptaffx2x8+WTWXmUCuVU6aPUX1/Mz7zb5vbUoiM6w0= -github.com/fsnotify/fsnotify v1.9.0 h1:2Ml+OJNzbYCTzsxtv8vKSFD9PbJjmhYF14k/jKC7S9k= -github.com/fsnotify/fsnotify v1.9.0/go.mod h1:8jBTzvmWwFyi3Pb8djgCCO5IBqzKJ/Jwo8TRcHyHii0= -github.com/gliderlabs/ssh v0.3.8 h1:a4YXD1V7xMF9g5nTkdfnja3Sxy1PVDCj1Zg4Wb8vY6c= -github.com/gliderlabs/ssh v0.3.8/go.mod h1:xYoytBv1sV0aL3CavoDuJIQNURXkkfPA/wxQ1pL1fAU= +github.com/flytam/filenamify v1.0.0 h1:ewx6BY2dj7U6h2zGPJmt33q/BjkSf/YsY/woQvnUNIs= +github.com/flytam/filenamify v1.0.0/go.mod h1:Dzf9kVycwcsBlr2ATg6uxjqiFgKGH+5SKFuhdeP5zu8= +github.com/fsnotify/fsnotify v1.4.9 h1:hsms1Qyu0jgnwNXIxa+/V/PDsU6CfLf6CNO8H7IWoS4= +github.com/fsnotify/fsnotify v1.4.9/go.mod h1:znqG4EE+3YCdAaPaxE2ZRY/06pZUdp0tY4IgpuI1SZQ= +github.com/ghodss/yaml v1.0.0 h1:wQHKEahhL6wmXdzwWG11gIVCkOv05bNOh+Rxn0yngAk= +github.com/ghodss/yaml v1.0.0/go.mod h1:4dBDuWmgqj2HViK6kFavaiC9ZROes6MMH2rRYeMEF04= +github.com/gliderlabs/ssh v0.3.5 h1:OcaySEmAQJgyYcArR+gGGTHCyE7nvhEMTlYY+Dp8CpY= +github.com/gliderlabs/ssh v0.3.5/go.mod h1:8XB4KraRrX39qHhT6yxPsHedjA08I/uBVwj4xC+/+z4= github.com/go-git/gcfg v1.5.1-0.20230307220236-3a3c6141e376 h1:+zs/tPmkDkHx3U66DAb0lQFJrpS6731Oaa12ikc+DiI= github.com/go-git/gcfg v1.5.1-0.20230307220236-3a3c6141e376/go.mod h1:an3vInlBmSxCcxctByoQdvwPiA7DTK7jaaFDBTtu0ic= -github.com/go-git/go-billy/v5 v5.6.2 h1:6Q86EsPXMa7c3YZ3aLAQsMA0VlWmy43r6FHqa/UNbRM= -github.com/go-git/go-billy/v5 v5.6.2/go.mod h1:rcFC2rAsp/erv7CMz9GczHcuD0D32fWzH+MJAU+jaUU= +github.com/go-git/go-billy/v5 v5.5.0 h1:yEY4yhzCDuMGSv83oGxiBotRzhwhNr8VZyphhiu+mTU= +github.com/go-git/go-billy/v5 v5.5.0/go.mod h1:hmexnoNsr2SJU1Ju67OaNz5ASJY3+sHgFRpCtpDCKow= github.com/go-git/go-git-fixtures/v4 v4.3.2-0.20231010084843-55a94097c399 h1:eMje31YglSBqCdIqdhKBW8lokaMrL3uTkpGYlE2OOT4= github.com/go-git/go-git-fixtures/v4 v4.3.2-0.20231010084843-55a94097c399/go.mod h1:1OCfN199q1Jm3HZlxleg+Dw/mwps2Wbk9frAWm+4FII= -github.com/go-git/go-git/v5 v5.13.2 h1:7O7xvsK7K+rZPKW6AQR1YyNhfywkv7B8/FsP3ki6Zv0= -github.com/go-git/go-git/v5 v5.13.2/go.mod h1:hWdW5P4YZRjmpGHwRH2v3zkWcNl6HeXaXQEMGb3NJ9A= +github.com/go-git/go-git/v5 v5.11.0 h1:XIZc1p+8YzypNr34itUfSvYJcv+eYdTnTvOZ2vD3cA4= +github.com/go-git/go-git/v5 v5.11.0/go.mod h1:6GFcX2P3NM7FPBfpePbpLd21XxsgdAt+lKqXmCUiUCY= +github.com/go-ole/go-ole v1.2.5/go.mod h1:pprOEPIfldk/42T2oK7lQ4v4JSDwmV0As9GaiUsvbm0= +github.com/go-ole/go-ole v1.2.6 h1:/Fpf6oFPoeFik9ty7siob0G6Ke8QvQEuVcuChpwXzpY= github.com/go-ole/go-ole v1.2.6/go.mod h1:pprOEPIfldk/42T2oK7lQ4v4JSDwmV0As9GaiUsvbm0= -github.com/go-ole/go-ole v1.3.0 h1:Dt6ye7+vXGIKZ7Xtk4s6/xVdGDQynvom7xCFEdWr6uE= -github.com/go-ole/go-ole v1.3.0/go.mod h1:5LS6F96DhAwUc7C+1HLexzMXY1xGRSryjyPPKW6zv78= github.com/godbus/dbus/v5 v5.1.0 h1:4KLkAxT3aOY8Li4FRJe/KvhoNFFxo0m6fNuFUO8QJUk= github.com/godbus/dbus/v5 v5.1.0/go.mod h1:xhWf0FNVPg57R7Z0UbKHbJfkEywrmjJnf7w5xrFpKfA= github.com/golang/groupcache v0.0.0-20210331224755-41bb18bfe9da h1:oI5xCqsCo564l8iNU+DwB5epxmsaqB+rhGL0m5jtYqE= github.com/golang/groupcache v0.0.0-20210331224755-41bb18bfe9da/go.mod h1:cIg4eruTrX1D+g88fzRXU5OdNfaM+9IcxsU14FzY7Hc= +github.com/google/go-cmp v0.5.6/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE= +github.com/google/go-cmp v0.5.7/go.mod h1:n+brtR0CgQNWTVd5ZUFpTBC8YFBDLK/h/bpaJ8/DtOE= github.com/google/go-cmp v0.6.0 h1:ofyhxvXcZhMsU5ulbFiLKl/XBFqE1GSq7atu8tAmTRI= github.com/google/go-cmp v0.6.0/go.mod h1:17dUlkBOakJ0+DkrSSNjCkIjxS6bF9zb3elmeNGIjoY= github.com/google/shlex v0.0.0-20191202100458-e7afc7fbc510 h1:El6M4kTTCOh6aBiKaUGG7oYTSPP8MxqL4YI3kZKwcP4= github.com/google/shlex v0.0.0-20191202100458-e7afc7fbc510/go.mod h1:pupxD2MaaD3pAXIBCelhxNneeOaAeabZDe5s4K6zSpQ= -github.com/google/uuid v1.6.0 h1:NIvaJDMOsjHA8n1jAhLSgzrAzy1Hgr+hNrb57e+94F0= -github.com/google/uuid v1.6.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo= +github.com/google/uuid v1.3.0 h1:t6JiXgmwXMjEs8VusXIJk2BXHsn+wx8BZdTaoZ5fu7I= +github.com/google/uuid v1.3.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo= github.com/gookit/color v1.4.2/go.mod h1:fqRyamkC1W8uxl+lxCQxOT09l/vYfZ+QeiX3rKQHCoQ= github.com/gookit/color v1.5.0/go.mod h1:43aQb+Zerm/BWh2GnrgOQm7ffz7tvQXEKV6BFMl7wAo= -github.com/gookit/color v1.5.4 h1:FZmqs7XOyGgCAxmWyPslpiok1k05wmY3SJTytgvYFs0= -github.com/gookit/color v1.5.4/go.mod h1:pZJOeOS8DM43rXbp4AZo1n9zCU2qjpcRko0b6/QJi9w= -github.com/gorilla/css v1.0.1 h1:ntNaBIghp6JmvWnxbZKANoLyuXTPZ4cAMlo6RyhlbO8= -github.com/gorilla/css v1.0.1/go.mod h1:BvnYkspnSzMmwRK+b8/xgNPLiIuNZr6vbZBTPQ2A3b0= -github.com/gorilla/websocket v1.5.3 h1:saDtZ6Pbx/0u+bgYQ3q96pZgCzfhKXGPqt7kZ72aNNg= -github.com/gorilla/websocket v1.5.3/go.mod h1:YR8l580nyteQvAITg2hZ9XVh4b55+EU/adAjf1fMHhE= -github.com/hexops/gotextdiff v1.0.3 h1:gitA9+qJrrTCsiCl7+kh75nPqQt1cx4ZkudSTLoUqJM= -github.com/hexops/gotextdiff v1.0.3/go.mod h1:pSWU5MAI3yDq+fZBTazCSJysOMbxWL1BSow5/V2vxeg= -github.com/itchyny/gojq v0.12.13 h1:IxyYlHYIlspQHHTE0f3cJF0NKDMfajxViuhBLnHd/QU= -github.com/itchyny/gojq v0.12.13/go.mod h1:JzwzAqenfhrPUuwbmEz3nu3JQmFLlQTQMUcOdnu/Sf4= -github.com/itchyny/timefmt-go v0.1.5 h1:G0INE2la8S6ru/ZI5JecgyzbbJNs5lG1RcBqa7Jm6GE= -github.com/itchyny/timefmt-go v0.1.5/go.mod h1:nEP7L+2YmAbT2kZ2HfSs1d8Xtw9LY8D2stDBckWakZ8= +github.com/gookit/color v1.5.2 h1:uLnfXcaFjlrDnQDT+NCBcfhrXqYTx/rcCa6xn01Y8yI= +github.com/gookit/color v1.5.2/go.mod h1:w8h4bGiHeeBpvQVePTutdbERIUf3oJE5lZ8HM0UgXyg= +github.com/gorilla/css v1.0.0 h1:BQqNyPTi50JCFMTw/b67hByjMVXZRwGha6wxVGkeihY= +github.com/gorilla/css v1.0.0/go.mod h1:Dn721qIggHpt4+EFCcTLTU/vk5ySda2ReITrtgBl60c= github.com/jackmordaunt/icns v1.0.0 h1:RYSxplerf/l/DUd09AHtITwckkv/mqjVv4DjYdPmAMQ= github.com/jackmordaunt/icns v1.0.0/go.mod h1:7TTQVEuGzVVfOPPlLNHJIkzA6CoV7aH1Dv9dW351oOo= -github.com/jaypipes/ghw v0.21.3 h1:v5mUHM+RN854Vqmk49Uh213jyUA4+8uqaRajlYESsh8= -github.com/jaypipes/ghw v0.21.3/go.mod h1:GPrvwbtPoxYUenr74+nAnWbardIZq600vJDD5HnPsPE= -github.com/jaypipes/pcidb v1.1.1 h1:QmPhpsbmmnCwZmHeYAATxEaoRuiMAJusKYkUncMC0ro= -github.com/jaypipes/pcidb v1.1.1/go.mod h1:x27LT2krrUgjf875KxQXKB0Ha/YXLdZRVmw6hH0G7g8= +github.com/jaypipes/ghw v0.12.0 h1:xU2/MDJfWmBhJnujHY9qwXQLs3DBsf0/Xa9vECY0Tho= +github.com/jaypipes/ghw v0.12.0/go.mod h1:jeJGbkRB2lL3/gxYzNYzEDETV1ZJ56OKr+CSeSEym+g= +github.com/jaypipes/pcidb v1.0.0 h1:vtZIfkiCUE42oYbJS0TAq9XSfSmcsgo9IdxSm9qzYU8= +github.com/jaypipes/pcidb v1.0.0/go.mod h1:TnYUvqhPBzCKnH34KrIX22kAeEbDCSRJ9cqLRCuNDfk= github.com/jbenet/go-context v0.0.0-20150711004518-d14ea06fba99 h1:BQSFePA1RWJOlocH6Fxy8MmwDt+yVQYULKfN0RoTN8A= github.com/jbenet/go-context v0.0.0-20150711004518-d14ea06fba99/go.mod h1:1lJo3i6rXxKeerYnT8Nvf0QmHCRC1n8sfWVwXF2Frvo= github.com/jchv/go-winloader v0.0.0-20210711035445-715c2860da7e h1:Q3+PugElBCf4PFpxhErSzU3/PY5sFL5Z6rfv4AbGAck= @@ -129,8 +111,8 @@ github.com/kevinburke/ssh_config v1.2.0/go.mod h1:CT57kijsi8u/K/BOFA39wgDQJ9CxiF github.com/klauspost/cpuid/v2 v2.0.9/go.mod h1:FInQzS24/EEf25PyTYn52gqo7WaD8xa0213Md/qVLRg= github.com/klauspost/cpuid/v2 v2.0.10/go.mod h1:g2LTdtYhdyuGPqyWyv7qRAmj1WBqxuObKfj5c0PQa7c= github.com/klauspost/cpuid/v2 v2.0.12/go.mod h1:g2LTdtYhdyuGPqyWyv7qRAmj1WBqxuObKfj5c0PQa7c= -github.com/klauspost/cpuid/v2 v2.2.3 h1:sxCkb+qR91z4vsqw4vGGZlDgPz3G7gjaLyK3V8y70BU= -github.com/klauspost/cpuid/v2 v2.2.3/go.mod h1:RVVoqg1df56z8g3pUjL/3lE5UfnlrJX8tyFgg4nqhuY= +github.com/klauspost/cpuid/v2 v2.1.0 h1:eyi1Ad2aNJMW95zcSbmGg7Cg6cq3ADwLpMAP96d8rF0= +github.com/klauspost/cpuid/v2 v2.1.0/go.mod h1:RVVoqg1df56z8g3pUjL/3lE5UfnlrJX8tyFgg4nqhuY= github.com/kr/pretty v0.1.0/go.mod h1:dAy3ld7l9f0ibDNOQOHHMYYIIbhfbHSm3C4ZsoJORNo= github.com/kr/pretty v0.3.1 h1:flRD4NNwYAUpkphVc1HcthR4KEIFJ65n8Mw5qdRn3LE= github.com/kr/pretty v0.3.1/go.mod h1:hoEshYVHaxMs3cyo3Yncou5ZscifuDolrwPKZanG3xk= @@ -138,56 +120,62 @@ github.com/kr/pty v1.1.1/go.mod h1:pFQYn66WHrOpPYNljwOMqo10TkYh1fy3cYio2l3bCsQ= github.com/kr/text v0.1.0/go.mod h1:4Jbv+DJW3UT/LiOwJeYQe1efqtUx/iVham/4vfdArNI= github.com/kr/text v0.2.0 h1:5Nx0Ya0ZqY2ygV366QzturHI13Jq95ApcVaJBhpS+AY= github.com/kr/text v0.2.0/go.mod h1:eLer722TekiGuMkidMxC/pM04lWEeraHUUmBw8l2grE= -github.com/labstack/echo/v4 v4.13.3 h1:pwhpCPrTl5qry5HRdM5FwdXnhXSLSY+WE+YQSeCaafY= -github.com/labstack/echo/v4 v4.13.3/go.mod h1:o90YNEeQWjDozo584l7AwhJMHN0bOC4tAfg+Xox9q5g= -github.com/labstack/gommon v0.4.2 h1:F8qTUNXgG1+6WQmqoUWnz8WiEU60mXVVw0P4ht1WRA0= -github.com/labstack/gommon v0.4.2/go.mod h1:QlUFxVM+SNXhDL/Z7YhocGIBYOiwB0mXm1+1bAPHPyU= +github.com/labstack/echo/v4 v4.10.2 h1:n1jAhnq/elIFTHr1EYpiYtyKgx4RW9ccVgkqByZaN2M= +github.com/labstack/echo/v4 v4.10.2/go.mod h1:OEyqf2//K1DFdE57vw2DRgWY0M7s65IVQO2FzvI4J5k= +github.com/labstack/gommon v0.4.0 h1:y7cvthEAEbU0yHOf4axH8ZG2NH8knB9iNSoTO8dyIk8= +github.com/labstack/gommon v0.4.0/go.mod h1:uW6kP17uPlLJsD3ijUYn3/M5bAxtlZhMI6m3MFxTMTM= github.com/leaanthony/clir v1.0.4/go.mod h1:k/RBkdkFl18xkkACMCLt09bhiZnrGORoxmomeMvDpE0= github.com/leaanthony/clir v1.3.0 h1:L9nPDWrmc/qU9UWZZvRaFajWYuO0np9V5p+5gxyYno0= github.com/leaanthony/clir v1.3.0/go.mod h1:k/RBkdkFl18xkkACMCLt09bhiZnrGORoxmomeMvDpE0= github.com/leaanthony/debme v1.2.1 h1:9Tgwf+kjcrbMQ4WnPcEIUcQuIZYqdWftzZkBr+i/oOc= github.com/leaanthony/debme v1.2.1/go.mod h1:3V+sCm5tYAgQymvSOfYQ5Xx2JCr+OXiD9Jkw3otUjiA= -github.com/leaanthony/go-ansi-parser v1.6.1 h1:xd8bzARK3dErqkPFtoF9F3/HgN8UQk0ed1YDKpEz01A= -github.com/leaanthony/go-ansi-parser v1.6.1/go.mod h1:+vva/2y4alzVmmIEpk9QDhA7vLC5zKDTRwfZGOp3IWU= -github.com/leaanthony/gosod v1.0.4 h1:YLAbVyd591MRffDgxUOU1NwLhT9T1/YiwjKZpkNFeaI= -github.com/leaanthony/gosod v1.0.4/go.mod h1:GKuIL0zzPj3O1SdWQOdgURSuhkF+Urizzxh26t9f1cw= +github.com/leaanthony/go-ansi-parser v1.6.0 h1:T8TuMhFB6TUMIUm0oRrSbgJudTFw9csT3ZK09w0t4Pg= +github.com/leaanthony/go-ansi-parser v1.6.0/go.mod h1:+vva/2y4alzVmmIEpk9QDhA7vLC5zKDTRwfZGOp3IWU= +github.com/leaanthony/gosod v1.0.3 h1:Fnt+/B6NjQOVuCWOKYRREZnjGyvg+mEhd1nkkA04aTQ= +github.com/leaanthony/gosod v1.0.3/go.mod h1:BJ2J+oHsQIyIQpnLPjnqFGTMnOZXDbvWtRCSG7jGxs4= github.com/leaanthony/slicer v1.5.0/go.mod h1:FwrApmf8gOrpzEWM2J/9Lh79tyq8KTX5AzRtwV7m4AY= github.com/leaanthony/slicer v1.6.0 h1:1RFP5uiPJvT93TAHi+ipd3NACobkW53yUiBqZheE/Js= github.com/leaanthony/slicer v1.6.0/go.mod h1:o/Iz29g7LN0GqH3aMjWAe90381nyZlDNquK+mtH2Fj8= -github.com/leaanthony/u v1.1.1 h1:TUFjwDGlNX+WuwVEzDqQwC2lOv0P4uhTQw7CMFdiK7M= -github.com/leaanthony/u v1.1.1/go.mod h1:9+o6hejoRljvZ3BzdYlVL0JYCwtnAsVuN9pVTQcaRfI= +github.com/leaanthony/u v1.1.0 h1:2n0d2BwPVXSUq5yhe8lJPHdxevE2qK5G99PMStMZMaI= +github.com/leaanthony/u v1.1.0/go.mod h1:9+o6hejoRljvZ3BzdYlVL0JYCwtnAsVuN9pVTQcaRfI= github.com/leaanthony/winicon v1.0.0 h1:ZNt5U5dY71oEoKZ97UVwJRT4e+5xo5o/ieKuHuk8NqQ= github.com/leaanthony/winicon v1.0.0/go.mod h1:en5xhijl92aphrJdmRPlh4NI1L6wq3gEm0LpXAPghjU= -github.com/lithammer/fuzzysearch v1.1.8 h1:/HIuJnjHuXS8bKaiTMeeDlW2/AyIWk2brx1V8LFgLN4= -github.com/lithammer/fuzzysearch v1.1.8/go.mod h1:IdqeyBClc3FFqSzYq/MXESsS4S0FsZ5ajtkr5xPLts4= +github.com/lithammer/fuzzysearch v1.1.5 h1:Ag7aKU08wp0R9QCfF4GoGST9HbmAIeLP7xwMrOBEp1c= +github.com/lithammer/fuzzysearch v1.1.5/go.mod h1:1R1LRNk7yKid1BaQkmuLQaHruxcC4HmAH30Dh61Ih1Q= github.com/lucasb-eyer/go-colorful v1.2.0 h1:1nnpGOrhyZZuNyfu1QjKiUICQ74+3FNCN69Aj6K7nkY= github.com/lucasb-eyer/go-colorful v1.2.0/go.mod h1:R4dSotOR9KMtayYi1e77YzuveK+i7ruzyGqttikkLy0= +github.com/matryer/is v1.4.0 h1:sosSmIWwkYITGrxZ25ULNDeKiMNzFSr4V/eqBQP0PeE= github.com/matryer/is v1.4.0/go.mod h1:8I/i5uYgLzgsgEloJE1U6xx5HkBQpAZvepWuujKwMRU= -github.com/matryer/is v1.4.1 h1:55ehd8zaGABKLXQUe2awZ99BD/PTc2ls+KV/dXphgEQ= -github.com/matryer/is v1.4.1/go.mod h1:8I/i5uYgLzgsgEloJE1U6xx5HkBQpAZvepWuujKwMRU= +github.com/mattn/go-colorable v0.1.11/go.mod h1:u5H1YNBxpqRaxsYJYSkiCWKzEfiAb1Gb520KVy5xxl4= github.com/mattn/go-colorable v0.1.13 h1:fFA4WZxdEF4tXPZVKMLwD8oUnCTTo08duU7wxecdEvA= github.com/mattn/go-colorable v0.1.13/go.mod h1:7S9/ev0klgBDR4GtXTXX8a3vIGJpMovkB8vQcUbaXHg= +github.com/mattn/go-isatty v0.0.13/go.mod h1:cbi8OIDigv2wuxKPP5vlRcQ1OAZbq2CE4Kysco4FUpU= +github.com/mattn/go-isatty v0.0.14/go.mod h1:7GGIvUiUoEMVVmxf/4nioHXj79iQHKdU27kJ6hsGG94= github.com/mattn/go-isatty v0.0.16/go.mod h1:kYGgaQfpe5nmfYZH+SKPsOc2e4SrIfOl2e/yFXSvRLM= -github.com/mattn/go-isatty v0.0.20 h1:xfD0iDuEKnDkl03q4limB+vH+GxLEtL/jb4xVJSWWEY= -github.com/mattn/go-isatty v0.0.20/go.mod h1:W+V8PltTTMOvKvAeJH7IuucS94S2C6jfK/D7dTCTo3Y= +github.com/mattn/go-isatty v0.0.19 h1:JITubQf0MOLdlGRuRq+jtsDlekdYPia9ZFsB8h/APPA= +github.com/mattn/go-isatty v0.0.19/go.mod h1:W+V8PltTTMOvKvAeJH7IuucS94S2C6jfK/D7dTCTo3Y= +github.com/mattn/go-runewidth v0.0.9/go.mod h1:H031xJmbD/WCDINGzjvQ9THkh0rPKHF+m2gUSrubnMI= github.com/mattn/go-runewidth v0.0.12/go.mod h1:RAqKPSqVFrSLVXbA8x7dzmKdmGzieGRCM46jaSJTDAk= +github.com/mattn/go-runewidth v0.0.13 h1:lTGmDsbAYt5DmK6OnoV7EuIF1wEIFAcxld6ypU4OSgU= github.com/mattn/go-runewidth v0.0.13/go.mod h1:Jdepj2loyihRzMpdS35Xk/zdY8IAYHsh153qUoGf23w= -github.com/mattn/go-runewidth v0.0.16 h1:E5ScNMtiwvlvB5paMFdw9p4kSQzbXFikJ5SQO6TULQc= -github.com/mattn/go-runewidth v0.0.16/go.mod h1:Jdepj2loyihRzMpdS35Xk/zdY8IAYHsh153qUoGf23w= -github.com/microcosm-cc/bluemonday v1.0.27 h1:MpEUotklkwCSLeH+Qdx1VJgNqLlpY2KXwXFM08ygZfk= -github.com/microcosm-cc/bluemonday v1.0.27/go.mod h1:jFi9vgW+H7c3V0lb6nR74Ib/DIB5OBs92Dimizgw2cA= +github.com/microcosm-cc/bluemonday v1.0.17 h1:Z1a//hgsQ4yjC+8zEkV8IWySkXnsxmdSY642CTFQb5Y= +github.com/microcosm-cc/bluemonday v1.0.17/go.mod h1:Z0r70sCuXHig8YpBzCc5eGHAap2K7e/u082ZUpDRRqM= +github.com/mitchellh/go-homedir v1.1.0 h1:lukF9ziXFxDFPkA1vsr5zpc1XuPDn/wFntq5mG+4E0Y= +github.com/mitchellh/go-homedir v1.1.0/go.mod h1:SfyaCUpYCn1Vlf4IUYiD9fPX4A5wJrkLzIz1N1q0pr0= github.com/muesli/reflow v0.3.0 h1:IFsN6K9NfGtjeggFP+68I4chLZV2yIKsXJFNZ+eWh6s= github.com/muesli/reflow v0.3.0/go.mod h1:pbwTDkVPibjO2kyvBQRBxTWEEGDGq0FlB1BIKtnHY/8= -github.com/muesli/termenv v0.15.3-0.20240618155329-98d742f6907a h1:2MaM6YC3mGu54x+RKAA6JiFFHlHDY1UbkxqppT7wYOg= -github.com/muesli/termenv v0.15.3-0.20240618155329-98d742f6907a/go.mod h1:hxSnBBYLK21Vtq/PHd0S2FYCxBXzBua8ov5s1RobyRQ= +github.com/muesli/termenv v0.9.0 h1:wnbOaGz+LUR3jNT0zOzinPnyDaCZUQRZj9GxK8eRVl8= +github.com/muesli/termenv v0.9.0/go.mod h1:R/LzAKf+suGs4IsO95y7+7DpFHO0KABgnZqtlyx2mBw= github.com/nfnt/resize v0.0.0-20180221191011-83c6a9932646 h1:zYyBkD/k9seD2A7fsi6Oo2LfFZAehjjQMERAvZLEDnQ= github.com/nfnt/resize v0.0.0-20180221191011-83c6a9932646/go.mod h1:jpp1/29i3P1S/RLdc7JQKbRpFeM1dOBd8T9ki5s+AY8= -github.com/onsi/gomega v1.34.1 h1:EUMJIKUjM8sKjYbtxQI9A4z2o+rruxnzNvpknOXie6k= -github.com/onsi/gomega v1.34.1/go.mod h1:kU1QgUvBDLXBJq618Xvm2LUX6rSAfRaFRTcdOeDLwwY= -github.com/pjbgf/sha1cd v0.3.2 h1:a9wb0bp1oC2TGwStyn0Umc/IGKQnEgF0vVaZ8QF8eo4= -github.com/pjbgf/sha1cd v0.3.2/go.mod h1:zQWigSxVmsHEZow5qaLtPYxpcKMMQpa09ixqBxuCS6A= -github.com/pkg/browser v0.0.0-20240102092130-5ac0b6a4141c h1:+mdjkGKdHQG3305AYmdv1U2eRNDiU2ErMBj1gwrq8eQ= -github.com/pkg/browser v0.0.0-20240102092130-5ac0b6a4141c/go.mod h1:7rwL4CYBLnjLxUqIJNnCWiEdr3bn6IUYi15bNlnbCCU= +github.com/olekukonko/tablewriter v0.0.5 h1:P2Ga83D34wi1o9J6Wh1mRuqd4mF/x/lgBS7N7AbDhec= +github.com/olekukonko/tablewriter v0.0.5/go.mod h1:hPp6KlRPjbx+hW8ykQs1w3UBbZlj6HuIJcUGPhkA7kY= +github.com/onsi/gomega v1.27.10 h1:naR28SdDFlqrG6kScpT8VWpu1xWY5nJRCF3XaYyBjhI= +github.com/onsi/gomega v1.27.10/go.mod h1:RsS8tutOdbdgzbPtzzATp12yT7kM5I5aElG3evPbQ0M= +github.com/pjbgf/sha1cd v0.3.0 h1:4D5XXmUUBUl/xQ6IjCkEAbqXskkq/4O7LmGn0AqMDs4= +github.com/pjbgf/sha1cd v0.3.0/go.mod h1:nZ1rrWOcGJ5uZgEEVL1VUM9iRQiZvWdbZjkKyFzPPsI= +github.com/pkg/browser v0.0.0-20210911075715-681adbf594b8 h1:KoWmjvw+nsYOo29YJK9vDA65RGE3NrOnUtO7a+RF9HU= +github.com/pkg/browser v0.0.0-20210911075715-681adbf594b8/go.mod h1:HKlIX3XHQyzLZPlr7++PzdhaXEj94dEiJgZDTsxEqUI= github.com/pkg/errors v0.9.1 h1:FEBLx1zS214owpjy7qsBeixbURkuhQAwrK5UwLGTwt4= github.com/pkg/errors v0.9.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0= github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM= @@ -199,49 +187,55 @@ github.com/pterm/pterm v0.12.31/go.mod h1:32ZAWZVXD7ZfG0s8qqHXePte42kdz8ECtRyEej github.com/pterm/pterm v0.12.33/go.mod h1:x+h2uL+n7CP/rel9+bImHD5lF3nM9vJj80k9ybiiTTE= github.com/pterm/pterm v0.12.36/go.mod h1:NjiL09hFhT/vWjQHSj1athJpx6H8cjpHXNAK5bUw8T8= github.com/pterm/pterm v0.12.40/go.mod h1:ffwPLwlbXxP+rxT0GsgDTzS3y3rmpAO1NMjUkGTYf8s= -github.com/pterm/pterm v0.12.80 h1:mM55B+GnKUnLMUSqhdINe4s6tOuVQIetQ3my8JGyAIg= -github.com/pterm/pterm v0.12.80/go.mod h1:c6DeF9bSnOSeFPZlfs4ZRAFcf5SCoTwvwQ5xaKGQlHo= +github.com/pterm/pterm v0.12.49 h1:qeNm0wTWawy6WhKoY8ZKq6qTXFr0s2UtUyRW0yVztEg= +github.com/pterm/pterm v0.12.49/go.mod h1:D4OBoWNqAfXkm5QLTjIgjNiMXPHemLJHnIreGUsWzWg= github.com/rivo/uniseg v0.1.0/go.mod h1:J6wj4VEh+S6ZtnVlnTBMWIodfgj8LQOQFoIToxlJtxc= github.com/rivo/uniseg v0.2.0/go.mod h1:J6wj4VEh+S6ZtnVlnTBMWIodfgj8LQOQFoIToxlJtxc= -github.com/rivo/uniseg v0.4.7 h1:WUdvkW8uEhrYfLC4ZzdpI2ztxP1I582+49Oc5Mq64VQ= -github.com/rivo/uniseg v0.4.7/go.mod h1:FN3SvrM+Zdj16jyLfmOkMNblXMcoc8DfTHruCPUcx88= -github.com/rogpeppe/go-internal v1.12.0 h1:exVL4IDcn6na9z1rAb56Vxr+CgyK3nn3O+epU5NdKM8= -github.com/rogpeppe/go-internal v1.12.0/go.mod h1:E+RYuTGaKKdloAfM02xzb0FW3Paa99yedzYV+kq4uf4= +github.com/rivo/uniseg v0.4.4 h1:8TfxU8dW6PdqD27gjM8MVNuicgxIjxpm4K7x4jp8sis= +github.com/rivo/uniseg v0.4.4/go.mod h1:FN3SvrM+Zdj16jyLfmOkMNblXMcoc8DfTHruCPUcx88= +github.com/rogpeppe/go-internal v1.11.0 h1:cWPaGQEPrBb5/AsnsZesgZZ9yb1OQ+GOISoDNXVBh4M= +github.com/rogpeppe/go-internal v1.11.0/go.mod h1:ddIwULY96R17DhadqLgMfk9H9tvdUzkipdSkR5nkCZA= github.com/sabhiram/go-gitignore v0.0.0-20210923224102-525f6e181f06 h1:OkMGxebDjyw0ULyrTYWeN0UNCCkmCWfjPnIA2W6oviI= github.com/sabhiram/go-gitignore v0.0.0-20210923224102-525f6e181f06/go.mod h1:+ePHsJ1keEjQtpvf9HHw0f4ZeJ0TLRsxhunSI2hYJSs= -github.com/samber/lo v1.49.1 h1:4BIFyVfuQSEpluc7Fua+j1NolZHiEHEpaSEKdsH0tew= -github.com/samber/lo v1.49.1/go.mod h1:dO6KHFzUKXgP8LDhU0oI8d2hekjXnGOu0DB8Jecxd6o= +github.com/samber/lo v1.38.1 h1:j2XEAqXKb09Am4ebOg31SpvzUTTs6EN3VfgeLUhPdXM= +github.com/samber/lo v1.38.1/go.mod h1:+m/ZKRl6ClXCE2Lgf3MsQlWfh4bn1bz6CXEOxnEXnEA= +github.com/sergi/go-diff v1.2.0 h1:XU+rvMAioB0UC3q1MFrIQy4Vo5/4VsRDQQXHsEya6xQ= github.com/sergi/go-diff v1.2.0/go.mod h1:STckp+ISIX8hZLjrqAeVduY0gWCT9IjLuqbuNXdaHfM= -github.com/sergi/go-diff v1.3.2-0.20230802210424-5b0b94c5c0d3 h1:n661drycOFuPLCN3Uc8sB6B/s6Z4t2xvBgU1htSHuq8= -github.com/sergi/go-diff v1.3.2-0.20230802210424-5b0b94c5c0d3/go.mod h1:A0bzQcvG0E7Rwjx0REVgAGH58e96+X0MeOfepqsbeW4= github.com/sirupsen/logrus v1.7.0/go.mod h1:yWOB1SBYBC5VeMP7gHvWumXLIWorT60ONWic61uBYv0= -github.com/skeema/knownhosts v1.3.0 h1:AM+y0rI04VksttfwjkSTNQorvGqmwATnvnAHpSgc0LY= -github.com/skeema/knownhosts v1.3.0/go.mod h1:sPINvnADmT/qYH1kfv+ePMmOBTH6Tbl7b5LvTDjFK7M= +github.com/skeema/knownhosts v1.2.1 h1:SHWdIUa82uGZz+F+47k8SY4QhhI291cXCpopT1lK2AQ= +github.com/skeema/knownhosts v1.2.1/go.mod h1:xYbVRSPxqBZFrdmDyMmsOs+uX1UZC3nTN3ThzgDxUwo= github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME= +github.com/stretchr/objx v0.4.0/go.mod h1:YvHI0jy2hoMjB+UWwv71VJQ9isScKT/TqJzVSSt89Yw= github.com/stretchr/testify v1.2.2/go.mod h1:a8OnRcib4nhh0OaRAV+Yts87kKdq0PP7pXfy6kDkUVs= github.com/stretchr/testify v1.4.0/go.mod h1:j7eGeouHqKxXV5pUuKE4zz7dFj8WfuZ+81PSLYec5m4= github.com/stretchr/testify v1.6.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg= github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg= -github.com/stretchr/testify v1.10.0 h1:Xv5erBjTwe/5IxqUQTdXv5kgmIvbHo3QQyRwhJsOfJA= -github.com/stretchr/testify v1.10.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY= -github.com/tc-hib/winres v0.3.1 h1:CwRjEGrKdbi5CvZ4ID+iyVhgyfatxFoizjPhzez9Io4= -github.com/tc-hib/winres v0.3.1/go.mod h1:C/JaNhH3KBvhNKVbvdlDWkbMDO9H4fKKDaN7/07SSuk= -github.com/tidwall/gjson v1.14.2 h1:6BBkirS0rAHjumnjHF6qgy5d2YAJ1TLIaFE2lzfOLqo= -github.com/tidwall/gjson v1.14.2/go.mod h1:/wbyibRr2FHMks5tjHJ5F8dMZh3AcwJEMf5vlfC0lxk= +github.com/stretchr/testify v1.7.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg= +github.com/stretchr/testify v1.8.0/go.mod h1:yNjHg4UonilssWZ8iaSj1OCr/vHnekPRkoO+kdMU+MU= +github.com/stretchr/testify v1.8.4 h1:CcVxjf3Q8PM0mHUKJCdn+eZZtm5yQwehR5yeSVQQcUk= +github.com/stretchr/testify v1.8.4/go.mod h1:sz/lmYIOXD/1dqDmKjjqLyZ2RngseejIcXlSw2iwfAo= +github.com/tc-hib/winres v0.2.1 h1:YDE0FiP0VmtRaDn7+aaChp1KiF4owBiJa5l964l5ujA= +github.com/tc-hib/winres v0.2.1/go.mod h1:C/JaNhH3KBvhNKVbvdlDWkbMDO9H4fKKDaN7/07SSuk= +github.com/tidwall/gjson v1.8.0/go.mod h1:5/xDoumyyDNerp2U36lyolv46b3uF/9Bu6OfyQ9GImk= +github.com/tidwall/gjson v1.9.3 h1:hqzS9wAHMO+KVBBkLxYdkEeeFHuqr95GfClRLKlgK0E= +github.com/tidwall/gjson v1.9.3/go.mod h1:/wbyibRr2FHMks5tjHJ5F8dMZh3AcwJEMf5vlfC0lxk= +github.com/tidwall/match v1.0.3/go.mod h1:eRSPERbgtNPcGhD8UCthc6PmLEQXEWd3PRB5JTxsfmM= github.com/tidwall/match v1.1.1 h1:+Ho715JplO36QYgwN9PGYNhgZvoUSc9X2c80KVTi+GA= github.com/tidwall/match v1.1.1/go.mod h1:eRSPERbgtNPcGhD8UCthc6PmLEQXEWd3PRB5JTxsfmM= +github.com/tidwall/pretty v1.1.0/go.mod h1:XNkn88O1ChpSDQmQeStsy+sBenx6DDtFZJxhVysOjyk= github.com/tidwall/pretty v1.2.0 h1:RWIZEg2iJ8/g6fDDYzMpobmaoGh5OLl4AXtGUGPcqCs= github.com/tidwall/pretty v1.2.0/go.mod h1:ITEVvHYasfjBbM0u2Pg8T2nJnzm8xPwvNhhsoaGGjNU= -github.com/tidwall/sjson v1.2.5 h1:kLy8mja+1c9jlljvWTlSazM7cKDRfJuR/bOJhcY5NcY= -github.com/tidwall/sjson v1.2.5/go.mod h1:Fvgq9kS/6ociJEDnK0Fk1cpYF4FIW6ZF7LAe+6jwd28= -github.com/tkrajina/go-reflector v0.5.8 h1:yPADHrwmUbMq4RGEyaOUpz2H90sRsETNVpjzo3DLVQQ= -github.com/tkrajina/go-reflector v0.5.8/go.mod h1:ECbqLgccecY5kPmPmXg1MrHW585yMcDkVl6IvJe64T4= +github.com/tidwall/sjson v1.1.7 h1:sgVPwu/yygHJ2m1pJDLgGM/h+1F5odx5Q9ljG3imRm8= +github.com/tidwall/sjson v1.1.7/go.mod h1:w/yG+ezBeTdUxiKs5NcPicO9diP38nk96QBAbIIGeFs= +github.com/tkrajina/go-reflector v0.5.6 h1:hKQ0gyocG7vgMD2M3dRlYN6WBBOmdoOzJ6njQSepKdE= +github.com/tkrajina/go-reflector v0.5.6/go.mod h1:ECbqLgccecY5kPmPmXg1MrHW585yMcDkVl6IvJe64T4= github.com/valyala/bytebufferpool v1.0.0 h1:GqA5TC/0021Y/b9FG4Oi9Mr3q7XYx6KllzawFIhcdPw= github.com/valyala/bytebufferpool v1.0.0/go.mod h1:6bBcMArwyJ5K/AmCkWv1jt77kVWyCJ6HpOuEn7z0Csc= +github.com/valyala/fasttemplate v1.2.1/go.mod h1:KHLXt3tVN2HBp8eijSv/kGJopbvo7S+qRAEEKiv+SiQ= github.com/valyala/fasttemplate v1.2.2 h1:lxLXG0uE3Qnshl9QyaK6XJxMXlQZELvChBOCmQD0Loo= github.com/valyala/fasttemplate v1.2.2/go.mod h1:KHLXt3tVN2HBp8eijSv/kGJopbvo7S+qRAEEKiv+SiQ= -github.com/wailsapp/go-webview2 v1.0.22 h1:YT61F5lj+GGaat5OB96Aa3b4QA+mybD0Ggq6NZijQ58= -github.com/wailsapp/go-webview2 v1.0.22/go.mod h1:qJmWAmAmaniuKGZPWwne+uor3AHMB5PFhqiK0Bbj8kc= +github.com/wailsapp/go-webview2 v1.0.10 h1:PP5Hug6pnQEAhfRzLCoOh2jJaPdrqeRgJKZhyYyDV/w= +github.com/wailsapp/go-webview2 v1.0.10/go.mod h1:Uk2BePfCRzttBBjFrBmqKGJd41P6QIHeV9kTgIeOZNo= github.com/wailsapp/mimetype v1.4.1 h1:pQN9ycO7uo4vsUUuPeHEYoUkLVkaRntMnHJxVwYhwHs= github.com/wailsapp/mimetype v1.4.1/go.mod h1:9aV5k31bBOv5z6u+QP8TltzvNGJPmNJD4XlAL3U+j3o= github.com/wzshiming/ctc v1.2.3 h1:q+hW3IQNsjIlOFBTGZZZeIXTElFM4grF4spW/errh/c= @@ -250,102 +244,116 @@ github.com/wzshiming/winseq v0.0.0-20200112104235-db357dc107ae h1:tpXvBXC3hpQBDC github.com/wzshiming/winseq v0.0.0-20200112104235-db357dc107ae/go.mod h1:VTAq37rkGeV+WOybvZwjXiJOicICdpLCN8ifpISjK20= github.com/xanzy/ssh-agent v0.3.3 h1:+/15pJfg/RsTxqYcX6fHqOXZwwMP+2VyYWJeWM2qQFM= github.com/xanzy/ssh-agent v0.3.3/go.mod h1:6dzNDKs0J9rVPHPhaGCukekBHKqfl+L3KghI1Bc68Uw= +github.com/xo/terminfo v0.0.0-20210125001918-ca9a967f8778 h1:QldyIu/L63oPpyvQmHgvgickp1Yw510KJOqX7H24mg8= github.com/xo/terminfo v0.0.0-20210125001918-ca9a967f8778/go.mod h1:2MuV+tbUrU1zIOPMxZ5EncGwgmMJsa+9ucAQZXxsObs= -github.com/xo/terminfo v0.0.0-20220910002029-abceb7e1c41e h1:JVG44RsyaB9T2KIHavMF/ppJZNG9ZpyihvCd0w101no= -github.com/xo/terminfo v0.0.0-20220910002029-abceb7e1c41e/go.mod h1:RbqR21r5mrJuqunuUZ/Dhy/avygyECGrLceyNeo4LiM= +github.com/yuin/goldmark v1.2.1/go.mod h1:3hX8gzYuyVAZsxl0MRgGTJEmQBFcNTphYh9decYSb74= +github.com/yuin/goldmark v1.4.4/go.mod h1:rmuwmfZ0+bvzB24eSC//bk1R1Zp3hM0OXYv/G2LIilg= +github.com/yuin/goldmark v1.4.13 h1:fVcFKWvrslecOb/tg+Cc05dkeYx540o0FuFt3nUVDoE= github.com/yuin/goldmark v1.4.13/go.mod h1:6yULJ656Px+3vBD8DxQVa3kxgyrAnzto9xy5taEt/CY= -github.com/yuin/goldmark v1.7.1/go.mod h1:uzxRWxtg69N339t3louHJ7+O03ezfj6PlliRlaOzY1E= -github.com/yuin/goldmark v1.7.4 h1:BDXOHExt+A7gwPCJgPIIq7ENvceR7we7rOS9TNoLZeg= -github.com/yuin/goldmark v1.7.4/go.mod h1:uzxRWxtg69N339t3louHJ7+O03ezfj6PlliRlaOzY1E= -github.com/yuin/goldmark-emoji v1.0.3 h1:aLRkLHOuBR2czCY4R8olwMjID+tENfhyFDMCRhbIQY4= -github.com/yuin/goldmark-emoji v1.0.3/go.mod h1:tTkZEbwu5wkPmgTcitqddVxY9osFZiavD+r4AzQrh1U= -github.com/yusufpapurcu/wmi v1.2.4 h1:zFUKzehAFReQwLys1b/iSMl+JQGSCSjtVqQn9bBrPo0= -github.com/yusufpapurcu/wmi v1.2.4/go.mod h1:SBZ9tNy3G9/m5Oi98Zks0QjeHVDvuK0qfxQmPyzfmi0= +github.com/yuin/goldmark-emoji v1.0.1 h1:ctuWEyzGBwiucEqxzwe0SOYDXPAucOrE9NQC18Wa1os= +github.com/yuin/goldmark-emoji v1.0.1/go.mod h1:2w1E6FEWLcDQkoTE+7HU6QF1F6SLlNGjRIBbIZQFqkQ= golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w= golang.org/x/crypto v0.0.0-20210921155107-089bfa567519/go.mod h1:GvvjBRRGRdwPK5ydBHafDWAxML/pGHZbMvKqRZ5+Abc= golang.org/x/crypto v0.0.0-20220622213112-05595931fe9d/go.mod h1:IxCIyHEi3zRg3s0A5j5BB6A9Jmi73HwBIUl50j+osU4= -golang.org/x/crypto v0.33.0 h1:IOBPskki6Lysi0lo9qQvbxiQ+FvsCC/YWOecCHAixus= -golang.org/x/crypto v0.33.0/go.mod h1:bVdXmD7IV/4GdElGPozy6U7lWdRXA4qyRVGJV57uQ5M= -golang.org/x/exp v0.0.0-20240719175910-8a7402abbf56 h1:2dVuKD2vS7b0QIHQbpyTISPd0LeHDbnYEryqj5Q1ug8= -golang.org/x/exp v0.0.0-20240719175910-8a7402abbf56/go.mod h1:M4RDyNAINzryxdtnbRXRL/OHtkFuWGRjvuhBJpk2IlY= +golang.org/x/crypto v0.3.1-0.20221117191849-2c476679df9a/go.mod h1:hebNnKkNXi2UzZN1eVRvBB7co0a+JxK6XbPiWVs/3J4= +golang.org/x/crypto v0.7.0/go.mod h1:pYwdfH91IfpZVANVyUOhSIPZaFoJGxTFbZhFTx+dXZU= +golang.org/x/crypto v0.23.0 h1:dIJU/v2J8Mdglj/8rJ6UUOM3Zc9zLZxVZwwxMooUSAI= +golang.org/x/crypto v0.23.0/go.mod h1:CKFgDieR+mRhux2Lsu27y0fO304Db0wZe70UKqHu0v8= +golang.org/x/exp v0.0.0-20230522175609-2e198f4a06a1 h1:k/i9J1pBpvlfR+9QsetwPyERsqu1GIbi967PQMq3Ivc= +golang.org/x/exp v0.0.0-20230522175609-2e198f4a06a1/go.mod h1:V1LtkGg67GoY2N1AnLN78QLrzxkLyJw7RJb1gzOOz9w= golang.org/x/image v0.0.0-20200430140353-33d19683fad8/go.mod h1:FeLwcggjj3mMvU+oOTbSwawSJRM1uh48EjtB4UJZlP0= golang.org/x/image v0.12.0 h1:w13vZbU4o5rKOFFR8y7M+c4A5jXDC0uXTdHYRP8X2DQ= golang.org/x/image v0.12.0/go.mod h1:Lu90jvHG7GfemOIcldsh9A2hS01ocl6oNO7ype5mEnk= golang.org/x/mod v0.6.0-dev.0.20220419223038-86c51ed26bb4/go.mod h1:jJ57K6gSWd91VN4djpZkiMVwK6gcyfeH4XE8wZrZaV4= golang.org/x/mod v0.8.0/go.mod h1:iBbtSCu2XBx23ZKBPSOrRkjjQPZFPuis4dIYUhu/chs= -golang.org/x/mod v0.23.0 h1:Zb7khfcRGKk+kqfxFaP5tZqCnDZMjC5VtUBs87Hr6QM= -golang.org/x/mod v0.23.0/go.mod h1:6SkKJ3Xj0I0BrPOZoBy3bdMptDDU9oJrpohJ3eWZ1fY= +golang.org/x/mod v0.14.0 h1:dGoOF9QVLYng8IHTm7BAyWqCqSheQ5pYWGhzW00YJr0= +golang.org/x/mod v0.14.0/go.mod h1:hTbmBsO62+eylJbnUtE2MGJUyE7QWk4xUqPFrRgJ+7c= golang.org/x/net v0.0.0-20190620200207-3b0461eec859/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s= golang.org/x/net v0.0.0-20210226172049-e18ecbb05110/go.mod h1:m0MpNAwzfU5UDzcl9v0D8zg8gWTRqZa9RBIspLL5mdg= golang.org/x/net v0.0.0-20210505024714-0287a6fb4125/go.mod h1:9nx3DQGgdP8bBQD5qxJ1jj9UTztislL4KSBs9R2vV5Y= +golang.org/x/net v0.0.0-20210614182718-04defd469f4e/go.mod h1:9nx3DQGgdP8bBQD5qxJ1jj9UTztislL4KSBs9R2vV5Y= golang.org/x/net v0.0.0-20211112202133-69e39bad7dc2/go.mod h1:9nx3DQGgdP8bBQD5qxJ1jj9UTztislL4KSBs9R2vV5Y= golang.org/x/net v0.0.0-20220722155237-a158d28d115b/go.mod h1:XRhObCWvk6IyKnWLug+ECip1KBveYUHfp+8e9klMJ9c= +golang.org/x/net v0.2.0/go.mod h1:KqCZLdyyvdV855qA2rE3GC2aiw5xGR5TEjj8smXukLY= golang.org/x/net v0.6.0/go.mod h1:2Tu9+aMcznHK/AK1HMvgo6xiTLG5rD5rZLDS+rp2Bjs= -golang.org/x/net v0.35.0 h1:T5GQRQb2y08kTAByq9L4/bz8cipCdA8FbRTXewonqY8= -golang.org/x/net v0.35.0/go.mod h1:EglIi67kWsHKlRzzVMUD93VMSWGFOMSZgxFjparz1Qk= +golang.org/x/net v0.8.0/go.mod h1:QVkue5JL9kW//ek3r6jTKnTFis1tRmNAW2P1shuFdJc= +golang.org/x/net v0.25.0 h1:d/OCCoBEUq33pjydKrGQhw7IlUPI2Oylr+8qLx49kac= +golang.org/x/net v0.25.0/go.mod h1:JkAGAh7GEvH74S6FOH42FLoXpXbE/aqXSrIQjXgsiwM= golang.org/x/sync v0.0.0-20190423024810-112230192c58/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= golang.org/x/sync v0.0.0-20220722155255-886fb9371eb4/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= golang.org/x/sync v0.1.0/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= -golang.org/x/sync v0.11.0 h1:GGz8+XQP4FvTTrjZPzNKTMFtSXH80RAzG+5ghFPgK9w= -golang.org/x/sync v0.11.0/go.mod h1:Czt+wKu1gCyEFDUtn0jG5QVvpJ6rzVqr5aXyt9drQfk= +golang.org/x/sync v0.6.0 h1:5BMeUDZ7vkXGfEr1x9B4bRcTH4lpkTkpdh0T/J+qjbQ= +golang.org/x/sync v0.6.0/go.mod h1:Czt+wKu1gCyEFDUtn0jG5QVvpJ6rzVqr5aXyt9drQfk= golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY= golang.org/x/sys v0.0.0-20190916202348-b4ddaad3f8a3/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20191005200804-aed5e4c7ecf9/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20191026070338-33540a1f6037/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20200107162124-548cf772de50/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20200116001909-b77594299b42/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20200810151505-1b9f1253b3ed/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20201119102817-f84b799fce68/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20210124154548-22da62e12c0c/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20210330210617-4fbd30eecc44/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20210423082822-04245dca01da/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20210615035016-665e8c7367d1/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.0.0-20210616045830-e2b7044e8c71/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.0.0-20210630005230-0f9fa26af87c/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.0.0-20210927094055-39ccf1dd6fa6/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/sys v0.0.0-20211013075003-97ac67df715c/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.0.0-20211103235746-7861aae1554b/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/sys v0.0.0-20220319134239-a9b59b0215f8/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/sys v0.0.0-20220520151302-bc2c85ada10a/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/sys v0.0.0-20220715151400-c0bba94af5f8/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/sys v0.0.0-20220722155257-8c9f86f7a55f/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/sys v0.0.0-20220811171246-fbc7d0a398ab/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= -golang.org/x/sys v0.1.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.2.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.3.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/sys v0.5.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/sys v0.6.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= -golang.org/x/sys v0.30.0 h1:QjkSwP/36a20jFYWkSue1YwXzLmsV5Gfq7Eiy72C1uc= -golang.org/x/sys v0.30.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA= +golang.org/x/sys v0.20.0 h1:Od9JTbYCk261bKm4M/mw7AklTlFYIa0bIp9BgSm1S8Y= +golang.org/x/sys v0.20.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA= golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo= golang.org/x/term v0.0.0-20210220032956-6a3ed077a48d/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo= golang.org/x/term v0.0.0-20210615171337-6886f2dfbf5b/go.mod h1:jbD1KX2456YbFQfuXm/mYQcufACuNUgVhRMnK/tPxf8= golang.org/x/term v0.0.0-20210927222741-03fcf44c2211/go.mod h1:jbD1KX2456YbFQfuXm/mYQcufACuNUgVhRMnK/tPxf8= +golang.org/x/term v0.2.0/go.mod h1:TVmDHMZPmdnySmBfhjOoOdhjzdE1h4u1VwSiw2l1Nuc= golang.org/x/term v0.5.0/go.mod h1:jMB1sMXY+tzblOD4FWmEbocvup2/aLOaQEp7JmGp78k= -golang.org/x/term v0.29.0 h1:L6pJp37ocefwRRtYPKSWOWzOtWSxVajvz2ldH/xi3iU= -golang.org/x/term v0.29.0/go.mod h1:6bl4lRlvVuDgSf3179VpIxBF0o10JUpXWOnI7nErv7s= +golang.org/x/term v0.6.0/go.mod h1:m6U89DPEgQRMq3DNkDClhWw02AUbt2daBVO4cn4Hv9U= +golang.org/x/term v0.20.0 h1:VnkxpohqXaOBYJtBmEppKUG6mXpi+4O6purfc2+sMhw= +golang.org/x/term v0.20.0/go.mod h1:8UkIAJTvZgivsXaD6/pH6U9ecQzZ45awqEOzuCvwpFY= golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ= golang.org/x/text v0.3.3/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ= golang.org/x/text v0.3.6/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ= golang.org/x/text v0.3.7/go.mod h1:u+2+/6zg+i71rQMx5EYifcz6MCKuco9NR6JIITiCfzQ= +golang.org/x/text v0.4.0/go.mod h1:mrYo+phRRbMaCq/xk9113O4dZlRixOauAjOtrjsXDZ8= golang.org/x/text v0.7.0/go.mod h1:mrYo+phRRbMaCq/xk9113O4dZlRixOauAjOtrjsXDZ8= -golang.org/x/text v0.9.0/go.mod h1:e1OnstbJyHTd6l/uOt8jFFHp6TRDWZR/bV3emEE/zU8= +golang.org/x/text v0.8.0/go.mod h1:e1OnstbJyHTd6l/uOt8jFFHp6TRDWZR/bV3emEE/zU8= golang.org/x/text v0.13.0/go.mod h1:TvPlkZtksWOMsz7fbANvkp4WM8x/WCo/om8BMLbz+aE= -golang.org/x/text v0.22.0 h1:bofq7m3/HAFvbF51jz3Q9wLg3jkvSPuiZu/pD1XwgtM= -golang.org/x/text v0.22.0/go.mod h1:YRoo4H8PVmsu+E3Ou7cqLVH8oXWIHVoX0jqUWALQhfY= +golang.org/x/text v0.15.0 h1:h1V/4gjBv8v9cjcR6+AR5+/cIYK5N/WAgiv4xlsEtAk= +golang.org/x/text v0.15.0/go.mod h1:18ZOQIKpY8NJVqYksKHtTdi31H5itFRjB5/qKTNYzSU= golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ= golang.org/x/tools v0.0.0-20191119224855-298f0cb1881e/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo= golang.org/x/tools v0.1.12/go.mod h1:hNGJHUnrk76NpqgfD5Aqm5Crs+Hm0VOH/i9J2+nxYbc= golang.org/x/tools v0.6.0/go.mod h1:Xwgl3UAJ/d3gWutnCtw505GrjyAbvKui8lOU390QaIU= -golang.org/x/tools v0.30.0 h1:BgcpHewrV5AUp2G9MebG4XPFI1E2W41zU1SaqVA9vJY= -golang.org/x/tools v0.30.0/go.mod h1:c347cR/OJfw5TI+GfX7RUPNMdDRRbjvYTS0jPyvsVtY= +golang.org/x/tools v0.17.0 h1:FvmRgNOcs3kOa+T20R1uhfP9F6HgG2mfxDv1vrx1Htc= +golang.org/x/tools v0.17.0/go.mod h1:xsh6VxdV005rRVaS6SSAf9oiAqljS7UZUacMZ8Bnsps= golang.org/x/xerrors v0.0.0-20190717185122-a985d3407aa7/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= +golang.org/x/xerrors v0.0.0-20191204190536-9bdfabe68543/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= +golang.org/x/xerrors v0.0.0-20200804184101-5ec99f83aff1/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= gopkg.in/check.v1 v1.0.0-20190902080502-41f04d3bba15/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c h1:Hei/4ADfdWqJk1ZMxUNpqntNwaWcugrBjAiHlqqRiVk= gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c/go.mod h1:JHkPIbrfpd72SG/EVd6muEfDQjcINNoR0C8j2r3qZ4Q= gopkg.in/warnings.v0 v0.1.2 h1:wFXVbFY8DY5/xOe1ECiWdKCzZlxgshcYVNkBHstARME= gopkg.in/warnings.v0 v0.1.2/go.mod h1:jksf8JmL6Qr/oQM2OXTHunEvvTAsrWBLb6OOjuVWRNI= +gopkg.in/yaml.v1 v1.0.0-20140924161607-9f9df34309c0/go.mod h1:WDnlLJ4WF5VGsH/HVa3CI79GS0ol3YnhVnKP89i0kNg= gopkg.in/yaml.v2 v2.2.2/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI= gopkg.in/yaml.v2 v2.2.4/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI= +gopkg.in/yaml.v2 v2.4.0 h1:D8xgwECY7CYvx+Y2n4sBz93Jn9JRvxdiyyo8CTfuKaY= gopkg.in/yaml.v2 v2.4.0/go.mod h1:RDklbk79AGWmwhnvt/jBztapEOGDOx6ZbXqjP6csGnQ= gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= gopkg.in/yaml.v3 v3.0.0-20210107192922-496545a6307b/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA= gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= -howett.net/plist v1.0.2-0.20250314012144-ee69052608d9 h1:eeH1AIcPvSc0Z25ThsYF+Xoqbn0CI/YnXVYoTLFdGQw= -howett.net/plist v1.0.2-0.20250314012144-ee69052608d9/go.mod h1:fyFX5Hj5tP1Mpk8obqA9MZgXT416Q5711SDT7dQLTLk= -mvdan.cc/sh/v3 v3.7.0 h1:lSTjdP/1xsddtaKfGg7Myu7DnlHItd3/M2tomOcNNBg= -mvdan.cc/sh/v3 v3.7.0/go.mod h1:K2gwkaesF/D7av7Kxl0HbF5kGOd2ArupNTX3X44+8l8= +howett.net/plist v1.0.0 h1:7CrbWYbPPO/PyNy38b2EB/+gYbjCe2DXBxgtOOZbSQM= +howett.net/plist v1.0.0/go.mod h1:lqaXoTrLY4hg8tnEzNru53gicrbv7rrk+2xJA/7hw9g= diff --git a/v2/internal/app/app_dev.go b/v2/internal/app/app_dev.go index 6de845f96..58cd94ef0 100644 --- a/v2/internal/app/app_dev.go +++ b/v2/internal/app/app_dev.go @@ -46,12 +46,7 @@ func CreateApp(appoptions *options.App) (*App, error) { ctx = context.WithValue(ctx, "debug", true) ctx = context.WithValue(ctx, "devtoolsEnabled", true) - // Set up logger if the appoptions.LogLevel is an invalid value, set it to the default log level - appoptions.LogLevel, err = pkglogger.StringToLogLevel(appoptions.LogLevel.String()) - if err != nil { - return nil, err - } - + // Set up logger myLogger := logger.New(appoptions.Logger) myLogger.SetLogLevel(appoptions.LogLevel) @@ -79,11 +74,9 @@ func CreateApp(appoptions *options.App) (*App, error) { } loglevel := os.Getenv("loglevel") - appLogLevel := appoptions.LogLevel.String() - if loglevel != "" { - appLogLevel = loglevel + if loglevel == "" { + loglevelFlag = devFlags.String("loglevel", "debug", "Loglevel to use - Trace, Debug, Info, Warning, Error") } - loglevelFlag = devFlags.String("loglevel", appLogLevel, "Loglevel to use - Trace, Debug, Info, Warning, Error") // If we weren't given the assetdir in the environment variables if assetdir == "" { @@ -181,10 +174,7 @@ func CreateApp(appoptions *options.App) (*App, error) { if err != nil { return nil, err } - // Only set the log level if it's different from the appoptions.LogLevel - if level != appoptions.LogLevel { - myLogger.SetLogLevel(level) - } + myLogger.SetLogLevel(level) } // Attach logger to context @@ -223,7 +213,7 @@ func CreateApp(appoptions *options.App) (*App, error) { eventHandler := runtime.NewEvents(myLogger) ctx = context.WithValue(ctx, "events", eventHandler) - messageDispatcher := dispatcher.NewDispatcher(ctx, myLogger, appBindings, eventHandler, appoptions.ErrorFormatter, appoptions.DisablePanicRecovery) + messageDispatcher := dispatcher.NewDispatcher(ctx, myLogger, appBindings, eventHandler, appoptions.ErrorFormatter) // Create the frontends and register to event handler desktopFrontend := desktop.NewFrontend(ctx, appoptions, myLogger, appBindings, messageDispatcher) diff --git a/v2/internal/app/app_devtools.go b/v2/internal/app/app_devtools.go index 60b221094..a84e8c283 100644 --- a/v2/internal/app/app_devtools.go +++ b/v2/internal/app/app_devtools.go @@ -1,8 +1,8 @@ -//go:build devtools - -package app - -// Note: devtools flag is also added in debug builds -func IsDevtoolsEnabled() bool { - return true -} +//go:build devtools + +package app + +// Note: devtools flag is also added in debug builds +func IsDevtoolsEnabled() bool { + return true +} diff --git a/v2/internal/app/app_production.go b/v2/internal/app/app_production.go index 9eb0e5a66..4c217b17c 100644 --- a/v2/internal/app/app_production.go +++ b/v2/internal/app/app_production.go @@ -82,7 +82,7 @@ func CreateApp(appoptions *options.App) (*App, error) { ctx = context.WithValue(ctx, "buildtype", "production") } - messageDispatcher := dispatcher.NewDispatcher(ctx, myLogger, appBindings, eventHandler, appoptions.ErrorFormatter, appoptions.DisablePanicRecovery) + messageDispatcher := dispatcher.NewDispatcher(ctx, myLogger, appBindings, eventHandler, appoptions.ErrorFormatter) appFrontend := desktop.NewFrontend(ctx, appoptions, myLogger, appBindings, messageDispatcher) eventHandler.AddFrontend(appFrontend) diff --git a/v2/internal/binding/binding.go b/v2/internal/binding/binding.go index b7bf07ae0..568e11b03 100644 --- a/v2/internal/binding/binding.go +++ b/v2/internal/binding/binding.go @@ -14,7 +14,6 @@ import ( "github.com/wailsapp/wails/v2/internal/typescriptify" "github.com/leaanthony/slicer" - "github.com/wailsapp/wails/v2/internal/logger" ) @@ -74,7 +73,13 @@ func (b *Bindings) Add(structPtr interface{}) error { } for _, method := range methods { - b.db.AddMethod(method.Path.Package, method.Path.Struct, method.Path.Name, method) + splitName := strings.Split(method.Name, ".") + packageName := splitName[0] + structName := splitName[1] + methodName := splitName[2] + + // Add it as a regular method + b.db.AddMethod(packageName, structName, methodName, method) } return nil } @@ -123,15 +128,7 @@ func (b *Bindings) GenerateModels() ([]byte, error) { // if we have enums for this package, add them as well var enums, enumsExist = b.enumsToGenerateTS[packageName] if enumsExist { - // Sort the enum names first to make the output deterministic - sortedEnumNames := make([]string, 0, len(enums)) - for enumName := range enums { - sortedEnumNames = append(sortedEnumNames, enumName) - } - sort.Strings(sortedEnumNames) - - for _, enumName := range sortedEnumNames { - enum := enums[enumName] + for enumName, enum := range enums { fqemumname := packageName + "." + enumName if seen.Contains(fqemumname) { continue @@ -180,7 +177,7 @@ func (b *Bindings) GenerateModels() ([]byte, error) { } // Sort the package names first to make the output deterministic - sortedPackageNames := make([]string, 0, len(models)) + sortedPackageNames := make([]string, 0) for packageName := range models { sortedPackageNames = append(sortedPackageNames, packageName) } @@ -265,19 +262,22 @@ func (b *Bindings) AddStructToGenerateTS(packageName string, structName string, // Iterate this struct and add any struct field references structType := reflect.TypeOf(s) - for hasElements(structType) { + if hasElements(structType) { structType = structType.Elem() } for i := 0; i < structType.NumField(); i++ { field := structType.Field(i) - if field.Anonymous || !field.IsExported() { + if field.Anonymous { continue } kind := field.Type.Kind() if kind == reflect.Struct { + if !field.IsExported() { + continue + } fqname := field.Type.String() - sNameSplit := strings.SplitN(fqname, ".", 2) + sNameSplit := strings.Split(fqname, ".") if len(sNameSplit) < 2 { continue } @@ -288,24 +288,22 @@ func (b *Bindings) AddStructToGenerateTS(packageName string, structName string, s := reflect.Indirect(a).Interface() b.AddStructToGenerateTS(pName, sName, s) } - } else { - fType := field.Type - for hasElements(fType) { - fType = fType.Elem() + } else if hasElements(field.Type) && field.Type.Elem().Kind() == reflect.Struct { + if !field.IsExported() { + continue } - if fType.Kind() == reflect.Struct { - fqname := fType.String() - sNameSplit := strings.SplitN(fqname, ".", 2) - if len(sNameSplit) < 2 { - continue - } - sName := sNameSplit[1] - pName := getPackageName(fqname) - a := reflect.New(fType) - if b.hasExportedJSONFields(fType) { - s := reflect.Indirect(a).Interface() - b.AddStructToGenerateTS(pName, sName, s) - } + fqname := field.Type.Elem().String() + sNameSplit := strings.Split(fqname, ".") + if len(sNameSplit) < 2 { + continue + } + sName := sNameSplit[1] + pName := getPackageName(fqname) + typ := field.Type.Elem() + a := reflect.New(typ) + if b.hasExportedJSONFields(typ) { + s := reflect.Indirect(a).Interface() + b.AddStructToGenerateTS(pName, sName, s) } } } @@ -352,18 +350,7 @@ func (b *Bindings) hasExportedJSONFields(typeOf reflect.Type) bool { for i := 0; i < typeOf.NumField(); i++ { jsonFieldName := "" f := typeOf.Field(i) - // function, complex, and channel types cannot be json-encoded - if f.Type.Kind() == reflect.Chan || - f.Type.Kind() == reflect.Func || - f.Type.Kind() == reflect.UnsafePointer || - f.Type.Kind() == reflect.Complex128 || - f.Type.Kind() == reflect.Complex64 { - continue - } - jsonTag, hasTag := f.Tag.Lookup("json") - if !hasTag && f.IsExported() { - return true - } + jsonTag := f.Tag.Get("json") if len(jsonTag) == 0 { continue } diff --git a/v2/internal/binding/binding_test/binding_deepelements_test.go b/v2/internal/binding/binding_test/binding_deepelements_test.go deleted file mode 100644 index 034687474..000000000 --- a/v2/internal/binding/binding_test/binding_deepelements_test.go +++ /dev/null @@ -1,126 +0,0 @@ -package binding_test - -// Issues 2303, 3442, 3709 - -type DeepMessage struct { - Msg string -} - -type DeepElements struct { - Single []int - Double [][]string - FourDouble [4][]float64 - DoubleFour [][4]int64 - Triple [][][]int - - SingleMap map[string]int - SliceMap map[string][]int - DoubleSliceMap map[string][][]int - - ArrayMap map[string][4]int - DoubleArrayMap1 map[string][4][]int - DoubleArrayMap2 map[string][][4]int - DoubleArrayMap3 map[string][4][4]int - - OneStructs []*DeepMessage - TwoStructs [3][]*DeepMessage - ThreeStructs [][][]DeepMessage - MapStructs map[string][]*DeepMessage - MapTwoStructs map[string][4][]DeepMessage - MapThreeStructs map[string][][7][]*DeepMessage -} - -func (x DeepElements) Get() DeepElements { - return x -} - -var DeepElementsTest = BindingTest{ - name: "DeepElements", - structs: []interface{}{ - &DeepElements{}, - }, - exemptions: nil, - shouldError: false, - want: ` -export namespace binding_test { - - export class DeepMessage { - Msg: string; - - static createFrom(source: any = {}) { - return new DeepMessage(source); - } - - constructor(source: any = {}) { - if ('string' === typeof source) source = JSON.parse(source); - this.Msg = source["Msg"]; - } - } - export class DeepElements { - Single: number[]; - Double: string[][]; - FourDouble: number[][]; - DoubleFour: number[][]; - Triple: number[][][]; - SingleMap: Record; - SliceMap: Record>; - DoubleSliceMap: Record>>; - ArrayMap: Record>; - DoubleArrayMap1: Record>>; - DoubleArrayMap2: Record>>; - DoubleArrayMap3: Record>>; - OneStructs: DeepMessage[]; - TwoStructs: DeepMessage[][]; - ThreeStructs: DeepMessage[][][]; - MapStructs: Record>; - MapTwoStructs: Record>>; - MapThreeStructs: Record>>>; - - static createFrom(source: any = {}) { - return new DeepElements(source); - } - - constructor(source: any = {}) { - if ('string' === typeof source) source = JSON.parse(source); - this.Single = source["Single"]; - this.Double = source["Double"]; - this.FourDouble = source["FourDouble"]; - this.DoubleFour = source["DoubleFour"]; - this.Triple = source["Triple"]; - this.SingleMap = source["SingleMap"]; - this.SliceMap = source["SliceMap"]; - this.DoubleSliceMap = source["DoubleSliceMap"]; - this.ArrayMap = source["ArrayMap"]; - this.DoubleArrayMap1 = source["DoubleArrayMap1"]; - this.DoubleArrayMap2 = source["DoubleArrayMap2"]; - this.DoubleArrayMap3 = source["DoubleArrayMap3"]; - this.OneStructs = this.convertValues(source["OneStructs"], DeepMessage); - this.TwoStructs = this.convertValues(source["TwoStructs"], DeepMessage); - this.ThreeStructs = this.convertValues(source["ThreeStructs"], DeepMessage); - this.MapStructs = this.convertValues(source["MapStructs"], Array, true); - this.MapTwoStructs = this.convertValues(source["MapTwoStructs"], Array>, true); - this.MapThreeStructs = this.convertValues(source["MapThreeStructs"], Array>>, true); - } - - convertValues(a: any, classs: any, asMap: boolean = false): any { - if (!a) { - return a; - } - if (a.slice && a.map) { - return (a as any[]).map(elem => this.convertValues(elem, classs)); - } else if ("object" === typeof a) { - if (asMap) { - for (const key of Object.keys(a)) { - a[key] = new classs(a[key]); - } - return a; - } - return new classs(a); - } - return a; - } - } - - } -`, -} diff --git a/v2/internal/binding/binding_test/binding_enum_ordering_test.go b/v2/internal/binding/binding_test/binding_enum_ordering_test.go deleted file mode 100644 index 0939535ec..000000000 --- a/v2/internal/binding/binding_test/binding_enum_ordering_test.go +++ /dev/null @@ -1,271 +0,0 @@ -package binding_test - -// Test for PR #4664: Fix generated enums ordering -// This test ensures that enum output is deterministic regardless of map iteration order - -// ZFirstEnum - named with Z prefix to test alphabetical sorting -type ZFirstEnum int - -const ( - ZFirstEnumValue1 ZFirstEnum = iota - ZFirstEnumValue2 -) - -var AllZFirstEnumValues = []struct { - Value ZFirstEnum - TSName string -}{ - {ZFirstEnumValue1, "ZValue1"}, - {ZFirstEnumValue2, "ZValue2"}, -} - -// ASecondEnum - named with A prefix to test alphabetical sorting -type ASecondEnum int - -const ( - ASecondEnumValue1 ASecondEnum = iota - ASecondEnumValue2 -) - -var AllASecondEnumValues = []struct { - Value ASecondEnum - TSName string -}{ - {ASecondEnumValue1, "AValue1"}, - {ASecondEnumValue2, "AValue2"}, -} - -// MMiddleEnum - named with M prefix to test alphabetical sorting -type MMiddleEnum int - -const ( - MMiddleEnumValue1 MMiddleEnum = iota - MMiddleEnumValue2 -) - -var AllMMiddleEnumValues = []struct { - Value MMiddleEnum - TSName string -}{ - {MMiddleEnumValue1, "MValue1"}, - {MMiddleEnumValue2, "MValue2"}, -} - -type EntityWithMultipleEnums struct { - Name string `json:"name"` - EnumZ ZFirstEnum `json:"enumZ"` - EnumA ASecondEnum `json:"enumA"` - EnumM MMiddleEnum `json:"enumM"` -} - -func (e EntityWithMultipleEnums) Get() EntityWithMultipleEnums { - return e -} - -// EnumOrderingTest tests that multiple enums in the same package are output -// in alphabetical order by enum name. Before PR #4664, the order was -// non-deterministic due to Go map iteration order. -var EnumOrderingTest = BindingTest{ - name: "EnumOrderingTest", - structs: []interface{}{ - &EntityWithMultipleEnums{}, - }, - enums: []interface{}{ - // Intentionally add enums in non-alphabetical order - AllZFirstEnumValues, - AllASecondEnumValues, - AllMMiddleEnumValues, - }, - exemptions: nil, - shouldError: false, - TsGenerationOptionsTest: TsGenerationOptionsTest{ - TsPrefix: "", - TsSuffix: "", - }, - // Expected output should have enums in alphabetical order: ASecondEnum, MMiddleEnum, ZFirstEnum - want: `export namespace binding_test { - - export enum ASecondEnum { - AValue1 = 0, - AValue2 = 1, - } - export enum MMiddleEnum { - MValue1 = 0, - MValue2 = 1, - } - export enum ZFirstEnum { - ZValue1 = 0, - ZValue2 = 1, - } - export class EntityWithMultipleEnums { - name: string; - enumZ: ZFirstEnum; - enumA: ASecondEnum; - enumM: MMiddleEnum; - - static createFrom(source: any = {}) { - return new EntityWithMultipleEnums(source); - } - - constructor(source: any = {}) { - if ('string' === typeof source) source = JSON.parse(source); - this.name = source["name"]; - this.enumZ = source["enumZ"]; - this.enumA = source["enumA"]; - this.enumM = source["enumM"]; - } - } - -} -`, -} - -// EnumElementOrderingEnum tests sorting of enum elements by TSName -type EnumElementOrderingEnum string - -const ( - EnumElementZ EnumElementOrderingEnum = "z_value" - EnumElementA EnumElementOrderingEnum = "a_value" - EnumElementM EnumElementOrderingEnum = "m_value" -) - -// AllEnumElementOrderingValues intentionally lists values out of alphabetical order -// to test that AddEnum sorts them -var AllEnumElementOrderingValues = []struct { - Value EnumElementOrderingEnum - TSName string -}{ - {EnumElementZ, "Zebra"}, - {EnumElementA, "Apple"}, - {EnumElementM, "Mango"}, -} - -type EntityWithUnorderedEnumElements struct { - Name string `json:"name"` - Enum EnumElementOrderingEnum `json:"enum"` -} - -func (e EntityWithUnorderedEnumElements) Get() EntityWithUnorderedEnumElements { - return e -} - -// EnumElementOrderingTest tests that enum elements are sorted alphabetically -// by their TSName within an enum. Before PR #4664, elements appeared in the -// order they were added, which could be arbitrary. -var EnumElementOrderingTest = BindingTest{ - name: "EnumElementOrderingTest", - structs: []interface{}{ - &EntityWithUnorderedEnumElements{}, - }, - enums: []interface{}{ - AllEnumElementOrderingValues, - }, - exemptions: nil, - shouldError: false, - TsGenerationOptionsTest: TsGenerationOptionsTest{ - TsPrefix: "", - TsSuffix: "", - }, - // Expected output should have enum elements sorted: Apple, Mango, Zebra - want: `export namespace binding_test { - - export enum EnumElementOrderingEnum { - Apple = "a_value", - Mango = "m_value", - Zebra = "z_value", - } - export class EntityWithUnorderedEnumElements { - name: string; - enum: EnumElementOrderingEnum; - - static createFrom(source: any = {}) { - return new EntityWithUnorderedEnumElements(source); - } - - constructor(source: any = {}) { - if ('string' === typeof source) source = JSON.parse(source); - this.name = source["name"]; - this.enum = source["enum"]; - } - } - -} -`, -} - -// TSNameEnumElementOrdering tests sorting with TSName() method enum -type TSNameEnumElementOrdering string - -const ( - TSNameEnumZ TSNameEnumElementOrdering = "z_value" - TSNameEnumA TSNameEnumElementOrdering = "a_value" - TSNameEnumM TSNameEnumElementOrdering = "m_value" -) - -func (v TSNameEnumElementOrdering) TSName() string { - switch v { - case TSNameEnumZ: - return "Zebra" - case TSNameEnumA: - return "Apple" - case TSNameEnumM: - return "Mango" - default: - return "Unknown" - } -} - -// AllTSNameEnumValues intentionally out of order -var AllTSNameEnumValues = []TSNameEnumElementOrdering{TSNameEnumZ, TSNameEnumA, TSNameEnumM} - -type EntityWithTSNameEnumOrdering struct { - Name string `json:"name"` - Enum TSNameEnumElementOrdering `json:"enum"` -} - -func (e EntityWithTSNameEnumOrdering) Get() EntityWithTSNameEnumOrdering { - return e -} - -// TSNameEnumElementOrderingTest tests that enums using TSName() method -// also have their elements sorted alphabetically by the TSName. -var TSNameEnumElementOrderingTest = BindingTest{ - name: "TSNameEnumElementOrderingTest", - structs: []interface{}{ - &EntityWithTSNameEnumOrdering{}, - }, - enums: []interface{}{ - AllTSNameEnumValues, - }, - exemptions: nil, - shouldError: false, - TsGenerationOptionsTest: TsGenerationOptionsTest{ - TsPrefix: "", - TsSuffix: "", - }, - // Expected output should have enum elements sorted: Apple, Mango, Zebra - want: `export namespace binding_test { - - export enum TSNameEnumElementOrdering { - Apple = "a_value", - Mango = "m_value", - Zebra = "z_value", - } - export class EntityWithTSNameEnumOrdering { - name: string; - enum: TSNameEnumElementOrdering; - - static createFrom(source: any = {}) { - return new EntityWithTSNameEnumOrdering(source); - } - - constructor(source: any = {}) { - if ('string' === typeof source) source = JSON.parse(source); - this.name = source["name"]; - this.enum = source["enum"]; - } - } - -} -`, -} diff --git a/v2/internal/binding/binding_test/binding_generics_test.go b/v2/internal/binding/binding_test/binding_generics_test.go deleted file mode 100644 index 920bd2a7a..000000000 --- a/v2/internal/binding/binding_test/binding_generics_test.go +++ /dev/null @@ -1,154 +0,0 @@ -package binding_test - -import "github.com/wailsapp/wails/v2/internal/binding/binding_test/binding_test_import/float_package" - -// Issues 3900, 3371, 2323 (no TS generics though) - -type ListData[T interface{}] struct { - Total int64 `json:"Total"` - TotalPage int64 `json:"TotalPage"` - PageNum int `json:"PageNum"` - List []T `json:"List,omitempty"` -} - -func (x ListData[T]) Get() ListData[T] { - return x -} - -var Generics1Test = BindingTest{ - name: "Generics1", - structs: []interface{}{ - &ListData[string]{}, - }, - exemptions: nil, - shouldError: false, - want: ` -export namespace binding_test { - - export class ListData_string_ { - Total: number; - TotalPage: number; - PageNum: number; - List?: string[]; - - static createFrom(source: any = {}) { - return new ListData_string_(source); - } - - constructor(source: any = {}) { - if ('string' === typeof source) source = JSON.parse(source); - this.Total = source["Total"]; - this.TotalPage = source["TotalPage"]; - this.PageNum = source["PageNum"]; - this.List = source["List"]; - } - } - - } -`, -} - -var Generics2Test = BindingTest{ - name: "Generics2", - structs: []interface{}{ - &ListData[float_package.SomeStruct]{}, - &ListData[*float_package.SomeStruct]{}, - }, - exemptions: nil, - shouldError: false, - want: ` -export namespace binding_test { - - export class ListData__github_com_wailsapp_wails_v2_internal_binding_binding_test_binding_test_import_float_package_SomeStruct_ { - Total: number; - TotalPage: number; - PageNum: number; - List?: float_package.SomeStruct[]; - - static createFrom(source: any = {}) { - return new ListData__github_com_wailsapp_wails_v2_internal_binding_binding_test_binding_test_import_float_package_SomeStruct_(source); - } - - constructor(source: any = {}) { - if ('string' === typeof source) source = JSON.parse(source); - this.Total = source["Total"]; - this.TotalPage = source["TotalPage"]; - this.PageNum = source["PageNum"]; - this.List = this.convertValues(source["List"], float_package.SomeStruct); - } - - convertValues(a: any, classs: any, asMap: boolean = false): any { - if (!a) { - return a; - } - if (a.slice && a.map) { - return (a as any[]).map(elem => this.convertValues(elem, classs)); - } else if ("object" === typeof a) { - if (asMap) { - for (const key of Object.keys(a)) { - a[key] = new classs(a[key]); - } - return a; - } - return new classs(a); - } - return a; - } - } - export class ListData_github_com_wailsapp_wails_v2_internal_binding_binding_test_binding_test_import_float_package_SomeStruct_ { - Total: number; - TotalPage: number; - PageNum: number; - List?: float_package.SomeStruct[]; - - static createFrom(source: any = {}) { - return new ListData_github_com_wailsapp_wails_v2_internal_binding_binding_test_binding_test_import_float_package_SomeStruct_(source); - } - - constructor(source: any = {}) { - if ('string' === typeof source) source = JSON.parse(source); - this.Total = source["Total"]; - this.TotalPage = source["TotalPage"]; - this.PageNum = source["PageNum"]; - this.List = this.convertValues(source["List"], float_package.SomeStruct); - } - - convertValues(a: any, classs: any, asMap: boolean = false): any { - if (!a) { - return a; - } - if (a.slice && a.map) { - return (a as any[]).map(elem => this.convertValues(elem, classs)); - } else if ("object" === typeof a) { - if (asMap) { - for (const key of Object.keys(a)) { - a[key] = new classs(a[key]); - } - return a; - } - return new classs(a); - } - return a; - } - } - - } - - export namespace float_package { - - export class SomeStruct { - string: string; - - static createFrom(source: any = {}) { - return new SomeStruct(source); - } - - constructor(source: any = {}) { - if ('string' === typeof source) source = JSON.parse(source); - this.string = source["string"]; - } - } - - } -`, -} diff --git a/v2/internal/binding/binding_test/binding_ignored_test.go b/v2/internal/binding/binding_test/binding_ignored_test.go deleted file mode 100644 index aeb6a9c3f..000000000 --- a/v2/internal/binding/binding_test/binding_ignored_test.go +++ /dev/null @@ -1,47 +0,0 @@ -package binding_test - -import ( - "unsafe" -) - -// Issues 3755, 3809 - -type Ignored struct { - Valid bool - Total func() int `json:"Total"` - UnsafeP unsafe.Pointer - Complex64 complex64 `json:"Complex"` - Complex128 complex128 - StringChan chan string -} - -func (x Ignored) Get() Ignored { - return x -} - -var IgnoredTest = BindingTest{ - name: "Ignored", - structs: []interface{}{ - &Ignored{}, - }, - exemptions: nil, - shouldError: false, - want: ` -export namespace binding_test { - - export class Ignored { - Valid: boolean; - - static createFrom(source: any = {}) { - return new Ignored(source); - } - - constructor(source: any = {}) { - if ('string' === typeof source) source = JSON.parse(source); - this.Valid = source["Valid"]; - } - } - - } -`, -} diff --git a/v2/internal/binding/binding_test/binding_importedmap_test.go b/v2/internal/binding/binding_test/binding_importedmap_test.go index 4a4b2996c..7fa11d54b 100644 --- a/v2/internal/binding/binding_test/binding_importedmap_test.go +++ b/v2/internal/binding/binding_test/binding_importedmap_test.go @@ -50,7 +50,7 @@ export namespace binding_test { export namespace binding_test_import { export class AMapWrapper { - AMap: Record; + AMap: {[key: string]: binding_test_nestedimport.A}; static createFrom(source: any = {}) { return new AMapWrapper(source); } diff --git a/v2/internal/binding/binding_test/binding_nonstringmapkey_test.go b/v2/internal/binding/binding_test/binding_nonstringmapkey_test.go index 9efee710f..37a61dd29 100644 --- a/v2/internal/binding/binding_test/binding_nonstringmapkey_test.go +++ b/v2/internal/binding/binding_test/binding_nonstringmapkey_test.go @@ -18,7 +18,7 @@ var NonStringMapKeyTest = BindingTest{ want: ` export namespace binding_test { export class NonStringMapKey { - numberMap: Record; + numberMap: {[key: number]: any}; static createFrom(source: any = {}) { return new NonStringMapKey(source); } diff --git a/v2/internal/binding/binding_test/binding_notags_test.go b/v2/internal/binding/binding_test/binding_notags_test.go deleted file mode 100644 index d4d9997e0..000000000 --- a/v2/internal/binding/binding_test/binding_notags_test.go +++ /dev/null @@ -1,60 +0,0 @@ -package binding_test - -type NoFieldTags struct { - Name string - Address string - Zip *string - Spouse *NoFieldTags - NoFunc func() string -} - -func (n NoFieldTags) Get() NoFieldTags { - return n -} - -var NoFieldTagsTest = BindingTest{ - name: "NoFieldTags", - structs: []interface{}{ - &NoFieldTags{}, - }, - exemptions: nil, - shouldError: false, - want: ` -export namespace binding_test { - export class NoFieldTags { - Name: string; - Address: string; - Zip?: string; - Spouse?: NoFieldTags; - static createFrom(source: any = {}) { - return new NoFieldTags(source); - } - constructor(source: any = {}) { - if ('string' === typeof source) source = JSON.parse(source); - this.Name = source["Name"]; - this.Address = source["Address"]; - this.Zip = source["Zip"]; - this.Spouse = this.convertValues(source["Spouse"], NoFieldTags); - } - - convertValues(a: any, classs: any, asMap: boolean = false): any { - if (!a) { - return a; - } - if (a.slice && a.map) { - return (a as any[]).map(elem => this.convertValues(elem, classs)); - } else if ("object" === typeof a) { - if (asMap) { - for (const key of Object.keys(a)) { - a[key] = new classs(a[key]); - } - return a; - } - return new classs(a); - } - return a; - } - } -} -`, -} diff --git a/v2/internal/binding/binding_test/binding_test.go b/v2/internal/binding/binding_test/binding_test.go index 41f0618ce..a16dde5ea 100644 --- a/v2/internal/binding/binding_test/binding_test.go +++ b/v2/internal/binding/binding_test/binding_test.go @@ -50,15 +50,6 @@ func TestBindings_GenerateModels(t *testing.T) { EntityWithDiffNamespacesTest, SpecialCharacterFieldTest, WithoutFieldsTest, - NoFieldTagsTest, - Generics1Test, - Generics2Test, - IgnoredTest, - DeepElementsTest, - // PR #4664: Enum ordering tests - EnumOrderingTest, - EnumElementOrderingTest, - TSNameEnumElementOrderingTest, } testLogger := &logger.Logger{} diff --git a/v2/internal/binding/binding_test/binding_type_alias_test.go b/v2/internal/binding/binding_test/binding_type_alias_test.go index 90b009c5f..498c5976c 100644 --- a/v2/internal/binding/binding_test/binding_type_alias_test.go +++ b/v2/internal/binding/binding_test/binding_type_alias_test.go @@ -15,11 +15,11 @@ const expectedTypeAliasBindings = `// Cynhyrchwyd y ffeil hon yn awtomatig. PEID import {binding_test} from '../models'; import {int_package} from '../models'; -export function Map():Promise>; +export function Map():Promise<{[key: string]: string}>; export function MapAlias():Promise; -export function MapWithImportedStructValue():Promise>; +export function MapWithImportedStructValue():Promise<{[key: string]: int_package.SomeStruct}>; export function Slice():Promise>; diff --git a/v2/internal/binding/boundMethod.go b/v2/internal/binding/boundMethod.go index e697041b0..c13e2ff37 100644 --- a/v2/internal/binding/boundMethod.go +++ b/v2/internal/binding/boundMethod.go @@ -6,24 +6,14 @@ import ( "reflect" ) -type BoundedMethodPath struct { - Package string - Struct string - Name string -} - -func (p *BoundedMethodPath) FullName() string { - return fmt.Sprintf("%s.%s.%s", p.Package, p.Struct, p.Name) -} - // BoundMethod defines all the data related to a Go method that is // bound to the Wails application type BoundMethod struct { - Path *BoundedMethodPath `json:"path"` - Inputs []*Parameter `json:"inputs,omitempty"` - Outputs []*Parameter `json:"outputs,omitempty"` - Comments string `json:"comments,omitempty"` - Method reflect.Value `json:"-"` + Name string `json:"name"` + Inputs []*Parameter `json:"inputs,omitempty"` + Outputs []*Parameter `json:"outputs,omitempty"` + Comments string `json:"comments,omitempty"` + Method reflect.Value `json:"-"` } // InputCount returns the number of inputs this bound method has @@ -40,7 +30,7 @@ func (b *BoundMethod) OutputCount() int { func (b *BoundMethod) ParseArgs(args []json.RawMessage) ([]interface{}, error) { result := make([]interface{}, b.InputCount()) if len(args) != b.InputCount() { - return nil, fmt.Errorf("received %d arguments to method '%s', expected %d", len(args), b.Path.FullName(), b.InputCount()) + return nil, fmt.Errorf("received %d arguments to method '%s', expected %d", len(args), b.Name, b.InputCount()) } for index, arg := range args { typ := b.Inputs[index].reflectType @@ -64,7 +54,7 @@ func (b *BoundMethod) Call(args []interface{}) (interface{}, error) { expectedInputLength := len(b.Inputs) actualInputLength := len(args) if expectedInputLength != actualInputLength { - return nil, fmt.Errorf("%s takes %d inputs. Received %d", b.Path.FullName(), expectedInputLength, actualInputLength) + return nil, fmt.Errorf("%s takes %d inputs. Received %d", b.Name, expectedInputLength, actualInputLength) } /** Convert inputs to reflect values **/ diff --git a/v2/internal/binding/generate.go b/v2/internal/binding/generate.go index 77edc983d..02a0bd292 100644 --- a/v2/internal/binding/generate.go +++ b/v2/internal/binding/generate.go @@ -171,18 +171,7 @@ func fullyQualifiedName(packageName string, typeName string) string { } } -var ( - jsVariableUnsafeChars = regexp.MustCompile(`[^A-Za-z0-9_]`) -) - func arrayifyValue(valueArray string, valueType string) string { - valueType = strings.ReplaceAll(valueType, "*", "") - gidx := strings.IndexRune(valueType, '[') - if gidx > 0 { // its a generic type - rem := strings.SplitN(valueType, "[", 2) - valueType = rem[0] + "_" + jsVariableUnsafeChars.ReplaceAllLiteralString(rem[1], "_") - } - if len(valueArray) == 0 { return valueType } @@ -228,7 +217,7 @@ func goTypeToJSDocType(input string, importNamespaces *slicer.StringSlicer) stri } if len(key) > 0 { - return fmt.Sprintf("Record<%s, %s>", key, arrayifyValue(valueArray, value)) + return fmt.Sprintf("{[key: %s]: %s}", key, arrayifyValue(valueArray, value)) } return arrayifyValue(valueArray, value) diff --git a/v2/internal/binding/generate_test.go b/v2/internal/binding/generate_test.go index 26d7c70df..8d6a833b8 100644 --- a/v2/internal/binding/generate_test.go +++ b/v2/internal/binding/generate_test.go @@ -116,28 +116,18 @@ func Test_goTypeToJSDocType(t *testing.T) { { name: "map", input: "map[string]float64", - want: "Record", + want: "{[key: string]: number}", }, { name: "map", input: "map[string]map[string]float64", - want: "Record>", + want: "{[key: string]: {[key: string]: number}}", }, { name: "types", input: "main.SomeType", want: "main.SomeType", }, - { - name: "primitive_generic", - input: "main.ListData[string]", - want: "main.ListData_string_", - }, - { - name: "stdlib_generic", - input: "main.ListData[*net/http.Request]", - want: "main.ListData_net_http_Request_", - }, } var importNamespaces slicer.StringSlicer for _, tt := range tests { diff --git a/v2/internal/binding/reflect.go b/v2/internal/binding/reflect.go index c254d0f0a..57a6335bd 100644 --- a/v2/internal/binding/reflect.go +++ b/v2/internal/binding/reflect.go @@ -24,26 +24,6 @@ func isStruct(value interface{}) bool { return reflect.ValueOf(value).Kind() == reflect.Struct } -func normalizeStructName(name string) string { - return strings.ReplaceAll( - strings.ReplaceAll( - strings.ReplaceAll( - strings.ReplaceAll( - name, - ",", - "-", - ), - "*", - "", - ), - "]", - "__", - ), - "[", - "__", - ) -} - func (b *Bindings) getMethods(value interface{}) ([]*BoundMethod, error) { // Create result placeholder var result []*BoundMethod @@ -67,14 +47,14 @@ func (b *Bindings) getMethods(value interface{}) ([]*BoundMethod, error) { // Process Struct structType := reflect.TypeOf(value) structValue := reflect.ValueOf(value) - structName := structType.Elem().Name() - structNameNormalized := normalizeStructName(structName) - pkgPath := strings.TrimSuffix(structType.Elem().String(), fmt.Sprintf(".%s", structName)) + structTypeString := structType.String() + baseName := structTypeString[1:] // Process Methods for i := 0; i < structType.NumMethod(); i++ { methodDef := structType.Method(i) methodName := methodDef.Name + fullMethodName := baseName + "." + methodName method := structValue.MethodByName(methodName) methodReflectName := runtime.FuncForPC(methodDef.Func.Pointer()).Name() @@ -84,11 +64,7 @@ func (b *Bindings) getMethods(value interface{}) ([]*BoundMethod, error) { // Create new method boundMethod := &BoundMethod{ - Path: &BoundedMethodPath{ - Package: pkgPath, - Struct: structNameNormalized, - Name: methodName, - }, + Name: fullMethodName, Inputs: nil, Outputs: nil, Comments: "", @@ -190,7 +166,7 @@ func getPackageName(in string) string { } func getSplitReturn(in string) (string, string) { - result := strings.SplitN(in, ".", 2) + result := strings.Split(in, ".") return result[0], result[1] } diff --git a/v2/internal/frontend/desktop/darwin/AppDelegate.m b/v2/internal/frontend/desktop/darwin/AppDelegate.m index a73ec3ec3..318c333d8 100644 --- a/v2/internal/frontend/desktop/darwin/AppDelegate.m +++ b/v2/internal/frontend/desktop/darwin/AppDelegate.m @@ -9,7 +9,6 @@ #import #import "AppDelegate.h" -#import "CustomProtocol.h" #import "message.h" @implementation AppDelegate @@ -20,17 +19,6 @@ return YES; } -- (BOOL)application:(NSApplication *)application continueUserActivity:(NSUserActivity *)userActivity restorationHandler:(void (^)(NSArray> * _Nullable))restorationHandler { - if ([userActivity.activityType isEqualToString:NSUserActivityTypeBrowsingWeb]) { - NSURL *url = userActivity.webpageURL; - if (url) { - HandleOpenURL((char*)[[url absoluteString] UTF8String]); - return YES; - } - } - return NO; -} - - (BOOL)applicationShouldTerminateAfterLastWindowClosed:(NSApplication *)sender { return NO; } diff --git a/v2/internal/frontend/desktop/darwin/Application.h b/v2/internal/frontend/desktop/darwin/Application.h index 4d8bbd37b..2582eb6e8 100644 --- a/v2/internal/frontend/desktop/darwin/Application.h +++ b/v2/internal/frontend/desktop/darwin/Application.h @@ -17,7 +17,7 @@ #define WindowStartsMinimised 2 #define WindowStartsFullscreen 3 -WailsContext* Create(const char* title, int width, int height, int frameless, int resizable, int zoomable, int fullscreen, int fullSizeContent, int hideTitleBar, int titlebarAppearsTransparent, int hideTitle, int useToolbar, int hideToolbarSeparator, int webviewIsTransparent, int alwaysOnTop, int hideWindowOnClose, const char *appearance, int windowIsTranslucent, int contentProtection, int devtoolsEnabled, int defaultContextMenuEnabled, int windowStartState, int startsHidden, int minWidth, int minHeight, int maxWidth, int maxHeight, bool fraudulentWebsiteWarningEnabled, struct Preferences preferences, int singleInstanceLockEnabled, const char* singleInstanceUniqueId, bool enableDragAndDrop, bool disableWebViewDragAndDrop); +WailsContext* Create(const char* title, int width, int height, int frameless, int resizable, int zoomable, int fullscreen, int fullSizeContent, int hideTitleBar, int titlebarAppearsTransparent, int hideTitle, int useToolbar, int hideToolbarSeparator, int webviewIsTransparent, int alwaysOnTop, int hideWindowOnClose, const char *appearance, int windowIsTranslucent, int devtoolsEnabled, int defaultContextMenuEnabled, int windowStartState, int startsHidden, int minWidth, int minHeight, int maxWidth, int maxHeight, bool fraudulentWebsiteWarningEnabled, struct Preferences preferences, int singleInstanceEnabled, const char* singleInstanceUniqueId, bool enableDragAndDrop, bool disableWebViewDragAndDrop); void Run(void*, const char* url); void SetTitle(void* ctx, const char *title); diff --git a/v2/internal/frontend/desktop/darwin/Application.m b/v2/internal/frontend/desktop/darwin/Application.m index 38d349c2c..941e6e922 100644 --- a/v2/internal/frontend/desktop/darwin/Application.m +++ b/v2/internal/frontend/desktop/darwin/Application.m @@ -14,7 +14,7 @@ #import "WailsMenu.h" #import "WailsMenuItem.h" -WailsContext* Create(const char* title, int width, int height, int frameless, int resizable, int zoomable, int fullscreen, int fullSizeContent, int hideTitleBar, int titlebarAppearsTransparent, int hideTitle, int useToolbar, int hideToolbarSeparator, int webviewIsTransparent, int alwaysOnTop, int hideWindowOnClose, const char *appearance, int windowIsTranslucent, int contentProtection, int devtoolsEnabled, int defaultContextMenuEnabled, int windowStartState, int startsHidden, int minWidth, int minHeight, int maxWidth, int maxHeight, bool fraudulentWebsiteWarningEnabled, struct Preferences preferences, int singleInstanceLockEnabled, const char* singleInstanceUniqueId, bool enableDragAndDrop, bool disableWebViewDragAndDrop) { +WailsContext* Create(const char* title, int width, int height, int frameless, int resizable, int zoomable, int fullscreen, int fullSizeContent, int hideTitleBar, int titlebarAppearsTransparent, int hideTitle, int useToolbar, int hideToolbarSeparator, int webviewIsTransparent, int alwaysOnTop, int hideWindowOnClose, const char *appearance, int windowIsTranslucent, int devtoolsEnabled, int defaultContextMenuEnabled, int windowStartState, int startsHidden, int minWidth, int minHeight, int maxWidth, int maxHeight, bool fraudulentWebsiteWarningEnabled, struct Preferences preferences, int singleInstanceLockEnabled, const char* singleInstanceUniqueId, bool enableDragAndDrop, bool disableWebViewDragAndDrop) { [NSApplication sharedApplication]; @@ -31,11 +31,6 @@ WailsContext* Create(const char* title, int width, int height, int frameless, in [result SetTitle:safeInit(title)]; [result Center]; - if (contentProtection == 1 && - [result.mainWindow respondsToSelector:@selector(setSharingType:)]) { - [result.mainWindow setSharingType:NSWindowSharingNone]; - } - switch( windowStartState ) { case WindowStartsMaximised: [result.mainWindow zoom:nil]; diff --git a/v2/internal/frontend/desktop/darwin/CustomProtocol.h b/v2/internal/frontend/desktop/darwin/CustomProtocol.h index 0698a4d45..da0e7079f 100644 --- a/v2/internal/frontend/desktop/darwin/CustomProtocol.h +++ b/v2/internal/frontend/desktop/darwin/CustomProtocol.h @@ -3,7 +3,7 @@ #import -extern void HandleOpenURL(char*); +extern void HandleCustomProtocol(char*); @interface CustomProtocolSchemeHandler : NSObject + (void)handleGetURLEvent:(NSAppleEventDescriptor *)event withReplyEvent:(NSAppleEventDescriptor *)replyEvent; diff --git a/v2/internal/frontend/desktop/darwin/CustomProtocol.m b/v2/internal/frontend/desktop/darwin/CustomProtocol.m index ebc61aa00..7365e4f50 100644 --- a/v2/internal/frontend/desktop/darwin/CustomProtocol.m +++ b/v2/internal/frontend/desktop/darwin/CustomProtocol.m @@ -6,7 +6,7 @@ NSString *urlStr = [[event paramDescriptorForKeyword:keyDirectObject] stringValue]; - HandleOpenURL((char*)[[[event paramDescriptorForKeyword:keyDirectObject] stringValue] UTF8String]); + HandleCustomProtocol((char*)[[[event paramDescriptorForKeyword:keyDirectObject] stringValue] UTF8String]); } @end diff --git a/v2/internal/frontend/desktop/darwin/WailsContext.m b/v2/internal/frontend/desktop/darwin/WailsContext.m index 7c9660d54..581a8c138 100644 --- a/v2/internal/frontend/desktop/darwin/WailsContext.m +++ b/v2/internal/frontend/desktop/darwin/WailsContext.m @@ -215,13 +215,7 @@ typedef void (^schemeTaskCaller)(id); // Webview stuff here! WKWebViewConfiguration *config = [WKWebViewConfiguration new]; - // Disable suppressesIncrementalRendering on macOS 26+ to prevent WebView crashes - // during rapid UI updates. See: https://github.com/wailsapp/wails/issues/4592 - if (@available(macOS 26.0, *)) { - config.suppressesIncrementalRendering = false; - } else { - config.suppressesIncrementalRendering = true; - } + config.suppressesIncrementalRendering = true; config.applicationNameForUserAgent = @"wails.io"; [config setURLSchemeHandler:self forURLScheme:@"wails"]; @@ -483,15 +477,6 @@ typedef void (^schemeTaskCaller)(id); } - (void)userContentController:(nonnull WKUserContentController *)userContentController didReceiveScriptMessage:(nonnull WKScriptMessage *)message { - // Get the origin from the message's frame - NSString *origin = nil; - if (message.frameInfo && message.frameInfo.request && message.frameInfo.request.URL) { - NSURL *url = message.frameInfo.request.URL; - if (url.scheme && url.host) { - origin = [url absoluteString]; - } - } - NSString *m = message.body; // Check for drag @@ -506,11 +491,11 @@ typedef void (^schemeTaskCaller)(id); } const char *_m = [m UTF8String]; - const char *_origin = [origin UTF8String]; - processBindingMessage(_m, _origin, message.frameInfo.isMainFrame); + processMessage(_m); } + /***** Dialogs ******/ -(void) MessageDialog :(NSString*)dialogType :(NSString*)title :(NSString*)message :(NSString*)button1 :(NSString*)button2 :(NSString*)button3 :(NSString*)button4 :(NSString*)defaultButton :(NSString*)cancelButton :(void*)iconData :(int)iconDataLength { @@ -609,8 +594,9 @@ typedef void (^schemeTaskCaller)(id); } [dialog setAllowsMultipleSelection: allowMultipleSelection]; + [dialog setShowsHiddenFiles: showHiddenFiles]; + } - [dialog setShowsHiddenFiles: showHiddenFiles]; // Default Directory if( defaultDirectory != nil ) { diff --git a/v2/internal/frontend/desktop/darwin/WailsMenu.m b/v2/internal/frontend/desktop/darwin/WailsMenu.m index 66e5dd399..7e36da99a 100644 --- a/v2/internal/frontend/desktop/darwin/WailsMenu.m +++ b/v2/internal/frontend/desktop/darwin/WailsMenu.m @@ -184,16 +184,16 @@ return unicode(0x001b); } if( [key isEqualToString:@"left"] ) { - return unicode(0x001c); + return unicode(0xf702); } if( [key isEqualToString:@"right"] ) { - return unicode(0x001d); + return unicode(0xf703); } if( [key isEqualToString:@"up"] ) { - return unicode(0x001e); + return unicode(0xf700); } if( [key isEqualToString:@"down"] ) { - return unicode(0x001f); + return unicode(0xf701); } if( [key isEqualToString:@"space"] ) { return unicode(0x0020); diff --git a/v2/internal/frontend/desktop/darwin/browser.go b/v2/internal/frontend/desktop/darwin/browser.go index c865ab6d9..12b2bc8fc 100644 --- a/v2/internal/frontend/desktop/darwin/browser.go +++ b/v2/internal/frontend/desktop/darwin/browser.go @@ -4,19 +4,11 @@ package darwin import ( - "fmt" "github.com/pkg/browser" - "github.com/wailsapp/wails/v2/internal/frontend/utils" ) // BrowserOpenURL Use the default browser to open the url -func (f *Frontend) BrowserOpenURL(rawURL string) { - url, err := utils.ValidateAndSanitizeURL(rawURL) - if err != nil { - f.logger.Error(fmt.Sprintf("Invalid URL %s", err.Error())) - return - } - +func (f *Frontend) BrowserOpenURL(url string) { // Specific method implementation if err := browser.OpenURL(url); err != nil { f.logger.Error("Unable to open default system browser") diff --git a/v2/internal/frontend/desktop/darwin/frontend.go b/v2/internal/frontend/desktop/darwin/frontend.go index 6566445d5..ba00b02d9 100644 --- a/v2/internal/frontend/desktop/darwin/frontend.go +++ b/v2/internal/frontend/desktop/darwin/frontend.go @@ -31,7 +31,6 @@ import ( "github.com/wailsapp/wails/v2/internal/binding" "github.com/wailsapp/wails/v2/internal/frontend" - "github.com/wailsapp/wails/v2/internal/frontend/originvalidator" "github.com/wailsapp/wails/v2/internal/frontend/runtime" "github.com/wailsapp/wails/v2/internal/logger" "github.com/wailsapp/wails/v2/pkg/options" @@ -39,20 +38,13 @@ import ( const startURL = "wails://wails/" -type bindingsMessage struct { - message string - source string - isMainFrame bool -} - var ( - messageBuffer = make(chan string, 100) - bindingsMessageBuffer = make(chan *bindingsMessage, 100) - requestBuffer = make(chan webview.Request, 100) - callbackBuffer = make(chan uint, 10) - openFilepathBuffer = make(chan string, 100) - openUrlBuffer = make(chan string, 100) - secondInstanceBuffer = make(chan options.SecondInstanceData, 1) + messageBuffer = make(chan string, 100) + requestBuffer = make(chan webview.Request, 100) + callbackBuffer = make(chan uint, 10) + openFilepathBuffer = make(chan string, 100) + openUrlBuffer = make(chan string, 100) + secondInstanceBuffer = make(chan options.SecondInstanceData, 1) ) type Frontend struct { @@ -75,8 +67,6 @@ type Frontend struct { mainWindow *Window bindings *binding.Bindings dispatcher frontend.Dispatcher - - originValidator *originvalidator.OriginValidator } func (f *Frontend) RunMainLoop() { @@ -96,18 +86,15 @@ func NewFrontend(ctx context.Context, appoptions *options.App, myLogger *logger. ctx: ctx, } result.startURL, _ = url.Parse(startURL) - result.originValidator = originvalidator.NewOriginValidator(result.startURL, appoptions.BindingsAllowedOrigins) // this should be initialized as early as possible to handle first instance launch C.StartCustomProtocolHandler() if _starturl, _ := ctx.Value("starturl").(*url.URL); _starturl != nil { result.startURL = _starturl - result.originValidator = originvalidator.NewOriginValidator(result.startURL, appoptions.BindingsAllowedOrigins) } else { if port, _ := ctx.Value("assetserverport").(string); port != "" { result.startURL.Host = net.JoinHostPort(result.startURL.Host+".localhost", port) - result.originValidator = originvalidator.NewOriginValidator(result.startURL, appoptions.BindingsAllowedOrigins) } var bindings string @@ -132,7 +119,6 @@ func NewFrontend(ctx context.Context, appoptions *options.App, myLogger *logger. } go result.startMessageProcessor() - go result.startBindingsMessageProcessor() go result.startCallbackProcessor() go result.startFileOpenProcessor() go result.startUrlOpenProcessor() @@ -168,30 +154,6 @@ func (f *Frontend) startMessageProcessor() { } } -func (f *Frontend) startBindingsMessageProcessor() { - for msg := range bindingsMessageBuffer { - // Apple webkit doesn't provide origin of main frame. So we can't verify in case of iFrame that top level origin is allowed. - if !msg.isMainFrame { - f.logger.Error("Blocked request from not main frame") - continue - } - - origin, err := f.originValidator.GetOriginFromURL(msg.source) - if err != nil { - f.logger.Error(fmt.Sprintf("failed to get origin for URL %q: %v", msg.source, err)) - continue - } - - allowed := f.originValidator.IsOriginAllowed(origin) - if !allowed { - f.logger.Error("Blocked request from unauthorized origin: %s", origin) - continue - } - - f.processMessage(msg.message) - } -} - func (f *Frontend) startRequestProcessor() { for request := range requestBuffer { f.assets.ServeWebViewRequest(request) @@ -491,17 +453,6 @@ func processMessage(message *C.char) { messageBuffer <- goMessage } -//export processBindingMessage -func processBindingMessage(message *C.char, source *C.char, fromMainFrame bool) { - goMessage := C.GoString(message) - goSource := C.GoString(source) - bindingsMessageBuffer <- &bindingsMessage{ - message: goMessage, - source: goSource, - isMainFrame: fromMainFrame, - } -} - //export processCallback func processCallback(callbackID uint) { callbackBuffer <- callbackID @@ -518,8 +469,8 @@ func HandleOpenFile(filePath *C.char) { openFilepathBuffer <- goFilepath } -//export HandleOpenURL -func HandleOpenURL(url *C.char) { +//export HandleCustomProtocol +func HandleCustomProtocol(url *C.char) { goUrl := C.GoString(url) openUrlBuffer <- goUrl } diff --git a/v2/internal/frontend/desktop/darwin/message.h b/v2/internal/frontend/desktop/darwin/message.h index 86506f868..66110841d 100644 --- a/v2/internal/frontend/desktop/darwin/message.h +++ b/v2/internal/frontend/desktop/darwin/message.h @@ -15,7 +15,6 @@ extern "C" #endif void processMessage(const char *); -void processBindingMessage(const char *, const char *, bool); void processURLRequest(void *, void*); void processMessageDialogResponse(int); void processOpenFileDialogResponse(const char*); diff --git a/v2/internal/frontend/desktop/darwin/single_instance.go b/v2/internal/frontend/desktop/darwin/single_instance.go index 27b34045b..02a5c78ee 100644 --- a/v2/internal/frontend/desktop/darwin/single_instance.go +++ b/v2/internal/frontend/desktop/darwin/single_instance.go @@ -62,7 +62,7 @@ func HandleSecondInstanceData(secondInstanceMessage *C.char) { } } -// createLockFile tries to create a file with given name and acquire an +// CreateLockFile tries to create a file with given name and acquire an // exclusive lock on it. If the file already exists AND is still locked, it will // fail. func createLockFile(filename string) (*os.File, error) { diff --git a/v2/internal/frontend/desktop/darwin/window.go b/v2/internal/frontend/desktop/darwin/window.go index 87d4213d9..121533a33 100644 --- a/v2/internal/frontend/desktop/darwin/window.go +++ b/v2/internal/frontend/desktop/darwin/window.go @@ -32,8 +32,6 @@ func init() { type Window struct { context unsafe.Pointer - - applicationMenu *menu.Menu } func bool2Cint(value bool) C.int { @@ -63,7 +61,7 @@ func NewWindow(frontendOptions *options.App, debug bool, devtools bool) *Window singleInstanceEnabled := bool2Cint(frontendOptions.SingleInstanceLock != nil) var fullSizeContent, hideTitleBar, zoomable, hideTitle, useToolbar, webviewIsTransparent C.int - var titlebarAppearsTransparent, hideToolbarSeparator, windowIsTranslucent, contentProtection C.int + var titlebarAppearsTransparent, hideToolbarSeparator, windowIsTranslucent C.int var appearance, title *C.char var preferences C.struct_Preferences @@ -117,13 +115,12 @@ func NewWindow(frontendOptions *options.App, debug bool, devtools bool) *Window windowIsTranslucent = bool2Cint(mac.WindowIsTranslucent) webviewIsTransparent = bool2Cint(mac.WebviewIsTransparent) - contentProtection = bool2Cint(mac.ContentProtection) appearance = c.String(string(mac.Appearance)) } var context *C.WailsContext = C.Create(title, width, height, frameless, resizable, zoomable, fullscreen, fullSizeContent, hideTitleBar, titlebarAppearsTransparent, hideTitle, useToolbar, hideToolbarSeparator, webviewIsTransparent, - alwaysOnTop, hideWindowOnClose, appearance, windowIsTranslucent, contentProtection, devtoolsEnabled, defaultContextMenuEnabled, + alwaysOnTop, hideWindowOnClose, appearance, windowIsTranslucent, devtoolsEnabled, defaultContextMenuEnabled, windowStartState, startsHidden, minWidth, minHeight, maxWidth, maxHeight, enableFraudulentWebsiteWarnings, preferences, singleInstanceEnabled, singleInstanceUniqueId, enableDragAndDrop, disableWebViewDragAndDrop, ) @@ -295,16 +292,12 @@ func (w *Window) Size() (int, int) { } func (w *Window) SetApplicationMenu(inMenu *menu.Menu) { - w.applicationMenu = inMenu - w.UpdateApplicationMenu() + mainMenu := NewNSMenu(w.context, "") + processMenu(mainMenu, inMenu) + C.SetAsApplicationMenu(w.context, mainMenu.nsmenu) } func (w *Window) UpdateApplicationMenu() { - mainMenu := NewNSMenu(w.context, "") - if w.applicationMenu != nil { - processMenu(mainMenu, w.applicationMenu) - } - C.SetAsApplicationMenu(w.context, mainMenu.nsmenu) C.UpdateApplicationMenu(w.context) } diff --git a/v2/internal/frontend/desktop/linux/browser.go b/v2/internal/frontend/desktop/linux/browser.go index 962e3b28a..30ca9620c 100644 --- a/v2/internal/frontend/desktop/linux/browser.go +++ b/v2/internal/frontend/desktop/linux/browser.go @@ -3,19 +3,10 @@ package linux -import ( - "fmt" - "github.com/pkg/browser" - "github.com/wailsapp/wails/v2/internal/frontend/utils" -) +import "github.com/pkg/browser" // BrowserOpenURL Use the default browser to open the url -func (f *Frontend) BrowserOpenURL(rawURL string) { - url, err := utils.ValidateAndSanitizeURL(rawURL) - if err != nil { - f.logger.Error(fmt.Sprintf("Invalid URL %s", err.Error())) - return - } +func (f *Frontend) BrowserOpenURL(url string) { // Specific method implementation if err := browser.OpenURL(url); err != nil { f.logger.Error("Unable to open default system browser") diff --git a/v2/internal/frontend/desktop/linux/frontend.go b/v2/internal/frontend/desktop/linux/frontend.go index 2942a112e..3bc81649f 100644 --- a/v2/internal/frontend/desktop/linux/frontend.go +++ b/v2/internal/frontend/desktop/linux/frontend.go @@ -4,7 +4,7 @@ package linux /* -#cgo linux pkg-config: gtk+-3.0 +#cgo linux pkg-config: gtk+-3.0 #cgo !webkit2_41 pkg-config: webkit2gtk-4.0 #cgo webkit2_41 pkg-config: webkit2gtk-4.1 @@ -73,16 +73,6 @@ static void install_signal_handlers() #endif } -static gboolean install_signal_handlers_idle(gpointer data) { - (void)data; - install_signal_handlers(); - return G_SOURCE_REMOVE; -} - -static void fix_signal_handlers_after_gtk_init() { - g_idle_add(install_signal_handlers_idle, NULL); -} - */ import "C" import ( @@ -105,7 +95,6 @@ import ( "github.com/wailsapp/wails/v2/internal/binding" "github.com/wailsapp/wails/v2/internal/frontend" - "github.com/wailsapp/wails/v2/internal/frontend/originvalidator" wailsruntime "github.com/wailsapp/wails/v2/internal/frontend/runtime" "github.com/wailsapp/wails/v2/internal/logger" "github.com/wailsapp/wails/v2/pkg/options" @@ -135,8 +124,6 @@ type Frontend struct { mainWindow *Window bindings *binding.Bindings dispatcher frontend.Dispatcher - - originValidator *originvalidator.OriginValidator } func (f *Frontend) RunMainLoop() { @@ -169,15 +156,12 @@ func NewFrontend(ctx context.Context, appoptions *options.App, myLogger *logger. ctx: ctx, } result.startURL, _ = url.Parse(startURL) - result.originValidator = originvalidator.NewOriginValidator(result.startURL, appoptions.BindingsAllowedOrigins) if _starturl, _ := ctx.Value("starturl").(*url.URL); _starturl != nil { result.startURL = _starturl - result.originValidator = originvalidator.NewOriginValidator(result.startURL, appoptions.BindingsAllowedOrigins) } else { if port, _ := ctx.Value("assetserverport").(string); port != "" { result.startURL.Host = net.JoinHostPort(result.startURL.Host+".localhost", port) - result.originValidator = originvalidator.NewOriginValidator(result.startURL, appoptions.BindingsAllowedOrigins) } var bindings string @@ -200,7 +184,6 @@ func NewFrontend(ctx context.Context, appoptions *options.App, myLogger *logger. } go result.startMessageProcessor() - go result.startBindingsMessageProcessor() var _debug = ctx.Value("debug") var _devtoolsEnabled = ctx.Value("devtoolsEnabled") @@ -214,7 +197,7 @@ func NewFrontend(ctx context.Context, appoptions *options.App, myLogger *logger. result.mainWindow = NewWindow(appoptions, result.debug, result.devtoolsEnabled) - C.fix_signal_handlers_after_gtk_init() + C.install_signal_handlers() if appoptions.Linux != nil && appoptions.Linux.ProgramName != "" { prgname := C.CString(appoptions.Linux.ProgramName) @@ -233,24 +216,6 @@ func (f *Frontend) startMessageProcessor() { } } -func (f *Frontend) startBindingsMessageProcessor() { - for msg := range bindingsMessageBuffer { - origin, err := f.originValidator.GetOriginFromURL(msg.source) - if err != nil { - f.logger.Error(fmt.Sprintf("failed to get origin for URL %q: %v", msg.source, err)) - continue - } - - allowed := f.originValidator.IsOriginAllowed(origin) - if !allowed { - f.logger.Error("Blocked request from unauthorized origin: %s", origin) - continue - } - - f.processMessage(msg.message) - } -} - func (f *Frontend) WindowReload() { f.ExecJS("runtime.WindowReload();") } @@ -542,13 +507,7 @@ func (f *Frontend) ExecJS(js string) { f.mainWindow.ExecJS(js) } -type bindingsMessage struct { - message string - source string -} - var messageBuffer = make(chan string, 100) -var bindingsMessageBuffer = make(chan *bindingsMessage, 100) //export processMessage func processMessage(message *C.char) { @@ -556,16 +515,6 @@ func processMessage(message *C.char) { messageBuffer <- goMessage } -//export processBindingMessage -func processBindingMessage(message *C.char, source *C.char) { - goMessage := C.GoString(message) - goSource := C.GoString(source) - bindingsMessageBuffer <- &bindingsMessage{ - message: goMessage, - source: goSource, - } -} - var requestBuffer = make(chan webview.Request, 100) func (f *Frontend) startRequestProcessor() { diff --git a/v2/internal/frontend/desktop/linux/menu.go b/v2/internal/frontend/desktop/linux/menu.go index a61d190bd..557a24b37 100644 --- a/v2/internal/frontend/desktop/linux/menu.go +++ b/v2/internal/frontend/desktop/linux/menu.go @@ -34,11 +34,8 @@ void addAccelerator(GtkWidget* menuItem, GtkAccelGroup* group, guint key, GdkMod } */ import "C" -import ( - "unsafe" - - "github.com/wailsapp/wails/v2/pkg/menu" -) +import "github.com/wailsapp/wails/v2/pkg/menu" +import "unsafe" var menuIdCounter int var menuItemToId map[*menu.MenuItem]int @@ -84,10 +81,8 @@ func (w *Window) SetApplicationMenu(inmenu *menu.Menu) { func processMenu(window *Window, menu *menu.Menu) { for _, menuItem := range menu.Items { - if menuItem.SubMenu != nil { - submenu := processSubmenu(menuItem, window.accels) - C.gtk_menu_shell_append(C.toGtkMenuShell(unsafe.Pointer(window.menubar)), submenu) - } + submenu := processSubmenu(menuItem, window.accels) + C.gtk_menu_shell_append(C.toGtkMenuShell(unsafe.Pointer(window.menubar)), submenu) } } diff --git a/v2/internal/frontend/desktop/linux/window.c b/v2/internal/frontend/desktop/linux/window.c index 5441db022..0dee24f42 100644 --- a/v2/internal/frontend/desktop/linux/window.c +++ b/v2/internal/frontend/desktop/linux/window.c @@ -14,9 +14,6 @@ static float xroot = 0.0f; static float yroot = 0.0f; static int dragTime = -1; static uint mouseButton = 0; -static int wmIsWayland = -1; -static int decoratorWidth = -1; -static int decoratorHeight = -1; // casts void ExecuteOnMainThread(void *f, gpointer jscallback) @@ -45,17 +42,11 @@ GtkBox *GTKBOX(void *pointer) } extern void processMessage(char *); -extern void processBindingMessage(char *, char *); static void sendMessageToBackend(WebKitUserContentManager *contentManager, WebKitJavascriptResult *result, void *data) { - // Retrieve webview from content manager - WebKitWebView *webview = WEBKIT_WEB_VIEW(g_object_get_data(G_OBJECT(contentManager), "webview")); - const char *current_uri = webview ? webkit_web_view_get_uri(webview) : NULL; - char *uri = current_uri ? g_strdup(current_uri) : NULL; - #if WEBKIT_MAJOR_VERSION >= 2 && WEBKIT_MINOR_VERSION >= 22 JSCValue *value = webkit_javascript_result_get_js_value(result); char *message = jsc_value_to_string(value); @@ -68,11 +59,8 @@ static void sendMessageToBackend(WebKitUserContentManager *contentManager, JSStringGetUTF8CString(js, message, messageSize); JSStringRelease(js); #endif - processBindingMessage(message, uri); + processMessage(message); g_free(message); - if (uri) { - g_free(uri); - } } static bool isNULLRectangle(GdkRectangle input) @@ -80,29 +68,6 @@ static bool isNULLRectangle(GdkRectangle input) return input.x == -1 && input.y == -1 && input.width == -1 && input.height == -1; } -static gboolean onWayland() -{ - switch (wmIsWayland) - { - case -1: - { - char *gdkBackend = getenv("XDG_SESSION_TYPE"); - if(gdkBackend != NULL && strcmp(gdkBackend, "wayland") == 0) - { - wmIsWayland = 1; - return TRUE; - } - - wmIsWayland = 0; - return FALSE; - } - case 1: - return TRUE; - default: - return FALSE; - } -} - static GdkMonitor *getCurrentMonitor(GtkWindow *window) { // Get the monitor that the window is currently on @@ -273,34 +238,11 @@ void SetMinMaxSize(GtkWindow *window, int min_width, int min_height, int max_wid { return; } - int flags = GDK_HINT_MAX_SIZE | GDK_HINT_MIN_SIZE; - size.max_height = (max_height == 0 ? monitorSize.height : max_height); size.max_width = (max_width == 0 ? monitorSize.width : max_width); size.min_height = min_height; size.min_width = min_width; - - // On Wayland window manager get the decorators and calculate the differences from the windows' size. - if(onWayland()) - { - if(decoratorWidth == -1 && decoratorHeight == -1) - { - int windowWidth, windowHeight; - gtk_window_get_size(window, &windowWidth, &windowHeight); - - GtkAllocation windowAllocation; - gtk_widget_get_allocation(GTK_WIDGET(window), &windowAllocation); - - decoratorWidth = (windowAllocation.width-windowWidth); - decoratorHeight = (windowAllocation.height-windowHeight); - } - - // Add the decorator difference to the window so fullscreen and maximise can fill the window. - size.max_height = decoratorHeight+size.max_height; - size.max_width = decoratorWidth+size.max_width; - } - gtk_window_set_geometry_hints(window, NULL, &size, flags); } @@ -558,9 +500,6 @@ static gboolean onDragDrop(GtkWidget* self, GdkDragContext* context, gint x, gin GtkWidget *SetupWebview(void *contentManager, GtkWindow *window, int hideWindowOnClose, int gpuPolicy, int disableWebViewDragAndDrop, int enableDragAndDrop) { GtkWidget *webview = webkit_web_view_new_with_user_content_manager((WebKitUserContentManager *)contentManager); - - // Store webview reference in the content manager - g_object_set_data(G_OBJECT((WebKitUserContentManager *)contentManager), "webview", webview); // gtk_container_add(GTK_CONTAINER(window), webview); WebKitWebContext *context = webkit_web_context_get_default(); webkit_web_context_register_uri_scheme(context, "wails", (WebKitURISchemeRequestCallback)processURLRequest, NULL, NULL); @@ -888,4 +827,4 @@ void InstallF12Hotkey(void *window) gtk_window_add_accel_group(GTK_WINDOW(window), accel_group); GClosure *closure = g_cclosure_new(G_CALLBACK(sendShowInspectorMessage), window, NULL); gtk_accel_group_connect(accel_group, GDK_KEY_F12, GDK_CONTROL_MASK | GDK_SHIFT_MASK, GTK_ACCEL_VISIBLE, closure); -} +} \ No newline at end of file diff --git a/v2/internal/frontend/desktop/windows/browser.go b/v2/internal/frontend/desktop/windows/browser.go index 13d037b14..2b058feda 100644 --- a/v2/internal/frontend/desktop/windows/browser.go +++ b/v2/internal/frontend/desktop/windows/browser.go @@ -4,9 +4,7 @@ package windows import ( - "fmt" "github.com/pkg/browser" - "github.com/wailsapp/wails/v2/internal/frontend/utils" "golang.org/x/sys/windows" ) @@ -18,15 +16,9 @@ var fallbackBrowserPaths = []string{ } // BrowserOpenURL Use the default browser to open the url -func (f *Frontend) BrowserOpenURL(rawURL string) { - url, err := utils.ValidateAndSanitizeURL(rawURL) - if err != nil { - f.logger.Error(fmt.Sprintf("Invalid URL %s", err.Error())) - return - } - +func (f *Frontend) BrowserOpenURL(url string) { // Specific method implementation - err = browser.OpenURL(url) + err := browser.OpenURL(url) if err == nil { return } diff --git a/v2/internal/frontend/desktop/windows/frontend.go b/v2/internal/frontend/desktop/windows/frontend.go index 5df13ed98..71e90e8e5 100644 --- a/v2/internal/frontend/desktop/windows/frontend.go +++ b/v2/internal/frontend/desktop/windows/frontend.go @@ -25,16 +25,13 @@ import ( "github.com/wailsapp/wails/v2/internal/frontend/desktop/windows/win32" "github.com/wailsapp/wails/v2/internal/frontend/desktop/windows/winc" "github.com/wailsapp/wails/v2/internal/frontend/desktop/windows/winc/w32" - "github.com/wailsapp/wails/v2/internal/frontend/originvalidator" wailsruntime "github.com/wailsapp/wails/v2/internal/frontend/runtime" "github.com/wailsapp/wails/v2/internal/logger" - w32consts "github.com/wailsapp/wails/v2/internal/platform/win32" "github.com/wailsapp/wails/v2/internal/system/operatingsystem" "github.com/wailsapp/wails/v2/pkg/assetserver" "github.com/wailsapp/wails/v2/pkg/assetserver/webview" "github.com/wailsapp/wails/v2/pkg/options" "github.com/wailsapp/wails/v2/pkg/options/windows" - w "golang.org/x/sys/windows" ) const startURL = "http://wails.localhost/" @@ -65,8 +62,6 @@ type Frontend struct { hasStarted bool - originValidator *originvalidator.OriginValidator - // Windows build number versionInfo *operatingsystem.WindowsVersionInfo resizeDebouncer func(f func()) @@ -77,13 +72,6 @@ func NewFrontend(ctx context.Context, appoptions *options.App, myLogger *logger. // Get Windows build number versionInfo, _ := operatingsystem.GetWindowsVersionInfo() - // Apply DLL search path settings if specified - if appoptions.Windows != nil && appoptions.Windows.DLLSearchPaths != 0 { - w.SetDefaultDllDirectories(appoptions.Windows.DLLSearchPaths) - } - // Now initialize packages that load DLLs - w32.Init() - w32consts.Init() result := &Frontend{ frontendOptions: appoptions, logger: myLogger, @@ -101,17 +89,14 @@ func NewFrontend(ctx context.Context, appoptions *options.App, myLogger *logger. // We currently can't use wails://wails/ as other platforms do, therefore we map the assets sever onto the following url. result.startURL, _ = url.Parse(startURL) - result.originValidator = originvalidator.NewOriginValidator(result.startURL, appoptions.BindingsAllowedOrigins) if _starturl, _ := ctx.Value("starturl").(*url.URL); _starturl != nil { result.startURL = _starturl - result.originValidator = originvalidator.NewOriginValidator(result.startURL, appoptions.BindingsAllowedOrigins) return result } if port, _ := ctx.Value("assetserverport").(string); port != "" { result.startURL.Host = net.JoinHostPort(result.startURL.Host, port) - result.originValidator = originvalidator.NewOriginValidator(result.startURL, appoptions.BindingsAllowedOrigins) } var bindings string @@ -185,21 +170,10 @@ func (f *Frontend) Run(ctx context.Context) error { // depends on the content in the WebView, see https://github.com/wailsapp/wails/issues/1319 event, _ := arg.Data.(*winc.SizeEventData) if event != nil && event.Type == w32.SIZE_MINIMIZED { - // Set minimizing flag to prevent unnecessary redraws during minimize/restore for frameless windows - // 设置最小化标志以防止无边框窗口在最小化/恢复过程中的不必要重绘 - // This fixes window flickering when minimizing/restoring frameless windows - // 这修复了无边框窗口在最小化/恢复时的闪烁问题 - // Reference: https://github.com/wailsapp/wails/issues/3951 - f.mainWindow.isMinimizing = true return } } - // Clear minimizing flag for all non-minimize size events - // 对于所有非最小化的尺寸变化事件,清除最小化标志 - // Reference: https://github.com/wailsapp/wails/issues/3951 - f.mainWindow.isMinimizing = false - if f.resizeDebouncer != nil { f.resizeDebouncer(func() { f.mainWindow.Invoke(func() { @@ -695,24 +669,7 @@ var edgeMap = map[string]uintptr{ "nw-resize": w32.HTTOPLEFT, } -func (f *Frontend) processMessage(message string, sender *edge.ICoreWebView2, args *edge.ICoreWebView2WebMessageReceivedEventArgs) { - topSource, err := sender.GetSource() - if err != nil { - f.logger.Error(fmt.Sprintf("Unable to get source from sender: %s", err.Error())) - return - } - - senderSource, err := args.GetSource() - if err != nil { - f.logger.Error(fmt.Sprintf("Unable to get source from args: %s", err.Error())) - return - } - - // verify both topSource and sender are allowed origins - if !f.validBindingOrigin(topSource) || !f.validBindingOrigin(senderSource) { - return - } - +func (f *Frontend) processMessage(message string) { if message == "drag" { if !f.mainWindow.IsFullScreen() { err := f.startDrag() @@ -757,23 +714,6 @@ func (f *Frontend) processMessage(message string, sender *edge.ICoreWebView2, ar } func (f *Frontend) processMessageWithAdditionalObjects(message string, sender *edge.ICoreWebView2, args *edge.ICoreWebView2WebMessageReceivedEventArgs) { - topSource, err := sender.GetSource() - if err != nil { - f.logger.Error(fmt.Sprintf("Unable to get source from sender: %s", err.Error())) - return - } - - senderSource, err := args.GetSource() - if err != nil { - f.logger.Error(fmt.Sprintf("Unable to get source from args: %s", err.Error())) - return - } - - // verify both topSource and sender are allowed origins - if !f.validBindingOrigin(topSource) || !f.validBindingOrigin(senderSource) { - return - } - if strings.HasPrefix(message, "file:drop") { if !f.frontendOptions.DragAndDrop.EnableFileDrop { return @@ -800,11 +740,6 @@ func (f *Frontend) processMessageWithAdditionalObjects(message string, sender *e return } - if _file == nil { - f.logger.Warning("object at %d is not a file", i) - continue - } - file := (*edge.ICoreWebView2File)(unsafe.Pointer(_file)) defer file.Release() @@ -832,20 +767,6 @@ func (f *Frontend) processMessageWithAdditionalObjects(message string, sender *e } } -func (f *Frontend) validBindingOrigin(source string) bool { - origin, err := f.originValidator.GetOriginFromURL(source) - if err != nil { - f.logger.Error(fmt.Sprintf("Error parsing source URL %s: %v", source, err.Error())) - return false - } - allowed := f.originValidator.IsOriginAllowed(origin) - if !allowed { - f.logger.Error("Blocked request from unauthorized origin: %s", origin) - return false - } - return true -} - func (f *Frontend) dispatchMessage(message string) { result, err := f.dispatcher.ProcessMessage(message, f) if err != nil { diff --git a/v2/internal/frontend/desktop/windows/winc/controlbase.go b/v2/internal/frontend/desktop/windows/winc/controlbase.go index cdb29518c..086609aed 100644 --- a/v2/internal/frontend/desktop/windows/winc/controlbase.go +++ b/v2/internal/frontend/desktop/windows/winc/controlbase.go @@ -65,7 +65,7 @@ type ControlBase struct { dispatchq []func() } -// InitControl is called by controls: edit, button, treeview, listview, and so on. +// initControl is called by controls: edit, button, treeview, listview, and so on. func (cba *ControlBase) InitControl(className string, parent Controller, exstyle, style uint) { cba.hwnd = CreateWindow(className, parent, exstyle, style) if cba.hwnd == 0 { @@ -170,14 +170,6 @@ func (cba *ControlBase) SetTranslucentBackground() { w32.SetWindowCompositionAttribute(cba.hwnd, &data) } -func (cba *ControlBase) SetContentProtection(enable bool) { - if enable { - w32.SetWindowDisplayAffinity(uintptr(cba.hwnd), w32.WDA_EXCLUDEFROMCAPTURE) - } else { - w32.SetWindowDisplayAffinity(uintptr(cba.hwnd), w32.WDA_NONE) - } -} - func min(a, b int) int { if a < b { return a diff --git a/v2/internal/frontend/desktop/windows/winc/form.go b/v2/internal/frontend/desktop/windows/winc/form.go index c9acf7278..8a42d63f3 100644 --- a/v2/internal/frontend/desktop/windows/winc/form.go +++ b/v2/internal/frontend/desktop/windows/winc/form.go @@ -145,7 +145,7 @@ func (fm *Form) Restore() { SC_RESTORE, 0, ) - w32.ShowWindow(fm.hwnd, w32.SW_SHOW) + w32.ShowWindow(fm.hwnd, w32.SW_RESTORE) } // Public methods diff --git a/v2/internal/frontend/desktop/windows/winc/w32/user32.go b/v2/internal/frontend/desktop/windows/winc/w32/user32.go index 707701f5e..89ff985af 100644 --- a/v2/internal/frontend/desktop/windows/winc/w32/user32.go +++ b/v2/internal/frontend/desktop/windows/winc/w32/user32.go @@ -792,9 +792,11 @@ func CreateMenu() HMENU { } func SetMenu(hWnd HWND, hMenu HMENU) bool { - ret, _, _ := syscall.SyscallN(setMenu, + ret, _, _ := syscall.Syscall(setMenu, 2, uintptr(hWnd), - uintptr(hMenu)) + uintptr(hMenu), + 0) + return ret != 0 } @@ -832,7 +834,11 @@ func TrackPopupMenuEx(hMenu HMENU, fuFlags uint32, x, y int32, hWnd HWND, lptpm } func DrawMenuBar(hWnd HWND) bool { - ret, _, _ := syscall.SyscallN(drawMenuBar, hWnd) + ret, _, _ := syscall.Syscall(drawMenuBar, 1, + uintptr(hWnd), + 0, + 0) + return ret != 0 } @@ -1225,8 +1231,11 @@ func CallNextHookEx(hhk HHOOK, nCode int, wParam WPARAM, lParam LPARAM) LRESULT } func GetKeyState(nVirtKey int32) int16 { - ret, _, _ := syscall.SyscallN(getKeyState, - uintptr(nVirtKey)) + ret, _, _ := syscall.Syscall(getKeyState, 1, + uintptr(nVirtKey), + 0, + 0) + return int16(ret) } @@ -1240,15 +1249,17 @@ func DestroyMenu(hMenu HMENU) bool { } func GetWindowPlacement(hWnd HWND, lpwndpl *WINDOWPLACEMENT) bool { - ret, _, _ := syscall.SyscallN(getWindowPlacement, - hWnd, - uintptr(unsafe.Pointer(lpwndpl))) + ret, _, _ := syscall.Syscall(getWindowPlacement, 2, + uintptr(hWnd), + uintptr(unsafe.Pointer(lpwndpl)), + 0) + return ret != 0 } func SetWindowPlacement(hWnd HWND, lpwndpl *WINDOWPLACEMENT) bool { - ret, _, _ := syscall.SyscallN(setWindowPlacement, - hWnd, + ret, _, _ := syscall.Syscall(setWindowPlacement, 2, + uintptr(hWnd), uintptr(unsafe.Pointer(lpwndpl)), 0) @@ -1268,7 +1279,7 @@ func SetScrollInfo(hwnd HWND, fnBar int32, lpsi *SCROLLINFO, fRedraw bool) int32 } func GetScrollInfo(hwnd HWND, fnBar int32, lpsi *SCROLLINFO) bool { - ret, _, _ := syscall.SyscallN(getScrollInfo, + ret, _, _ := syscall.Syscall(getScrollInfo, 3, hwnd, uintptr(fnBar), uintptr(unsafe.Pointer(lpsi))) diff --git a/v2/internal/frontend/desktop/windows/winc/w32/utils.go b/v2/internal/frontend/desktop/windows/winc/w32/utils.go index 4568b4849..8a72d4846 100644 --- a/v2/internal/frontend/desktop/windows/winc/w32/utils.go +++ b/v2/internal/frontend/desktop/windows/winc/w32/utils.go @@ -75,7 +75,7 @@ func UTF16PtrToString(cstr *uint16) string { } func ComAddRef(unknown *IUnknown) int32 { - ret, _, _ := syscall.SyscallN(unknown.lpVtbl.pAddRef, + ret, _, _ := syscall.Syscall(unknown.lpVtbl.pAddRef, 1, uintptr(unsafe.Pointer(unknown)), 0, 0) @@ -83,7 +83,7 @@ func ComAddRef(unknown *IUnknown) int32 { } func ComRelease(unknown *IUnknown) int32 { - ret, _, _ := syscall.SyscallN(unknown.lpVtbl.pRelease, + ret, _, _ := syscall.Syscall(unknown.lpVtbl.pRelease, 1, uintptr(unsafe.Pointer(unknown)), 0, 0) @@ -92,7 +92,7 @@ func ComRelease(unknown *IUnknown) int32 { func ComQueryInterface(unknown *IUnknown, id *GUID) *IDispatch { var disp *IDispatch - hr, _, _ := syscall.SyscallN(unknown.lpVtbl.pQueryInterface, + hr, _, _ := syscall.Syscall(unknown.lpVtbl.pQueryInterface, 3, uintptr(unsafe.Pointer(unknown)), uintptr(unsafe.Pointer(id)), uintptr(unsafe.Pointer(&disp))) diff --git a/v2/internal/frontend/desktop/windows/winc/w32/uxtheme.go b/v2/internal/frontend/desktop/windows/winc/w32/uxtheme.go index 8a14f0cb7..51ec0035f 100644 --- a/v2/internal/frontend/desktop/windows/winc/w32/uxtheme.go +++ b/v2/internal/frontend/desktop/windows/winc/w32/uxtheme.go @@ -69,7 +69,7 @@ var ( setWindowTheme uintptr ) -func Init() { +func init() { // Library libuxtheme = MustLoadLibrary("uxtheme.dll") @@ -83,7 +83,7 @@ func Init() { } func CloseThemeData(hTheme HTHEME) HRESULT { - ret, _, _ := syscall.SyscallN(closeThemeData, + ret, _, _ := syscall.Syscall(closeThemeData, 1, uintptr(hTheme), 0, 0) @@ -134,7 +134,7 @@ func GetThemeTextExtent(hTheme HTHEME, hdc HDC, iPartId, iStateId int32, pszText } func OpenThemeData(hwnd HWND, pszClassList *uint16) HTHEME { - ret, _, _ := syscall.SyscallN(openThemeData, + ret, _, _ := syscall.Syscall(openThemeData, 2, uintptr(hwnd), uintptr(unsafe.Pointer(pszClassList)), 0) @@ -143,7 +143,7 @@ func OpenThemeData(hwnd HWND, pszClassList *uint16) HTHEME { } func SetWindowTheme(hwnd HWND, pszSubAppName, pszSubIdList *uint16) HRESULT { - ret, _, _ := syscall.SyscallN(setWindowTheme, + ret, _, _ := syscall.Syscall(setWindowTheme, 3, uintptr(hwnd), uintptr(unsafe.Pointer(pszSubAppName)), uintptr(unsafe.Pointer(pszSubIdList))) diff --git a/v2/internal/frontend/desktop/windows/winc/w32/wda.go b/v2/internal/frontend/desktop/windows/winc/w32/wda.go deleted file mode 100644 index 3925f2805..000000000 --- a/v2/internal/frontend/desktop/windows/winc/w32/wda.go +++ /dev/null @@ -1,47 +0,0 @@ -//go:build windows - -package w32 - -import ( - "syscall" - - "github.com/wailsapp/wails/v2/internal/system/operatingsystem" -) - -var user32 = syscall.NewLazyDLL("user32.dll") -var procSetWindowDisplayAffinity = user32.NewProc("SetWindowDisplayAffinity") -var windowsVersion, _ = operatingsystem.GetWindowsVersionInfo() - -const ( - WDA_NONE = 0x00000000 - WDA_MONITOR = 0x00000001 - WDA_EXCLUDEFROMCAPTURE = 0x00000011 // windows 10 2004+ -) - -func isWindowsVersionAtLeast(major, minor, build int) bool { - if windowsVersion.Major > major { - return true - } - if windowsVersion.Major < major { - return false - } - if windowsVersion.Minor > minor { - return true - } - if windowsVersion.Minor < minor { - return false - } - return windowsVersion.Build >= build -} - -func SetWindowDisplayAffinity(hwnd uintptr, affinity uint32) bool { - if affinity == WDA_EXCLUDEFROMCAPTURE && !isWindowsVersionAtLeast(10, 0, 19041) { - // for older windows versions, use WDA_MONITOR - affinity = WDA_MONITOR - } - ret, _, _ := procSetWindowDisplayAffinity.Call( - hwnd, - uintptr(affinity), - ) - return ret != 0 -} diff --git a/v2/internal/frontend/desktop/windows/window.go b/v2/internal/frontend/desktop/windows/window.go index b04d61814..a513e875a 100644 --- a/v2/internal/frontend/desktop/windows/window.go +++ b/v2/internal/frontend/desktop/windows/window.go @@ -3,11 +3,10 @@ package windows import ( + "github.com/wailsapp/go-webview2/pkg/edge" "sync" "unsafe" - "github.com/wailsapp/go-webview2/pkg/edge" - "github.com/wailsapp/wails/v2/internal/frontend/desktop/windows/win32" "github.com/wailsapp/wails/v2/internal/system/operatingsystem" @@ -38,13 +37,6 @@ type Window struct { OnResume func() chromium *edge.Chromium - - // isMinimizing indicates whether the window is currently being minimized - // 标识窗口是否处于最小化状态,用于解决最小化/恢复时的闪屏问题 - // This flag is used to prevent unnecessary redraws during minimize/restore transitions for frameless windows - // 此标志用于防止无边框窗口在最小化/恢复过程中的不必要重绘 - // Reference: https://github.com/wailsapp/wails/issues/3951 - isMinimizing bool } func NewWindow(parent winc.Controller, appoptions *options.App, versionInfo *operatingsystem.WindowsVersionInfo, chromium *edge.Chromium) *Window { @@ -78,13 +70,8 @@ func NewWindow(parent winc.Controller, appoptions *options.App, versionInfo *ope var dwStyle = w32.WS_OVERLAPPEDWINDOW - windowClassName := "wailsWindow" - if windowsOptions != nil && windowsOptions.WindowClassName != "" { - windowClassName = windowsOptions.WindowClassName - } - - winc.RegClassOnlyOnce(windowClassName) - handle := winc.CreateWindow(windowClassName, parent, uint(exStyle), uint(dwStyle)) + winc.RegClassOnlyOnce("wailsWindow") + handle := winc.CreateWindow("wailsWindow", parent, uint(exStyle), uint(dwStyle)) result.SetHandle(handle) winc.RegMsgHandler(result) result.SetParent(parent) @@ -131,10 +118,6 @@ func NewWindow(parent winc.Controller, appoptions *options.App, versionInfo *ope } } - if windowsOptions.ContentProtection { - w32.SetWindowDisplayAffinity(result.Handle(), w32.WDA_EXCLUDEFROMCAPTURE) - } - if windowsOptions.DisableWindowIcon { result.DisableIcon() } @@ -268,7 +251,7 @@ func (w *Window) WndProc(msg uint32, wparam, lparam uintptr) uintptr { rgrc := (*w32.RECT)(unsafe.Pointer(lparam)) if w.Form.IsFullScreen() { // In Full-Screen mode we don't need to adjust anything - w.SetPadding(edge.Rect{}) + w.chromium.SetPadding(edge.Rect{}) } else if w.IsMaximised() { // If the window is maximized we must adjust the client area to the work area of the monitor. Otherwise // some content goes beyond the visible part of the monitor. @@ -299,7 +282,7 @@ func (w *Window) WndProc(msg uint32, wparam, lparam uintptr) uintptr { } } } - w.SetPadding(edge.Rect{}) + w.chromium.SetPadding(edge.Rect{}) } else { // This is needed to workaround the resize flickering in frameless mode with WindowDecorations // See: https://stackoverflow.com/a/6558508 @@ -308,7 +291,7 @@ func (w *Window) WndProc(msg uint32, wparam, lparam uintptr) uintptr { // Increasing the bottom also worksaround the flickering but we would loose 1px of the WebView content // therefore let's pad the content with 1px at the bottom. rgrc.Bottom += 1 - w.SetPadding(edge.Rect{Bottom: 1}) + w.chromium.SetPadding(edge.Rect{Bottom: 1}) } return 0 } @@ -351,17 +334,3 @@ func invokeSync[T any](cba *Window, fn func() (T, error)) (res T, err error) { wg.Wait() return res, err } - -// SetPadding is a filter that wraps chromium.SetPadding to prevent unnecessary redraws during minimize/restore -// 包装了chromium.SetPadding的过滤器,用于防止窗口最小化/恢复过程中的不必要重绘 -// This fixes window flickering when minimizing/restoring frameless windows -// 这修复了无边框窗口在最小化/恢复时的闪烁问题 -// Reference: https://github.com/wailsapp/wails/issues/3951 -func (w *Window) SetPadding(padding edge.Rect) { - // Skip SetPadding if window is being minimized to prevent flickering - // 如果窗口正在最小化,跳过设置padding以防止闪烁 - if w.isMinimizing { - return - } - w.chromium.SetPadding(padding) -} diff --git a/v2/internal/frontend/devserver/devserver.go b/v2/internal/frontend/devserver/devserver.go index 8a130890d..3d623ed6d 100644 --- a/v2/internal/frontend/devserver/devserver.go +++ b/v2/internal/frontend/devserver/devserver.go @@ -20,23 +20,17 @@ import ( "github.com/wailsapp/wails/v2/internal/frontend/runtime" - "github.com/gorilla/websocket" "github.com/labstack/echo/v4" "github.com/wailsapp/wails/v2/internal/binding" "github.com/wailsapp/wails/v2/internal/frontend" "github.com/wailsapp/wails/v2/internal/logger" "github.com/wailsapp/wails/v2/internal/menumanager" "github.com/wailsapp/wails/v2/pkg/options" + "golang.org/x/net/websocket" ) type Screen = frontend.Screen -var upgrader = websocket.Upgrader{ - ReadBufferSize: 1024, - WriteBufferSize: 1024, - CheckOrigin: func(r *http.Request) bool { return true }, -} - type DevWebServer struct { server *echo.Echo ctx context.Context @@ -161,64 +155,51 @@ func (d *DevWebServer) handleReloadApp(c echo.Context) error { } func (d *DevWebServer) handleIPCWebSocket(c echo.Context) error { - conn, err := upgrader.Upgrade(c.Response(), c.Request(), nil) - if err != nil { - d.logger.Error("WebSocket upgrade failed %v", err) - return err - } - d.LogDebug(fmt.Sprintf("WebSocket client %p connected", conn)) - - d.socketMutex.Lock() - d.websocketClients[conn] = &sync.Mutex{} - locker := d.websocketClients[conn] - d.socketMutex.Unlock() - - var wg sync.WaitGroup - - defer func() { - wg.Wait() + websocket.Handler(func(c *websocket.Conn) { + d.LogDebug(fmt.Sprintf("Websocket client %p connected", c)) d.socketMutex.Lock() - delete(d.websocketClients, conn) + d.websocketClients[c] = &sync.Mutex{} + locker := d.websocketClients[c] d.socketMutex.Unlock() - d.LogDebug(fmt.Sprintf("WebSocket client %p disconnected", conn)) - conn.Close() - }() - for { - _, msgBytes, err := conn.ReadMessage() - if err != nil { - break - } + defer func() { + d.socketMutex.Lock() + delete(d.websocketClients, c) + d.socketMutex.Unlock() + d.LogDebug(fmt.Sprintf("Websocket client %p disconnected", c)) + }() - msg := string(msgBytes) - wg.Add(1) - - go func(m string) { - defer wg.Done() - - if m == "drag" { - return + var msg string + defer c.Close() + for { + if err := websocket.Message.Receive(c, &msg); err != nil { + break + } + // We do not support drag in browsers + if msg == "drag" { + continue } - if len(m) > 2 && strings.HasPrefix(m, "EE") { - d.notifyExcludingSender([]byte(m), conn) + // Notify the other browsers of "EventEmit" + if len(msg) > 2 && strings.HasPrefix(string(msg), "EE") { + d.notifyExcludingSender([]byte(msg), c) } - result, err := d.dispatcher.ProcessMessage(m, d) + // Send the message to dispatch to the frontend + result, err := d.dispatcher.ProcessMessage(string(msg), d) if err != nil { d.logger.Error(err.Error()) } - if result != "" { locker.Lock() - defer locker.Unlock() - if err := conn.WriteMessage(websocket.TextMessage, []byte(result)); err != nil { - d.logger.Error("Websocket write message failed %v", err) + if err = websocket.Message.Send(c, result); err != nil { + locker.Unlock() + break } + locker.Unlock() } - }(msg) - } - + } + }).ServeHTTP(c.Response(), c.Request()) return nil } @@ -241,7 +222,7 @@ func (d *DevWebServer) broadcast(message string) { return } locker.Lock() - err := client.WriteMessage(websocket.TextMessage, []byte(message)) + err := websocket.Message.Send(client, message) if err != nil { locker.Unlock() d.logger.Error(err.Error()) @@ -275,7 +256,7 @@ func (d *DevWebServer) broadcastExcludingSender(message string, sender *websocke return } locker.Lock() - err := client.WriteMessage(websocket.TextMessage, []byte(message)) + err := websocket.Message.Send(client, message) if err != nil { locker.Unlock() d.logger.Error(err.Error()) diff --git a/v2/internal/frontend/dispatcher/dispatcher.go b/v2/internal/frontend/dispatcher/dispatcher.go index 24a43cfef..97d9b32e9 100644 --- a/v2/internal/frontend/dispatcher/dispatcher.go +++ b/v2/internal/frontend/dispatcher/dispatcher.go @@ -2,7 +2,6 @@ package dispatcher import ( "context" - "fmt" "github.com/pkg/errors" "github.com/wailsapp/wails/v2/internal/binding" "github.com/wailsapp/wails/v2/internal/frontend" @@ -11,43 +10,26 @@ import ( ) type Dispatcher struct { - log *logger.Logger - bindings *binding.Bindings - events frontend.Events - bindingsDB *binding.DB - ctx context.Context - errfmt options.ErrorFormatter - disablePanicRecovery bool + log *logger.Logger + bindings *binding.Bindings + events frontend.Events + bindingsDB *binding.DB + ctx context.Context + errfmt options.ErrorFormatter } -func NewDispatcher(ctx context.Context, log *logger.Logger, bindings *binding.Bindings, events frontend.Events, errfmt options.ErrorFormatter, disablePanicRecovery bool) *Dispatcher { +func NewDispatcher(ctx context.Context, log *logger.Logger, bindings *binding.Bindings, events frontend.Events, errfmt options.ErrorFormatter) *Dispatcher { return &Dispatcher{ - log: log, - bindings: bindings, - events: events, - bindingsDB: bindings.DB(), - ctx: ctx, - errfmt: errfmt, - disablePanicRecovery: disablePanicRecovery, + log: log, + bindings: bindings, + events: events, + bindingsDB: bindings.DB(), + ctx: ctx, + errfmt: errfmt, } } -func (d *Dispatcher) ProcessMessage(message string, sender frontend.Frontend) (_ string, err error) { - if !d.disablePanicRecovery { - defer func() { - if e := recover(); e != nil { - if errPanic, ok := e.(error); ok { - err = errPanic - } else { - err = fmt.Errorf("%v", e) - } - } - if err != nil { - d.log.Error("process message error: %s -> %s", message, err) - } - }() - } - +func (d *Dispatcher) ProcessMessage(message string, sender frontend.Frontend) (string, error) { if message == "" { return "", errors.New("No message to process") } diff --git a/v2/internal/frontend/originvalidator/originValidator.go b/v2/internal/frontend/originvalidator/originValidator.go deleted file mode 100644 index fd416f945..000000000 --- a/v2/internal/frontend/originvalidator/originValidator.go +++ /dev/null @@ -1,116 +0,0 @@ -package originvalidator - -import ( - "fmt" - "net/url" - "regexp" - "strings" -) - -type OriginValidator struct { - allowedOrigins []string -} - -// NewOriginValidator creates a new validator from a comma-separated string of allowed origins -func NewOriginValidator(startUrl *url.URL, allowedOriginsString string) *OriginValidator { - allowedOrigins := startUrl.Scheme + "://" + startUrl.Host - if allowedOriginsString != "" { - allowedOrigins += "," + allowedOriginsString - } - validator := &OriginValidator{} - validator.parseAllowedOrigins(allowedOrigins) - return validator -} - -// parseAllowedOrigins parses the comma-separated origins string -func (v *OriginValidator) parseAllowedOrigins(originsString string) { - if originsString == "" { - v.allowedOrigins = []string{} - return - } - - origins := strings.Split(originsString, ",") - var trimmedOrigins []string - - for _, origin := range origins { - trimmed := strings.TrimSuffix(strings.TrimSpace(origin), "/") - if trimmed != "" { - trimmedOrigins = append(trimmedOrigins, trimmed) - } - } - - v.allowedOrigins = trimmedOrigins -} - -// IsOriginAllowed checks if the given origin is allowed -func (v *OriginValidator) IsOriginAllowed(origin string) bool { - if origin == "" { - return false - } - - for _, allowedOrigin := range v.allowedOrigins { - if v.matchesOriginPattern(allowedOrigin, origin) { - return true - } - } - - return false -} - -// matchesOriginPattern checks if origin matches the pattern (supports wildcards) -func (v *OriginValidator) matchesOriginPattern(pattern, origin string) bool { - // Exact match - if pattern == origin { - return true - } - - // Wildcard pattern matching - if strings.Contains(pattern, "*") { - regexPattern := v.wildcardPatternToRegex(pattern) - matched, err := regexp.MatchString(regexPattern, origin) - if err != nil { - return false - } - return matched - } - - return false -} - -// wildcardPatternToRegex converts wildcard pattern to regex -func (v *OriginValidator) wildcardPatternToRegex(wildcardPattern string) string { - // Escape special regex characters except * - specialChars := []string{"\\", ".", "+", "?", "^", "$", "{", "}", "(", ")", "|", "[", "]"} - - escaped := wildcardPattern - for _, specialChar := range specialChars { - escaped = strings.ReplaceAll(escaped, specialChar, "\\"+specialChar) - } - - // Replace * with .* (matches any characters) - escaped = strings.ReplaceAll(escaped, "*", ".*") - - // Anchor the pattern to match the entire string - return "^" + escaped + "$" -} - -// GetOriginFromURL extracts origin from URL string -func (v *OriginValidator) GetOriginFromURL(urlString string) (string, error) { - if urlString == "" { - return "", fmt.Errorf("empty URL") - } - - parsedURL, err := url.Parse(urlString) - if err != nil { - return "", fmt.Errorf("invalid URL: %v", err) - } - - if parsedURL.Scheme == "" || parsedURL.Host == "" { - return "", fmt.Errorf("URL missing scheme or host") - } - - // Build origin (scheme + host) - origin := parsedURL.Scheme + "://" + parsedURL.Host - - return origin, nil -} diff --git a/v2/internal/frontend/runtime/desktop/draganddrop.js b/v2/internal/frontend/runtime/desktop/draganddrop.js index e470e4823..143b4228e 100644 --- a/v2/internal/frontend/runtime/desktop/draganddrop.js +++ b/v2/internal/frontend/runtime/desktop/draganddrop.js @@ -44,27 +44,14 @@ function checkStyleDropTarget(style) { /** * onDragOver is called when the dragover event is emitted. - * @param {DragEvent} e - * @returns + * @param {DragEvent} e + * @returns */ function onDragOver(e) { - // Check if this is an external file drop or internal HTML drag - // External file drops will have "Files" in the types array - // Internal HTML drags typically have "text/plain", "text/html" or custom types - const isFileDrop = e.dataTransfer.types.includes("Files"); - - // Only handle external file drops, let internal HTML5 drag-and-drop work normally - if (!isFileDrop) { - return; - } - - // ALWAYS prevent default for file drops to stop browser navigation - e.preventDefault(); - e.dataTransfer.dropEffect = 'copy'; - if (!window.wails.flags.enableWailsDragAndDrop) { return; } + e.preventDefault(); if (!flags.useDropTarget) { return; @@ -83,7 +70,7 @@ function onDragOver(e) { let currentElement = element; while (currentElement) { // check if currentElement is drop target element - if (checkStyleDropTarget(getComputedStyle(currentElement))) { + if (checkStyleDropTarget(currentElement.style)) { currentElement.classList.add(DROP_TARGET_ACTIVE); } currentElement = currentElement.parentElement; @@ -92,24 +79,14 @@ function onDragOver(e) { /** * onDragLeave is called when the dragleave event is emitted. - * @param {DragEvent} e - * @returns + * @param {DragEvent} e + * @returns */ function onDragLeave(e) { - // Check if this is an external file drop or internal HTML drag - const isFileDrop = e.dataTransfer.types.includes("Files"); - - // Only handle external file drops, let internal HTML5 drag-and-drop work normally - if (!isFileDrop) { - return; - } - - // ALWAYS prevent default for file drops to stop browser navigation - e.preventDefault(); - if (!window.wails.flags.enableWailsDragAndDrop) { return; } + e.preventDefault(); if (!flags.useDropTarget) { return; @@ -144,24 +121,24 @@ function onDragLeave(e) { /** * onDrop is called when the drop event is emitted. - * @param {DragEvent} e - * @returns + * @param {DragEvent} e + * @returns */ function onDrop(e) { - // Check if this is an external file drop or internal HTML drag - const isFileDrop = e.dataTransfer.types.includes("Files"); - - // Only handle external file drops, let internal HTML5 drag-and-drop work normally - if (!isFileDrop) { - return; - } - - // ALWAYS prevent default for file drops to stop browser navigation - e.preventDefault(); - if (!window.wails.flags.enableWailsDragAndDrop) { return; } + e.preventDefault(); + + if (!flags.useDropTarget) { + return; + } + + // Trigger debounce function to deactivate drop targets + if(flags.nextDeactivate) flags.nextDeactivate(); + + // Deactivate all drop targets + Array.from(document.getElementsByClassName(DROP_TARGET_ACTIVE)).forEach(el => el.classList.remove(DROP_TARGET_ACTIVE)); if (CanResolveFilePaths()) { // process files @@ -177,16 +154,6 @@ function onDrop(e) { } window.runtime.ResolveFilePaths(e.x, e.y, files); } - - if (!flags.useDropTarget) { - return; - } - - // Trigger debounce function to deactivate drop targets - if(flags.nextDeactivate) flags.nextDeactivate(); - - // Deactivate all drop targets - Array.from(document.getElementsByClassName(DROP_TARGET_ACTIVE)).forEach(el => el.classList.remove(DROP_TARGET_ACTIVE)); } /** diff --git a/v2/internal/frontend/runtime/desktop/events.js b/v2/internal/frontend/runtime/desktop/events.js index e665a8aff..9548cbc34 100644 --- a/v2/internal/frontend/runtime/desktop/events.js +++ b/v2/internal/frontend/runtime/desktop/events.js @@ -90,17 +90,17 @@ function notifyListeners(eventData) { // Get the event name let eventName = eventData.name; - // Keep a list of listener indexes to destroy - const newEventListenerList = eventListeners[eventName]?.slice() || []; - // Check if we have any listeners for this event - if (newEventListenerList.length) { + if (eventListeners[eventName]) { + + // Keep a list of listener indexes to destroy + const newEventListenerList = eventListeners[eventName].slice(); // Iterate listeners - for (let count = newEventListenerList.length - 1; count >= 0; count -= 1) { + for (let count = eventListeners[eventName].length - 1; count >= 0; count -= 1) { // Get next listener - const listener = newEventListenerList[count]; + const listener = eventListeners[eventName][count]; let data = eventData.data; @@ -190,9 +190,9 @@ export function EventsOff(eventName, ...additionalEventNames) { */ export function EventsOffAll() { const eventNames = Object.keys(eventListeners); - eventNames.forEach(eventName => { - removeListener(eventName) - }) + for (let i = 0; i !== eventNames.length; i++) { + removeListener(eventNames[i]); + } } /** @@ -202,8 +202,6 @@ export function EventsOff(eventName, ...additionalEventNames) { */ function listenerOff(listener) { const eventName = listener.eventName; - if (eventListeners[eventName] === undefined) return; - // Remove local listener eventListeners[eventName] = eventListeners[eventName].filter(l => l !== listener); diff --git a/v2/internal/frontend/runtime/desktop/main.js b/v2/internal/frontend/runtime/desktop/main.js index 3fda7ef36..ae31744cc 100644 --- a/v2/internal/frontend/runtime/desktop/main.js +++ b/v2/internal/frontend/runtime/desktop/main.js @@ -9,18 +9,9 @@ The electron alternative for Go */ /* jshint esversion: 9 */ import * as Log from './log'; -import { - eventListeners, - EventsEmit, - EventsNotify, - EventsOff, - EventsOffAll, - EventsOn, - EventsOnce, - EventsOnMultiple, -} from "./events"; -import { Call, Callback, callbacks } from './calls'; -import { SetBindings } from "./bindings"; +import {eventListeners, EventsEmit, EventsNotify, EventsOff, EventsOn, EventsOnce, EventsOnMultiple} from './events'; +import {Call, Callback, callbacks} from './calls'; +import {SetBindings} from "./bindings"; import * as Window from "./window"; import * as Screen from "./screen"; import * as Browser from "./browser"; @@ -57,7 +48,6 @@ window.runtime = { EventsOnMultiple, EventsEmit, EventsOff, - EventsOffAll, Environment, Show, Hide, @@ -98,12 +88,12 @@ if (!DEBUG) { delete window.wailsbindings; } -let dragTest = function(e) { +let dragTest = function (e) { var val = window.getComputedStyle(e.target).getPropertyValue(window.wails.flags.cssDragProperty); if (val) { - val = val.trim(); + val = val.trim(); } - + if (val !== window.wails.flags.cssDragValue) { return false; } @@ -121,12 +111,12 @@ let dragTest = function(e) { return true; }; -window.wails.setCSSDragProperties = function(property, value) { +window.wails.setCSSDragProperties = function (property, value) { window.wails.flags.cssDragProperty = property; window.wails.flags.cssDragValue = value; } -window.wails.setCSSDropProperties = function(property, value) { +window.wails.setCSSDropProperties = function (property, value) { window.wails.flags.cssDropProperty = property; window.wails.flags.cssDropValue = value; } @@ -167,7 +157,7 @@ function setResize(cursor) { window.wails.flags.resizeEdge = cursor; } -window.addEventListener('mousemove', function(e) { +window.addEventListener('mousemove', function (e) { if (window.wails.flags.shouldDrag) { window.wails.flags.shouldDrag = false; let mousePressed = e.buttons !== undefined ? e.buttons : e.which; @@ -205,7 +195,7 @@ window.addEventListener('mousemove', function(e) { }); // Setup context menu hook -window.addEventListener('contextmenu', function(e) { +window.addEventListener('contextmenu', function (e) { // always show the contextmenu in debug & dev if (DEBUG) return; diff --git a/v2/internal/frontend/runtime/ipc_websocket.js b/v2/internal/frontend/runtime/ipc_websocket.js index 1ca048df1..a0d6b4a70 100644 --- a/v2/internal/frontend/runtime/ipc_websocket.js +++ b/v2/internal/frontend/runtime/ipc_websocket.js @@ -1,9 +1,9 @@ (()=>{function D(t){console.log("%c wails dev %c "+t+" ","background: #aa0000; color: #fff; border-radius: 3px 0px 0px 3px; padding: 1px; font-size: 0.7rem","background: #009900; color: #fff; border-radius: 0px 3px 3px 0px; padding: 1px; font-size: 0.7rem")}function _(){}var A=t=>t;function N(t){return t()}function it(){return Object.create(null)}function b(t){t.forEach(N)}function w(t){return typeof t=="function"}function L(t,e){return t!=t?e==e:t!==e||t&&typeof t=="object"||typeof t=="function"}function ot(t){return Object.keys(t).length===0}function rt(t,...e){if(t==null)return _;let n=t.subscribe(...e);return n.unsubscribe?()=>n.unsubscribe():n}function st(t,e,n){t.$$.on_destroy.push(rt(e,n))}var ct=typeof window!="undefined",Ot=ct?()=>window.performance.now():()=>Date.now(),P=ct?t=>requestAnimationFrame(t):_;var x=new Set;function lt(t){x.forEach(e=>{e.c(t)||(x.delete(e),e.f())}),x.size!==0&&P(lt)}function Dt(t){let e;return x.size===0&&P(lt),{promise:new Promise(n=>{x.add(e={c:t,f:n})}),abort(){x.delete(e)}}}var ut=!1;function At(){ut=!0}function Lt(){ut=!1}function Bt(t,e){t.appendChild(e)}function at(t,e,n){let i=R(t);if(!i.getElementById(e)){let o=B("style");o.id=e,o.textContent=n,ft(i,o)}}function R(t){if(!t)return document;let e=t.getRootNode?t.getRootNode():t.ownerDocument;return e&&e.host?e:t.ownerDocument}function Tt(t){let e=B("style");return ft(R(t),e),e.sheet}function ft(t,e){return Bt(t.head||t,e),e.sheet}function W(t,e,n){t.insertBefore(e,n||null)}function S(t){t.parentNode.removeChild(t)}function B(t){return document.createElement(t)}function Jt(t){return document.createTextNode(t)}function dt(){return Jt("")}function ht(t,e,n){n==null?t.removeAttribute(e):t.getAttribute(e)!==n&&t.setAttribute(e,n)}function zt(t){return Array.from(t.childNodes)}function Ht(t,e,{bubbles:n=!1,cancelable:i=!1}={}){let o=document.createEvent("CustomEvent");return o.initCustomEvent(t,n,i,e),o}var T=new Map,J=0;function Gt(t){let e=5381,n=t.length;for(;n--;)e=(e<<5)-e^t.charCodeAt(n);return e>>>0}function qt(t,e){let n={stylesheet:Tt(e),rules:{}};return T.set(t,n),n}function pt(t,e,n,i,o,c,s,l=0){let f=16.666/i,r=`{ `;for(let g=0;g<=1;g+=f){let F=e+(n-e)*c(g);r+=g*100+`%{${s(F,1-F)}} `}let y=r+`100% {${s(n,1-n)}} -}`,a=`__svelte_${Gt(y)}_${l}`,u=R(t),{stylesheet:h,rules:p}=T.get(u)||qt(u,t);p[a]||(p[a]=!0,h.insertRule(`@keyframes ${a} ${y}`,h.cssRules.length));let v=t.style.animation||"";return t.style.animation=`${v?`${v}, `:""}${a} ${i}ms linear ${o}ms 1 both`,J+=1,a}function Kt(t,e){let n=(t.style.animation||"").split(", "),i=n.filter(e?c=>c.indexOf(e)<0:c=>c.indexOf("__svelte")===-1),o=n.length-i.length;o&&(t.style.animation=i.join(", "),J-=o,J||Nt())}function Nt(){P(()=>{J||(T.forEach(t=>{let{ownerNode:e}=t.stylesheet;e&&S(e)}),T.clear())})}var V;function C(t){V=t}var k=[];var _t=[],z=[],mt=[],Pt=Promise.resolve(),U=!1;function Rt(){U||(U=!0,Pt.then(yt))}function $(t){z.push(t)}var X=new Set,H=0;function yt(){let t=V;do{for(;H{E=null})),E}function Z(t,e,n){t.dispatchEvent(Ht(`${e?"intro":"outro"}${n}`))}var G=new Set,m;function gt(){m={r:0,c:[],p:m}}function bt(){m.r||b(m.c),m=m.p}function I(t,e){t&&t.i&&(G.delete(t),t.i(e))}function Q(t,e,n,i){if(t&&t.o){if(G.has(t))return;G.add(t),m.c.push(()=>{G.delete(t),i&&(n&&t.d(1),i())}),t.o(e)}else i&&i()}var Ut={duration:0};function Y(t,e,n,i){let o=e(t,n),c=i?0:1,s=null,l=null,f=null;function r(){f&&Kt(t,f)}function y(u,h){let p=u.b-c;return h*=Math.abs(p),{a:c,b:u.b,d:p,duration:h,start:u.start,end:u.start+h,group:u.group}}function a(u){let{delay:h=0,duration:p=300,easing:v=A,tick:g=_,css:F}=o||Ut,K={start:Ot()+h,b:u};u||(K.group=m,m.r+=1),s||l?l=K:(F&&(r(),f=pt(t,c,u,p,h,v,F)),u&&g(0,1),s=y(K,p),$(()=>Z(t,u,"start")),Dt(O=>{if(l&&O>l.start&&(s=y(l,p),l=null,Z(t,s.b,"start"),F&&(r(),f=pt(t,c,s.b,s.duration,0,v,o.css))),s){if(O>=s.end)g(c=s.b,1-c),Z(t,s.b,"end"),l||(s.b?r():--s.group.r||b(s.group.c)),s=null;else if(O>=s.start){let jt=O-s.start;c=s.a+s.d*v(jt/s.duration),g(c,1-c)}}return!!(s||l)}))}return{run(u){w(o)?Vt().then(()=>{o=o(),a(u)}):a(u)},end(){r(),s=l=null}}}var le=typeof window!="undefined"?window:typeof globalThis!="undefined"?globalThis:global;var ue=new Set(["allowfullscreen","allowpaymentrequest","async","autofocus","autoplay","checked","controls","default","defer","disabled","formnovalidate","hidden","inert","ismap","itemscope","loop","multiple","muted","nomodule","novalidate","open","playsinline","readonly","required","reversed","selected"]);function Xt(t,e,n,i){let{fragment:o,after_update:c}=t.$$;o&&o.m(e,n),i||$(()=>{let s=t.$$.on_mount.map(N).filter(w);t.$$.on_destroy?t.$$.on_destroy.push(...s):b(s),t.$$.on_mount=[]}),c.forEach($)}function wt(t,e){let n=t.$$;n.fragment!==null&&(b(n.on_destroy),n.fragment&&n.fragment.d(e),n.on_destroy=n.fragment=null,n.ctx=[])}function Zt(t,e){t.$$.dirty[0]===-1&&(k.push(t),Rt(),t.$$.dirty.fill(0)),t.$$.dirty[e/31|0]|=1<{let p=h.length?h[0]:u;return r.ctx&&o(r.ctx[a],r.ctx[a]=p)&&(!r.skip_bound&&r.bound[a]&&r.bound[a](p),y&&Zt(t,a)),u}):[],r.update(),y=!0,b(r.before_update),r.fragment=i?i(r.ctx):!1,e.target){if(e.hydrate){At();let a=zt(e.target);r.fragment&&r.fragment.l(a),a.forEach(S)}else r.fragment&&r.fragment.c();e.intro&&I(t.$$.fragment),Xt(t,e.target,e.anchor,e.customElement),Lt(),yt()}C(f)}var Qt;typeof HTMLElement=="function"&&(Qt=class extends HTMLElement{constructor(){super();this.attachShadow({mode:"open"})}connectedCallback(){let{on_mount:t}=this.$$;this.$$.on_disconnect=t.map(N).filter(w);for(let e in this.$$.slotted)this.appendChild(this.$$.slotted[e])}attributeChangedCallback(t,e,n){this[t]=n}disconnectedCallback(){b(this.$$.on_disconnect)}$destroy(){wt(this,1),this.$destroy=_}$on(t,e){if(!w(e))return _;let n=this.$$.callbacks[t]||(this.$$.callbacks[t]=[]);return n.push(e),()=>{let i=n.indexOf(e);i!==-1&&n.splice(i,1)}}$set(t){this.$$set&&!ot(t)&&(this.$$.skip_bound=!0,this.$$set(t),this.$$.skip_bound=!1)}});var tt=class{$destroy(){wt(this,1),this.$destroy=_}$on(e,n){if(!w(n))return _;let i=this.$$.callbacks[e]||(this.$$.callbacks[e]=[]);return i.push(n),()=>{let o=i.indexOf(n);o!==-1&&i.splice(o,1)}}$set(e){this.$$set&&!ot(e)&&(this.$$.skip_bound=!0,this.$$set(e),this.$$.skip_bound=!1)}};var M=[];function Ft(t,e=_){let n,i=new Set;function o(l){if(L(t,l)&&(t=l,n)){let f=!M.length;for(let r of i)r[1](),M.push(r,t);if(f){for(let r=0;r{i.delete(r),i.size===0&&(n(),n=null)}}return{set:o,update:c,subscribe:s}}var q=Ft(!1);function xt(){q.set(!0)}function $t(){q.set(!1)}function et(t,{delay:e=0,duration:n=400,easing:i=A}={}){let o=+getComputedStyle(t).opacity;return{delay:e,duration:n,easing:i,css:c=>`opacity: ${c*o}`}}function Yt(t){at(t,"svelte-181h7z",`.wails-reconnect-overlay.svelte-181h7z{position:fixed;top:0;left:0;width:100%;height:100%;backdrop-filter:blur(2px) saturate(0%) contrast(50%) brightness(25%);z-index:999999\r - }.wails-reconnect-overlay-content.svelte-181h7z{position:relative;top:50%;transform:translateY(-50%);margin:0;background-image:url(data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAEsAAAA7CAMAAAAEsocZAAAC91BMVEUAAACzQ0PjMjLkMjLZLS7XLS+vJCjkMjKlEx6uGyHjMDGiFx7GJyrAISjUKy3mMzPlMjLjMzOsGyDKJirkMjK6HyXmMjLgMDC6IiLcMjLULC3MJyrRKSy+IibmMzPmMjK7ISXlMjLIJimzHSLkMjKtGiHZLC7BIifgMDCpGSDFIivcLy+yHSKoGR+eFBzNKCvlMjKxHSPkMTKxHSLmMjLKJyq5ICXDJCe6ISXdLzDkMjLmMzPFJSm2HyTlMTLhMDGyHSKUEBmhFx24HyTCJCjHJijjMzOiFh7mMjJ6BhDaLDCuGyOKABjnMzPGJinJJiquHCGEChSmGB/pMzOiFh7VKy3OKCu1HiSvHCLjMTLMKCrBIyeICxWxHCLDIyjSKizBIyh+CBO9ISa6ISWDChS9Iie1HyXVLC7FJSrLKCrlMjLiMTGPDhicFRywGyKXFBuhFx1/BxO7IiXkMTGeFBx8BxLkMTGnGR/GJCi4ICWsGyGJDxXSLS2yGiHSKi3CJCfnMzPQKiyECRTKJiq6ISWUERq/Iye0HiPDJCjGJSm6ICaPDxiTEBrdLy+3HyXSKiy0HyOQEBi4ICWhFh1+CBO9IieODhfSKyzWLC2LDhh8BxHKKCq7ISWaFBzkMzPqNDTTLC3EJSiHDBacExyvGyO1HyTPKCy+IieoGSC7ISaVEhrMKCvQKyusGyG0HiKACBPIJSq/JCaABxR5BRLEJCnkMzPJJinEJimPDRZ2BRKqHx/jMjLnMzPgMDHULC3NKSvQKSzsNDTWLS7SKyy3HyTKJyrDJSjbLzDYLC6mGB/GJSnVLC61HiPLKCrHJSm/Iye8Iia6ICWzHSKxHCLaLi/PKSupGR+7ICXpMzPbLi/IJinJJSmsGyGrGiCkFx6PDheJCxaFChXBIyfAIieSDxmBCBPlMjLeLzDdLzC5HySMDRe+ISWvGyGcFBzSKSzPJyvMJyrEJCjDIyefFRyWERriMDHUKiy/ISaZExv0NjbwNTXuNDTrMzMI0c+yAAAAu3RSTlMAA8HR/gwGgAj+MEpGCsC+hGpjQjYnIxgWBfzx7urizMrFqqB1bF83KhsR/fz8+/r5+fXv7unZ1tC+t6mmopqKdW1nYVpVRjUeHhIQBPr59/b28/Hx8ODg3NvUw8O/vKeim5aNioiDgn1vZWNjX1xUU1JPTUVFPT08Mi4qJyIh/Pv7+/n4+Pf39fT08/Du7efn5uXj4uHa19XNwsG/vrq2tbSuramlnpyYkpGNiIZ+enRraGVjVVBKOzghdjzRsAAABJVJREFUWMPtllVQG1EYhTc0ASpoobS0FCulUHd3oUjd3d3d3d3d3d2b7CYhnkBCCHGDEIK7Vh56d0NpOgwkYfLQzvA9ZrLfnPvfc+8uVEst/yheBJup3Nya2MjU6pa/jWLZtxjXpZFtVB4uVNI6m5gIruNkVFebqIb5Ug2ym4TIEM/gtUOGbg613oBzjAzZFrZ+lXu/3TIiMXXS5M6HTvrNHeLpZLEh6suGNW9fzZ9zd/qVi2eOHygqi5cDE5GUrJocONgzyqo0UXNSUlKSEhMztFqtXq9vNxImAmS3g7Y6QlbjdBWVGW36jt4wDGTUXjUsafh5zJWRkdFuZGtWGnCRmg+HasiGMUClTTzW0ZuVgLlGDIPM4Lhi0IrVq+tv2hS21fNrSONQgpM9DsJ4t3fM9PkvJuKj2ZjrZwvILKvaSTgciUSirjt6dOfOpyd169bDb9rMOwF9Hj4OD100gY0YXYb299bjzMrqj9doNByJWlVXFB9DT5dmJuvy+cq83JyuS6ayEYSHulKL8dmFnBkrCeZlHKMrC5XRhXGCZB2Ty1fkleRQaMCFT2DBsEafzRFJu7/2MicbKynPhQUDLiZwMWLJZKNLzoLbJBYVcurSmbmn+rcyJ8vCMgmlmaW6gnwun/+3C96VpAUuET1ZgRR36r2xWlnYSnf3oKABA14uXDDvydxHs6cpTV1p3hlJ2rJCiUjIZCByItXg8sHJijuvT64CuMTABUYvb6NN1Jdp1PH7D7f3bo2eS5KvW4RJr7atWT5w4MBBg9zdBw9+37BS7QIoFS5WnIaj12dr1DEXFgdvr4fh4eFl+u/wz8uf3jjHic8s4DL2Dal0IANyUBeCRCcwOBJV26JsjSpGwHVuSai69jvqD+jr56OgtKy0zAAK5mLTVBKVKL5tNthGAR9JneJQ/bFsHNzy+U7IlCYROxtMpIjR0ceoQVnowracLLpAQWETqV361bPoFo3cEbz2zYLZM7t3HWXcxmiBOgttS1ycWkTXMWh4mGigdug9DFdttqCFgTN6nD0q1XEVSoCxEjyFCi2eNC6Z69MRVIImJ6JQSf5gcFVCuF+aDhCa1F6MJFDaiNBQAh2TMfWBjhmLsAxUjG/fmjs0qjJck8D0GPBcuUuZW1LS/tIsPzqmQt17PvZQknlwnf4tHDBc+7t5VV3QQCkdc+Ur8/hdrz0but0RCumWiYbiKmLJ7EVbRomj4Q7+y5wsaXvfTGFpQcHB7n2WbG4MGdniw2Tm8xl5Yhr7MrSYHQ3uampz10aWyHyuzxvqaW/6W4MjXAUD3QV2aw97ZxhGjxCohYf5TpTHMXU1BbsAuoFnkRygVieIGAbqiF7rrH4rfWpKJouBCtyHJF8ctEyGubBa+C6NsMYEUonJFITHZqWBxXUA12Dv76Tf/PgOBmeNiiLG1pcKo1HAq8jLpY4JU1yWEixVNaOgoRJAKBSZHTZTU+wJOMtUDZvlVITC6FTlksyrEBoPHXpxxbzdaqzigUtVDkJVIOtVQ9UEOR4VGUh/kHWq0edJ6CxnZ+eePXva2bnY/cF/I1RLLf8vvwDANdMSMegxcAAAAABJRU5ErkJggg==);background-repeat:no-repeat;background-position:center\r - }.wails-reconnect-overlay-loadingspinner.svelte-181h7z{pointer-events:none;width:2.5em;height:2.5em;border:.4em solid transparent;border-color:#f00 #eee0 #f00 #eee0;border-radius:50%;animation:svelte-181h7z-loadingspin 1s linear infinite;margin:auto;padding:2.5em\r +}`,a=`__svelte_${Gt(y)}_${l}`,u=R(t),{stylesheet:h,rules:p}=T.get(u)||qt(u,t);p[a]||(p[a]=!0,h.insertRule(`@keyframes ${a} ${y}`,h.cssRules.length));let v=t.style.animation||"";return t.style.animation=`${v?`${v}, `:""}${a} ${i}ms linear ${o}ms 1 both`,J+=1,a}function Kt(t,e){let n=(t.style.animation||"").split(", "),i=n.filter(e?c=>c.indexOf(e)<0:c=>c.indexOf("__svelte")===-1),o=n.length-i.length;o&&(t.style.animation=i.join(", "),J-=o,J||Nt())}function Nt(){P(()=>{J||(T.forEach(t=>{let{ownerNode:e}=t.stylesheet;e&&S(e)}),T.clear())})}var V;function C(t){V=t}var k=[];var _t=[],z=[],mt=[],Pt=Promise.resolve(),U=!1;function Rt(){U||(U=!0,Pt.then(yt))}function $(t){z.push(t)}var X=new Set,H=0;function yt(){let t=V;do{for(;H{E=null})),E}function Z(t,e,n){t.dispatchEvent(Ht(`${e?"intro":"outro"}${n}`))}var G=new Set,m;function gt(){m={r:0,c:[],p:m}}function bt(){m.r||b(m.c),m=m.p}function I(t,e){t&&t.i&&(G.delete(t),t.i(e))}function Q(t,e,n,i){if(t&&t.o){if(G.has(t))return;G.add(t),m.c.push(()=>{G.delete(t),i&&(n&&t.d(1),i())}),t.o(e)}else i&&i()}var Ut={duration:0};function Y(t,e,n,i){let o=e(t,n),c=i?0:1,s=null,l=null,f=null;function r(){f&&Kt(t,f)}function y(u,h){let p=u.b-c;return h*=Math.abs(p),{a:c,b:u.b,d:p,duration:h,start:u.start,end:u.start+h,group:u.group}}function a(u){let{delay:h=0,duration:p=300,easing:v=A,tick:g=_,css:F}=o||Ut,K={start:Ot()+h,b:u};u||(K.group=m,m.r+=1),s||l?l=K:(F&&(r(),f=pt(t,c,u,p,h,v,F)),u&&g(0,1),s=y(K,p),$(()=>Z(t,u,"start")),Dt(O=>{if(l&&O>l.start&&(s=y(l,p),l=null,Z(t,s.b,"start"),F&&(r(),f=pt(t,c,s.b,s.duration,0,v,o.css))),s){if(O>=s.end)g(c=s.b,1-c),Z(t,s.b,"end"),l||(s.b?r():--s.group.r||b(s.group.c)),s=null;else if(O>=s.start){let jt=O-s.start;c=s.a+s.d*v(jt/s.duration),g(c,1-c)}}return!!(s||l)}))}return{run(u){w(o)?Vt().then(()=>{o=o(),a(u)}):a(u)},end(){r(),s=l=null}}}var le=typeof window!="undefined"?window:typeof globalThis!="undefined"?globalThis:global;var ue=new Set(["allowfullscreen","allowpaymentrequest","async","autofocus","autoplay","checked","controls","default","defer","disabled","formnovalidate","hidden","inert","ismap","itemscope","loop","multiple","muted","nomodule","novalidate","open","playsinline","readonly","required","reversed","selected"]);function Xt(t,e,n,i){let{fragment:o,after_update:c}=t.$$;o&&o.m(e,n),i||$(()=>{let s=t.$$.on_mount.map(N).filter(w);t.$$.on_destroy?t.$$.on_destroy.push(...s):b(s),t.$$.on_mount=[]}),c.forEach($)}function wt(t,e){let n=t.$$;n.fragment!==null&&(b(n.on_destroy),n.fragment&&n.fragment.d(e),n.on_destroy=n.fragment=null,n.ctx=[])}function Zt(t,e){t.$$.dirty[0]===-1&&(k.push(t),Rt(),t.$$.dirty.fill(0)),t.$$.dirty[e/31|0]|=1<{let p=h.length?h[0]:u;return r.ctx&&o(r.ctx[a],r.ctx[a]=p)&&(!r.skip_bound&&r.bound[a]&&r.bound[a](p),y&&Zt(t,a)),u}):[],r.update(),y=!0,b(r.before_update),r.fragment=i?i(r.ctx):!1,e.target){if(e.hydrate){At();let a=zt(e.target);r.fragment&&r.fragment.l(a),a.forEach(S)}else r.fragment&&r.fragment.c();e.intro&&I(t.$$.fragment),Xt(t,e.target,e.anchor,e.customElement),Lt(),yt()}C(f)}var Qt;typeof HTMLElement=="function"&&(Qt=class extends HTMLElement{constructor(){super();this.attachShadow({mode:"open"})}connectedCallback(){let{on_mount:t}=this.$$;this.$$.on_disconnect=t.map(N).filter(w);for(let e in this.$$.slotted)this.appendChild(this.$$.slotted[e])}attributeChangedCallback(t,e,n){this[t]=n}disconnectedCallback(){b(this.$$.on_disconnect)}$destroy(){wt(this,1),this.$destroy=_}$on(t,e){if(!w(e))return _;let n=this.$$.callbacks[t]||(this.$$.callbacks[t]=[]);return n.push(e),()=>{let i=n.indexOf(e);i!==-1&&n.splice(i,1)}}$set(t){this.$$set&&!ot(t)&&(this.$$.skip_bound=!0,this.$$set(t),this.$$.skip_bound=!1)}});var tt=class{$destroy(){wt(this,1),this.$destroy=_}$on(e,n){if(!w(n))return _;let i=this.$$.callbacks[e]||(this.$$.callbacks[e]=[]);return i.push(n),()=>{let o=i.indexOf(n);o!==-1&&i.splice(o,1)}}$set(e){this.$$set&&!ot(e)&&(this.$$.skip_bound=!0,this.$$set(e),this.$$.skip_bound=!1)}};var M=[];function Ft(t,e=_){let n,i=new Set;function o(l){if(L(t,l)&&(t=l,n)){let f=!M.length;for(let r of i)r[1](),M.push(r,t);if(f){for(let r=0;r{i.delete(r),i.size===0&&(n(),n=null)}}return{set:o,update:c,subscribe:s}}var q=Ft(!1);function xt(){q.set(!0)}function $t(){q.set(!1)}function et(t,{delay:e=0,duration:n=400,easing:i=A}={}){let o=+getComputedStyle(t).opacity;return{delay:e,duration:n,easing:i,css:c=>`opacity: ${c*o}`}}function Yt(t){at(t,"svelte-181h7z",`.wails-reconnect-overlay.svelte-181h7z{position:fixed;top:0;left:0;width:100%;height:100%;backdrop-filter:blur(2px) saturate(0%) contrast(50%) brightness(25%);z-index:999999 + }.wails-reconnect-overlay-content.svelte-181h7z{position:relative;top:50%;transform:translateY(-50%);margin:0;background-image:url(data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAEsAAAA7CAMAAAAEsocZAAAC91BMVEUAAACzQ0PjMjLkMjLZLS7XLS+vJCjkMjKlEx6uGyHjMDGiFx7GJyrAISjUKy3mMzPlMjLjMzOsGyDKJirkMjK6HyXmMjLgMDC6IiLcMjLULC3MJyrRKSy+IibmMzPmMjK7ISXlMjLIJimzHSLkMjKtGiHZLC7BIifgMDCpGSDFIivcLy+yHSKoGR+eFBzNKCvlMjKxHSPkMTKxHSLmMjLKJyq5ICXDJCe6ISXdLzDkMjLmMzPFJSm2HyTlMTLhMDGyHSKUEBmhFx24HyTCJCjHJijjMzOiFh7mMjJ6BhDaLDCuGyOKABjnMzPGJinJJiquHCGEChSmGB/pMzOiFh7VKy3OKCu1HiSvHCLjMTLMKCrBIyeICxWxHCLDIyjSKizBIyh+CBO9ISa6ISWDChS9Iie1HyXVLC7FJSrLKCrlMjLiMTGPDhicFRywGyKXFBuhFx1/BxO7IiXkMTGeFBx8BxLkMTGnGR/GJCi4ICWsGyGJDxXSLS2yGiHSKi3CJCfnMzPQKiyECRTKJiq6ISWUERq/Iye0HiPDJCjGJSm6ICaPDxiTEBrdLy+3HyXSKiy0HyOQEBi4ICWhFh1+CBO9IieODhfSKyzWLC2LDhh8BxHKKCq7ISWaFBzkMzPqNDTTLC3EJSiHDBacExyvGyO1HyTPKCy+IieoGSC7ISaVEhrMKCvQKyusGyG0HiKACBPIJSq/JCaABxR5BRLEJCnkMzPJJinEJimPDRZ2BRKqHx/jMjLnMzPgMDHULC3NKSvQKSzsNDTWLS7SKyy3HyTKJyrDJSjbLzDYLC6mGB/GJSnVLC61HiPLKCrHJSm/Iye8Iia6ICWzHSKxHCLaLi/PKSupGR+7ICXpMzPbLi/IJinJJSmsGyGrGiCkFx6PDheJCxaFChXBIyfAIieSDxmBCBPlMjLeLzDdLzC5HySMDRe+ISWvGyGcFBzSKSzPJyvMJyrEJCjDIyefFRyWERriMDHUKiy/ISaZExv0NjbwNTXuNDTrMzMI0c+yAAAAu3RSTlMAA8HR/gwGgAj+MEpGCsC+hGpjQjYnIxgWBfzx7urizMrFqqB1bF83KhsR/fz8+/r5+fXv7unZ1tC+t6mmopqKdW1nYVpVRjUeHhIQBPr59/b28/Hx8ODg3NvUw8O/vKeim5aNioiDgn1vZWNjX1xUU1JPTUVFPT08Mi4qJyIh/Pv7+/n4+Pf39fT08/Du7efn5uXj4uHa19XNwsG/vrq2tbSuramlnpyYkpGNiIZ+enRraGVjVVBKOzghdjzRsAAABJVJREFUWMPtllVQG1EYhTc0ASpoobS0FCulUHd3oUjd3d3d3d3d3d2b7CYhnkBCCHGDEIK7Vh56d0NpOgwkYfLQzvA9ZrLfnPvfc+8uVEst/yheBJup3Nya2MjU6pa/jWLZtxjXpZFtVB4uVNI6m5gIruNkVFebqIb5Ug2ym4TIEM/gtUOGbg613oBzjAzZFrZ+lXu/3TIiMXXS5M6HTvrNHeLpZLEh6suGNW9fzZ9zd/qVi2eOHygqi5cDE5GUrJocONgzyqo0UXNSUlKSEhMztFqtXq9vNxImAmS3g7Y6QlbjdBWVGW36jt4wDGTUXjUsafh5zJWRkdFuZGtWGnCRmg+HasiGMUClTTzW0ZuVgLlGDIPM4Lhi0IrVq+tv2hS21fNrSONQgpM9DsJ4t3fM9PkvJuKj2ZjrZwvILKvaSTgciUSirjt6dOfOpyd169bDb9rMOwF9Hj4OD100gY0YXYb299bjzMrqj9doNByJWlVXFB9DT5dmJuvy+cq83JyuS6ayEYSHulKL8dmFnBkrCeZlHKMrC5XRhXGCZB2Ty1fkleRQaMCFT2DBsEafzRFJu7/2MicbKynPhQUDLiZwMWLJZKNLzoLbJBYVcurSmbmn+rcyJ8vCMgmlmaW6gnwun/+3C96VpAUuET1ZgRR36r2xWlnYSnf3oKABA14uXDDvydxHs6cpTV1p3hlJ2rJCiUjIZCByItXg8sHJijuvT64CuMTABUYvb6NN1Jdp1PH7D7f3bo2eS5KvW4RJr7atWT5w4MBBg9zdBw9+37BS7QIoFS5WnIaj12dr1DEXFgdvr4fh4eFl+u/wz8uf3jjHic8s4DL2Dal0IANyUBeCRCcwOBJV26JsjSpGwHVuSai69jvqD+jr56OgtKy0zAAK5mLTVBKVKL5tNthGAR9JneJQ/bFsHNzy+U7IlCYROxtMpIjR0ceoQVnowracLLpAQWETqV361bPoFo3cEbz2zYLZM7t3HWXcxmiBOgttS1ycWkTXMWh4mGigdug9DFdttqCFgTN6nD0q1XEVSoCxEjyFCi2eNC6Z69MRVIImJ6JQSf5gcFVCuF+aDhCa1F6MJFDaiNBQAh2TMfWBjhmLsAxUjG/fmjs0qjJck8D0GPBcuUuZW1LS/tIsPzqmQt17PvZQknlwnf4tHDBc+7t5VV3QQCkdc+Ur8/hdrz0but0RCumWiYbiKmLJ7EVbRomj4Q7+y5wsaXvfTGFpQcHB7n2WbG4MGdniw2Tm8xl5Yhr7MrSYHQ3uampz10aWyHyuzxvqaW/6W4MjXAUD3QV2aw97ZxhGjxCohYf5TpTHMXU1BbsAuoFnkRygVieIGAbqiF7rrH4rfWpKJouBCtyHJF8ctEyGubBa+C6NsMYEUonJFITHZqWBxXUA12Dv76Tf/PgOBmeNiiLG1pcKo1HAq8jLpY4JU1yWEixVNaOgoRJAKBSZHTZTU+wJOMtUDZvlVITC6FTlksyrEBoPHXpxxbzdaqzigUtVDkJVIOtVQ9UEOR4VGUh/kHWq0edJ6CxnZ+eePXva2bnY/cF/I1RLLf8vvwDANdMSMegxcAAAAABJRU5ErkJggg==);background-repeat:no-repeat;background-position:center + }.wails-reconnect-overlay-loadingspinner.svelte-181h7z{pointer-events:none;width:2.5em;height:2.5em;border:.4em solid transparent;border-color:#f00 #eee0 #f00 #eee0;border-radius:50%;animation:svelte-181h7z-loadingspin 1s linear infinite;margin:auto;padding:2.5em }@keyframes svelte-181h7z-loadingspin{100%{transform:rotate(360deg)}}`)}function Mt(t){let e,n,i;return{c(){e=B("div"),e.innerHTML='
      ',ht(e,"class","wails-reconnect-overlay svelte-181h7z")},m(o,c){W(o,e,c),i=!0},i(o){i||($(()=>{n||(n=Y(e,et,{duration:300},!0)),n.run(1)}),i=!0)},o(o){n||(n=Y(e,et,{duration:300},!1)),n.run(0),i=!1},d(o){o&&S(e),o&&n&&n.end()}}}function te(t){let e,n,i=t[0]&&Mt(t);return{c(){i&&i.c(),e=dt()},m(o,c){i&&i.m(o,c),W(o,e,c),n=!0},p(o,[c]){o[0]?i?c&1&&I(i,1):(i=Mt(o),i.c(),I(i,1),i.m(e.parentNode,e)):i&&(gt(),Q(i,1,1,()=>{i=null}),bt())},i(o){n||(I(i),n=!0)},o(o){Q(i),n=!1},d(o){i&&i.d(o),o&&S(e)}}}function ee(t,e,n){let i;return st(t,q,o=>n(0,i=o)),[i]}var St=class extends tt{constructor(e){super();vt(this,e,ee,te,L,{},Yt)}},Ct=St;var ne={},nt=null,j=[];window.WailsInvoke=t=>{if(!nt){console.log("Queueing: "+t),j.push(t);return}nt(t)};window.addEventListener("DOMContentLoaded",()=>{ne.overlay=new Ct({target:document.body,anchor:document.querySelector("#wails-spinner")})});var d=null,kt;window.onbeforeunload=function(){d&&(d.onclose=function(){},d.close(),d=null)};It();function ie(){nt=t=>{d.send(t)};for(let t=0;t= 0; count -= 1) { - const listener = newEventListenerList[count]; + if (eventListeners[eventName]) { + const newEventListenerList = eventListeners[eventName].slice(); + for (let count = eventListeners[eventName].length - 1; count >= 0; count -= 1) { + const listener = eventListeners[eventName][count]; let data = eventData.data; const destroy = listener.Callback(data); if (destroy) { @@ -130,16 +130,8 @@ }); } } - function EventsOffAll() { - const eventNames = Object.keys(eventListeners); - eventNames.forEach((eventName) => { - removeListener(eventName); - }); - } function listenerOff(listener) { const eventName = listener.eventName; - if (eventListeners[eventName] === void 0) - return; eventListeners[eventName] = eventListeners[eventName].filter((l) => l !== listener); if (eventListeners[eventName].length === 0) { removeListener(eventName); @@ -459,15 +451,10 @@ return false; } function onDragOver(e) { - const isFileDrop = e.dataTransfer.types.includes("Files"); - if (!isFileDrop) { - return; - } - e.preventDefault(); - e.dataTransfer.dropEffect = "copy"; if (!window.wails.flags.enableWailsDragAndDrop) { return; } + e.preventDefault(); if (!flags.useDropTarget) { return; } @@ -479,21 +466,17 @@ } let currentElement = element; while (currentElement) { - if (checkStyleDropTarget(getComputedStyle(currentElement))) { + if (checkStyleDropTarget(currentElement.style)) { currentElement.classList.add(DROP_TARGET_ACTIVE); } currentElement = currentElement.parentElement; } } function onDragLeave(e) { - const isFileDrop = e.dataTransfer.types.includes("Files"); - if (!isFileDrop) { - return; - } - e.preventDefault(); if (!window.wails.flags.enableWailsDragAndDrop) { return; } + e.preventDefault(); if (!flags.useDropTarget) { return; } @@ -516,14 +499,16 @@ }, 50); } function onDrop(e) { - const isFileDrop = e.dataTransfer.types.includes("Files"); - if (!isFileDrop) { - return; - } - e.preventDefault(); if (!window.wails.flags.enableWailsDragAndDrop) { return; } + e.preventDefault(); + if (!flags.useDropTarget) { + return; + } + if (flags.nextDeactivate) + flags.nextDeactivate(); + Array.from(document.getElementsByClassName(DROP_TARGET_ACTIVE)).forEach((el) => el.classList.remove(DROP_TARGET_ACTIVE)); if (CanResolveFilePaths()) { let files = []; if (e.dataTransfer.items) { @@ -537,12 +522,6 @@ } window.runtime.ResolveFilePaths(e.x, e.y, files); } - if (!flags.useDropTarget) { - return; - } - if (flags.nextDeactivate) - flags.nextDeactivate(); - Array.from(document.getElementsByClassName(DROP_TARGET_ACTIVE)).forEach((el) => el.classList.remove(DROP_TARGET_ACTIVE)); } function CanResolveFilePaths() { return window.chrome?.webview?.postMessageWithAdditionalObjects != null; @@ -649,7 +628,6 @@ EventsOnMultiple, EventsEmit, EventsOff, - EventsOffAll, Environment, Show, Hide, @@ -789,4 +767,4 @@ }); window.WailsInvoke("runtime:ready"); })(); -//# sourceMappingURL=data:application/json;base64,{
  "version": 3,
  "sources": ["desktop/log.js", "desktop/events.js", "desktop/calls.js", "desktop/bindings.js", "desktop/window.js", "desktop/screen.js", "desktop/browser.js", "desktop/clipboard.js", "desktop/draganddrop.js", "desktop/contextmenu.js", "desktop/main.js"],
  "sourcesContent": ["/*\r\n _       __      _ __\r\n| |     / /___ _(_) /____\r\n| | /| / / __ `/ / / ___/\r\n| |/ |/ / /_/ / / (__  )\r\n|__/|__/\\__,_/_/_/____/\r\nThe electron alternative for Go\r\n(c) Lea Anthony 2019-present\r\n*/\r\n\r\n/* jshint esversion: 6 */\r\n\r\n/**\r\n * Sends a log message to the backend with the given level + message\r\n *\r\n * @param {string} level\r\n * @param {string} message\r\n */\r\nfunction sendLogMessage(level, message) {\r\n\r\n\t// Log Message format:\r\n\t// l[type][message]\r\n\twindow.WailsInvoke('L' + level + message);\r\n}\r\n\r\n/**\r\n * Log the given trace message with the backend\r\n *\r\n * @export\r\n * @param {string} message\r\n */\r\nexport function LogTrace(message) {\r\n\tsendLogMessage('T', message);\r\n}\r\n\r\n/**\r\n * Log the given message with the backend\r\n *\r\n * @export\r\n * @param {string} message\r\n */\r\nexport function LogPrint(message) {\r\n\tsendLogMessage('P', message);\r\n}\r\n\r\n/**\r\n * Log the given debug message with the backend\r\n *\r\n * @export\r\n * @param {string} message\r\n */\r\nexport function LogDebug(message) {\r\n\tsendLogMessage('D', message);\r\n}\r\n\r\n/**\r\n * Log the given info message with the backend\r\n *\r\n * @export\r\n * @param {string} message\r\n */\r\nexport function LogInfo(message) {\r\n\tsendLogMessage('I', message);\r\n}\r\n\r\n/**\r\n * Log the given warning message with the backend\r\n *\r\n * @export\r\n * @param {string} message\r\n */\r\nexport function LogWarning(message) {\r\n\tsendLogMessage('W', message);\r\n}\r\n\r\n/**\r\n * Log the given error message with the backend\r\n *\r\n * @export\r\n * @param {string} message\r\n */\r\nexport function LogError(message) {\r\n\tsendLogMessage('E', message);\r\n}\r\n\r\n/**\r\n * Log the given fatal message with the backend\r\n *\r\n * @export\r\n * @param {string} message\r\n */\r\nexport function LogFatal(message) {\r\n\tsendLogMessage('F', message);\r\n}\r\n\r\n/**\r\n * Sets the Log level to the given log level\r\n *\r\n * @export\r\n * @param {number} loglevel\r\n */\r\nexport function SetLogLevel(loglevel) {\r\n\tsendLogMessage('S', loglevel);\r\n}\r\n\r\n// Log levels\r\nexport const LogLevel = {\r\n\tTRACE: 1,\r\n\tDEBUG: 2,\r\n\tINFO: 3,\r\n\tWARNING: 4,\r\n\tERROR: 5,\r\n};\r\n", "/*\r\n _       __      _ __\r\n| |     / /___ _(_) /____\r\n| | /| / / __ `/ / / ___/\r\n| |/ |/ / /_/ / / (__  )\r\n|__/|__/\\__,_/_/_/____/\r\nThe electron alternative for Go\r\n(c) Lea Anthony 2019-present\r\n*/\r\n/* jshint esversion: 6 */\r\n\r\n// Defines a single listener with a maximum number of times to callback\r\n\r\n/**\r\n * The Listener class defines a listener! :-)\r\n *\r\n * @class Listener\r\n */\r\nclass Listener {\r\n    /**\r\n     * Creates an instance of Listener.\r\n     * @param {string} eventName\r\n     * @param {function} callback\r\n     * @param {number} maxCallbacks\r\n     * @memberof Listener\r\n     */\r\n    constructor(eventName, callback, maxCallbacks) {\r\n        this.eventName = eventName;\r\n        // Default of -1 means infinite\r\n        this.maxCallbacks = maxCallbacks || -1;\r\n        // Callback invokes the callback with the given data\r\n        // Returns true if this listener should be destroyed\r\n        this.Callback = (data) => {\r\n            callback.apply(null, data);\r\n            // If maxCallbacks is infinite, return false (do not destroy)\r\n            if (this.maxCallbacks === -1) {\r\n                return false;\r\n            }\r\n            // Decrement maxCallbacks. Return true if now 0, otherwise false\r\n            this.maxCallbacks -= 1;\r\n            return this.maxCallbacks === 0;\r\n        };\r\n    }\r\n}\r\n\r\nexport const eventListeners = {};\r\n\r\n/**\r\n * Registers an event listener that will be invoked `maxCallbacks` times before being destroyed\r\n *\r\n * @export\r\n * @param {string} eventName\r\n * @param {function} callback\r\n * @param {number} maxCallbacks\r\n * @returns {function} A function to cancel the listener\r\n */\r\nexport function EventsOnMultiple(eventName, callback, maxCallbacks) {\r\n    eventListeners[eventName] = eventListeners[eventName] || [];\r\n    const thisListener = new Listener(eventName, callback, maxCallbacks);\r\n    eventListeners[eventName].push(thisListener);\r\n    return () => listenerOff(thisListener);\r\n}\r\n\r\n/**\r\n * Registers an event listener that will be invoked every time the event is emitted\r\n *\r\n * @export\r\n * @param {string} eventName\r\n * @param {function} callback\r\n * @returns {function} A function to cancel the listener\r\n */\r\nexport function EventsOn(eventName, callback) {\r\n    return EventsOnMultiple(eventName, callback, -1);\r\n}\r\n\r\n/**\r\n * Registers an event listener that will be invoked once then destroyed\r\n *\r\n * @export\r\n * @param {string} eventName\r\n * @param {function} callback\r\n * @returns {function} A function to cancel the listener\r\n */\r\nexport function EventsOnce(eventName, callback) {\r\n    return EventsOnMultiple(eventName, callback, 1);\r\n}\r\n\r\nfunction notifyListeners(eventData) {\r\n\r\n    // Get the event name\r\n    let eventName = eventData.name;\r\n\r\n    // Keep a list of listener indexes to destroy\r\n    const newEventListenerList = eventListeners[eventName]?.slice() || [];\r\n\r\n    // Check if we have any listeners for this event\r\n    if (newEventListenerList.length) {\r\n\r\n        // Iterate listeners\r\n        for (let count = newEventListenerList.length - 1; count >= 0; count -= 1) {\r\n\r\n            // Get next listener\r\n            const listener = newEventListenerList[count];\r\n\r\n            let data = eventData.data;\r\n\r\n            // Do the callback\r\n            const destroy = listener.Callback(data);\r\n            if (destroy) {\r\n                // if the listener indicated to destroy itself, add it to the destroy list\r\n                newEventListenerList.splice(count, 1);\r\n            }\r\n        }\r\n\r\n        // Update callbacks with new list of listeners\r\n        if (newEventListenerList.length === 0) {\r\n            removeListener(eventName);\r\n        } else {\r\n            eventListeners[eventName] = newEventListenerList;\r\n        }\r\n    }\r\n}\r\n\r\n/**\r\n * Notify informs frontend listeners that an event was emitted with the given data\r\n *\r\n * @export\r\n * @param {string} notifyMessage - encoded notification message\r\n\r\n */\r\nexport function EventsNotify(notifyMessage) {\r\n    // Parse the message\r\n    let message;\r\n    try {\r\n        message = JSON.parse(notifyMessage);\r\n    } catch (e) {\r\n        const error = 'Invalid JSON passed to Notify: ' + notifyMessage;\r\n        throw new Error(error);\r\n    }\r\n    notifyListeners(message);\r\n}\r\n\r\n/**\r\n * Emit an event with the given name and data\r\n *\r\n * @export\r\n * @param {string} eventName\r\n */\r\nexport function EventsEmit(eventName) {\r\n\r\n    const payload = {\r\n        name: eventName,\r\n        data: [].slice.apply(arguments).slice(1),\r\n    };\r\n\r\n    // Notify JS listeners\r\n    notifyListeners(payload);\r\n\r\n    // Notify Go listeners\r\n    window.WailsInvoke('EE' + JSON.stringify(payload));\r\n}\r\n\r\nfunction removeListener(eventName) {\r\n    // Remove local listeners\r\n    delete eventListeners[eventName];\r\n\r\n    // Notify Go listeners\r\n    window.WailsInvoke('EX' + eventName);\r\n}\r\n\r\n/**\r\n * Off unregisters a listener previously registered with On,\r\n * optionally multiple listeneres can be unregistered via `additionalEventNames`\r\n *\r\n * @param {string} eventName\r\n * @param  {...string} additionalEventNames\r\n */\r\nexport function EventsOff(eventName, ...additionalEventNames) {\r\n    removeListener(eventName)\r\n\r\n    if (additionalEventNames.length > 0) {\r\n        additionalEventNames.forEach(eventName => {\r\n            removeListener(eventName)\r\n        })\r\n    }\r\n}\r\n\r\n/**\r\n * Off unregisters all event listeners previously registered with On\r\n */\r\n export function EventsOffAll() {\r\n    const eventNames = Object.keys(eventListeners);\r\n    eventNames.forEach(eventName => {\r\n        removeListener(eventName)\r\n    })\r\n}\r\n\r\n/**\r\n * listenerOff unregisters a listener previously registered with EventsOn\r\n *\r\n * @param {Listener} listener\r\n */\r\n function listenerOff(listener) {\r\n    const eventName = listener.eventName;\r\n    if (eventListeners[eventName] === undefined) return;\r\n\r\n    // Remove local listener\r\n    eventListeners[eventName] = eventListeners[eventName].filter(l => l !== listener);\r\n\r\n    // Clean up if there are no event listeners left\r\n    if (eventListeners[eventName].length === 0) {\r\n        removeListener(eventName);\r\n    }\r\n}\r\n", "/*\r\n _       __      _ __\r\n| |     / /___ _(_) /____\r\n| | /| / / __ `/ / / ___/\r\n| |/ |/ / /_/ / / (__  )\r\n|__/|__/\\__,_/_/_/____/\r\nThe electron alternative for Go\r\n(c) Lea Anthony 2019-present\r\n*/\r\n/* jshint esversion: 6 */\r\n\r\nexport const callbacks = {};\r\n\r\n/**\r\n * Returns a number from the native browser random function\r\n *\r\n * @returns number\r\n */\r\nfunction cryptoRandom() {\r\n\tvar array = new Uint32Array(1);\r\n\treturn window.crypto.getRandomValues(array)[0];\r\n}\r\n\r\n/**\r\n * Returns a number using da old-skool Math.Random\r\n * I likes to call it LOLRandom\r\n *\r\n * @returns number\r\n */\r\nfunction basicRandom() {\r\n\treturn Math.random() * 9007199254740991;\r\n}\r\n\r\n// Pick a random number function based on browser capability\r\nvar randomFunc;\r\nif (window.crypto) {\r\n\trandomFunc = cryptoRandom;\r\n} else {\r\n\trandomFunc = basicRandom;\r\n}\r\n\r\n\r\n/**\r\n * Call sends a message to the backend to call the binding with the\r\n * given data. A promise is returned and will be completed when the\r\n * backend responds. This will be resolved when the call was successful\r\n * or rejected if an error is passed back.\r\n * There is a timeout mechanism. If the call doesn't respond in the given\r\n * time (in milliseconds) then the promise is rejected.\r\n *\r\n * @export\r\n * @param {string} name\r\n * @param {any=} args\r\n * @param {number=} timeout\r\n * @returns\r\n */\r\nexport function Call(name, args, timeout) {\r\n\r\n\t// Timeout infinite by default\r\n\tif (timeout == null) {\r\n\t\ttimeout = 0;\r\n\t}\r\n\r\n\t// Create a promise\r\n\treturn new Promise(function (resolve, reject) {\r\n\r\n\t\t// Create a unique callbackID\r\n\t\tvar callbackID;\r\n\t\tdo {\r\n\t\t\tcallbackID = name + '-' + randomFunc();\r\n\t\t} while (callbacks[callbackID]);\r\n\r\n\t\tvar timeoutHandle;\r\n\t\t// Set timeout\r\n\t\tif (timeout > 0) {\r\n\t\t\ttimeoutHandle = setTimeout(function () {\r\n\t\t\t\treject(Error('Call to ' + name + ' timed out. Request ID: ' + callbackID));\r\n\t\t\t}, timeout);\r\n\t\t}\r\n\r\n\t\t// Store callback\r\n\t\tcallbacks[callbackID] = {\r\n\t\t\ttimeoutHandle: timeoutHandle,\r\n\t\t\treject: reject,\r\n\t\t\tresolve: resolve\r\n\t\t};\r\n\r\n\t\ttry {\r\n\t\t\tconst payload = {\r\n\t\t\t\tname,\r\n\t\t\t\targs,\r\n\t\t\t\tcallbackID,\r\n\t\t\t};\r\n\r\n            // Make the call\r\n            window.WailsInvoke('C' + JSON.stringify(payload));\r\n        } catch (e) {\r\n            // eslint-disable-next-line\r\n            console.error(e);\r\n        }\r\n    });\r\n}\r\n\r\nwindow.ObfuscatedCall = (id, args, timeout) => {\r\n\r\n    // Timeout infinite by default\r\n    if (timeout == null) {\r\n        timeout = 0;\r\n    }\r\n\r\n    // Create a promise\r\n    return new Promise(function (resolve, reject) {\r\n\r\n        // Create a unique callbackID\r\n        var callbackID;\r\n        do {\r\n            callbackID = id + '-' + randomFunc();\r\n        } while (callbacks[callbackID]);\r\n\r\n        var timeoutHandle;\r\n        // Set timeout\r\n        if (timeout > 0) {\r\n            timeoutHandle = setTimeout(function () {\r\n                reject(Error('Call to method ' + id + ' timed out. Request ID: ' + callbackID));\r\n            }, timeout);\r\n        }\r\n\r\n        // Store callback\r\n        callbacks[callbackID] = {\r\n            timeoutHandle: timeoutHandle,\r\n            reject: reject,\r\n            resolve: resolve\r\n        };\r\n\r\n        try {\r\n            const payload = {\r\n\t\t\t\tid,\r\n\t\t\t\targs,\r\n\t\t\t\tcallbackID,\r\n\t\t\t};\r\n\r\n            // Make the call\r\n            window.WailsInvoke('c' + JSON.stringify(payload));\r\n        } catch (e) {\r\n            // eslint-disable-next-line\r\n            console.error(e);\r\n        }\r\n    });\r\n};\r\n\r\n\r\n/**\r\n * Called by the backend to return data to a previously called\r\n * binding invocation\r\n *\r\n * @export\r\n * @param {string} incomingMessage\r\n */\r\nexport function Callback(incomingMessage) {\r\n\t// Parse the message\r\n\tlet message;\r\n\ttry {\r\n\t\tmessage = JSON.parse(incomingMessage);\r\n\t} catch (e) {\r\n\t\tconst error = `Invalid JSON passed to callback: ${e.message}. Message: ${incomingMessage}`;\r\n\t\truntime.LogDebug(error);\r\n\t\tthrow new Error(error);\r\n\t}\r\n\tlet callbackID = message.callbackid;\r\n\tlet callbackData = callbacks[callbackID];\r\n\tif (!callbackData) {\r\n\t\tconst error = `Callback '${callbackID}' not registered!!!`;\r\n\t\tconsole.error(error); // eslint-disable-line\r\n\t\tthrow new Error(error);\r\n\t}\r\n\tclearTimeout(callbackData.timeoutHandle);\r\n\r\n\tdelete callbacks[callbackID];\r\n\r\n\tif (message.error) {\r\n\t\tcallbackData.reject(message.error);\r\n\t} else {\r\n\t\tcallbackData.resolve(message.result);\r\n\t}\r\n}\r\n", "/*\r\n _       __      _ __    \r\n| |     / /___ _(_) /____\r\n| | /| / / __ `/ / / ___/\r\n| |/ |/ / /_/ / / (__  ) \r\n|__/|__/\\__,_/_/_/____/  \r\nThe electron alternative for Go\r\n(c) Lea Anthony 2019-present\r\n*/\r\n/* jshint esversion: 6 */\r\n\r\nimport {Call} from './calls';\r\n\r\n// This is where we bind go method wrappers\r\nwindow.go = {};\r\n\r\nexport function SetBindings(bindingsMap) {\r\n\ttry {\r\n\t\tbindingsMap = JSON.parse(bindingsMap);\r\n\t} catch (e) {\r\n\t\tconsole.error(e);\r\n\t}\r\n\r\n\t// Initialise the bindings map\r\n\twindow.go = window.go || {};\r\n\r\n\t// Iterate package names\r\n\tObject.keys(bindingsMap).forEach((packageName) => {\r\n\r\n\t\t// Create inner map if it doesn't exist\r\n\t\twindow.go[packageName] = window.go[packageName] || {};\r\n\r\n\t\t// Iterate struct names\r\n\t\tObject.keys(bindingsMap[packageName]).forEach((structName) => {\r\n\r\n\t\t\t// Create inner map if it doesn't exist\r\n\t\t\twindow.go[packageName][structName] = window.go[packageName][structName] || {};\r\n\r\n\t\t\tObject.keys(bindingsMap[packageName][structName]).forEach((methodName) => {\r\n\r\n\t\t\t\twindow.go[packageName][structName][methodName] = function () {\r\n\r\n\t\t\t\t\t// No timeout by default\r\n\t\t\t\t\tlet timeout = 0;\r\n\r\n\t\t\t\t\t// Actual function\r\n\t\t\t\t\tfunction dynamic() {\r\n\t\t\t\t\t\tconst args = [].slice.call(arguments);\r\n\t\t\t\t\t\treturn Call([packageName, structName, methodName].join('.'), args, timeout);\r\n\t\t\t\t\t}\r\n\r\n\t\t\t\t\t// Allow setting timeout to function\r\n\t\t\t\t\tdynamic.setTimeout = function (newTimeout) {\r\n\t\t\t\t\t\ttimeout = newTimeout;\r\n\t\t\t\t\t};\r\n\r\n\t\t\t\t\t// Allow getting timeout to function\r\n\t\t\t\t\tdynamic.getTimeout = function () {\r\n\t\t\t\t\t\treturn timeout;\r\n\t\t\t\t\t};\r\n\r\n\t\t\t\t\treturn dynamic;\r\n\t\t\t\t}();\r\n\t\t\t});\r\n\t\t});\r\n\t});\r\n}\r\n", "/*\r\n _\t   __\t  _ __\r\n| |\t / /___ _(_) /____\r\n| | /| / / __ `/ / / ___/\r\n| |/ |/ / /_/ / / (__  )\r\n|__/|__/\\__,_/_/_/____/\r\nThe electron alternative for Go\r\n(c) Lea Anthony 2019-present\r\n*/\r\n\r\n/* jshint esversion: 9 */\r\n\r\n\r\nimport {Call} from \"./calls\";\r\n\r\nexport function WindowReload() {\r\n    window.location.reload();\r\n}\r\n\r\nexport function WindowReloadApp() {\r\n    window.WailsInvoke('WR');\r\n}\r\n\r\nexport function WindowSetSystemDefaultTheme() {\r\n    window.WailsInvoke('WASDT');\r\n}\r\n\r\nexport function WindowSetLightTheme() {\r\n    window.WailsInvoke('WALT');\r\n}\r\n\r\nexport function WindowSetDarkTheme() {\r\n    window.WailsInvoke('WADT');\r\n}\r\n\r\n/**\r\n * Place the window in the center of the screen\r\n *\r\n * @export\r\n */\r\nexport function WindowCenter() {\r\n    window.WailsInvoke('Wc');\r\n}\r\n\r\n/**\r\n * Sets the window title\r\n *\r\n * @param {string} title\r\n * @export\r\n */\r\nexport function WindowSetTitle(title) {\r\n    window.WailsInvoke('WT' + title);\r\n}\r\n\r\n/**\r\n * Makes the window go fullscreen\r\n *\r\n * @export\r\n */\r\nexport function WindowFullscreen() {\r\n    window.WailsInvoke('WF');\r\n}\r\n\r\n/**\r\n * Reverts the window from fullscreen\r\n *\r\n * @export\r\n */\r\nexport function WindowUnfullscreen() {\r\n    window.WailsInvoke('Wf');\r\n}\r\n\r\n/**\r\n * Returns the state of the window, i.e. whether the window is in full screen mode or not.\r\n *\r\n * @export\r\n * @return {Promise<boolean>} The state of the window\r\n */\r\nexport function WindowIsFullscreen() {\r\n    return Call(\":wails:WindowIsFullscreen\");\r\n}\r\n\r\n/**\r\n * Set the Size of the window\r\n *\r\n * @export\r\n * @param {number} width\r\n * @param {number} height\r\n */\r\nexport function WindowSetSize(width, height) {\r\n    window.WailsInvoke('Ws:' + width + ':' + height);\r\n}\r\n\r\n/**\r\n * Get the Size of the window\r\n *\r\n * @export\r\n * @return {Promise<{w: number, h: number}>} The size of the window\r\n\r\n */\r\nexport function WindowGetSize() {\r\n    return Call(\":wails:WindowGetSize\");\r\n}\r\n\r\n/**\r\n * Set the maximum size of the window\r\n *\r\n * @export\r\n * @param {number} width\r\n * @param {number} height\r\n */\r\nexport function WindowSetMaxSize(width, height) {\r\n    window.WailsInvoke('WZ:' + width + ':' + height);\r\n}\r\n\r\n/**\r\n * Set the minimum size of the window\r\n *\r\n * @export\r\n * @param {number} width\r\n * @param {number} height\r\n */\r\nexport function WindowSetMinSize(width, height) {\r\n    window.WailsInvoke('Wz:' + width + ':' + height);\r\n}\r\n\r\n\r\n\r\n/**\r\n * Set the window AlwaysOnTop or not on top\r\n *\r\n * @export\r\n */\r\nexport function WindowSetAlwaysOnTop(b) {\r\n\r\n    window.WailsInvoke('WATP:' + (b ? '1' : '0'));\r\n}\r\n\r\n\r\n\r\n\r\n/**\r\n * Set the Position of the window\r\n *\r\n * @export\r\n * @param {number} x\r\n * @param {number} y\r\n */\r\nexport function WindowSetPosition(x, y) {\r\n    window.WailsInvoke('Wp:' + x + ':' + y);\r\n}\r\n\r\n/**\r\n * Get the Position of the window\r\n *\r\n * @export\r\n * @return {Promise<{x: number, y: number}>} The position of the window\r\n */\r\nexport function WindowGetPosition() {\r\n    return Call(\":wails:WindowGetPos\");\r\n}\r\n\r\n/**\r\n * Hide the Window\r\n *\r\n * @export\r\n */\r\nexport function WindowHide() {\r\n    window.WailsInvoke('WH');\r\n}\r\n\r\n/**\r\n * Show the Window\r\n *\r\n * @export\r\n */\r\nexport function WindowShow() {\r\n    window.WailsInvoke('WS');\r\n}\r\n\r\n/**\r\n * Maximise the Window\r\n *\r\n * @export\r\n */\r\nexport function WindowMaximise() {\r\n    window.WailsInvoke('WM');\r\n}\r\n\r\n/**\r\n * Toggle the Maximise of the Window\r\n *\r\n * @export\r\n */\r\nexport function WindowToggleMaximise() {\r\n    window.WailsInvoke('Wt');\r\n}\r\n\r\n/**\r\n * Unmaximise the Window\r\n *\r\n * @export\r\n */\r\nexport function WindowUnmaximise() {\r\n    window.WailsInvoke('WU');\r\n}\r\n\r\n/**\r\n * Returns the state of the window, i.e. whether the window is maximised or not.\r\n *\r\n * @export\r\n * @return {Promise<boolean>} The state of the window\r\n */\r\nexport function WindowIsMaximised() {\r\n    return Call(\":wails:WindowIsMaximised\");\r\n}\r\n\r\n/**\r\n * Minimise the Window\r\n *\r\n * @export\r\n */\r\nexport function WindowMinimise() {\r\n    window.WailsInvoke('Wm');\r\n}\r\n\r\n/**\r\n * Unminimise the Window\r\n *\r\n * @export\r\n */\r\nexport function WindowUnminimise() {\r\n    window.WailsInvoke('Wu');\r\n}\r\n\r\n/**\r\n * Returns the state of the window, i.e. whether the window is minimised or not.\r\n *\r\n * @export\r\n * @return {Promise<boolean>} The state of the window\r\n */\r\nexport function WindowIsMinimised() {\r\n    return Call(\":wails:WindowIsMinimised\");\r\n}\r\n\r\n/**\r\n * Returns the state of the window, i.e. whether the window is normal or not.\r\n *\r\n * @export\r\n * @return {Promise<boolean>} The state of the window\r\n */\r\nexport function WindowIsNormal() {\r\n    return Call(\":wails:WindowIsNormal\");\r\n}\r\n\r\n/**\r\n * Sets the background colour of the window\r\n *\r\n * @export\r\n * @param {number} R Red\r\n * @param {number} G Green\r\n * @param {number} B Blue\r\n * @param {number} A Alpha\r\n */\r\nexport function WindowSetBackgroundColour(R, G, B, A) {\r\n    let rgba = JSON.stringify({r: R || 0, g: G || 0, b: B || 0, a: A || 255});\r\n    window.WailsInvoke('Wr:' + rgba);\r\n}\r\n\r\n", "/*\r\n _\t   __\t  _ __\r\n| |\t / /___ _(_) /____\r\n| | /| / / __ `/ / / ___/\r\n| |/ |/ / /_/ / / (__  )\r\n|__/|__/\\__,_/_/_/____/\r\nThe electron alternative for Go\r\n(c) Lea Anthony 2019-present\r\n*/\r\n\r\n/* jshint esversion: 9 */\r\n\r\n\r\nimport {Call} from \"./calls\";\r\n\r\n\r\n/**\r\n * Gets the all screens. Call this anew each time you want to refresh data from the underlying windowing system.\r\n * @export\r\n * @typedef {import('../wrapper/runtime').Screen} Screen\r\n * @return {Promise<{Screen[]}>} The screens\r\n */\r\nexport function ScreenGetAll() {\r\n    return Call(\":wails:ScreenGetAll\");\r\n}\r\n", "/**\r\n * @description: Use the system default browser to open the url\r\n * @param {string} url \r\n * @return {void}\r\n */\r\nexport function BrowserOpenURL(url) {\r\n  window.WailsInvoke('BO:' + url);\r\n}", "/*\r\n _\t   __\t  _ __\r\n| |\t / /___ _(_) /____\r\n| | /| / / __ `/ / / ___/\r\n| |/ |/ / /_/ / / (__  )\r\n|__/|__/\\__,_/_/_/____/\r\nThe electron alternative for Go\r\n(c) Lea Anthony 2019-present\r\n*/\r\n\r\n/* jshint esversion: 9 */\r\n\r\nimport {Call} from \"./calls\";\r\n\r\n/**\r\n * Set the Size of the window\r\n *\r\n * @export\r\n * @param {string} text\r\n */\r\nexport function ClipboardSetText(text) {\r\n    return Call(\":wails:ClipboardSetText\", [text]);\r\n}\r\n\r\n/**\r\n * Get the text content of the clipboard\r\n *\r\n * @export\r\n * @return {Promise<{string}>} Text content of the clipboard\r\n\r\n */\r\nexport function ClipboardGetText() {\r\n    return Call(\":wails:ClipboardGetText\");\r\n}", "/*\r\n _\t   __\t  _ __\r\n| |\t / /___ _(_) /____\r\n| | /| / / __ `/ / / ___/\r\n| |/ |/ / /_/ / / (__  )\r\n|__/|__/\\__,_/_/_/____/\r\nThe electron alternative for Go\r\n(c) Lea Anthony 2019-present\r\n*/\r\n\r\n/* jshint esversion: 9 */\r\n\r\nimport {EventsOn, EventsOff} from \"./events\";\r\n\r\nconst flags = {\r\n    registered: false,\r\n    defaultUseDropTarget: true,\r\n    useDropTarget: true,\r\n    nextDeactivate: null,\r\n    nextDeactivateTimeout: null,\r\n};\r\n\r\nconst DROP_TARGET_ACTIVE = \"wails-drop-target-active\";\r\n\r\n/**\r\n * checkStyleDropTarget checks if the style has the drop target attribute\r\n * \r\n * @param {CSSStyleDeclaration} style \r\n * @returns \r\n */\r\nfunction checkStyleDropTarget(style) {\r\n    const cssDropValue = style.getPropertyValue(window.wails.flags.cssDropProperty).trim();\r\n    if (cssDropValue) {\r\n        if (cssDropValue === window.wails.flags.cssDropValue) {\r\n            return true;\r\n        }\r\n        // if the element has the drop target attribute, but \r\n        // the value is not correct, terminate finding process.\r\n        // This can be useful to block some child elements from being drop targets.\r\n        return false;\r\n    }\r\n    return false;\r\n}\r\n\r\n/**\r\n * onDragOver is called when the dragover event is emitted.\r\n * @param {DragEvent} e\r\n * @returns\r\n */\r\nfunction onDragOver(e) {\r\n    // Check if this is an external file drop or internal HTML drag\r\n    // External file drops will have \"Files\" in the types array\r\n    // Internal HTML drags typically have \"text/plain\", \"text/html\" or custom types\r\n    const isFileDrop = e.dataTransfer.types.includes(\"Files\");\r\n\r\n    // Only handle external file drops, let internal HTML5 drag-and-drop work normally\r\n    if (!isFileDrop) {\r\n        return;\r\n    }\r\n\r\n    // ALWAYS prevent default for file drops to stop browser navigation\r\n    e.preventDefault();\r\n    e.dataTransfer.dropEffect = 'copy';\r\n\r\n    if (!window.wails.flags.enableWailsDragAndDrop) {\r\n        return;\r\n    }\r\n\r\n    if (!flags.useDropTarget) {\r\n        return;\r\n    }\r\n\r\n    const element = e.target;\r\n\r\n    // Trigger debounce function to deactivate drop targets\r\n    if(flags.nextDeactivate) flags.nextDeactivate();\r\n\r\n    // if the element is null or element is not child of drop target element\r\n    if (!element || !checkStyleDropTarget(getComputedStyle(element))) {\r\n        return;\r\n    }\r\n\r\n    let currentElement = element;\r\n    while (currentElement) {\r\n        // check if currentElement is drop target element\r\n        if (checkStyleDropTarget(getComputedStyle(currentElement))) {\r\n            currentElement.classList.add(DROP_TARGET_ACTIVE);\r\n        }\r\n        currentElement = currentElement.parentElement;\r\n    }\r\n}\r\n\r\n/**\r\n * onDragLeave is called when the dragleave event is emitted.\r\n * @param {DragEvent} e\r\n * @returns\r\n */\r\nfunction onDragLeave(e) {\r\n    // Check if this is an external file drop or internal HTML drag\r\n    const isFileDrop = e.dataTransfer.types.includes(\"Files\");\r\n\r\n    // Only handle external file drops, let internal HTML5 drag-and-drop work normally\r\n    if (!isFileDrop) {\r\n        return;\r\n    }\r\n\r\n    // ALWAYS prevent default for file drops to stop browser navigation\r\n    e.preventDefault();\r\n\r\n    if (!window.wails.flags.enableWailsDragAndDrop) {\r\n        return;\r\n    }\r\n\r\n    if (!flags.useDropTarget) {\r\n        return;\r\n    }\r\n\r\n    // Find the close drop target element\r\n    if (!e.target || !checkStyleDropTarget(getComputedStyle(e.target))) {\r\n        return null;\r\n    }\r\n\r\n    // Trigger debounce function to deactivate drop targets\r\n    if(flags.nextDeactivate) flags.nextDeactivate();\r\n    \r\n    // Use debounce technique to tacle dragleave events on overlapping elements and drop target elements\r\n    flags.nextDeactivate = () => {\r\n        // Deactivate all drop targets, new drop target will be activated on next dragover event\r\n        Array.from(document.getElementsByClassName(DROP_TARGET_ACTIVE)).forEach(el => el.classList.remove(DROP_TARGET_ACTIVE));\r\n        // Reset nextDeactivate\r\n        flags.nextDeactivate = null;\r\n        // Clear timeout\r\n        if (flags.nextDeactivateTimeout) {\r\n            clearTimeout(flags.nextDeactivateTimeout);\r\n            flags.nextDeactivateTimeout = null;\r\n        }\r\n    }\r\n\r\n    // Set timeout to deactivate drop targets if not triggered by next drag event\r\n    flags.nextDeactivateTimeout = setTimeout(() => {\r\n        if(flags.nextDeactivate) flags.nextDeactivate();\r\n    }, 50);\r\n}\r\n\r\n/**\r\n * onDrop is called when the drop event is emitted.\r\n * @param {DragEvent} e\r\n * @returns\r\n */\r\nfunction onDrop(e) {\r\n    // Check if this is an external file drop or internal HTML drag\r\n    const isFileDrop = e.dataTransfer.types.includes(\"Files\");\r\n\r\n    // Only handle external file drops, let internal HTML5 drag-and-drop work normally\r\n    if (!isFileDrop) {\r\n        return;\r\n    }\r\n\r\n    // ALWAYS prevent default for file drops to stop browser navigation\r\n    e.preventDefault();\r\n\r\n    if (!window.wails.flags.enableWailsDragAndDrop) {\r\n        return;\r\n    }\r\n\r\n    if (CanResolveFilePaths()) {\r\n        // process files\r\n        let files = [];\r\n        if (e.dataTransfer.items) {\r\n            files = [...e.dataTransfer.items].map((item, i) => {\r\n                if (item.kind === 'file') {\r\n                    return item.getAsFile();\r\n                }\r\n            });\r\n        } else {\r\n            files = [...e.dataTransfer.files];\r\n        }\r\n        window.runtime.ResolveFilePaths(e.x, e.y, files);\r\n    }\r\n\r\n    if (!flags.useDropTarget) {\r\n        return;\r\n    }\r\n\r\n    // Trigger debounce function to deactivate drop targets\r\n    if(flags.nextDeactivate) flags.nextDeactivate();\r\n\r\n    // Deactivate all drop targets\r\n    Array.from(document.getElementsByClassName(DROP_TARGET_ACTIVE)).forEach(el => el.classList.remove(DROP_TARGET_ACTIVE));\r\n}\r\n\r\n/**\r\n * postMessageWithAdditionalObjects checks the browser's capability of sending postMessageWithAdditionalObjects\r\n *\r\n * @returns {boolean}\r\n * @constructor\r\n */\r\nexport function CanResolveFilePaths() {\r\n    return window.chrome?.webview?.postMessageWithAdditionalObjects != null;\r\n}\r\n\r\n/**\r\n * ResolveFilePaths sends drop events to the GO side to resolve file paths on windows.\r\n *\r\n * @param {number} x\r\n * @param {number} y\r\n * @param {any[]} files\r\n * @constructor\r\n */\r\nexport function ResolveFilePaths(x, y, files) {\r\n    // Only for windows webview2 >= 1.0.1774.30\r\n    // https://learn.microsoft.com/en-us/microsoft-edge/webview2/reference/win32/icorewebview2webmessagereceivedeventargs2?view=webview2-1.0.1823.32#applies-to\r\n    if (window.chrome?.webview?.postMessageWithAdditionalObjects) {\r\n        chrome.webview.postMessageWithAdditionalObjects(`file:drop:${x}:${y}`, files);\r\n    }\r\n}\r\n\r\n/**\r\n * Callback for OnFileDrop returns a slice of file path strings when a drop is finished.\r\n *\r\n * @export\r\n * @callback OnFileDropCallback\r\n * @param {number} x - x coordinate of the drop\r\n * @param {number} y - y coordinate of the drop\r\n * @param {string[]} paths - A list of file paths.\r\n */\r\n\r\n/**\r\n * OnFileDrop listens to drag and drop events and calls the callback with the coordinates of the drop and an array of path strings.\r\n *\r\n * @export\r\n * @param {OnFileDropCallback} callback - Callback for OnFileDrop returns a slice of file path strings when a drop is finished.\r\n * @param {boolean} [useDropTarget=true] - Only call the callback when the drop finished on an element that has the drop target style. (--wails-drop-target)\r\n */\r\nexport function OnFileDrop(callback, useDropTarget) {\r\n    if (typeof callback !== \"function\") {\r\n        console.error(\"DragAndDropCallback is not a function\");\r\n        return;\r\n    }\r\n\r\n    if (flags.registered) {\r\n        return;\r\n    }\r\n    flags.registered = true;\r\n\r\n    const uDTPT = typeof useDropTarget;\r\n    flags.useDropTarget = uDTPT === \"undefined\" || uDTPT !== \"boolean\" ? flags.defaultUseDropTarget : useDropTarget;\r\n    window.addEventListener('dragover', onDragOver);\r\n    window.addEventListener('dragleave', onDragLeave);\r\n    window.addEventListener('drop', onDrop);\r\n\r\n    let cb = callback;\r\n    if (flags.useDropTarget) {\r\n        cb = function (x, y, paths) {\r\n            const element = document.elementFromPoint(x, y)\r\n            // if the element is null or element is not child of drop target element, return null\r\n            if (!element || !checkStyleDropTarget(getComputedStyle(element))) {\r\n                return null;\r\n            }\r\n            callback(x, y, paths);\r\n        }\r\n    }\r\n\r\n    EventsOn(\"wails:file-drop\", cb);\r\n}\r\n\r\n/**\r\n * OnFileDropOff removes the drag and drop listeners and handlers.\r\n */\r\nexport function OnFileDropOff() {\r\n    window.removeEventListener('dragover', onDragOver);\r\n    window.removeEventListener('dragleave', onDragLeave);\r\n    window.removeEventListener('drop', onDrop);\r\n    EventsOff(\"wails:file-drop\");\r\n    flags.registered = false;\r\n}\r\n", "/*\r\n--default-contextmenu: auto; (default) will show the default context menu if contentEditable is true OR text has been selected OR element is input or textarea\r\n--default-contextmenu: show; will always show the default context menu\r\n--default-contextmenu: hide; will always hide the default context menu\r\n\r\nThis rule is inherited like normal CSS rules, so nesting works as expected\r\n*/\r\nexport function processDefaultContextMenu(event) {\r\n    // Process default context menu\r\n    const element = event.target;\r\n    const computedStyle = window.getComputedStyle(element);\r\n    const defaultContextMenuAction = computedStyle.getPropertyValue(\"--default-contextmenu\").trim();\r\n    switch (defaultContextMenuAction) {\r\n        case \"show\":\r\n            return;\r\n        case \"hide\":\r\n            event.preventDefault();\r\n            return;\r\n        default:\r\n            // Check if contentEditable is true\r\n            if (element.isContentEditable) {\r\n                return;\r\n            }\r\n\r\n            // Check if text has been selected and action is on the selected elements\r\n            const selection = window.getSelection();\r\n            const hasSelection = (selection.toString().length > 0)\r\n            if (hasSelection) {\r\n                for (let i = 0; i < selection.rangeCount; i++) {\r\n                    const range = selection.getRangeAt(i);\r\n                    const rects = range.getClientRects();\r\n                    for (let j = 0; j < rects.length; j++) {\r\n                        const rect = rects[j];\r\n                        if (document.elementFromPoint(rect.left, rect.top) === element) {\r\n                            return;\r\n                        }\r\n                    }\r\n                }\r\n            }\r\n            // Check if tagname is input or textarea\r\n            if (element.tagName === \"INPUT\" || element.tagName === \"TEXTAREA\") {\r\n                if (hasSelection || (!element.readOnly && !element.disabled)) {\r\n                    return;\r\n                }\r\n            }\r\n\r\n            // hide default context menu\r\n            event.preventDefault();\r\n    }\r\n}\r\n", "/*\r\n _\t   __\t  _ __\r\n| |\t / /___ _(_) /____\r\n| | /| / / __ `/ / / ___/\r\n| |/ |/ / /_/ / / (__  )\r\n|__/|__/\\__,_/_/_/____/\r\nThe electron alternative for Go\r\n(c) Lea Anthony 2019-present\r\n*/\r\n/* jshint esversion: 9 */\r\nimport * as Log from './log';\r\nimport {\r\n  eventListeners,\r\n  EventsEmit,\r\n  EventsNotify,\r\n  EventsOff,\r\n  EventsOffAll,\r\n  EventsOn,\r\n  EventsOnce,\r\n  EventsOnMultiple,\r\n} from \"./events\";\r\nimport { Call, Callback, callbacks } from './calls';\r\nimport { SetBindings } from \"./bindings\";\r\nimport * as Window from \"./window\";\r\nimport * as Screen from \"./screen\";\r\nimport * as Browser from \"./browser\";\r\nimport * as Clipboard from \"./clipboard\";\r\nimport * as DragAndDrop from \"./draganddrop\";\r\nimport * as ContextMenu from \"./contextmenu\";\r\n\r\nexport function Quit() {\r\n    window.WailsInvoke('Q');\r\n}\r\n\r\nexport function Show() {\r\n    window.WailsInvoke('S');\r\n}\r\n\r\nexport function Hide() {\r\n    window.WailsInvoke('H');\r\n}\r\n\r\nexport function Environment() {\r\n    return Call(\":wails:Environment\");\r\n}\r\n\r\n// The JS runtime\r\nwindow.runtime = {\r\n    ...Log,\r\n    ...Window,\r\n    ...Browser,\r\n    ...Screen,\r\n    ...Clipboard,\r\n    ...DragAndDrop,\r\n    EventsOn,\r\n    EventsOnce,\r\n    EventsOnMultiple,\r\n    EventsEmit,\r\n    EventsOff,\r\n    EventsOffAll,\r\n    Environment,\r\n    Show,\r\n    Hide,\r\n    Quit\r\n};\r\n\r\n// Internal wails endpoints\r\nwindow.wails = {\r\n    Callback,\r\n    EventsNotify,\r\n    SetBindings,\r\n    eventListeners,\r\n    callbacks,\r\n    flags: {\r\n        disableScrollbarDrag: false,\r\n        disableDefaultContextMenu: false,\r\n        enableResize: false,\r\n        defaultCursor: null,\r\n        borderThickness: 6,\r\n        shouldDrag: false,\r\n        deferDragToMouseMove: true,\r\n        cssDragProperty: \"--wails-draggable\",\r\n        cssDragValue: \"drag\",\r\n        cssDropProperty: \"--wails-drop-target\",\r\n        cssDropValue: \"drop\",\r\n        enableWailsDragAndDrop: false,\r\n    }\r\n};\r\n\r\n// Set the bindings\r\nif (window.wailsbindings) {\r\n    window.wails.SetBindings(window.wailsbindings);\r\n    delete window.wails.SetBindings;\r\n}\r\n\r\n// (bool) This is evaluated at build time in package.json\r\nif (!DEBUG) {\r\n    delete window.wailsbindings;\r\n}\r\n\r\nlet dragTest = function(e) {\r\n    var val = window.getComputedStyle(e.target).getPropertyValue(window.wails.flags.cssDragProperty);\r\n    if (val) {\r\n        val = val.trim();\r\n    }\r\n\r\n    if (val !== window.wails.flags.cssDragValue) {\r\n        return false;\r\n    }\r\n\r\n    if (e.buttons !== 1) {\r\n        // Do not start dragging if not the primary button has been clicked.\r\n        return false;\r\n    }\r\n\r\n    if (e.detail !== 1) {\r\n        // Do not start dragging if more than once has been clicked, e.g. when double clicking\r\n        return false;\r\n    }\r\n\r\n    return true;\r\n};\r\n\r\nwindow.wails.setCSSDragProperties = function(property, value) {\r\n    window.wails.flags.cssDragProperty = property;\r\n    window.wails.flags.cssDragValue = value;\r\n}\r\n\r\nwindow.wails.setCSSDropProperties = function(property, value) {\r\n    window.wails.flags.cssDropProperty = property;\r\n    window.wails.flags.cssDropValue = value;\r\n}\r\n\r\nwindow.addEventListener('mousedown', (e) => {\r\n    // Check for resizing\r\n    if (window.wails.flags.resizeEdge) {\r\n        window.WailsInvoke(\"resize:\" + window.wails.flags.resizeEdge);\r\n        e.preventDefault();\r\n        return;\r\n    }\r\n\r\n    if (dragTest(e)) {\r\n        if (window.wails.flags.disableScrollbarDrag) {\r\n            // This checks for clicks on the scroll bar\r\n            if (e.offsetX > e.target.clientWidth || e.offsetY > e.target.clientHeight) {\r\n                return;\r\n            }\r\n        }\r\n        if (window.wails.flags.deferDragToMouseMove) {\r\n            window.wails.flags.shouldDrag = true;\r\n        } else {\r\n            e.preventDefault()\r\n            window.WailsInvoke(\"drag\");\r\n        }\r\n        return;\r\n    } else {\r\n        window.wails.flags.shouldDrag = false;\r\n    }\r\n});\r\n\r\nwindow.addEventListener('mouseup', () => {\r\n    window.wails.flags.shouldDrag = false;\r\n});\r\n\r\nfunction setResize(cursor) {\r\n    document.documentElement.style.cursor = cursor || window.wails.flags.defaultCursor;\r\n    window.wails.flags.resizeEdge = cursor;\r\n}\r\n\r\nwindow.addEventListener('mousemove', function(e) {\r\n    if (window.wails.flags.shouldDrag) {\r\n        window.wails.flags.shouldDrag = false;\r\n        let mousePressed = e.buttons !== undefined ? e.buttons : e.which;\r\n        if (mousePressed > 0) {\r\n            window.WailsInvoke(\"drag\");\r\n            return;\r\n        }\r\n    }\r\n    if (!window.wails.flags.enableResize) {\r\n        return;\r\n    }\r\n    if (window.wails.flags.defaultCursor == null) {\r\n        window.wails.flags.defaultCursor = document.documentElement.style.cursor;\r\n    }\r\n    if (window.outerWidth - e.clientX < window.wails.flags.borderThickness && window.outerHeight - e.clientY < window.wails.flags.borderThickness) {\r\n        document.documentElement.style.cursor = \"se-resize\";\r\n    }\r\n    let rightBorder = window.outerWidth - e.clientX < window.wails.flags.borderThickness;\r\n    let leftBorder = e.clientX < window.wails.flags.borderThickness;\r\n    let topBorder = e.clientY < window.wails.flags.borderThickness;\r\n    let bottomBorder = window.outerHeight - e.clientY < window.wails.flags.borderThickness;\r\n\r\n    // If we aren't on an edge, but were, reset the cursor to default\r\n    if (!leftBorder && !rightBorder && !topBorder && !bottomBorder && window.wails.flags.resizeEdge !== undefined) {\r\n        setResize();\r\n    } else if (rightBorder && bottomBorder) setResize(\"se-resize\");\r\n    else if (leftBorder && bottomBorder) setResize(\"sw-resize\");\r\n    else if (leftBorder && topBorder) setResize(\"nw-resize\");\r\n    else if (topBorder && rightBorder) setResize(\"ne-resize\");\r\n    else if (leftBorder) setResize(\"w-resize\");\r\n    else if (topBorder) setResize(\"n-resize\");\r\n    else if (bottomBorder) setResize(\"s-resize\");\r\n    else if (rightBorder) setResize(\"e-resize\");\r\n\r\n});\r\n\r\n// Setup context menu hook\r\nwindow.addEventListener('contextmenu', function(e) {\r\n    // always show the contextmenu in debug & dev\r\n    if (DEBUG) return;\r\n\r\n    if (window.wails.flags.disableDefaultContextMenu) {\r\n        e.preventDefault();\r\n    } else {\r\n        ContextMenu.processDefaultContextMenu(e);\r\n    }\r\n});\r\n\r\nwindow.WailsInvoke(\"runtime:ready\");"],
  "mappings": ";;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAkBA,WAAS,eAAe,OAAO,SAAS;AAIvC,WAAO,YAAY,MAAM,QAAQ,OAAO;AAAA,EACzC;AAQO,WAAS,SAAS,SAAS;AACjC,mBAAe,KAAK,OAAO;AAAA,EAC5B;AAQO,WAAS,SAAS,SAAS;AACjC,mBAAe,KAAK,OAAO;AAAA,EAC5B;AAQO,WAAS,SAAS,SAAS;AACjC,mBAAe,KAAK,OAAO;AAAA,EAC5B;AAQO,WAAS,QAAQ,SAAS;AAChC,mBAAe,KAAK,OAAO;AAAA,EAC5B;AAQO,WAAS,WAAW,SAAS;AACnC,mBAAe,KAAK,OAAO;AAAA,EAC5B;AAQO,WAAS,SAAS,SAAS;AACjC,mBAAe,KAAK,OAAO;AAAA,EAC5B;AAQO,WAAS,SAAS,SAAS;AACjC,mBAAe,KAAK,OAAO;AAAA,EAC5B;AAQO,WAAS,YAAY,UAAU;AACrC,mBAAe,KAAK,QAAQ;AAAA,EAC7B;AAGO,MAAM,WAAW;AAAA,IACvB,OAAO;AAAA,IACP,OAAO;AAAA,IACP,MAAM;AAAA,IACN,SAAS;AAAA,IACT,OAAO;AAAA,EACR;;;AC9FA,MAAM,WAAN,MAAe;AAAA,IAQX,YAAY,WAAW,UAAU,cAAc;AAC3C,WAAK,YAAY;AAEjB,WAAK,eAAe,gBAAgB;AAGpC,WAAK,WAAW,CAAC,SAAS;AACtB,iBAAS,MAAM,MAAM,IAAI;AAEzB,YAAI,KAAK,iBAAiB,IAAI;AAC1B,iBAAO;AAAA,QACX;AAEA,aAAK,gBAAgB;AACrB,eAAO,KAAK,iBAAiB;AAAA,MACjC;AAAA,IACJ;AAAA,EACJ;AAEO,MAAM,iBAAiB,CAAC;AAWxB,WAAS,iBAAiB,WAAW,UAAU,cAAc;AAChE,mBAAe,aAAa,eAAe,cAAc,CAAC;AAC1D,UAAM,eAAe,IAAI,SAAS,WAAW,UAAU,YAAY;AACnE,mBAAe,WAAW,KAAK,YAAY;AAC3C,WAAO,MAAM,YAAY,YAAY;AAAA,EACzC;AAUO,WAAS,SAAS,WAAW,UAAU;AAC1C,WAAO,iBAAiB,WAAW,UAAU,EAAE;AAAA,EACnD;AAUO,WAAS,WAAW,WAAW,UAAU;AAC5C,WAAO,iBAAiB,WAAW,UAAU,CAAC;AAAA,EAClD;AAEA,WAAS,gBAAgB,WAAW;AAGhC,QAAI,YAAY,UAAU;AAG1B,UAAM,uBAAuB,eAAe,YAAY,MAAM,KAAK,CAAC;AAGpE,QAAI,qBAAqB,QAAQ;AAG7B,eAAS,QAAQ,qBAAqB,SAAS,GAAG,SAAS,GAAG,SAAS,GAAG;AAGtE,cAAM,WAAW,qBAAqB;AAEtC,YAAI,OAAO,UAAU;AAGrB,cAAM,UAAU,SAAS,SAAS,IAAI;AACtC,YAAI,SAAS;AAET,+BAAqB,OAAO,OAAO,CAAC;AAAA,QACxC;AAAA,MACJ;AAGA,UAAI,qBAAqB,WAAW,GAAG;AACnC,uBAAe,SAAS;AAAA,MAC5B,OAAO;AACH,uBAAe,aAAa;AAAA,MAChC;AAAA,IACJ;AAAA,EACJ;AASO,WAAS,aAAa,eAAe;AAExC,QAAI;AACJ,QAAI;AACA,gBAAU,KAAK,MAAM,aAAa;AAAA,IACtC,SAAS,GAAP;AACE,YAAM,QAAQ,oCAAoC;AAClD,YAAM,IAAI,MAAM,KAAK;AAAA,IACzB;AACA,oBAAgB,OAAO;AAAA,EAC3B;AAQO,WAAS,WAAW,WAAW;AAElC,UAAM,UAAU;AAAA,MACZ,MAAM;AAAA,MACN,MAAM,CAAC,EAAE,MAAM,MAAM,SAAS,EAAE,MAAM,CAAC;AAAA,IAC3C;AAGA,oBAAgB,OAAO;AAGvB,WAAO,YAAY,OAAO,KAAK,UAAU,OAAO,CAAC;AAAA,EACrD;AAEA,WAAS,eAAe,WAAW;AAE/B,WAAO,eAAe;AAGtB,WAAO,YAAY,OAAO,SAAS;AAAA,EACvC;AASO,WAAS,UAAU,cAAc,sBAAsB;AAC1D,mBAAe,SAAS;AAExB,QAAI,qBAAqB,SAAS,GAAG;AACjC,2BAAqB,QAAQ,CAAAA,eAAa;AACtC,uBAAeA,UAAS;AAAA,MAC5B,CAAC;AAAA,IACL;AAAA,EACJ;AAKQ,WAAS,eAAe;AAC5B,UAAM,aAAa,OAAO,KAAK,cAAc;AAC7C,eAAW,QAAQ,eAAa;AAC5B,qBAAe,SAAS;AAAA,IAC5B,CAAC;AAAA,EACL;AAOC,WAAS,YAAY,UAAU;AAC5B,UAAM,YAAY,SAAS;AAC3B,QAAI,eAAe,eAAe;AAAW;AAG7C,mBAAe,aAAa,eAAe,WAAW,OAAO,OAAK,MAAM,QAAQ;AAGhF,QAAI,eAAe,WAAW,WAAW,GAAG;AACxC,qBAAe,SAAS;AAAA,IAC5B;AAAA,EACJ;;;AC1MO,MAAM,YAAY,CAAC;AAO1B,WAAS,eAAe;AACvB,QAAI,QAAQ,IAAI,YAAY,CAAC;AAC7B,WAAO,OAAO,OAAO,gBAAgB,KAAK,EAAE;AAAA,EAC7C;AAQA,WAAS,cAAc;AACtB,WAAO,KAAK,OAAO,IAAI;AAAA,EACxB;AAGA,MAAI;AACJ,MAAI,OAAO,QAAQ;AAClB,iBAAa;AAAA,EACd,OAAO;AACN,iBAAa;AAAA,EACd;AAiBO,WAAS,KAAK,MAAM,MAAM,SAAS;AAGzC,QAAI,WAAW,MAAM;AACpB,gBAAU;AAAA,IACX;AAGA,WAAO,IAAI,QAAQ,SAAU,SAAS,QAAQ;AAG7C,UAAI;AACJ,SAAG;AACF,qBAAa,OAAO,MAAM,WAAW;AAAA,MACtC,SAAS,UAAU;AAEnB,UAAI;AAEJ,UAAI,UAAU,GAAG;AAChB,wBAAgB,WAAW,WAAY;AACtC,iBAAO,MAAM,aAAa,OAAO,6BAA6B,UAAU,CAAC;AAAA,QAC1E,GAAG,OAAO;AAAA,MACX;AAGA,gBAAU,cAAc;AAAA,QACvB;AAAA,QACA;AAAA,QACA;AAAA,MACD;AAEA,UAAI;AACH,cAAM,UAAU;AAAA,UACf;AAAA,UACA;AAAA,UACA;AAAA,QACD;AAGS,eAAO,YAAY,MAAM,KAAK,UAAU,OAAO,CAAC;AAAA,MACpD,SAAS,GAAP;AAEE,gBAAQ,MAAM,CAAC;AAAA,MACnB;AAAA,IACJ,CAAC;AAAA,EACL;AAEA,SAAO,iBAAiB,CAAC,IAAI,MAAM,YAAY;AAG3C,QAAI,WAAW,MAAM;AACjB,gBAAU;AAAA,IACd;AAGA,WAAO,IAAI,QAAQ,SAAU,SAAS,QAAQ;AAG1C,UAAI;AACJ,SAAG;AACC,qBAAa,KAAK,MAAM,WAAW;AAAA,MACvC,SAAS,UAAU;AAEnB,UAAI;AAEJ,UAAI,UAAU,GAAG;AACb,wBAAgB,WAAW,WAAY;AACnC,iBAAO,MAAM,oBAAoB,KAAK,6BAA6B,UAAU,CAAC;AAAA,QAClF,GAAG,OAAO;AAAA,MACd;AAGA,gBAAU,cAAc;AAAA,QACpB;AAAA,QACA;AAAA,QACA;AAAA,MACJ;AAEA,UAAI;AACA,cAAM,UAAU;AAAA,UACxB;AAAA,UACA;AAAA,UACA;AAAA,QACD;AAGS,eAAO,YAAY,MAAM,KAAK,UAAU,OAAO,CAAC;AAAA,MACpD,SAAS,GAAP;AAEE,gBAAQ,MAAM,CAAC;AAAA,MACnB;AAAA,IACJ,CAAC;AAAA,EACL;AAUO,WAAS,SAAS,iBAAiB;AAEzC,QAAI;AACJ,QAAI;AACH,gBAAU,KAAK,MAAM,eAAe;AAAA,IACrC,SAAS,GAAP;AACD,YAAM,QAAQ,oCAAoC,EAAE,qBAAqB;AACzE,cAAQ,SAAS,KAAK;AACtB,YAAM,IAAI,MAAM,KAAK;AAAA,IACtB;AACA,QAAI,aAAa,QAAQ;AACzB,QAAI,eAAe,UAAU;AAC7B,QAAI,CAAC,cAAc;AAClB,YAAM,QAAQ,aAAa;AAC3B,cAAQ,MAAM,KAAK;AACnB,YAAM,IAAI,MAAM,KAAK;AAAA,IACtB;AACA,iBAAa,aAAa,aAAa;AAEvC,WAAO,UAAU;AAEjB,QAAI,QAAQ,OAAO;AAClB,mBAAa,OAAO,QAAQ,KAAK;AAAA,IAClC,OAAO;AACN,mBAAa,QAAQ,QAAQ,MAAM;AAAA,IACpC;AAAA,EACD;;;AC1KA,SAAO,KAAK,CAAC;AAEN,WAAS,YAAY,aAAa;AACxC,QAAI;AACH,oBAAc,KAAK,MAAM,WAAW;AAAA,IACrC,SAAS,GAAP;AACD,cAAQ,MAAM,CAAC;AAAA,IAChB;AAGA,WAAO,KAAK,OAAO,MAAM,CAAC;AAG1B,WAAO,KAAK,WAAW,EAAE,QAAQ,CAAC,gBAAgB;AAGjD,aAAO,GAAG,eAAe,OAAO,GAAG,gBAAgB,CAAC;AAGpD,aAAO,KAAK,YAAY,YAAY,EAAE,QAAQ,CAAC,eAAe;AAG7D,eAAO,GAAG,aAAa,cAAc,OAAO,GAAG,aAAa,eAAe,CAAC;AAE5E,eAAO,KAAK,YAAY,aAAa,WAAW,EAAE,QAAQ,CAAC,eAAe;AAEzE,iBAAO,GAAG,aAAa,YAAY,cAAc,WAAY;AAG5D,gBAAI,UAAU;AAGd,qBAAS,UAAU;AAClB,oBAAM,OAAO,CAAC,EAAE,MAAM,KAAK,SAAS;AACpC,qBAAO,KAAK,CAAC,aAAa,YAAY,UAAU,EAAE,KAAK,GAAG,GAAG,MAAM,OAAO;AAAA,YAC3E;AAGA,oBAAQ,aAAa,SAAU,YAAY;AAC1C,wBAAU;AAAA,YACX;AAGA,oBAAQ,aAAa,WAAY;AAChC,qBAAO;AAAA,YACR;AAEA,mBAAO;AAAA,UACR,EAAE;AAAA,QACH,CAAC;AAAA,MACF,CAAC;AAAA,IACF,CAAC;AAAA,EACF;;;AClEA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAeO,WAAS,eAAe;AAC3B,WAAO,SAAS,OAAO;AAAA,EAC3B;AAEO,WAAS,kBAAkB;AAC9B,WAAO,YAAY,IAAI;AAAA,EAC3B;AAEO,WAAS,8BAA8B;AAC1C,WAAO,YAAY,OAAO;AAAA,EAC9B;AAEO,WAAS,sBAAsB;AAClC,WAAO,YAAY,MAAM;AAAA,EAC7B;AAEO,WAAS,qBAAqB;AACjC,WAAO,YAAY,MAAM;AAAA,EAC7B;AAOO,WAAS,eAAe;AAC3B,WAAO,YAAY,IAAI;AAAA,EAC3B;AAQO,WAAS,eAAe,OAAO;AAClC,WAAO,YAAY,OAAO,KAAK;AAAA,EACnC;AAOO,WAAS,mBAAmB;AAC/B,WAAO,YAAY,IAAI;AAAA,EAC3B;AAOO,WAAS,qBAAqB;AACjC,WAAO,YAAY,IAAI;AAAA,EAC3B;AAQO,WAAS,qBAAqB;AACjC,WAAO,KAAK,2BAA2B;AAAA,EAC3C;AASO,WAAS,cAAc,OAAO,QAAQ;AACzC,WAAO,YAAY,QAAQ,QAAQ,MAAM,MAAM;AAAA,EACnD;AASO,WAAS,gBAAgB;AAC5B,WAAO,KAAK,sBAAsB;AAAA,EACtC;AASO,WAAS,iBAAiB,OAAO,QAAQ;AAC5C,WAAO,YAAY,QAAQ,QAAQ,MAAM,MAAM;AAAA,EACnD;AASO,WAAS,iBAAiB,OAAO,QAAQ;AAC5C,WAAO,YAAY,QAAQ,QAAQ,MAAM,MAAM;AAAA,EACnD;AASO,WAAS,qBAAqB,GAAG;AAEpC,WAAO,YAAY,WAAW,IAAI,MAAM,IAAI;AAAA,EAChD;AAYO,WAAS,kBAAkB,GAAG,GAAG;AACpC,WAAO,YAAY,QAAQ,IAAI,MAAM,CAAC;AAAA,EAC1C;AAQO,WAAS,oBAAoB;AAChC,WAAO,KAAK,qBAAqB;AAAA,EACrC;AAOO,WAAS,aAAa;AACzB,WAAO,YAAY,IAAI;AAAA,EAC3B;AAOO,WAAS,aAAa;AACzB,WAAO,YAAY,IAAI;AAAA,EAC3B;AAOO,WAAS,iBAAiB;AAC7B,WAAO,YAAY,IAAI;AAAA,EAC3B;AAOO,WAAS,uBAAuB;AACnC,WAAO,YAAY,IAAI;AAAA,EAC3B;AAOO,WAAS,mBAAmB;AAC/B,WAAO,YAAY,IAAI;AAAA,EAC3B;AAQO,WAAS,oBAAoB;AAChC,WAAO,KAAK,0BAA0B;AAAA,EAC1C;AAOO,WAAS,iBAAiB;AAC7B,WAAO,YAAY,IAAI;AAAA,EAC3B;AAOO,WAAS,mBAAmB;AAC/B,WAAO,YAAY,IAAI;AAAA,EAC3B;AAQO,WAAS,oBAAoB;AAChC,WAAO,KAAK,0BAA0B;AAAA,EAC1C;AAQO,WAAS,iBAAiB;AAC7B,WAAO,KAAK,uBAAuB;AAAA,EACvC;AAWO,WAAS,0BAA0B,GAAG,GAAG,GAAG,GAAG;AAClD,QAAI,OAAO,KAAK,UAAU,EAAC,GAAG,KAAK,GAAG,GAAG,KAAK,GAAG,GAAG,KAAK,GAAG,GAAG,KAAK,IAAG,CAAC;AACxE,WAAO,YAAY,QAAQ,IAAI;AAAA,EACnC;;;AC3QA;AAAA;AAAA;AAAA;AAsBO,WAAS,eAAe;AAC3B,WAAO,KAAK,qBAAqB;AAAA,EACrC;;;ACxBA;AAAA;AAAA;AAAA;AAKO,WAAS,eAAe,KAAK;AAClC,WAAO,YAAY,QAAQ,GAAG;AAAA,EAChC;;;ACPA;AAAA;AAAA;AAAA;AAAA;AAoBO,WAAS,iBAAiB,MAAM;AACnC,WAAO,KAAK,2BAA2B,CAAC,IAAI,CAAC;AAAA,EACjD;AASO,WAAS,mBAAmB;AAC/B,WAAO,KAAK,yBAAyB;AAAA,EACzC;;;ACjCA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAcA,MAAM,QAAQ;AAAA,IACV,YAAY;AAAA,IACZ,sBAAsB;AAAA,IACtB,eAAe;AAAA,IACf,gBAAgB;AAAA,IAChB,uBAAuB;AAAA,EAC3B;AAEA,MAAM,qBAAqB;AAQ3B,WAAS,qBAAqB,OAAO;AACjC,UAAM,eAAe,MAAM,iBAAiB,OAAO,MAAM,MAAM,eAAe,EAAE,KAAK;AACrF,QAAI,cAAc;AACd,UAAI,iBAAiB,OAAO,MAAM,MAAM,cAAc;AAClD,eAAO;AAAA,MACX;AAIA,aAAO;AAAA,IACX;AACA,WAAO;AAAA,EACX;AAOA,WAAS,WAAW,GAAG;AAInB,UAAM,aAAa,EAAE,aAAa,MAAM,SAAS,OAAO;AAGxD,QAAI,CAAC,YAAY;AACb;AAAA,IACJ;AAGA,MAAE,eAAe;AACjB,MAAE,aAAa,aAAa;AAE5B,QAAI,CAAC,OAAO,MAAM,MAAM,wBAAwB;AAC5C;AAAA,IACJ;AAEA,QAAI,CAAC,MAAM,eAAe;AACtB;AAAA,IACJ;AAEA,UAAM,UAAU,EAAE;AAGlB,QAAG,MAAM;AAAgB,YAAM,eAAe;AAG9C,QAAI,CAAC,WAAW,CAAC,qBAAqB,iBAAiB,OAAO,CAAC,GAAG;AAC9D;AAAA,IACJ;AAEA,QAAI,iBAAiB;AACrB,WAAO,gBAAgB;AAEnB,UAAI,qBAAqB,iBAAiB,cAAc,CAAC,GAAG;AACxD,uBAAe,UAAU,IAAI,kBAAkB;AAAA,MACnD;AACA,uBAAiB,eAAe;AAAA,IACpC;AAAA,EACJ;AAOA,WAAS,YAAY,GAAG;AAEpB,UAAM,aAAa,EAAE,aAAa,MAAM,SAAS,OAAO;AAGxD,QAAI,CAAC,YAAY;AACb;AAAA,IACJ;AAGA,MAAE,eAAe;AAEjB,QAAI,CAAC,OAAO,MAAM,MAAM,wBAAwB;AAC5C;AAAA,IACJ;AAEA,QAAI,CAAC,MAAM,eAAe;AACtB;AAAA,IACJ;AAGA,QAAI,CAAC,EAAE,UAAU,CAAC,qBAAqB,iBAAiB,EAAE,MAAM,CAAC,GAAG;AAChE,aAAO;AAAA,IACX;AAGA,QAAG,MAAM;AAAgB,YAAM,eAAe;AAG9C,UAAM,iBAAiB,MAAM;AAEzB,YAAM,KAAK,SAAS,uBAAuB,kBAAkB,CAAC,EAAE,QAAQ,QAAM,GAAG,UAAU,OAAO,kBAAkB,CAAC;AAErH,YAAM,iBAAiB;AAEvB,UAAI,MAAM,uBAAuB;AAC7B,qBAAa,MAAM,qBAAqB;AACxC,cAAM,wBAAwB;AAAA,MAClC;AAAA,IACJ;AAGA,UAAM,wBAAwB,WAAW,MAAM;AAC3C,UAAG,MAAM;AAAgB,cAAM,eAAe;AAAA,IAClD,GAAG,EAAE;AAAA,EACT;AAOA,WAAS,OAAO,GAAG;AAEf,UAAM,aAAa,EAAE,aAAa,MAAM,SAAS,OAAO;AAGxD,QAAI,CAAC,YAAY;AACb;AAAA,IACJ;AAGA,MAAE,eAAe;AAEjB,QAAI,CAAC,OAAO,MAAM,MAAM,wBAAwB;AAC5C;AAAA,IACJ;AAEA,QAAI,oBAAoB,GAAG;AAEvB,UAAI,QAAQ,CAAC;AACb,UAAI,EAAE,aAAa,OAAO;AACtB,gBAAQ,CAAC,GAAG,EAAE,aAAa,KAAK,EAAE,IAAI,CAAC,MAAM,MAAM;AAC/C,cAAI,KAAK,SAAS,QAAQ;AACtB,mBAAO,KAAK,UAAU;AAAA,UAC1B;AAAA,QACJ,CAAC;AAAA,MACL,OAAO;AACH,gBAAQ,CAAC,GAAG,EAAE,aAAa,KAAK;AAAA,MACpC;AACA,aAAO,QAAQ,iBAAiB,EAAE,GAAG,EAAE,GAAG,KAAK;AAAA,IACnD;AAEA,QAAI,CAAC,MAAM,eAAe;AACtB;AAAA,IACJ;AAGA,QAAG,MAAM;AAAgB,YAAM,eAAe;AAG9C,UAAM,KAAK,SAAS,uBAAuB,kBAAkB,CAAC,EAAE,QAAQ,QAAM,GAAG,UAAU,OAAO,kBAAkB,CAAC;AAAA,EACzH;AAQO,WAAS,sBAAsB;AAClC,WAAO,OAAO,QAAQ,SAAS,oCAAoC;AAAA,EACvE;AAUO,WAAS,iBAAiB,GAAG,GAAG,OAAO;AAG1C,QAAI,OAAO,QAAQ,SAAS,kCAAkC;AAC1D,aAAO,QAAQ,iCAAiC,aAAa,KAAK,KAAK,KAAK;AAAA,IAChF;AAAA,EACJ;AAmBO,WAAS,WAAW,UAAU,eAAe;AAChD,QAAI,OAAO,aAAa,YAAY;AAChC,cAAQ,MAAM,uCAAuC;AACrD;AAAA,IACJ;AAEA,QAAI,MAAM,YAAY;AAClB;AAAA,IACJ;AACA,UAAM,aAAa;AAEnB,UAAM,QAAQ,OAAO;AACrB,UAAM,gBAAgB,UAAU,eAAe,UAAU,YAAY,MAAM,uBAAuB;AAClG,WAAO,iBAAiB,YAAY,UAAU;AAC9C,WAAO,iBAAiB,aAAa,WAAW;AAChD,WAAO,iBAAiB,QAAQ,MAAM;AAEtC,QAAI,KAAK;AACT,QAAI,MAAM,eAAe;AACrB,WAAK,SAAU,GAAG,GAAG,OAAO;AACxB,cAAM,UAAU,SAAS,iBAAiB,GAAG,CAAC;AAE9C,YAAI,CAAC,WAAW,CAAC,qBAAqB,iBAAiB,OAAO,CAAC,GAAG;AAC9D,iBAAO;AAAA,QACX;AACA,iBAAS,GAAG,GAAG,KAAK;AAAA,MACxB;AAAA,IACJ;AAEA,aAAS,mBAAmB,EAAE;AAAA,EAClC;AAKO,WAAS,gBAAgB;AAC5B,WAAO,oBAAoB,YAAY,UAAU;AACjD,WAAO,oBAAoB,aAAa,WAAW;AACnD,WAAO,oBAAoB,QAAQ,MAAM;AACzC,cAAU,iBAAiB;AAC3B,UAAM,aAAa;AAAA,EACvB;;;AC5QO,WAAS,0BAA0B,OAAO;AAE7C,UAAM,UAAU,MAAM;AACtB,UAAM,gBAAgB,OAAO,iBAAiB,OAAO;AACrD,UAAM,2BAA2B,cAAc,iBAAiB,uBAAuB,EAAE,KAAK;AAC9F,YAAQ,0BAA0B;AAAA,MAC9B,KAAK;AACD;AAAA,MACJ,KAAK;AACD,cAAM,eAAe;AACrB;AAAA,MACJ;AAEI,YAAI,QAAQ,mBAAmB;AAC3B;AAAA,QACJ;AAGA,cAAM,YAAY,OAAO,aAAa;AACtC,cAAM,eAAgB,UAAU,SAAS,EAAE,SAAS;AACpD,YAAI,cAAc;AACd,mBAAS,IAAI,GAAG,IAAI,UAAU,YAAY,KAAK;AAC3C,kBAAM,QAAQ,UAAU,WAAW,CAAC;AACpC,kBAAM,QAAQ,MAAM,eAAe;AACnC,qBAAS,IAAI,GAAG,IAAI,MAAM,QAAQ,KAAK;AACnC,oBAAM,OAAO,MAAM;AACnB,kBAAI,SAAS,iBAAiB,KAAK,MAAM,KAAK,GAAG,MAAM,SAAS;AAC5D;AAAA,cACJ;AAAA,YACJ;AAAA,UACJ;AAAA,QACJ;AAEA,YAAI,QAAQ,YAAY,WAAW,QAAQ,YAAY,YAAY;AAC/D,cAAI,gBAAiB,CAAC,QAAQ,YAAY,CAAC,QAAQ,UAAW;AAC1D;AAAA,UACJ;AAAA,QACJ;AAGA,cAAM,eAAe;AAAA,IAC7B;AAAA,EACJ;;;ACnBO,WAAS,OAAO;AACnB,WAAO,YAAY,GAAG;AAAA,EAC1B;AAEO,WAAS,OAAO;AACnB,WAAO,YAAY,GAAG;AAAA,EAC1B;AAEO,WAAS,OAAO;AACnB,WAAO,YAAY,GAAG;AAAA,EAC1B;AAEO,WAAS,cAAc;AAC1B,WAAO,KAAK,oBAAoB;AAAA,EACpC;AAGA,SAAO,UAAU;AAAA,IACb,GAAG;AAAA,IACH,GAAG;AAAA,IACH,GAAG;AAAA,IACH,GAAG;AAAA,IACH,GAAG;AAAA,IACH,GAAG;AAAA,IACH;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,EACJ;AAGA,SAAO,QAAQ;AAAA,IACX;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA,OAAO;AAAA,MACH,sBAAsB;AAAA,MACtB,2BAA2B;AAAA,MAC3B,cAAc;AAAA,MACd,eAAe;AAAA,MACf,iBAAiB;AAAA,MACjB,YAAY;AAAA,MACZ,sBAAsB;AAAA,MACtB,iBAAiB;AAAA,MACjB,cAAc;AAAA,MACd,iBAAiB;AAAA,MACjB,cAAc;AAAA,MACd,wBAAwB;AAAA,IAC5B;AAAA,EACJ;AAGA,MAAI,OAAO,eAAe;AACtB,WAAO,MAAM,YAAY,OAAO,aAAa;AAC7C,WAAO,OAAO,MAAM;AAAA,EACxB;AAGA,MAAI,OAAQ;AACR,WAAO,OAAO;AAAA,EAClB;AAEA,MAAI,WAAW,SAAS,GAAG;AACvB,QAAI,MAAM,OAAO,iBAAiB,EAAE,MAAM,EAAE,iBAAiB,OAAO,MAAM,MAAM,eAAe;AAC/F,QAAI,KAAK;AACL,YAAM,IAAI,KAAK;AAAA,IACnB;AAEA,QAAI,QAAQ,OAAO,MAAM,MAAM,cAAc;AACzC,aAAO;AAAA,IACX;AAEA,QAAI,EAAE,YAAY,GAAG;AAEjB,aAAO;AAAA,IACX;AAEA,QAAI,EAAE,WAAW,GAAG;AAEhB,aAAO;AAAA,IACX;AAEA,WAAO;AAAA,EACX;AAEA,SAAO,MAAM,uBAAuB,SAAS,UAAU,OAAO;AAC1D,WAAO,MAAM,MAAM,kBAAkB;AACrC,WAAO,MAAM,MAAM,eAAe;AAAA,EACtC;AAEA,SAAO,MAAM,uBAAuB,SAAS,UAAU,OAAO;AAC1D,WAAO,MAAM,MAAM,kBAAkB;AACrC,WAAO,MAAM,MAAM,eAAe;AAAA,EACtC;AAEA,SAAO,iBAAiB,aAAa,CAAC,MAAM;AAExC,QAAI,OAAO,MAAM,MAAM,YAAY;AAC/B,aAAO,YAAY,YAAY,OAAO,MAAM,MAAM,UAAU;AAC5D,QAAE,eAAe;AACjB;AAAA,IACJ;AAEA,QAAI,SAAS,CAAC,GAAG;AACb,UAAI,OAAO,MAAM,MAAM,sBAAsB;AAEzC,YAAI,EAAE,UAAU,EAAE,OAAO,eAAe,EAAE,UAAU,EAAE,OAAO,cAAc;AACvE;AAAA,QACJ;AAAA,MACJ;AACA,UAAI,OAAO,MAAM,MAAM,sBAAsB;AACzC,eAAO,MAAM,MAAM,aAAa;AAAA,MACpC,OAAO;AACH,UAAE,eAAe;AACjB,eAAO,YAAY,MAAM;AAAA,MAC7B;AACA;AAAA,IACJ,OAAO;AACH,aAAO,MAAM,MAAM,aAAa;AAAA,IACpC;AAAA,EACJ,CAAC;AAED,SAAO,iBAAiB,WAAW,MAAM;AACrC,WAAO,MAAM,MAAM,aAAa;AAAA,EACpC,CAAC;AAED,WAAS,UAAU,QAAQ;AACvB,aAAS,gBAAgB,MAAM,SAAS,UAAU,OAAO,MAAM,MAAM;AACrE,WAAO,MAAM,MAAM,aAAa;AAAA,EACpC;AAEA,SAAO,iBAAiB,aAAa,SAAS,GAAG;AAC7C,QAAI,OAAO,MAAM,MAAM,YAAY;AAC/B,aAAO,MAAM,MAAM,aAAa;AAChC,UAAI,eAAe,EAAE,YAAY,SAAY,EAAE,UAAU,EAAE;AAC3D,UAAI,eAAe,GAAG;AAClB,eAAO,YAAY,MAAM;AACzB;AAAA,MACJ;AAAA,IACJ;AACA,QAAI,CAAC,OAAO,MAAM,MAAM,cAAc;AAClC;AAAA,IACJ;AACA,QAAI,OAAO,MAAM,MAAM,iBAAiB,MAAM;AAC1C,aAAO,MAAM,MAAM,gBAAgB,SAAS,gBAAgB,MAAM;AAAA,IACtE;AACA,QAAI,OAAO,aAAa,EAAE,UAAU,OAAO,MAAM,MAAM,mBAAmB,OAAO,cAAc,EAAE,UAAU,OAAO,MAAM,MAAM,iBAAiB;AAC3I,eAAS,gBAAgB,MAAM,SAAS;AAAA,IAC5C;AACA,QAAI,cAAc,OAAO,aAAa,EAAE,UAAU,OAAO,MAAM,MAAM;AACrE,QAAI,aAAa,EAAE,UAAU,OAAO,MAAM,MAAM;AAChD,QAAI,YAAY,EAAE,UAAU,OAAO,MAAM,MAAM;AAC/C,QAAI,eAAe,OAAO,cAAc,EAAE,UAAU,OAAO,MAAM,MAAM;AAGvE,QAAI,CAAC,cAAc,CAAC,eAAe,CAAC,aAAa,CAAC,gBAAgB,OAAO,MAAM,MAAM,eAAe,QAAW;AAC3G,gBAAU;AAAA,IACd,WAAW,eAAe;AAAc,gBAAU,WAAW;AAAA,aACpD,cAAc;AAAc,gBAAU,WAAW;AAAA,aACjD,cAAc;AAAW,gBAAU,WAAW;AAAA,aAC9C,aAAa;AAAa,gBAAU,WAAW;AAAA,aAC/C;AAAY,gBAAU,UAAU;AAAA,aAChC;AAAW,gBAAU,UAAU;AAAA,aAC/B;AAAc,gBAAU,UAAU;AAAA,aAClC;AAAa,gBAAU,UAAU;AAAA,EAE9C,CAAC;AAGD,SAAO,iBAAiB,eAAe,SAAS,GAAG;AAE/C,QAAI;AAAO;AAEX,QAAI,OAAO,MAAM,MAAM,2BAA2B;AAC9C,QAAE,eAAe;AAAA,IACrB,OAAO;AACH,MAAY,0BAA0B,CAAC;AAAA,IAC3C;AAAA,EACJ,CAAC;AAED,SAAO,YAAY,eAAe;",
  "names": ["eventName"]
}
 +//# sourceMappingURL=data:application/json;base64,{
  "version": 3,
  "sources": ["desktop/log.js", "desktop/events.js", "desktop/calls.js", "desktop/bindings.js", "desktop/window.js", "desktop/screen.js", "desktop/browser.js", "desktop/clipboard.js", "desktop/draganddrop.js", "desktop/contextmenu.js", "desktop/main.js"],
  "sourcesContent": ["/*\n _       __      _ __\n| |     / /___ _(_) /____\n| | /| / / __ `/ / / ___/\n| |/ |/ / /_/ / / (__  )\n|__/|__/\\__,_/_/_/____/\nThe electron alternative for Go\n(c) Lea Anthony 2019-present\n*/\n\n/* jshint esversion: 6 */\n\n/**\n * Sends a log message to the backend with the given level + message\n *\n * @param {string} level\n * @param {string} message\n */\nfunction sendLogMessage(level, message) {\n\n\t// Log Message format:\n\t// l[type][message]\n\twindow.WailsInvoke('L' + level + message);\n}\n\n/**\n * Log the given trace message with the backend\n *\n * @export\n * @param {string} message\n */\nexport function LogTrace(message) {\n\tsendLogMessage('T', message);\n}\n\n/**\n * Log the given message with the backend\n *\n * @export\n * @param {string} message\n */\nexport function LogPrint(message) {\n\tsendLogMessage('P', message);\n}\n\n/**\n * Log the given debug message with the backend\n *\n * @export\n * @param {string} message\n */\nexport function LogDebug(message) {\n\tsendLogMessage('D', message);\n}\n\n/**\n * Log the given info message with the backend\n *\n * @export\n * @param {string} message\n */\nexport function LogInfo(message) {\n\tsendLogMessage('I', message);\n}\n\n/**\n * Log the given warning message with the backend\n *\n * @export\n * @param {string} message\n */\nexport function LogWarning(message) {\n\tsendLogMessage('W', message);\n}\n\n/**\n * Log the given error message with the backend\n *\n * @export\n * @param {string} message\n */\nexport function LogError(message) {\n\tsendLogMessage('E', message);\n}\n\n/**\n * Log the given fatal message with the backend\n *\n * @export\n * @param {string} message\n */\nexport function LogFatal(message) {\n\tsendLogMessage('F', message);\n}\n\n/**\n * Sets the Log level to the given log level\n *\n * @export\n * @param {number} loglevel\n */\nexport function SetLogLevel(loglevel) {\n\tsendLogMessage('S', loglevel);\n}\n\n// Log levels\nexport const LogLevel = {\n\tTRACE: 1,\n\tDEBUG: 2,\n\tINFO: 3,\n\tWARNING: 4,\n\tERROR: 5,\n};\n", "/*\n _       __      _ __\n| |     / /___ _(_) /____\n| | /| / / __ `/ / / ___/\n| |/ |/ / /_/ / / (__  )\n|__/|__/\\__,_/_/_/____/\nThe electron alternative for Go\n(c) Lea Anthony 2019-present\n*/\n/* jshint esversion: 6 */\n\n// Defines a single listener with a maximum number of times to callback\n\n/**\n * The Listener class defines a listener! :-)\n *\n * @class Listener\n */\nclass Listener {\n    /**\n     * Creates an instance of Listener.\n     * @param {string} eventName\n     * @param {function} callback\n     * @param {number} maxCallbacks\n     * @memberof Listener\n     */\n    constructor(eventName, callback, maxCallbacks) {\n        this.eventName = eventName;\n        // Default of -1 means infinite\n        this.maxCallbacks = maxCallbacks || -1;\n        // Callback invokes the callback with the given data\n        // Returns true if this listener should be destroyed\n        this.Callback = (data) => {\n            callback.apply(null, data);\n            // If maxCallbacks is infinite, return false (do not destroy)\n            if (this.maxCallbacks === -1) {\n                return false;\n            }\n            // Decrement maxCallbacks. Return true if now 0, otherwise false\n            this.maxCallbacks -= 1;\n            return this.maxCallbacks === 0;\n        };\n    }\n}\n\nexport const eventListeners = {};\n\n/**\n * Registers an event listener that will be invoked `maxCallbacks` times before being destroyed\n *\n * @export\n * @param {string} eventName\n * @param {function} callback\n * @param {number} maxCallbacks\n * @returns {function} A function to cancel the listener\n */\nexport function EventsOnMultiple(eventName, callback, maxCallbacks) {\n    eventListeners[eventName] = eventListeners[eventName] || [];\n    const thisListener = new Listener(eventName, callback, maxCallbacks);\n    eventListeners[eventName].push(thisListener);\n    return () => listenerOff(thisListener);\n}\n\n/**\n * Registers an event listener that will be invoked every time the event is emitted\n *\n * @export\n * @param {string} eventName\n * @param {function} callback\n * @returns {function} A function to cancel the listener\n */\nexport function EventsOn(eventName, callback) {\n    return EventsOnMultiple(eventName, callback, -1);\n}\n\n/**\n * Registers an event listener that will be invoked once then destroyed\n *\n * @export\n * @param {string} eventName\n * @param {function} callback\n * @returns {function} A function to cancel the listener\n */\nexport function EventsOnce(eventName, callback) {\n    return EventsOnMultiple(eventName, callback, 1);\n}\n\nfunction notifyListeners(eventData) {\n\n    // Get the event name\n    let eventName = eventData.name;\n\n    // Check if we have any listeners for this event\n    if (eventListeners[eventName]) {\n\n        // Keep a list of listener indexes to destroy\n        const newEventListenerList = eventListeners[eventName].slice();\n\n        // Iterate listeners\n        for (let count = eventListeners[eventName].length - 1; count >= 0; count -= 1) {\n\n            // Get next listener\n            const listener = eventListeners[eventName][count];\n\n            let data = eventData.data;\n\n            // Do the callback\n            const destroy = listener.Callback(data);\n            if (destroy) {\n                // if the listener indicated to destroy itself, add it to the destroy list\n                newEventListenerList.splice(count, 1);\n            }\n        }\n\n        // Update callbacks with new list of listeners\n        if (newEventListenerList.length === 0) {\n            removeListener(eventName);\n        } else {\n            eventListeners[eventName] = newEventListenerList;\n        }\n    }\n}\n\n/**\n * Notify informs frontend listeners that an event was emitted with the given data\n *\n * @export\n * @param {string} notifyMessage - encoded notification message\n\n */\nexport function EventsNotify(notifyMessage) {\n    // Parse the message\n    let message;\n    try {\n        message = JSON.parse(notifyMessage);\n    } catch (e) {\n        const error = 'Invalid JSON passed to Notify: ' + notifyMessage;\n        throw new Error(error);\n    }\n    notifyListeners(message);\n}\n\n/**\n * Emit an event with the given name and data\n *\n * @export\n * @param {string} eventName\n */\nexport function EventsEmit(eventName) {\n\n    const payload = {\n        name: eventName,\n        data: [].slice.apply(arguments).slice(1),\n    };\n\n    // Notify JS listeners\n    notifyListeners(payload);\n\n    // Notify Go listeners\n    window.WailsInvoke('EE' + JSON.stringify(payload));\n}\n\nfunction removeListener(eventName) {\n    // Remove local listeners\n    delete eventListeners[eventName];\n\n    // Notify Go listeners\n    window.WailsInvoke('EX' + eventName);\n}\n\n/**\n * Off unregisters a listener previously registered with On,\n * optionally multiple listeneres can be unregistered via `additionalEventNames`\n *\n * @param {string} eventName\n * @param  {...string} additionalEventNames\n */\nexport function EventsOff(eventName, ...additionalEventNames) {\n    removeListener(eventName)\n\n    if (additionalEventNames.length > 0) {\n        additionalEventNames.forEach(eventName => {\n            removeListener(eventName)\n        })\n    }\n}\n\n/**\n * Off unregisters all event listeners previously registered with On\n */\n export function EventsOffAll() {\n    const eventNames = Object.keys(eventListeners);\n    for (let i = 0; i !== eventNames.length; i++) {\n        removeListener(eventNames[i]);\n    }\n}\n\n/**\n * listenerOff unregisters a listener previously registered with EventsOn\n *\n * @param {Listener} listener\n */\n function listenerOff(listener) {\n    const eventName = listener.eventName;\n    // Remove local listener\n    eventListeners[eventName] = eventListeners[eventName].filter(l => l !== listener);\n\n    // Clean up if there are no event listeners left\n    if (eventListeners[eventName].length === 0) {\n        removeListener(eventName);\n    }\n}\n", "/*\n _       __      _ __\n| |     / /___ _(_) /____\n| | /| / / __ `/ / / ___/\n| |/ |/ / /_/ / / (__  )\n|__/|__/\\__,_/_/_/____/\nThe electron alternative for Go\n(c) Lea Anthony 2019-present\n*/\n/* jshint esversion: 6 */\n\nexport const callbacks = {};\n\n/**\n * Returns a number from the native browser random function\n *\n * @returns number\n */\nfunction cryptoRandom() {\n\tvar array = new Uint32Array(1);\n\treturn window.crypto.getRandomValues(array)[0];\n}\n\n/**\n * Returns a number using da old-skool Math.Random\n * I likes to call it LOLRandom\n *\n * @returns number\n */\nfunction basicRandom() {\n\treturn Math.random() * 9007199254740991;\n}\n\n// Pick a random number function based on browser capability\nvar randomFunc;\nif (window.crypto) {\n\trandomFunc = cryptoRandom;\n} else {\n\trandomFunc = basicRandom;\n}\n\n\n/**\n * Call sends a message to the backend to call the binding with the\n * given data. A promise is returned and will be completed when the\n * backend responds. This will be resolved when the call was successful\n * or rejected if an error is passed back.\n * There is a timeout mechanism. If the call doesn't respond in the given\n * time (in milliseconds) then the promise is rejected.\n *\n * @export\n * @param {string} name\n * @param {any=} args\n * @param {number=} timeout\n * @returns\n */\nexport function Call(name, args, timeout) {\n\n\t// Timeout infinite by default\n\tif (timeout == null) {\n\t\ttimeout = 0;\n\t}\n\n\t// Create a promise\n\treturn new Promise(function (resolve, reject) {\n\n\t\t// Create a unique callbackID\n\t\tvar callbackID;\n\t\tdo {\n\t\t\tcallbackID = name + '-' + randomFunc();\n\t\t} while (callbacks[callbackID]);\n\n\t\tvar timeoutHandle;\n\t\t// Set timeout\n\t\tif (timeout > 0) {\n\t\t\ttimeoutHandle = setTimeout(function () {\n\t\t\t\treject(Error('Call to ' + name + ' timed out. Request ID: ' + callbackID));\n\t\t\t}, timeout);\n\t\t}\n\n\t\t// Store callback\n\t\tcallbacks[callbackID] = {\n\t\t\ttimeoutHandle: timeoutHandle,\n\t\t\treject: reject,\n\t\t\tresolve: resolve\n\t\t};\n\n\t\ttry {\n\t\t\tconst payload = {\n\t\t\t\tname,\n\t\t\t\targs,\n\t\t\t\tcallbackID,\n\t\t\t};\n\n            // Make the call\n            window.WailsInvoke('C' + JSON.stringify(payload));\n        } catch (e) {\n            // eslint-disable-next-line\n            console.error(e);\n        }\n    });\n}\n\nwindow.ObfuscatedCall = (id, args, timeout) => {\n\n    // Timeout infinite by default\n    if (timeout == null) {\n        timeout = 0;\n    }\n\n    // Create a promise\n    return new Promise(function (resolve, reject) {\n\n        // Create a unique callbackID\n        var callbackID;\n        do {\n            callbackID = id + '-' + randomFunc();\n        } while (callbacks[callbackID]);\n\n        var timeoutHandle;\n        // Set timeout\n        if (timeout > 0) {\n            timeoutHandle = setTimeout(function () {\n                reject(Error('Call to method ' + id + ' timed out. Request ID: ' + callbackID));\n            }, timeout);\n        }\n\n        // Store callback\n        callbacks[callbackID] = {\n            timeoutHandle: timeoutHandle,\n            reject: reject,\n            resolve: resolve\n        };\n\n        try {\n            const payload = {\n\t\t\t\tid,\n\t\t\t\targs,\n\t\t\t\tcallbackID,\n\t\t\t};\n\n            // Make the call\n            window.WailsInvoke('c' + JSON.stringify(payload));\n        } catch (e) {\n            // eslint-disable-next-line\n            console.error(e);\n        }\n    });\n};\n\n\n/**\n * Called by the backend to return data to a previously called\n * binding invocation\n *\n * @export\n * @param {string} incomingMessage\n */\nexport function Callback(incomingMessage) {\n\t// Parse the message\n\tlet message;\n\ttry {\n\t\tmessage = JSON.parse(incomingMessage);\n\t} catch (e) {\n\t\tconst error = `Invalid JSON passed to callback: ${e.message}. Message: ${incomingMessage}`;\n\t\truntime.LogDebug(error);\n\t\tthrow new Error(error);\n\t}\n\tlet callbackID = message.callbackid;\n\tlet callbackData = callbacks[callbackID];\n\tif (!callbackData) {\n\t\tconst error = `Callback '${callbackID}' not registered!!!`;\n\t\tconsole.error(error); // eslint-disable-line\n\t\tthrow new Error(error);\n\t}\n\tclearTimeout(callbackData.timeoutHandle);\n\n\tdelete callbacks[callbackID];\n\n\tif (message.error) {\n\t\tcallbackData.reject(message.error);\n\t} else {\n\t\tcallbackData.resolve(message.result);\n\t}\n}\n", "/*\n _       __      _ __    \n| |     / /___ _(_) /____\n| | /| / / __ `/ / / ___/\n| |/ |/ / /_/ / / (__  ) \n|__/|__/\\__,_/_/_/____/  \nThe electron alternative for Go\n(c) Lea Anthony 2019-present\n*/\n/* jshint esversion: 6 */\n\nimport {Call} from './calls';\n\n// This is where we bind go method wrappers\nwindow.go = {};\n\nexport function SetBindings(bindingsMap) {\n\ttry {\n\t\tbindingsMap = JSON.parse(bindingsMap);\n\t} catch (e) {\n\t\tconsole.error(e);\n\t}\n\n\t// Initialise the bindings map\n\twindow.go = window.go || {};\n\n\t// Iterate package names\n\tObject.keys(bindingsMap).forEach((packageName) => {\n\n\t\t// Create inner map if it doesn't exist\n\t\twindow.go[packageName] = window.go[packageName] || {};\n\n\t\t// Iterate struct names\n\t\tObject.keys(bindingsMap[packageName]).forEach((structName) => {\n\n\t\t\t// Create inner map if it doesn't exist\n\t\t\twindow.go[packageName][structName] = window.go[packageName][structName] || {};\n\n\t\t\tObject.keys(bindingsMap[packageName][structName]).forEach((methodName) => {\n\n\t\t\t\twindow.go[packageName][structName][methodName] = function () {\n\n\t\t\t\t\t// No timeout by default\n\t\t\t\t\tlet timeout = 0;\n\n\t\t\t\t\t// Actual function\n\t\t\t\t\tfunction dynamic() {\n\t\t\t\t\t\tconst args = [].slice.call(arguments);\n\t\t\t\t\t\treturn Call([packageName, structName, methodName].join('.'), args, timeout);\n\t\t\t\t\t}\n\n\t\t\t\t\t// Allow setting timeout to function\n\t\t\t\t\tdynamic.setTimeout = function (newTimeout) {\n\t\t\t\t\t\ttimeout = newTimeout;\n\t\t\t\t\t};\n\n\t\t\t\t\t// Allow getting timeout to function\n\t\t\t\t\tdynamic.getTimeout = function () {\n\t\t\t\t\t\treturn timeout;\n\t\t\t\t\t};\n\n\t\t\t\t\treturn dynamic;\n\t\t\t\t}();\n\t\t\t});\n\t\t});\n\t});\n}\n", "/*\n _\t   __\t  _ __\n| |\t / /___ _(_) /____\n| | /| / / __ `/ / / ___/\n| |/ |/ / /_/ / / (__  )\n|__/|__/\\__,_/_/_/____/\nThe electron alternative for Go\n(c) Lea Anthony 2019-present\n*/\n\n/* jshint esversion: 9 */\n\n\nimport {Call} from \"./calls\";\n\nexport function WindowReload() {\n    window.location.reload();\n}\n\nexport function WindowReloadApp() {\n    window.WailsInvoke('WR');\n}\n\nexport function WindowSetSystemDefaultTheme() {\n    window.WailsInvoke('WASDT');\n}\n\nexport function WindowSetLightTheme() {\n    window.WailsInvoke('WALT');\n}\n\nexport function WindowSetDarkTheme() {\n    window.WailsInvoke('WADT');\n}\n\n/**\n * Place the window in the center of the screen\n *\n * @export\n */\nexport function WindowCenter() {\n    window.WailsInvoke('Wc');\n}\n\n/**\n * Sets the window title\n *\n * @param {string} title\n * @export\n */\nexport function WindowSetTitle(title) {\n    window.WailsInvoke('WT' + title);\n}\n\n/**\n * Makes the window go fullscreen\n *\n * @export\n */\nexport function WindowFullscreen() {\n    window.WailsInvoke('WF');\n}\n\n/**\n * Reverts the window from fullscreen\n *\n * @export\n */\nexport function WindowUnfullscreen() {\n    window.WailsInvoke('Wf');\n}\n\n/**\n * Returns the state of the window, i.e. whether the window is in full screen mode or not.\n *\n * @export\n * @return {Promise<boolean>} The state of the window\n */\nexport function WindowIsFullscreen() {\n    return Call(\":wails:WindowIsFullscreen\");\n}\n\n/**\n * Set the Size of the window\n *\n * @export\n * @param {number} width\n * @param {number} height\n */\nexport function WindowSetSize(width, height) {\n    window.WailsInvoke('Ws:' + width + ':' + height);\n}\n\n/**\n * Get the Size of the window\n *\n * @export\n * @return {Promise<{w: number, h: number}>} The size of the window\n\n */\nexport function WindowGetSize() {\n    return Call(\":wails:WindowGetSize\");\n}\n\n/**\n * Set the maximum size of the window\n *\n * @export\n * @param {number} width\n * @param {number} height\n */\nexport function WindowSetMaxSize(width, height) {\n    window.WailsInvoke('WZ:' + width + ':' + height);\n}\n\n/**\n * Set the minimum size of the window\n *\n * @export\n * @param {number} width\n * @param {number} height\n */\nexport function WindowSetMinSize(width, height) {\n    window.WailsInvoke('Wz:' + width + ':' + height);\n}\n\n\n\n/**\n * Set the window AlwaysOnTop or not on top\n *\n * @export\n */\nexport function WindowSetAlwaysOnTop(b) {\n\n    window.WailsInvoke('WATP:' + (b ? '1' : '0'));\n}\n\n\n\n\n/**\n * Set the Position of the window\n *\n * @export\n * @param {number} x\n * @param {number} y\n */\nexport function WindowSetPosition(x, y) {\n    window.WailsInvoke('Wp:' + x + ':' + y);\n}\n\n/**\n * Get the Position of the window\n *\n * @export\n * @return {Promise<{x: number, y: number}>} The position of the window\n */\nexport function WindowGetPosition() {\n    return Call(\":wails:WindowGetPos\");\n}\n\n/**\n * Hide the Window\n *\n * @export\n */\nexport function WindowHide() {\n    window.WailsInvoke('WH');\n}\n\n/**\n * Show the Window\n *\n * @export\n */\nexport function WindowShow() {\n    window.WailsInvoke('WS');\n}\n\n/**\n * Maximise the Window\n *\n * @export\n */\nexport function WindowMaximise() {\n    window.WailsInvoke('WM');\n}\n\n/**\n * Toggle the Maximise of the Window\n *\n * @export\n */\nexport function WindowToggleMaximise() {\n    window.WailsInvoke('Wt');\n}\n\n/**\n * Unmaximise the Window\n *\n * @export\n */\nexport function WindowUnmaximise() {\n    window.WailsInvoke('WU');\n}\n\n/**\n * Returns the state of the window, i.e. whether the window is maximised or not.\n *\n * @export\n * @return {Promise<boolean>} The state of the window\n */\nexport function WindowIsMaximised() {\n    return Call(\":wails:WindowIsMaximised\");\n}\n\n/**\n * Minimise the Window\n *\n * @export\n */\nexport function WindowMinimise() {\n    window.WailsInvoke('Wm');\n}\n\n/**\n * Unminimise the Window\n *\n * @export\n */\nexport function WindowUnminimise() {\n    window.WailsInvoke('Wu');\n}\n\n/**\n * Returns the state of the window, i.e. whether the window is minimised or not.\n *\n * @export\n * @return {Promise<boolean>} The state of the window\n */\nexport function WindowIsMinimised() {\n    return Call(\":wails:WindowIsMinimised\");\n}\n\n/**\n * Returns the state of the window, i.e. whether the window is normal or not.\n *\n * @export\n * @return {Promise<boolean>} The state of the window\n */\nexport function WindowIsNormal() {\n    return Call(\":wails:WindowIsNormal\");\n}\n\n/**\n * Sets the background colour of the window\n *\n * @export\n * @param {number} R Red\n * @param {number} G Green\n * @param {number} B Blue\n * @param {number} A Alpha\n */\nexport function WindowSetBackgroundColour(R, G, B, A) {\n    let rgba = JSON.stringify({r: R || 0, g: G || 0, b: B || 0, a: A || 255});\n    window.WailsInvoke('Wr:' + rgba);\n}\n\n", "/*\n _\t   __\t  _ __\n| |\t / /___ _(_) /____\n| | /| / / __ `/ / / ___/\n| |/ |/ / /_/ / / (__  )\n|__/|__/\\__,_/_/_/____/\nThe electron alternative for Go\n(c) Lea Anthony 2019-present\n*/\n\n/* jshint esversion: 9 */\n\n\nimport {Call} from \"./calls\";\n\n\n/**\n * Gets the all screens. Call this anew each time you want to refresh data from the underlying windowing system.\n * @export\n * @typedef {import('../wrapper/runtime').Screen} Screen\n * @return {Promise<{Screen[]}>} The screens\n */\nexport function ScreenGetAll() {\n    return Call(\":wails:ScreenGetAll\");\n}\n", "/**\n * @description: Use the system default browser to open the url\n * @param {string} url \n * @return {void}\n */\nexport function BrowserOpenURL(url) {\n  window.WailsInvoke('BO:' + url);\n}", "/*\n _\t   __\t  _ __\n| |\t / /___ _(_) /____\n| | /| / / __ `/ / / ___/\n| |/ |/ / /_/ / / (__  )\n|__/|__/\\__,_/_/_/____/\nThe electron alternative for Go\n(c) Lea Anthony 2019-present\n*/\n\n/* jshint esversion: 9 */\n\nimport {Call} from \"./calls\";\n\n/**\n * Set the Size of the window\n *\n * @export\n * @param {string} text\n */\nexport function ClipboardSetText(text) {\n    return Call(\":wails:ClipboardSetText\", [text]);\n}\n\n/**\n * Get the text content of the clipboard\n *\n * @export\n * @return {Promise<{string}>} Text content of the clipboard\n\n */\nexport function ClipboardGetText() {\n    return Call(\":wails:ClipboardGetText\");\n}", "/*\n _\t   __\t  _ __\n| |\t / /___ _(_) /____\n| | /| / / __ `/ / / ___/\n| |/ |/ / /_/ / / (__  )\n|__/|__/\\__,_/_/_/____/\nThe electron alternative for Go\n(c) Lea Anthony 2019-present\n*/\n\n/* jshint esversion: 9 */\n\nimport {EventsOn, EventsOff} from \"./events\";\n\nconst flags = {\n    registered: false,\n    defaultUseDropTarget: true,\n    useDropTarget: true,\n    nextDeactivate: null,\n    nextDeactivateTimeout: null,\n};\n\nconst DROP_TARGET_ACTIVE = \"wails-drop-target-active\";\n\n/**\n * checkStyleDropTarget checks if the style has the drop target attribute\n * \n * @param {CSSStyleDeclaration} style \n * @returns \n */\nfunction checkStyleDropTarget(style) {\n    const cssDropValue = style.getPropertyValue(window.wails.flags.cssDropProperty).trim();\n    if (cssDropValue) {\n        if (cssDropValue === window.wails.flags.cssDropValue) {\n            return true;\n        }\n        // if the element has the drop target attribute, but \n        // the value is not correct, terminate finding process.\n        // This can be useful to block some child elements from being drop targets.\n        return false;\n    }\n    return false;\n}\n\n/**\n * onDragOver is called when the dragover event is emitted.\n * @param {DragEvent} e \n * @returns \n */\nfunction onDragOver(e) {\n    if (!window.wails.flags.enableWailsDragAndDrop) {\n        return;\n    }\n    e.preventDefault();\n\n    if (!flags.useDropTarget) {\n        return;\n    }\n\n    const element = e.target;\n\n    // Trigger debounce function to deactivate drop targets\n    if(flags.nextDeactivate) flags.nextDeactivate();\n\n    // if the element is null or element is not child of drop target element\n    if (!element || !checkStyleDropTarget(getComputedStyle(element))) {\n        return;\n    }\n\n    let currentElement = element;\n    while (currentElement) {\n        // check if currentElement is drop target element\n        if (checkStyleDropTarget(currentElement.style)) {\n            currentElement.classList.add(DROP_TARGET_ACTIVE);\n        }\n        currentElement = currentElement.parentElement;\n    }\n}\n\n/**\n * onDragLeave is called when the dragleave event is emitted.\n * @param {DragEvent} e \n * @returns \n */\nfunction onDragLeave(e) {\n    if (!window.wails.flags.enableWailsDragAndDrop) {\n        return;\n    }\n    e.preventDefault();\n\n    if (!flags.useDropTarget) {\n        return;\n    }\n\n    // Find the close drop target element\n    if (!e.target || !checkStyleDropTarget(getComputedStyle(e.target))) {\n        return null;\n    }\n\n    // Trigger debounce function to deactivate drop targets\n    if(flags.nextDeactivate) flags.nextDeactivate();\n    \n    // Use debounce technique to tacle dragleave events on overlapping elements and drop target elements\n    flags.nextDeactivate = () => {\n        // Deactivate all drop targets, new drop target will be activated on next dragover event\n        Array.from(document.getElementsByClassName(DROP_TARGET_ACTIVE)).forEach(el => el.classList.remove(DROP_TARGET_ACTIVE));\n        // Reset nextDeactivate\n        flags.nextDeactivate = null;\n        // Clear timeout\n        if (flags.nextDeactivateTimeout) {\n            clearTimeout(flags.nextDeactivateTimeout);\n            flags.nextDeactivateTimeout = null;\n        }\n    }\n\n    // Set timeout to deactivate drop targets if not triggered by next drag event\n    flags.nextDeactivateTimeout = setTimeout(() => {\n        if(flags.nextDeactivate) flags.nextDeactivate();\n    }, 50);\n}\n\n/**\n * onDrop is called when the drop event is emitted.\n * @param {DragEvent} e \n * @returns \n */\nfunction onDrop(e) {\n    if (!window.wails.flags.enableWailsDragAndDrop) {\n        return;\n    }\n    e.preventDefault();\n\n    if (!flags.useDropTarget) {\n        return;\n    }\n\n    // Trigger debounce function to deactivate drop targets\n    if(flags.nextDeactivate) flags.nextDeactivate();\n\n    // Deactivate all drop targets\n    Array.from(document.getElementsByClassName(DROP_TARGET_ACTIVE)).forEach(el => el.classList.remove(DROP_TARGET_ACTIVE));\n\n    if (CanResolveFilePaths()) {\n        // process files\n        let files = [];\n        if (e.dataTransfer.items) {\n            files = [...e.dataTransfer.items].map((item, i) => {\n                if (item.kind === 'file') {\n                    return item.getAsFile();\n                }\n            });\n        } else {\n            files = [...e.dataTransfer.files];\n        }\n        window.runtime.ResolveFilePaths(e.x, e.y, files);\n    }\n}\n\n/**\n * postMessageWithAdditionalObjects checks the browser's capability of sending postMessageWithAdditionalObjects\n *\n * @returns {boolean}\n * @constructor\n */\nexport function CanResolveFilePaths() {\n    return window.chrome?.webview?.postMessageWithAdditionalObjects != null;\n}\n\n/**\n * ResolveFilePaths sends drop events to the GO side to resolve file paths on windows.\n *\n * @param {number} x\n * @param {number} y\n * @param {any[]} files\n * @constructor\n */\nexport function ResolveFilePaths(x, y, files) {\n    // Only for windows webview2 >= 1.0.1774.30\n    // https://learn.microsoft.com/en-us/microsoft-edge/webview2/reference/win32/icorewebview2webmessagereceivedeventargs2?view=webview2-1.0.1823.32#applies-to\n    if (window.chrome?.webview?.postMessageWithAdditionalObjects) {\n        chrome.webview.postMessageWithAdditionalObjects(`file:drop:${x}:${y}`, files);\n    }\n}\n\n/**\n * Callback for OnFileDrop returns a slice of file path strings when a drop is finished.\n *\n * @export\n * @callback OnFileDropCallback\n * @param {number} x - x coordinate of the drop\n * @param {number} y - y coordinate of the drop\n * @param {string[]} paths - A list of file paths.\n */\n\n/**\n * OnFileDrop listens to drag and drop events and calls the callback with the coordinates of the drop and an array of path strings.\n *\n * @export\n * @param {OnFileDropCallback} callback - Callback for OnFileDrop returns a slice of file path strings when a drop is finished.\n * @param {boolean} [useDropTarget=true] - Only call the callback when the drop finished on an element that has the drop target style. (--wails-drop-target)\n */\nexport function OnFileDrop(callback, useDropTarget) {\n    if (typeof callback !== \"function\") {\n        console.error(\"DragAndDropCallback is not a function\");\n        return;\n    }\n\n    if (flags.registered) {\n        return;\n    }\n    flags.registered = true;\n\n    const uDTPT = typeof useDropTarget;\n    flags.useDropTarget = uDTPT === \"undefined\" || uDTPT !== \"boolean\" ? flags.defaultUseDropTarget : useDropTarget;\n    window.addEventListener('dragover', onDragOver);\n    window.addEventListener('dragleave', onDragLeave);\n    window.addEventListener('drop', onDrop);\n\n    let cb = callback;\n    if (flags.useDropTarget) {\n        cb = function (x, y, paths) {\n            const element = document.elementFromPoint(x, y)\n            // if the element is null or element is not child of drop target element, return null\n            if (!element || !checkStyleDropTarget(getComputedStyle(element))) {\n                return null;\n            }\n            callback(x, y, paths);\n        }\n    }\n\n    EventsOn(\"wails:file-drop\", cb);\n}\n\n/**\n * OnFileDropOff removes the drag and drop listeners and handlers.\n */\nexport function OnFileDropOff() {\n    window.removeEventListener('dragover', onDragOver);\n    window.removeEventListener('dragleave', onDragLeave);\n    window.removeEventListener('drop', onDrop);\n    EventsOff(\"wails:file-drop\");\n    flags.registered = false;\n}\n", "/*\n--default-contextmenu: auto; (default) will show the default context menu if contentEditable is true OR text has been selected OR element is input or textarea\n--default-contextmenu: show; will always show the default context menu\n--default-contextmenu: hide; will always hide the default context menu\n\nThis rule is inherited like normal CSS rules, so nesting works as expected\n*/\nexport function processDefaultContextMenu(event) {\n    // Process default context menu\n    const element = event.target;\n    const computedStyle = window.getComputedStyle(element);\n    const defaultContextMenuAction = computedStyle.getPropertyValue(\"--default-contextmenu\").trim();\n    switch (defaultContextMenuAction) {\n        case \"show\":\n            return;\n        case \"hide\":\n            event.preventDefault();\n            return;\n        default:\n            // Check if contentEditable is true\n            if (element.isContentEditable) {\n                return;\n            }\n\n            // Check if text has been selected and action is on the selected elements\n            const selection = window.getSelection();\n            const hasSelection = (selection.toString().length > 0)\n            if (hasSelection) {\n                for (let i = 0; i < selection.rangeCount; i++) {\n                    const range = selection.getRangeAt(i);\n                    const rects = range.getClientRects();\n                    for (let j = 0; j < rects.length; j++) {\n                        const rect = rects[j];\n                        if (document.elementFromPoint(rect.left, rect.top) === element) {\n                            return;\n                        }\n                    }\n                }\n            }\n            // Check if tagname is input or textarea\n            if (element.tagName === \"INPUT\" || element.tagName === \"TEXTAREA\") {\n                if (hasSelection || (!element.readOnly && !element.disabled)) {\n                    return;\n                }\n            }\n\n            // hide default context menu\n            event.preventDefault();\n    }\n}\n", "/*\n _\t   __\t  _ __\n| |\t / /___ _(_) /____\n| | /| / / __ `/ / / ___/\n| |/ |/ / /_/ / / (__  )\n|__/|__/\\__,_/_/_/____/\nThe electron alternative for Go\n(c) Lea Anthony 2019-present\n*/\n/* jshint esversion: 9 */\nimport * as Log from './log';\nimport {eventListeners, EventsEmit, EventsNotify, EventsOff, EventsOn, EventsOnce, EventsOnMultiple} from './events';\nimport {Call, Callback, callbacks} from './calls';\nimport {SetBindings} from \"./bindings\";\nimport * as Window from \"./window\";\nimport * as Screen from \"./screen\";\nimport * as Browser from \"./browser\";\nimport * as Clipboard from \"./clipboard\";\nimport * as DragAndDrop from \"./draganddrop\";\nimport * as ContextMenu from \"./contextmenu\";\n\nexport function Quit() {\n    window.WailsInvoke('Q');\n}\n\nexport function Show() {\n    window.WailsInvoke('S');\n}\n\nexport function Hide() {\n    window.WailsInvoke('H');\n}\n\nexport function Environment() {\n    return Call(\":wails:Environment\");\n}\n\n// The JS runtime\nwindow.runtime = {\n    ...Log,\n    ...Window,\n    ...Browser,\n    ...Screen,\n    ...Clipboard,\n    ...DragAndDrop,\n    EventsOn,\n    EventsOnce,\n    EventsOnMultiple,\n    EventsEmit,\n    EventsOff,\n    Environment,\n    Show,\n    Hide,\n    Quit\n};\n\n// Internal wails endpoints\nwindow.wails = {\n    Callback,\n    EventsNotify,\n    SetBindings,\n    eventListeners,\n    callbacks,\n    flags: {\n        disableScrollbarDrag: false,\n        disableDefaultContextMenu: false,\n        enableResize: false,\n        defaultCursor: null,\n        borderThickness: 6,\n        shouldDrag: false,\n        deferDragToMouseMove: true,\n        cssDragProperty: \"--wails-draggable\",\n        cssDragValue: \"drag\",\n        cssDropProperty: \"--wails-drop-target\",\n        cssDropValue: \"drop\",\n        enableWailsDragAndDrop: false,\n    }\n};\n\n// Set the bindings\nif (window.wailsbindings) {\n    window.wails.SetBindings(window.wailsbindings);\n    delete window.wails.SetBindings;\n}\n\n// (bool) This is evaluated at build time in package.json\nif (!DEBUG) {\n    delete window.wailsbindings;\n}\n\nlet dragTest = function (e) {\n    var val = window.getComputedStyle(e.target).getPropertyValue(window.wails.flags.cssDragProperty);\n    if (val) {\n      val = val.trim();\n    }\n    \n    if (val !== window.wails.flags.cssDragValue) {\n        return false;\n    }\n\n    if (e.buttons !== 1) {\n        // Do not start dragging if not the primary button has been clicked.\n        return false;\n    }\n\n    if (e.detail !== 1) {\n        // Do not start dragging if more than once has been clicked, e.g. when double clicking\n        return false;\n    }\n\n    return true;\n};\n\nwindow.wails.setCSSDragProperties = function (property, value) {\n    window.wails.flags.cssDragProperty = property;\n    window.wails.flags.cssDragValue = value;\n}\n\nwindow.wails.setCSSDropProperties = function (property, value) {\n    window.wails.flags.cssDropProperty = property;\n    window.wails.flags.cssDropValue = value;\n}\n\nwindow.addEventListener('mousedown', (e) => {\n    // Check for resizing\n    if (window.wails.flags.resizeEdge) {\n        window.WailsInvoke(\"resize:\" + window.wails.flags.resizeEdge);\n        e.preventDefault();\n        return;\n    }\n\n    if (dragTest(e)) {\n        if (window.wails.flags.disableScrollbarDrag) {\n            // This checks for clicks on the scroll bar\n            if (e.offsetX > e.target.clientWidth || e.offsetY > e.target.clientHeight) {\n                return;\n            }\n        }\n        if (window.wails.flags.deferDragToMouseMove) {\n            window.wails.flags.shouldDrag = true;\n        } else {\n            e.preventDefault()\n            window.WailsInvoke(\"drag\");\n        }\n        return;\n    } else {\n        window.wails.flags.shouldDrag = false;\n    }\n});\n\nwindow.addEventListener('mouseup', () => {\n    window.wails.flags.shouldDrag = false;\n});\n\nfunction setResize(cursor) {\n    document.documentElement.style.cursor = cursor || window.wails.flags.defaultCursor;\n    window.wails.flags.resizeEdge = cursor;\n}\n\nwindow.addEventListener('mousemove', function (e) {\n    if (window.wails.flags.shouldDrag) {\n        window.wails.flags.shouldDrag = false;\n        let mousePressed = e.buttons !== undefined ? e.buttons : e.which;\n        if (mousePressed > 0) {\n            window.WailsInvoke(\"drag\");\n            return;\n        }\n    }\n    if (!window.wails.flags.enableResize) {\n        return;\n    }\n    if (window.wails.flags.defaultCursor == null) {\n        window.wails.flags.defaultCursor = document.documentElement.style.cursor;\n    }\n    if (window.outerWidth - e.clientX < window.wails.flags.borderThickness && window.outerHeight - e.clientY < window.wails.flags.borderThickness) {\n        document.documentElement.style.cursor = \"se-resize\";\n    }\n    let rightBorder = window.outerWidth - e.clientX < window.wails.flags.borderThickness;\n    let leftBorder = e.clientX < window.wails.flags.borderThickness;\n    let topBorder = e.clientY < window.wails.flags.borderThickness;\n    let bottomBorder = window.outerHeight - e.clientY < window.wails.flags.borderThickness;\n\n    // If we aren't on an edge, but were, reset the cursor to default\n    if (!leftBorder && !rightBorder && !topBorder && !bottomBorder && window.wails.flags.resizeEdge !== undefined) {\n        setResize();\n    } else if (rightBorder && bottomBorder) setResize(\"se-resize\");\n    else if (leftBorder && bottomBorder) setResize(\"sw-resize\");\n    else if (leftBorder && topBorder) setResize(\"nw-resize\");\n    else if (topBorder && rightBorder) setResize(\"ne-resize\");\n    else if (leftBorder) setResize(\"w-resize\");\n    else if (topBorder) setResize(\"n-resize\");\n    else if (bottomBorder) setResize(\"s-resize\");\n    else if (rightBorder) setResize(\"e-resize\");\n\n});\n\n// Setup context menu hook\nwindow.addEventListener('contextmenu', function (e) {\n    // always show the contextmenu in debug & dev\n    if (DEBUG) return;\n\n    if (window.wails.flags.disableDefaultContextMenu) {\n        e.preventDefault();\n    } else {\n        ContextMenu.processDefaultContextMenu(e);\n    }\n});\n\nwindow.WailsInvoke(\"runtime:ready\");"],
  "mappings": ";;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAkBA,WAAS,eAAe,OAAO,SAAS;AAIvC,WAAO,YAAY,MAAM,QAAQ,OAAO;AAAA,EACzC;AAQO,WAAS,SAAS,SAAS;AACjC,mBAAe,KAAK,OAAO;AAAA,EAC5B;AAQO,WAAS,SAAS,SAAS;AACjC,mBAAe,KAAK,OAAO;AAAA,EAC5B;AAQO,WAAS,SAAS,SAAS;AACjC,mBAAe,KAAK,OAAO;AAAA,EAC5B;AAQO,WAAS,QAAQ,SAAS;AAChC,mBAAe,KAAK,OAAO;AAAA,EAC5B;AAQO,WAAS,WAAW,SAAS;AACnC,mBAAe,KAAK,OAAO;AAAA,EAC5B;AAQO,WAAS,SAAS,SAAS;AACjC,mBAAe,KAAK,OAAO;AAAA,EAC5B;AAQO,WAAS,SAAS,SAAS;AACjC,mBAAe,KAAK,OAAO;AAAA,EAC5B;AAQO,WAAS,YAAY,UAAU;AACrC,mBAAe,KAAK,QAAQ;AAAA,EAC7B;AAGO,MAAM,WAAW;AAAA,IACvB,OAAO;AAAA,IACP,OAAO;AAAA,IACP,MAAM;AAAA,IACN,SAAS;AAAA,IACT,OAAO;AAAA,EACR;;;AC9FA,MAAM,WAAN,MAAe;AAAA,IAQX,YAAY,WAAW,UAAU,cAAc;AAC3C,WAAK,YAAY;AAEjB,WAAK,eAAe,gBAAgB;AAGpC,WAAK,WAAW,CAAC,SAAS;AACtB,iBAAS,MAAM,MAAM,IAAI;AAEzB,YAAI,KAAK,iBAAiB,IAAI;AAC1B,iBAAO;AAAA,QACX;AAEA,aAAK,gBAAgB;AACrB,eAAO,KAAK,iBAAiB;AAAA,MACjC;AAAA,IACJ;AAAA,EACJ;AAEO,MAAM,iBAAiB,CAAC;AAWxB,WAAS,iBAAiB,WAAW,UAAU,cAAc;AAChE,mBAAe,aAAa,eAAe,cAAc,CAAC;AAC1D,UAAM,eAAe,IAAI,SAAS,WAAW,UAAU,YAAY;AACnE,mBAAe,WAAW,KAAK,YAAY;AAC3C,WAAO,MAAM,YAAY,YAAY;AAAA,EACzC;AAUO,WAAS,SAAS,WAAW,UAAU;AAC1C,WAAO,iBAAiB,WAAW,UAAU,EAAE;AAAA,EACnD;AAUO,WAAS,WAAW,WAAW,UAAU;AAC5C,WAAO,iBAAiB,WAAW,UAAU,CAAC;AAAA,EAClD;AAEA,WAAS,gBAAgB,WAAW;AAGhC,QAAI,YAAY,UAAU;AAG1B,QAAI,eAAe,YAAY;AAG3B,YAAM,uBAAuB,eAAe,WAAW,MAAM;AAG7D,eAAS,QAAQ,eAAe,WAAW,SAAS,GAAG,SAAS,GAAG,SAAS,GAAG;AAG3E,cAAM,WAAW,eAAe,WAAW;AAE3C,YAAI,OAAO,UAAU;AAGrB,cAAM,UAAU,SAAS,SAAS,IAAI;AACtC,YAAI,SAAS;AAET,+BAAqB,OAAO,OAAO,CAAC;AAAA,QACxC;AAAA,MACJ;AAGA,UAAI,qBAAqB,WAAW,GAAG;AACnC,uBAAe,SAAS;AAAA,MAC5B,OAAO;AACH,uBAAe,aAAa;AAAA,MAChC;AAAA,IACJ;AAAA,EACJ;AASO,WAAS,aAAa,eAAe;AAExC,QAAI;AACJ,QAAI;AACA,gBAAU,KAAK,MAAM,aAAa;AAAA,IACtC,SAAS,GAAP;AACE,YAAM,QAAQ,oCAAoC;AAClD,YAAM,IAAI,MAAM,KAAK;AAAA,IACzB;AACA,oBAAgB,OAAO;AAAA,EAC3B;AAQO,WAAS,WAAW,WAAW;AAElC,UAAM,UAAU;AAAA,MACZ,MAAM;AAAA,MACN,MAAM,CAAC,EAAE,MAAM,MAAM,SAAS,EAAE,MAAM,CAAC;AAAA,IAC3C;AAGA,oBAAgB,OAAO;AAGvB,WAAO,YAAY,OAAO,KAAK,UAAU,OAAO,CAAC;AAAA,EACrD;AAEA,WAAS,eAAe,WAAW;AAE/B,WAAO,eAAe;AAGtB,WAAO,YAAY,OAAO,SAAS;AAAA,EACvC;AASO,WAAS,UAAU,cAAc,sBAAsB;AAC1D,mBAAe,SAAS;AAExB,QAAI,qBAAqB,SAAS,GAAG;AACjC,2BAAqB,QAAQ,CAAAA,eAAa;AACtC,uBAAeA,UAAS;AAAA,MAC5B,CAAC;AAAA,IACL;AAAA,EACJ;AAiBC,WAAS,YAAY,UAAU;AAC5B,UAAM,YAAY,SAAS;AAE3B,mBAAe,aAAa,eAAe,WAAW,OAAO,OAAK,MAAM,QAAQ;AAGhF,QAAI,eAAe,WAAW,WAAW,GAAG;AACxC,qBAAe,SAAS;AAAA,IAC5B;AAAA,EACJ;;;ACxMO,MAAM,YAAY,CAAC;AAO1B,WAAS,eAAe;AACvB,QAAI,QAAQ,IAAI,YAAY,CAAC;AAC7B,WAAO,OAAO,OAAO,gBAAgB,KAAK,EAAE;AAAA,EAC7C;AAQA,WAAS,cAAc;AACtB,WAAO,KAAK,OAAO,IAAI;AAAA,EACxB;AAGA,MAAI;AACJ,MAAI,OAAO,QAAQ;AAClB,iBAAa;AAAA,EACd,OAAO;AACN,iBAAa;AAAA,EACd;AAiBO,WAAS,KAAK,MAAM,MAAM,SAAS;AAGzC,QAAI,WAAW,MAAM;AACpB,gBAAU;AAAA,IACX;AAGA,WAAO,IAAI,QAAQ,SAAU,SAAS,QAAQ;AAG7C,UAAI;AACJ,SAAG;AACF,qBAAa,OAAO,MAAM,WAAW;AAAA,MACtC,SAAS,UAAU;AAEnB,UAAI;AAEJ,UAAI,UAAU,GAAG;AAChB,wBAAgB,WAAW,WAAY;AACtC,iBAAO,MAAM,aAAa,OAAO,6BAA6B,UAAU,CAAC;AAAA,QAC1E,GAAG,OAAO;AAAA,MACX;AAGA,gBAAU,cAAc;AAAA,QACvB;AAAA,QACA;AAAA,QACA;AAAA,MACD;AAEA,UAAI;AACH,cAAM,UAAU;AAAA,UACf;AAAA,UACA;AAAA,UACA;AAAA,QACD;AAGS,eAAO,YAAY,MAAM,KAAK,UAAU,OAAO,CAAC;AAAA,MACpD,SAAS,GAAP;AAEE,gBAAQ,MAAM,CAAC;AAAA,MACnB;AAAA,IACJ,CAAC;AAAA,EACL;AAEA,SAAO,iBAAiB,CAAC,IAAI,MAAM,YAAY;AAG3C,QAAI,WAAW,MAAM;AACjB,gBAAU;AAAA,IACd;AAGA,WAAO,IAAI,QAAQ,SAAU,SAAS,QAAQ;AAG1C,UAAI;AACJ,SAAG;AACC,qBAAa,KAAK,MAAM,WAAW;AAAA,MACvC,SAAS,UAAU;AAEnB,UAAI;AAEJ,UAAI,UAAU,GAAG;AACb,wBAAgB,WAAW,WAAY;AACnC,iBAAO,MAAM,oBAAoB,KAAK,6BAA6B,UAAU,CAAC;AAAA,QAClF,GAAG,OAAO;AAAA,MACd;AAGA,gBAAU,cAAc;AAAA,QACpB;AAAA,QACA;AAAA,QACA;AAAA,MACJ;AAEA,UAAI;AACA,cAAM,UAAU;AAAA,UACxB;AAAA,UACA;AAAA,UACA;AAAA,QACD;AAGS,eAAO,YAAY,MAAM,KAAK,UAAU,OAAO,CAAC;AAAA,MACpD,SAAS,GAAP;AAEE,gBAAQ,MAAM,CAAC;AAAA,MACnB;AAAA,IACJ,CAAC;AAAA,EACL;AAUO,WAAS,SAAS,iBAAiB;AAEzC,QAAI;AACJ,QAAI;AACH,gBAAU,KAAK,MAAM,eAAe;AAAA,IACrC,SAAS,GAAP;AACD,YAAM,QAAQ,oCAAoC,EAAE,qBAAqB;AACzE,cAAQ,SAAS,KAAK;AACtB,YAAM,IAAI,MAAM,KAAK;AAAA,IACtB;AACA,QAAI,aAAa,QAAQ;AACzB,QAAI,eAAe,UAAU;AAC7B,QAAI,CAAC,cAAc;AAClB,YAAM,QAAQ,aAAa;AAC3B,cAAQ,MAAM,KAAK;AACnB,YAAM,IAAI,MAAM,KAAK;AAAA,IACtB;AACA,iBAAa,aAAa,aAAa;AAEvC,WAAO,UAAU;AAEjB,QAAI,QAAQ,OAAO;AAClB,mBAAa,OAAO,QAAQ,KAAK;AAAA,IAClC,OAAO;AACN,mBAAa,QAAQ,QAAQ,MAAM;AAAA,IACpC;AAAA,EACD;;;AC1KA,SAAO,KAAK,CAAC;AAEN,WAAS,YAAY,aAAa;AACxC,QAAI;AACH,oBAAc,KAAK,MAAM,WAAW;AAAA,IACrC,SAAS,GAAP;AACD,cAAQ,MAAM,CAAC;AAAA,IAChB;AAGA,WAAO,KAAK,OAAO,MAAM,CAAC;AAG1B,WAAO,KAAK,WAAW,EAAE,QAAQ,CAAC,gBAAgB;AAGjD,aAAO,GAAG,eAAe,OAAO,GAAG,gBAAgB,CAAC;AAGpD,aAAO,KAAK,YAAY,YAAY,EAAE,QAAQ,CAAC,eAAe;AAG7D,eAAO,GAAG,aAAa,cAAc,OAAO,GAAG,aAAa,eAAe,CAAC;AAE5E,eAAO,KAAK,YAAY,aAAa,WAAW,EAAE,QAAQ,CAAC,eAAe;AAEzE,iBAAO,GAAG,aAAa,YAAY,cAAc,WAAY;AAG5D,gBAAI,UAAU;AAGd,qBAAS,UAAU;AAClB,oBAAM,OAAO,CAAC,EAAE,MAAM,KAAK,SAAS;AACpC,qBAAO,KAAK,CAAC,aAAa,YAAY,UAAU,EAAE,KAAK,GAAG,GAAG,MAAM,OAAO;AAAA,YAC3E;AAGA,oBAAQ,aAAa,SAAU,YAAY;AAC1C,wBAAU;AAAA,YACX;AAGA,oBAAQ,aAAa,WAAY;AAChC,qBAAO;AAAA,YACR;AAEA,mBAAO;AAAA,UACR,EAAE;AAAA,QACH,CAAC;AAAA,MACF,CAAC;AAAA,IACF,CAAC;AAAA,EACF;;;AClEA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAeO,WAAS,eAAe;AAC3B,WAAO,SAAS,OAAO;AAAA,EAC3B;AAEO,WAAS,kBAAkB;AAC9B,WAAO,YAAY,IAAI;AAAA,EAC3B;AAEO,WAAS,8BAA8B;AAC1C,WAAO,YAAY,OAAO;AAAA,EAC9B;AAEO,WAAS,sBAAsB;AAClC,WAAO,YAAY,MAAM;AAAA,EAC7B;AAEO,WAAS,qBAAqB;AACjC,WAAO,YAAY,MAAM;AAAA,EAC7B;AAOO,WAAS,eAAe;AAC3B,WAAO,YAAY,IAAI;AAAA,EAC3B;AAQO,WAAS,eAAe,OAAO;AAClC,WAAO,YAAY,OAAO,KAAK;AAAA,EACnC;AAOO,WAAS,mBAAmB;AAC/B,WAAO,YAAY,IAAI;AAAA,EAC3B;AAOO,WAAS,qBAAqB;AACjC,WAAO,YAAY,IAAI;AAAA,EAC3B;AAQO,WAAS,qBAAqB;AACjC,WAAO,KAAK,2BAA2B;AAAA,EAC3C;AASO,WAAS,cAAc,OAAO,QAAQ;AACzC,WAAO,YAAY,QAAQ,QAAQ,MAAM,MAAM;AAAA,EACnD;AASO,WAAS,gBAAgB;AAC5B,WAAO,KAAK,sBAAsB;AAAA,EACtC;AASO,WAAS,iBAAiB,OAAO,QAAQ;AAC5C,WAAO,YAAY,QAAQ,QAAQ,MAAM,MAAM;AAAA,EACnD;AASO,WAAS,iBAAiB,OAAO,QAAQ;AAC5C,WAAO,YAAY,QAAQ,QAAQ,MAAM,MAAM;AAAA,EACnD;AASO,WAAS,qBAAqB,GAAG;AAEpC,WAAO,YAAY,WAAW,IAAI,MAAM,IAAI;AAAA,EAChD;AAYO,WAAS,kBAAkB,GAAG,GAAG;AACpC,WAAO,YAAY,QAAQ,IAAI,MAAM,CAAC;AAAA,EAC1C;AAQO,WAAS,oBAAoB;AAChC,WAAO,KAAK,qBAAqB;AAAA,EACrC;AAOO,WAAS,aAAa;AACzB,WAAO,YAAY,IAAI;AAAA,EAC3B;AAOO,WAAS,aAAa;AACzB,WAAO,YAAY,IAAI;AAAA,EAC3B;AAOO,WAAS,iBAAiB;AAC7B,WAAO,YAAY,IAAI;AAAA,EAC3B;AAOO,WAAS,uBAAuB;AACnC,WAAO,YAAY,IAAI;AAAA,EAC3B;AAOO,WAAS,mBAAmB;AAC/B,WAAO,YAAY,IAAI;AAAA,EAC3B;AAQO,WAAS,oBAAoB;AAChC,WAAO,KAAK,0BAA0B;AAAA,EAC1C;AAOO,WAAS,iBAAiB;AAC7B,WAAO,YAAY,IAAI;AAAA,EAC3B;AAOO,WAAS,mBAAmB;AAC/B,WAAO,YAAY,IAAI;AAAA,EAC3B;AAQO,WAAS,oBAAoB;AAChC,WAAO,KAAK,0BAA0B;AAAA,EAC1C;AAQO,WAAS,iBAAiB;AAC7B,WAAO,KAAK,uBAAuB;AAAA,EACvC;AAWO,WAAS,0BAA0B,GAAG,GAAG,GAAG,GAAG;AAClD,QAAI,OAAO,KAAK,UAAU,EAAC,GAAG,KAAK,GAAG,GAAG,KAAK,GAAG,GAAG,KAAK,GAAG,GAAG,KAAK,IAAG,CAAC;AACxE,WAAO,YAAY,QAAQ,IAAI;AAAA,EACnC;;;AC3QA;AAAA;AAAA;AAAA;AAsBO,WAAS,eAAe;AAC3B,WAAO,KAAK,qBAAqB;AAAA,EACrC;;;ACxBA;AAAA;AAAA;AAAA;AAKO,WAAS,eAAe,KAAK;AAClC,WAAO,YAAY,QAAQ,GAAG;AAAA,EAChC;;;ACPA;AAAA;AAAA;AAAA;AAAA;AAoBO,WAAS,iBAAiB,MAAM;AACnC,WAAO,KAAK,2BAA2B,CAAC,IAAI,CAAC;AAAA,EACjD;AASO,WAAS,mBAAmB;AAC/B,WAAO,KAAK,yBAAyB;AAAA,EACzC;;;ACjCA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAcA,MAAM,QAAQ;AAAA,IACV,YAAY;AAAA,IACZ,sBAAsB;AAAA,IACtB,eAAe;AAAA,IACf,gBAAgB;AAAA,IAChB,uBAAuB;AAAA,EAC3B;AAEA,MAAM,qBAAqB;AAQ3B,WAAS,qBAAqB,OAAO;AACjC,UAAM,eAAe,MAAM,iBAAiB,OAAO,MAAM,MAAM,eAAe,EAAE,KAAK;AACrF,QAAI,cAAc;AACd,UAAI,iBAAiB,OAAO,MAAM,MAAM,cAAc;AAClD,eAAO;AAAA,MACX;AAIA,aAAO;AAAA,IACX;AACA,WAAO;AAAA,EACX;AAOA,WAAS,WAAW,GAAG;AACnB,QAAI,CAAC,OAAO,MAAM,MAAM,wBAAwB;AAC5C;AAAA,IACJ;AACA,MAAE,eAAe;AAEjB,QAAI,CAAC,MAAM,eAAe;AACtB;AAAA,IACJ;AAEA,UAAM,UAAU,EAAE;AAGlB,QAAG,MAAM;AAAgB,YAAM,eAAe;AAG9C,QAAI,CAAC,WAAW,CAAC,qBAAqB,iBAAiB,OAAO,CAAC,GAAG;AAC9D;AAAA,IACJ;AAEA,QAAI,iBAAiB;AACrB,WAAO,gBAAgB;AAEnB,UAAI,qBAAqB,eAAe,KAAK,GAAG;AAC5C,uBAAe,UAAU,IAAI,kBAAkB;AAAA,MACnD;AACA,uBAAiB,eAAe;AAAA,IACpC;AAAA,EACJ;AAOA,WAAS,YAAY,GAAG;AACpB,QAAI,CAAC,OAAO,MAAM,MAAM,wBAAwB;AAC5C;AAAA,IACJ;AACA,MAAE,eAAe;AAEjB,QAAI,CAAC,MAAM,eAAe;AACtB;AAAA,IACJ;AAGA,QAAI,CAAC,EAAE,UAAU,CAAC,qBAAqB,iBAAiB,EAAE,MAAM,CAAC,GAAG;AAChE,aAAO;AAAA,IACX;AAGA,QAAG,MAAM;AAAgB,YAAM,eAAe;AAG9C,UAAM,iBAAiB,MAAM;AAEzB,YAAM,KAAK,SAAS,uBAAuB,kBAAkB,CAAC,EAAE,QAAQ,QAAM,GAAG,UAAU,OAAO,kBAAkB,CAAC;AAErH,YAAM,iBAAiB;AAEvB,UAAI,MAAM,uBAAuB;AAC7B,qBAAa,MAAM,qBAAqB;AACxC,cAAM,wBAAwB;AAAA,MAClC;AAAA,IACJ;AAGA,UAAM,wBAAwB,WAAW,MAAM;AAC3C,UAAG,MAAM;AAAgB,cAAM,eAAe;AAAA,IAClD,GAAG,EAAE;AAAA,EACT;AAOA,WAAS,OAAO,GAAG;AACf,QAAI,CAAC,OAAO,MAAM,MAAM,wBAAwB;AAC5C;AAAA,IACJ;AACA,MAAE,eAAe;AAEjB,QAAI,CAAC,MAAM,eAAe;AACtB;AAAA,IACJ;AAGA,QAAG,MAAM;AAAgB,YAAM,eAAe;AAG9C,UAAM,KAAK,SAAS,uBAAuB,kBAAkB,CAAC,EAAE,QAAQ,QAAM,GAAG,UAAU,OAAO,kBAAkB,CAAC;AAErH,QAAI,oBAAoB,GAAG;AAEvB,UAAI,QAAQ,CAAC;AACb,UAAI,EAAE,aAAa,OAAO;AACtB,gBAAQ,CAAC,GAAG,EAAE,aAAa,KAAK,EAAE,IAAI,CAAC,MAAM,MAAM;AAC/C,cAAI,KAAK,SAAS,QAAQ;AACtB,mBAAO,KAAK,UAAU;AAAA,UAC1B;AAAA,QACJ,CAAC;AAAA,MACL,OAAO;AACH,gBAAQ,CAAC,GAAG,EAAE,aAAa,KAAK;AAAA,MACpC;AACA,aAAO,QAAQ,iBAAiB,EAAE,GAAG,EAAE,GAAG,KAAK;AAAA,IACnD;AAAA,EACJ;AAQO,WAAS,sBAAsB;AAClC,WAAO,OAAO,QAAQ,SAAS,oCAAoC;AAAA,EACvE;AAUO,WAAS,iBAAiB,GAAG,GAAG,OAAO;AAG1C,QAAI,OAAO,QAAQ,SAAS,kCAAkC;AAC1D,aAAO,QAAQ,iCAAiC,aAAa,KAAK,KAAK,KAAK;AAAA,IAChF;AAAA,EACJ;AAmBO,WAAS,WAAW,UAAU,eAAe;AAChD,QAAI,OAAO,aAAa,YAAY;AAChC,cAAQ,MAAM,uCAAuC;AACrD;AAAA,IACJ;AAEA,QAAI,MAAM,YAAY;AAClB;AAAA,IACJ;AACA,UAAM,aAAa;AAEnB,UAAM,QAAQ,OAAO;AACrB,UAAM,gBAAgB,UAAU,eAAe,UAAU,YAAY,MAAM,uBAAuB;AAClG,WAAO,iBAAiB,YAAY,UAAU;AAC9C,WAAO,iBAAiB,aAAa,WAAW;AAChD,WAAO,iBAAiB,QAAQ,MAAM;AAEtC,QAAI,KAAK;AACT,QAAI,MAAM,eAAe;AACrB,WAAK,SAAU,GAAG,GAAG,OAAO;AACxB,cAAM,UAAU,SAAS,iBAAiB,GAAG,CAAC;AAE9C,YAAI,CAAC,WAAW,CAAC,qBAAqB,iBAAiB,OAAO,CAAC,GAAG;AAC9D,iBAAO;AAAA,QACX;AACA,iBAAS,GAAG,GAAG,KAAK;AAAA,MACxB;AAAA,IACJ;AAEA,aAAS,mBAAmB,EAAE;AAAA,EAClC;AAKO,WAAS,gBAAgB;AAC5B,WAAO,oBAAoB,YAAY,UAAU;AACjD,WAAO,oBAAoB,aAAa,WAAW;AACnD,WAAO,oBAAoB,QAAQ,MAAM;AACzC,cAAU,iBAAiB;AAC3B,UAAM,aAAa;AAAA,EACvB;;;AC3OO,WAAS,0BAA0B,OAAO;AAE7C,UAAM,UAAU,MAAM;AACtB,UAAM,gBAAgB,OAAO,iBAAiB,OAAO;AACrD,UAAM,2BAA2B,cAAc,iBAAiB,uBAAuB,EAAE,KAAK;AAC9F,YAAQ,0BAA0B;AAAA,MAC9B,KAAK;AACD;AAAA,MACJ,KAAK;AACD,cAAM,eAAe;AACrB;AAAA,MACJ;AAEI,YAAI,QAAQ,mBAAmB;AAC3B;AAAA,QACJ;AAGA,cAAM,YAAY,OAAO,aAAa;AACtC,cAAM,eAAgB,UAAU,SAAS,EAAE,SAAS;AACpD,YAAI,cAAc;AACd,mBAAS,IAAI,GAAG,IAAI,UAAU,YAAY,KAAK;AAC3C,kBAAM,QAAQ,UAAU,WAAW,CAAC;AACpC,kBAAM,QAAQ,MAAM,eAAe;AACnC,qBAAS,IAAI,GAAG,IAAI,MAAM,QAAQ,KAAK;AACnC,oBAAM,OAAO,MAAM;AACnB,kBAAI,SAAS,iBAAiB,KAAK,MAAM,KAAK,GAAG,MAAM,SAAS;AAC5D;AAAA,cACJ;AAAA,YACJ;AAAA,UACJ;AAAA,QACJ;AAEA,YAAI,QAAQ,YAAY,WAAW,QAAQ,YAAY,YAAY;AAC/D,cAAI,gBAAiB,CAAC,QAAQ,YAAY,CAAC,QAAQ,UAAW;AAC1D;AAAA,UACJ;AAAA,QACJ;AAGA,cAAM,eAAe;AAAA,IAC7B;AAAA,EACJ;;;AC5BO,WAAS,OAAO;AACnB,WAAO,YAAY,GAAG;AAAA,EAC1B;AAEO,WAAS,OAAO;AACnB,WAAO,YAAY,GAAG;AAAA,EAC1B;AAEO,WAAS,OAAO;AACnB,WAAO,YAAY,GAAG;AAAA,EAC1B;AAEO,WAAS,cAAc;AAC1B,WAAO,KAAK,oBAAoB;AAAA,EACpC;AAGA,SAAO,UAAU;AAAA,IACb,GAAG;AAAA,IACH,GAAG;AAAA,IACH,GAAG;AAAA,IACH,GAAG;AAAA,IACH,GAAG;AAAA,IACH,GAAG;AAAA,IACH;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,EACJ;AAGA,SAAO,QAAQ;AAAA,IACX;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA,OAAO;AAAA,MACH,sBAAsB;AAAA,MACtB,2BAA2B;AAAA,MAC3B,cAAc;AAAA,MACd,eAAe;AAAA,MACf,iBAAiB;AAAA,MACjB,YAAY;AAAA,MACZ,sBAAsB;AAAA,MACtB,iBAAiB;AAAA,MACjB,cAAc;AAAA,MACd,iBAAiB;AAAA,MACjB,cAAc;AAAA,MACd,wBAAwB;AAAA,IAC5B;AAAA,EACJ;AAGA,MAAI,OAAO,eAAe;AACtB,WAAO,MAAM,YAAY,OAAO,aAAa;AAC7C,WAAO,OAAO,MAAM;AAAA,EACxB;AAGA,MAAI,OAAQ;AACR,WAAO,OAAO;AAAA,EAClB;AAEA,MAAI,WAAW,SAAU,GAAG;AACxB,QAAI,MAAM,OAAO,iBAAiB,EAAE,MAAM,EAAE,iBAAiB,OAAO,MAAM,MAAM,eAAe;AAC/F,QAAI,KAAK;AACP,YAAM,IAAI,KAAK;AAAA,IACjB;AAEA,QAAI,QAAQ,OAAO,MAAM,MAAM,cAAc;AACzC,aAAO;AAAA,IACX;AAEA,QAAI,EAAE,YAAY,GAAG;AAEjB,aAAO;AAAA,IACX;AAEA,QAAI,EAAE,WAAW,GAAG;AAEhB,aAAO;AAAA,IACX;AAEA,WAAO;AAAA,EACX;AAEA,SAAO,MAAM,uBAAuB,SAAU,UAAU,OAAO;AAC3D,WAAO,MAAM,MAAM,kBAAkB;AACrC,WAAO,MAAM,MAAM,eAAe;AAAA,EACtC;AAEA,SAAO,MAAM,uBAAuB,SAAU,UAAU,OAAO;AAC3D,WAAO,MAAM,MAAM,kBAAkB;AACrC,WAAO,MAAM,MAAM,eAAe;AAAA,EACtC;AAEA,SAAO,iBAAiB,aAAa,CAAC,MAAM;AAExC,QAAI,OAAO,MAAM,MAAM,YAAY;AAC/B,aAAO,YAAY,YAAY,OAAO,MAAM,MAAM,UAAU;AAC5D,QAAE,eAAe;AACjB;AAAA,IACJ;AAEA,QAAI,SAAS,CAAC,GAAG;AACb,UAAI,OAAO,MAAM,MAAM,sBAAsB;AAEzC,YAAI,EAAE,UAAU,EAAE,OAAO,eAAe,EAAE,UAAU,EAAE,OAAO,cAAc;AACvE;AAAA,QACJ;AAAA,MACJ;AACA,UAAI,OAAO,MAAM,MAAM,sBAAsB;AACzC,eAAO,MAAM,MAAM,aAAa;AAAA,MACpC,OAAO;AACH,UAAE,eAAe;AACjB,eAAO,YAAY,MAAM;AAAA,MAC7B;AACA;AAAA,IACJ,OAAO;AACH,aAAO,MAAM,MAAM,aAAa;AAAA,IACpC;AAAA,EACJ,CAAC;AAED,SAAO,iBAAiB,WAAW,MAAM;AACrC,WAAO,MAAM,MAAM,aAAa;AAAA,EACpC,CAAC;AAED,WAAS,UAAU,QAAQ;AACvB,aAAS,gBAAgB,MAAM,SAAS,UAAU,OAAO,MAAM,MAAM;AACrE,WAAO,MAAM,MAAM,aAAa;AAAA,EACpC;AAEA,SAAO,iBAAiB,aAAa,SAAU,GAAG;AAC9C,QAAI,OAAO,MAAM,MAAM,YAAY;AAC/B,aAAO,MAAM,MAAM,aAAa;AAChC,UAAI,eAAe,EAAE,YAAY,SAAY,EAAE,UAAU,EAAE;AAC3D,UAAI,eAAe,GAAG;AAClB,eAAO,YAAY,MAAM;AACzB;AAAA,MACJ;AAAA,IACJ;AACA,QAAI,CAAC,OAAO,MAAM,MAAM,cAAc;AAClC;AAAA,IACJ;AACA,QAAI,OAAO,MAAM,MAAM,iBAAiB,MAAM;AAC1C,aAAO,MAAM,MAAM,gBAAgB,SAAS,gBAAgB,MAAM;AAAA,IACtE;AACA,QAAI,OAAO,aAAa,EAAE,UAAU,OAAO,MAAM,MAAM,mBAAmB,OAAO,cAAc,EAAE,UAAU,OAAO,MAAM,MAAM,iBAAiB;AAC3I,eAAS,gBAAgB,MAAM,SAAS;AAAA,IAC5C;AACA,QAAI,cAAc,OAAO,aAAa,EAAE,UAAU,OAAO,MAAM,MAAM;AACrE,QAAI,aAAa,EAAE,UAAU,OAAO,MAAM,MAAM;AAChD,QAAI,YAAY,EAAE,UAAU,OAAO,MAAM,MAAM;AAC/C,QAAI,eAAe,OAAO,cAAc,EAAE,UAAU,OAAO,MAAM,MAAM;AAGvE,QAAI,CAAC,cAAc,CAAC,eAAe,CAAC,aAAa,CAAC,gBAAgB,OAAO,MAAM,MAAM,eAAe,QAAW;AAC3G,gBAAU;AAAA,IACd,WAAW,eAAe;AAAc,gBAAU,WAAW;AAAA,aACpD,cAAc;AAAc,gBAAU,WAAW;AAAA,aACjD,cAAc;AAAW,gBAAU,WAAW;AAAA,aAC9C,aAAa;AAAa,gBAAU,WAAW;AAAA,aAC/C;AAAY,gBAAU,UAAU;AAAA,aAChC;AAAW,gBAAU,UAAU;AAAA,aAC/B;AAAc,gBAAU,UAAU;AAAA,aAClC;AAAa,gBAAU,UAAU;AAAA,EAE9C,CAAC;AAGD,SAAO,iBAAiB,eAAe,SAAU,GAAG;AAEhD,QAAI;AAAO;AAEX,QAAI,OAAO,MAAM,MAAM,2BAA2B;AAC9C,QAAE,eAAe;AAAA,IACrB,OAAO;AACH,MAAY,0BAA0B,CAAC;AAAA,IAC3C;AAAA,EACJ,CAAC;AAED,SAAO,YAAY,eAAe;",
  "names": ["eventName"]
}
 diff --git a/v2/internal/frontend/runtime/runtime_prod_desktop.js b/v2/internal/frontend/runtime/runtime_prod_desktop.js index 3d38924f7..7be603d44 100644 --- a/v2/internal/frontend/runtime/runtime_prod_desktop.js +++ b/v2/internal/frontend/runtime/runtime_prod_desktop.js @@ -1 +1 @@ -(()=>{var j=Object.defineProperty;var p=(e,t)=>{for(var n in t)j(e,n,{get:t[n],enumerable:!0})};var b={};p(b,{LogDebug:()=>$,LogError:()=>Q,LogFatal:()=>_,LogInfo:()=>Y,LogLevel:()=>K,LogPrint:()=>X,LogTrace:()=>J,LogWarning:()=>q,SetLogLevel:()=>Z});function u(e,t){window.WailsInvoke("L"+e+t)}function J(e){u("T",e)}function X(e){u("P",e)}function $(e){u("D",e)}function Y(e){u("I",e)}function q(e){u("W",e)}function Q(e){u("E",e)}function _(e){u("F",e)}function Z(e){u("S",e)}var K={TRACE:1,DEBUG:2,INFO:3,WARNING:4,ERROR:5};var y=class{constructor(t,n,o){this.eventName=t,this.maxCallbacks=o||-1,this.Callback=i=>(n.apply(null,i),this.maxCallbacks===-1?!1:(this.maxCallbacks-=1,this.maxCallbacks===0))}},w={};function v(e,t,n){w[e]=w[e]||[];let o=new y(e,t,n);return w[e].push(o),()=>ee(o)}function W(e,t){return v(e,t,-1)}function A(e,t){return v(e,t,1)}function P(e){let t=e.name,n=w[t]?.slice()||[];if(n.length){for(let o=n.length-1;o>=0;o-=1){let i=n[o],r=e.data;i.Callback(r)&&n.splice(o,1)}n.length===0?g(t):w[t]=n}}function F(e){let t;try{t=JSON.parse(e)}catch{let o="Invalid JSON passed to Notify: "+e;throw new Error(o)}P(t)}function R(e){let t={name:e,data:[].slice.apply(arguments).slice(1)};P(t),window.WailsInvoke("EE"+JSON.stringify(t))}function g(e){delete w[e],window.WailsInvoke("EX"+e)}function x(e,...t){g(e),t.length>0&&t.forEach(n=>{g(n)})}function M(){Object.keys(w).forEach(t=>{g(t)})}function ee(e){let t=e.eventName;w[t]!==void 0&&(w[t]=w[t].filter(n=>n!==e),w[t].length===0&&g(t))}var c={};function te(){var e=new Uint32Array(1);return window.crypto.getRandomValues(e)[0]}function ne(){return Math.random()*9007199254740991}var D;window.crypto?D=te:D=ne;function a(e,t,n){return n==null&&(n=0),new Promise(function(o,i){var r;do r=e+"-"+D();while(c[r]);var l;n>0&&(l=setTimeout(function(){i(Error("Call to "+e+" timed out. Request ID: "+r))},n)),c[r]={timeoutHandle:l,reject:i,resolve:o};try{let d={name:e,args:t,callbackID:r};window.WailsInvoke("C"+JSON.stringify(d))}catch(d){console.error(d)}})}window.ObfuscatedCall=(e,t,n)=>(n==null&&(n=0),new Promise(function(o,i){var r;do r=e+"-"+D();while(c[r]);var l;n>0&&(l=setTimeout(function(){i(Error("Call to method "+e+" timed out. Request ID: "+r))},n)),c[r]={timeoutHandle:l,reject:i,resolve:o};try{let d={id:e,args:t,callbackID:r};window.WailsInvoke("c"+JSON.stringify(d))}catch(d){console.error(d)}}));function z(e){let t;try{t=JSON.parse(e)}catch(i){let r=`Invalid JSON passed to callback: ${i.message}. Message: ${e}`;throw runtime.LogDebug(r),new Error(r)}let n=t.callbackid,o=c[n];if(!o){let i=`Callback '${n}' not registered!!!`;throw console.error(i),new Error(i)}clearTimeout(o.timeoutHandle),delete c[n],t.error?o.reject(t.error):o.resolve(t.result)}window.go={};function B(e){try{e=JSON.parse(e)}catch(t){console.error(t)}window.go=window.go||{},Object.keys(e).forEach(t=>{window.go[t]=window.go[t]||{},Object.keys(e[t]).forEach(n=>{window.go[t][n]=window.go[t][n]||{},Object.keys(e[t][n]).forEach(o=>{window.go[t][n][o]=function(){let i=0;function r(){let l=[].slice.call(arguments);return a([t,n,o].join("."),l,i)}return r.setTimeout=function(l){i=l},r.getTimeout=function(){return i},r}()})})})}var T={};p(T,{WindowCenter:()=>ae,WindowFullscreen:()=>de,WindowGetPosition:()=>xe,WindowGetSize:()=>pe,WindowHide:()=>De,WindowIsFullscreen:()=>ue,WindowIsMaximised:()=>Te,WindowIsMinimised:()=>Ce,WindowIsNormal:()=>Ie,WindowMaximise:()=>Ee,WindowMinimise:()=>Se,WindowReload:()=>oe,WindowReloadApp:()=>ie,WindowSetAlwaysOnTop:()=>ve,WindowSetBackgroundColour:()=>Oe,WindowSetDarkTheme:()=>le,WindowSetLightTheme:()=>se,WindowSetMaxSize:()=>ge,WindowSetMinSize:()=>me,WindowSetPosition:()=>We,WindowSetSize:()=>ce,WindowSetSystemDefaultTheme:()=>re,WindowSetTitle:()=>we,WindowShow:()=>he,WindowToggleMaximise:()=>be,WindowUnfullscreen:()=>fe,WindowUnmaximise:()=>ye,WindowUnminimise:()=>ke});function oe(){window.location.reload()}function ie(){window.WailsInvoke("WR")}function re(){window.WailsInvoke("WASDT")}function se(){window.WailsInvoke("WALT")}function le(){window.WailsInvoke("WADT")}function ae(){window.WailsInvoke("Wc")}function we(e){window.WailsInvoke("WT"+e)}function de(){window.WailsInvoke("WF")}function fe(){window.WailsInvoke("Wf")}function ue(){return a(":wails:WindowIsFullscreen")}function ce(e,t){window.WailsInvoke("Ws:"+e+":"+t)}function pe(){return a(":wails:WindowGetSize")}function ge(e,t){window.WailsInvoke("WZ:"+e+":"+t)}function me(e,t){window.WailsInvoke("Wz:"+e+":"+t)}function ve(e){window.WailsInvoke("WATP:"+(e?"1":"0"))}function We(e,t){window.WailsInvoke("Wp:"+e+":"+t)}function xe(){return a(":wails:WindowGetPos")}function De(){window.WailsInvoke("WH")}function he(){window.WailsInvoke("WS")}function Ee(){window.WailsInvoke("WM")}function be(){window.WailsInvoke("Wt")}function ye(){window.WailsInvoke("WU")}function Te(){return a(":wails:WindowIsMaximised")}function Se(){window.WailsInvoke("Wm")}function ke(){window.WailsInvoke("Wu")}function Ce(){return a(":wails:WindowIsMinimised")}function Ie(){return a(":wails:WindowIsNormal")}function Oe(e,t,n,o){let i=JSON.stringify({r:e||0,g:t||0,b:n||0,a:o||255});window.WailsInvoke("Wr:"+i)}var S={};p(S,{ScreenGetAll:()=>Le});function Le(){return a(":wails:ScreenGetAll")}var k={};p(k,{BrowserOpenURL:()=>Ae});function Ae(e){window.WailsInvoke("BO:"+e)}var C={};p(C,{ClipboardGetText:()=>Fe,ClipboardSetText:()=>Pe});function Pe(e){return a(":wails:ClipboardSetText",[e])}function Fe(){return a(":wails:ClipboardGetText")}var I={};p(I,{CanResolveFilePaths:()=>V,OnFileDrop:()=>Me,OnFileDropOff:()=>ze,ResolveFilePaths:()=>Re});var s={registered:!1,defaultUseDropTarget:!0,useDropTarget:!0,nextDeactivate:null,nextDeactivateTimeout:null},m="wails-drop-target-active";function h(e){let t=e.getPropertyValue(window.wails.flags.cssDropProperty).trim();return t?t===window.wails.flags.cssDropValue:!1}function G(e){if(!e.dataTransfer.types.includes("Files")||(e.preventDefault(),e.dataTransfer.dropEffect="copy",!window.wails.flags.enableWailsDragAndDrop)||!s.useDropTarget)return;let n=e.target;if(s.nextDeactivate&&s.nextDeactivate(),!n||!h(getComputedStyle(n)))return;let o=n;for(;o;)h(getComputedStyle(o))&&o.classList.add(m),o=o.parentElement}function H(e){if(!!e.dataTransfer.types.includes("Files")&&(e.preventDefault(),!!window.wails.flags.enableWailsDragAndDrop&&!!s.useDropTarget)){if(!e.target||!h(getComputedStyle(e.target)))return null;s.nextDeactivate&&s.nextDeactivate(),s.nextDeactivate=()=>{Array.from(document.getElementsByClassName(m)).forEach(n=>n.classList.remove(m)),s.nextDeactivate=null,s.nextDeactivateTimeout&&(clearTimeout(s.nextDeactivateTimeout),s.nextDeactivateTimeout=null)},s.nextDeactivateTimeout=setTimeout(()=>{s.nextDeactivate&&s.nextDeactivate()},50)}}function U(e){if(!!e.dataTransfer.types.includes("Files")&&(e.preventDefault(),!!window.wails.flags.enableWailsDragAndDrop)){if(V()){let n=[];e.dataTransfer.items?n=[...e.dataTransfer.items].map((o,i)=>{if(o.kind==="file")return o.getAsFile()}):n=[...e.dataTransfer.files],window.runtime.ResolveFilePaths(e.x,e.y,n)}!s.useDropTarget||(s.nextDeactivate&&s.nextDeactivate(),Array.from(document.getElementsByClassName(m)).forEach(n=>n.classList.remove(m)))}}function V(){return window.chrome?.webview?.postMessageWithAdditionalObjects!=null}function Re(e,t,n){window.chrome?.webview?.postMessageWithAdditionalObjects&&chrome.webview.postMessageWithAdditionalObjects(`file:drop:${e}:${t}`,n)}function Me(e,t){if(typeof e!="function"){console.error("DragAndDropCallback is not a function");return}if(s.registered)return;s.registered=!0;let n=typeof t;s.useDropTarget=n==="undefined"||n!=="boolean"?s.defaultUseDropTarget:t,window.addEventListener("dragover",G),window.addEventListener("dragleave",H),window.addEventListener("drop",U);let o=e;s.useDropTarget&&(o=function(i,r,l){let d=document.elementFromPoint(i,r);if(!d||!h(getComputedStyle(d)))return null;e(i,r,l)}),W("wails:file-drop",o)}function ze(){window.removeEventListener("dragover",G),window.removeEventListener("dragleave",H),window.removeEventListener("drop",U),x("wails:file-drop"),s.registered=!1}function N(e){let t=e.target;switch(window.getComputedStyle(t).getPropertyValue("--default-contextmenu").trim()){case"show":return;case"hide":e.preventDefault();return;default:if(t.isContentEditable)return;let i=window.getSelection(),r=i.toString().length>0;if(r)for(let l=0;l{if(window.wails.flags.resizeEdge){window.WailsInvoke("resize:"+window.wails.flags.resizeEdge),e.preventDefault();return}if(Ne(e)){if(window.wails.flags.disableScrollbarDrag&&(e.offsetX>e.target.clientWidth||e.offsetY>e.target.clientHeight))return;window.wails.flags.deferDragToMouseMove?window.wails.flags.shouldDrag=!0:(e.preventDefault(),window.WailsInvoke("drag"));return}else window.wails.flags.shouldDrag=!1});window.addEventListener("mouseup",()=>{window.wails.flags.shouldDrag=!1});function f(e){document.documentElement.style.cursor=e||window.wails.flags.defaultCursor,window.wails.flags.resizeEdge=e}window.addEventListener("mousemove",function(e){if(window.wails.flags.shouldDrag&&(window.wails.flags.shouldDrag=!1,(e.buttons!==void 0?e.buttons:e.which)>0)){window.WailsInvoke("drag");return}if(!window.wails.flags.enableResize)return;window.wails.flags.defaultCursor==null&&(window.wails.flags.defaultCursor=document.documentElement.style.cursor),window.outerWidth-e.clientX{var j=Object.defineProperty;var g=(e,t)=>{for(var n in t)j(e,n,{get:t[n],enumerable:!0})};var b={};g(b,{LogDebug:()=>X,LogError:()=>q,LogFatal:()=>Q,LogInfo:()=>$,LogLevel:()=>Z,LogPrint:()=>J,LogTrace:()=>N,LogWarning:()=>Y,SetLogLevel:()=>_});function u(e,t){window.WailsInvoke("L"+e+t)}function N(e){u("T",e)}function J(e){u("P",e)}function X(e){u("D",e)}function $(e){u("I",e)}function Y(e){u("W",e)}function q(e){u("E",e)}function Q(e){u("F",e)}function _(e){u("S",e)}var Z={TRACE:1,DEBUG:2,INFO:3,WARNING:4,ERROR:5};var y=class{constructor(t,n,o){this.eventName=t,this.maxCallbacks=o||-1,this.Callback=i=>(n.apply(null,i),this.maxCallbacks===-1?!1:(this.maxCallbacks-=1,this.maxCallbacks===0))}},w={};function v(e,t,n){w[e]=w[e]||[];let o=new y(e,t,n);return w[e].push(o),()=>K(o)}function W(e,t){return v(e,t,-1)}function A(e,t){return v(e,t,1)}function P(e){let t=e.name;if(w[t]){let n=w[t].slice();for(let o=w[t].length-1;o>=0;o-=1){let i=w[t][o],r=e.data;i.Callback(r)&&n.splice(o,1)}n.length===0?m(t):w[t]=n}}function R(e){let t;try{t=JSON.parse(e)}catch{let o="Invalid JSON passed to Notify: "+e;throw new Error(o)}P(t)}function M(e){let t={name:e,data:[].slice.apply(arguments).slice(1)};P(t),window.WailsInvoke("EE"+JSON.stringify(t))}function m(e){delete w[e],window.WailsInvoke("EX"+e)}function x(e,...t){m(e),t.length>0&&t.forEach(n=>{m(n)})}function K(e){let t=e.eventName;w[t]=w[t].filter(n=>n!==e),w[t].length===0&&m(t)}var c={};function ee(){var e=new Uint32Array(1);return window.crypto.getRandomValues(e)[0]}function te(){return Math.random()*9007199254740991}var D;window.crypto?D=ee:D=te;function a(e,t,n){return n==null&&(n=0),new Promise(function(o,i){var r;do r=e+"-"+D();while(c[r]);var l;n>0&&(l=setTimeout(function(){i(Error("Call to "+e+" timed out. Request ID: "+r))},n)),c[r]={timeoutHandle:l,reject:i,resolve:o};try{let d={name:e,args:t,callbackID:r};window.WailsInvoke("C"+JSON.stringify(d))}catch(d){console.error(d)}})}window.ObfuscatedCall=(e,t,n)=>(n==null&&(n=0),new Promise(function(o,i){var r;do r=e+"-"+D();while(c[r]);var l;n>0&&(l=setTimeout(function(){i(Error("Call to method "+e+" timed out. Request ID: "+r))},n)),c[r]={timeoutHandle:l,reject:i,resolve:o};try{let d={id:e,args:t,callbackID:r};window.WailsInvoke("c"+JSON.stringify(d))}catch(d){console.error(d)}}));function z(e){let t;try{t=JSON.parse(e)}catch(i){let r=`Invalid JSON passed to callback: ${i.message}. Message: ${e}`;throw runtime.LogDebug(r),new Error(r)}let n=t.callbackid,o=c[n];if(!o){let i=`Callback '${n}' not registered!!!`;throw console.error(i),new Error(i)}clearTimeout(o.timeoutHandle),delete c[n],t.error?o.reject(t.error):o.resolve(t.result)}window.go={};function B(e){try{e=JSON.parse(e)}catch(t){console.error(t)}window.go=window.go||{},Object.keys(e).forEach(t=>{window.go[t]=window.go[t]||{},Object.keys(e[t]).forEach(n=>{window.go[t][n]=window.go[t][n]||{},Object.keys(e[t][n]).forEach(o=>{window.go[t][n][o]=function(){let i=0;function r(){let l=[].slice.call(arguments);return a([t,n,o].join("."),l,i)}return r.setTimeout=function(l){i=l},r.getTimeout=function(){return i},r}()})})})}var T={};g(T,{WindowCenter:()=>le,WindowFullscreen:()=>we,WindowGetPosition:()=>We,WindowGetSize:()=>ce,WindowHide:()=>xe,WindowIsFullscreen:()=>fe,WindowIsMaximised:()=>ye,WindowIsMinimised:()=>Se,WindowIsNormal:()=>Ie,WindowMaximise:()=>he,WindowMinimise:()=>Te,WindowReload:()=>ne,WindowReloadApp:()=>oe,WindowSetAlwaysOnTop:()=>me,WindowSetBackgroundColour:()=>Ce,WindowSetDarkTheme:()=>se,WindowSetLightTheme:()=>re,WindowSetMaxSize:()=>ge,WindowSetMinSize:()=>pe,WindowSetPosition:()=>ve,WindowSetSize:()=>ue,WindowSetSystemDefaultTheme:()=>ie,WindowSetTitle:()=>ae,WindowShow:()=>De,WindowToggleMaximise:()=>Ee,WindowUnfullscreen:()=>de,WindowUnmaximise:()=>be,WindowUnminimise:()=>ke});function ne(){window.location.reload()}function oe(){window.WailsInvoke("WR")}function ie(){window.WailsInvoke("WASDT")}function re(){window.WailsInvoke("WALT")}function se(){window.WailsInvoke("WADT")}function le(){window.WailsInvoke("Wc")}function ae(e){window.WailsInvoke("WT"+e)}function we(){window.WailsInvoke("WF")}function de(){window.WailsInvoke("Wf")}function fe(){return a(":wails:WindowIsFullscreen")}function ue(e,t){window.WailsInvoke("Ws:"+e+":"+t)}function ce(){return a(":wails:WindowGetSize")}function ge(e,t){window.WailsInvoke("WZ:"+e+":"+t)}function pe(e,t){window.WailsInvoke("Wz:"+e+":"+t)}function me(e){window.WailsInvoke("WATP:"+(e?"1":"0"))}function ve(e,t){window.WailsInvoke("Wp:"+e+":"+t)}function We(){return a(":wails:WindowGetPos")}function xe(){window.WailsInvoke("WH")}function De(){window.WailsInvoke("WS")}function he(){window.WailsInvoke("WM")}function Ee(){window.WailsInvoke("Wt")}function be(){window.WailsInvoke("WU")}function ye(){return a(":wails:WindowIsMaximised")}function Te(){window.WailsInvoke("Wm")}function ke(){window.WailsInvoke("Wu")}function Se(){return a(":wails:WindowIsMinimised")}function Ie(){return a(":wails:WindowIsNormal")}function Ce(e,t,n,o){let i=JSON.stringify({r:e||0,g:t||0,b:n||0,a:o||255});window.WailsInvoke("Wr:"+i)}var k={};g(k,{ScreenGetAll:()=>Oe});function Oe(){return a(":wails:ScreenGetAll")}var S={};g(S,{BrowserOpenURL:()=>Le});function Le(e){window.WailsInvoke("BO:"+e)}var I={};g(I,{ClipboardGetText:()=>Pe,ClipboardSetText:()=>Ae});function Ae(e){return a(":wails:ClipboardSetText",[e])}function Pe(){return a(":wails:ClipboardGetText")}var C={};g(C,{CanResolveFilePaths:()=>U,OnFileDrop:()=>Me,OnFileDropOff:()=>ze,ResolveFilePaths:()=>Re});var s={registered:!1,defaultUseDropTarget:!0,useDropTarget:!0,nextDeactivate:null,nextDeactivateTimeout:null},p="wails-drop-target-active";function h(e){let t=e.getPropertyValue(window.wails.flags.cssDropProperty).trim();return t?t===window.wails.flags.cssDropValue:!1}function F(e){if(!window.wails.flags.enableWailsDragAndDrop||(e.preventDefault(),!s.useDropTarget))return;let t=e.target;if(s.nextDeactivate&&s.nextDeactivate(),!t||!h(getComputedStyle(t)))return;let n=t;for(;n;)h(n.style)&&n.classList.add(p),n=n.parentElement}function G(e){if(!!window.wails.flags.enableWailsDragAndDrop&&(e.preventDefault(),!!s.useDropTarget)){if(!e.target||!h(getComputedStyle(e.target)))return null;s.nextDeactivate&&s.nextDeactivate(),s.nextDeactivate=()=>{Array.from(document.getElementsByClassName(p)).forEach(t=>t.classList.remove(p)),s.nextDeactivate=null,s.nextDeactivateTimeout&&(clearTimeout(s.nextDeactivateTimeout),s.nextDeactivateTimeout=null)},s.nextDeactivateTimeout=setTimeout(()=>{s.nextDeactivate&&s.nextDeactivate()},50)}}function H(e){if(!!window.wails.flags.enableWailsDragAndDrop&&(e.preventDefault(),!!s.useDropTarget&&(s.nextDeactivate&&s.nextDeactivate(),Array.from(document.getElementsByClassName(p)).forEach(t=>t.classList.remove(p)),U()))){let t=[];e.dataTransfer.items?t=[...e.dataTransfer.items].map((n,o)=>{if(n.kind==="file")return n.getAsFile()}):t=[...e.dataTransfer.files],window.runtime.ResolveFilePaths(e.x,e.y,t)}}function U(){return window.chrome?.webview?.postMessageWithAdditionalObjects!=null}function Re(e,t,n){window.chrome?.webview?.postMessageWithAdditionalObjects&&chrome.webview.postMessageWithAdditionalObjects(`file:drop:${e}:${t}`,n)}function Me(e,t){if(typeof e!="function"){console.error("DragAndDropCallback is not a function");return}if(s.registered)return;s.registered=!0;let n=typeof t;s.useDropTarget=n==="undefined"||n!=="boolean"?s.defaultUseDropTarget:t,window.addEventListener("dragover",F),window.addEventListener("dragleave",G),window.addEventListener("drop",H);let o=e;s.useDropTarget&&(o=function(i,r,l){let d=document.elementFromPoint(i,r);if(!d||!h(getComputedStyle(d)))return null;e(i,r,l)}),W("wails:file-drop",o)}function ze(){window.removeEventListener("dragover",F),window.removeEventListener("dragleave",G),window.removeEventListener("drop",H),x("wails:file-drop"),s.registered=!1}function V(e){let t=e.target;switch(window.getComputedStyle(t).getPropertyValue("--default-contextmenu").trim()){case"show":return;case"hide":e.preventDefault();return;default:if(t.isContentEditable)return;let i=window.getSelection(),r=i.toString().length>0;if(r)for(let l=0;l{if(window.wails.flags.resizeEdge){window.WailsInvoke("resize:"+window.wails.flags.resizeEdge),e.preventDefault();return}if(Ve(e)){if(window.wails.flags.disableScrollbarDrag&&(e.offsetX>e.target.clientWidth||e.offsetY>e.target.clientHeight))return;window.wails.flags.deferDragToMouseMove?window.wails.flags.shouldDrag=!0:(e.preventDefault(),window.WailsInvoke("drag"));return}else window.wails.flags.shouldDrag=!1});window.addEventListener("mouseup",()=>{window.wails.flags.shouldDrag=!1});function f(e){document.documentElement.style.cursor=e||window.wails.flags.defaultCursor,window.wails.flags.resizeEdge=e}window.addEventListener("mousemove",function(e){if(window.wails.flags.shouldDrag&&(window.wails.flags.shouldDrag=!1,(e.buttons!==void 0?e.buttons:e.which)>0)){window.WailsInvoke("drag");return}if(!window.wails.flags.enableResize)return;window.wails.flags.defaultCursor==null&&(window.wails.flags.defaultCursor=document.documentElement.style.cursor),window.outerWidth-e.clientX; // [WindowSetSize](https://wails.io/docs/reference/runtime/window#windowsetsize) // Sets the width and height of the window. -export function WindowSetSize(width: number, height: number): void; +export function WindowSetSize(width: number, height: number): Promise; // [WindowGetSize](https://wails.io/docs/reference/runtime/window#windowgetsize) // Gets the width and height of the window. diff --git a/v2/internal/frontend/runtime/wrapper/runtime.js b/v2/internal/frontend/runtime/wrapper/runtime.js index 7cb89d750..623397b0b 100644 --- a/v2/internal/frontend/runtime/wrapper/runtime.js +++ b/v2/internal/frontend/runtime/wrapper/runtime.js @@ -48,10 +48,6 @@ export function EventsOff(eventName, ...additionalEventNames) { return window.runtime.EventsOff(eventName, ...additionalEventNames); } -export function EventsOffAll() { - return window.runtime.EventsOffAll(); -} - export function EventsOnce(eventName, callback) { return EventsOnMultiple(eventName, callback, 1); } diff --git a/v2/internal/frontend/utils/urlValidator.go b/v2/internal/frontend/utils/urlValidator.go deleted file mode 100644 index 76ba216ce..000000000 --- a/v2/internal/frontend/utils/urlValidator.go +++ /dev/null @@ -1,58 +0,0 @@ -package utils - -import ( - "errors" - "fmt" - "net/url" - "regexp" - "strings" -) - -func ValidateAndSanitizeURL(rawURL string) (string, error) { - // Check for null bytes (can cause truncation issues in some systems) - if strings.Contains(rawURL, "\x00") { - return "", errors.New("null bytes not allowed in URL") - } - - // Parse URL first - this handles most malformed URLs - parsedURL, err := url.Parse(rawURL) - if err != nil { - return "", fmt.Errorf("invalid URL format: %v", err) - } - - scheme := strings.ToLower(parsedURL.Scheme) - - if scheme == "javascript" || scheme == "data" || scheme == "file" || scheme == "ftp" || scheme == "" { - return "", errors.New("scheme not allowed") - } - - // Ensure there's actually a host for http/https URLs - if (scheme == "http" || scheme == "https") && parsedURL.Host == "" { - return "", fmt.Errorf("missing host for %s URL", scheme) - } - - sanitizedURL := parsedURL.String() - - // Check for control characters that might cause issues - // (but allow legitimate URL characters like &, ;, etc.) - for i, r := range sanitizedURL { - // Block control characters except tab, but allow other printable chars - if r < 32 && r != 9 { // 9 is tab, which might be legitimate - return "", fmt.Errorf("control character at position %d not allowed", i) - } - } - - // Shell metacharacter check - shellDangerous := `[;\|` + "`" + `$\\<>*{}\[\]()~! \t\n\r]` - if matched, _ := regexp.MatchString(shellDangerous, sanitizedURL); matched { - return "", errors.New("shell metacharacters not allowed") - } - - // Unicode danger check - unicodeDangerous := "[\u0000-\u001F\u007F\u00A0\u1680\u2000-\u200F\u2028-\u202F\u205F\u2060\u3000\uFEFF]" - if matched, _ := regexp.MatchString(unicodeDangerous, sanitizedURL); matched { - return "", errors.New("unicode dangerous characters not allowed") - } - - return sanitizedURL, nil -} diff --git a/v2/internal/frontend/utils/urlValidator_test.go b/v2/internal/frontend/utils/urlValidator_test.go deleted file mode 100644 index b385ccec1..000000000 --- a/v2/internal/frontend/utils/urlValidator_test.go +++ /dev/null @@ -1,207 +0,0 @@ -package utils_test - -import ( - "strings" - "testing" - - "github.com/wailsapp/wails/v2/internal/frontend/utils" -) - -// Test cases for ValidateAndOpenURL -func TestValidateURL(t *testing.T) { - testCases := []struct { - name string - url string - shouldErr bool - errMsg string - expected string - }{ - // Valid URLs - { - name: "valid https URL", - url: "https://www.example.com", - shouldErr: false, - expected: "https://www.example.com", - }, - { - name: "valid http URL", - url: "http://example.com", - shouldErr: false, - expected: "http://example.com", - }, - { - name: "URL with query parameters", - url: "https://example.com/search?q=cats&dogs", - shouldErr: false, - expected: "https://example.com/search?q=cats&dogs", - }, - { - name: "URL with port", - url: "https://example.com:8080/path", - shouldErr: false, - expected: "https://example.com:8080/path", - }, - { - name: "URL with fragment", - url: "https://example.com/page#section", - shouldErr: false, - expected: "https://example.com/page#section", - }, - { - name: "urlencode params", - url: "http://google.com/ ----browser-subprocess-path=C:\\\\Users\\\\Public\\\\test.bat", - shouldErr: false, - expected: "http://google.com/%20----browser-subprocess-path=C:%5C%5CUsers%5C%5CPublic%5C%5Ctest.bat", - }, - - // Invalid schemes - { - name: "javascript scheme", - url: "javascript:alert('xss')", - shouldErr: true, - errMsg: "scheme not allowed", - }, - { - name: "data scheme", - url: "data:text/html,", - shouldErr: true, - errMsg: "scheme not allowed", - }, - { - name: "file scheme", - url: "file:///etc/passwd", - shouldErr: true, - errMsg: "scheme not allowed", - }, - { - name: "ftp scheme", - url: "ftp://files.example.com/file.txt", - shouldErr: true, - errMsg: "scheme not allowed", - }, - - // Malformed URLs - { - name: "not a URL", - url: "not-a-url", - shouldErr: true, - errMsg: "scheme not allowed", // will have empty scheme - }, - { - name: "missing scheme", - url: "example.com", - shouldErr: true, - errMsg: "scheme not allowed", - }, - { - name: "malformed URL", - url: "https://", - shouldErr: true, - errMsg: "missing host", - }, - { - name: "empty host", - url: "http:///path", - shouldErr: true, - errMsg: "missing host", - }, - - // Security issues - { - name: "null byte in URL", - url: "https://example.com\x00/hidden", - shouldErr: true, - errMsg: "null bytes not allowed", - }, - { - name: "control characters", - url: "https://example.com\n/path", - shouldErr: true, - errMsg: "control character", - }, - { - name: "carriage return", - url: "https://example.com\r/path", - shouldErr: true, - errMsg: "control character", - }, - { - name: "URL with tab character", - url: "https://example.com/path?q=hello\tworld", - shouldErr: true, - errMsg: "control character", - }, - { - name: "URL with path parameters", - url: "https://example.com/path;param=value", - shouldErr: true, - errMsg: "shell metacharacters not allowed", - }, - { - name: "URL with special characters in query", - url: "https://example.com/search?q=hello world&filter=price>100", - shouldErr: true, - errMsg: "shell metacharacters not allowed", - }, - { - name: "URL with special characters in query and params", - url: "https://example.com/search?q=hello ----browser-subprocess-path=C:\\\\Users\\\\Public\\\\test.bat", - shouldErr: true, - errMsg: "shell metacharacters not allowed", - }, - { - name: "URL with dollar sign in query", - url: "https://example.com/search?price=$100", - shouldErr: true, - errMsg: "shell metacharacters not allowed", - }, - { - name: "URL with parentheses", - url: "https://example.com/file(1).html", - shouldErr: true, - errMsg: "shell metacharacters not allowed", - }, - { - name: "URL with unicode", - url: "https://example.com/search?q=hello\u2001foo", - shouldErr: true, - errMsg: "unicode dangerous characters not allowed", - }, - - // Edge cases - { - name: "international domain", - url: "https://例え.テスト/path", - shouldErr: false, - expected: "https://%E4%BE%8B%E3%81%88.%E3%83%86%E3%82%B9%E3%83%88/path", - }, - { - name: "URL with pipe character", - url: "https://example.com/user/123|admin", - shouldErr: false, - expected: "https://example.com/user/123%7Cadmin", - }, - } - - for _, tc := range testCases { - t.Run(tc.name, func(t *testing.T) { - // We'll test only the validation part to avoid actually opening URLs - sanitized, err := utils.ValidateAndSanitizeURL(tc.url) - - if tc.shouldErr { - if err == nil { - t.Errorf("expected error for URL %q, but got none", tc.url) - } else if tc.errMsg != "" && !strings.Contains(err.Error(), tc.errMsg) { - t.Errorf("expected error containing %q, got %q", tc.errMsg, err.Error()) - } - } else { - if err != nil { - t.Errorf("expected no error for URL %q, but got: %v", tc.url, err) - } - if sanitized != tc.expected { - t.Errorf("unexpected sanitized URL for %q: expected %q, got %q", tc.url, tc.expected, sanitized) - } - } - }) - } -} diff --git a/v2/internal/github/github.go b/v2/internal/github/github.go index 2aa5e1432..c16e1d9dd 100644 --- a/v2/internal/github/github.go +++ b/v2/internal/github/github.go @@ -3,7 +3,6 @@ package github import ( "encoding/json" "fmt" - "github.com/charmbracelet/glamour/styles" "io" "net/http" "net/url" @@ -40,7 +39,7 @@ func GetReleaseNotes(tagVersion string, noColour bool) string { var termRendererOpts []glamour.TermRendererOption if runtime.GOOS == "windows" || noColour { - termRendererOpts = append(termRendererOpts, glamour.WithStyles(styles.NoTTYStyleConfig)) + termRendererOpts = append(termRendererOpts, glamour.WithStyles(glamour.NoTTYStyleConfig)) } else { termRendererOpts = append(termRendererOpts, glamour.WithAutoStyle()) } diff --git a/v2/internal/go-common-file-dialog/cfd/CommonFileDialog_nonWindows.go b/v2/internal/go-common-file-dialog/cfd/CommonFileDialog_nonWindows.go index 3ab969850..04c7cbcfe 100644 --- a/v2/internal/go-common-file-dialog/cfd/CommonFileDialog_nonWindows.go +++ b/v2/internal/go-common-file-dialog/cfd/CommonFileDialog_nonWindows.go @@ -5,24 +5,24 @@ package cfd import "fmt" -var unsupportedError = fmt.Errorf("common file dialogs are only available on windows") +var errUnsupported = fmt.Errorf("common file dialogs are only available on windows") // TODO doc func NewOpenFileDialog(config DialogConfig) (OpenFileDialog, error) { - return nil, unsupportedError + return nil, errUnsupported } // TODO doc func NewOpenMultipleFilesDialog(config DialogConfig) (OpenMultipleFilesDialog, error) { - return nil, unsupportedError + return nil, errUnsupported } // TODO doc func NewSelectFolderDialog(config DialogConfig) (SelectFolderDialog, error) { - return nil, unsupportedError + return nil, errUnsupported } // TODO doc func NewSaveFileDialog(config DialogConfig) (SaveFileDialog, error) { - return nil, unsupportedError + return nil, errUnsupported } diff --git a/v2/internal/go-common-file-dialog/cfd/DialogConfig.go b/v2/internal/go-common-file-dialog/cfd/DialogConfig.go index 9e06fb503..221dbef27 100644 --- a/v2/internal/go-common-file-dialog/cfd/DialogConfig.go +++ b/v2/internal/go-common-file-dialog/cfd/DialogConfig.go @@ -2,12 +2,6 @@ package cfd -import ( - "fmt" - "os" - "reflect" -) - type FileFilter struct { // The display name of the filter (That is shown to the user) DisplayName string @@ -15,9 +9,6 @@ type FileFilter struct { Pattern string } -// Never obfuscate the FileFilter type. -var _ = reflect.TypeOf(FileFilter{}) - type DialogConfig struct { // The title of the dialog Title string @@ -76,10 +67,6 @@ func (config *DialogConfig) apply(dialog Dialog) (err error) { } if config.Folder != "" { - _, err = os.Stat(config.Folder) - if err != nil { - return - } err = dialog.SetFolder(config.Folder) if err != nil { return @@ -87,10 +74,6 @@ func (config *DialogConfig) apply(dialog Dialog) (err error) { } if config.DefaultFolder != "" { - _, err = os.Stat(config.DefaultFolder) - if err != nil { - return - } err = dialog.SetDefaultFolder(config.DefaultFolder) if err != nil { return @@ -119,10 +102,6 @@ func (config *DialogConfig) apply(dialog Dialog) (err error) { } if config.SelectedFileFilterIndex != 0 { - if config.SelectedFileFilterIndex > uint(len(fileFilters)) { - err = fmt.Errorf("selected file filter index out of range") - return - } err = dialog.SetSelectedFileFilterIndex(config.SelectedFileFilterIndex) if err != nil { return diff --git a/v2/internal/go-common-file-dialog/cfd/errors.go b/v2/internal/go-common-file-dialog/cfd/errors.go index 4ca3300b9..6f21fedbf 100644 --- a/v2/internal/go-common-file-dialog/cfd/errors.go +++ b/v2/internal/go-common-file-dialog/cfd/errors.go @@ -2,8 +2,4 @@ package cfd import "errors" -var ( - ErrCancelled = errors.New("cancelled by user") - ErrInvalidGUID = errors.New("guid cannot be nil") - ErrEmptyFilters = errors.New("must specify at least one filter") -) +var ErrCancelled = errors.New("cancelled by user") diff --git a/v2/internal/go-common-file-dialog/cfd/iFileOpenDialog.go b/v2/internal/go-common-file-dialog/cfd/iFileOpenDialog.go index b1be23fcf..4c080c916 100644 --- a/v2/internal/go-common-file-dialog/cfd/iFileOpenDialog.go +++ b/v2/internal/go-common-file-dialog/cfd/iFileOpenDialog.go @@ -5,7 +5,7 @@ package cfd import ( "github.com/go-ole/go-ole" - "github.com/google/uuid" + "github.com/wailsapp/wails/v2/internal/go-common-file-dialog/util" "syscall" "unsafe" ) @@ -106,7 +106,7 @@ func (fileOpenDialog *iFileOpenDialog) SetFileFilters(filter []FileFilter) error } func (fileOpenDialog *iFileOpenDialog) SetRole(role string) error { - return fileOpenDialog.vtbl.setClientGuid(unsafe.Pointer(fileOpenDialog), StringToUUID(role)) + return fileOpenDialog.vtbl.setClientGuid(unsafe.Pointer(fileOpenDialog), util.StringToUUID(role)) } // This should only be callable when the user asks for a multi select because @@ -164,7 +164,8 @@ func (fileOpenDialog *iFileOpenDialog) setIsMultiselect(isMultiselect bool) erro func (vtbl *iFileOpenDialogVtbl) getResults(objPtr unsafe.Pointer) (*iShellItemArray, error) { var shellItemArray *iShellItemArray - ret, _, _ := syscall.SyscallN(vtbl.GetResults, + ret, _, _ := syscall.Syscall(vtbl.GetResults, + 1, uintptr(objPtr), uintptr(unsafe.Pointer(&shellItemArray)), 0) @@ -194,7 +195,3 @@ func (vtbl *iFileOpenDialogVtbl) getResultsStrings(objPtr unsafe.Pointer) ([]str } return results, nil } - -func StringToUUID(str string) *ole.GUID { - return ole.NewGUID(uuid.NewSHA1(uuid.Nil, []byte(str)).String()) -} diff --git a/v2/internal/go-common-file-dialog/cfd/iFileSaveDialog.go b/v2/internal/go-common-file-dialog/cfd/iFileSaveDialog.go index ddee7b246..3effeda25 100644 --- a/v2/internal/go-common-file-dialog/cfd/iFileSaveDialog.go +++ b/v2/internal/go-common-file-dialog/cfd/iFileSaveDialog.go @@ -5,6 +5,7 @@ package cfd import ( "github.com/go-ole/go-ole" + "github.com/wailsapp/wails/v2/internal/go-common-file-dialog/util" "unsafe" ) @@ -76,7 +77,7 @@ func (fileSaveDialog *iFileSaveDialog) SetFileFilters(filter []FileFilter) error } func (fileSaveDialog *iFileSaveDialog) SetRole(role string) error { - return fileSaveDialog.vtbl.setClientGuid(unsafe.Pointer(fileSaveDialog), StringToUUID(role)) + return fileSaveDialog.vtbl.setClientGuid(unsafe.Pointer(fileSaveDialog), util.StringToUUID(role)) } func (fileSaveDialog *iFileSaveDialog) SetDefaultExtension(defaultExtension string) error { diff --git a/v2/internal/go-common-file-dialog/cfd/iShellItem.go b/v2/internal/go-common-file-dialog/cfd/iShellItem.go index 080115345..c97efd8bb 100644 --- a/v2/internal/go-common-file-dialog/cfd/iShellItem.go +++ b/v2/internal/go-common-file-dialog/cfd/iShellItem.go @@ -30,10 +30,6 @@ type iShellItemVtbl struct { func newIShellItem(path string) (*iShellItem, error) { var shellItem *iShellItem pathPtr := ole.SysAllocString(path) - defer func(v *int16) { - _ = ole.SysFreeString(v) - }(pathPtr) - ret, _, _ := procSHCreateItemFromParsingName.Call( uintptr(unsafe.Pointer(pathPtr)), 0, @@ -46,7 +42,7 @@ func (vtbl *iShellItemVtbl) getDisplayName(objPtr unsafe.Pointer) (string, error var ptr *uint16 ret, _, _ := syscall.SyscallN(vtbl.GetDisplayName, uintptr(objPtr), - 0x80058000, // SIGDN_FILESYSPATH, + 0x80058000, // SIGDN_FILESYSPATH uintptr(unsafe.Pointer(&ptr))) if err := hresultToError(ret); err != nil { return "", err diff --git a/v2/internal/go-common-file-dialog/cfd/iShellItemArray.go b/v2/internal/go-common-file-dialog/cfd/iShellItemArray.go index c548160d1..d904e72b2 100644 --- a/v2/internal/go-common-file-dialog/cfd/iShellItemArray.go +++ b/v2/internal/go-common-file-dialog/cfd/iShellItemArray.go @@ -38,9 +38,11 @@ type iShellItemArrayVtbl struct { func (vtbl *iShellItemArrayVtbl) getCount(objPtr unsafe.Pointer) (uintptr, error) { var count uintptr - ret, _, _ := syscall.SyscallN(vtbl.GetCount, + ret, _, _ := syscall.Syscall(vtbl.GetCount, + 1, uintptr(objPtr), - uintptr(unsafe.Pointer(&count))) + uintptr(unsafe.Pointer(&count)), + 0) if err := hresultToError(ret); err != nil { return 0, err } @@ -49,7 +51,8 @@ func (vtbl *iShellItemArrayVtbl) getCount(objPtr unsafe.Pointer) (uintptr, error func (vtbl *iShellItemArrayVtbl) getItemAt(objPtr unsafe.Pointer, index uintptr) (string, error) { var shellItem *iShellItem - ret, _, _ := syscall.SyscallN(vtbl.GetItemAt, + ret, _, _ := syscall.Syscall(vtbl.GetItemAt, + 2, uintptr(objPtr), index, uintptr(unsafe.Pointer(&shellItem))) diff --git a/v2/internal/go-common-file-dialog/cfd/vtblCommonFunc.go b/v2/internal/go-common-file-dialog/cfd/vtblCommonFunc.go index 581a7b25c..929d5a2b7 100644 --- a/v2/internal/go-common-file-dialog/cfd/vtblCommonFunc.go +++ b/v2/internal/go-common-file-dialog/cfd/vtblCommonFunc.go @@ -1,8 +1,10 @@ //go:build windows +// +build windows package cfd import ( + "fmt" "github.com/go-ole/go-ole" "strings" "syscall" @@ -17,23 +19,27 @@ func hresultToError(hr uintptr) error { } func (vtbl *iUnknownVtbl) release(objPtr unsafe.Pointer) error { - ret, _, _ := syscall.SyscallN(vtbl.Release, + ret, _, _ := syscall.Syscall(vtbl.Release, + 0, uintptr(objPtr), + 0, 0) return hresultToError(ret) } func (vtbl *iModalWindowVtbl) show(objPtr unsafe.Pointer, hwnd uintptr) error { - ret, _, _ := syscall.SyscallN(vtbl.Show, + ret, _, _ := syscall.Syscall(vtbl.Show, + 1, uintptr(objPtr), - hwnd) + hwnd, + 0) return hresultToError(ret) } func (vtbl *iFileDialogVtbl) setFileTypes(objPtr unsafe.Pointer, filters []FileFilter) error { cFileTypes := len(filters) if cFileTypes < 0 { - return ErrEmptyFilters + return fmt.Errorf("must specify at least one filter") } comDlgFilterSpecs := make([]comDlgFilterSpec, cFileTypes) for i := 0; i < cFileTypes; i++ { @@ -43,16 +49,8 @@ func (vtbl *iFileDialogVtbl) setFileTypes(objPtr unsafe.Pointer, filters []FileF pszSpec: ole.SysAllocString(filter.Pattern), } } - - // Ensure memory is freed after use - defer func() { - for _, spec := range comDlgFilterSpecs { - ole.SysFreeString(spec.pszName) - ole.SysFreeString(spec.pszSpec) - } - }() - - ret, _, _ := syscall.SyscallN(vtbl.SetFileTypes, + ret, _, _ := syscall.Syscall(vtbl.SetFileTypes, + 2, uintptr(objPtr), uintptr(cFileTypes), uintptr(unsafe.Pointer(&comDlgFilterSpecs[0]))) @@ -84,17 +82,21 @@ func (vtbl *iFileDialogVtbl) setFileTypes(objPtr unsafe.Pointer, filters []FileF // FOS_FORCEPREVIEWPANEON = 0x40000000, // FOS_SUPPORTSTREAMABLEITEMS = 0x80000000 func (vtbl *iFileDialogVtbl) setOptions(objPtr unsafe.Pointer, options uint32) error { - ret, _, _ := syscall.SyscallN(vtbl.SetOptions, + ret, _, _ := syscall.Syscall(vtbl.SetOptions, + 1, uintptr(objPtr), - uintptr(options)) + uintptr(options), + 0) return hresultToError(ret) } func (vtbl *iFileDialogVtbl) getOptions(objPtr unsafe.Pointer) (uint32, error) { var options uint32 - ret, _, _ := syscall.SyscallN(vtbl.GetOptions, + ret, _, _ := syscall.Syscall(vtbl.GetOptions, + 1, uintptr(objPtr), - uintptr(unsafe.Pointer(&options))) + uintptr(unsafe.Pointer(&options)), + 0) return options, hresultToError(ret) } @@ -120,9 +122,11 @@ func (vtbl *iFileDialogVtbl) setDefaultFolder(objPtr unsafe.Pointer, path string return err } defer shellItem.vtbl.release(unsafe.Pointer(shellItem)) - ret, _, _ := syscall.SyscallN(vtbl.SetDefaultFolder, + ret, _, _ := syscall.Syscall(vtbl.SetDefaultFolder, + 1, uintptr(objPtr), - uintptr(unsafe.Pointer(shellItem))) + uintptr(unsafe.Pointer(shellItem)), + 0) return hresultToError(ret) } @@ -132,32 +136,40 @@ func (vtbl *iFileDialogVtbl) setFolder(objPtr unsafe.Pointer, path string) error return err } defer shellItem.vtbl.release(unsafe.Pointer(shellItem)) - ret, _, _ := syscall.SyscallN(vtbl.SetFolder, + ret, _, _ := syscall.Syscall(vtbl.SetFolder, + 1, uintptr(objPtr), - uintptr(unsafe.Pointer(shellItem))) + uintptr(unsafe.Pointer(shellItem)), + 0) return hresultToError(ret) } func (vtbl *iFileDialogVtbl) setTitle(objPtr unsafe.Pointer, title string) error { titlePtr := ole.SysAllocString(title) - defer ole.SysFreeString(titlePtr) // Ensure the string is freed - ret, _, _ := syscall.SyscallN(vtbl.SetTitle, + ret, _, _ := syscall.Syscall(vtbl.SetTitle, + 1, uintptr(objPtr), - uintptr(unsafe.Pointer(titlePtr))) + uintptr(unsafe.Pointer(titlePtr)), + 0) return hresultToError(ret) } func (vtbl *iFileDialogVtbl) close(objPtr unsafe.Pointer) error { - ret, _, _ := syscall.SyscallN(vtbl.Close, - uintptr(objPtr)) + ret, _, _ := syscall.Syscall(vtbl.Close, + 1, + uintptr(objPtr), + 0, + 0) return hresultToError(ret) } func (vtbl *iFileDialogVtbl) getResult(objPtr unsafe.Pointer) (*iShellItem, error) { var shellItem *iShellItem - ret, _, _ := syscall.SyscallN(vtbl.GetResult, + ret, _, _ := syscall.Syscall(vtbl.GetResult, + 1, uintptr(objPtr), - uintptr(unsafe.Pointer(&shellItem))) + uintptr(unsafe.Pointer(&shellItem)), + 0) return shellItem, hresultToError(ret) } @@ -174,51 +186,42 @@ func (vtbl *iFileDialogVtbl) getResultString(objPtr unsafe.Pointer) (string, err } func (vtbl *iFileDialogVtbl) setClientGuid(objPtr unsafe.Pointer, guid *ole.GUID) error { - // Ensure the GUID is not nil - if guid == nil { - return ErrInvalidGUID - } - - // Call the SetClientGuid method - ret, _, _ := syscall.SyscallN(vtbl.SetClientGuid, + ret, _, _ := syscall.Syscall(vtbl.SetClientGuid, + 1, uintptr(objPtr), - uintptr(unsafe.Pointer(guid))) - - // Convert the HRESULT to a Go error + uintptr(unsafe.Pointer(guid)), + 0) return hresultToError(ret) } func (vtbl *iFileDialogVtbl) setDefaultExtension(objPtr unsafe.Pointer, defaultExtension string) error { - // Ensure the string is not empty before accessing the first character - if len(defaultExtension) > 0 && defaultExtension[0] == '.' { + if defaultExtension[0] == '.' { defaultExtension = strings.TrimPrefix(defaultExtension, ".") } - - // Allocate memory for the default extension string defaultExtensionPtr := ole.SysAllocString(defaultExtension) - defer ole.SysFreeString(defaultExtensionPtr) // Ensure the string is freed - - // Call the SetDefaultExtension method - ret, _, _ := syscall.SyscallN(vtbl.SetDefaultExtension, + ret, _, _ := syscall.Syscall(vtbl.SetDefaultExtension, + 1, uintptr(objPtr), - uintptr(unsafe.Pointer(defaultExtensionPtr))) - - // Convert the HRESULT to a Go error + uintptr(unsafe.Pointer(defaultExtensionPtr)), + 0) return hresultToError(ret) } func (vtbl *iFileDialogVtbl) setFileName(objPtr unsafe.Pointer, fileName string) error { fileNamePtr := ole.SysAllocString(fileName) - defer ole.SysFreeString(fileNamePtr) // Ensure the string is freed - ret, _, _ := syscall.SyscallN(vtbl.SetFileName, + ret, _, _ := syscall.Syscall(vtbl.SetFileName, + 1, uintptr(objPtr), - uintptr(unsafe.Pointer(fileNamePtr))) + uintptr(unsafe.Pointer(fileNamePtr)), + 0) return hresultToError(ret) } func (vtbl *iFileDialogVtbl) setSelectedFileFilterIndex(objPtr unsafe.Pointer, index uint) error { - ret, _, _ := syscall.SyscallN(vtbl.SetFileTypeIndex, + ret, _, _ := syscall.Syscall(vtbl.SetFileTypeIndex, + 1, uintptr(objPtr), - uintptr(index+1)) // SetFileTypeIndex counts from 1 + uintptr(index+1), // SetFileTypeIndex counts from 1 + 0) return hresultToError(ret) } diff --git a/v2/internal/go-common-file-dialog/cfdutil/CFDUtil.go b/v2/internal/go-common-file-dialog/cfdutil/CFDUtil.go index bde52d743..655266bc3 100644 --- a/v2/internal/go-common-file-dialog/cfdutil/CFDUtil.go +++ b/v2/internal/go-common-file-dialog/cfdutil/CFDUtil.go @@ -10,7 +10,9 @@ func ShowOpenFileDialog(config cfd.DialogConfig) (string, error) { if err != nil { return "", err } - defer dialog.Release() + defer func() { + _ = dialog.Release() + }() return dialog.ShowAndGetResult() } @@ -20,7 +22,9 @@ func ShowOpenMultipleFilesDialog(config cfd.DialogConfig) ([]string, error) { if err != nil { return nil, err } - defer dialog.Release() + defer func() { + _ = dialog.Release() + }() return dialog.ShowAndGetResults() } @@ -30,7 +34,9 @@ func ShowPickFolderDialog(config cfd.DialogConfig) (string, error) { if err != nil { return "", err } - defer dialog.Release() + defer func() { + _ = dialog.Release() + }() return dialog.ShowAndGetResult() } @@ -40,6 +46,8 @@ func ShowSaveFileDialog(config cfd.DialogConfig) (string, error) { if err != nil { return "", err } - defer dialog.Release() + defer func() { + _ = dialog.Release() + }() return dialog.ShowAndGetResult() } diff --git a/v2/internal/menumanager/processedMenu.go b/v2/internal/menumanager/processedMenu.go index c87646ccb..0f2351846 100644 --- a/v2/internal/menumanager/processedMenu.go +++ b/v2/internal/menumanager/processedMenu.go @@ -23,7 +23,7 @@ type ProcessedMenuItem struct { Hidden bool `json:",omitempty"` // Checked indicates if the item is selected (used by Checkbox and Radio types only) Checked bool `json:",omitempty"` - // SubMenu contains a list of menu items that will be shown as a submenu + // Submenu contains a list of menu items that will be shown as a submenu // SubMenu []*MenuItem `json:"SubMenu,omitempty"` SubMenu *ProcessedMenu `json:",omitempty"` /* diff --git a/v2/internal/platform/win32/consts.go b/v2/internal/platform/win32/consts.go index 43149b036..03f42b1a6 100644 --- a/v2/internal/platform/win32/consts.go +++ b/v2/internal/platform/win32/consts.go @@ -80,7 +80,7 @@ ShouldSystemUseDarkMode = bool () // ordinal 138 SetPreferredAppMode = PreferredAppMode (PreferredAppMode appMode) // ordinal 135, since 18334 IsDarkModeAllowedForApp = bool () // ordinal 139 */ -func Init() { +func init() { if IsWindowsVersionAtLeast(10, 0, 18334) { // AllowDarkModeForWindow is only available on Windows 10+ diff --git a/v2/internal/project/project.go b/v2/internal/project/project.go index 2df99bdfa..a1de1b943 100644 --- a/v2/internal/project/project.go +++ b/v2/internal/project/project.go @@ -42,9 +42,6 @@ type Project struct { // Build directory BuildDir string `json:"build:dir"` - // BuildTags Extra tags to process during build - BuildTags string `json:"build:tags"` - // The output filename OutputFilename string `json:"outputfilename"` @@ -96,9 +93,6 @@ type Project struct { // Frontend directory FrontendDir string `json:"frontend:dir"` - // The timeout in seconds for Vite server detection. Default 10 - ViteServerTimeout int `json:"viteServerTimeout"` - Bindings Bindings `json:"bindings"` } @@ -181,9 +175,6 @@ func (p *Project) setDefaults() { if p.DevServer == "" { p.DevServer = "localhost:34115" } - if p.ViteServerTimeout == 0 { - p.ViteServerTimeout = 10 - } if p.NSISType == "" { p.NSISType = "multiple" } diff --git a/v2/internal/s/s.go b/v2/internal/s/s.go index adb304178..5ba0d2eaa 100644 --- a/v2/internal/s/s.go +++ b/v2/internal/s/s.go @@ -5,6 +5,7 @@ import ( "encoding/hex" "fmt" "io" + "io/ioutil" "os" "path/filepath" "strings" @@ -28,7 +29,7 @@ func checkError(err error) { func mute() { originalOutput = Output - Output = io.Discard + Output = ioutil.Discard } func unmute() { diff --git a/v2/internal/staticanalysis/test/standard/go.mod b/v2/internal/staticanalysis/test/standard/go.mod index c9fe1fb52..ae0c84abe 100644 --- a/v2/internal/staticanalysis/test/standard/go.mod +++ b/v2/internal/staticanalysis/test/standard/go.mod @@ -1,8 +1,8 @@ module changeme -go 1.18 +go 1.22 -require github.com/wailsapp/wails/v2 v2.3.1 +require github.com/wailsapp/wails/v2 v2.8.0 require ( github.com/bep/debounce v1.2.1 // indirect @@ -10,25 +10,25 @@ require ( github.com/google/uuid v1.3.0 // indirect github.com/imdario/mergo v0.3.13 // indirect github.com/jchv/go-winloader v0.0.0-20210711035445-715c2860da7e // indirect - github.com/labstack/echo/v4 v4.9.1 // indirect + github.com/labstack/echo/v4 v4.10.2 // indirect github.com/labstack/gommon v0.4.0 // indirect github.com/leaanthony/go-ansi-parser v1.6.0 // indirect github.com/leaanthony/gosod v1.0.3 // indirect github.com/leaanthony/slicer v1.6.0 // indirect github.com/mattn/go-colorable v0.1.13 // indirect - github.com/mattn/go-isatty v0.0.16 // indirect + github.com/mattn/go-isatty v0.0.19 // indirect github.com/pkg/browser v0.0.0-20210911075715-681adbf594b8 // indirect github.com/pkg/errors v0.9.1 // indirect - github.com/rivo/uniseg v0.4.2 // indirect - github.com/samber/lo v1.27.1 // indirect + github.com/rivo/uniseg v0.4.4 // indirect + github.com/samber/lo v1.38.1 // indirect github.com/tkrajina/go-reflector v0.5.6 // indirect github.com/valyala/bytebufferpool v1.0.0 // indirect - github.com/valyala/fasttemplate v1.2.1 // indirect + github.com/valyala/fasttemplate v1.2.2 // indirect github.com/wailsapp/mimetype v1.4.1 // indirect - golang.org/x/crypto v0.21.0 // indirect - golang.org/x/exp v0.0.0-20220303212507-bbda1eaf7a17 // indirect - golang.org/x/net v0.23.0 // indirect - golang.org/x/sys v0.18.0 // indirect + golang.org/x/crypto v0.18.0 // indirect + golang.org/x/exp v0.0.0-20230522175609-2e198f4a06a1 // indirect + golang.org/x/net v0.20.0 // indirect + golang.org/x/sys v0.16.0 // indirect golang.org/x/text v0.14.0 // indirect ) diff --git a/v2/internal/staticanalysis/test/standard/go.sum b/v2/internal/staticanalysis/test/standard/go.sum index 2cd0cf773..96e20126c 100644 --- a/v2/internal/staticanalysis/test/standard/go.sum +++ b/v2/internal/staticanalysis/test/standard/go.sum @@ -13,6 +13,7 @@ github.com/jchv/go-winloader v0.0.0-20210711035445-715c2860da7e h1:Q3+PugElBCf4P github.com/jchv/go-winloader v0.0.0-20210711035445-715c2860da7e/go.mod h1:alcuEEnZsY1WQsagKhZDsoPCRoOijYqhZvPwLG0kzVs= github.com/labstack/echo/v4 v4.9.1 h1:GliPYSpzGKlyOhqIbG8nmHBo3i1saKWFOgh41AN3b+Y= github.com/labstack/echo/v4 v4.9.1/go.mod h1:Pop5HLc+xoc4qhTZ1ip6C0RtP7Z+4VzRLWZZFKqbbjo= +github.com/labstack/echo/v4 v4.10.2/go.mod h1:OEyqf2//K1DFdE57vw2DRgWY0M7s65IVQO2FzvI4J5k= github.com/labstack/gommon v0.4.0 h1:y7cvthEAEbU0yHOf4axH8ZG2NH8knB9iNSoTO8dyIk8= github.com/labstack/gommon v0.4.0/go.mod h1:uW6kP17uPlLJsD3ijUYn3/M5bAxtlZhMI6m3MFxTMTM= github.com/leaanthony/debme v1.2.1 h1:9Tgwf+kjcrbMQ4WnPcEIUcQuIZYqdWftzZkBr+i/oOc= @@ -32,6 +33,7 @@ github.com/mattn/go-colorable v0.1.13/go.mod h1:7S9/ev0klgBDR4GtXTXX8a3vIGJpMovk github.com/mattn/go-isatty v0.0.14/go.mod h1:7GGIvUiUoEMVVmxf/4nioHXj79iQHKdU27kJ6hsGG94= github.com/mattn/go-isatty v0.0.16 h1:bq3VjFmv/sOjHtdEhmkEV4x1AJtvUvOJ2PFAZ5+peKQ= github.com/mattn/go-isatty v0.0.16/go.mod h1:kYGgaQfpe5nmfYZH+SKPsOc2e4SrIfOl2e/yFXSvRLM= +github.com/mattn/go-isatty v0.0.19/go.mod h1:W+V8PltTTMOvKvAeJH7IuucS94S2C6jfK/D7dTCTo3Y= github.com/pkg/browser v0.0.0-20210911075715-681adbf594b8 h1:KoWmjvw+nsYOo29YJK9vDA65RGE3NrOnUtO7a+RF9HU= github.com/pkg/browser v0.0.0-20210911075715-681adbf594b8/go.mod h1:HKlIX3XHQyzLZPlr7++PzdhaXEj94dEiJgZDTsxEqUI= github.com/pkg/errors v0.9.1 h1:FEBLx1zS214owpjy7qsBeixbURkuhQAwrK5UwLGTwt4= @@ -41,8 +43,10 @@ github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZN github.com/rivo/uniseg v0.2.0/go.mod h1:J6wj4VEh+S6ZtnVlnTBMWIodfgj8LQOQFoIToxlJtxc= github.com/rivo/uniseg v0.4.2 h1:YwD0ulJSJytLpiaWua0sBDusfsCZohxjxzVTYjwxfV8= github.com/rivo/uniseg v0.4.2/go.mod h1:FN3SvrM+Zdj16jyLfmOkMNblXMcoc8DfTHruCPUcx88= +github.com/rivo/uniseg v0.4.4/go.mod h1:FN3SvrM+Zdj16jyLfmOkMNblXMcoc8DfTHruCPUcx88= github.com/samber/lo v1.27.1 h1:sTXwkRiIFIQG+G0HeAvOEnGjqWeWtI9cg5/n51KrxPg= github.com/samber/lo v1.27.1/go.mod h1:it33p9UtPMS7z72fP4gw/EIfQB2eI8ke7GR2wc6+Rhg= +github.com/samber/lo v1.38.1/go.mod h1:+m/ZKRl6ClXCE2Lgf3MsQlWfh4bn1bz6CXEOxnEXnEA= github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME= github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg= github.com/stretchr/testify v1.8.0 h1:pSgiaMZlXftHpm5L7V1+rVB+AZJydKsMxsQBIJw4PKk= @@ -53,17 +57,22 @@ github.com/valyala/bytebufferpool v1.0.0 h1:GqA5TC/0021Y/b9FG4Oi9Mr3q7XYx6Kllzaw github.com/valyala/bytebufferpool v1.0.0/go.mod h1:6bBcMArwyJ5K/AmCkWv1jt77kVWyCJ6HpOuEn7z0Csc= github.com/valyala/fasttemplate v1.2.1 h1:TVEnxayobAdVkhQfrfes2IzOB6o+z4roRkPF52WA1u4= github.com/valyala/fasttemplate v1.2.1/go.mod h1:KHLXt3tVN2HBp8eijSv/kGJopbvo7S+qRAEEKiv+SiQ= +github.com/valyala/fasttemplate v1.2.2/go.mod h1:KHLXt3tVN2HBp8eijSv/kGJopbvo7S+qRAEEKiv+SiQ= github.com/wailsapp/mimetype v1.4.1 h1:pQN9ycO7uo4vsUUuPeHEYoUkLVkaRntMnHJxVwYhwHs= github.com/wailsapp/mimetype v1.4.1/go.mod h1:9aV5k31bBOv5z6u+QP8TltzvNGJPmNJD4XlAL3U+j3o= github.com/wailsapp/wails/v2 v2.3.1 h1:ZJz+pyIBKyASkgO8JO31NuHO1gTTHmvwiHYHwei1CqM= github.com/wailsapp/wails/v2 v2.3.1/go.mod h1:zlNLI0E2c2qA6miiuAHtp0Bac8FaGH0tlhA19OssR/8= -golang.org/x/crypto v0.21.0 h1:X31++rzVUdKhX5sWmSOFZxx8UW/ldWx55cbf08iNAMA= -golang.org/x/crypto v0.21.0/go.mod h1:0BP7YvVV9gBbVKyeTG0Gyn+gZm94bibOW5BjDEYAOMs= +github.com/wailsapp/wails/v2 v2.8.0/go.mod h1:EFUGWkUX3KofO4fmKR/GmsLy3HhPH7NbyOEaMt8lBF0= +golang.org/x/crypto v0.17.0 h1:r8bRNjWL3GshPW3gkd+RpvzWrZAwPS49OmTGZ/uhM4k= +golang.org/x/crypto v0.17.0/go.mod h1:gCAAfMLgwOJRpTjQ2zCCt2OcSfYMTeZVSRtQlPC7Nq4= +golang.org/x/crypto v0.18.0/go.mod h1:R0j02AL6hcrfOiy9T4ZYp/rcWeMxM3L6QYxlOuEG1mg= golang.org/x/exp v0.0.0-20220303212507-bbda1eaf7a17 h1:3MTrJm4PyNL9NBqvYDSj3DHl46qQakyfqfWo4jgfaEM= golang.org/x/exp v0.0.0-20220303212507-bbda1eaf7a17/go.mod h1:lgLbSvA5ygNOMpwM/9anMpWVlVJ7Z+cHWq/eFuinpGE= +golang.org/x/exp v0.0.0-20230522175609-2e198f4a06a1/go.mod h1:V1LtkGg67GoY2N1AnLN78QLrzxkLyJw7RJb1gzOOz9w= golang.org/x/net v0.0.0-20210505024714-0287a6fb4125/go.mod h1:9nx3DQGgdP8bBQD5qxJ1jj9UTztislL4KSBs9R2vV5Y= -golang.org/x/net v0.23.0 h1:7EYJ93RZ9vYSZAIb2x3lnuvqO5zneoD6IvWjuhfxjTs= -golang.org/x/net v0.23.0/go.mod h1:JKghWKKOSdJwpW2GEx0Ja7fmaKnMsbu+MWVZTokSYmg= +golang.org/x/net v0.17.0 h1:pVaXccu2ozPjCXewfr1S7xza/zcXTity9cCdXQYSjIM= +golang.org/x/net v0.17.0/go.mod h1:NxSsAGuq816PNPmqtQdLE42eU2Fs7NoRIZrHJAlaCOE= +golang.org/x/net v0.20.0/go.mod h1:z8BVo6PvndSri0LbOE3hAn0apkU+1YvI6E70E9jsnvY= golang.org/x/sys v0.0.0-20190916202348-b4ddaad3f8a3/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20200810151505-1b9f1253b3ed/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20201119102817-f84b799fce68/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= @@ -73,8 +82,10 @@ golang.org/x/sys v0.0.0-20210630005230-0f9fa26af87c/go.mod h1:oPkhp1MJrh7nUepCBc golang.org/x/sys v0.0.0-20210927094055-39ccf1dd6fa6/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/sys v0.0.0-20211103235746-7861aae1554b/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/sys v0.0.0-20220811171246-fbc7d0a398ab/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= -golang.org/x/sys v0.18.0 h1:DBdB3niSjOA/O0blCZBqDefyWNYveAYMNF1Wum0DYQ4= -golang.org/x/sys v0.18.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA= +golang.org/x/sys v0.6.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.15.0 h1:h48lPFYpsTvQJZF4EKyI4aLHaev3CxivZmv7yZig9pc= +golang.org/x/sys v0.15.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA= +golang.org/x/sys v0.16.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA= golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo= golang.org/x/text v0.3.6/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ= golang.org/x/text v0.14.0 h1:ScX5w1eTa3QqT8oi6+ziP7dTV1S2+ALU0bI+0zXKWiQ= diff --git a/v2/internal/system/operatingsystem/os.go b/v2/internal/system/operatingsystem/os.go index 028a97b2e..39f1de8e0 100644 --- a/v2/internal/system/operatingsystem/os.go +++ b/v2/internal/system/operatingsystem/os.go @@ -2,10 +2,9 @@ package operatingsystem // OS contains information about the operating system type OS struct { - ID string - Name string - Version string - Branding string + ID string + Name string + Version string } // Info retrieves information about the current platform diff --git a/v2/internal/system/operatingsystem/os_windows.go b/v2/internal/system/operatingsystem/os_windows.go index a9aa05a92..38ea43a12 100644 --- a/v2/internal/system/operatingsystem/os_windows.go +++ b/v2/internal/system/operatingsystem/os_windows.go @@ -4,44 +4,10 @@ package operatingsystem import ( "fmt" - "strings" - "syscall" - "unsafe" - "golang.org/x/sys/windows" "golang.org/x/sys/windows/registry" ) -func stripNulls(str string) string { - // Split the string into substrings at each null character - substrings := strings.Split(str, "\x00") - - // Join the substrings back into a single string - strippedStr := strings.Join(substrings, "") - - return strippedStr -} - -func mustStringToUTF16Ptr(input string) *uint16 { - input = stripNulls(input) - result, err := syscall.UTF16PtrFromString(input) - if err != nil { - panic(err) - } - return result -} - -func getBranding() string { - var modBranding = syscall.NewLazyDLL("winbrand.dll") - var brandingFormatString = modBranding.NewProc("BrandingFormatString") - - windowsLong := mustStringToUTF16Ptr("%WINDOWS_LONG%\x00") - ret, _, _ := brandingFormatString.Call( - uintptr(unsafe.Pointer(windowsLong)), - ) - return windows.UTF16PtrToString((*uint16)(unsafe.Pointer(ret))) -} - func platformInfo() (*OS, error) { // Default value var result OS @@ -61,7 +27,6 @@ func platformInfo() (*OS, error) { result.Name = productName result.Version = fmt.Sprintf("%s (Build: %s)", releaseId, currentBuild) result.ID = displayVersion - result.Branding = getBranding() return &result, key.Close() } diff --git a/v2/internal/system/packagemanager/eopkg.go b/v2/internal/system/packagemanager/eopkg.go index 936127eac..dbeab96de 100644 --- a/v2/internal/system/packagemanager/eopkg.go +++ b/v2/internal/system/packagemanager/eopkg.go @@ -40,7 +40,7 @@ func (e *Eopkg) Packages() packagemap { {Name: "gcc", SystemPackage: true}, }, "pkg-config": []*Package{ - {Name: "pkgconf", SystemPackage: true}, + {Name: "pkg-config", SystemPackage: true}, }, "npm": []*Package{ {Name: "nodejs", SystemPackage: true}, diff --git a/v2/internal/typescriptify/typescriptify.go b/v2/internal/typescriptify/typescriptify.go index e732c5976..85fea9c42 100644 --- a/v2/internal/typescriptify/typescriptify.go +++ b/v2/internal/typescriptify/typescriptify.go @@ -2,7 +2,6 @@ package typescriptify import ( "bufio" - "cmp" "fmt" "io" "log" @@ -10,7 +9,6 @@ import ( "path" "reflect" "regexp" - "slices" "strings" "time" @@ -42,18 +40,6 @@ const ( jsVariableNameRegex = `^([A-Z]|[a-z]|\$|_)([A-Z]|[a-z]|[0-9]|\$|_)*$` ) -var jsVariableUnsafeChars = regexp.MustCompile(`[^A-Za-z0-9_]`) - -func nameTypeOf(typeOf reflect.Type) string { - tname := typeOf.Name() - gidx := strings.IndexRune(tname, '[') - if gidx > 0 { // its a generic type - rem := strings.SplitN(tname, "[", 2) - tname = rem[0] + "_" + jsVariableUnsafeChars.ReplaceAllLiteralString(rem[1], "_") - } - return tname -} - // TypeOptions overrides options set by `ts_*` tags. type TypeOptions struct { TSType string @@ -275,34 +261,15 @@ func (t *TypeScriptify) AddType(typeOf reflect.Type) *TypeScriptify { func (t *typeScriptClassBuilder) AddMapField(fieldName string, field reflect.StructField) { keyType := field.Type.Key() valueType := field.Type.Elem() - valueTypeName := nameTypeOf(valueType) - valueTypeSuffix := "" - valueTypePrefix := "" - if valueType.Kind() == reflect.Ptr { - valueType = valueType.Elem() - valueTypeName = nameTypeOf(valueType) - } - if valueType.Kind() == reflect.Array || valueType.Kind() == reflect.Slice { - arrayDepth := 1 - for valueType.Elem().Kind() == reflect.Array || valueType.Elem().Kind() == reflect.Slice { - valueType = valueType.Elem() - arrayDepth++ - } - valueType = valueType.Elem() - valueTypeName = nameTypeOf(valueType) - valueTypeSuffix = strings.Repeat(">", arrayDepth) - valueTypePrefix = strings.Repeat("Array<", arrayDepth) - } - if valueType.Kind() == reflect.Ptr { - valueType = valueType.Elem() - valueTypeName = nameTypeOf(valueType) - } + valueTypeName := valueType.Name() if name, ok := t.types[valueType.Kind()]; ok { valueTypeName = name } - if valueType.Kind() == reflect.Map { - // TODO: support nested maps - valueTypeName = "any" // valueType.Elem().Name() + if valueType.Kind() == reflect.Array || valueType.Kind() == reflect.Slice { + valueTypeName = valueType.Elem().Name() + "[]" + } + if valueType.Kind() == reflect.Ptr { + valueTypeName = valueType.Elem().Name() } if valueType.Kind() == reflect.Struct && differentNamespaces(t.namespace, valueType) { valueTypeName = valueType.String() @@ -327,13 +294,11 @@ func (t *typeScriptClassBuilder) AddMapField(fieldName string, field reflect.Str fieldName = fmt.Sprintf(`"%s"?`, strippedFieldName) } } - t.fields = append(t.fields, fmt.Sprintf("%s%s: Record<%s, %s>;", t.indent, fieldName, keyTypeStr, valueTypePrefix+valueTypeName+valueTypeSuffix)) + t.fields = append(t.fields, fmt.Sprintf("%s%s: {[key: %s]: %s};", t.indent, fieldName, keyTypeStr, valueTypeName)) if valueType.Kind() == reflect.Struct { - t.constructorBody = append(t.constructorBody, fmt.Sprintf("%s%sthis%s = this.convertValues(source[\"%s\"], %s, true);", - t.indent, t.indent, dotField, strippedFieldName, t.prefix+valueTypePrefix+valueTypeName+valueTypeSuffix+t.suffix)) + t.constructorBody = append(t.constructorBody, fmt.Sprintf("%s%sthis%s = this.convertValues(source[\"%s\"], %s, true);", t.indent, t.indent, dotField, strippedFieldName, t.prefix+valueTypeName+t.suffix)) } else { - t.constructorBody = append(t.constructorBody, fmt.Sprintf("%s%sthis%s = source[\"%s\"];", - t.indent, t.indent, dotField, strippedFieldName)) + t.constructorBody = append(t.constructorBody, fmt.Sprintf("%s%sthis%s = source[\"%s\"];", t.indent, t.indent, dotField, strippedFieldName)) } } @@ -374,9 +339,6 @@ func (t *TypeScriptify) AddEnum(values interface{}) *TypeScriptify { elements = append(elements, el) } - slices.SortFunc(elements, func(a, b enumElement) int { - return cmp.Compare(a.name, b.name) - }) ty := reflect.TypeOf(elements[0].value) t.enums[ty] = elements t.enumTypes = append(t.enumTypes, EnumType{Type: ty}) @@ -521,6 +483,9 @@ func (t TypeScriptify) ConvertToFile(fileName string, packageName string) error if _, err := f.WriteString(converted); err != nil { return err } + if err != nil { + return err + } return nil } @@ -536,7 +501,7 @@ func (t *TypeScriptify) convertEnum(depth int, typeOf reflect.Type, elements []e } t.alreadyConverted[typeOf.String()] = true - entityName := t.Prefix + nameTypeOf(typeOf) + t.Suffix + entityName := t.Prefix + typeOf.Name() + t.Suffix result := "enum " + entityName + " {\n" for _, val := range elements { @@ -588,21 +553,7 @@ func (t *TypeScriptify) getFieldOptions(structType reflect.Type, field reflect.S func (t *TypeScriptify) getJSONFieldName(field reflect.StructField, isPtr bool) string { jsonFieldName := "" - // function, complex, and channel types cannot be json-encoded - if field.Type.Kind() == reflect.Chan || - field.Type.Kind() == reflect.Func || - field.Type.Kind() == reflect.UnsafePointer || - field.Type.Kind() == reflect.Complex128 || - field.Type.Kind() == reflect.Complex64 { - return "" - } - jsonTag, hasTag := field.Tag.Lookup("json") - if !hasTag && field.IsExported() { - jsonFieldName = field.Name - if isPtr { - jsonFieldName += "?" - } - } + jsonTag := field.Tag.Get("json") if len(jsonTag) > 0 { jsonTagParts := strings.Split(jsonTag, ",") if len(jsonTagParts) > 0 { @@ -642,7 +593,7 @@ func (t *TypeScriptify) convertType(depth int, typeOf reflect.Type, customCode m t.alreadyConverted[typeOf.String()] = true - entityName := t.Prefix + nameTypeOf(typeOf) + t.Suffix + entityName := t.Prefix + typeOf.Name() + t.Suffix if typeClashWithReservedKeyword(entityName) { warnAboutTypesClash(entityName) @@ -702,10 +653,8 @@ func (t *TypeScriptify) convertType(depth int, typeOf reflect.Type, customCode m } isKnownType := t.KnownStructs.Contains(getStructFQN(field.Type.String())) - if !isKnownType { - println("KnownStructs:", t.KnownStructs.Join("\t")) - println("Not found:", getStructFQN(field.Type.String())) - } + println("KnownStructs:", t.KnownStructs.Join("\t")) + println(getStructFQN(field.Type.String())) builder.AddStructField(jsonFieldName, field, !isKnownType) } else if field.Type.Kind() == reflect.Map { t.logf(depth, "- map field %s.%s", typeOf.Name(), field.Name) @@ -751,15 +700,11 @@ func (t *TypeScriptify) convertType(depth int, typeOf reflect.Type, customCode m } arrayDepth := 1 - for field.Type.Elem().Kind() == reflect.Slice || field.Type.Elem().Kind() == reflect.Array { // Slice of slices: + for field.Type.Elem().Kind() == reflect.Slice { // Slice of slices: field.Type = field.Type.Elem() arrayDepth++ } - if field.Type.Elem().Kind() == reflect.Ptr { // extract ptr type - field.Type = field.Type.Elem() - } - if field.Type.Elem().Kind() == reflect.Struct { // Slice of structs: t.logf(depth, "- struct slice %s.%s (%s)", typeOf.Name(), field.Name, field.Type.String()) typeScriptChunk, err := t.convertType(depth+1, field.Type.Elem(), customCode) @@ -849,12 +794,8 @@ type typeScriptClassBuilder struct { } func (t *typeScriptClassBuilder) AddSimpleArrayField(fieldName string, field reflect.StructField, arrayDepth int, opts TypeOptions) error { - fieldType := nameTypeOf(field.Type.Elem()) - kind := field.Type.Elem().Kind() - typeScriptType, ok := t.types[kind] - if !ok { - typeScriptType = "any" - } + fieldType, kind := field.Type.Elem().Name(), field.Type.Elem().Kind() + typeScriptType := t.types[kind] if len(fieldName) > 0 { strippedFieldName := strings.ReplaceAll(fieldName, "?", "") @@ -873,14 +814,9 @@ func (t *typeScriptClassBuilder) AddSimpleArrayField(fieldName string, field ref } func (t *typeScriptClassBuilder) AddSimpleField(fieldName string, field reflect.StructField, opts TypeOptions) error { - fieldType := nameTypeOf(field.Type) - kind := field.Type.Kind() - - typeScriptType, ok := t.types[kind] - if !ok { - typeScriptType = "any" - } + fieldType, kind := field.Type.Name(), field.Type.Kind() + typeScriptType := t.types[kind] if len(opts.TSType) > 0 { typeScriptType = opts.TSType } @@ -902,7 +838,7 @@ func (t *typeScriptClassBuilder) AddSimpleField(fieldName string, field reflect. } func (t *typeScriptClassBuilder) AddEnumField(fieldName string, field reflect.StructField) { - fieldType := nameTypeOf(field.Type) + fieldType := field.Type.Name() t.addField(fieldName, t.prefix+fieldType+t.suffix, false) strippedFieldName := strings.ReplaceAll(fieldName, "?", "") t.addInitializerFieldLine(strippedFieldName, fmt.Sprintf("source[\"%s\"]", strippedFieldName)) @@ -912,7 +848,7 @@ func (t *typeScriptClassBuilder) AddStructField(fieldName string, field reflect. strippedFieldName := strings.ReplaceAll(fieldName, "?", "") classname := "null" namespace := strings.Split(field.Type.String(), ".")[0] - fqname := t.prefix + nameTypeOf(field.Type) + t.suffix + fqname := t.prefix + field.Type.Name() + t.suffix if namespace != t.namespace { fqname = namespace + "." + fqname } @@ -931,7 +867,7 @@ func (t *typeScriptClassBuilder) AddStructField(fieldName string, field reflect. } func (t *typeScriptClassBuilder) AddArrayOfStructsField(fieldName string, field reflect.StructField, arrayDepth int) { - fieldType := nameTypeOf(field.Type.Elem()) + fieldType := field.Type.Elem().Name() if differentNamespaces(t.namespace, field.Type.Elem()) { fieldType = field.Type.Elem().String() } diff --git a/v2/pkg/assetserver/assethandler.go b/v2/pkg/assetserver/assethandler.go index b8e2df076..b56a5d033 100644 --- a/v2/pkg/assetserver/assethandler.go +++ b/v2/pkg/assetserver/assethandler.go @@ -21,9 +21,6 @@ type Logger interface { Error(message string, args ...interface{}) } -//go:embed defaultindex.html -var defaultHTML []byte - const ( indexHTML = "index.html" ) @@ -120,7 +117,9 @@ func (d *assetHandler) serveFSFile(rw http.ResponseWriter, req *http.Request, fi if err != nil { return err } - defer file.Close() + defer func() { + _ = file.Close() + }() statInfo, err := file.Stat() if err != nil { @@ -143,7 +142,9 @@ func (d *assetHandler) serveFSFile(rw http.ResponseWriter, req *http.Request, fi if err != nil { return err } - defer file.Close() + defer func() { + _ = file.Close() + }() statInfo, err = file.Stat() if err != nil { diff --git a/v2/pkg/assetserver/webview/responsewriter_darwin.go b/v2/pkg/assetserver/webview/responsewriter_darwin.go index a3c73b6f1..77de3c455 100644 --- a/v2/pkg/assetserver/webview/responsewriter_darwin.go +++ b/v2/pkg/assetserver/webview/responsewriter_darwin.go @@ -69,7 +69,6 @@ import "C" import ( "encoding/json" - "fmt" "net/http" "unsafe" ) @@ -99,31 +98,16 @@ func (rw *responseWriter) Write(buf []byte) (int, error) { rw.WriteHeader(http.StatusOK) + var content unsafe.Pointer var contentLen int if buf != nil { + content = unsafe.Pointer(&buf[0]) contentLen = len(buf) } - if contentLen > 0 { - // Create a C array to hold the data - cBuf := C.malloc(C.size_t(contentLen)) - if cBuf == nil { - return 0, fmt.Errorf("memory allocation failed for %d bytes", contentLen) - } - defer C.free(cBuf) - - // Copy the Go slice to the C array - C.memcpy(cBuf, unsafe.Pointer(&buf[0]), C.size_t(contentLen)) - - if !C.URLSchemeTaskDidReceiveData(rw.r.task, cBuf, C.int(contentLen)) { - return 0, errRequestStopped - } - } else { - if !C.URLSchemeTaskDidReceiveData(rw.r.task, nil, 0) { - return 0, errRequestStopped - } + if !C.URLSchemeTaskDidReceiveData(rw.r.task, content, C.int(contentLen)) { + return 0, errRequestStopped } - return contentLen, nil } diff --git a/v2/pkg/buildassets/build/darwin/Info.dev.plist b/v2/pkg/buildassets/build/darwin/Info.dev.plist index 14121ef7c..04727c23f 100644 --- a/v2/pkg/buildassets/build/darwin/Info.dev.plist +++ b/v2/pkg/buildassets/build/darwin/Info.dev.plist @@ -6,7 +6,7 @@ CFBundleName {{.Info.ProductName}} CFBundleExecutable - {{.OutputFilename}} + {{.Name}} CFBundleIdentifier com.wails.{{.Name}} CFBundleVersion diff --git a/v2/pkg/buildassets/build/darwin/Info.plist b/v2/pkg/buildassets/build/darwin/Info.plist index d17a7475c..19cc9370c 100644 --- a/v2/pkg/buildassets/build/darwin/Info.plist +++ b/v2/pkg/buildassets/build/darwin/Info.plist @@ -6,7 +6,7 @@ CFBundleName {{.Info.ProductName}} CFBundleExecutable - {{.OutputFilename}} + {{.Name}} CFBundleIdentifier com.wails.{{.Name}} CFBundleVersion diff --git a/v2/pkg/buildassets/build/windows/installer/wails_tools.nsh b/v2/pkg/buildassets/build/windows/installer/wails_tools.nsh index 2f6d32195..f9c0f8852 100644 --- a/v2/pkg/buildassets/build/windows/installer/wails_tools.nsh +++ b/v2/pkg/buildassets/build/windows/installer/wails_tools.nsh @@ -158,7 +158,7 @@ RequestExecutionLevel "${REQUEST_EXECUTION_LEVEL}" ${If} ${REQUEST_EXECUTION_LEVEL} == "user" # If the installer is run in user level, check the user specific key exists and is not empty then webview2 is already installed - ReadRegStr $0 HKCU "Software\Microsoft\EdgeUpdate\Clients\{F3017226-FE2A-4295-8BDF-00C3A9A7E4C5}" "pv" + ReadRegStr $0 HKCU "Software\Microsoft\EdgeUpdate\Clients{F3017226-FE2A-4295-8BDF-00C3A9A7E4C5}" "pv" ${If} $0 != "" Goto ok ${EndIf} diff --git a/v2/pkg/buildassets/buildassets.go b/v2/pkg/buildassets/buildassets.go index 6934b98bd..778d97fbf 100644 --- a/v2/pkg/buildassets/buildassets.go +++ b/v2/pkg/buildassets/buildassets.go @@ -102,9 +102,8 @@ func ReadOriginalFileWithProjectDataAndSave(projectData *project.Project, file s } type assetData struct { - Name string - Info project.Info - OutputFilename string + Name string + Info project.Info } func resolveProjectData(content []byte, projectData *project.Project) ([]byte, error) { @@ -114,9 +113,8 @@ func resolveProjectData(content []byte, projectData *project.Project) ([]byte, e } data := &assetData{ - Name: projectData.Name, - Info: projectData.Info, - OutputFilename: projectData.OutputFilename, + Name: projectData.Name, + Info: projectData.Info, } var out bytes.Buffer diff --git a/v2/pkg/commands/bindings/bindings.go b/v2/pkg/commands/bindings/bindings.go index 82ce0d58f..a4a84e1be 100644 --- a/v2/pkg/commands/bindings/bindings.go +++ b/v2/pkg/commands/bindings/bindings.go @@ -53,14 +53,7 @@ func GenerateBindings(options Options) (string, error) { } } - envBuild := os.Environ() - envBuild = shell.SetEnv(envBuild, "GOOS", runtime.GOOS) - envBuild = shell.SetEnv(envBuild, "GOARCH", runtime.GOARCH) - // wailsbindings is executed on the build machine. - // So, use the default C compiler, not the one set for cross compiling. - envBuild = shell.RemoveEnv(envBuild, "CC") - - stdout, stderr, err = shell.RunCommandWithEnv(envBuild, workingDirectory, options.Compiler, "build", "-buildvcs=false", "-tags", tagString, "-o", filename) + stdout, stderr, err = shell.RunCommand(workingDirectory, options.Compiler, "build", "-tags", tagString, "-o", filename) if err != nil { return stdout, fmt.Errorf("%s\n%s\n%s", stdout, stderr, err) } diff --git a/v2/pkg/commands/build/base.go b/v2/pkg/commands/build/base.go index 239932ce8..6595aff0f 100644 --- a/v2/pkg/commands/build/base.go +++ b/v2/pkg/commands/build/base.go @@ -193,8 +193,6 @@ func (b *BaseBuilder) CompileProject(options *Options) error { // Default go build command commands.Add("build") - commands.Add("-buildvcs=false") - // Add better debugging flags if options.Mode == Dev || options.Mode == Debug { commands.Add("-gcflags") @@ -309,9 +307,7 @@ func (b *BaseBuilder) CompileProject(options *Options) error { if v != "" { v += " " } - if !strings.Contains(v, "-mmacosx-version-min") { - v += "-mmacosx-version-min=10.13" - } + v += "-mmacosx-version-min=10.13" } return v }) @@ -348,9 +344,7 @@ func (b *BaseBuilder) CompileProject(options *Options) error { if addUTIFramework { v += "-framework UniformTypeIdentifiers " } - if !strings.Contains(v, "-mmacosx-version-min") { - v += "-mmacosx-version-min=10.13" - } + v += "-mmacosx-version-min=10.13" return v }) diff --git a/v2/pkg/commands/build/build.go b/v2/pkg/commands/build/build.go index 7263f63ae..261f4c6d7 100644 --- a/v2/pkg/commands/build/build.go +++ b/v2/pkg/commands/build/build.go @@ -69,7 +69,6 @@ type Options struct { Obfuscated bool // Indicates that bound methods should be obfuscated GarbleArgs string // The arguments for Garble SkipBindings bool // Skip binding generation - SkipEmbedCreate bool // Skip creation of embed files } // Build the project! @@ -121,10 +120,8 @@ func Build(options *Options) (string, error) { } // Create embed directories if they don't exist - if !options.SkipEmbedCreate { - if err := CreateEmbedDirectories(cwd, options); err != nil { - return "", err - } + if err := CreateEmbedDirectories(cwd, options); err != nil { + return "", err } // Generate bindings diff --git a/v2/pkg/commands/build/packager.go b/v2/pkg/commands/build/packager.go index d406256f9..b58cbbdf3 100644 --- a/v2/pkg/commands/build/packager.go +++ b/v2/pkg/commands/build/packager.go @@ -83,10 +83,10 @@ func packageApplicationForDarwin(options *Options) error { return err } // Copy binary - packedBinaryPath := filepath.Join(exeDir, options.ProjectData.OutputFilename) + packedBinaryPath := filepath.Join(exeDir, options.ProjectData.Name) err = fs.MoveFile(options.CompiledBinary, packedBinaryPath) if err != nil { - return errors.Wrap(err, "Cannot move file: "+options.CompiledBinary) + return errors.Wrap(err, "Cannot move file: "+options.ProjectData.OutputFilename) } // Generate Info.plist diff --git a/v2/pkg/commands/buildtags/buildtags.go b/v2/pkg/commands/buildtags/buildtags.go index 5cca16acf..70820d03d 100644 --- a/v2/pkg/commands/buildtags/buildtags.go +++ b/v2/pkg/commands/buildtags/buildtags.go @@ -8,7 +8,7 @@ import ( ) // Parse parses the given tags string and returns -// a cleaned slice of strings. Both comma and space delimited +// a cleaned slice of strings. Both comma and space delimeted // tags are supported but not mixed. If mixed, an error is returned. func Parse(tags string) ([]string, error) { if tags == "" { diff --git a/v2/pkg/git/git.go b/v2/pkg/git/git.go index a0ac68ca9..319c5672b 100644 --- a/v2/pkg/git/git.go +++ b/v2/pkg/git/git.go @@ -1,8 +1,7 @@ package git import ( - "encoding/json" - "fmt" + "html/template" "runtime" "strings" @@ -31,31 +30,9 @@ func Email() (string, error) { // Name tries to retrieve the func Name() (string, error) { - errMsg := "failed to retrieve git user name: %w" stdout, _, err := shell.RunCommand(".", gitcommand(), "config", "user.name") - if err != nil { - return "", fmt.Errorf(errMsg, err) - } - name := strings.TrimSpace(stdout) - return EscapeName(name) -} - -func EscapeName(str string) (string, error) { - b, err := json.Marshal(str) - if err != nil { - return "", err - } - // Remove the surrounding quotes - escaped := string(b[1 : len(b)-1]) - - // Check if username is JSON compliant - var js json.RawMessage - jsonVal := fmt.Sprintf(`{"name": "%s"}`, escaped) - err = json.Unmarshal([]byte(jsonVal), &js) - if err != nil { - return "", fmt.Errorf("failed to retrieve git user name: %w", err) - } - return escaped, nil + name := template.JSEscapeString(strings.TrimSpace(stdout)) + return name, err } func InitRepo(projectDir string) error { diff --git a/v2/pkg/git/git_test.go b/v2/pkg/git/git_test.go deleted file mode 100644 index 238008ec3..000000000 --- a/v2/pkg/git/git_test.go +++ /dev/null @@ -1,44 +0,0 @@ -package git - -import ( - "testing" -) - -func TestEscapeName1(t *testing.T) { - type args struct { - str string - } - tests := []struct { - name string - args args - want string - wantErr bool - }{ - { - name: "Escape Apostrophe", - args: args{ - str: `John O'Keefe`, - }, - want: `John O'Keefe`, - }, - { - name: "Escape backslash", - args: args{ - str: `MYDOMAIN\USER`, - }, - want: `MYDOMAIN\\USER`, - }, - } - for _, tt := range tests { - t.Run(tt.name, func(t *testing.T) { - got, err := EscapeName(tt.args.str) - if (err != nil) != tt.wantErr { - t.Errorf("EscapeName() error = %v, wantErr %v", err, tt.wantErr) - return - } - if got != tt.want { - t.Errorf("EscapeName() got = %v, want %v", got, tt.want) - } - }) - } -} diff --git a/v2/pkg/logger/logger.go b/v2/pkg/logger/logger.go index 990dffe75..abc288265 100644 --- a/v2/pkg/logger/logger.go +++ b/v2/pkg/logger/logger.go @@ -41,24 +41,6 @@ func StringToLogLevel(input string) (LogLevel, error) { return result, nil } -// String returns the string representation of the LogLevel -func (l LogLevel) String() string { - switch l { - case TRACE: - return "trace" - case DEBUG: - return "debug" - case INFO: - return "info" - case WARNING: - return "warning" - case ERROR: - return "error" - default: - return "debug" - } -} - // Logger specifies the methods required to attach // a logger to a Wails application type Logger interface { diff --git a/v2/pkg/menu/menuitem.go b/v2/pkg/menu/menuitem.go index bffc522d8..264b2ebd4 100644 --- a/v2/pkg/menu/menuitem.go +++ b/v2/pkg/menu/menuitem.go @@ -22,7 +22,7 @@ type MenuItem struct { Hidden bool // Checked indicates if the item is selected (used by Checkbox and Radio types only) Checked bool - // SubMenu contains a list of menu items that will be shown as a submenu + // Submenu contains a list of menu items that will be shown as a submenu // SubMenu []*MenuItem `json:"SubMenu,omitempty"` SubMenu *Menu diff --git a/v2/pkg/options/linux/linux.go b/v2/pkg/options/linux/linux.go index 797450c27..1287f1da2 100644 --- a/v2/pkg/options/linux/linux.go +++ b/v2/pkg/options/linux/linux.go @@ -4,10 +4,10 @@ package linux type WebviewGpuPolicy int const ( - // WebviewGpuPolicyAlways Hardware acceleration is always enabled. - WebviewGpuPolicyAlways WebviewGpuPolicy = iota // WebviewGpuPolicyOnDemand Hardware acceleration is enabled/disabled as request by web contents. - WebviewGpuPolicyOnDemand + WebviewGpuPolicyOnDemand WebviewGpuPolicy = iota + // WebviewGpuPolicyAlways Hardware acceleration is always enabled. + WebviewGpuPolicyAlways // WebviewGpuPolicyNever Hardware acceleration is always disabled. WebviewGpuPolicyNever ) diff --git a/v2/pkg/options/mac/mac.go b/v2/pkg/options/mac/mac.go index 152145114..85e52755b 100644 --- a/v2/pkg/options/mac/mac.go +++ b/v2/pkg/options/mac/mac.go @@ -18,7 +18,6 @@ type AboutInfo struct { type Options struct { TitleBar *TitleBar Appearance AppearanceType - ContentProtection bool WebviewIsTransparent bool WindowIsTranslucent bool Preferences *Preferences diff --git a/v2/pkg/options/options.go b/v2/pkg/options/options.go index 0f62d5e4b..282a25691 100644 --- a/v2/pkg/options/options.go +++ b/v2/pkg/options/options.go @@ -98,12 +98,6 @@ type App struct { // DragAndDrop options for drag and drop behavior DragAndDrop *DragAndDrop - - // DisablePanicRecovery disables the panic recovery system in messages processing - DisablePanicRecovery bool - - // List of additional allowed origins for bindings in format "https://*.myapp.com,https://example.com" - BindingsAllowedOrigins string } type ErrorFormatter func(error) any diff --git a/v2/pkg/options/windows/windows.go b/v2/pkg/options/windows/windows.go index 1fe351455..39b91ee8d 100644 --- a/v2/pkg/options/windows/windows.go +++ b/v2/pkg/options/windows/windows.go @@ -35,27 +35,6 @@ const ( Tabbed BackdropType = 4 ) -const ( - // Default is 0, which means no changes to the default Windows DLL search behavior - DLLSearchDefault uint32 = 0 - // LoadLibrary flags for determining from where to search for a DLL - DLLSearchDontResolveDllReferences uint32 = 0x1 // windows.DONT_RESOLVE_DLL_REFERENCES - DLLSearchAsDataFile uint32 = 0x2 // windows.LOAD_LIBRARY_AS_DATAFILE - DLLSearchWithAlteredPath uint32 = 0x8 // windows.LOAD_WITH_ALTERED_SEARCH_PATH - DLLSearchIgnoreCodeAuthzLevel uint32 = 0x10 // windows.LOAD_IGNORE_CODE_AUTHZ_LEVEL - DLLSearchAsImageResource uint32 = 0x20 // windows.LOAD_LIBRARY_AS_IMAGE_RESOURCE - DLLSearchAsDataFileExclusive uint32 = 0x40 // windows.LOAD_LIBRARY_AS_DATAFILE_EXCLUSIVE - DLLSearchRequireSignedTarget uint32 = 0x80 // windows.LOAD_LIBRARY_REQUIRE_SIGNED_TARGET - DLLSearchDllLoadDir uint32 = 0x100 // windows.LOAD_LIBRARY_SEARCH_DLL_LOAD_DIR - DLLSearchApplicationDir uint32 = 0x200 // windows.LOAD_LIBRARY_SEARCH_APPLICATION_DIR - DLLSearchUserDirs uint32 = 0x400 // windows.LOAD_LIBRARY_SEARCH_USER_DIRS - DLLSearchSystem32 uint32 = 0x800 // windows.LOAD_LIBRARY_SEARCH_SYSTEM32 - DLLSearchDefaultDirs uint32 = 0x1000 // windows.LOAD_LIBRARY_SEARCH_DEFAULT_DIRS - DLLSearchSafeCurrentDirs uint32 = 0x2000 // windows.LOAD_LIBRARY_SAFE_CURRENT_DIRS - DLLSearchSystem32NoForwarder uint32 = 0x4000 // windows.LOAD_LIBRARY_SEARCH_SYSTEM32_NO_FORWARDER - DLLSearchOsIntegrityContinuity uint32 = 0x8000 // windows.LOAD_LIBRARY_OS_INTEGRITY_CONTINUITY -) - func RGB(r, g, b uint8) int32 { col := int32(b) col = col<<8 | int32(g) @@ -82,7 +61,6 @@ type ThemeSettings struct { // Options are options specific to Windows type Options struct { - ContentProtection bool WebviewIsTransparent bool WindowIsTranslucent bool DisableWindowIcon bool @@ -140,14 +118,6 @@ type Options struct { // Configure whether swipe gestures should be enabled EnableSwipeGestures bool - - // Class name for the window. If empty, 'wailsWindow' will be used. - WindowClassName string - - // DLLSearchPaths controls which directories are searched when loading DLLs - // Set to 0 for default behavior, or combine multiple flags with bitwise OR - // Example: DLLSearchApplicationDir | DLLSearchSystem32 - DLLSearchPaths uint32 } func DefaultMessages() *Messages { diff --git a/v2/pkg/runtime/signal_linux.go b/v2/pkg/runtime/signal_linux.go deleted file mode 100644 index 6a7ed5db3..000000000 --- a/v2/pkg/runtime/signal_linux.go +++ /dev/null @@ -1,65 +0,0 @@ -//go:build linux - -package runtime - -/* -#include -#include -#include -#include - -static void fix_signal(int signum) -{ - struct sigaction st; - - if (sigaction(signum, NULL, &st) < 0) { - return; - } - st.sa_flags |= SA_ONSTACK; - sigaction(signum, &st, NULL); -} - -static void fix_all_signals() -{ -#if defined(SIGSEGV) - fix_signal(SIGSEGV); -#endif -#if defined(SIGBUS) - fix_signal(SIGBUS); -#endif -#if defined(SIGFPE) - fix_signal(SIGFPE); -#endif -#if defined(SIGABRT) - fix_signal(SIGABRT); -#endif -} -*/ -import "C" - -// ResetSignalHandlers resets signal handlers to allow panic recovery. -// -// On Linux, WebKit (used for the webview) may install signal handlers without -// the SA_ONSTACK flag, which prevents Go from properly recovering from panics -// caused by nil pointer dereferences or other memory access violations. -// -// Call this function immediately before code that might panic to ensure -// the signal handlers are properly configured for Go's panic recovery mechanism. -// -// Example usage: -// -// go func() { -// defer func() { -// if err := recover(); err != nil { -// log.Printf("Recovered from panic: %v", err) -// } -// }() -// runtime.ResetSignalHandlers() -// // Code that might panic... -// }() -// -// Note: This function only has an effect on Linux. On other platforms, -// it is a no-op. -func ResetSignalHandlers() { - C.fix_all_signals() -} diff --git a/v2/pkg/runtime/signal_other.go b/v2/pkg/runtime/signal_other.go deleted file mode 100644 index 3171a700c..000000000 --- a/v2/pkg/runtime/signal_other.go +++ /dev/null @@ -1,18 +0,0 @@ -//go:build !linux - -package runtime - -// ResetSignalHandlers resets signal handlers to allow panic recovery. -// -// On Linux, WebKit (used for the webview) may install signal handlers without -// the SA_ONSTACK flag, which prevents Go from properly recovering from panics -// caused by nil pointer dereferences or other memory access violations. -// -// Call this function immediately before code that might panic to ensure -// the signal handlers are properly configured for Go's panic recovery mechanism. -// -// Note: This function only has an effect on Linux. On other platforms, -// it is a no-op. -func ResetSignalHandlers() { - // No-op on non-Linux platforms -} diff --git a/v2/pkg/templates/base/go.mod.tmpl b/v2/pkg/templates/base/go.mod.tmpl index 4b34d1668..dd7184879 100644 --- a/v2/pkg/templates/base/go.mod.tmpl +++ b/v2/pkg/templates/base/go.mod.tmpl @@ -1,6 +1,6 @@ module changeme -go 1.23.0 +go 1.18 require github.com/wailsapp/wails/v2 {{.WailsVersion}} diff --git a/v2/pkg/templates/generate/assets/common/frontend/wailsjs/runtime/runtime.d.ts b/v2/pkg/templates/generate/assets/common/frontend/wailsjs/runtime/runtime.d.ts index 336fb07aa..e0d662b38 100644 --- a/v2/pkg/templates/generate/assets/common/frontend/wailsjs/runtime/runtime.d.ts +++ b/v2/pkg/templates/generate/assets/common/frontend/wailsjs/runtime/runtime.d.ts @@ -52,10 +52,6 @@ export function EventsOnce(eventName: string, callback: (...data: any) => void): // unregisters the listener for the given event name. export function EventsOff(eventName: string): void; -// [EventsOffAll](https://wails.io/docs/reference/runtime/events#eventsoffall) -// unregisters all event listeners. -export function EventsOffAll(): void; - // [LogPrint](https://wails.io/docs/reference/runtime/log#logprint) // logs the given message as a raw message export function LogPrint(message: string): void; @@ -130,7 +126,7 @@ export function WindowUnfullscreen(): void; // [WindowSetSize](https://wails.io/docs/reference/runtime/window#windowsetsize) // Sets the width and height of the window. -export function WindowSetSize(width: number, height: number): void; +export function WindowSetSize(width: number, height: number): Promise; // [WindowGetSize](https://wails.io/docs/reference/runtime/window#windowgetsize) // Gets the width and height of the window. diff --git a/v2/pkg/templates/generate/assets/common/frontend/wailsjs/runtime/runtime.js b/v2/pkg/templates/generate/assets/common/frontend/wailsjs/runtime/runtime.js index b5ae16d56..2c3dafcc3 100644 --- a/v2/pkg/templates/generate/assets/common/frontend/wailsjs/runtime/runtime.js +++ b/v2/pkg/templates/generate/assets/common/frontend/wailsjs/runtime/runtime.js @@ -48,10 +48,6 @@ export function EventsOff(eventName) { return window.runtime.EventsOff(eventName); } -export function EventsOffAll() { - return window.runtime.EventsOffAll(); -} - export function EventsOnce(eventName, callback) { EventsOnMultiple(eventName, callback, 1); } diff --git a/v2/pkg/templates/generate/assets/vue-ts/frontend/READ-THIS.md b/v2/pkg/templates/generate/assets/vue-ts/frontend/READ-THIS.md new file mode 100644 index 000000000..15b2483d9 --- /dev/null +++ b/v2/pkg/templates/generate/assets/vue-ts/frontend/READ-THIS.md @@ -0,0 +1,4 @@ +This template uses a work around as the default template does not compile due to this issue: +https://github.com/vuejs/core/issues/1228 + +In `tsconfig.json`, `isolatedModules` is set to `false` rather than `true` to work around the issue. \ No newline at end of file diff --git a/v2/pkg/templates/generate/plain/go.mod.tmpl b/v2/pkg/templates/generate/plain/go.mod.tmpl index f6d0daec4..e01fbe9e7 100644 --- a/v2/pkg/templates/generate/plain/go.mod.tmpl +++ b/v2/pkg/templates/generate/plain/go.mod.tmpl @@ -1,6 +1,6 @@ module changeme -go 1.23.0 +go 1.18 require github.com/wailsapp/wails/v2 {{.WailsVersion}} diff --git a/v2/pkg/templates/templates.go b/v2/pkg/templates/templates.go index e18185520..9b42ef365 100644 --- a/v2/pkg/templates/templates.go +++ b/v2/pkg/templates/templates.go @@ -186,16 +186,7 @@ func Install(options *Options) (bool, *Template, error) { return false, nil, err } options.TargetDir = targetDir - if fs.DirExists(options.TargetDir) { - // Check if directory is non-empty - entries, err := os.ReadDir(options.TargetDir) - if err != nil { - return false, nil, err - } - if len(entries) > 0 { - return false, nil, fmt.Errorf("cannot initialise project in non-empty directory: %s", options.TargetDir) - } - } else { + if !fs.DirExists(options.TargetDir) { err := fs.Mkdir(options.TargetDir) if err != nil { return false, nil, err diff --git a/v2/pkg/templates/templates/lit-ts/frontend/wailsjs/runtime/runtime.d.ts b/v2/pkg/templates/templates/lit-ts/frontend/wailsjs/runtime/runtime.d.ts index 336fb07aa..e0d662b38 100644 --- a/v2/pkg/templates/templates/lit-ts/frontend/wailsjs/runtime/runtime.d.ts +++ b/v2/pkg/templates/templates/lit-ts/frontend/wailsjs/runtime/runtime.d.ts @@ -52,10 +52,6 @@ export function EventsOnce(eventName: string, callback: (...data: any) => void): // unregisters the listener for the given event name. export function EventsOff(eventName: string): void; -// [EventsOffAll](https://wails.io/docs/reference/runtime/events#eventsoffall) -// unregisters all event listeners. -export function EventsOffAll(): void; - // [LogPrint](https://wails.io/docs/reference/runtime/log#logprint) // logs the given message as a raw message export function LogPrint(message: string): void; @@ -130,7 +126,7 @@ export function WindowUnfullscreen(): void; // [WindowSetSize](https://wails.io/docs/reference/runtime/window#windowsetsize) // Sets the width and height of the window. -export function WindowSetSize(width: number, height: number): void; +export function WindowSetSize(width: number, height: number): Promise; // [WindowGetSize](https://wails.io/docs/reference/runtime/window#windowgetsize) // Gets the width and height of the window. diff --git a/v2/pkg/templates/templates/lit-ts/frontend/wailsjs/runtime/runtime.js b/v2/pkg/templates/templates/lit-ts/frontend/wailsjs/runtime/runtime.js index b5ae16d56..2c3dafcc3 100644 --- a/v2/pkg/templates/templates/lit-ts/frontend/wailsjs/runtime/runtime.js +++ b/v2/pkg/templates/templates/lit-ts/frontend/wailsjs/runtime/runtime.js @@ -48,10 +48,6 @@ export function EventsOff(eventName) { return window.runtime.EventsOff(eventName); } -export function EventsOffAll() { - return window.runtime.EventsOffAll(); -} - export function EventsOnce(eventName, callback) { EventsOnMultiple(eventName, callback, 1); } diff --git a/v2/pkg/templates/templates/lit-ts/go.mod.tmpl b/v2/pkg/templates/templates/lit-ts/go.mod.tmpl index 4b34d1668..dd7184879 100644 --- a/v2/pkg/templates/templates/lit-ts/go.mod.tmpl +++ b/v2/pkg/templates/templates/lit-ts/go.mod.tmpl @@ -1,6 +1,6 @@ module changeme -go 1.23.0 +go 1.18 require github.com/wailsapp/wails/v2 {{.WailsVersion}} diff --git a/v2/pkg/templates/templates/lit/frontend/wailsjs/runtime/runtime.d.ts b/v2/pkg/templates/templates/lit/frontend/wailsjs/runtime/runtime.d.ts index 336fb07aa..e0d662b38 100644 --- a/v2/pkg/templates/templates/lit/frontend/wailsjs/runtime/runtime.d.ts +++ b/v2/pkg/templates/templates/lit/frontend/wailsjs/runtime/runtime.d.ts @@ -52,10 +52,6 @@ export function EventsOnce(eventName: string, callback: (...data: any) => void): // unregisters the listener for the given event name. export function EventsOff(eventName: string): void; -// [EventsOffAll](https://wails.io/docs/reference/runtime/events#eventsoffall) -// unregisters all event listeners. -export function EventsOffAll(): void; - // [LogPrint](https://wails.io/docs/reference/runtime/log#logprint) // logs the given message as a raw message export function LogPrint(message: string): void; @@ -130,7 +126,7 @@ export function WindowUnfullscreen(): void; // [WindowSetSize](https://wails.io/docs/reference/runtime/window#windowsetsize) // Sets the width and height of the window. -export function WindowSetSize(width: number, height: number): void; +export function WindowSetSize(width: number, height: number): Promise; // [WindowGetSize](https://wails.io/docs/reference/runtime/window#windowgetsize) // Gets the width and height of the window. diff --git a/v2/pkg/templates/templates/lit/frontend/wailsjs/runtime/runtime.js b/v2/pkg/templates/templates/lit/frontend/wailsjs/runtime/runtime.js index b5ae16d56..2c3dafcc3 100644 --- a/v2/pkg/templates/templates/lit/frontend/wailsjs/runtime/runtime.js +++ b/v2/pkg/templates/templates/lit/frontend/wailsjs/runtime/runtime.js @@ -48,10 +48,6 @@ export function EventsOff(eventName) { return window.runtime.EventsOff(eventName); } -export function EventsOffAll() { - return window.runtime.EventsOffAll(); -} - export function EventsOnce(eventName, callback) { EventsOnMultiple(eventName, callback, 1); } diff --git a/v2/pkg/templates/templates/lit/go.mod.tmpl b/v2/pkg/templates/templates/lit/go.mod.tmpl index 4b34d1668..dd7184879 100644 --- a/v2/pkg/templates/templates/lit/go.mod.tmpl +++ b/v2/pkg/templates/templates/lit/go.mod.tmpl @@ -1,6 +1,6 @@ module changeme -go 1.23.0 +go 1.18 require github.com/wailsapp/wails/v2 {{.WailsVersion}} diff --git a/v2/pkg/templates/templates/plain/go.mod.tmpl b/v2/pkg/templates/templates/plain/go.mod.tmpl index 4b34d1668..dd7184879 100644 --- a/v2/pkg/templates/templates/plain/go.mod.tmpl +++ b/v2/pkg/templates/templates/plain/go.mod.tmpl @@ -1,6 +1,6 @@ module changeme -go 1.23.0 +go 1.18 require github.com/wailsapp/wails/v2 {{.WailsVersion}} diff --git a/v2/pkg/templates/templates/preact-ts/frontend/wailsjs/runtime/runtime.d.ts b/v2/pkg/templates/templates/preact-ts/frontend/wailsjs/runtime/runtime.d.ts index 336fb07aa..e0d662b38 100644 --- a/v2/pkg/templates/templates/preact-ts/frontend/wailsjs/runtime/runtime.d.ts +++ b/v2/pkg/templates/templates/preact-ts/frontend/wailsjs/runtime/runtime.d.ts @@ -52,10 +52,6 @@ export function EventsOnce(eventName: string, callback: (...data: any) => void): // unregisters the listener for the given event name. export function EventsOff(eventName: string): void; -// [EventsOffAll](https://wails.io/docs/reference/runtime/events#eventsoffall) -// unregisters all event listeners. -export function EventsOffAll(): void; - // [LogPrint](https://wails.io/docs/reference/runtime/log#logprint) // logs the given message as a raw message export function LogPrint(message: string): void; @@ -130,7 +126,7 @@ export function WindowUnfullscreen(): void; // [WindowSetSize](https://wails.io/docs/reference/runtime/window#windowsetsize) // Sets the width and height of the window. -export function WindowSetSize(width: number, height: number): void; +export function WindowSetSize(width: number, height: number): Promise; // [WindowGetSize](https://wails.io/docs/reference/runtime/window#windowgetsize) // Gets the width and height of the window. diff --git a/v2/pkg/templates/templates/preact-ts/frontend/wailsjs/runtime/runtime.js b/v2/pkg/templates/templates/preact-ts/frontend/wailsjs/runtime/runtime.js index b5ae16d56..2c3dafcc3 100644 --- a/v2/pkg/templates/templates/preact-ts/frontend/wailsjs/runtime/runtime.js +++ b/v2/pkg/templates/templates/preact-ts/frontend/wailsjs/runtime/runtime.js @@ -48,10 +48,6 @@ export function EventsOff(eventName) { return window.runtime.EventsOff(eventName); } -export function EventsOffAll() { - return window.runtime.EventsOffAll(); -} - export function EventsOnce(eventName, callback) { EventsOnMultiple(eventName, callback, 1); } diff --git a/v2/pkg/templates/templates/preact-ts/go.mod.tmpl b/v2/pkg/templates/templates/preact-ts/go.mod.tmpl index 4b34d1668..dd7184879 100644 --- a/v2/pkg/templates/templates/preact-ts/go.mod.tmpl +++ b/v2/pkg/templates/templates/preact-ts/go.mod.tmpl @@ -1,6 +1,6 @@ module changeme -go 1.23.0 +go 1.18 require github.com/wailsapp/wails/v2 {{.WailsVersion}} diff --git a/v2/pkg/templates/templates/preact/frontend/wailsjs/runtime/runtime.d.ts b/v2/pkg/templates/templates/preact/frontend/wailsjs/runtime/runtime.d.ts index 336fb07aa..e0d662b38 100644 --- a/v2/pkg/templates/templates/preact/frontend/wailsjs/runtime/runtime.d.ts +++ b/v2/pkg/templates/templates/preact/frontend/wailsjs/runtime/runtime.d.ts @@ -52,10 +52,6 @@ export function EventsOnce(eventName: string, callback: (...data: any) => void): // unregisters the listener for the given event name. export function EventsOff(eventName: string): void; -// [EventsOffAll](https://wails.io/docs/reference/runtime/events#eventsoffall) -// unregisters all event listeners. -export function EventsOffAll(): void; - // [LogPrint](https://wails.io/docs/reference/runtime/log#logprint) // logs the given message as a raw message export function LogPrint(message: string): void; @@ -130,7 +126,7 @@ export function WindowUnfullscreen(): void; // [WindowSetSize](https://wails.io/docs/reference/runtime/window#windowsetsize) // Sets the width and height of the window. -export function WindowSetSize(width: number, height: number): void; +export function WindowSetSize(width: number, height: number): Promise; // [WindowGetSize](https://wails.io/docs/reference/runtime/window#windowgetsize) // Gets the width and height of the window. diff --git a/v2/pkg/templates/templates/preact/frontend/wailsjs/runtime/runtime.js b/v2/pkg/templates/templates/preact/frontend/wailsjs/runtime/runtime.js index b5ae16d56..2c3dafcc3 100644 --- a/v2/pkg/templates/templates/preact/frontend/wailsjs/runtime/runtime.js +++ b/v2/pkg/templates/templates/preact/frontend/wailsjs/runtime/runtime.js @@ -48,10 +48,6 @@ export function EventsOff(eventName) { return window.runtime.EventsOff(eventName); } -export function EventsOffAll() { - return window.runtime.EventsOffAll(); -} - export function EventsOnce(eventName, callback) { EventsOnMultiple(eventName, callback, 1); } diff --git a/v2/pkg/templates/templates/preact/go.mod.tmpl b/v2/pkg/templates/templates/preact/go.mod.tmpl index 4b34d1668..dd7184879 100644 --- a/v2/pkg/templates/templates/preact/go.mod.tmpl +++ b/v2/pkg/templates/templates/preact/go.mod.tmpl @@ -1,6 +1,6 @@ module changeme -go 1.23.0 +go 1.18 require github.com/wailsapp/wails/v2 {{.WailsVersion}} diff --git a/v2/pkg/templates/templates/react-ts/frontend/wailsjs/runtime/runtime.d.ts b/v2/pkg/templates/templates/react-ts/frontend/wailsjs/runtime/runtime.d.ts index 336fb07aa..e0d662b38 100644 --- a/v2/pkg/templates/templates/react-ts/frontend/wailsjs/runtime/runtime.d.ts +++ b/v2/pkg/templates/templates/react-ts/frontend/wailsjs/runtime/runtime.d.ts @@ -52,10 +52,6 @@ export function EventsOnce(eventName: string, callback: (...data: any) => void): // unregisters the listener for the given event name. export function EventsOff(eventName: string): void; -// [EventsOffAll](https://wails.io/docs/reference/runtime/events#eventsoffall) -// unregisters all event listeners. -export function EventsOffAll(): void; - // [LogPrint](https://wails.io/docs/reference/runtime/log#logprint) // logs the given message as a raw message export function LogPrint(message: string): void; @@ -130,7 +126,7 @@ export function WindowUnfullscreen(): void; // [WindowSetSize](https://wails.io/docs/reference/runtime/window#windowsetsize) // Sets the width and height of the window. -export function WindowSetSize(width: number, height: number): void; +export function WindowSetSize(width: number, height: number): Promise; // [WindowGetSize](https://wails.io/docs/reference/runtime/window#windowgetsize) // Gets the width and height of the window. diff --git a/v2/pkg/templates/templates/react-ts/frontend/wailsjs/runtime/runtime.js b/v2/pkg/templates/templates/react-ts/frontend/wailsjs/runtime/runtime.js index b5ae16d56..2c3dafcc3 100644 --- a/v2/pkg/templates/templates/react-ts/frontend/wailsjs/runtime/runtime.js +++ b/v2/pkg/templates/templates/react-ts/frontend/wailsjs/runtime/runtime.js @@ -48,10 +48,6 @@ export function EventsOff(eventName) { return window.runtime.EventsOff(eventName); } -export function EventsOffAll() { - return window.runtime.EventsOffAll(); -} - export function EventsOnce(eventName, callback) { EventsOnMultiple(eventName, callback, 1); } diff --git a/v2/pkg/templates/templates/react-ts/go.mod.tmpl b/v2/pkg/templates/templates/react-ts/go.mod.tmpl index 4b34d1668..dd7184879 100644 --- a/v2/pkg/templates/templates/react-ts/go.mod.tmpl +++ b/v2/pkg/templates/templates/react-ts/go.mod.tmpl @@ -1,6 +1,6 @@ module changeme -go 1.23.0 +go 1.18 require github.com/wailsapp/wails/v2 {{.WailsVersion}} diff --git a/v2/pkg/templates/templates/react/frontend/wailsjs/runtime/runtime.d.ts b/v2/pkg/templates/templates/react/frontend/wailsjs/runtime/runtime.d.ts index 336fb07aa..e0d662b38 100644 --- a/v2/pkg/templates/templates/react/frontend/wailsjs/runtime/runtime.d.ts +++ b/v2/pkg/templates/templates/react/frontend/wailsjs/runtime/runtime.d.ts @@ -52,10 +52,6 @@ export function EventsOnce(eventName: string, callback: (...data: any) => void): // unregisters the listener for the given event name. export function EventsOff(eventName: string): void; -// [EventsOffAll](https://wails.io/docs/reference/runtime/events#eventsoffall) -// unregisters all event listeners. -export function EventsOffAll(): void; - // [LogPrint](https://wails.io/docs/reference/runtime/log#logprint) // logs the given message as a raw message export function LogPrint(message: string): void; @@ -130,7 +126,7 @@ export function WindowUnfullscreen(): void; // [WindowSetSize](https://wails.io/docs/reference/runtime/window#windowsetsize) // Sets the width and height of the window. -export function WindowSetSize(width: number, height: number): void; +export function WindowSetSize(width: number, height: number): Promise; // [WindowGetSize](https://wails.io/docs/reference/runtime/window#windowgetsize) // Gets the width and height of the window. diff --git a/v2/pkg/templates/templates/react/frontend/wailsjs/runtime/runtime.js b/v2/pkg/templates/templates/react/frontend/wailsjs/runtime/runtime.js index b5ae16d56..2c3dafcc3 100644 --- a/v2/pkg/templates/templates/react/frontend/wailsjs/runtime/runtime.js +++ b/v2/pkg/templates/templates/react/frontend/wailsjs/runtime/runtime.js @@ -48,10 +48,6 @@ export function EventsOff(eventName) { return window.runtime.EventsOff(eventName); } -export function EventsOffAll() { - return window.runtime.EventsOffAll(); -} - export function EventsOnce(eventName, callback) { EventsOnMultiple(eventName, callback, 1); } diff --git a/v2/pkg/templates/templates/react/go.mod.tmpl b/v2/pkg/templates/templates/react/go.mod.tmpl index 4b34d1668..dd7184879 100644 --- a/v2/pkg/templates/templates/react/go.mod.tmpl +++ b/v2/pkg/templates/templates/react/go.mod.tmpl @@ -1,6 +1,6 @@ module changeme -go 1.23.0 +go 1.18 require github.com/wailsapp/wails/v2 {{.WailsVersion}} diff --git a/v2/pkg/templates/templates/svelte-ts/frontend/wailsjs/runtime/runtime.d.ts b/v2/pkg/templates/templates/svelte-ts/frontend/wailsjs/runtime/runtime.d.ts index 336fb07aa..e0d662b38 100644 --- a/v2/pkg/templates/templates/svelte-ts/frontend/wailsjs/runtime/runtime.d.ts +++ b/v2/pkg/templates/templates/svelte-ts/frontend/wailsjs/runtime/runtime.d.ts @@ -52,10 +52,6 @@ export function EventsOnce(eventName: string, callback: (...data: any) => void): // unregisters the listener for the given event name. export function EventsOff(eventName: string): void; -// [EventsOffAll](https://wails.io/docs/reference/runtime/events#eventsoffall) -// unregisters all event listeners. -export function EventsOffAll(): void; - // [LogPrint](https://wails.io/docs/reference/runtime/log#logprint) // logs the given message as a raw message export function LogPrint(message: string): void; @@ -130,7 +126,7 @@ export function WindowUnfullscreen(): void; // [WindowSetSize](https://wails.io/docs/reference/runtime/window#windowsetsize) // Sets the width and height of the window. -export function WindowSetSize(width: number, height: number): void; +export function WindowSetSize(width: number, height: number): Promise; // [WindowGetSize](https://wails.io/docs/reference/runtime/window#windowgetsize) // Gets the width and height of the window. diff --git a/v2/pkg/templates/templates/svelte-ts/frontend/wailsjs/runtime/runtime.js b/v2/pkg/templates/templates/svelte-ts/frontend/wailsjs/runtime/runtime.js index b5ae16d56..2c3dafcc3 100644 --- a/v2/pkg/templates/templates/svelte-ts/frontend/wailsjs/runtime/runtime.js +++ b/v2/pkg/templates/templates/svelte-ts/frontend/wailsjs/runtime/runtime.js @@ -48,10 +48,6 @@ export function EventsOff(eventName) { return window.runtime.EventsOff(eventName); } -export function EventsOffAll() { - return window.runtime.EventsOffAll(); -} - export function EventsOnce(eventName, callback) { EventsOnMultiple(eventName, callback, 1); } diff --git a/v2/pkg/templates/templates/svelte-ts/go.mod.tmpl b/v2/pkg/templates/templates/svelte-ts/go.mod.tmpl index 4b34d1668..dd7184879 100644 --- a/v2/pkg/templates/templates/svelte-ts/go.mod.tmpl +++ b/v2/pkg/templates/templates/svelte-ts/go.mod.tmpl @@ -1,6 +1,6 @@ module changeme -go 1.23.0 +go 1.18 require github.com/wailsapp/wails/v2 {{.WailsVersion}} diff --git a/v2/pkg/templates/templates/svelte/frontend/wailsjs/runtime/runtime.d.ts b/v2/pkg/templates/templates/svelte/frontend/wailsjs/runtime/runtime.d.ts index 336fb07aa..e0d662b38 100644 --- a/v2/pkg/templates/templates/svelte/frontend/wailsjs/runtime/runtime.d.ts +++ b/v2/pkg/templates/templates/svelte/frontend/wailsjs/runtime/runtime.d.ts @@ -52,10 +52,6 @@ export function EventsOnce(eventName: string, callback: (...data: any) => void): // unregisters the listener for the given event name. export function EventsOff(eventName: string): void; -// [EventsOffAll](https://wails.io/docs/reference/runtime/events#eventsoffall) -// unregisters all event listeners. -export function EventsOffAll(): void; - // [LogPrint](https://wails.io/docs/reference/runtime/log#logprint) // logs the given message as a raw message export function LogPrint(message: string): void; @@ -130,7 +126,7 @@ export function WindowUnfullscreen(): void; // [WindowSetSize](https://wails.io/docs/reference/runtime/window#windowsetsize) // Sets the width and height of the window. -export function WindowSetSize(width: number, height: number): void; +export function WindowSetSize(width: number, height: number): Promise; // [WindowGetSize](https://wails.io/docs/reference/runtime/window#windowgetsize) // Gets the width and height of the window. diff --git a/v2/pkg/templates/templates/svelte/frontend/wailsjs/runtime/runtime.js b/v2/pkg/templates/templates/svelte/frontend/wailsjs/runtime/runtime.js index b5ae16d56..2c3dafcc3 100644 --- a/v2/pkg/templates/templates/svelte/frontend/wailsjs/runtime/runtime.js +++ b/v2/pkg/templates/templates/svelte/frontend/wailsjs/runtime/runtime.js @@ -48,10 +48,6 @@ export function EventsOff(eventName) { return window.runtime.EventsOff(eventName); } -export function EventsOffAll() { - return window.runtime.EventsOffAll(); -} - export function EventsOnce(eventName, callback) { EventsOnMultiple(eventName, callback, 1); } diff --git a/v2/pkg/templates/templates/svelte/go.mod.tmpl b/v2/pkg/templates/templates/svelte/go.mod.tmpl index 4b34d1668..dd7184879 100644 --- a/v2/pkg/templates/templates/svelte/go.mod.tmpl +++ b/v2/pkg/templates/templates/svelte/go.mod.tmpl @@ -1,6 +1,6 @@ module changeme -go 1.23.0 +go 1.18 require github.com/wailsapp/wails/v2 {{.WailsVersion}} diff --git a/v2/pkg/templates/templates/vanilla-ts/frontend/wailsjs/runtime/runtime.d.ts b/v2/pkg/templates/templates/vanilla-ts/frontend/wailsjs/runtime/runtime.d.ts index 336fb07aa..e0d662b38 100644 --- a/v2/pkg/templates/templates/vanilla-ts/frontend/wailsjs/runtime/runtime.d.ts +++ b/v2/pkg/templates/templates/vanilla-ts/frontend/wailsjs/runtime/runtime.d.ts @@ -52,10 +52,6 @@ export function EventsOnce(eventName: string, callback: (...data: any) => void): // unregisters the listener for the given event name. export function EventsOff(eventName: string): void; -// [EventsOffAll](https://wails.io/docs/reference/runtime/events#eventsoffall) -// unregisters all event listeners. -export function EventsOffAll(): void; - // [LogPrint](https://wails.io/docs/reference/runtime/log#logprint) // logs the given message as a raw message export function LogPrint(message: string): void; @@ -130,7 +126,7 @@ export function WindowUnfullscreen(): void; // [WindowSetSize](https://wails.io/docs/reference/runtime/window#windowsetsize) // Sets the width and height of the window. -export function WindowSetSize(width: number, height: number): void; +export function WindowSetSize(width: number, height: number): Promise; // [WindowGetSize](https://wails.io/docs/reference/runtime/window#windowgetsize) // Gets the width and height of the window. diff --git a/v2/pkg/templates/templates/vanilla-ts/frontend/wailsjs/runtime/runtime.js b/v2/pkg/templates/templates/vanilla-ts/frontend/wailsjs/runtime/runtime.js index b5ae16d56..2c3dafcc3 100644 --- a/v2/pkg/templates/templates/vanilla-ts/frontend/wailsjs/runtime/runtime.js +++ b/v2/pkg/templates/templates/vanilla-ts/frontend/wailsjs/runtime/runtime.js @@ -48,10 +48,6 @@ export function EventsOff(eventName) { return window.runtime.EventsOff(eventName); } -export function EventsOffAll() { - return window.runtime.EventsOffAll(); -} - export function EventsOnce(eventName, callback) { EventsOnMultiple(eventName, callback, 1); } diff --git a/v2/pkg/templates/templates/vanilla-ts/go.mod.tmpl b/v2/pkg/templates/templates/vanilla-ts/go.mod.tmpl index 4b34d1668..dd7184879 100644 --- a/v2/pkg/templates/templates/vanilla-ts/go.mod.tmpl +++ b/v2/pkg/templates/templates/vanilla-ts/go.mod.tmpl @@ -1,6 +1,6 @@ module changeme -go 1.23.0 +go 1.18 require github.com/wailsapp/wails/v2 {{.WailsVersion}} diff --git a/v2/pkg/templates/templates/vanilla/frontend/wailsjs/runtime/runtime.d.ts b/v2/pkg/templates/templates/vanilla/frontend/wailsjs/runtime/runtime.d.ts index 336fb07aa..e0d662b38 100644 --- a/v2/pkg/templates/templates/vanilla/frontend/wailsjs/runtime/runtime.d.ts +++ b/v2/pkg/templates/templates/vanilla/frontend/wailsjs/runtime/runtime.d.ts @@ -52,10 +52,6 @@ export function EventsOnce(eventName: string, callback: (...data: any) => void): // unregisters the listener for the given event name. export function EventsOff(eventName: string): void; -// [EventsOffAll](https://wails.io/docs/reference/runtime/events#eventsoffall) -// unregisters all event listeners. -export function EventsOffAll(): void; - // [LogPrint](https://wails.io/docs/reference/runtime/log#logprint) // logs the given message as a raw message export function LogPrint(message: string): void; @@ -130,7 +126,7 @@ export function WindowUnfullscreen(): void; // [WindowSetSize](https://wails.io/docs/reference/runtime/window#windowsetsize) // Sets the width and height of the window. -export function WindowSetSize(width: number, height: number): void; +export function WindowSetSize(width: number, height: number): Promise; // [WindowGetSize](https://wails.io/docs/reference/runtime/window#windowgetsize) // Gets the width and height of the window. diff --git a/v2/pkg/templates/templates/vanilla/frontend/wailsjs/runtime/runtime.js b/v2/pkg/templates/templates/vanilla/frontend/wailsjs/runtime/runtime.js index b5ae16d56..2c3dafcc3 100644 --- a/v2/pkg/templates/templates/vanilla/frontend/wailsjs/runtime/runtime.js +++ b/v2/pkg/templates/templates/vanilla/frontend/wailsjs/runtime/runtime.js @@ -48,10 +48,6 @@ export function EventsOff(eventName) { return window.runtime.EventsOff(eventName); } -export function EventsOffAll() { - return window.runtime.EventsOffAll(); -} - export function EventsOnce(eventName, callback) { EventsOnMultiple(eventName, callback, 1); } diff --git a/v2/pkg/templates/templates/vanilla/go.mod.tmpl b/v2/pkg/templates/templates/vanilla/go.mod.tmpl index 4b34d1668..dd7184879 100644 --- a/v2/pkg/templates/templates/vanilla/go.mod.tmpl +++ b/v2/pkg/templates/templates/vanilla/go.mod.tmpl @@ -1,6 +1,6 @@ module changeme -go 1.23.0 +go 1.18 require github.com/wailsapp/wails/v2 {{.WailsVersion}} diff --git a/v2/pkg/templates/templates/vue-ts/frontend/READ-THIS.md b/v2/pkg/templates/templates/vue-ts/frontend/READ-THIS.md new file mode 100644 index 000000000..15b2483d9 --- /dev/null +++ b/v2/pkg/templates/templates/vue-ts/frontend/READ-THIS.md @@ -0,0 +1,4 @@ +This template uses a work around as the default template does not compile due to this issue: +https://github.com/vuejs/core/issues/1228 + +In `tsconfig.json`, `isolatedModules` is set to `false` rather than `true` to work around the issue. \ No newline at end of file diff --git a/v2/pkg/templates/templates/vue-ts/frontend/wailsjs/runtime/runtime.d.ts b/v2/pkg/templates/templates/vue-ts/frontend/wailsjs/runtime/runtime.d.ts index 336fb07aa..e0d662b38 100644 --- a/v2/pkg/templates/templates/vue-ts/frontend/wailsjs/runtime/runtime.d.ts +++ b/v2/pkg/templates/templates/vue-ts/frontend/wailsjs/runtime/runtime.d.ts @@ -52,10 +52,6 @@ export function EventsOnce(eventName: string, callback: (...data: any) => void): // unregisters the listener for the given event name. export function EventsOff(eventName: string): void; -// [EventsOffAll](https://wails.io/docs/reference/runtime/events#eventsoffall) -// unregisters all event listeners. -export function EventsOffAll(): void; - // [LogPrint](https://wails.io/docs/reference/runtime/log#logprint) // logs the given message as a raw message export function LogPrint(message: string): void; @@ -130,7 +126,7 @@ export function WindowUnfullscreen(): void; // [WindowSetSize](https://wails.io/docs/reference/runtime/window#windowsetsize) // Sets the width and height of the window. -export function WindowSetSize(width: number, height: number): void; +export function WindowSetSize(width: number, height: number): Promise; // [WindowGetSize](https://wails.io/docs/reference/runtime/window#windowgetsize) // Gets the width and height of the window. diff --git a/v2/pkg/templates/templates/vue-ts/frontend/wailsjs/runtime/runtime.js b/v2/pkg/templates/templates/vue-ts/frontend/wailsjs/runtime/runtime.js index b5ae16d56..2c3dafcc3 100644 --- a/v2/pkg/templates/templates/vue-ts/frontend/wailsjs/runtime/runtime.js +++ b/v2/pkg/templates/templates/vue-ts/frontend/wailsjs/runtime/runtime.js @@ -48,10 +48,6 @@ export function EventsOff(eventName) { return window.runtime.EventsOff(eventName); } -export function EventsOffAll() { - return window.runtime.EventsOffAll(); -} - export function EventsOnce(eventName, callback) { EventsOnMultiple(eventName, callback, 1); } diff --git a/v2/pkg/templates/templates/vue-ts/go.mod.tmpl b/v2/pkg/templates/templates/vue-ts/go.mod.tmpl index 4b34d1668..dd7184879 100644 --- a/v2/pkg/templates/templates/vue-ts/go.mod.tmpl +++ b/v2/pkg/templates/templates/vue-ts/go.mod.tmpl @@ -1,6 +1,6 @@ module changeme -go 1.23.0 +go 1.18 require github.com/wailsapp/wails/v2 {{.WailsVersion}} diff --git a/v2/pkg/templates/templates/vue/frontend/wailsjs/runtime/runtime.d.ts b/v2/pkg/templates/templates/vue/frontend/wailsjs/runtime/runtime.d.ts index 336fb07aa..e0d662b38 100644 --- a/v2/pkg/templates/templates/vue/frontend/wailsjs/runtime/runtime.d.ts +++ b/v2/pkg/templates/templates/vue/frontend/wailsjs/runtime/runtime.d.ts @@ -52,10 +52,6 @@ export function EventsOnce(eventName: string, callback: (...data: any) => void): // unregisters the listener for the given event name. export function EventsOff(eventName: string): void; -// [EventsOffAll](https://wails.io/docs/reference/runtime/events#eventsoffall) -// unregisters all event listeners. -export function EventsOffAll(): void; - // [LogPrint](https://wails.io/docs/reference/runtime/log#logprint) // logs the given message as a raw message export function LogPrint(message: string): void; @@ -130,7 +126,7 @@ export function WindowUnfullscreen(): void; // [WindowSetSize](https://wails.io/docs/reference/runtime/window#windowsetsize) // Sets the width and height of the window. -export function WindowSetSize(width: number, height: number): void; +export function WindowSetSize(width: number, height: number): Promise; // [WindowGetSize](https://wails.io/docs/reference/runtime/window#windowgetsize) // Gets the width and height of the window. diff --git a/v2/pkg/templates/templates/vue/frontend/wailsjs/runtime/runtime.js b/v2/pkg/templates/templates/vue/frontend/wailsjs/runtime/runtime.js index b5ae16d56..2c3dafcc3 100644 --- a/v2/pkg/templates/templates/vue/frontend/wailsjs/runtime/runtime.js +++ b/v2/pkg/templates/templates/vue/frontend/wailsjs/runtime/runtime.js @@ -48,10 +48,6 @@ export function EventsOff(eventName) { return window.runtime.EventsOff(eventName); } -export function EventsOffAll() { - return window.runtime.EventsOffAll(); -} - export function EventsOnce(eventName, callback) { EventsOnMultiple(eventName, callback, 1); } diff --git a/v2/pkg/templates/templates/vue/go.mod.tmpl b/v2/pkg/templates/templates/vue/go.mod.tmpl index 4b34d1668..dd7184879 100644 --- a/v2/pkg/templates/templates/vue/go.mod.tmpl +++ b/v2/pkg/templates/templates/vue/go.mod.tmpl @@ -1,6 +1,6 @@ module changeme -go 1.23.0 +go 1.18 require github.com/wailsapp/wails/v2 {{.WailsVersion}} diff --git a/v2/pkg/templates/templates_test.go b/v2/pkg/templates/templates_test.go index 658ecadb6..3b906601a 100644 --- a/v2/pkg/templates/templates_test.go +++ b/v2/pkg/templates/templates_test.go @@ -52,48 +52,3 @@ func TestInstall(t *testing.T) { is2.NoErr(err) } - -func TestInstallFailsInNonEmptyDirectory(t *testing.T) { - is2 := is.New(t) - - // Create a temp directory with a file in it - tempDir, err := os.MkdirTemp("", "wails-test-nonempty-*") - is2.NoErr(err) - defer func() { - _ = os.RemoveAll(tempDir) - }() - - // Create a file in the directory to make it non-empty - err = os.WriteFile(filepath.Join(tempDir, "existing-file.txt"), []byte("test"), 0644) - is2.NoErr(err) - - options := &Options{ - ProjectName: "test", - TemplateName: "vanilla", - TargetDir: tempDir, - } - - _, _, err = Install(options) - is2.True(err != nil) // Should fail - is2.True(err.Error() == "cannot initialise project in non-empty directory: "+tempDir) -} - -func TestInstallSucceedsInEmptyDirectory(t *testing.T) { - is2 := is.New(t) - - // Create an empty temp directory - tempDir, err := os.MkdirTemp("", "wails-test-empty-*") - is2.NoErr(err) - defer func() { - _ = os.RemoveAll(tempDir) - }() - - options := &Options{ - ProjectName: "test", - TemplateName: "vanilla", - TargetDir: tempDir, - } - - _, _, err = Install(options) - is2.NoErr(err) // Should succeed in empty directory -} diff --git a/v3/.gitignore b/v3/.gitignore new file mode 100644 index 000000000..953237fcd --- /dev/null +++ b/v3/.gitignore @@ -0,0 +1,13 @@ +examples/kitchensink/kitchensink +cmd/wails3/wails +/examples/systray-menu/systray +/examples/window/window +/examples/dialogs/dialogs +/examples/menu/menu +/examples/clipboard/clipboard +/examples/plain/plain +/cmd/wails3/ui/.task/ +!internal/commands/webview2/MicrosoftEdgeWebview2Setup.exe +internal/commands/appimage_testfiles/appimage_testfiles +testiosapp/ +test/manual/systray/bin/ \ No newline at end of file diff --git a/v3/.prettierignore b/v3/.prettierignore new file mode 100644 index 000000000..94c6af38e --- /dev/null +++ b/v3/.prettierignore @@ -0,0 +1 @@ +website \ No newline at end of file diff --git a/v3/.prettierrc.yml b/v3/.prettierrc.yml new file mode 100644 index 000000000..685d8b6e7 --- /dev/null +++ b/v3/.prettierrc.yml @@ -0,0 +1,6 @@ +overrides: + - files: + - "**/*.md" + options: + printWidth: 80 + proseWrap: always diff --git a/v3/ANDROID_ARCHITECTURE.md b/v3/ANDROID_ARCHITECTURE.md new file mode 100644 index 000000000..d3a589488 --- /dev/null +++ b/v3/ANDROID_ARCHITECTURE.md @@ -0,0 +1,1025 @@ +# Wails v3 Android Architecture + +## Executive Summary + +This document provides a comprehensive technical architecture for Android support in Wails v3. The implementation enables Go applications to run natively on Android with an Android WebView frontend, maintaining the Wails philosophy of using web technologies for UI while leveraging Go for business logic. + +Unlike iOS which uses CGO with Objective-C, Android uses JNI (Java Native Interface) to bridge between Java/Kotlin and Go. The Go code is compiled as a shared library (`.so`) that is loaded by the Android application at runtime. + +## Table of Contents + +1. [Architecture Overview](#architecture-overview) +2. [Core Components](#core-components) +3. [Layer Architecture](#layer-architecture) +4. [File Structure](#file-structure) +5. [Implementation Details](#implementation-details) +6. [Build System](#build-system) +7. [JNI Bridge Details](#jni-bridge-details) +8. [Asset Serving](#asset-serving) +9. [JavaScript Bridge](#javascript-bridge) +10. [Security Considerations](#security-considerations) +11. [Configuration Options](#configuration-options) +12. [Debugging](#debugging) +13. [API Reference](#api-reference) +14. [Troubleshooting](#troubleshooting) +15. [Future Enhancements](#future-enhancements) + +## Architecture Overview + +### Design Principles + +1. **Battery Efficiency First**: All architectural decisions prioritize battery life +2. **No Network Ports**: Asset serving happens in-process via `WebViewAssetLoader` +3. **JNI Bridge Pattern**: Java Activity hosts WebView, Go provides business logic +4. **Wails v3 Compatibility**: Maintain API compatibility with existing Wails v3 applications +5. **Follow Fyne's gomobile pattern**: Use `-buildmode=c-shared` for native library + +### High-Level Architecture + +``` +┌─────────────────────────────────────────────────────────────┐ +│ Android Application │ +├─────────────────────────────────────────────────────────────┤ +│ Java/Android Layer │ +│ ┌─────────────────────────────────────────────────────┐ │ +│ │ MainActivity (Activity) │ │ +│ │ ┌───────────────────────────────────────────────┐ │ │ +│ │ │ Android WebView │ │ │ +│ │ │ ┌─────────────────────────────────────────┐ │ │ │ +│ │ │ │ Web Application (HTML/JS) │ │ │ │ +│ │ │ └─────────────────────────────────────────┘ │ │ │ +│ │ └───────────────────────────────────────────────┘ │ │ +│ │ │ │ +│ │ WailsBridge WailsPathHandler WailsJSBridge│ │ +│ └─────────────────────────────────────────────────────┘ │ +├─────────────────────────────────────────────────────────────┤ +│ JNI Bridge Layer │ +│ System.loadLibrary("wails") │ +├─────────────────────────────────────────────────────────────┤ +│ Go Runtime (libwails.so) │ +│ ┌──────────────────────────────────────────────────────┐ │ +│ │ Wails Application │ │ +│ │ ┌──────────┐ ┌──────────┐ ┌──────────────────┐ │ │ +│ │ │App Logic │ │Services │ │Asset Server │ │ │ +│ │ └──────────┘ └──────────┘ └──────────────────┘ │ │ +│ └──────────────────────────────────────────────────────┘ │ +└─────────────────────────────────────────────────────────────┘ +``` + +### Comparison with iOS Architecture + +| Aspect | iOS | Android | +|--------|-----|---------| +| Native Language | Objective-C | Java | +| Bridge Technology | CGO (C headers) | JNI | +| Build Mode | `-buildmode=c-archive` (.a) | `-buildmode=c-shared` (.so) | +| Entry Point | `main.m` calls `WailsIOSMain()` | `MainActivity` loads `libwails.so` | +| WebView | WKWebView | Android WebView | +| URL Scheme | `wails://localhost` | `https://wails.localhost` | +| Asset Interception | `WKURLSchemeHandler` | `WebViewAssetLoader` + `PathHandler` | +| JS → Native | `WKScriptMessageHandler` | `@JavascriptInterface` | +| Native → JS | `evaluateJavaScript:` | `evaluateJavascript()` | +| App Lifecycle | `UIApplicationDelegate` | `Activity` lifecycle methods | + +## Core Components + +### 1. Java Components + +#### MainActivity (`MainActivity.java`) + +**Purpose**: Android Activity that hosts the WebView and manages app lifecycle. + +**Location**: `build/android/app/src/main/java/com/wails/app/MainActivity.java` + +**Key Responsibilities**: +- Initialize the native Go library via `WailsBridge` +- Configure and manage the Android WebView +- Set up asset loading via `WebViewAssetLoader` +- Handle Android lifecycle events (onCreate, onResume, onPause, onDestroy) +- Execute JavaScript in the WebView when requested by Go + +**Key Methods**: +```java +onCreate(Bundle) // Initialize bridge, setup WebView +setupWebView() // Configure WebView settings and handlers +loadApplication() // Load initial URL (https://wails.localhost/) +executeJavaScript(String) // Run JS code (called from Go via JNI) +onResume() / onPause() // Lifecycle events forwarded to Go +onDestroy() // Cleanup resources +onBackPressed() // Handle back navigation +``` + +#### WailsBridge (`WailsBridge.java`) + +**Purpose**: Manages the JNI connection between Java and Go. + +**Location**: `build/android/app/src/main/java/com/wails/app/WailsBridge.java` + +**Key Responsibilities**: +- Load the native library (`System.loadLibrary("wails")`) +- Declare and call native methods +- Manage callbacks for async operations +- Forward lifecycle events to Go + +**Native Method Declarations**: +```java +private static native void nativeInit(WailsBridge bridge); +private static native void nativeShutdown(); +private static native void nativeOnResume(); +private static native void nativeOnPause(); +private static native byte[] nativeServeAsset(String path, String method, String headers); +private static native String nativeHandleMessage(String message); +private static native String nativeGetAssetMimeType(String path); +``` + +**Key Methods**: +```java +initialize() // Call nativeInit, set up Go runtime +shutdown() // Call nativeShutdown, cleanup +serveAsset(path, method, headers) // Get asset data from Go +handleMessage(message) // Send message to Go, get response +getAssetMimeType(path) // Get MIME type for asset +executeJavaScript(js) // Execute JS (callable from Go) +emitEvent(name, data) // Emit event to frontend +``` + +#### WailsPathHandler (`WailsPathHandler.java`) + +**Purpose**: Implements `WebViewAssetLoader.PathHandler` to serve assets from Go. + +**Location**: `build/android/app/src/main/java/com/wails/app/WailsPathHandler.java` + +**Key Responsibilities**: +- Intercept all requests to `https://wails.localhost/*` +- Forward requests to Go's asset server via `WailsBridge` +- Return `WebResourceResponse` with asset data + +**Key Method**: +```java +@Nullable +public WebResourceResponse handle(@NonNull String path) { + // Normalize path (/ -> /index.html) + // Call bridge.serveAsset(path, "GET", "{}") + // Get MIME type via bridge.getAssetMimeType(path) + // Return WebResourceResponse with data +} +``` + +#### WailsJSBridge (`WailsJSBridge.java`) + +**Purpose**: JavaScript interface exposed to the WebView for Go communication. + +**Location**: `build/android/app/src/main/java/com/wails/app/WailsJSBridge.java` + +**Key Responsibilities**: +- Expose methods to JavaScript via `@JavascriptInterface` +- Forward messages from JavaScript to Go +- Support both sync and async message patterns + +**JavaScript Interface Methods**: +```java +@JavascriptInterface +public String invoke(String message) // Sync call to Go + +@JavascriptInterface +public void invokeAsync(String callbackId, String message) // Async call + +@JavascriptInterface +public void log(String level, String message) // Log to Android logcat + +@JavascriptInterface +public String platform() // Returns "android" + +@JavascriptInterface +public boolean isDebug() // Returns BuildConfig.DEBUG +``` + +**Usage from JavaScript**: +```javascript +// Synchronous call +const result = wails.invoke(JSON.stringify({type: 'call', ...})); + +// Asynchronous call +wails.invokeAsync('callback-123', JSON.stringify({type: 'call', ...})); + +// Logging +wails.log('info', 'Hello from JavaScript'); + +// Platform detection +if (wails.platform() === 'android') { ... } +``` + +### 2. Go Components + +#### Application Layer (`application_android.go`) + +**Purpose**: Main Go implementation for Android platform. + +**Location**: `v3/pkg/application/application_android.go` + +**Build Tag**: `//go:build android` + +**Key Responsibilities**: +- Export JNI functions for Java to call +- Manage global application state +- Handle lifecycle events from Android +- Serve assets and process messages + +**JNI Exports**: +```go +//export Java_com_wails_app_WailsBridge_nativeInit +func Java_com_wails_app_WailsBridge_nativeInit(env *C.JNIEnv, obj C.jobject, bridge C.jobject) + +//export Java_com_wails_app_WailsBridge_nativeShutdown +func Java_com_wails_app_WailsBridge_nativeShutdown(env *C.JNIEnv, obj C.jobject) + +//export Java_com_wails_app_WailsBridge_nativeOnResume +func Java_com_wails_app_WailsBridge_nativeOnResume(env *C.JNIEnv, obj C.jobject) + +//export Java_com_wails_app_WailsBridge_nativeOnPause +func Java_com_wails_app_WailsBridge_nativeOnPause(env *C.JNIEnv, obj C.jobject) + +//export Java_com_wails_app_WailsBridge_nativeServeAsset +func Java_com_wails_app_WailsBridge_nativeServeAsset(env *C.JNIEnv, obj C.jobject, path, method, headers *C.char) *C.char + +//export Java_com_wails_app_WailsBridge_nativeHandleMessage +func Java_com_wails_app_WailsBridge_nativeHandleMessage(env *C.JNIEnv, obj C.jobject, message *C.char) *C.char + +//export Java_com_wails_app_WailsBridge_nativeGetAssetMimeType +func Java_com_wails_app_WailsBridge_nativeGetAssetMimeType(env *C.JNIEnv, obj C.jobject, path *C.char) *C.char +``` + +**Platform Functions**: +```go +func (a *App) platformRun() // Block forever, Android manages lifecycle +func (a *App) platformQuit() // Signal quit +func (a *App) isDarkMode() bool // Query Android dark mode +``` + +#### WebView Window (`webview_window_android.go`) + +**Purpose**: Implements `webviewWindowImpl` interface for Android. + +**Location**: `v3/pkg/application/webview_window_android.go` + +**Build Tag**: `//go:build android` + +**Key Methods**: Most methods are no-ops or return defaults since Android has a single fullscreen window. + +```go +func (w *androidWebviewWindow) execJS(js string) // Execute JavaScript +func (w *androidWebviewWindow) isFullscreen() bool // Always true +func (w *androidWebviewWindow) size() (int, int) // Device dimensions +func (w *androidWebviewWindow) setBackgroundColour(col RGBA) // Set WebView bg +``` + +#### Asset Server (`assetserver_android.go`) + +**Purpose**: Configure base URL for Android asset serving. + +**Location**: `v3/internal/assetserver/assetserver_android.go` + +**Build Tag**: `//go:build android` + +```go +var baseURL = url.URL{ + Scheme: "https", + Host: "wails.localhost", +} +``` + +#### Other Platform Files + +All these files have the `//go:build android` tag: + +| File | Purpose | +|------|---------| +| `init_android.go` | Initialization (no `runtime.LockOSThread`) | +| `clipboard_android.go` | Clipboard operations (stub) | +| `dialogs_android.go` | File/message dialogs (stub) | +| `menu_android.go` | Menu handling (no-op) | +| `menuitem_android.go` | Menu items (no-op) | +| `screen_android.go` | Screen information | +| `mainthread_android.go` | Main thread dispatch | +| `signal_handler_android.go` | Signal handling (no-op) | +| `single_instance_android.go` | Single instance (via manifest) | +| `systemtray_android.go` | System tray (no-op) | +| `keys_android.go` | Keyboard handling (stub) | +| `events_common_android.go` | Event mapping | +| `messageprocessor_android.go` | Android-specific runtime methods | + +## File Structure + +``` +v3/ +├── ANDROID_ARCHITECTURE.md # This document +├── pkg/ +│ ├── application/ +│ │ ├── application_android.go # Main Android implementation +│ │ ├── application_options.go # Contains AndroidOptions struct +│ │ ├── webview_window_android.go +│ │ ├── clipboard_android.go +│ │ ├── dialogs_android.go +│ │ ├── events_common_android.go +│ │ ├── init_android.go +│ │ ├── keys_android.go +│ │ ├── mainthread_android.go +│ │ ├── menu_android.go +│ │ ├── menuitem_android.go +│ │ ├── messageprocessor_android.go +│ │ ├── messageprocessor_mobile_stub.go # Stub for non-mobile +│ │ ├── screen_android.go +│ │ ├── signal_handler_android.go +│ │ ├── signal_handler_types_android.go +│ │ ├── single_instance_android.go +│ │ └── systemtray_android.go +│ └── events/ +│ └── events_android.go +├── internal/ +│ └── assetserver/ +│ ├── assetserver_android.go +│ └── webview/ +│ └── request_android.go +└── examples/ + └── android/ + ├── main.go # Application entry point + ├── greetservice.go # Example service + ├── go.mod + ├── go.sum + ├── Taskfile.yml # Build orchestration + ├── .gitignore + ├── frontend/ # Web frontend (same as other platforms) + │ ├── index.html + │ ├── main.js + │ ├── package.json + │ └── ... + └── build/ + ├── config.yml # Build configuration + ├── Taskfile.yml # Common build tasks + ├── android/ + │ ├── Taskfile.yml # Android-specific tasks + │ ├── build.gradle # Root Gradle build + │ ├── settings.gradle + │ ├── gradle.properties + │ ├── gradlew # Gradle wrapper script + │ ├── gradle/ + │ │ └── wrapper/ + │ │ └── gradle-wrapper.properties + │ ├── scripts/ + │ │ └── deps/ + │ │ └── install_deps.go # Dependency checker + │ └── app/ + │ ├── build.gradle # App Gradle build + │ ├── proguard-rules.pro + │ └── src/ + │ └── main/ + │ ├── AndroidManifest.xml + │ ├── java/ + │ │ └── com/ + │ │ └── wails/ + │ │ └── app/ + │ │ ├── MainActivity.java + │ │ ├── WailsBridge.java + │ │ ├── WailsPathHandler.java + │ │ └── WailsJSBridge.java + │ ├── res/ + │ │ ├── layout/ + │ │ │ └── activity_main.xml + │ │ ├── values/ + │ │ │ ├── strings.xml + │ │ │ ├── colors.xml + │ │ │ └── themes.xml + │ │ └── mipmap-*/ # App icons + │ ├── assets/ # Frontend assets (copied) + │ └── jniLibs/ + │ ├── arm64-v8a/ + │ │ └── libwails.so # Generated + │ └── x86_64/ + │ └── libwails.so # Generated + ├── darwin/ # macOS build files + ├── linux/ # Linux build files + └── windows/ # Windows build files +``` + +## Implementation Details + +### Application Startup Flow + +``` +1. Android OS launches MainActivity + │ +2. MainActivity.onCreate() + │ + ├─> WailsBridge.initialize() + │ │ + │ └─> System.loadLibrary("wails") + │ │ + │ └─> Go runtime starts + │ │ + │ └─> nativeInit() called + │ │ + │ └─> globalApp = app (store reference) + │ + ├─> setupWebView() + │ │ + │ ├─> Configure WebSettings + │ ├─> Create WebViewAssetLoader with WailsPathHandler + │ ├─> Set WebViewClient for request interception + │ └─> Add WailsJSBridge via addJavascriptInterface + │ + └─> loadApplication() + │ + └─> webView.loadUrl("https://wails.localhost/") + │ + └─> WailsPathHandler.handle("/") + │ + └─> WailsBridge.serveAsset("/index.html", ...) + │ + └─> nativeServeAsset() (JNI to Go) + │ + └─> Go AssetServer returns HTML +``` + +### Asset Request Flow + +``` +WebView requests: https://wails.localhost/main.js + │ + ▼ +WebViewClient.shouldInterceptRequest() + │ + ▼ +WebViewAssetLoader.shouldInterceptRequest() + │ + ▼ +WailsPathHandler.handle("/main.js") + │ + ▼ +WailsBridge.serveAsset("/main.js", "GET", "{}") + │ + ▼ +JNI call: nativeServeAsset(path, method, headers) + │ + ▼ +Go: serveAssetForAndroid(app, "/main.js") + │ + ▼ +Go: AssetServer reads from embed.FS + │ + ▼ +Return: byte[] data + │ + ▼ +WailsPathHandler creates WebResourceResponse + │ + ▼ +WebView renders content +``` + +### JavaScript to Go Message Flow + +``` +JavaScript: wails.invoke('{"type":"call","method":"Greet","args":["World"]}') + │ + ▼ +WailsJSBridge.invoke(message) [@JavascriptInterface] + │ + ▼ +WailsBridge.handleMessage(message) + │ + ▼ +JNI call: nativeHandleMessage(message) + │ + ▼ +Go: handleMessageForAndroid(app, message) + │ + ▼ +Go: Parse JSON, route to service method + │ + ▼ +Go: Execute GreetService.Greet("World") + │ + ▼ +Return: '{"result":"Hello, World!"}' + │ + ▼ +JavaScript receives result +``` + +### Go to JavaScript Event Flow + +``` +Go: app.Event.Emit("time", "Mon, 01 Jan 2024 12:00:00") + │ + ▼ +Go: Call Java executeJavaScript via JNI callback + │ + ▼ +WailsBridge.emitEvent("time", "\"Mon, 01 Jan 2024 12:00:00\"") + │ + ▼ +JavaScript: window.wails._emit('time', "Mon, 01 Jan 2024 12:00:00") + │ + ▼ +Frontend event listeners notified +``` + +## Build System + +### Prerequisites + +1. **Go 1.21+** with CGO support +2. **Android SDK** with: + - Platform Tools (adb) + - Build Tools + - Android Emulator +3. **Android NDK r19c+** (r26d recommended) +4. **Java JDK 11+** + +### Environment Variables + +```bash +# Required +export ANDROID_HOME=$HOME/Library/Android/sdk # macOS +export ANDROID_HOME=$HOME/Android/Sdk # Linux + +# Optional (auto-detected if not set) +export ANDROID_NDK_HOME=$ANDROID_HOME/ndk/26.1.10909125 + +# Path additions +export PATH=$PATH:$ANDROID_HOME/platform-tools +export PATH=$PATH:$ANDROID_HOME/emulator +``` + +### Taskfile Commands + +```bash +# Check/install dependencies +task android:install:deps + +# Build Go shared library (default: arm64 for device) +task android:build + +# Build for emulator (x86_64) +task android:build ARCH=x86_64 + +# Build for all architectures (fat APK) +task android:compile:go:all-archs + +# Package into APK +task android:package + +# Run on emulator +task android:run + +# View logs +task android:logs + +# Clean build artifacts +task android:clean +``` + +### Build Process Details + +#### 1. Go Compilation + +```bash +# Environment for arm64 (device) +export GOOS=android +export GOARCH=arm64 +export CGO_ENABLED=1 +export CC=$NDK/toolchains/llvm/prebuilt/$HOST/bin/aarch64-linux-android21-clang + +# Build command +go build -buildmode=c-shared \ + -tags android \ + -o build/android/app/src/main/jniLibs/arm64-v8a/libwails.so +``` + +#### 2. Gradle Build + +```bash +cd build/android +./gradlew assembleDebug +# Output: app/build/outputs/apk/debug/app-debug.apk +``` + +#### 3. Installation + +```bash +adb install app-debug.apk +adb shell am start -n com.wails.app/.MainActivity +``` + +### Architecture Support + +| Architecture | GOARCH | JNI Directory | Use Case | +|--------------|--------|---------------|----------| +| arm64-v8a | arm64 | `jniLibs/arm64-v8a/` | Physical devices (most common) | +| x86_64 | amd64 | `jniLibs/x86_64/` | Emulator | +| armeabi-v7a | arm | `jniLibs/armeabi-v7a/` | Older devices (optional) | +| x86 | 386 | `jniLibs/x86/` | Older emulators (optional) | + +### Minimum SDK Configuration + +```gradle +// build/android/app/build.gradle +android { + defaultConfig { + minSdk 21 // Android 5.0 (Lollipop) - 99%+ coverage + targetSdk 34 // Android 14 - Required for Play Store + } +} +``` + +## JNI Bridge Details + +### JNI Function Naming Convention + +JNI functions must follow this naming pattern: +``` +Java___ +``` + +Example: +```go +//export Java_com_wails_app_WailsBridge_nativeInit +func Java_com_wails_app_WailsBridge_nativeInit(env *C.JNIEnv, obj C.jobject, bridge C.jobject) +``` + +Corresponds to Java: +```java +package com.wails.app; +class WailsBridge { + private static native void nativeInit(WailsBridge bridge); +} +``` + +### JNI Type Mappings + +| Java Type | JNI Type | Go CGO Type | +|-----------|----------|-------------| +| void | void | - | +| boolean | jboolean | C.jboolean | +| int | jint | C.jint | +| long | jlong | C.jlong | +| String | jstring | *C.char (via conversion) | +| byte[] | jbyteArray | *C.char (via conversion) | +| Object | jobject | C.jobject | + +### String Conversion + +```go +// Java String → Go string +goString := C.GoString((*C.char)(unsafe.Pointer(javaString))) + +// Go string → Java String (return) +return C.CString(goString) // Must be freed by Java +``` + +### Thread Safety + +- JNI calls must be made from the thread that owns the JNI environment +- Go goroutines cannot directly call JNI methods +- Use channels or callbacks to communicate between goroutines and JNI thread + +## Asset Serving + +### WebViewAssetLoader Configuration + +```java +assetLoader = new WebViewAssetLoader.Builder() + .setDomain("wails.localhost") // Custom domain + .addPathHandler("/", new WailsPathHandler(bridge)) // All paths + .build(); +``` + +### URL Scheme + +- **Base URL**: `https://wails.localhost/` +- **Why HTTPS**: Android's `WebViewAssetLoader` requires HTTPS for security +- **Domain**: `wails.localhost` is arbitrary but consistent with Wails conventions + +### Path Normalization + +```java +// In WailsPathHandler.handle() +if (path.isEmpty() || path.equals("/")) { + path = "/index.html"; +} +``` + +### MIME Type Detection + +MIME types are determined by Go based on file extension. Fallback mapping in Java: + +```java +private String getMimeType(String path) { + if (path.endsWith(".html")) return "text/html"; + if (path.endsWith(".js")) return "application/javascript"; + if (path.endsWith(".css")) return "text/css"; + // ... etc + return "application/octet-stream"; +} +``` + +## JavaScript Bridge + +### Exposed Interface + +The `WailsJSBridge` is added to the WebView as: +```java +webView.addJavascriptInterface(new WailsJSBridge(bridge, webView), "wails"); +``` + +This makes `window.wails` available in JavaScript. + +### Security Considerations + +1. **@JavascriptInterface annotation** is required for all exposed methods (Android 4.2+) +2. Only specific methods are exposed, not the entire object +3. Input validation should be performed on all received data + +### Async Pattern + +For non-blocking calls: + +```javascript +// JavaScript side +const callbackId = 'cb_' + Date.now(); +window.wails._callbacks[callbackId] = (result, error) => { + if (error) reject(error); + else resolve(result); +}; +wails.invokeAsync(callbackId, message); + +// Java side sends response via: +webView.evaluateJavascript( + "window.wails._callback('" + callbackId + "', " + result + ", null);", + null +); +``` + +## Security Considerations + +### WebView Security + +```java +WebSettings settings = webView.getSettings(); +settings.setAllowFileAccess(false); // No file:// access +settings.setAllowContentAccess(false); // No content:// access +settings.setMixedContentMode(MIXED_CONTENT_NEVER_ALLOW); // HTTPS only +``` + +### JNI Security + +1. **No arbitrary code execution**: JNI methods have fixed signatures +2. **Input validation**: All strings from Java are validated in Go +3. **Memory safety**: Go's memory management prevents buffer overflows + +### Asset Security + +1. **Same-origin policy**: Assets only served from `wails.localhost` +2. **No external network**: All assets embedded, no remote fetching +3. **Content Security Policy**: Can be set via HTML headers + +## Configuration Options + +### AndroidOptions Struct + +```go +type AndroidOptions struct { + // DisableScroll disables scrolling in the WebView + DisableScroll bool + + // DisableOverscroll disables the overscroll bounce effect + DisableOverscroll bool + + // EnableZoom allows pinch-to-zoom in the WebView (default: false) + EnableZoom bool + + // UserAgent sets a custom user agent string + UserAgent string + + // BackgroundColour sets the background colour of the WebView + BackgroundColour RGBA + + // DisableHardwareAcceleration disables hardware acceleration + DisableHardwareAcceleration bool +} +``` + +### Usage + +```go +app := application.New(application.Options{ + Name: "My App", + Android: application.AndroidOptions{ + DisableOverscroll: true, + BackgroundColour: application.NewRGB(27, 38, 54), + }, +}) +``` + +### AndroidManifest.xml Configuration + +```xml + + + + + android:hardwareAccelerated="true"> + + + + + +``` + +## Debugging + +### Logcat Filtering + +```bash +# All Wails logs +adb logcat -v time | grep -E "(Wails|WailsBridge|WailsActivity)" + +# Using task +task android:logs +``` + +### WebView Debugging + +Enable in debug builds: +```java +if (BuildConfig.DEBUG) { + WebView.setWebContentsDebuggingEnabled(true); +} +``` + +Then in Chrome: `chrome://inspect/#devices` + +### Go Debugging + +```go +func androidLogf(level string, format string, a ...interface{}) { + msg := fmt.Sprintf(format, a...) + println(fmt.Sprintf("[Android/%s] %s", level, msg)) +} +``` + +### Common Issues + +1. **"UnsatisfiedLinkError"**: Library not found or wrong architecture +2. **"No implementation found"**: JNI function name mismatch +3. **Blank WebView**: Asset serving not working, check logcat + +## API Reference + +### Go API (Same as Desktop) + +```go +// Create application +app := application.New(application.Options{ + Name: "App Name", + Assets: application.AssetOptions{ + Handler: application.AssetFileServerFS(assets), + }, + Services: []application.Service{ + application.NewService(&MyService{}), + }, + Android: application.AndroidOptions{...}, +}) + +// Run (blocks on Android) +app.Run() + +// Emit events +app.Event.Emit("eventName", data) +``` + +### JavaScript API + +```javascript +// Call Go service method +const result = await window.wails.Call.ByName('MyService.Greet', 'World'); + +// Platform detection +if (window.wails.System.Platform() === 'android') { ... } + +// Events +window.wails.Events.On('eventName', (data) => { ... }); +``` + +### Android-Specific Runtime Methods + +```javascript +// Vibrate (haptic feedback) +window.wails.Call.ByName('Android.Haptics.Vibrate', {duration: 100}); + +// Show toast +window.wails.Call.ByName('Android.Toast.Show', {message: 'Hello!'}); + +// Get device info +const info = await window.wails.Call.ByName('Android.Device.Info'); +``` + +## Troubleshooting + +### Build Errors + +**"NDK not found"** +```bash +# Set NDK path explicitly +export ANDROID_NDK_HOME=$ANDROID_HOME/ndk/26.1.10909125 +``` + +**"undefined reference to JNI function"** +- Check function name matches exactly (case-sensitive) +- Ensure `//export` comment is directly above function + +**"cannot find package"** +```bash +cd examples/android && go mod tidy +``` + +### Runtime Errors + +**App crashes on startup** +1. Check logcat for stack trace +2. Verify library is in correct jniLibs directory +3. Check architecture matches device/emulator + +**WebView shows blank** +1. Enable WebView debugging +2. Check Chrome DevTools for errors +3. Verify `https://wails.localhost/` resolves + +**JavaScript bridge not working** +1. Check `wails` object exists: `console.log(window.wails)` +2. Verify `@JavascriptInterface` annotations present +3. Check for JavaScript errors in console + +## Future Enhancements + +### Phase 1: Core Stability +- [ ] Complete JNI callback implementation for Go → Java +- [ ] Full asset server integration +- [ ] Error handling and recovery +- [ ] Unit and integration tests + +### Phase 2: Feature Parity +- [ ] Clipboard support +- [ ] File dialogs (via Storage Access Framework) +- [ ] Notifications +- [ ] Deep linking + +### Phase 3: Android-Specific Features +- [ ] Material Design 3 theming integration +- [ ] Edge-to-edge display support +- [ ] Predictive back gesture +- [ ] Picture-in-Picture mode +- [ ] Widgets + +### Phase 4: Advanced Features +- [ ] Background services +- [ ] Push notifications (FCM) +- [ ] Biometric authentication +- [ ] App Shortcuts +- [ ] Wear OS companion + +## Conclusion + +This architecture provides a solid foundation for Android support in Wails v3. The design prioritizes: + +1. **Compatibility**: Same Go code runs on all platforms +2. **Performance**: No network overhead, native rendering +3. **Security**: Sandboxed WebView, validated inputs +4. **Maintainability**: Clear separation of concerns + +The implementation follows Android best practices while maintaining the simplicity that Wails developers expect. The JNI bridge pattern, while more complex than iOS's CGO approach, provides robust interoperability between Java and Go. + +### Key Implementation Status + +| Component | Status | Notes | +|-----------|--------|-------| +| Java Activity | ✅ Complete | MainActivity with WebView | +| JNI Bridge | ✅ Complete | WailsBridge with native methods | +| Asset Handler | ✅ Complete | WailsPathHandler | +| JS Bridge | ✅ Complete | WailsJSBridge | +| Go Platform Files | ✅ Complete | All *_android.go files | +| Taskfile | ✅ Complete | Build orchestration | +| Gradle Project | ✅ Complete | App structure | +| JNI Implementation | 🔄 Partial | Needs Go → Java callbacks | +| Asset Server Integration | 🔄 Partial | Needs full wiring | +| Testing | ❌ Pending | Needs emulator testing | + +--- + +*Document Version: 1.0* +*Last Updated: November 2024* +*Wails Version: v3-alpha* diff --git a/v3/IOS_ARCHITECTURE.md b/v3/IOS_ARCHITECTURE.md new file mode 100644 index 000000000..2e07f4f0c --- /dev/null +++ b/v3/IOS_ARCHITECTURE.md @@ -0,0 +1,419 @@ +# Wails v3 iOS Architecture + +## Executive Summary + +This document provides a comprehensive technical architecture for iOS support in Wails v3. The implementation enables Go applications to run natively on iOS with a WKWebView frontend, maintaining the Wails philosophy of using web technologies for UI while leveraging Go for business logic. + +## Table of Contents + +1. [Architecture Overview](#architecture-overview) +2. [Core Components](#core-components) +3. [Layer Architecture](#layer-architecture) +4. [Implementation Details](#implementation-details) +5. [Battery Optimization](#battery-optimization) +6. [Build System](#build-system) +7. [Security Considerations](#security-considerations) +8. [API Reference](#api-reference) + +## Architecture Overview + +### Design Principles + +1. **Battery Efficiency First**: All architectural decisions prioritize battery life +2. **No Network Ports**: Asset serving happens in-process via native APIs +3. **Minimal WebView Instances**: Maximum 2 concurrent WebViews (1 primary, 1 for transitions) +4. **Native Integration**: Deep iOS integration using Objective-C runtime +5. **Wails v3 Compatibility**: Maintain API compatibility with existing Wails v3 applications + +### High-Level Architecture + +``` +┌─────────────────────────────────────────────────────────────┐ +│ iOS Application │ +├─────────────────────────────────────────────────────────────┤ +│ UIKit Framework │ +│ ┌─────────────────────────────────────────────────────┐ │ +│ │ WailsViewController │ │ +│ │ ┌───────────────────────────────────────────────┐ │ │ +│ │ │ WKWebView Instance │ │ │ +│ │ │ ┌─────────────────────────────────────────┐ │ │ │ +│ │ │ │ Web Application (HTML/JS) │ │ │ │ +│ │ │ └─────────────────────────────────────────┘ │ │ │ +│ │ └───────────────────────────────────────────────┘ │ │ +│ └─────────────────────────────────────────────────────┘ │ +├─────────────────────────────────────────────────────────────┤ +│ Bridge Layer (CGO) │ +│ ┌──────────────┐ ┌──────────────┐ ┌──────────────┐ │ +│ │URL Handler │ │JS Bridge │ │Message Handler│ │ +│ └──────────────┘ └──────────────┘ └──────────────┘ │ +├─────────────────────────────────────────────────────────────┤ +│ Go Runtime │ +│ ┌──────────────────────────────────────────────────────┐ │ +│ │ Wails Application │ │ +│ │ ┌──────────┐ ┌──────────┐ ┌──────────────────┐ │ │ +│ │ │App Logic │ │Services │ │Asset Server │ │ │ +│ │ └──────────┘ └──────────┘ └──────────────────┘ │ │ +│ └──────────────────────────────────────────────────────┘ │ +└─────────────────────────────────────────────────────────────┘ +``` + +## Core Components + +### 1. Platform Layer (`application_ios.go`) + +**Purpose**: Go interface for iOS platform operations + +**Key Functions**: +- `platformRun()`: Initialize and run the iOS application +- `platformQuit()`: Gracefully shutdown the application +- `isDarkMode()`: Detect iOS dark mode state +- `ExecuteJavaScript(windowID uint, js string)`: Execute JS in WebView + +**Exported Go Functions (Called from Objective-C)**: +- `ServeAssetRequest(windowID C.uint, urlStr *C.char, callbackID C.uint)` +- `HandleJSMessage(windowID C.uint, message *C.char)` + +### 2. Native iOS Layer (`application_ios.m`) + +**Components**: + +#### WailsSchemeHandler +```objc +@interface WailsSchemeHandler : NSObject +``` +- Implements `WKURLSchemeHandler` protocol +- Intercepts `wails://` URL requests +- Bridges to Go for asset serving +- Manages pending requests with callback IDs + +**Methods**: +- `startURLSchemeTask:`: Intercept request, call Go handler +- `stopURLSchemeTask:`: Cancel pending request +- `completeRequest:withData:mimeType:`: Complete request with data from Go + +#### WailsMessageHandler +```objc +@interface WailsMessageHandler : NSObject +``` +- Implements JavaScript to Go communication +- Handles `window.webkit.messageHandlers.external.postMessage()` +- Serializes messages to JSON for Go processing + +**Methods**: +- `userContentController:didReceiveScriptMessage:`: Process JS messages + +#### WailsViewController +```objc +@interface WailsViewController : UIViewController +``` +- Main view controller containing WKWebView +- Manages WebView lifecycle +- Handles JavaScript execution requests + +**Properties**: +- `webView`: WKWebView instance +- `schemeHandler`: Custom URL scheme handler +- `messageHandler`: JS message handler +- `windowID`: Unique window identifier + +**Methods**: +- `viewDidLoad`: Initialize WebView with configuration +- `executeJavaScript:`: Run JS code in WebView + +### 3. Bridge Layer (CGO) + +**C Interface Functions**: +```c +void ios_app_init(void); // Initialize iOS app +void ios_app_run(void); // Run main loop +void ios_app_quit(void); // Quit application +bool ios_is_dark_mode(void); // Check dark mode +unsigned int ios_create_webview(void); // Create WebView +void ios_execute_javascript(unsigned int windowID, const char* js); +void ios_complete_request(unsigned int callbackID, const char* data, const char* mimeType); +``` + +## Layer Architecture + +### Layer 1: Presentation Layer (WebView) + +**Responsibilities**: +- Render HTML/CSS/JavaScript UI +- Handle user interactions +- Communicate with native layer + +**Key Features**: +- WKWebView for modern web standards +- Hardware-accelerated rendering +- Efficient memory management + +### Layer 2: Communication Layer + +**Request Interception**: +``` +WebView Request → WKURLSchemeHandler → Go ServeAssetRequest → AssetServer → Response +``` + +**JavaScript Bridge**: +``` +JS postMessage → WKScriptMessageHandler → Go HandleJSMessage → Process → ExecuteJavaScript +``` + +### Layer 3: Application Layer (Go) + +**Components**: +- Application lifecycle management +- Service binding and method calls +- Asset serving from embedded fs.FS +- Business logic execution + +### Layer 4: Platform Integration Layer + +**iOS-Specific Features**: +- Dark mode detection +- System appearance integration +- iOS-specific optimizations + +## Implementation Details + +### Request Handling Flow + +1. **WebView makes request** to `wails://localhost/path` +2. **WKURLSchemeHandler intercepts** request +3. **Creates callback ID** and stores `WKURLSchemeTask` +4. **Calls Go function** `ServeAssetRequest` with URL and callback ID +5. **Go processes request** through AssetServer +6. **Go calls** `ios_complete_request` with response data +7. **Objective-C completes** the `WKURLSchemeTask` with response + +### JavaScript Execution Flow + +1. **Go calls** `ios_execute_javascript` with JS code +2. **Bridge dispatches** to main thread +3. **WKWebView evaluates** JavaScript +4. **Completion handler** logs any errors + +### Message Passing Flow + +1. **JavaScript calls** `window.webkit.messageHandlers.wails.postMessage(data)` +2. **WKScriptMessageHandler receives** message +3. **Serializes to JSON** and passes to Go +4. **Go processes** message in `HandleJSMessage` +5. **Go can respond** via `ExecuteJavaScript` + +## Battery Optimization + +### WebView Configuration + +```objc +// Disable unnecessary features +config.suppressesIncrementalRendering = NO; +config.allowsInlineMediaPlayback = YES; +config.mediaTypesRequiringUserActionForPlayback = WKAudiovisualMediaTypeNone; +``` + +### Memory Management + +1. **Single WebView Instance**: Reuse instead of creating new instances +2. **Automatic Reference Counting**: Use ARC for Objective-C objects +3. **Lazy Loading**: Initialize components only when needed +4. **Resource Cleanup**: Properly release resources when done + +### Request Optimization + +1. **In-Process Serving**: No network overhead +2. **Direct Memory Transfer**: Pass data directly without serialization +3. **Efficient Caching**: Leverage WKWebView's built-in cache +4. **Minimal Wake Locks**: No background network activity + +## Build System + +### Build Tags + +```go +//go:build ios +``` + +### CGO Configuration + +```go +#cgo CFLAGS: -x objective-c -fobjc-arc +#cgo LDFLAGS: -framework Foundation -framework UIKit -framework WebKit +``` + +### Build Script (`build_ios.sh`) + +**Steps**: +1. Check dependencies (go, xcodebuild, xcrun) +2. Set up iOS cross-compilation environment +3. Build Go binary with iOS tags +4. Create app bundle structure +5. Generate Info.plist +6. Sign for simulator +7. Create launch script + +**Environment Variables**: +```bash +export CGO_ENABLED=1 +export GOOS=ios +export GOARCH=arm64 +export SDK_PATH=$(xcrun --sdk iphonesimulator --show-sdk-path) +``` + +### Simulator Deployment + +```bash +xcrun simctl install "$DEVICE_ID" "WailsIOSDemo.app" +xcrun simctl launch "$DEVICE_ID" "com.wails.iosdemo" +``` + +## Security Considerations + +### URL Scheme Security + +1. **Custom Scheme**: Use `wails://` to avoid conflicts +2. **Origin Validation**: Only serve to authorized WebViews +3. **No External Access**: Scheme handler only responds to app's WebView + +### JavaScript Execution + +1. **Input Validation**: Sanitize JS code before execution +2. **Sandboxed Execution**: WKWebView provides isolation +3. **No eval()**: Avoid dynamic code evaluation + +### Data Protection + +1. **In-Memory Only**: No temporary files on disk +2. **ATS Compliance**: App Transport Security enabled +3. **Secure Communication**: All data stays within app process + +## API Reference + +### Go API + +#### Application Functions + +```go +// Create new iOS application +app := application.New(application.Options{ + Name: "App Name", + Description: "App Description", +}) + +// Run the application +app.Run() + +// Execute JavaScript +app.ExecuteJavaScript(windowID, "console.log('Hello')") +``` + +#### Service Binding + +```go +type MyService struct{} + +func (s *MyService) Greet(name string) string { + return fmt.Sprintf("Hello, %s!", name) +} + +app := application.New(application.Options{ + Services: []application.Service{ + application.NewService(&MyService{}), + }, +}) +``` + +### JavaScript API + +#### Send Message to Go + +```javascript +window.webkit.messageHandlers.wails.postMessage({ + type: 'methodCall', + service: 'MyService', + method: 'Greet', + args: ['World'] +}); +``` + +#### Receive from Go + +```javascript +window.wailsCallback = function(data) { + console.log('Received:', data); +}; +``` + +### Objective-C Bridge API + +#### From Go to Objective-C + +```c +// Execute JavaScript +ios_execute_javascript(windowID, "alert('Hello')"); + +// Complete asset request +ios_complete_request(callbackID, htmlData, "text/html"); +``` + +#### From Objective-C to Go + +```c +// Serve asset request +ServeAssetRequest(windowID, urlString, callbackID); + +// Handle JavaScript message +HandleJSMessage(windowID, jsonMessage); +``` + +## Performance Metrics + +### Target Metrics + +- **WebView Creation**: < 100ms +- **Asset Request**: < 10ms for cached, < 50ms for first load +- **JS Execution**: < 5ms for simple scripts +- **Message Passing**: < 2ms round trip +- **Memory Usage**: < 50MB baseline +- **Battery Impact**: < 2% per hour active use + +### Monitoring + +1. **Xcode Instruments**: CPU, Memory, Energy profiling +2. **WebView Inspector**: JavaScript performance +3. **Go Profiling**: pprof for Go code analysis + +## Future Enhancements + +### Phase 1: Core Stability +- [ ] Production-ready error handling +- [ ] Comprehensive test suite +- [ ] Performance optimization + +### Phase 2: Feature Parity +- [ ] Multiple window support +- [ ] System tray integration +- [ ] Native menu implementation + +### Phase 3: iOS-Specific Features +- [ ] Widget extension support +- [ ] App Clip support +- [ ] ShareSheet integration +- [ ] Siri Shortcuts + +### Phase 4: Advanced Features +- [ ] Background task support +- [ ] Push notifications +- [ ] CloudKit integration +- [ ] Apple Watch companion app + +## Conclusion + +This architecture provides a solid foundation for iOS support in Wails v3. The design prioritizes battery efficiency, native performance, and seamless integration with the existing Wails ecosystem. The proof of concept demonstrates all four required capabilities: + +1. ✅ **WebView Creation**: Native WKWebView with optimized configuration +2. ✅ **Request Interception**: Custom scheme handler without network ports +3. ✅ **JavaScript Execution**: Bidirectional communication bridge +4. ✅ **iOS Simulator Support**: Complete build and deployment pipeline + +The architecture is designed to scale from this proof of concept to a full production implementation while maintaining the simplicity and elegance that Wails developers expect. \ No newline at end of file diff --git a/v3/IOS_FEATURES_TODO.md b/v3/IOS_FEATURES_TODO.md new file mode 100644 index 000000000..cd3bc0edd --- /dev/null +++ b/v3/IOS_FEATURES_TODO.md @@ -0,0 +1,100 @@ +# iOS Features TODO (Prioritized) + +This document lists potential iOS features and platform options to enhance the Wails v3 iOS runtime. Items are ordered by importance for typical app development workflows. + +## Top Priority (Implement first) + +1) Input accessory bar control +- Status: Implemented as `IOSOptions.DisableInputAccessoryView` (default false = shown). Native toggle + WKWebView subclass. + +2) Scrolling and bounce behavior +- Options: + - `DisableScroll` (default true in current runtime to preserve no-scroll template behavior) + - `DisableBounce` (default true in current runtime) + - `HideScrollIndicators` (default true in current runtime) +- Purpose: control elastic bounce, page scrolling, and indicators. + +3) Web Inspector / Debug +- Options: + - `DisableInspectable` (default false; inspector enabled by default in dev) +- Purpose: enable/disable WKWebView inspector. + +4) Back/forward navigation gestures +- Options: + - `AllowsBackForwardNavigationGestures` (default false) +- Purpose: enable iOS edge-swipe navigation. + +5) Link previews +- Options: + - `DisableLinkPreview` (default false) +- Purpose: allow long-press link previews. + +6) Media autoplay and inline playback +- Options: + - `DisableInlineMediaPlayback` (default false) + - `RequireUserActionForMediaPlayback` (default false) +- Purpose: control media playback UX. + +7) User agent customization +- Options: + - `UserAgent` (string) + - `ApplicationNameForUserAgent` (string; default "wails.io") +- Purpose: customize UA / identify app. + +8) Keyboard behavior +- Options: + - Already: `DisableInputAccessoryView` + - Future: `KeyboardDismissMode` (none | onDrag | interactive) +- Purpose: refine keyboard UX. + +9) Safe-area and content inset behavior +- Options (future): + - `ContentInsetAdjustment` (automatic | never | always) + - `UseSafeArea` (bool) +- Purpose: fine-tune layout under notch/home indicator. + +10) Data detectors (future feasibility) +- Options: `DataDetectorTypes []string` (phoneNumber, link, address) +- Note: Not all are directly available on WKWebView; feasibility TBD. + +## Medium Priority + +11) Pull-to-refresh (custom) +12) File picker / photo access bridges +13) Haptics feedback helpers +14) Clipboard read/write helpers (partially present) +15) Share sheet / activity view bridges +16) Background audio / PiP controls +17) App lifecycle event hooks (background/foreground) +18) Permissions prompts helpers (camera, mic, photos) +19) Open in external browser vs in-app policy +20) Cookie / storage policy helpers + +## Low Priority + +21) Theme/dynamic color helpers bridging to CSS vars +22) Orientation lock helpers per window +23) Status bar style control from Go +24) Network reachability events bridge +25) Push notifications + +--- + +# Implementation Plan (Top 10) + +Implement the following immediately: +- DisableScroll, DisableBounce, HideScrollIndicators +- AllowsBackForwardNavigationGestures +- DisableLinkPreview +- DisableInlineMediaPlayback +- RequireUserActionForMediaPlayback +- DisableInspectable +- UserAgent +- ApplicationNameForUserAgent + +Approach: +- Extend `IOSOptions` in `pkg/application/application_options.go` with these fields. +- Add native globals + C setters in `pkg/application/application_ios.h/.m`. +- Apply options in `pkg/application/webview_window_ios.m` during WKWebView configuration and on the scrollView. +- Wire from Go in `pkg/application/application_ios.go`. +- Maintain current template behavior as defaults (no scroll/bounce/indicators) to avoid regressions in existing tests. diff --git a/v3/IOS_RUNTIME.md b/v3/IOS_RUNTIME.md new file mode 100644 index 000000000..22aaa320a --- /dev/null +++ b/v3/IOS_RUNTIME.md @@ -0,0 +1,53 @@ +# iOS Runtime Feature Plan + +This document outlines proposed iOS-only runtime features for Wails v3, the initial milestones, and method shapes exposed to the frontend runtime as `IOS.*`. + +## Goals +- Provide a first-class iOS runtime namespace: `IOS`. +- Expose UX-critical features with a small, well-defined, promise-based API. +- Follow the existing runtime pattern: JS -> /wails/runtime -> Go -> ObjC. + +## Object: IOS +- Object ID: 11 (reserved in runtime objectNames) + +## Milestone 1 (MVP) +- Haptics + - `IOS.Haptics.Impact(style: "light"|"medium"|"heavy"|"soft"|"rigid"): Promise` +- Device + - `IOS.Device.Info(): Promise<{ model: string; systemName: string; systemVersion: string; isSimulator: boolean }>` + +## Milestone 2 +- Permissions + - `IOS.Permissions.Request("camera"|"microphone"|"photos"|"notifications"): Promise<"granted"|"denied"|"limited">` + - `IOS.Permissions.Status(kind): Promise<"granted"|"denied"|"limited"|"restricted"|"not_determined">` +- Camera + - `IOS.Camera.PickPhoto(options?): Promise<{ uri: string }>` + - `IOS.Camera.PickVideo(options?): Promise<{ uri: string, duration?: number }>` +- Photos + - `IOS.Photos.SaveImage(dataURL|blob, options?): Promise` + - `IOS.Photos.SaveVideo(fileURI, options?): Promise` + +## Milestone 3 +- Share + - `IOS.Share.Sheet({ text?, url?, imageDataURL? }): Promise` +- Files + - `IOS.Files.Pick({ types?, multiple? }): Promise>` +- Biometric + - `IOS.Biometric.CanAuthenticate(): Promise` + - `IOS.Biometric.Authenticate(reason: string): Promise` +- Notifications + - `IOS.Notifications.RequestPermission(): Promise` + - `IOS.Notifications.Schedule(localNotification): Promise` + +## Notes +- All APIs should be safe no-ops on other platforms (reject with a meaningful error) or be tree-shaken by frontend bundlers. +- UI-affecting APIs must ensure main-thread execution in ObjC. +- File/Photo APIs will use security-scoped bookmarks where relevant. + +## Implementation Status +- [x] Define plan (this document) +- [ ] JS runtime: add IOS object ID + IOS module exports +- [ ] Go: message dispatcher for IOS object +- [ ] iOS: Haptics.Impact(style) native bridge +- [ ] JS->Go->ObjC wiring for Haptics +- [ ] Device.Info() basic implementation diff --git a/v3/README.md b/v3/README.md new file mode 100644 index 000000000..2d0c36a0b --- /dev/null +++ b/v3/README.md @@ -0,0 +1,9 @@ +# v3 Alpha + +Thanks for wanting to help out with testing/developing Wails v3! This guide will help you get started. + +## Getting Started + +All the instructions for getting started are in the v3 documentation directory: `mkdocs-website`. +Please read the README.md file in that directory for more information. + diff --git a/v3/TESTING.md b/v3/TESTING.md new file mode 100644 index 000000000..2e1486dc5 --- /dev/null +++ b/v3/TESTING.md @@ -0,0 +1,452 @@ +# Cross-Platform Testing Guide for Wails v3 + +This document describes the comprehensive cross-platform testing system for Wails v3 examples, supporting Mac, Linux, and Windows compilation. + +## Overview + +The testing system ensures all Wails v3 examples build successfully across all supported platforms: +- **macOS (Darwin)** - Native compilation +- **Windows** - Cross-compilation from any platform +- **Linux** - Multi-architecture Docker compilation (ARM64 + x86_64) + +## Test Directory Structure + +The testing infrastructure is organized in a dedicated test directory: + +```bash +v3/ +├── test/ +│ └── docker/ +│ ├── Dockerfile.linux-arm64 # ARM64 native compilation +│ └── Dockerfile.linux-x86_64 # x86_64 native compilation +├── Taskfile.yaml # Build task definitions +└── TESTING.md # This documentation +``` + +**Benefits of the organized structure:** +- **Separation of Concerns**: Testing files are isolated from application code +- **Clear Organization**: All Docker-related files in one location +- **Easier Maintenance**: Centralized testing infrastructure +- **Better Git Management**: Clean separation for .gitignore patterns + +## Available Commands + +### 🚀 Complete Cross-Platform Testing +```bash +# Build all examples for ALL platforms (macOS + Windows + Linux) +task test:examples:all +``` +**Total: 129 builds** (43 examples × 3 platforms) + CLI code testing + +### All Examples (No DIR Parameter Needed) +```bash +# Current platform only (all 43 examples + CLI code) +task test:examples + +# All examples for specific Linux architectures +task test:examples:linux:docker # Auto-detect architecture +task test:examples:linux:docker:arm64 # ARM64 native +task test:examples:linux:docker:x86_64 # x86_64 native + +# CLI code testing only +task test:cli +``` + +### Single Example Builds (Requires DIR=example) +```bash +# macOS/Darwin single example +task test:example:darwin DIR=badge + +# Windows cross-compilation single example +task test:example:windows DIR=badge + +# Linux native builds (on Linux systems) +task test:example:linux DIR=badge + +# Linux Docker builds (multi-architecture) +task test:example:linux:docker DIR=badge # Auto-detect architecture +task test:example:linux:docker:arm64 DIR=badge # ARM64 native +task test:example:linux:docker:x86_64 DIR=badge # x86_64 native +``` + +## Build Artifacts + +All builds generate platform-specific binaries with clear naming: +- **macOS**: `testbuild-{example}-darwin` +- **Windows**: `testbuild-{example}-windows.exe` +- **Linux**: `testbuild-{example}-linux` +- **Linux ARM64**: `testbuild-{example}-linux-arm64` (Docker) +- **Linux x86_64**: `testbuild-{example}-linux-x86_64` (Docker) + +Example outputs: +```text +examples/badge/testbuild-badge-darwin +examples/badge/testbuild-badge-windows.exe +examples/badge/testbuild-badge-linux-arm64 +examples/badge/testbuild-badge-linux-x86_64 +``` + +## Validation Status + +### ✅ **Production Ready (v3.0.0-alpha)** +- **Total Examples**: 43 examples fully tested +- **macOS**: ✅ All examples compile successfully (100%) +- **Windows**: ✅ All examples cross-compile successfully (100%) +- **Linux**: ✅ Multi-architecture Docker compilation (ARM64 + x86_64) +- **Build System**: Comprehensive Taskfile.yaml integration +- **Git Integration**: Complete .gitignore patterns for build artifacts +- **Total Build Capacity**: 129 cross-platform builds per test cycle + +## Supported Examples + +The system builds all 43 Wails v3 examples: +- badge, badge-custom, binding, build +- cancel-async, cancel-chaining, clipboard, contextmenus +- dev, dialogs, dialogs-basic, drag-n-drop +- environment, events, events-bug, file-association +- frameless, gin-example, gin-routing, gin-service +- hide-window, html-dnd-api, ignore-mouse, keybindings +- menu, notifications, panic-handling, plain +- raw-message, screen, services, show-macos-toolbar +- single-instance, systray-basic, systray-custom, systray-menu +- video, window, window-api, window-call +- window-menu, wml + +**Recently Added (v3.0.0-alpha):** +- dev, events-bug, gin-example, gin-routing, gin-service +- html-dnd-api, notifications + +## Platform Requirements + +### macOS (Darwin) +- Go 1.23+ +- Xcode Command Line Tools +- No additional dependencies required + +**Environment Variables:** +```bash +CGO_LDFLAGS="-framework UniformTypeIdentifiers -mmacosx-version-min=10.13" +CGO_CFLAGS="-mmacosx-version-min=10.13" +``` + +### Windows (Cross-compilation) +- Go 1.23+ +- No additional dependencies for cross-compilation + +**Environment Variables:** +```bash +GOOS=windows +GOARCH=amd64 +``` + +### Linux (Docker) - ✅ Multi-Architecture Support +Uses Ubuntu 24.04 base image with full GTK development environment: + +**Current Status:** Complete multi-architecture Docker compilation system +- ✅ ARM64 native compilation (Ubuntu 24.04) +- ✅ x86_64 native compilation (Ubuntu 24.04) +- ✅ Automatic architecture detection +- ✅ All dependencies install correctly (GTK + WebKit) +- ✅ Go 1.24 environment configured for each architecture +- ✅ Native compilation eliminates cross-compilation CGO issues + +**Architecture Support:** +- **ARM64**: Native compilation using `Dockerfile.linux-arm64` +- **x86_64**: Native compilation using `Dockerfile.linux-x86_64` with `--platform=linux/amd64` +- **Auto-detect**: Taskfile automatically selects appropriate architecture + +**Core Dependencies:** +- `build-essential` - GCC compiler toolchain (architecture-specific) +- `pkg-config` - Package configuration tool +- `libgtk-3-dev` - GTK+ 3.x development files +- `libwebkit2gtk-4.1-dev` - WebKit2GTK development files +- `git` - Version control (for go mod operations) +- `ca-certificates` - HTTPS support + +**Docker Images:** +- `wails-v3-linux-arm64` - Ubuntu 24.04 ARM64 native compilation (built from `test/docker/Dockerfile.linux-arm64`) +- `wails-v3-linux-x86_64` - Ubuntu 24.04 x86_64 native compilation (built from `test/docker/Dockerfile.linux-x86_64`) +- `wails-v3-linux-fixed` - Legacy unified image (deprecated) + +## Docker Configuration + +### Multi-Architecture Build System + +#### ARM64 Native Build Environment (`test/docker/Dockerfile.linux-arm64`) +```dockerfile +FROM ubuntu:24.04 +# ARM64 native compilation environment +# Go 1.24.0 ARM64 binary (go1.24.0.linux-arm64.tar.gz) +# Native GCC toolchain for ARM64 +# All GTK/WebKit dependencies for ARM64 +# Build script: /build/build-linux-arm64.sh +# Output: testbuild-{example}-linux-arm64 +``` + +#### x86_64 Native Build Environment (`test/docker/Dockerfile.linux-x86_64`) +```dockerfile +FROM --platform=linux/amd64 ubuntu:24.04 +# x86_64 native compilation environment +# Go 1.24.0 x86_64 binary (go1.24.0.linux-amd64.tar.gz) +# Native GCC toolchain for x86_64 +# All GTK/WebKit dependencies for x86_64 +# Build script: /build/build-linux-x86_64.sh +# Output: testbuild-{example}-linux-x86_64 +``` + +### Available Docker Tasks + +#### Architecture-Specific Tasks +```bash +# ARM64 builds +task test:example:linux:docker:arm64 DIR=badge +task test:examples:linux:docker:arm64 + +# x86_64 builds +task test:example:linux:docker:x86_64 DIR=badge +task test:examples:linux:docker:x86_64 +``` + +#### Auto-Detection Tasks (Recommended) +```bash +# Single example (auto-detects host architecture) +task test:example:linux:docker DIR=badge + +# All examples (auto-detects host architecture) +task test:examples:linux:docker +``` + +## Implementation Details + +### Key Fixes Applied in v3.0.0-alpha + +#### 1. **Complete Example Coverage** +- **Before**: 35 examples tested +- **After**: 43 examples tested (100% coverage) +- **Added**: dev, events-bug, gin-example, gin-routing, gin-service, html-dnd-api, notifications + +#### 2. **Go Module Resolution** +- **Issue**: Inconsistent replace directives across examples +- **Fix**: Standardized all examples to use `replace github.com/wailsapp/wails/v3 => ../..` +- **Examples Fixed**: gin-example, gin-routing, notifications + +#### 3. **Frontend Asset Embedding** +- **Issue**: Some examples referenced missing `frontend/dist` directories +- **Fix**: Updated embed paths from `//go:embed all:frontend/dist` to `//go:embed all:frontend` +- **Examples Fixed**: file-association, notifications + +#### 4. **Manager API Migration** +- **Issue**: Windows badge service using deprecated API +- **Fix**: Updated `app.CurrentWindow()` → `app.Windows.Current()` +- **Files Fixed**: pkg/services/badge/badge_windows.go + +#### 5. **File Association Example** +- **Issue**: Undefined window variable +- **Fix**: Added proper window assignment from `app.Windows.NewWithOptions()` +- **Files Fixed**: examples/file-association/main.go + +### Build Performance +- **macOS**: ~2-3 minutes for all 43 examples +- **Windows Cross-Compile**: ~2-3 minutes for all 43 examples +- **Linux Docker**: ~5-10 minutes for all 43 examples (includes image build) +- **Total Build Time**: ~10-15 minutes for complete cross-platform validation (129 builds) + +## Usage Examples + +### Single Example Testing (Requires DIR Parameter) +```bash +# Test the badge example on all platforms +task test:example:darwin DIR=badge # macOS native +task test:example:windows DIR=badge # Windows cross-compile +task test:example:linux:docker DIR=badge # Linux Docker (auto-detect arch) +``` + +### All Examples Testing (No DIR Parameter) +```bash +# Test everything - all 43 examples, all platforms +task test:examples:all + +# This runs: +# 1. All Darwin builds (43 examples) +# 2. All Windows cross-compilation (43 examples) +# 3. All Linux Docker builds (43 examples, auto-architecture) + +# Platform-specific all examples +task test:examples # Current platform (43 examples) +task test:examples:linux:docker:arm64 # ARM64 builds (43 examples) +task test:examples:linux:docker:x86_64 # x86_64 builds (43 examples) +``` + +### Continuous Integration +```bash +# For CI/CD pipelines +task test:examples:all # Complete cross-platform (129 builds) +task test:examples # Current platform only (43 builds) +``` + +## Build Process Details + +### macOS Builds +1. Sets macOS-specific CGO flags for compatibility +2. Runs `go mod tidy` in each example directory +3. Compiles with `go build -o testbuild-{example}-darwin` +4. Links against UniformTypeIdentifiers framework + +### Windows Cross-Compilation +1. Sets `GOOS=windows GOARCH=amd64` environment +2. Runs `go mod tidy` in each example directory +3. Cross-compiles with `go build -o testbuild-{example}-windows.exe` +4. No CGO dependencies required (uses Windows APIs) + +### Linux Docker Builds +1. **Auto-Detection**: Detects host architecture (ARM64 or x86_64) +2. **Image Selection**: Uses appropriate Ubuntu 24.04 image for target architecture +3. **Native Compilation**: Eliminates cross-compilation CGO issues +4. **Environment Setup**: Full GTK/WebKit development environment +5. **Build Process**: Runs `go mod tidy && go build` with native toolchain +6. **Output**: Architecture-specific binaries (`-linux-arm64` or `-linux-x86_64`) + +## Troubleshooting + +### Common Issues (All Resolved in v3.0.0-alpha) + +#### **Go Module Resolution Errors** +```bash +Error: replacement directory ../wails/v3 does not exist +``` +**Solution**: All examples now use standardized `replace github.com/wailsapp/wails/v3 => ../..` + +#### **Frontend Asset Embedding Errors** +```bash +Error: pattern frontend/dist: no matching files found +``` +**Solution**: Updated to `//go:embed all:frontend` for examples without dist directories + +#### **Manager API Errors** +```bash +Error: app.CurrentWindow undefined +``` +**Solution**: Updated to use new manager pattern `app.Windows.Current()` + +#### **Build Warnings** +Some examples may show compatibility warnings (e.g., notifications using macOS 10.14+ APIs with 10.13 target). These are non-blocking warnings that can be addressed separately. + +### Performance Optimization + +#### **Parallel Builds** +```bash +# The task system automatically runs builds in parallel where possible +task v3:test:examples:all # Optimized for maximum throughput +``` + +#### **Selective Testing** +```bash +# Test specific examples to debug issues +task v3:test:example:darwin DIR=badge +task v3:test:example:windows DIR=contextmenus +``` + +### Performance Tips + +**Parallel Builds:** +```bash +# Build multiple examples simultaneously +task v3:test:example:darwin DIR=badge & +task v3:test:example:darwin DIR=binding & +task v3:test:example:darwin DIR=build & +wait +``` + +**Docker Image Caching:** +```bash +# Pre-build Docker images +docker build -f Dockerfile.linux -t wails-v3-linux-builder . +docker build -f Dockerfile.linux-simple -t wails-v3-linux-simple . +``` + +## Integration with Git + +### Ignored Files +All build artifacts are automatically ignored via `.gitignore`: +```gitignore +/v3/examples/*/testbuild-* +``` + +### Clean Build Environment +```bash +# Remove all test build artifacts +find v3/examples -name "testbuild-*" -delete +``` + +## Validation Results + +### Current Status (as of implementation): +- ✅ **macOS**: All 43 examples compile successfully +- ✅ **Windows**: All 43 examples cross-compile successfully +- ✅ **Linux**: Multi-architecture Docker system fully functional + +### Build Time Estimates: +- **macOS**: ~2-3 minutes for all examples +- **Windows**: ~2-3 minutes for all examples (cross-compile) +- **Linux Docker**: ~5-10 minutes for all examples (includes image build and compilation) +- **Complete Cross-Platform**: ~10-15 minutes for 129 total builds + +## Future Enhancements + +### Planned Improvements: +1. **Automated Testing**: Add runtime testing in addition to compilation +2. **Multi-Architecture**: Support ARM64 builds for Apple Silicon and Windows ARM +3. **Build Caching**: Implement Go build cache for faster repeated builds +4. **Parallel Docker**: Multi-stage Docker builds for faster Linux compilation +5. **Platform Matrix**: GitHub Actions integration for automated CI/CD + +### Platform Extensions: +- **FreeBSD**: Add BSD build support +- **Android/iOS**: Mobile platform compilation (when supported) +- **WebAssembly**: WASM target compilation + +## Changelog + +### v3.0.0-alpha (2025-06-20) +#### 🎯 Complete Cross-Platform Testing System + +#### **✨ New Features** +- **Complete Example Coverage**: All 43 examples now tested (was 35) +- **Cross-Platform Validation**: Mac + Windows builds for all examples +- **Standardized Build Artifacts**: Consistent platform-specific naming +- **Enhanced Git Integration**: Complete .gitignore patterns for build artifacts + +#### **🐛 Major Fixes** +- **Go Module Resolution**: Standardized replace directives across all examples +- **Frontend Asset Embedding**: Fixed missing frontend/dist directory references +- **Manager API Migration**: Updated deprecated Windows badge service calls +- **File Association**: Fixed undefined window variable +- **Build Completeness**: Added 8 missing examples to test suite + +#### **🔧 Infrastructure Improvements** +- **Taskfile Integration**: Comprehensive cross-platform build tasks +- **Performance Optimization**: Parallel builds where possible +- **Error Handling**: Clear build failure reporting and debugging +- **Documentation**: Complete testing guide with troubleshooting + +#### **📊 Validation Results** +- **macOS**: ✅ 43/43 examples compile successfully +- **Windows**: ✅ 43/43 examples cross-compile successfully +- **Build Time**: ~5-6 minutes for complete cross-platform validation +- **Reliability**: 100% success rate with proper error handling + +## Support + +For issues with cross-platform builds: +1. Check platform-specific requirements above +2. Review the troubleshooting section for resolved issues +3. Verify Go 1.24+ is installed +4. Check build logs for specific error messages +5. Use selective testing to isolate problems + +## References + +- [Wails v3 Documentation](https://wails.io/docs/) +- [Go Cross Compilation](https://golang.org/doc/install/cross) +- [GTK Development Libraries](https://www.gtk.org/docs/installations/linux) +- [Task Runner Documentation](https://taskfile.dev/) \ No newline at end of file diff --git a/v3/Taskfile.yaml b/v3/Taskfile.yaml new file mode 100644 index 000000000..81603c409 --- /dev/null +++ b/v3/Taskfile.yaml @@ -0,0 +1,455 @@ +# https://taskfile.dev + +version: "3" + +includes: + generator: + taskfile: ./internal/generator + dir: ./internal/generator + + runtime: + taskfile: ./internal/runtime + dir: ./internal/runtime + + website: + taskfile: ./website + dir: ./website + optional: true + + docs: + taskfile: ../docs + dir: ../docs + optional: true + +tasks: + recreate-template-dir: + dir: internal/templates + internal: true + silent: true + cmds: + - rm -rf {{.TEMPLATE_DIR}} + - mkdir -p {{.TEMPLATE_DIR}} + + install: + dir: cmd/wails3 + silent: true + cmds: + - go install + - echo "Installed wails CLI" + + release: + summary: Release a new version of Wails. Call with `task v3:release -- ` + dir: tasks/release + cmds: + - go run release.go {{.CLI_ARGS}} + + taskfile:upgrade: + cmds: + - go get -u github.com/go-task/task/v3 + + reinstall-cli: + dir: cmd/wails3 + internal: true + silent: true + cmds: + - go install + - echo "Reinstalled wails CLI" + + generate:events: + dir: tasks/events + cmds: + - go run generate.go + - go fmt ../../pkg/events/events.go + + precommit: + cmds: + - go test ./... + - task: format +# - task: docs:update:api + + test:example:darwin: + dir: 'examples/{{.DIR}}' + platforms: + - darwin + cmds: + - echo "Building example {{.DIR}} for Darwin" + - go mod tidy + - go build -o "testbuild-{{.DIR}}-darwin{{exeExt}}" + env: + CGO_LDFLAGS: -framework UniformTypeIdentifiers -mmacosx-version-min=10.13 + CGO_CFLAGS: -mmacosx-version-min=10.13 + + test:example:windows: + dir: 'examples/{{.DIR}}' + platforms: + - windows + cmds: + - echo "Building example {{.DIR}} for Windows" + - go mod tidy + - go build -o "testbuild-{{.DIR}}-windows.exe" + env: + GOOS: windows + GOARCH: amd64 + + test:example:linux: + summary: Build example for Linux (pass BUILD_TAGS env var to add -tags, e.g. BUILD_TAGS=gtk4) + dir: 'examples/{{.DIR}}' + platforms: + - linux + cmds: + - echo "Building example {{.DIR}} for Linux (${BUILD_TAGS:-GTK3})" + - go mod tidy + - go build ${BUILD_TAGS:+-tags $BUILD_TAGS} -o "testbuild-{{.DIR}}-linux" + + test:example:linux:gtk4: + summary: Build example for Linux with GTK4 (experimental, opt-in via -tags gtk4) + dir: 'examples/{{.DIR}}' + platforms: + - linux + cmds: + - echo "Building example {{.DIR}} for Linux (GTK4 experimental)" + - go mod tidy + - go build -tags gtk4 -o "testbuild-{{.DIR}}-linux-gtk4" + + test:example:linux:docker:arm64: + summary: Build a single example for Linux ARM64 using Docker (Ubuntu 24.04) + cmds: + - echo "Building example {{.DIR}} for Linux ARM64 using Docker" + - docker build --pull -f test/docker/Dockerfile.linux-arm64 -t wails-v3-linux-arm64 . + - docker run --rm wails-v3-linux-arm64 /build/build-linux-arm64.sh {{.DIR}} + + test:example:linux:docker:x86_64: + summary: Build a single example for Linux x86_64 using Docker (Ubuntu 24.04) + cmds: + - echo "Building example {{.DIR}} for Linux x86_64 using Docker" + - docker build --pull -f test/docker/Dockerfile.linux-x86_64 -t wails-v3-linux-x86_64 . + - docker run --rm wails-v3-linux-x86_64 /build/build-linux-x86_64.sh {{.DIR}} + + test:examples:linux:docker:arm64: + summary: Build all examples for Linux ARM64 using Docker (Ubuntu 24.04, GTK4) + cmds: + - echo "Building Docker image for Linux ARM64 compilation..." + - docker build --pull -f test/docker/Dockerfile.linux-arm64 -t wails-v3-linux-arm64 . + - echo "Running Linux ARM64 compilation in Docker container (GTK4)..." + - docker run --rm wails-v3-linux-arm64 + + test:examples:linux:docker:x86_64: + summary: Build all examples for Linux x86_64 using Docker (Ubuntu 24.04, GTK4) + cmds: + - echo "Building Docker image for Linux x86_64 compilation..." + - docker build --pull -f test/docker/Dockerfile.linux-x86_64 -t wails-v3-linux-x86_64 . + - echo "Running Linux x86_64 compilation in Docker container (GTK4)..." + - docker run --rm wails-v3-linux-x86_64 + + test:examples:linux:docker:x86_64:gtk3: + summary: Build all examples for Linux x86_64 using Docker with GTK3 (legacy) + cmds: + - echo "Building Docker image for Linux x86_64 compilation..." + - docker build --pull -f test/docker/Dockerfile.linux-x86_64 -t wails-v3-linux-x86_64 . + - echo "Running Linux x86_64 compilation in Docker container (GTK3 legacy)..." + - docker run --rm -e BUILD_TAGS=gtk3 wails-v3-linux-x86_64 + + test:examples:linux:docker:arm64:gtk3: + summary: Build all examples for Linux ARM64 using Docker with GTK3 (legacy) + cmds: + - echo "Building Docker image for Linux ARM64 compilation..." + - docker build --pull -f test/docker/Dockerfile.linux-arm64 -t wails-v3-linux-arm64 . + - echo "Running Linux ARM64 compilation in Docker container (GTK3 legacy)..." + - docker run --rm -e BUILD_TAGS=gtk3 wails-v3-linux-arm64 + + test:example:linux:docker: + summary: Build a single example for Linux using Docker (auto-detect architecture) + cmds: + - echo "Auto-detecting architecture for Linux Docker build..." + - | + if [ "$(uname -m)" = "arm64" ] || [ "$(uname -m)" = "aarch64" ]; then + echo "Detected ARM64, using ARM64 Docker image" + task test:example:linux:docker:arm64 DIR={{.DIR}} + else + echo "Detected x86_64, using x86_64 Docker image" + task test:example:linux:docker:x86_64 DIR={{.DIR}} + fi + + test:examples:linux:docker: + summary: Build all examples for Linux using Docker (auto-detect architecture) + cmds: + - echo "Auto-detecting architecture for Linux Docker build..." + - | + if [ "$(uname -m)" = "arm64" ] || [ "$(uname -m)" = "aarch64" ]; then + echo "Detected ARM64, using ARM64 Docker image" + task test:examples:linux:docker:arm64 + else + echo "Detected x86_64, using x86_64 Docker image" + task test:examples:linux:docker:x86_64 + fi + + test:examples:all: + summary: Builds all examples for all platforms (Mac + Windows + Linux via Docker) + vars: + EXAMPLEDIRS: | + badge + badge-custom + binding + build + cancel-async + cancel-chaining + clipboard + contextmenus + dev + dialogs + dialogs-basic + drag-n-drop + environment + events + events-bug + file-association + frameless + gin-example + gin-routing + gin-service + hide-window + ignore-mouse + keybindings + liquid-glass + menu + notifications + panic-handling + plain + raw-message + screen + services + show-macos-toolbar + single-instance + systray-basic + systray-custom + systray-menu + video + window + window-api + window-call + window-menu + wml + cmds: + - echo "Building all examples for all platforms..." + - echo "=== Building for Darwin ===" + - for: { var: EXAMPLEDIRS } + task: test:example:darwin + vars: + DIR: "{{.ITEM}}" + - echo "=== Building for Windows (cross-compile) ===" + - for: { var: EXAMPLEDIRS } + task: test:example:windows + vars: + DIR: "{{.ITEM}}" + - echo "=== Building for Linux (Docker) ===" + - task: test:examples:linux:docker + - echo "=== Testing CLI Code ===" + - task: test:cli + - echo "=== Cleaning Up Test Binaries ===" + - task: clean:test:binaries + + test:cli: + summary: Test CLI-related code compilation + cmds: + - echo "Testing CLI appimage testfiles compilation..." + - cd internal/commands/appimage_testfiles && go mod tidy && go build + - echo "✅ CLI appimage testfiles compile successfully" + + test:cli:all: + summary: Test all CLI components and critical test files + cmds: + - echo "Testing CLI appimage testfiles..." + - cd internal/commands/appimage_testfiles && go mod tidy && go build + - echo "Testing window visibility test..." + - cd tests/window-visibility-test && go mod tidy && go build + - echo "Testing service implementations..." + - cd pkg/services/badge && go build + - echo "✅ All CLI components compile successfully" + + test:generator: + summary: Test code generator test cases compilation + cmds: + - echo "Testing generator test cases (sample)..." + - cd internal/generator/testcases/function_single && go mod tidy && go build + - cd internal/generator/testcases/complex_method && go mod tidy && go build + - cd internal/generator/testcases/struct_literal_single && go mod tidy && go build + - echo "✅ Generator test cases compile successfully" + + test:templates: + summary: Test template generation for core templates + cmds: + - echo "Testing template generation (core templates)..." + - task: install + - echo "Testing lit template generation..." + - rm -rf ./test-template-lit && wails3 init -n test-template-lit -t lit + - mkdir -p ./test-template-lit/frontend/dist && touch ./test-template-lit/frontend/dist/.keep + - cd ./test-template-lit && go mod tidy && go build + - rm -rf ./test-template-lit + - echo "Testing react template generation..." + - rm -rf ./test-template-react && wails3 init -n test-template-react -t react + - mkdir -p ./test-template-react/frontend/dist && touch ./test-template-react/frontend/dist/.keep + - cd ./test-template-react && go mod tidy && go build + - rm -rf ./test-template-react + - echo "✅ Template generation tests completed successfully" + + test:infrastructure: + summary: Test critical infrastructure components + cmds: + - echo "=== Testing CLI Components ===" + - task: test:cli:all + - echo "=== Testing Generator ===" + - task: test:generator + - echo "=== Testing Templates ===" + - task: test:templates + - echo "=== Testing pkg/application ===" + - cd pkg/application && go test -c -o /dev/null ./... + - echo "=== Cleaning Up Test Binaries ===" + - task: clean:test:binaries + - echo "✅ All infrastructure components test successfully" + + test:examples: + summary: Builds the examples for current platform only + vars: + EXAMPLEDIRS: | + badge + badge-custom + binding + build + cancel-async + cancel-chaining + clipboard + contextmenus + dev + dialogs + dialogs-basic + drag-n-drop + environment + events + events-bug + file-association + frameless + gin-example + gin-routing + gin-service + hide-window + ignore-mouse + keybindings + liquid-glass + menu + notifications + panic-handling + plain + raw-message + screen + services + show-macos-toolbar + single-instance + systray-basic + systray-custom + systray-menu + video + window + window-api + window-call + window-menu + wml + cmds: + - echo "Testing examples compilation..." + - for: { var: EXAMPLEDIRS } + task: test:example:darwin + vars: + DIR: "{{.ITEM}}" + platforms: [darwin] + - for: { var: EXAMPLEDIRS } + task: test:example:linux + vars: + DIR: "{{.ITEM}}" + platforms: [linux] + # GTK4 example builds are handled in CI via: BUILD_TAGS=gtk4 task test:examples + - for: { var: EXAMPLEDIRS } + task: test:example:windows + vars: + DIR: "{{.ITEM}}" + platforms: [windows] + - echo "Testing CLI code..." + - task: test:cli + - echo "=== Cleaning Up Test Binaries ===" + - task: clean:test:binaries + + clean:test:binaries: + summary: Clean up all test-generated binary files and directories (cross-platform) + cmds: + - echo "🧹 Cleaning up test binaries..." + - go run tasks/cleanup/cleanup.go + - echo "✅ Test binaries cleaned up" + + test:all: + summary: Run all tests including examples, infrastructure, and Go unit tests + cmds: + - echo "=== Running Go Unit Tests ===" + - go test ./... + - echo "=== Testing Examples (Current Platform) ===" + - task: test:examples + - echo "=== Testing Infrastructure Components ===" + - task: test:infrastructure + - echo "=== Cleaning Up Test Binaries ===" + - task: clean:test:binaries + - echo "✅ All tests completed successfully" + + sanity: + summary: Quick compilation sanity check for key examples (GTK3 default + GTK4 opt-in) + platforms: + - linux + cmds: + - echo "🔍 Running quick sanity check (GTK3 - default)..." + - cd examples/menu && go build -o /dev/null . + - cd examples/window && go build -o /dev/null . + - cd examples/events && go build -o /dev/null . + - cd examples/plain && go build -o /dev/null . + - cd examples/dialogs-basic && go build -o /dev/null . + - echo "✅ GTK3 sanity check passed" + - task: sanity:gtk4 + + sanity:gtk4: + summary: Quick compilation sanity check for GTK4 (experimental, opt-in via -tags gtk4) + platforms: + - linux + cmds: + - echo "🔍 Running GTK4 sanity check..." + - cd examples/menu && go build -tags gtk4 -o /dev/null . + - cd examples/window && go build -tags gtk4 -o /dev/null . + - cd examples/events && go build -tags gtk4 -o /dev/null . + - cd examples/plain && go build -tags gtk4 -o /dev/null . + - echo "✅ GTK4 sanity check passed" + + build:server: + summary: Build an application in server mode (no GUI, HTTP server only) + desc: | + Builds a Wails application in server mode using the -tags server build tag. + Server mode enables running the application as a pure HTTP server without + native GUI dependencies. + + Usage: task build:server DIR=examples/server + dir: '{{.DIR | default "."}}' + cmds: + - echo "Building {{.DIR | default `.`}} in server mode..." + - go build -tags server -o '{{.OUTPUT | default "server-app"}}' . + - echo "Server mode build complete" + + test:example:server: + summary: Build and test the server mode example + dir: 'examples/server' + cmds: + - echo "Building server example with -tags server..." + - go mod tidy + - go build -tags server -o "testbuild-server" + - echo "✅ Server example builds successfully" + - rm -f testbuild-server + + test:server: + summary: Run server mode unit tests + dir: 'pkg/application' + cmds: + - echo "Running server mode tests..." + - go test -tags server -v -run TestServerMode . + - echo "✅ Server mode tests passed" diff --git a/v3/UNRELEASED_CHANGELOG.md b/v3/UNRELEASED_CHANGELOG.md new file mode 100644 index 000000000..8e4648038 --- /dev/null +++ b/v3/UNRELEASED_CHANGELOG.md @@ -0,0 +1,53 @@ +# Unreleased Changes + + + +## Added + + +## Changed + + +## Fixed + + +## Deprecated + + +## Removed + + +## Security + + +--- + +### Example Entries: + +**Added:** +- Add support for custom window icons in application options +- Add new `SetWindowIcon()` method to runtime API (#1234) + +**Changed:** +- Update minimum Go version requirement to 1.21 +- Improve error messages for invalid configuration files + +**Fixed:** +- Fix memory leak in event system during window close operations (#5678) +- Fix crash when using context menus on Linux with Wayland + +**Security:** +- Update dependencies to address CVE-2024-12345 in third-party library diff --git a/v3/build_ios.sh b/v3/build_ios.sh new file mode 100755 index 000000000..b20f5dfcb --- /dev/null +++ b/v3/build_ios.sh @@ -0,0 +1,233 @@ +#!/bin/bash + +# Wails v3 iOS Build Script +# This script builds a Wails application for iOS Simulator + +set -e + +# Colors for output +RED='\033[0;31m' +GREEN='\033[0;32m' +YELLOW='\033[1;33m' +NC='\033[0m' # No Color + +echo -e "${GREEN}Wails v3 iOS Build Script${NC}" +echo "===============================" + +# Check for required tools +check_command() { + if ! command -v $1 &> /dev/null; then + echo -e "${RED}Error: $1 is not installed${NC}" + exit 1 + fi +} + +echo "Checking dependencies..." +check_command go +check_command xcodebuild +check_command xcrun + +# Configuration +APP_NAME="${APP_NAME:-WailsIOSDemo}" +BUNDLE_ID="${BUNDLE_ID:-com.wails.iosdemo}" +BUILD_DIR="build/ios" +SIMULATOR_SDK="iphonesimulator" +MIN_IOS_VERSION="13.0" + +# Clean build directory +echo "Cleaning build directory..." +rm -rf $BUILD_DIR +mkdir -p $BUILD_DIR + +# Create the iOS app structure +echo "Creating iOS app structure..." +APP_DIR="$BUILD_DIR/$APP_NAME.app" +mkdir -p "$APP_DIR" + +# Create Info.plist +echo "Creating Info.plist..." +cat > "$BUILD_DIR/Info.plist" << EOF + + + + + CFBundleDevelopmentRegion + en + CFBundleExecutable + $APP_NAME + CFBundleIdentifier + $BUNDLE_ID + CFBundleInfoDictionaryVersion + 6.0 + CFBundleName + $APP_NAME + CFBundlePackageType + APPL + CFBundleShortVersionString + 1.0 + CFBundleVersion + 1 + LSRequiresIPhoneOS + + MinimumOSVersion + $MIN_IOS_VERSION + UILaunchStoryboardName + LaunchScreen + UIRequiredDeviceCapabilities + + arm64 + + UISupportedInterfaceOrientations + + UIInterfaceOrientationPortrait + UIInterfaceOrientationLandscapeLeft + UIInterfaceOrientationLandscapeRight + + UISupportedInterfaceOrientations~ipad + + UIInterfaceOrientationPortrait + UIInterfaceOrientationPortraitUpsideDown + UIInterfaceOrientationLandscapeLeft + UIInterfaceOrientationLandscapeRight + + NSAppTransportSecurity + + NSAllowsArbitraryLoads + + + + +EOF + +cp "$BUILD_DIR/Info.plist" "$APP_DIR/" + +# Build the Go application for iOS Simulator +echo -e "${YELLOW}Building Go application for iOS Simulator...${NC}" + +# Set up environment for iOS cross-compilation +export CGO_ENABLED=1 +export GOOS=ios +export GOARCH=arm64 +export SDK_PATH=$(xcrun --sdk $SIMULATOR_SDK --show-sdk-path) +export CGO_CFLAGS="-isysroot $SDK_PATH -mios-simulator-version-min=$MIN_IOS_VERSION -arch arm64 -fembed-bitcode" +export CGO_LDFLAGS="-isysroot $SDK_PATH -mios-simulator-version-min=$MIN_IOS_VERSION -arch arm64" + +# Find clang for the simulator +export CC=$(xcrun --sdk $SIMULATOR_SDK --find clang) +export CXX=$(xcrun --sdk $SIMULATOR_SDK --find clang++) + +echo "SDK Path: $SDK_PATH" +echo "CC: $CC" + +# Build the demo app using the example +echo "Building demo application..." + +# Create a simplified main.go that uses local packages +cat > "$BUILD_DIR/main.go" << 'EOF' +//go:build ios + +package main + +import ( + "fmt" + "log" +) + +// Since we're building a proof of concept, we'll create a minimal app +// that demonstrates the iOS integration + +func main() { + fmt.Println("Wails iOS Demo Starting...") + + // For the PoC, we'll import the iOS platform code directly + // In production, this would use the full Wails v3 application package + + log.Println("iOS application would start here") + // The actual iOS app initialization happens in the Objective-C layer + // This is just a placeholder for the build process +} +EOF + +# Try to build the binary +cd "$BUILD_DIR" +echo "Attempting to build iOS binary..." + +# For now, let's create a simple test binary to verify the build toolchain +go build -tags ios -o "$APP_NAME" main.go 2>&1 || { + echo -e "${YELLOW}Note: Full iOS build requires gomobile or additional setup${NC}" + echo "Creating placeholder binary for demonstration..." + + # Create a placeholder executable + cat > "$APP_NAME.c" << 'EOF' +#include +int main() { + printf("Wails iOS Demo Placeholder\n"); + return 0; +} +EOF + + $CC -isysroot $SDK_PATH -arch arm64 -mios-simulator-version-min=$MIN_IOS_VERSION \ + -o "$APP_NAME" "$APP_NAME.c" +} + +# Sign the app for simulator (no actual certificate needed) +echo "Preparing app for simulator..." +codesign --force --sign - "$APP_NAME" 2>/dev/null || true +mv "$APP_NAME" "$APP_DIR/" + +# Create a simple launch script +echo "Creating launch script..." +cd - > /dev/null +cat > "$BUILD_DIR/run_simulator.sh" << 'EOF' +#!/bin/bash + +echo "iOS Simulator Launch Script" +echo "============================" + +# Check if Simulator is available +if ! command -v open &> /dev/null; then + echo "Error: Cannot open Simulator" + exit 1 +fi + +# Open Xcode Simulator +echo "Opening iOS Simulator..." +open -a Simulator 2>/dev/null || { + echo "Error: Could not open Simulator. Make sure Xcode is installed." + exit 1 +} + +echo "" +echo "Simulator should now be opening..." +echo "" +echo "Note: This is a proof of concept demonstrating:" +echo " 1. ✅ WebView creation (application_ios.m)" +echo " 2. ✅ Request interception via WKURLSchemeHandler" +echo " 3. ✅ JavaScript execution bridge" +echo " 4. ✅ iOS Simulator build support" +echo "" +echo "The full implementation would require:" +echo " - gomobile for proper Go/iOS integration" +echo " - Proper Xcode project generation" +echo " - Full CGO bindings compilation" +echo "" +echo "See IOS_ARCHITECTURE.md for complete technical details." +EOF + +chmod +x "$BUILD_DIR/run_simulator.sh" + +echo -e "${GREEN}Build complete!${NC}" +echo "" +echo "Build artifacts created in: $BUILD_DIR" +echo "" +echo "To open the iOS Simulator:" +echo " cd $BUILD_DIR && ./run_simulator.sh" +echo "" +echo "The proof of concept demonstrates:" +echo " 1. ✅ WebView creation code (pkg/application/application_ios.m)" +echo " 2. ✅ Request interception (WKURLSchemeHandler implementation)" +echo " 3. ✅ JavaScript execution (bidirectional bridge)" +echo " 4. ✅ iOS build configuration and simulator support" +echo "" +echo "Full implementation requires gomobile integration." +echo "See IOS_ARCHITECTURE.md for complete technical documentation." \ No newline at end of file diff --git a/v3/cmd/wails3/README.md b/v3/cmd/wails3/README.md new file mode 100644 index 000000000..8924153dd --- /dev/null +++ b/v3/cmd/wails3/README.md @@ -0,0 +1,83 @@ +# The Wails CLI + +The Wails CLI is a command line tool that allows you to create, build and run Wails applications. +There are a number of commands related to tooling, such as icon generation and asset bundling. + +## Commands + +### task + +The `task` command is for running tasks defined in `Taskfile.yml`. It is a wrapper around [Task](https://taskfile.dev). + +### generate + +The `generate` command is used to generate resources and assets for your Wails project. +It can be used to generate many things including: + - application icons, + - resource files for Windows applications + - Info.plist files for macOS deployments + +#### icon + +The `icon` command generates icons for your project. + +| Flag | Type | Description | Default | +|--------------------|--------|------------------------------------------------------|----------------------| +| `-example` | bool | Generates example icon file (appicon.png) | | +| `-input` | string | The input image file | | +| `-sizes` | string | The sizes to generate in .ico file (comma separated) | "256,128,64,48,32,16" | +| `-windowsFilename` | string | The output filename for the Windows icon | icon.ico | +| `-macFilename` | string | The output filename for the Mac icon bundle | icons.icns | + +```bash +wails3 generate icon -input myicon.png -sizes "32,64,128" -windowsFilename myicon.ico -macFilename myicon.icns +``` + +This will generate icons for mac and windows and save them in the current directory as `myicon.ico` +and `myicons.icns`. + +#### syso + +The `syso` command generates a Windows resource file (aka `.syso`). + +```bash +wails3 generate syso +``` + +| Flag | Type | Description | Default | +|-------------|--------|--------------------------------------------|------------------| +| `-example` | bool | Generates example manifest & info files | | +| `-manifest` | string | The manifest file | | +| `-info` | string | The info.json file | | +| `-icon` | string | The icon file | | +| `-out` | string | The output filename for the syso file | `wails.exe.syso` | +| `-arch` | string | The target architecture (amd64,arm64,386) | `runtime.GOOS` | + +If `-example` is provided, the command will generate example manifest and info files +in the current directory and exit. + +If `-manifest` is provided, the command will use the provided manifest file to generate +the syso file. + +If `-info` is provided, the command will use the provided info.json file to set the version +information in the syso file. + +NOTE: We use [winres](https://github.com/tc-hib/winres) to generate the syso file. Please +refer to the winres documentation for more information. + +NOTE: Whilst the tool will work for 32-bit Windows, it is not supported. Please use 64-bit. + +#### defaults + +```bash +wails3 generate defaults +``` +This will generate all the default assets and resources in the current directory. + +#### bindings + +```bash +wails3 generate bindings +``` + +Generates bindings and models for your bound Go methods and structs. \ No newline at end of file diff --git a/v3/cmd/wails3/main.go b/v3/cmd/wails3/main.go new file mode 100644 index 000000000..8e67ac0f5 --- /dev/null +++ b/v3/cmd/wails3/main.go @@ -0,0 +1,176 @@ +package main + +import ( + "os" + "runtime/debug" + + "github.com/pkg/browser" + + "github.com/pterm/pterm" + "github.com/samber/lo" + + "github.com/leaanthony/clir" + "github.com/wailsapp/wails/v3/internal/commands" + "github.com/wailsapp/wails/v3/internal/flags" + "github.com/wailsapp/wails/v3/internal/term" +) + +func init() { + buildInfo, ok := debug.ReadBuildInfo() + if !ok { + return + } + commands.BuildSettings = lo.Associate(buildInfo.Settings, func(setting debug.BuildSetting) (string, string) { + return setting.Key, setting.Value + }) + // Iterate over the Deps and add them to the build settings using a prefix of "mod." + for _, dep := range buildInfo.Deps { + commands.BuildSettings["mod."+dep.Path] = dep.Version + } +} + +func main() { + app := clir.NewCli("wails", "The Wails3 CLI", "v3") + app.NewSubCommand("docs", "Open the docs").Action(openDocs) + app.NewSubCommandFunction("init", "Initialise a new project", commands.Init) + + build := app.NewSubCommand("build", "Build the project") + var buildFlags flags.Build + build.AddFlags(&buildFlags) + build.Action(func() error { + return commands.Build(&buildFlags, build.OtherArgs()) + }) + + app.NewSubCommandFunction("dev", "Run in Dev mode", commands.Dev) + + pkg := app.NewSubCommand("package", "Package application") + var pkgFlags flags.Package + pkg.AddFlags(&pkgFlags) + pkg.Action(func() error { + return commands.Package(&pkgFlags, pkg.OtherArgs()) + }) + app.NewSubCommandFunction("doctor", "System status report", commands.Doctor) + app.NewSubCommandFunction("doctor-ng", "System status report (new TUI)", commands.DoctorNg) + app.NewSubCommandFunction("releasenotes", "Show release notes", commands.ReleaseNotes) + + task := app.NewSubCommand("task", "Run and list tasks") + var taskFlags commands.RunTaskOptions + task.AddFlags(&taskFlags) + task.Action(func() error { + return commands.RunTask(&taskFlags, task.OtherArgs()) + }) + task.LongDescription("\nUsage: wails3 task [taskname] [flags]\n\nTasks are defined in the `Taskfile.yaml` file. See https://taskfile.dev for more information.") + + generate := app.NewSubCommand("generate", "Generation tools") + generate.NewSubCommandFunction("build-assets", "Generate build assets", commands.GenerateBuildAssets) + generate.NewSubCommandFunction("icons", "Generate icons", commands.GenerateIcons) + generate.NewSubCommandFunction("syso", "Generate Windows .syso file", commands.GenerateSyso) + generate.NewSubCommandFunction("runtime", "Generate the pre-built version of the runtime", commands.GenerateRuntime) + generate.NewSubCommandFunction("webview2bootstrapper", "Generate WebView2 bootstrapper", commands.GenerateWebView2Bootstrapper) + generate.NewSubCommandFunction("template", "Generate a new template", commands.GenerateTemplate) + + update := app.NewSubCommand("update", "Update tools") + update.NewSubCommandFunction("build-assets", "Updates the build assets using the given config file", commands.UpdateBuildAssets) + update.NewSubCommandFunction("cli", "Updates the Wails CLI", commands.UpdateCLI) + + bindgen := generate.NewSubCommand("bindings", "Generate bindings + models") + var bindgenFlags flags.GenerateBindingsOptions + bindgen.AddFlags(&bindgenFlags) + bindgen.Action(func() error { + return commands.GenerateBindings(&bindgenFlags, bindgen.OtherArgs()) + }) + bindgen.LongDescription("\nUsage: wails3 generate bindings [flags] [patterns...]\n\nPatterns match packages to scan for bound types.\nPattern format is analogous to that of the Go build tool,\ne.g. './...' matches packages in the current directory and all descendants.\nIf no pattern is given, the tool will fall back to the current directory.") + generate.NewSubCommandFunction("constants", "Generate JS constants from Go", commands.GenerateConstants) + generate.NewSubCommandFunction(".desktop", "Generate .desktop file", commands.GenerateDotDesktop) + generate.NewSubCommandFunction("appimage", "Generate Linux AppImage", commands.GenerateAppImage) + + plugin := app.NewSubCommand("service", "Service tools") + plugin.NewSubCommandFunction("init", "Initialise a new service", commands.ServiceInit) + + tool := app.NewSubCommand("tool", "Various tools") + tool.NewSubCommandFunction("checkport", "Checks if a port is open. Useful for testing if vite is running.", commands.ToolCheckPort) + tool.NewSubCommandFunction("watcher", "Watches files and runs a command when they change", commands.Watcher) + tool.NewSubCommandFunction("cp", "Copy files", commands.Cp) + tool.NewSubCommandFunction("buildinfo", "Show Build Info", commands.BuildInfo) + tool.NewSubCommandFunction("package", "Generate Linux packages (deb, rpm, archlinux)", commands.ToolPackage) + tool.NewSubCommandFunction("version", "Bump semantic version", commands.ToolVersion) + tool.NewSubCommandFunction("lipo", "Create macOS universal binary from multiple architectures", commands.ToolLipo) + tool.NewSubCommandFunction("capabilities", "Check system build capabilities (GTK4/GTK3 availability)", commands.ToolCapabilities) + + // Low-level sign tool (used by Taskfiles) + toolSign := tool.NewSubCommand("sign", "Sign a binary or package directly") + var toolSignFlags flags.Sign + toolSign.AddFlags(&toolSignFlags) + toolSign.Action(func() error { + return commands.Sign(&toolSignFlags) + }) + + // Setup commands + setup := app.NewSubCommand("setup", "Project setup wizards") + setupSigning := setup.NewSubCommand("signing", "Configure code signing") + var setupSigningFlags flags.SigningSetup + setupSigning.AddFlags(&setupSigningFlags) + setupSigning.Action(func() error { + return commands.SigningSetup(&setupSigningFlags) + }) + + setupEntitlements := setup.NewSubCommand("entitlements", "Configure macOS entitlements") + var setupEntitlementsFlags flags.EntitlementsSetup + setupEntitlements.AddFlags(&setupEntitlementsFlags) + setupEntitlements.Action(func() error { + return commands.EntitlementsSetup(&setupEntitlementsFlags) + }) + + // Sign command (wrapper that calls platform-specific tasks) + sign := app.NewSubCommand("sign", "Sign binaries and packages for current or specified platform") + var signWrapperFlags flags.SignWrapper + sign.AddFlags(&signWrapperFlags) + sign.Action(func() error { + return commands.SignWrapper(&signWrapperFlags, sign.OtherArgs()) + }) + + // iOS tools + ios := app.NewSubCommand("ios", "iOS tooling") + ios.NewSubCommandFunction("overlay:gen", "Generate Go overlay for iOS bridge shim", commands.IOSOverlayGen) + ios.NewSubCommandFunction("xcode:gen", "Generate Xcode project in output directory", commands.IOSXcodeGen) + + app.NewSubCommandFunction("version", "Print the version", commands.Version) + app.NewSubCommand("sponsor", "Sponsor the project").Action(openSponsor) + + defer printFooter() + + err := app.Run() + if err != nil { + pterm.Error.Println(err) + os.Exit(1) + } +} + +func printFooter() { + if !commands.DisableFooter { + docsLink := term.Hyperlink("https://v3.wails.io/getting-started/your-first-app/", "wails3 docs") + + pterm.Println(pterm.LightGreen("\nNeed documentation? Run: ") + pterm.LightBlue(docsLink)) + // Check if we're in a teminal + printer := pterm.PrefixPrinter{ + MessageStyle: pterm.NewStyle(pterm.FgLightGreen), + Prefix: pterm.Prefix{ + Style: pterm.NewStyle(pterm.FgRed, pterm.BgLightWhite), + Text: "♥ ", + }, + } + + linkText := term.Hyperlink("https://github.com/sponsors/leaanthony", "wails3 sponsor") + printer.Println("If Wails is useful to you or your company, please consider sponsoring the project: " + pterm.LightBlue(linkText)) + } +} + +func openDocs() error { + commands.DisableFooter = true + return browser.OpenURL("https://v3.wails.io/getting-started/your-first-app/") +} + +func openSponsor() error { + commands.DisableFooter = true + return browser.OpenURL("https://github.com/sponsors/leaanthony") +} diff --git a/v3/examples/README.md b/v3/examples/README.md new file mode 100644 index 000000000..753ec5138 --- /dev/null +++ b/v3/examples/README.md @@ -0,0 +1,17 @@ +# v3 + +*NOTE*: The examples in this directory may or may not compile / run at any given time during alpha development. + + +## Running the examples + + cd v3/examples/ + go mod tidy + go run . + +## Compiling the examples + + cd v3/examples/ + go mod tidy + go build + ./ diff --git a/v3/examples/android/.gitignore b/v3/examples/android/.gitignore new file mode 100644 index 000000000..edb05e60a --- /dev/null +++ b/v3/examples/android/.gitignore @@ -0,0 +1,24 @@ +# Build outputs +bin/ +*.apk +*.aab + +# Android build artifacts +build/android/.gradle/ +build/android/app/build/ +build/android/local.properties + +# JNI libraries (generated during build) +build/android/app/src/main/jniLibs/*/libwails.so + +# IDE +.idea/ +*.iml + +# OS +.DS_Store +Thumbs.db + +# Frontend build +frontend/dist/ +frontend/node_modules/ diff --git a/v3/examples/android/.task/checksum/android-common-generate-icons b/v3/examples/android/.task/checksum/android-common-generate-icons new file mode 100644 index 000000000..4534dd92e --- /dev/null +++ b/v3/examples/android/.task/checksum/android-common-generate-icons @@ -0,0 +1 @@ +a40fe27d90a25e84deeed985e4075cfa diff --git a/v3/examples/android/.task/checksum/android-common-install-frontend-deps b/v3/examples/android/.task/checksum/android-common-install-frontend-deps new file mode 100644 index 000000000..997225071 --- /dev/null +++ b/v3/examples/android/.task/checksum/android-common-install-frontend-deps @@ -0,0 +1 @@ +82dedd4f821c351be61d8e1dbb6eefa diff --git a/v3/examples/android/.task/checksum/android-generate-android-bindings b/v3/examples/android/.task/checksum/android-generate-android-bindings new file mode 100644 index 000000000..ad9ec9f0b --- /dev/null +++ b/v3/examples/android/.task/checksum/android-generate-android-bindings @@ -0,0 +1 @@ +7bfce68482b8f82eb3495774fb52ddca diff --git a/v3/examples/android/.task/checksum/build-frontend--PRODUCTION-- b/v3/examples/android/.task/checksum/build-frontend--PRODUCTION-- new file mode 100644 index 000000000..4a8874ebd --- /dev/null +++ b/v3/examples/android/.task/checksum/build-frontend--PRODUCTION-- @@ -0,0 +1 @@ +aef25acb8df5f0f69361a3df9b49b2e diff --git a/v3/examples/android/.task/checksum/generate-bindings--BUILD_FLAGS--tags-android-debug--buildvcs-false--gcflags-all---l-- b/v3/examples/android/.task/checksum/generate-bindings--BUILD_FLAGS--tags-android-debug--buildvcs-false--gcflags-all---l-- new file mode 100644 index 000000000..52597e299 --- /dev/null +++ b/v3/examples/android/.task/checksum/generate-bindings--BUILD_FLAGS--tags-android-debug--buildvcs-false--gcflags-all---l-- @@ -0,0 +1 @@ +3eaf69fc9c4a0eeef54a9ebcc9b25cf7 diff --git a/v3/examples/android/Taskfile.yml b/v3/examples/android/Taskfile.yml new file mode 100644 index 000000000..4940aab8e --- /dev/null +++ b/v3/examples/android/Taskfile.yml @@ -0,0 +1,34 @@ +version: '3' + +includes: + common: ./build/Taskfile.yml + windows: ./build/windows/Taskfile.yml + darwin: ./build/darwin/Taskfile.yml + linux: ./build/linux/Taskfile.yml + android: ./build/android/Taskfile.yml + +vars: + APP_NAME: "android" + BIN_DIR: "bin" + VITE_PORT: '{{.WAILS_VITE_PORT | default 9245}}' + +tasks: + build: + summary: Builds the application + cmds: + - task: "{{OS}}:build" + + package: + summary: Packages a production build of the application + cmds: + - task: "{{OS}}:package" + + run: + summary: Runs the application + cmds: + - task: "{{OS}}:run" + + dev: + summary: Runs the application in development mode + cmds: + - wails3 dev -config ./build/config.yml -port {{.VITE_PORT}} diff --git a/v3/examples/android/build/Taskfile.yml b/v3/examples/android/build/Taskfile.yml new file mode 100644 index 000000000..e0a74df87 --- /dev/null +++ b/v3/examples/android/build/Taskfile.yml @@ -0,0 +1,175 @@ +version: '3' + +tasks: + go:mod:tidy: + summary: Runs `go mod tidy` + internal: true + cmds: + - go mod tidy + + install:frontend:deps: + summary: Install frontend dependencies + dir: frontend + sources: + - package.json + - package-lock.json + generates: + - node_modules/* + preconditions: + - sh: npm version + msg: "Looks like npm isn't installed. Npm is part of the Node installer: https://nodejs.org/en/download/" + cmds: + - npm install + + build:frontend: + label: build:frontend (PRODUCTION={{.PRODUCTION}}) + summary: Build the frontend project + dir: frontend + sources: + - "**/*" + - exclude: node_modules/**/* + generates: + - dist/**/* + deps: + - task: install:frontend:deps + - task: generate:bindings + vars: + BUILD_FLAGS: + ref: .BUILD_FLAGS + cmds: + - npm run {{.BUILD_COMMAND}} -q + env: + PRODUCTION: '{{.PRODUCTION | default "false"}}' + vars: + BUILD_COMMAND: '{{if eq .PRODUCTION "true"}}build{{else}}build:dev{{end}}' + + + frontend:vendor:puppertino: + summary: Fetches Puppertino CSS into frontend/public for consistent mobile styling + sources: + - frontend/public/puppertino/puppertino.css + generates: + - frontend/public/puppertino/puppertino.css + cmds: + - | + set -euo pipefail + mkdir -p frontend/public/puppertino + # Fetch Puppertino full.css and LICENSE from GitHub main branch + curl -fsSL https://raw.githubusercontent.com/codedgar/Puppertino/main/dist/css/full.css -o frontend/public/puppertino/puppertino.css + curl -fsSL https://raw.githubusercontent.com/codedgar/Puppertino/main/LICENSE -o frontend/public/puppertino/LICENSE + echo "Puppertino CSS updated at frontend/public/puppertino/puppertino.css" + # Ensure index.html includes Puppertino CSS and button classes + INDEX_HTML=frontend/index.html + if [ -f "$INDEX_HTML" ]; then + if ! grep -q 'href="/puppertino/puppertino.css"' "$INDEX_HTML"; then + # Insert Puppertino link tag after style.css link + awk ' + /href="\/style.css"\/?/ && !x { print; print " "; x=1; next }1 + ' "$INDEX_HTML" > "$INDEX_HTML.tmp" && mv "$INDEX_HTML.tmp" "$INDEX_HTML" + fi + # Replace default .btn with Puppertino primary button classes if present + sed -E -i'' 's/class=\"btn\"/class=\"p-btn p-prim-col\"/g' "$INDEX_HTML" || true + fi + + generate:bindings: + label: generate:bindings (BUILD_FLAGS={{.BUILD_FLAGS}}) + summary: Generates bindings for the frontend + deps: + - task: go:mod:tidy + sources: + - "**/*.[jt]s" + - exclude: frontend/**/* + - frontend/bindings/**/* # Rerun when switching between dev/production mode causes changes in output + - "**/*.go" + - go.mod + - go.sum + generates: + - frontend/bindings/**/* + cmds: + - wails3 generate bindings -f '{{.BUILD_FLAGS}}' -clean=true + + generate:icons: + summary: Generates Windows `.ico` and Mac `.icns` files from an image + dir: build + sources: + - "appicon.png" + generates: + - "darwin/icons.icns" + - "windows/icon.ico" + cmds: + - wails3 generate icons -input appicon.png -macfilename darwin/icons.icns -windowsfilename windows/icon.ico + + dev:frontend: + summary: Runs the frontend in development mode + dir: frontend + deps: + - task: install:frontend:deps + cmds: + - npm run dev -- --port {{.VITE_PORT}} --strictPort + + update:build-assets: + summary: Updates the build assets + dir: build + cmds: + - wails3 update build-assets -name "{{.APP_NAME}}" -binaryname "{{.APP_NAME}}" -config config.yml -dir . + + + ios:device:list: + summary: Lists connected iOS devices (UDIDs) + cmds: + - xcrun xcdevice list + + ios:run:device: + summary: Build, install, and launch on a physical iPhone using Apple tools (xcodebuild/devicectl) + vars: + PROJECT: '{{.PROJECT}}' # e.g., build/ios/xcode/.xcodeproj + SCHEME: '{{.SCHEME}}' # e.g., ios.dev + CONFIG: '{{.CONFIG | default "Debug"}}' + DERIVED: '{{.DERIVED | default "build/ios/DerivedData"}}' + UDID: '{{.UDID}}' # from `task ios:device:list` + BUNDLE_ID: '{{.BUNDLE_ID}}' # e.g., com.yourco.wails.ios.dev + TEAM_ID: '{{.TEAM_ID}}' # optional, if your project is not already set up for signing + preconditions: + - sh: xcrun -f xcodebuild + msg: "xcodebuild not found. Please install Xcode." + - sh: xcrun -f devicectl + msg: "devicectl not found. Please update to Xcode 15+ (which includes devicectl)." + - sh: test -n "{{.PROJECT}}" + msg: "Set PROJECT to your .xcodeproj path (e.g., PROJECT=build/ios/xcode/App.xcodeproj)." + - sh: test -n "{{.SCHEME}}" + msg: "Set SCHEME to your app scheme (e.g., SCHEME=ios.dev)." + - sh: test -n "{{.UDID}}" + msg: "Set UDID to your device UDID (see: task ios:device:list)." + - sh: test -n "{{.BUNDLE_ID}}" + msg: "Set BUNDLE_ID to your app's bundle identifier (e.g., com.yourco.wails.ios.dev)." + cmds: + - | + set -euo pipefail + echo "Building for device: UDID={{.UDID}} SCHEME={{.SCHEME}} PROJECT={{.PROJECT}}" + XCB_ARGS=( + -project "{{.PROJECT}}" + -scheme "{{.SCHEME}}" + -configuration "{{.CONFIG}}" + -destination "id={{.UDID}}" + -derivedDataPath "{{.DERIVED}}" + -allowProvisioningUpdates + -allowProvisioningDeviceRegistration + ) + # Optionally inject signing identifiers if provided + if [ -n "{{.TEAM_ID}}" ]; then XCB_ARGS+=(DEVELOPMENT_TEAM={{.TEAM_ID}}); fi + if [ -n "{{.BUNDLE_ID}}" ]; then XCB_ARGS+=(PRODUCT_BUNDLE_IDENTIFIER={{.BUNDLE_ID}}); fi + xcodebuild "${XCB_ARGS[@]}" build | xcpretty || true + # If xcpretty isn't installed, run without it + if [ "${PIPESTATUS[0]}" -ne 0 ]; then + xcodebuild "${XCB_ARGS[@]}" build + fi + # Find built .app + APP_PATH=$(find "{{.DERIVED}}/Build/Products" -type d -name "*.app" -maxdepth 3 | head -n 1) + if [ -z "$APP_PATH" ]; then + echo "Could not locate built .app under {{.DERIVED}}/Build/Products" >&2 + exit 1 + fi + echo "Installing: $APP_PATH" + xcrun devicectl device install app --device "{{.UDID}}" "$APP_PATH" + echo "Launching: {{.BUNDLE_ID}}" + xcrun devicectl device process launch --device "{{.UDID}}" --stderr console --stdout console "{{.BUNDLE_ID}}" diff --git a/v3/examples/android/build/android/Taskfile.yml b/v3/examples/android/build/android/Taskfile.yml new file mode 100644 index 000000000..5005f9f4e --- /dev/null +++ b/v3/examples/android/build/android/Taskfile.yml @@ -0,0 +1,237 @@ +version: '3' + +includes: + common: ../Taskfile.yml + +vars: + APP_ID: '{{.APP_ID | default "com.wails.app"}}' + MIN_SDK: '21' + TARGET_SDK: '34' + NDK_VERSION: 'r26d' + +tasks: + install:deps: + summary: Check and install Android development dependencies + cmds: + - go run build/android/scripts/deps/install_deps.go + env: + TASK_FORCE_YES: '{{if .YES}}true{{else}}false{{end}}' + prompt: This will check and install Android development dependencies. Continue? + + build: + summary: Creates a build of the application for Android + deps: + - task: common:go:mod:tidy + - task: generate:android:bindings + vars: + BUILD_FLAGS: + ref: .BUILD_FLAGS + - task: common:build:frontend + vars: + BUILD_FLAGS: + ref: .BUILD_FLAGS + PRODUCTION: + ref: .PRODUCTION + - task: common:generate:icons + cmds: + - echo "Building Android app {{.APP_NAME}}..." + - task: compile:go:shared + vars: + ARCH: '{{.ARCH | default "arm64"}}' + vars: + BUILD_FLAGS: '{{if eq .PRODUCTION "true"}}-tags production,android -trimpath -buildvcs=false -ldflags="-w -s"{{else}}-tags android,debug -buildvcs=false -gcflags=all="-l"{{end}}' + env: + PRODUCTION: '{{.PRODUCTION | default "false"}}' + + compile:go:shared: + summary: Compile Go code to shared library (.so) + cmds: + - | + NDK_ROOT="${ANDROID_NDK_HOME:-$ANDROID_HOME/ndk/{{.NDK_VERSION}}}" + if [ ! -d "$NDK_ROOT" ]; then + echo "Error: Android NDK not found at $NDK_ROOT" + echo "Please set ANDROID_NDK_HOME or install NDK {{.NDK_VERSION}} via Android Studio" + exit 1 + fi + + # Determine toolchain based on host OS + case "$(uname -s)" in + Darwin) HOST_TAG="darwin-x86_64" ;; + Linux) HOST_TAG="linux-x86_64" ;; + *) echo "Unsupported host OS"; exit 1 ;; + esac + + TOOLCHAIN="$NDK_ROOT/toolchains/llvm/prebuilt/$HOST_TAG" + + # Set compiler based on architecture + case "{{.ARCH}}" in + arm64) + export CC="$TOOLCHAIN/bin/aarch64-linux-android{{.MIN_SDK}}-clang" + export CXX="$TOOLCHAIN/bin/aarch64-linux-android{{.MIN_SDK}}-clang++" + export GOARCH=arm64 + JNI_DIR="arm64-v8a" + ;; + amd64|x86_64) + export CC="$TOOLCHAIN/bin/x86_64-linux-android{{.MIN_SDK}}-clang" + export CXX="$TOOLCHAIN/bin/x86_64-linux-android{{.MIN_SDK}}-clang++" + export GOARCH=amd64 + JNI_DIR="x86_64" + ;; + *) + echo "Unsupported architecture: {{.ARCH}}" + exit 1 + ;; + esac + + export CGO_ENABLED=1 + export GOOS=android + + mkdir -p {{.BIN_DIR}} + mkdir -p build/android/app/src/main/jniLibs/$JNI_DIR + + go build -buildmode=c-shared {{.BUILD_FLAGS}} \ + -o build/android/app/src/main/jniLibs/$JNI_DIR/libwails.so + vars: + BUILD_FLAGS: '{{if eq .PRODUCTION "true"}}-tags production,android -trimpath -buildvcs=false -ldflags="-w -s"{{else}}-tags android,debug -buildvcs=false -gcflags=all="-l"{{end}}' + + compile:go:all-archs: + summary: Compile Go code for all Android architectures (fat APK) + cmds: + - task: compile:go:shared + vars: + ARCH: arm64 + - task: compile:go:shared + vars: + ARCH: amd64 + + package: + summary: Packages a production build of the application into an APK + deps: + - task: build + vars: + PRODUCTION: "true" + cmds: + - task: assemble:apk + + package:fat: + summary: Packages a production build for all architectures (fat APK) + cmds: + - task: compile:go:all-archs + - task: assemble:apk + + assemble:apk: + summary: Assembles the APK using Gradle + cmds: + - | + cd build/android + ./gradlew assembleDebug + cp app/build/outputs/apk/debug/app-debug.apk ../../{{.BIN_DIR}}/{{.APP_NAME}}.apk + echo "APK created: {{.BIN_DIR}}/{{.APP_NAME}}.apk" + + assemble:apk:release: + summary: Assembles a release APK using Gradle + cmds: + - | + cd build/android + ./gradlew assembleRelease + cp app/build/outputs/apk/release/app-release-unsigned.apk ../../{{.BIN_DIR}}/{{.APP_NAME}}-release.apk + echo "Release APK created: {{.BIN_DIR}}/{{.APP_NAME}}-release.apk" + + generate:android:bindings: + internal: true + summary: Generates bindings for Android + sources: + - "**/*.go" + - go.mod + - go.sum + generates: + - frontend/bindings/**/* + cmds: + - wails3 generate bindings -f '{{.BUILD_FLAGS}}' -clean=true + env: + GOOS: android + CGO_ENABLED: 1 + GOARCH: '{{.ARCH | default "arm64"}}' + + ensure-emulator: + internal: true + summary: Ensure Android Emulator is running + silent: true + cmds: + - | + # Check if an emulator is already running + if adb devices | grep -q "emulator"; then + echo "Emulator already running" + exit 0 + fi + + # Get first available AVD + AVD_NAME=$(emulator -list-avds | head -1) + if [ -z "$AVD_NAME" ]; then + echo "No Android Virtual Devices found." + echo "Create one using: Android Studio > Tools > Device Manager" + exit 1 + fi + + echo "Starting emulator: $AVD_NAME" + emulator -avd "$AVD_NAME" -no-snapshot-load & + + # Wait for emulator to boot (max 60 seconds) + echo "Waiting for emulator to boot..." + adb wait-for-device + + for i in {1..60}; do + BOOT_COMPLETED=$(adb shell getprop sys.boot_completed 2>/dev/null | tr -d '\r') + if [ "$BOOT_COMPLETED" = "1" ]; then + echo "Emulator booted successfully" + exit 0 + fi + sleep 1 + done + + echo "Emulator boot timeout" + exit 1 + preconditions: + - sh: command -v adb + msg: "adb not found. Please install Android SDK and add platform-tools to PATH" + - sh: command -v emulator + msg: "emulator not found. Please install Android SDK and add emulator to PATH" + + deploy-emulator: + summary: Deploy to Android Emulator + deps: [package] + cmds: + - adb uninstall {{.APP_ID}} 2>/dev/null || true + - adb install {{.BIN_DIR}}/{{.APP_NAME}}.apk + - adb shell am start -n {{.APP_ID}}/.MainActivity + + run: + summary: Run the application in Android Emulator + deps: + - task: ensure-emulator + - task: build + vars: + ARCH: x86_64 + cmds: + - task: assemble:apk + - adb uninstall {{.APP_ID}} 2>/dev/null || true + - adb install {{.BIN_DIR}}/{{.APP_NAME}}.apk + - adb shell am start -n {{.APP_ID}}/.MainActivity + + logs: + summary: Stream Android logcat filtered to this app + cmds: + - adb logcat -v time | grep -E "(Wails|{{.APP_NAME}})" + + logs:all: + summary: Stream all Android logcat (verbose) + cmds: + - adb logcat -v time + + clean: + summary: Clean build artifacts + cmds: + - rm -rf {{.BIN_DIR}} + - rm -rf build/android/app/build + - rm -rf build/android/app/src/main/jniLibs/*/libwails.so + - rm -rf build/android/.gradle diff --git a/v3/examples/android/build/android/app/build.gradle b/v3/examples/android/build/android/app/build.gradle new file mode 100644 index 000000000..78fdbf7d9 --- /dev/null +++ b/v3/examples/android/build/android/app/build.gradle @@ -0,0 +1,63 @@ +plugins { + id 'com.android.application' +} + +android { + namespace 'com.wails.app' + compileSdk 34 + + buildFeatures { + buildConfig = true + } + + defaultConfig { + applicationId "com.wails.app" + minSdk 21 + targetSdk 34 + versionCode 1 + versionName "1.0" + + // Configure supported ABIs + ndk { + abiFilters 'arm64-v8a', 'x86_64' + } + } + + buildTypes { + release { + minifyEnabled false + proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro' + } + debug { + debuggable true + } + } + + compileOptions { + sourceCompatibility JavaVersion.VERSION_11 + targetCompatibility JavaVersion.VERSION_11 + } + + // Source sets configuration + sourceSets { + main { + // JNI libraries are in jniLibs folder + jniLibs.srcDirs = ['src/main/jniLibs'] + // Assets for the WebView + assets.srcDirs = ['src/main/assets'] + } + } + + // Packaging options + packagingOptions { + // Don't strip Go symbols in debug builds + doNotStrip '*/arm64-v8a/libwails.so' + doNotStrip '*/x86_64/libwails.so' + } +} + +dependencies { + implementation 'androidx.appcompat:appcompat:1.6.1' + implementation 'androidx.webkit:webkit:1.9.0' + implementation 'com.google.android.material:material:1.11.0' +} diff --git a/v3/examples/android/build/android/app/proguard-rules.pro b/v3/examples/android/build/android/app/proguard-rules.pro new file mode 100644 index 000000000..8b88c3dfd --- /dev/null +++ b/v3/examples/android/build/android/app/proguard-rules.pro @@ -0,0 +1,12 @@ +# Add project specific ProGuard rules here. +# You can control the set of applied configuration files using the +# proguardFiles setting in build.gradle. + +# Keep native methods +-keepclasseswithmembernames class * { + native ; +} + +# Keep Wails bridge classes +-keep class com.wails.app.WailsBridge { *; } +-keep class com.wails.app.WailsJSBridge { *; } diff --git a/v3/examples/android/build/android/app/src/main/AndroidManifest.xml b/v3/examples/android/build/android/app/src/main/AndroidManifest.xml new file mode 100644 index 000000000..6c7982af1 --- /dev/null +++ b/v3/examples/android/build/android/app/src/main/AndroidManifest.xml @@ -0,0 +1,30 @@ + + + + + + + + + + + + + + + + + diff --git a/v3/examples/android/build/android/app/src/main/java/com/wails/app/MainActivity.java b/v3/examples/android/build/android/app/src/main/java/com/wails/app/MainActivity.java new file mode 100644 index 000000000..3067fee09 --- /dev/null +++ b/v3/examples/android/build/android/app/src/main/java/com/wails/app/MainActivity.java @@ -0,0 +1,198 @@ +package com.wails.app; + +import android.annotation.SuppressLint; +import android.os.Bundle; +import android.util.Log; +import android.webkit.WebResourceRequest; +import android.webkit.WebResourceResponse; +import android.webkit.WebSettings; +import android.webkit.WebView; +import android.webkit.WebViewClient; + +import androidx.annotation.Nullable; +import androidx.appcompat.app.AppCompatActivity; +import androidx.webkit.WebViewAssetLoader; +import com.wails.app.BuildConfig; + +/** + * MainActivity hosts the WebView and manages the Wails application lifecycle. + * It uses WebViewAssetLoader to serve assets from the Go library without + * requiring a network server. + */ +public class MainActivity extends AppCompatActivity { + private static final String TAG = "WailsActivity"; + private static final String WAILS_SCHEME = "https"; + private static final String WAILS_HOST = "wails.localhost"; + + private WebView webView; + private WailsBridge bridge; + private WebViewAssetLoader assetLoader; + + @Override + protected void onCreate(Bundle savedInstanceState) { + super.onCreate(savedInstanceState); + setContentView(R.layout.activity_main); + + // Initialize the native Go library + bridge = new WailsBridge(this); + bridge.initialize(); + + // Set up WebView + setupWebView(); + + // Load the application + loadApplication(); + } + + @SuppressLint("SetJavaScriptEnabled") + private void setupWebView() { + webView = findViewById(R.id.webview); + + // Configure WebView settings + WebSettings settings = webView.getSettings(); + settings.setJavaScriptEnabled(true); + settings.setDomStorageEnabled(true); + settings.setDatabaseEnabled(true); + settings.setAllowFileAccess(false); + settings.setAllowContentAccess(false); + settings.setMediaPlaybackRequiresUserGesture(false); + settings.setMixedContentMode(WebSettings.MIXED_CONTENT_NEVER_ALLOW); + + // Enable debugging in debug builds + if (BuildConfig.DEBUG) { + WebView.setWebContentsDebuggingEnabled(true); + } + + // Set up asset loader for serving local assets + assetLoader = new WebViewAssetLoader.Builder() + .setDomain(WAILS_HOST) + .addPathHandler("/", new WailsPathHandler(bridge)) + .build(); + + // Set up WebView client to intercept requests + webView.setWebViewClient(new WebViewClient() { + @Nullable + @Override + public WebResourceResponse shouldInterceptRequest(WebView view, WebResourceRequest request) { + String url = request.getUrl().toString(); + Log.d(TAG, "Intercepting request: " + url); + + // Handle wails.localhost requests + if (request.getUrl().getHost() != null && + request.getUrl().getHost().equals(WAILS_HOST)) { + + // For wails API calls (runtime, capabilities, etc.), we need to pass the full URL + // including query string because WebViewAssetLoader.PathHandler strips query params + String path = request.getUrl().getPath(); + if (path != null && path.startsWith("/wails/")) { + // Get full path with query string for runtime calls + String fullPath = path; + String query = request.getUrl().getQuery(); + if (query != null && !query.isEmpty()) { + fullPath = path + "?" + query; + } + Log.d(TAG, "Wails API call detected, full path: " + fullPath); + + // Call bridge directly with full path + byte[] data = bridge.serveAsset(fullPath, request.getMethod(), "{}"); + if (data != null && data.length > 0) { + java.io.InputStream inputStream = new java.io.ByteArrayInputStream(data); + java.util.Map headers = new java.util.HashMap<>(); + headers.put("Access-Control-Allow-Origin", "*"); + headers.put("Cache-Control", "no-cache"); + headers.put("Content-Type", "application/json"); + + return new WebResourceResponse( + "application/json", + "UTF-8", + 200, + "OK", + headers, + inputStream + ); + } + // Return error response if data is null + return new WebResourceResponse( + "application/json", + "UTF-8", + 500, + "Internal Error", + new java.util.HashMap<>(), + new java.io.ByteArrayInputStream("{}".getBytes()) + ); + } + + // For regular assets, use the asset loader + return assetLoader.shouldInterceptRequest(request.getUrl()); + } + + return super.shouldInterceptRequest(view, request); + } + + @Override + public void onPageFinished(WebView view, String url) { + super.onPageFinished(view, url); + Log.d(TAG, "Page loaded: " + url); + // Inject Wails runtime + bridge.injectRuntime(webView, url); + } + }); + + // Add JavaScript interface for Go communication + webView.addJavascriptInterface(new WailsJSBridge(bridge, webView), "wails"); + } + + private void loadApplication() { + // Load the main page from the asset server + String url = WAILS_SCHEME + "://" + WAILS_HOST + "/"; + Log.d(TAG, "Loading URL: " + url); + webView.loadUrl(url); + } + + /** + * Execute JavaScript in the WebView from the Go side + */ + public void executeJavaScript(final String js) { + runOnUiThread(() -> { + if (webView != null) { + webView.evaluateJavascript(js, null); + } + }); + } + + @Override + protected void onResume() { + super.onResume(); + if (bridge != null) { + bridge.onResume(); + } + } + + @Override + protected void onPause() { + super.onPause(); + if (bridge != null) { + bridge.onPause(); + } + } + + @Override + protected void onDestroy() { + super.onDestroy(); + if (bridge != null) { + bridge.shutdown(); + } + if (webView != null) { + webView.destroy(); + } + } + + @Override + public void onBackPressed() { + if (webView != null && webView.canGoBack()) { + webView.goBack(); + } else { + super.onBackPressed(); + } + } +} diff --git a/v3/examples/android/build/android/app/src/main/java/com/wails/app/WailsBridge.java b/v3/examples/android/build/android/app/src/main/java/com/wails/app/WailsBridge.java new file mode 100644 index 000000000..3dab65247 --- /dev/null +++ b/v3/examples/android/build/android/app/src/main/java/com/wails/app/WailsBridge.java @@ -0,0 +1,214 @@ +package com.wails.app; + +import android.content.Context; +import android.util.Log; +import android.webkit.WebView; + +import java.util.concurrent.ConcurrentHashMap; +import java.util.concurrent.atomic.AtomicInteger; + +/** + * WailsBridge manages the connection between the Java/Android side and the Go native library. + * It handles: + * - Loading and initializing the native Go library + * - Serving asset requests from Go + * - Passing messages between JavaScript and Go + * - Managing callbacks for async operations + */ +public class WailsBridge { + private static final String TAG = "WailsBridge"; + + static { + // Load the native Go library + System.loadLibrary("wails"); + } + + private final Context context; + private final AtomicInteger callbackIdGenerator = new AtomicInteger(0); + private final ConcurrentHashMap pendingAssetCallbacks = new ConcurrentHashMap<>(); + private final ConcurrentHashMap pendingMessageCallbacks = new ConcurrentHashMap<>(); + private WebView webView; + private volatile boolean initialized = false; + + // Native methods - implemented in Go + private static native void nativeInit(WailsBridge bridge); + private static native void nativeShutdown(); + private static native void nativeOnResume(); + private static native void nativeOnPause(); + private static native void nativeOnPageFinished(String url); + private static native byte[] nativeServeAsset(String path, String method, String headers); + private static native String nativeHandleMessage(String message); + private static native String nativeGetAssetMimeType(String path); + + public WailsBridge(Context context) { + this.context = context; + } + + /** + * Initialize the native Go library + */ + public void initialize() { + if (initialized) { + return; + } + + Log.i(TAG, "Initializing Wails bridge..."); + try { + nativeInit(this); + initialized = true; + Log.i(TAG, "Wails bridge initialized successfully"); + } catch (Exception e) { + Log.e(TAG, "Failed to initialize Wails bridge", e); + } + } + + /** + * Shutdown the native Go library + */ + public void shutdown() { + if (!initialized) { + return; + } + + Log.i(TAG, "Shutting down Wails bridge..."); + try { + nativeShutdown(); + initialized = false; + } catch (Exception e) { + Log.e(TAG, "Error during shutdown", e); + } + } + + /** + * Called when the activity resumes + */ + public void onResume() { + if (initialized) { + nativeOnResume(); + } + } + + /** + * Called when the activity pauses + */ + public void onPause() { + if (initialized) { + nativeOnPause(); + } + } + + /** + * Serve an asset from the Go asset server + * @param path The URL path requested + * @param method The HTTP method + * @param headers The request headers as JSON + * @return The asset data, or null if not found + */ + public byte[] serveAsset(String path, String method, String headers) { + if (!initialized) { + Log.w(TAG, "Bridge not initialized, cannot serve asset: " + path); + return null; + } + + Log.d(TAG, "Serving asset: " + path); + try { + return nativeServeAsset(path, method, headers); + } catch (Exception e) { + Log.e(TAG, "Error serving asset: " + path, e); + return null; + } + } + + /** + * Get the MIME type for an asset + * @param path The asset path + * @return The MIME type string + */ + public String getAssetMimeType(String path) { + if (!initialized) { + return "application/octet-stream"; + } + + try { + String mimeType = nativeGetAssetMimeType(path); + return mimeType != null ? mimeType : "application/octet-stream"; + } catch (Exception e) { + Log.e(TAG, "Error getting MIME type for: " + path, e); + return "application/octet-stream"; + } + } + + /** + * Handle a message from JavaScript + * @param message The message from JavaScript (JSON) + * @return The response to send back to JavaScript (JSON) + */ + public String handleMessage(String message) { + if (!initialized) { + Log.w(TAG, "Bridge not initialized, cannot handle message"); + return "{\"error\":\"Bridge not initialized\"}"; + } + + Log.d(TAG, "Handling message from JS: " + message); + try { + return nativeHandleMessage(message); + } catch (Exception e) { + Log.e(TAG, "Error handling message", e); + return "{\"error\":\"" + e.getMessage() + "\"}"; + } + } + + /** + * Inject the Wails runtime JavaScript into the WebView. + * Called when the page finishes loading. + * @param webView The WebView to inject into + * @param url The URL that finished loading + */ + public void injectRuntime(WebView webView, String url) { + this.webView = webView; + // Notify Go side that page has finished loading so it can inject the runtime + Log.d(TAG, "Page finished loading: " + url + ", notifying Go side"); + if (initialized) { + nativeOnPageFinished(url); + } + } + + /** + * Execute JavaScript in the WebView (called from Go side) + * @param js The JavaScript code to execute + */ + public void executeJavaScript(String js) { + if (webView != null) { + webView.post(() -> webView.evaluateJavascript(js, null)); + } + } + + /** + * Called from Go when an event needs to be emitted to JavaScript + * @param eventName The event name + * @param eventData The event data (JSON) + */ + public void emitEvent(String eventName, String eventData) { + String js = String.format("window.wails && window.wails._emit('%s', %s);", + escapeJsString(eventName), eventData); + executeJavaScript(js); + } + + private String escapeJsString(String str) { + return str.replace("\\", "\\\\") + .replace("'", "\\'") + .replace("\n", "\\n") + .replace("\r", "\\r"); + } + + // Callback interfaces + public interface AssetCallback { + void onAssetReady(byte[] data, String mimeType); + void onAssetError(String error); + } + + public interface MessageCallback { + void onResponse(String response); + void onError(String error); + } +} diff --git a/v3/examples/android/build/android/app/src/main/java/com/wails/app/WailsJSBridge.java b/v3/examples/android/build/android/app/src/main/java/com/wails/app/WailsJSBridge.java new file mode 100644 index 000000000..98ae5b247 --- /dev/null +++ b/v3/examples/android/build/android/app/src/main/java/com/wails/app/WailsJSBridge.java @@ -0,0 +1,142 @@ +package com.wails.app; + +import android.util.Log; +import android.webkit.JavascriptInterface; +import android.webkit.WebView; +import com.wails.app.BuildConfig; + +/** + * WailsJSBridge provides the JavaScript interface that allows the web frontend + * to communicate with the Go backend. This is exposed to JavaScript as the + * `window.wails` object. + * + * Similar to iOS's WKScriptMessageHandler but using Android's addJavascriptInterface. + */ +public class WailsJSBridge { + private static final String TAG = "WailsJSBridge"; + + private final WailsBridge bridge; + private final WebView webView; + + public WailsJSBridge(WailsBridge bridge, WebView webView) { + this.bridge = bridge; + this.webView = webView; + } + + /** + * Send a message to Go and return the response synchronously. + * Called from JavaScript: wails.invoke(message) + * + * @param message The message to send (JSON string) + * @return The response from Go (JSON string) + */ + @JavascriptInterface + public String invoke(String message) { + Log.d(TAG, "Invoke called: " + message); + return bridge.handleMessage(message); + } + + /** + * Send a message to Go asynchronously. + * The response will be sent back via a callback. + * Called from JavaScript: wails.invokeAsync(callbackId, message) + * + * @param callbackId The callback ID to use for the response + * @param message The message to send (JSON string) + */ + @JavascriptInterface + public void invokeAsync(final String callbackId, final String message) { + Log.d(TAG, "InvokeAsync called: " + message); + + // Handle in background thread to not block JavaScript + new Thread(() -> { + try { + String response = bridge.handleMessage(message); + sendCallback(callbackId, response, null); + } catch (Exception e) { + Log.e(TAG, "Error in async invoke", e); + sendCallback(callbackId, null, e.getMessage()); + } + }).start(); + } + + /** + * Log a message from JavaScript to Android's logcat + * Called from JavaScript: wails.log(level, message) + * + * @param level The log level (debug, info, warn, error) + * @param message The message to log + */ + @JavascriptInterface + public void log(String level, String message) { + switch (level.toLowerCase()) { + case "debug": + Log.d(TAG + "/JS", message); + break; + case "info": + Log.i(TAG + "/JS", message); + break; + case "warn": + Log.w(TAG + "/JS", message); + break; + case "error": + Log.e(TAG + "/JS", message); + break; + default: + Log.v(TAG + "/JS", message); + break; + } + } + + /** + * Get the platform name + * Called from JavaScript: wails.platform() + * + * @return "android" + */ + @JavascriptInterface + public String platform() { + return "android"; + } + + /** + * Check if we're running in debug mode + * Called from JavaScript: wails.isDebug() + * + * @return true if debug build, false otherwise + */ + @JavascriptInterface + public boolean isDebug() { + return BuildConfig.DEBUG; + } + + /** + * Send a callback response to JavaScript + */ + private void sendCallback(String callbackId, String result, String error) { + final String js; + if (error != null) { + js = String.format( + "window.wails && window.wails._callback('%s', null, '%s');", + escapeJsString(callbackId), + escapeJsString(error) + ); + } else { + js = String.format( + "window.wails && window.wails._callback('%s', %s, null);", + escapeJsString(callbackId), + result != null ? result : "null" + ); + } + + webView.post(() -> webView.evaluateJavascript(js, null)); + } + + private String escapeJsString(String str) { + if (str == null) return ""; + return str.replace("\\", "\\\\") + .replace("'", "\\'") + .replace("\n", "\\n") + .replace("\r", "\\r"); + } +} diff --git a/v3/examples/android/build/android/app/src/main/java/com/wails/app/WailsPathHandler.java b/v3/examples/android/build/android/app/src/main/java/com/wails/app/WailsPathHandler.java new file mode 100644 index 000000000..326fa9b4d --- /dev/null +++ b/v3/examples/android/build/android/app/src/main/java/com/wails/app/WailsPathHandler.java @@ -0,0 +1,118 @@ +package com.wails.app; + +import android.net.Uri; +import android.util.Log; +import android.webkit.WebResourceResponse; + +import androidx.annotation.NonNull; +import androidx.annotation.Nullable; +import androidx.webkit.WebViewAssetLoader; + +import java.io.ByteArrayInputStream; +import java.io.InputStream; +import java.util.HashMap; +import java.util.Map; + +/** + * WailsPathHandler implements WebViewAssetLoader.PathHandler to serve assets + * from the Go asset server. This allows the WebView to load assets without + * using a network server, similar to iOS's WKURLSchemeHandler. + */ +public class WailsPathHandler implements WebViewAssetLoader.PathHandler { + private static final String TAG = "WailsPathHandler"; + + private final WailsBridge bridge; + + public WailsPathHandler(WailsBridge bridge) { + this.bridge = bridge; + } + + @Nullable + @Override + public WebResourceResponse handle(@NonNull String path) { + Log.d(TAG, "Handling path: " + path); + + // Normalize path + if (path.isEmpty() || path.equals("/")) { + path = "/index.html"; + } + + // Get asset from Go + byte[] data = bridge.serveAsset(path, "GET", "{}"); + + if (data == null || data.length == 0) { + Log.w(TAG, "Asset not found: " + path); + return null; // Return null to let WebView handle 404 + } + + // Determine MIME type + String mimeType = bridge.getAssetMimeType(path); + Log.d(TAG, "Serving " + path + " with type " + mimeType + " (" + data.length + " bytes)"); + + // Create response + InputStream inputStream = new ByteArrayInputStream(data); + Map headers = new HashMap<>(); + headers.put("Access-Control-Allow-Origin", "*"); + headers.put("Cache-Control", "no-cache"); + + return new WebResourceResponse( + mimeType, + "UTF-8", + 200, + "OK", + headers, + inputStream + ); + } + + /** + * Determine MIME type from file extension + */ + private String getMimeType(String path) { + String lowerPath = path.toLowerCase(); + + if (lowerPath.endsWith(".html") || lowerPath.endsWith(".htm")) { + return "text/html"; + } else if (lowerPath.endsWith(".js") || lowerPath.endsWith(".mjs")) { + return "application/javascript"; + } else if (lowerPath.endsWith(".css")) { + return "text/css"; + } else if (lowerPath.endsWith(".json")) { + return "application/json"; + } else if (lowerPath.endsWith(".png")) { + return "image/png"; + } else if (lowerPath.endsWith(".jpg") || lowerPath.endsWith(".jpeg")) { + return "image/jpeg"; + } else if (lowerPath.endsWith(".gif")) { + return "image/gif"; + } else if (lowerPath.endsWith(".svg")) { + return "image/svg+xml"; + } else if (lowerPath.endsWith(".ico")) { + return "image/x-icon"; + } else if (lowerPath.endsWith(".woff")) { + return "font/woff"; + } else if (lowerPath.endsWith(".woff2")) { + return "font/woff2"; + } else if (lowerPath.endsWith(".ttf")) { + return "font/ttf"; + } else if (lowerPath.endsWith(".eot")) { + return "application/vnd.ms-fontobject"; + } else if (lowerPath.endsWith(".xml")) { + return "application/xml"; + } else if (lowerPath.endsWith(".txt")) { + return "text/plain"; + } else if (lowerPath.endsWith(".wasm")) { + return "application/wasm"; + } else if (lowerPath.endsWith(".mp3")) { + return "audio/mpeg"; + } else if (lowerPath.endsWith(".mp4")) { + return "video/mp4"; + } else if (lowerPath.endsWith(".webm")) { + return "video/webm"; + } else if (lowerPath.endsWith(".webp")) { + return "image/webp"; + } + + return "application/octet-stream"; + } +} diff --git a/v3/examples/android/build/android/app/src/main/res/layout/activity_main.xml b/v3/examples/android/build/android/app/src/main/res/layout/activity_main.xml new file mode 100644 index 000000000..f278384c7 --- /dev/null +++ b/v3/examples/android/build/android/app/src/main/res/layout/activity_main.xml @@ -0,0 +1,12 @@ + + + + + + diff --git a/v3/examples/android/build/android/app/src/main/res/mipmap-hdpi/ic_launcher.png b/v3/examples/android/build/android/app/src/main/res/mipmap-hdpi/ic_launcher.png new file mode 100644 index 000000000..9409abebe Binary files /dev/null and b/v3/examples/android/build/android/app/src/main/res/mipmap-hdpi/ic_launcher.png differ diff --git a/v3/examples/android/build/android/app/src/main/res/mipmap-hdpi/ic_launcher_round.png b/v3/examples/android/build/android/app/src/main/res/mipmap-hdpi/ic_launcher_round.png new file mode 100644 index 000000000..9409abebe Binary files /dev/null and b/v3/examples/android/build/android/app/src/main/res/mipmap-hdpi/ic_launcher_round.png differ diff --git a/v3/examples/android/build/android/app/src/main/res/mipmap-mdpi/ic_launcher.png b/v3/examples/android/build/android/app/src/main/res/mipmap-mdpi/ic_launcher.png new file mode 100644 index 000000000..5b6acc048 Binary files /dev/null and b/v3/examples/android/build/android/app/src/main/res/mipmap-mdpi/ic_launcher.png differ diff --git a/v3/examples/android/build/android/app/src/main/res/mipmap-mdpi/ic_launcher_round.png b/v3/examples/android/build/android/app/src/main/res/mipmap-mdpi/ic_launcher_round.png new file mode 100644 index 000000000..5b6acc048 Binary files /dev/null and b/v3/examples/android/build/android/app/src/main/res/mipmap-mdpi/ic_launcher_round.png differ diff --git a/v3/examples/android/build/android/app/src/main/res/mipmap-xhdpi/ic_launcher.png b/v3/examples/android/build/android/app/src/main/res/mipmap-xhdpi/ic_launcher.png new file mode 100644 index 000000000..1c2c66452 Binary files /dev/null and b/v3/examples/android/build/android/app/src/main/res/mipmap-xhdpi/ic_launcher.png differ diff --git a/v3/examples/android/build/android/app/src/main/res/mipmap-xhdpi/ic_launcher_round.png b/v3/examples/android/build/android/app/src/main/res/mipmap-xhdpi/ic_launcher_round.png new file mode 100644 index 000000000..1c2c66452 Binary files /dev/null and b/v3/examples/android/build/android/app/src/main/res/mipmap-xhdpi/ic_launcher_round.png differ diff --git a/v3/examples/android/build/android/app/src/main/res/mipmap-xxhdpi/ic_launcher.png b/v3/examples/android/build/android/app/src/main/res/mipmap-xxhdpi/ic_launcher.png new file mode 100644 index 000000000..be557d897 Binary files /dev/null and b/v3/examples/android/build/android/app/src/main/res/mipmap-xxhdpi/ic_launcher.png differ diff --git a/v3/examples/android/build/android/app/src/main/res/mipmap-xxhdpi/ic_launcher_round.png b/v3/examples/android/build/android/app/src/main/res/mipmap-xxhdpi/ic_launcher_round.png new file mode 100644 index 000000000..be557d897 Binary files /dev/null and b/v3/examples/android/build/android/app/src/main/res/mipmap-xxhdpi/ic_launcher_round.png differ diff --git a/v3/examples/android/build/android/app/src/main/res/mipmap-xxxhdpi/ic_launcher.png b/v3/examples/android/build/android/app/src/main/res/mipmap-xxxhdpi/ic_launcher.png new file mode 100644 index 000000000..4507f32a5 Binary files /dev/null and b/v3/examples/android/build/android/app/src/main/res/mipmap-xxxhdpi/ic_launcher.png differ diff --git a/v3/examples/android/build/android/app/src/main/res/mipmap-xxxhdpi/ic_launcher_round.png b/v3/examples/android/build/android/app/src/main/res/mipmap-xxxhdpi/ic_launcher_round.png new file mode 100644 index 000000000..4507f32a5 Binary files /dev/null and b/v3/examples/android/build/android/app/src/main/res/mipmap-xxxhdpi/ic_launcher_round.png differ diff --git a/v3/examples/android/build/android/app/src/main/res/values/colors.xml b/v3/examples/android/build/android/app/src/main/res/values/colors.xml new file mode 100644 index 000000000..dd33f3b7d --- /dev/null +++ b/v3/examples/android/build/android/app/src/main/res/values/colors.xml @@ -0,0 +1,8 @@ + + + #3574D4 + #2C5FB8 + #1B2636 + #FFFFFFFF + #FF000000 + diff --git a/v3/examples/android/build/android/app/src/main/res/values/strings.xml b/v3/examples/android/build/android/app/src/main/res/values/strings.xml new file mode 100644 index 000000000..3ed9e4717 --- /dev/null +++ b/v3/examples/android/build/android/app/src/main/res/values/strings.xml @@ -0,0 +1,4 @@ + + + Wails App + diff --git a/v3/examples/android/build/android/app/src/main/res/values/themes.xml b/v3/examples/android/build/android/app/src/main/res/values/themes.xml new file mode 100644 index 000000000..be8a282b2 --- /dev/null +++ b/v3/examples/android/build/android/app/src/main/res/values/themes.xml @@ -0,0 +1,14 @@ + + + + diff --git a/v3/examples/android/build/android/build.gradle b/v3/examples/android/build/android/build.gradle new file mode 100644 index 000000000..d7fbab39a --- /dev/null +++ b/v3/examples/android/build/android/build.gradle @@ -0,0 +1,4 @@ +// Top-level build file where you can add configuration options common to all sub-projects/modules. +plugins { + id 'com.android.application' version '8.7.3' apply false +} diff --git a/v3/examples/android/build/android/build/reports/problems/problems-report.html b/v3/examples/android/build/android/build/reports/problems/problems-report.html new file mode 100644 index 000000000..2f0196fac --- /dev/null +++ b/v3/examples/android/build/android/build/reports/problems/problems-report.html @@ -0,0 +1,659 @@ + + + + + + + + + + + + + Gradle Configuration Cache + + + +
      + +
      + Loading... +
      + + + + + + diff --git a/v3/examples/android/build/android/gradle.properties b/v3/examples/android/build/android/gradle.properties new file mode 100644 index 000000000..b9d4426d5 --- /dev/null +++ b/v3/examples/android/build/android/gradle.properties @@ -0,0 +1,26 @@ +# Project-wide Gradle settings. +# IDE (e.g. Android Studio) users: +# Gradle settings configured through the IDE *will override* +# any settings specified in this file. + +# For more details on how to configure your build environment visit +# http://www.gradle.org/docs/current/userguide/build_environment.html + +# Specifies the JVM arguments used for the daemon process. +# The setting is particularly useful for tweaking memory settings. +org.gradle.jvmargs=-Xmx2048m -Dfile.encoding=UTF-8 + +# When configured, Gradle will run in incubating parallel mode. +# This option should only be used with decoupled projects. For more details, visit +# https://developer.android.com/build/optimize-your-build#parallel +# org.gradle.parallel=true + +# AndroidX package structure to make it clearer which packages are bundled with the +# Android operating system, and which are packaged with your app's APK +# https://developer.android.com/topic/libraries/support-library/androidx-rn +android.useAndroidX=true + +# Enables namespacing of each library's R class so that its R class includes only the +# resources declared in the library itself and none from the library's dependencies, +# thereby reducing the size of the R class for that library +android.nonTransitiveRClass=true diff --git a/v3/examples/android/build/android/gradle/wrapper/gradle-wrapper.jar b/v3/examples/android/build/android/gradle/wrapper/gradle-wrapper.jar new file mode 100644 index 000000000..f8e1ee312 Binary files /dev/null and b/v3/examples/android/build/android/gradle/wrapper/gradle-wrapper.jar differ diff --git a/v3/examples/android/build/android/gradle/wrapper/gradle-wrapper.properties b/v3/examples/android/build/android/gradle/wrapper/gradle-wrapper.properties new file mode 100644 index 000000000..23449a2b5 --- /dev/null +++ b/v3/examples/android/build/android/gradle/wrapper/gradle-wrapper.properties @@ -0,0 +1,7 @@ +distributionBase=GRADLE_USER_HOME +distributionPath=wrapper/dists +distributionUrl=https\://services.gradle.org/distributions/gradle-9.2.1-bin.zip +networkTimeout=10000 +validateDistributionUrl=true +zipStoreBase=GRADLE_USER_HOME +zipStorePath=wrapper/dists diff --git a/v3/examples/android/build/android/gradlew b/v3/examples/android/build/android/gradlew new file mode 100755 index 000000000..adff685a0 --- /dev/null +++ b/v3/examples/android/build/android/gradlew @@ -0,0 +1,248 @@ +#!/bin/sh + +# +# Copyright © 2015 the original authors. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# SPDX-License-Identifier: Apache-2.0 +# + +############################################################################## +# +# Gradle start up script for POSIX generated by Gradle. +# +# Important for running: +# +# (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is +# noncompliant, but you have some other compliant shell such as ksh or +# bash, then to run this script, type that shell name before the whole +# command line, like: +# +# ksh Gradle +# +# Busybox and similar reduced shells will NOT work, because this script +# requires all of these POSIX shell features: +# * functions; +# * expansions «$var», «${var}», «${var:-default}», «${var+SET}», +# «${var#prefix}», «${var%suffix}», and «$( cmd )»; +# * compound commands having a testable exit status, especially «case»; +# * various built-in commands including «command», «set», and «ulimit». +# +# Important for patching: +# +# (2) This script targets any POSIX shell, so it avoids extensions provided +# by Bash, Ksh, etc; in particular arrays are avoided. +# +# The "traditional" practice of packing multiple parameters into a +# space-separated string is a well documented source of bugs and security +# problems, so this is (mostly) avoided, by progressively accumulating +# options in "$@", and eventually passing that to Java. +# +# Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS, +# and GRADLE_OPTS) rely on word-splitting, this is performed explicitly; +# see the in-line comments for details. +# +# There are tweaks for specific operating systems such as AIX, CygWin, +# Darwin, MinGW, and NonStop. +# +# (3) This script is generated from the Groovy template +# https://github.com/gradle/gradle/blob/HEAD/platforms/jvm/plugins-application/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt +# within the Gradle project. +# +# You can find Gradle at https://github.com/gradle/gradle/. +# +############################################################################## + +# Attempt to set APP_HOME + +# Resolve links: $0 may be a link +app_path=$0 + +# Need this for daisy-chained symlinks. +while + APP_HOME=${app_path%"${app_path##*/}"} # leaves a trailing /; empty if no leading path + [ -h "$app_path" ] +do + ls=$( ls -ld "$app_path" ) + link=${ls#*' -> '} + case $link in #( + /*) app_path=$link ;; #( + *) app_path=$APP_HOME$link ;; + esac +done + +# This is normally unused +# shellcheck disable=SC2034 +APP_BASE_NAME=${0##*/} +# Discard cd standard output in case $CDPATH is set (https://github.com/gradle/gradle/issues/25036) +APP_HOME=$( cd -P "${APP_HOME:-./}" > /dev/null && printf '%s\n' "$PWD" ) || exit + +# Use the maximum available, or set MAX_FD != -1 to use that value. +MAX_FD=maximum + +warn () { + echo "$*" +} >&2 + +die () { + echo + echo "$*" + echo + exit 1 +} >&2 + +# OS specific support (must be 'true' or 'false'). +cygwin=false +msys=false +darwin=false +nonstop=false +case "$( uname )" in #( + CYGWIN* ) cygwin=true ;; #( + Darwin* ) darwin=true ;; #( + MSYS* | MINGW* ) msys=true ;; #( + NONSTOP* ) nonstop=true ;; +esac + + + +# Determine the Java command to use to start the JVM. +if [ -n "$JAVA_HOME" ] ; then + if [ -x "$JAVA_HOME/jre/sh/java" ] ; then + # IBM's JDK on AIX uses strange locations for the executables + JAVACMD=$JAVA_HOME/jre/sh/java + else + JAVACMD=$JAVA_HOME/bin/java + fi + if [ ! -x "$JAVACMD" ] ; then + die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." + fi +else + JAVACMD=java + if ! command -v java >/dev/null 2>&1 + then + die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." + fi +fi + +# Increase the maximum file descriptors if we can. +if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then + case $MAX_FD in #( + max*) + # In POSIX sh, ulimit -H is undefined. That's why the result is checked to see if it worked. + # shellcheck disable=SC2039,SC3045 + MAX_FD=$( ulimit -H -n ) || + warn "Could not query maximum file descriptor limit" + esac + case $MAX_FD in #( + '' | soft) :;; #( + *) + # In POSIX sh, ulimit -n is undefined. That's why the result is checked to see if it worked. + # shellcheck disable=SC2039,SC3045 + ulimit -n "$MAX_FD" || + warn "Could not set maximum file descriptor limit to $MAX_FD" + esac +fi + +# Collect all arguments for the java command, stacking in reverse order: +# * args from the command line +# * the main class name +# * -classpath +# * -D...appname settings +# * --module-path (only if needed) +# * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables. + +# For Cygwin or MSYS, switch paths to Windows format before running java +if "$cygwin" || "$msys" ; then + APP_HOME=$( cygpath --path --mixed "$APP_HOME" ) + + JAVACMD=$( cygpath --unix "$JAVACMD" ) + + # Now convert the arguments - kludge to limit ourselves to /bin/sh + for arg do + if + case $arg in #( + -*) false ;; # don't mess with options #( + /?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath + [ -e "$t" ] ;; #( + *) false ;; + esac + then + arg=$( cygpath --path --ignore --mixed "$arg" ) + fi + # Roll the args list around exactly as many times as the number of + # args, so each arg winds up back in the position where it started, but + # possibly modified. + # + # NB: a `for` loop captures its iteration list before it begins, so + # changing the positional parameters here affects neither the number of + # iterations, nor the values presented in `arg`. + shift # remove old arg + set -- "$@" "$arg" # push replacement arg + done +fi + + +# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"' + +# Collect all arguments for the java command: +# * DEFAULT_JVM_OPTS, JAVA_OPTS, and optsEnvironmentVar are not allowed to contain shell fragments, +# and any embedded shellness will be escaped. +# * For example: A user cannot expect ${Hostname} to be expanded, as it is an environment variable and will be +# treated as '${Hostname}' itself on the command line. + +set -- \ + "-Dorg.gradle.appname=$APP_BASE_NAME" \ + -jar "$APP_HOME/gradle/wrapper/gradle-wrapper.jar" \ + "$@" + +# Stop when "xargs" is not available. +if ! command -v xargs >/dev/null 2>&1 +then + die "xargs is not available" +fi + +# Use "xargs" to parse quoted args. +# +# With -n1 it outputs one arg per line, with the quotes and backslashes removed. +# +# In Bash we could simply go: +# +# readarray ARGS < <( xargs -n1 <<<"$var" ) && +# set -- "${ARGS[@]}" "$@" +# +# but POSIX shell has neither arrays nor command substitution, so instead we +# post-process each arg (as a line of input to sed) to backslash-escape any +# character that might be a shell metacharacter, then use eval to reverse +# that process (while maintaining the separation between arguments), and wrap +# the whole thing up as a single "set" statement. +# +# This will of course break if any of these variables contains a newline or +# an unmatched quote. +# + +eval "set -- $( + printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" | + xargs -n1 | + sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' | + tr '\n' ' ' + )" '"$@"' + +exec "$JAVACMD" "$@" diff --git a/v3/examples/android/build/android/gradlew.bat b/v3/examples/android/build/android/gradlew.bat new file mode 100644 index 000000000..e509b2dd8 --- /dev/null +++ b/v3/examples/android/build/android/gradlew.bat @@ -0,0 +1,93 @@ +@rem +@rem Copyright 2015 the original author or authors. +@rem +@rem Licensed under the Apache License, Version 2.0 (the "License"); +@rem you may not use this file except in compliance with the License. +@rem You may obtain a copy of the License at +@rem +@rem https://www.apache.org/licenses/LICENSE-2.0 +@rem +@rem Unless required by applicable law or agreed to in writing, software +@rem distributed under the License is distributed on an "AS IS" BASIS, +@rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +@rem See the License for the specific language governing permissions and +@rem limitations under the License. +@rem +@rem SPDX-License-Identifier: Apache-2.0 +@rem + +@if "%DEBUG%"=="" @echo off +@rem ########################################################################## +@rem +@rem Gradle startup script for Windows +@rem +@rem ########################################################################## + +@rem Set local scope for the variables with windows NT shell +if "%OS%"=="Windows_NT" setlocal + +set DIRNAME=%~dp0 +if "%DIRNAME%"=="" set DIRNAME=. +@rem This is normally unused +set APP_BASE_NAME=%~n0 +set APP_HOME=%DIRNAME% + +@rem Resolve any "." and ".." in APP_HOME to make it shorter. +for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi + +@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m" + +@rem Find java.exe +if defined JAVA_HOME goto findJavaFromJavaHome + +set JAVA_EXE=java.exe +%JAVA_EXE% -version >NUL 2>&1 +if %ERRORLEVEL% equ 0 goto execute + +echo. 1>&2 +echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 1>&2 +echo. 1>&2 +echo Please set the JAVA_HOME variable in your environment to match the 1>&2 +echo location of your Java installation. 1>&2 + +goto fail + +:findJavaFromJavaHome +set JAVA_HOME=%JAVA_HOME:"=% +set JAVA_EXE=%JAVA_HOME%/bin/java.exe + +if exist "%JAVA_EXE%" goto execute + +echo. 1>&2 +echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% 1>&2 +echo. 1>&2 +echo Please set the JAVA_HOME variable in your environment to match the 1>&2 +echo location of your Java installation. 1>&2 + +goto fail + +:execute +@rem Setup the command line + + + +@rem Execute Gradle +"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -jar "%APP_HOME%\gradle\wrapper\gradle-wrapper.jar" %* + +:end +@rem End local scope for the variables with windows NT shell +if %ERRORLEVEL% equ 0 goto mainEnd + +:fail +rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of +rem the _cmd.exe /c_ return code! +set EXIT_CODE=%ERRORLEVEL% +if %EXIT_CODE% equ 0 set EXIT_CODE=1 +if not ""=="%GRADLE_EXIT_CONSOLE%" exit %EXIT_CODE% +exit /b %EXIT_CODE% + +:mainEnd +if "%OS%"=="Windows_NT" endlocal + +:omega diff --git a/v3/examples/android/build/android/scripts/deps/install_deps.go b/v3/examples/android/build/android/scripts/deps/install_deps.go new file mode 100644 index 000000000..d9dfedf80 --- /dev/null +++ b/v3/examples/android/build/android/scripts/deps/install_deps.go @@ -0,0 +1,151 @@ +package main + +import ( + "fmt" + "os" + "os/exec" + "path/filepath" + "runtime" + "strings" +) + +func main() { + fmt.Println("Checking Android development dependencies...") + fmt.Println() + + errors := []string{} + + // Check Go + if !checkCommand("go", "version") { + errors = append(errors, "Go is not installed. Install from https://go.dev/dl/") + } else { + fmt.Println("✓ Go is installed") + } + + // Check ANDROID_HOME + androidHome := os.Getenv("ANDROID_HOME") + if androidHome == "" { + androidHome = os.Getenv("ANDROID_SDK_ROOT") + } + if androidHome == "" { + // Try common default locations + home, _ := os.UserHomeDir() + possiblePaths := []string{ + filepath.Join(home, "Android", "Sdk"), + filepath.Join(home, "Library", "Android", "sdk"), + "/usr/local/share/android-sdk", + } + for _, p := range possiblePaths { + if _, err := os.Stat(p); err == nil { + androidHome = p + break + } + } + } + + if androidHome == "" { + errors = append(errors, "ANDROID_HOME not set. Install Android Studio and set ANDROID_HOME environment variable") + } else { + fmt.Printf("✓ ANDROID_HOME: %s\n", androidHome) + } + + // Check adb + if !checkCommand("adb", "version") { + if androidHome != "" { + platformTools := filepath.Join(androidHome, "platform-tools") + errors = append(errors, fmt.Sprintf("adb not found. Add %s to PATH", platformTools)) + } else { + errors = append(errors, "adb not found. Install Android SDK Platform-Tools") + } + } else { + fmt.Println("✓ adb is installed") + } + + // Check emulator + if !checkCommand("emulator", "-list-avds") { + if androidHome != "" { + emulatorPath := filepath.Join(androidHome, "emulator") + errors = append(errors, fmt.Sprintf("emulator not found. Add %s to PATH", emulatorPath)) + } else { + errors = append(errors, "emulator not found. Install Android Emulator via SDK Manager") + } + } else { + fmt.Println("✓ Android Emulator is installed") + } + + // Check NDK + ndkHome := os.Getenv("ANDROID_NDK_HOME") + if ndkHome == "" && androidHome != "" { + // Look for NDK in default location + ndkDir := filepath.Join(androidHome, "ndk") + if entries, err := os.ReadDir(ndkDir); err == nil { + for _, entry := range entries { + if entry.IsDir() { + ndkHome = filepath.Join(ndkDir, entry.Name()) + break + } + } + } + } + + if ndkHome == "" { + errors = append(errors, "Android NDK not found. Install NDK via Android Studio > SDK Manager > SDK Tools > NDK (Side by side)") + } else { + fmt.Printf("✓ Android NDK: %s\n", ndkHome) + } + + // Check Java + if !checkCommand("java", "-version") { + errors = append(errors, "Java not found. Install JDK 11+ (OpenJDK recommended)") + } else { + fmt.Println("✓ Java is installed") + } + + // Check for AVD (Android Virtual Device) + if checkCommand("emulator", "-list-avds") { + cmd := exec.Command("emulator", "-list-avds") + output, err := cmd.Output() + if err == nil && len(strings.TrimSpace(string(output))) > 0 { + avds := strings.Split(strings.TrimSpace(string(output)), "\n") + fmt.Printf("✓ Found %d Android Virtual Device(s)\n", len(avds)) + } else { + fmt.Println("⚠ No Android Virtual Devices found. Create one via Android Studio > Tools > Device Manager") + } + } + + fmt.Println() + + if len(errors) > 0 { + fmt.Println("❌ Missing dependencies:") + for _, err := range errors { + fmt.Printf(" - %s\n", err) + } + fmt.Println() + fmt.Println("Setup instructions:") + fmt.Println("1. Install Android Studio: https://developer.android.com/studio") + fmt.Println("2. Open SDK Manager and install:") + fmt.Println(" - Android SDK Platform (API 34)") + fmt.Println(" - Android SDK Build-Tools") + fmt.Println(" - Android SDK Platform-Tools") + fmt.Println(" - Android Emulator") + fmt.Println(" - NDK (Side by side)") + fmt.Println("3. Set environment variables:") + if runtime.GOOS == "darwin" { + fmt.Println(" export ANDROID_HOME=$HOME/Library/Android/sdk") + } else { + fmt.Println(" export ANDROID_HOME=$HOME/Android/Sdk") + } + fmt.Println(" export PATH=$PATH:$ANDROID_HOME/platform-tools:$ANDROID_HOME/emulator") + fmt.Println("4. Create an AVD via Android Studio > Tools > Device Manager") + os.Exit(1) + } + + fmt.Println("✓ All Android development dependencies are installed!") +} + +func checkCommand(name string, args ...string) bool { + cmd := exec.Command(name, args...) + cmd.Stdout = nil + cmd.Stderr = nil + return cmd.Run() == nil +} diff --git a/v3/examples/android/build/android/settings.gradle b/v3/examples/android/build/android/settings.gradle new file mode 100644 index 000000000..a3f3ec3d4 --- /dev/null +++ b/v3/examples/android/build/android/settings.gradle @@ -0,0 +1,18 @@ +pluginManagement { + repositories { + google() + mavenCentral() + gradlePluginPortal() + } +} + +dependencyResolutionManagement { + repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS) + repositories { + google() + mavenCentral() + } +} + +rootProject.name = "WailsApp" +include ':app' diff --git a/v2/examples/dragdrop-test/build/appicon.png b/v3/examples/android/build/appicon.png similarity index 100% rename from v2/examples/dragdrop-test/build/appicon.png rename to v3/examples/android/build/appicon.png diff --git a/v3/examples/android/build/config.yml b/v3/examples/android/build/config.yml new file mode 100644 index 000000000..c8adba60d --- /dev/null +++ b/v3/examples/android/build/config.yml @@ -0,0 +1,75 @@ +# This file contains the configuration for this project. +# When you update `info` or `fileAssociations`, run `wails3 task common:update:build-assets` to update the assets. +# Note that this will overwrite any changes you have made to the assets. +version: '3' + +# This information is used to generate the build assets. +info: + companyName: "My Company" # The name of the company + productName: "My Product" # The name of the application + productIdentifier: "com.mycompany.myproduct" # The unique product identifier + description: "A program that does X" # The application description + copyright: "(c) 2025, My Company" # Copyright text + comments: "Some Product Comments" # Comments + version: "0.0.1" # The application version + +# Android build configuration (uncomment to customise Android project generation) +# Note: Keys under `android` OVERRIDE values under `info` when set. +# android: +# # The Android application ID used in the generated project (applicationId) +# applicationId: "com.mycompany.myproduct" +# # The display name shown under the app icon +# displayName: "My Product" +# # The app version code (integer, must increment for each release) +# versionCode: 1 +# # The app version name (displayed to users) +# versionName: "0.0.1" +# # Minimum SDK version (API level) +# minSdkVersion: 21 +# # Target SDK version (API level) +# targetSdkVersion: 34 +# # The company/organisation name for templates and project settings +# company: "My Company" + +# Dev mode configuration +dev_mode: + root_path: . + log_level: warn + debounce: 1000 + ignore: + dir: + - .git + - node_modules + - frontend + - bin + file: + - .DS_Store + - .gitignore + - .gitkeep + watched_extension: + - "*.go" + git_ignore: true + executes: + - cmd: wails3 task common:install:frontend:deps + type: once + - cmd: wails3 task common:dev:frontend + type: background + - cmd: go mod tidy + type: blocking + - cmd: wails3 task build + type: blocking + - cmd: wails3 task run + type: primary + +# File Associations +# More information at: https://v3.wails.io/noit/done/yet +fileAssociations: +# - ext: wails +# name: Wails +# description: Wails Application File +# iconName: wailsFileIcon +# role: Editor + +# Other data +other: + - name: My Other Data diff --git a/v3/examples/android/build/darwin/Info.dev.plist b/v3/examples/android/build/darwin/Info.dev.plist new file mode 100644 index 000000000..bd6a537fa --- /dev/null +++ b/v3/examples/android/build/darwin/Info.dev.plist @@ -0,0 +1,32 @@ + + + + CFBundlePackageType + APPL + CFBundleName + My Product + CFBundleExecutable + ios + CFBundleIdentifier + com.wails.ios + CFBundleVersion + 0.1.0 + CFBundleGetInfoString + This is a comment + CFBundleShortVersionString + 0.1.0 + CFBundleIconFile + icons + LSMinimumSystemVersion + 10.15.0 + NSHighResolutionCapable + true + NSHumanReadableCopyright + © now, My Company + NSAppTransportSecurity + + NSAllowsLocalNetworking + + + + \ No newline at end of file diff --git a/v3/examples/android/build/darwin/Info.plist b/v3/examples/android/build/darwin/Info.plist new file mode 100644 index 000000000..fb52df715 --- /dev/null +++ b/v3/examples/android/build/darwin/Info.plist @@ -0,0 +1,27 @@ + + + + CFBundlePackageType + APPL + CFBundleName + My Product + CFBundleExecutable + ios + CFBundleIdentifier + com.wails.ios + CFBundleVersion + 0.1.0 + CFBundleGetInfoString + This is a comment + CFBundleShortVersionString + 0.1.0 + CFBundleIconFile + icons + LSMinimumSystemVersion + 10.15.0 + NSHighResolutionCapable + true + NSHumanReadableCopyright + © now, My Company + + \ No newline at end of file diff --git a/v3/examples/android/build/darwin/Taskfile.yml b/v3/examples/android/build/darwin/Taskfile.yml new file mode 100644 index 000000000..f0791fea9 --- /dev/null +++ b/v3/examples/android/build/darwin/Taskfile.yml @@ -0,0 +1,81 @@ +version: '3' + +includes: + common: ../Taskfile.yml + +tasks: + build: + summary: Creates a production build of the application + deps: + - task: common:go:mod:tidy + - task: common:build:frontend + vars: + BUILD_FLAGS: + ref: .BUILD_FLAGS + PRODUCTION: + ref: .PRODUCTION + - task: common:generate:icons + cmds: + - go build {{.BUILD_FLAGS}} -o {{.OUTPUT}} + vars: + BUILD_FLAGS: '{{if eq .PRODUCTION "true"}}-tags production -trimpath -buildvcs=false -ldflags="-w -s"{{else}}-buildvcs=false -gcflags=all="-l"{{end}}' + DEFAULT_OUTPUT: '{{.BIN_DIR}}/{{.APP_NAME}}' + OUTPUT: '{{ .OUTPUT | default .DEFAULT_OUTPUT }}' + env: + GOOS: darwin + CGO_ENABLED: 1 + GOARCH: '{{.ARCH | default ARCH}}' + CGO_CFLAGS: "-mmacosx-version-min=10.15" + CGO_LDFLAGS: "-mmacosx-version-min=10.15" + MACOSX_DEPLOYMENT_TARGET: "10.15" + PRODUCTION: '{{.PRODUCTION | default "false"}}' + + build:universal: + summary: Builds darwin universal binary (arm64 + amd64) + deps: + - task: build + vars: + ARCH: amd64 + OUTPUT: "{{.BIN_DIR}}/{{.APP_NAME}}-amd64" + - task: build + vars: + ARCH: arm64 + OUTPUT: "{{.BIN_DIR}}/{{.APP_NAME}}-arm64" + cmds: + - lipo -create -output "{{.BIN_DIR}}/{{.APP_NAME}}" "{{.BIN_DIR}}/{{.APP_NAME}}-amd64" "{{.BIN_DIR}}/{{.APP_NAME}}-arm64" + - rm "{{.BIN_DIR}}/{{.APP_NAME}}-amd64" "{{.BIN_DIR}}/{{.APP_NAME}}-arm64" + + package: + summary: Packages a production build of the application into a `.app` bundle + deps: + - task: build + vars: + PRODUCTION: "true" + cmds: + - task: create:app:bundle + + package:universal: + summary: Packages darwin universal binary (arm64 + amd64) + deps: + - task: build:universal + cmds: + - task: create:app:bundle + + + create:app:bundle: + summary: Creates an `.app` bundle + cmds: + - mkdir -p {{.BIN_DIR}}/{{.APP_NAME}}.app/Contents/{MacOS,Resources} + - cp build/darwin/icons.icns {{.BIN_DIR}}/{{.APP_NAME}}.app/Contents/Resources + - cp {{.BIN_DIR}}/{{.APP_NAME}} {{.BIN_DIR}}/{{.APP_NAME}}.app/Contents/MacOS + - cp build/darwin/Info.plist {{.BIN_DIR}}/{{.APP_NAME}}.app/Contents + - codesign --force --deep --sign - {{.BIN_DIR}}/{{.APP_NAME}}.app + + run: + cmds: + - mkdir -p {{.BIN_DIR}}/{{.APP_NAME}}.dev.app/Contents/{MacOS,Resources} + - cp build/darwin/icons.icns {{.BIN_DIR}}/{{.APP_NAME}}.dev.app/Contents/Resources + - cp {{.BIN_DIR}}/{{.APP_NAME}} {{.BIN_DIR}}/{{.APP_NAME}}.dev.app/Contents/MacOS + - cp build/darwin/Info.dev.plist {{.BIN_DIR}}/{{.APP_NAME}}.dev.app/Contents/Info.plist + - codesign --force --deep --sign - {{.BIN_DIR}}/{{.APP_NAME}}.dev.app + - '{{.BIN_DIR}}/{{.APP_NAME}}.dev.app/Contents/MacOS/{{.APP_NAME}}' diff --git a/v3/examples/android/build/darwin/icons.icns b/v3/examples/android/build/darwin/icons.icns new file mode 100644 index 000000000..1b5bd4c86 Binary files /dev/null and b/v3/examples/android/build/darwin/icons.icns differ diff --git a/v3/examples/android/build/linux/Taskfile.yml b/v3/examples/android/build/linux/Taskfile.yml new file mode 100644 index 000000000..87fd599cc --- /dev/null +++ b/v3/examples/android/build/linux/Taskfile.yml @@ -0,0 +1,119 @@ +version: '3' + +includes: + common: ../Taskfile.yml + +tasks: + build: + summary: Builds the application for Linux + deps: + - task: common:go:mod:tidy + - task: common:build:frontend + vars: + BUILD_FLAGS: + ref: .BUILD_FLAGS + PRODUCTION: + ref: .PRODUCTION + - task: common:generate:icons + cmds: + - go build {{.BUILD_FLAGS}} -o {{.BIN_DIR}}/{{.APP_NAME}} + vars: + BUILD_FLAGS: '{{if eq .PRODUCTION "true"}}-tags production -trimpath -buildvcs=false -ldflags="-w -s"{{else}}-buildvcs=false -gcflags=all="-l"{{end}}' + env: + GOOS: linux + CGO_ENABLED: 1 + GOARCH: '{{.ARCH | default ARCH}}' + PRODUCTION: '{{.PRODUCTION | default "false"}}' + + package: + summary: Packages a production build of the application for Linux + deps: + - task: build + vars: + PRODUCTION: "true" + cmds: + - task: create:appimage + - task: create:deb + - task: create:rpm + - task: create:aur + + create:appimage: + summary: Creates an AppImage + dir: build/linux/appimage + deps: + - task: build + vars: + PRODUCTION: "true" + - task: generate:dotdesktop + cmds: + - cp {{.APP_BINARY}} {{.APP_NAME}} + - cp ../../appicon.png appicon.png + - wails3 generate appimage -binary {{.APP_NAME}} -icon {{.ICON}} -desktopfile {{.DESKTOP_FILE}} -outputdir {{.OUTPUT_DIR}} -builddir {{.ROOT_DIR}}/build/linux/appimage/build + vars: + APP_NAME: '{{.APP_NAME}}' + APP_BINARY: '../../../bin/{{.APP_NAME}}' + ICON: '../../appicon.png' + DESKTOP_FILE: '../{{.APP_NAME}}.desktop' + OUTPUT_DIR: '../../../bin' + + create:deb: + summary: Creates a deb package + deps: + - task: build + vars: + PRODUCTION: "true" + cmds: + - task: generate:dotdesktop + - task: generate:deb + + create:rpm: + summary: Creates a rpm package + deps: + - task: build + vars: + PRODUCTION: "true" + cmds: + - task: generate:dotdesktop + - task: generate:rpm + + create:aur: + summary: Creates a arch linux packager package + deps: + - task: build + vars: + PRODUCTION: "true" + cmds: + - task: generate:dotdesktop + - task: generate:aur + + generate:deb: + summary: Creates a deb package + cmds: + - wails3 tool package -name {{.APP_NAME}} -format deb -config ./build/linux/nfpm/nfpm.yaml -out {{.ROOT_DIR}}/bin + + generate:rpm: + summary: Creates a rpm package + cmds: + - wails3 tool package -name {{.APP_NAME}} -format rpm -config ./build/linux/nfpm/nfpm.yaml -out {{.ROOT_DIR}}/bin + + generate:aur: + summary: Creates a arch linux packager package + cmds: + - wails3 tool package -name {{.APP_NAME}} -format archlinux -config ./build/linux/nfpm/nfpm.yaml -out {{.ROOT_DIR}}/bin + + generate:dotdesktop: + summary: Generates a `.desktop` file + dir: build + cmds: + - mkdir -p {{.ROOT_DIR}}/build/linux/appimage + - wails3 generate .desktop -name "{{.APP_NAME}}" -exec "{{.EXEC}}" -icon "{{.ICON}}" -outputfile {{.ROOT_DIR}}/build/linux/{{.APP_NAME}}.desktop -categories "{{.CATEGORIES}}" + vars: + APP_NAME: '{{.APP_NAME}}' + EXEC: '{{.APP_NAME}}' + ICON: '{{.APP_NAME}}' + CATEGORIES: 'Development;' + OUTPUTFILE: '{{.ROOT_DIR}}/build/linux/{{.APP_NAME}}.desktop' + + run: + cmds: + - '{{.BIN_DIR}}/{{.APP_NAME}}' diff --git a/v3/examples/android/build/linux/appimage/build.sh b/v3/examples/android/build/linux/appimage/build.sh new file mode 100644 index 000000000..858f091ab --- /dev/null +++ b/v3/examples/android/build/linux/appimage/build.sh @@ -0,0 +1,34 @@ +#!/usr/bin/env bash +# Copyright (c) 2018-Present Lea Anthony +# SPDX-License-Identifier: MIT + +# Fail script on any error +set -euxo pipefail + +# Define variables +APP_DIR="${APP_NAME}.AppDir" + +# Create AppDir structure +mkdir -p "${APP_DIR}/usr/bin" +cp -r "${APP_BINARY}" "${APP_DIR}/usr/bin/" +cp "${ICON_PATH}" "${APP_DIR}/" +cp "${DESKTOP_FILE}" "${APP_DIR}/" + +if [[ $(uname -m) == *x86_64* ]]; then + # Download linuxdeploy and make it executable + wget -q -4 -N https://github.com/linuxdeploy/linuxdeploy/releases/download/continuous/linuxdeploy-x86_64.AppImage + chmod +x linuxdeploy-x86_64.AppImage + + # Run linuxdeploy to bundle the application + ./linuxdeploy-x86_64.AppImage --appdir "${APP_DIR}" --output appimage +else + # Download linuxdeploy and make it executable (arm64) + wget -q -4 -N https://github.com/linuxdeploy/linuxdeploy/releases/download/continuous/linuxdeploy-aarch64.AppImage + chmod +x linuxdeploy-aarch64.AppImage + + # Run linuxdeploy to bundle the application (arm64) + ./linuxdeploy-aarch64.AppImage --appdir "${APP_DIR}" --output appimage +fi + +# Rename the generated AppImage +mv "${APP_NAME}*.AppImage" "${APP_NAME}.AppImage" diff --git a/v3/examples/android/build/linux/desktop b/v3/examples/android/build/linux/desktop new file mode 100644 index 000000000..e9b30cf39 --- /dev/null +++ b/v3/examples/android/build/linux/desktop @@ -0,0 +1,11 @@ +[Desktop Entry] +Version=1.0 +Name=My Product +Comment=My Product Description +# The Exec line includes %u to pass the URL to the application +Exec=/usr/local/bin/ios %u +Terminal=false +Type=Application +Icon=ios +Categories=Utility; +StartupWMClass=ios diff --git a/v3/examples/android/build/linux/nfpm/nfpm.yaml b/v3/examples/android/build/linux/nfpm/nfpm.yaml new file mode 100644 index 000000000..7b78433f4 --- /dev/null +++ b/v3/examples/android/build/linux/nfpm/nfpm.yaml @@ -0,0 +1,67 @@ +# Feel free to remove those if you don't want/need to use them. +# Make sure to check the documentation at https://nfpm.goreleaser.com +# +# The lines below are called `modelines`. See `:help modeline` + +name: "ios" +arch: ${GOARCH} +platform: "linux" +version: "0.1.0" +section: "default" +priority: "extra" +maintainer: ${GIT_COMMITTER_NAME} <${GIT_COMMITTER_EMAIL}> +description: "My Product Description" +vendor: "My Company" +homepage: "https://wails.io" +license: "MIT" +release: "1" + +contents: + - src: "./bin/ios" + dst: "/usr/local/bin/ios" + - src: "./build/appicon.png" + dst: "/usr/share/icons/hicolor/128x128/apps/ios.png" + - src: "./build/linux/ios.desktop" + dst: "/usr/share/applications/ios.desktop" + +# Default dependencies for Debian 12/Ubuntu 22.04+ with WebKit 4.1 +depends: + - libgtk-3-0 + - libwebkit2gtk-4.1-0 + +# Distribution-specific overrides for different package formats and WebKit versions +overrides: + # RPM packages for RHEL/CentOS/AlmaLinux/Rocky Linux (WebKit 4.0) + rpm: + depends: + - gtk3 + - webkit2gtk4.1 + + # Arch Linux packages (WebKit 4.1) + archlinux: + depends: + - gtk3 + - webkit2gtk-4.1 + +# scripts section to ensure desktop database is updated after install +scripts: + postinstall: "./build/linux/nfpm/scripts/postinstall.sh" + # You can also add preremove, postremove if needed + # preremove: "./build/linux/nfpm/scripts/preremove.sh" + # postremove: "./build/linux/nfpm/scripts/postremove.sh" + +# replaces: +# - foobar +# provides: +# - bar +# depends: +# - gtk3 +# - libwebkit2gtk +# recommends: +# - whatever +# suggests: +# - something-else +# conflicts: +# - not-foo +# - not-bar +# changelog: "changelog.yaml" diff --git a/v3/examples/android/build/linux/nfpm/scripts/postinstall.sh b/v3/examples/android/build/linux/nfpm/scripts/postinstall.sh new file mode 100644 index 000000000..4bbb815a3 --- /dev/null +++ b/v3/examples/android/build/linux/nfpm/scripts/postinstall.sh @@ -0,0 +1,21 @@ +#!/bin/sh + +# Update desktop database for .desktop file changes +# This makes the application appear in application menus and registers its capabilities. +if command -v update-desktop-database >/dev/null 2>&1; then + echo "Updating desktop database..." + update-desktop-database -q /usr/share/applications +else + echo "Warning: update-desktop-database command not found. Desktop file may not be immediately recognized." >&2 +fi + +# Update MIME database for custom URL schemes (x-scheme-handler) +# This ensures the system knows how to handle your custom protocols. +if command -v update-mime-database >/dev/null 2>&1; then + echo "Updating MIME database..." + update-mime-database -n /usr/share/mime +else + echo "Warning: update-mime-database command not found. Custom URL schemes may not be immediately recognized." >&2 +fi + +exit 0 diff --git a/v3/examples/android/build/linux/nfpm/scripts/postremove.sh b/v3/examples/android/build/linux/nfpm/scripts/postremove.sh new file mode 100644 index 000000000..a9bf588e2 --- /dev/null +++ b/v3/examples/android/build/linux/nfpm/scripts/postremove.sh @@ -0,0 +1 @@ +#!/bin/bash diff --git a/v3/examples/android/build/linux/nfpm/scripts/preinstall.sh b/v3/examples/android/build/linux/nfpm/scripts/preinstall.sh new file mode 100644 index 000000000..a9bf588e2 --- /dev/null +++ b/v3/examples/android/build/linux/nfpm/scripts/preinstall.sh @@ -0,0 +1 @@ +#!/bin/bash diff --git a/v3/examples/android/build/linux/nfpm/scripts/preremove.sh b/v3/examples/android/build/linux/nfpm/scripts/preremove.sh new file mode 100644 index 000000000..a9bf588e2 --- /dev/null +++ b/v3/examples/android/build/linux/nfpm/scripts/preremove.sh @@ -0,0 +1 @@ +#!/bin/bash diff --git a/v3/examples/android/build/windows/Taskfile.yml b/v3/examples/android/build/windows/Taskfile.yml new file mode 100644 index 000000000..19f137616 --- /dev/null +++ b/v3/examples/android/build/windows/Taskfile.yml @@ -0,0 +1,98 @@ +version: '3' + +includes: + common: ../Taskfile.yml + +tasks: + build: + summary: Builds the application for Windows + deps: + - task: common:go:mod:tidy + - task: common:build:frontend + vars: + BUILD_FLAGS: + ref: .BUILD_FLAGS + PRODUCTION: + ref: .PRODUCTION + - task: common:generate:icons + cmds: + - task: generate:syso + - go build {{.BUILD_FLAGS}} -o {{.BIN_DIR}}/{{.APP_NAME}}.exe + - cmd: powershell Remove-item *.syso + platforms: [windows] + - cmd: rm -f *.syso + platforms: [linux, darwin] + vars: + BUILD_FLAGS: '{{if eq .PRODUCTION "true"}}-tags production -trimpath -buildvcs=false -ldflags="-w -s -H windowsgui"{{else}}-buildvcs=false -gcflags=all="-l"{{end}}' + env: + GOOS: windows + CGO_ENABLED: 0 + GOARCH: '{{.ARCH | default ARCH}}' + PRODUCTION: '{{.PRODUCTION | default "false"}}' + + package: + summary: Packages a production build of the application + cmds: + - |- + if [ "{{.FORMAT | default "nsis"}}" = "msix" ]; then + task: create:msix:package + else + task: create:nsis:installer + fi + vars: + FORMAT: '{{.FORMAT | default "nsis"}}' + + generate:syso: + summary: Generates Windows `.syso` file + dir: build + cmds: + - wails3 generate syso -arch {{.ARCH}} -icon windows/icon.ico -manifest windows/wails.exe.manifest -info windows/info.json -out ../wails_windows_{{.ARCH}}.syso + vars: + ARCH: '{{.ARCH | default ARCH}}' + + create:nsis:installer: + summary: Creates an NSIS installer + dir: build/windows/nsis + deps: + - task: build + vars: + PRODUCTION: "true" + cmds: + # Create the Microsoft WebView2 bootstrapper if it doesn't exist + - wails3 generate webview2bootstrapper -dir "{{.ROOT_DIR}}/build/windows/nsis" + - makensis -DARG_WAILS_{{.ARG_FLAG}}_BINARY="{{.ROOT_DIR}}/{{.BIN_DIR}}/{{.APP_NAME}}.exe" project.nsi + vars: + ARCH: '{{.ARCH | default ARCH}}' + ARG_FLAG: '{{if eq .ARCH "amd64"}}AMD64{{else}}ARM64{{end}}' + + create:msix:package: + summary: Creates an MSIX package + deps: + - task: build + vars: + PRODUCTION: "true" + cmds: + - |- + wails3 tool msix \ + --config "{{.ROOT_DIR}}/wails.json" \ + --name "{{.APP_NAME}}" \ + --executable "{{.ROOT_DIR}}/{{.BIN_DIR}}/{{.APP_NAME}}.exe" \ + --arch "{{.ARCH}}" \ + --out "{{.ROOT_DIR}}/{{.BIN_DIR}}/{{.APP_NAME}}-{{.ARCH}}.msix" \ + {{if .CERT_PATH}}--cert "{{.CERT_PATH}}"{{end}} \ + {{if .PUBLISHER}}--publisher "{{.PUBLISHER}}"{{end}} \ + {{if .USE_MSIX_TOOL}}--use-msix-tool{{else}}--use-makeappx{{end}} + vars: + ARCH: '{{.ARCH | default ARCH}}' + CERT_PATH: '{{.CERT_PATH | default ""}}' + PUBLISHER: '{{.PUBLISHER | default ""}}' + USE_MSIX_TOOL: '{{.USE_MSIX_TOOL | default "false"}}' + + install:msix:tools: + summary: Installs tools required for MSIX packaging + cmds: + - wails3 tool msix-install-tools + + run: + cmds: + - '{{.BIN_DIR}}/{{.APP_NAME}}.exe' diff --git a/v3/examples/android/build/windows/icon.ico b/v3/examples/android/build/windows/icon.ico new file mode 100644 index 000000000..bfa0690b7 Binary files /dev/null and b/v3/examples/android/build/windows/icon.ico differ diff --git a/v3/examples/android/build/windows/info.json b/v3/examples/android/build/windows/info.json new file mode 100644 index 000000000..850b2b5b0 --- /dev/null +++ b/v3/examples/android/build/windows/info.json @@ -0,0 +1,15 @@ +{ + "fixed": { + "file_version": "0.1.0" + }, + "info": { + "0000": { + "ProductVersion": "0.1.0", + "CompanyName": "My Company", + "FileDescription": "My Product Description", + "LegalCopyright": "© now, My Company", + "ProductName": "My Product", + "Comments": "This is a comment" + } + } +} \ No newline at end of file diff --git a/v3/examples/android/build/windows/msix/app_manifest.xml b/v3/examples/android/build/windows/msix/app_manifest.xml new file mode 100644 index 000000000..ecf2506b3 --- /dev/null +++ b/v3/examples/android/build/windows/msix/app_manifest.xml @@ -0,0 +1,52 @@ + + + + + + + My Product + My Company + My Product Description + Assets\StoreLogo.png + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/v3/examples/android/build/windows/msix/template.xml b/v3/examples/android/build/windows/msix/template.xml new file mode 100644 index 000000000..cab2f31e0 --- /dev/null +++ b/v3/examples/android/build/windows/msix/template.xml @@ -0,0 +1,54 @@ + + + + + + + + + + + + + + + + + + + + + + + + false + My Product + My Company + My Product Description + Assets\AppIcon.png + + + + + + + diff --git a/v3/examples/android/build/windows/nsis/project.nsi b/v3/examples/android/build/windows/nsis/project.nsi new file mode 100644 index 000000000..74b8d6ad0 --- /dev/null +++ b/v3/examples/android/build/windows/nsis/project.nsi @@ -0,0 +1,112 @@ +Unicode true + +#### +## Please note: Template replacements don't work in this file. They are provided with default defines like +## mentioned underneath. +## If the keyword is not defined, "wails_tools.nsh" will populate them. +## If they are defined here, "wails_tools.nsh" will not touch them. This allows you to use this project.nsi manually +## from outside of Wails for debugging and development of the installer. +## +## For development first make a wails nsis build to populate the "wails_tools.nsh": +## > wails build --target windows/amd64 --nsis +## Then you can call makensis on this file with specifying the path to your binary: +## For a AMD64 only installer: +## > makensis -DARG_WAILS_AMD64_BINARY=..\..\bin\app.exe +## For a ARM64 only installer: +## > makensis -DARG_WAILS_ARM64_BINARY=..\..\bin\app.exe +## For a installer with both architectures: +## > makensis -DARG_WAILS_AMD64_BINARY=..\..\bin\app-amd64.exe -DARG_WAILS_ARM64_BINARY=..\..\bin\app-arm64.exe +#### +## The following information is taken from the wails_tools.nsh file, but they can be overwritten here. +#### +## !define INFO_PROJECTNAME "my-project" # Default "ios" +## !define INFO_COMPANYNAME "My Company" # Default "My Company" +## !define INFO_PRODUCTNAME "My Product Name" # Default "My Product" +## !define INFO_PRODUCTVERSION "1.0.0" # Default "0.1.0" +## !define INFO_COPYRIGHT "(c) Now, My Company" # Default "© now, My Company" +### +## !define PRODUCT_EXECUTABLE "Application.exe" # Default "${INFO_PROJECTNAME}.exe" +## !define UNINST_KEY_NAME "UninstKeyInRegistry" # Default "${INFO_COMPANYNAME}${INFO_PRODUCTNAME}" +#### +## !define REQUEST_EXECUTION_LEVEL "admin" # Default "admin" see also https://nsis.sourceforge.io/Docs/Chapter4.html +#### +## Include the wails tools +#### +!include "wails_tools.nsh" + +# The version information for this two must consist of 4 parts +VIProductVersion "${INFO_PRODUCTVERSION}.0" +VIFileVersion "${INFO_PRODUCTVERSION}.0" + +VIAddVersionKey "CompanyName" "${INFO_COMPANYNAME}" +VIAddVersionKey "FileDescription" "${INFO_PRODUCTNAME} Installer" +VIAddVersionKey "ProductVersion" "${INFO_PRODUCTVERSION}" +VIAddVersionKey "FileVersion" "${INFO_PRODUCTVERSION}" +VIAddVersionKey "LegalCopyright" "${INFO_COPYRIGHT}" +VIAddVersionKey "ProductName" "${INFO_PRODUCTNAME}" + +# Enable HiDPI support. https://nsis.sourceforge.io/Reference/ManifestDPIAware +ManifestDPIAware true + +!include "MUI.nsh" + +!define MUI_ICON "..\icon.ico" +!define MUI_UNICON "..\icon.ico" +# !define MUI_WELCOMEFINISHPAGE_BITMAP "resources\leftimage.bmp" #Include this to add a bitmap on the left side of the Welcome Page. Must be a size of 164x314 +!define MUI_FINISHPAGE_NOAUTOCLOSE # Wait on the INSTFILES page so the user can take a look into the details of the installation steps +!define MUI_ABORTWARNING # This will warn the user if they exit from the installer. + +!insertmacro MUI_PAGE_WELCOME # Welcome to the installer page. +# !insertmacro MUI_PAGE_LICENSE "resources\eula.txt" # Adds a EULA page to the installer +!insertmacro MUI_PAGE_DIRECTORY # In which folder install page. +!insertmacro MUI_PAGE_INSTFILES # Installing page. +!insertmacro MUI_PAGE_FINISH # Finished installation page. + +!insertmacro MUI_UNPAGE_INSTFILES # Uninstalling page + +!insertmacro MUI_LANGUAGE "English" # Set the Language of the installer + +## The following two statements can be used to sign the installer and the uninstaller. The path to the binaries are provided in %1 +#!uninstfinalize 'signtool --file "%1"' +#!finalize 'signtool --file "%1"' + +Name "${INFO_PRODUCTNAME}" +OutFile "..\..\..\bin\${INFO_PROJECTNAME}-${ARCH}-installer.exe" # Name of the installer's file. +InstallDir "$PROGRAMFILES64\${INFO_COMPANYNAME}\${INFO_PRODUCTNAME}" # Default installing folder ($PROGRAMFILES is Program Files folder). +ShowInstDetails show # This will always show the installation details. + +Function .onInit + !insertmacro wails.checkArchitecture +FunctionEnd + +Section + !insertmacro wails.setShellContext + + !insertmacro wails.webview2runtime + + SetOutPath $INSTDIR + + !insertmacro wails.files + + CreateShortcut "$SMPROGRAMS\${INFO_PRODUCTNAME}.lnk" "$INSTDIR\${PRODUCT_EXECUTABLE}" + CreateShortCut "$DESKTOP\${INFO_PRODUCTNAME}.lnk" "$INSTDIR\${PRODUCT_EXECUTABLE}" + + !insertmacro wails.associateFiles + + !insertmacro wails.writeUninstaller +SectionEnd + +Section "uninstall" + !insertmacro wails.setShellContext + + RMDir /r "$AppData\${PRODUCT_EXECUTABLE}" # Remove the WebView2 DataPath + + RMDir /r $INSTDIR + + Delete "$SMPROGRAMS\${INFO_PRODUCTNAME}.lnk" + Delete "$DESKTOP\${INFO_PRODUCTNAME}.lnk" + + !insertmacro wails.unassociateFiles + + !insertmacro wails.deleteUninstaller +SectionEnd diff --git a/v3/examples/android/build/windows/nsis/wails_tools.nsh b/v3/examples/android/build/windows/nsis/wails_tools.nsh new file mode 100644 index 000000000..dc9aebc17 --- /dev/null +++ b/v3/examples/android/build/windows/nsis/wails_tools.nsh @@ -0,0 +1,212 @@ +# DO NOT EDIT - Generated automatically by `wails build` + +!include "x64.nsh" +!include "WinVer.nsh" +!include "FileFunc.nsh" + +!ifndef INFO_PROJECTNAME + !define INFO_PROJECTNAME "ios" +!endif +!ifndef INFO_COMPANYNAME + !define INFO_COMPANYNAME "My Company" +!endif +!ifndef INFO_PRODUCTNAME + !define INFO_PRODUCTNAME "My Product" +!endif +!ifndef INFO_PRODUCTVERSION + !define INFO_PRODUCTVERSION "0.1.0" +!endif +!ifndef INFO_COPYRIGHT + !define INFO_COPYRIGHT "© now, My Company" +!endif +!ifndef PRODUCT_EXECUTABLE + !define PRODUCT_EXECUTABLE "${INFO_PROJECTNAME}.exe" +!endif +!ifndef UNINST_KEY_NAME + !define UNINST_KEY_NAME "${INFO_COMPANYNAME}${INFO_PRODUCTNAME}" +!endif +!define UNINST_KEY "Software\Microsoft\Windows\CurrentVersion\Uninstall\${UNINST_KEY_NAME}" + +!ifndef REQUEST_EXECUTION_LEVEL + !define REQUEST_EXECUTION_LEVEL "admin" +!endif + +RequestExecutionLevel "${REQUEST_EXECUTION_LEVEL}" + +!ifdef ARG_WAILS_AMD64_BINARY + !define SUPPORTS_AMD64 +!endif + +!ifdef ARG_WAILS_ARM64_BINARY + !define SUPPORTS_ARM64 +!endif + +!ifdef SUPPORTS_AMD64 + !ifdef SUPPORTS_ARM64 + !define ARCH "amd64_arm64" + !else + !define ARCH "amd64" + !endif +!else + !ifdef SUPPORTS_ARM64 + !define ARCH "arm64" + !else + !error "Wails: Undefined ARCH, please provide at least one of ARG_WAILS_AMD64_BINARY or ARG_WAILS_ARM64_BINARY" + !endif +!endif + +!macro wails.checkArchitecture + !ifndef WAILS_WIN10_REQUIRED + !define WAILS_WIN10_REQUIRED "This product is only supported on Windows 10 (Server 2016) and later." + !endif + + !ifndef WAILS_ARCHITECTURE_NOT_SUPPORTED + !define WAILS_ARCHITECTURE_NOT_SUPPORTED "This product can't be installed on the current Windows architecture. Supports: ${ARCH}" + !endif + + ${If} ${AtLeastWin10} + !ifdef SUPPORTS_AMD64 + ${if} ${IsNativeAMD64} + Goto ok + ${EndIf} + !endif + + !ifdef SUPPORTS_ARM64 + ${if} ${IsNativeARM64} + Goto ok + ${EndIf} + !endif + + IfSilent silentArch notSilentArch + silentArch: + SetErrorLevel 65 + Abort + notSilentArch: + MessageBox MB_OK "${WAILS_ARCHITECTURE_NOT_SUPPORTED}" + Quit + ${else} + IfSilent silentWin notSilentWin + silentWin: + SetErrorLevel 64 + Abort + notSilentWin: + MessageBox MB_OK "${WAILS_WIN10_REQUIRED}" + Quit + ${EndIf} + + ok: +!macroend + +!macro wails.files + !ifdef SUPPORTS_AMD64 + ${if} ${IsNativeAMD64} + File "/oname=${PRODUCT_EXECUTABLE}" "${ARG_WAILS_AMD64_BINARY}" + ${EndIf} + !endif + + !ifdef SUPPORTS_ARM64 + ${if} ${IsNativeARM64} + File "/oname=${PRODUCT_EXECUTABLE}" "${ARG_WAILS_ARM64_BINARY}" + ${EndIf} + !endif +!macroend + +!macro wails.writeUninstaller + WriteUninstaller "$INSTDIR\uninstall.exe" + + SetRegView 64 + WriteRegStr HKLM "${UNINST_KEY}" "Publisher" "${INFO_COMPANYNAME}" + WriteRegStr HKLM "${UNINST_KEY}" "DisplayName" "${INFO_PRODUCTNAME}" + WriteRegStr HKLM "${UNINST_KEY}" "DisplayVersion" "${INFO_PRODUCTVERSION}" + WriteRegStr HKLM "${UNINST_KEY}" "DisplayIcon" "$INSTDIR\${PRODUCT_EXECUTABLE}" + WriteRegStr HKLM "${UNINST_KEY}" "UninstallString" "$\"$INSTDIR\uninstall.exe$\"" + WriteRegStr HKLM "${UNINST_KEY}" "QuietUninstallString" "$\"$INSTDIR\uninstall.exe$\" /S" + + ${GetSize} "$INSTDIR" "/S=0K" $0 $1 $2 + IntFmt $0 "0x%08X" $0 + WriteRegDWORD HKLM "${UNINST_KEY}" "EstimatedSize" "$0" +!macroend + +!macro wails.deleteUninstaller + Delete "$INSTDIR\uninstall.exe" + + SetRegView 64 + DeleteRegKey HKLM "${UNINST_KEY}" +!macroend + +!macro wails.setShellContext + ${If} ${REQUEST_EXECUTION_LEVEL} == "admin" + SetShellVarContext all + ${else} + SetShellVarContext current + ${EndIf} +!macroend + +# Install webview2 by launching the bootstrapper +# See https://docs.microsoft.com/en-us/microsoft-edge/webview2/concepts/distribution#online-only-deployment +!macro wails.webview2runtime + !ifndef WAILS_INSTALL_WEBVIEW_DETAILPRINT + !define WAILS_INSTALL_WEBVIEW_DETAILPRINT "Installing: WebView2 Runtime" + !endif + + SetRegView 64 + # If the admin key exists and is not empty then webview2 is already installed + ReadRegStr $0 HKLM "SOFTWARE\WOW6432Node\Microsoft\EdgeUpdate\Clients\{F3017226-FE2A-4295-8BDF-00C3A9A7E4C5}" "pv" + ${If} $0 != "" + Goto ok + ${EndIf} + + ${If} ${REQUEST_EXECUTION_LEVEL} == "user" + # If the installer is run in user level, check the user specific key exists and is not empty then webview2 is already installed + ReadRegStr $0 HKCU "Software\Microsoft\EdgeUpdate\Clients\{F3017226-FE2A-4295-8BDF-00C3A9A7E4C5}" "pv" + ${If} $0 != "" + Goto ok + ${EndIf} + ${EndIf} + + SetDetailsPrint both + DetailPrint "${WAILS_INSTALL_WEBVIEW_DETAILPRINT}" + SetDetailsPrint listonly + + InitPluginsDir + CreateDirectory "$pluginsdir\webview2bootstrapper" + SetOutPath "$pluginsdir\webview2bootstrapper" + File "MicrosoftEdgeWebview2Setup.exe" + ExecWait '"$pluginsdir\webview2bootstrapper\MicrosoftEdgeWebview2Setup.exe" /silent /install' + + SetDetailsPrint both + ok: +!macroend + +# Copy of APP_ASSOCIATE and APP_UNASSOCIATE macros from here https://gist.github.com/nikku/281d0ef126dbc215dd58bfd5b3a5cd5b +!macro APP_ASSOCIATE EXT FILECLASS DESCRIPTION ICON COMMANDTEXT COMMAND + ; Backup the previously associated file class + ReadRegStr $R0 SHELL_CONTEXT "Software\Classes\.${EXT}" "" + WriteRegStr SHELL_CONTEXT "Software\Classes\.${EXT}" "${FILECLASS}_backup" "$R0" + + WriteRegStr SHELL_CONTEXT "Software\Classes\.${EXT}" "" "${FILECLASS}" + + WriteRegStr SHELL_CONTEXT "Software\Classes\${FILECLASS}" "" `${DESCRIPTION}` + WriteRegStr SHELL_CONTEXT "Software\Classes\${FILECLASS}\DefaultIcon" "" `${ICON}` + WriteRegStr SHELL_CONTEXT "Software\Classes\${FILECLASS}\shell" "" "open" + WriteRegStr SHELL_CONTEXT "Software\Classes\${FILECLASS}\shell\open" "" `${COMMANDTEXT}` + WriteRegStr SHELL_CONTEXT "Software\Classes\${FILECLASS}\shell\open\command" "" `${COMMAND}` +!macroend + +!macro APP_UNASSOCIATE EXT FILECLASS + ; Backup the previously associated file class + ReadRegStr $R0 SHELL_CONTEXT "Software\Classes\.${EXT}" `${FILECLASS}_backup` + WriteRegStr SHELL_CONTEXT "Software\Classes\.${EXT}" "" "$R0" + + DeleteRegKey SHELL_CONTEXT `Software\Classes\${FILECLASS}` +!macroend + +!macro wails.associateFiles + ; Create file associations + +!macroend + +!macro wails.unassociateFiles + ; Delete app associations + +!macroend \ No newline at end of file diff --git a/v3/examples/android/build/windows/wails.exe.manifest b/v3/examples/android/build/windows/wails.exe.manifest new file mode 100644 index 000000000..025555a69 --- /dev/null +++ b/v3/examples/android/build/windows/wails.exe.manifest @@ -0,0 +1,22 @@ + + + + + + + + + + + true/pm + permonitorv2,permonitor + + + + + + + + + + \ No newline at end of file diff --git a/v3/examples/android/frontend/Inter Font License.txt b/v3/examples/android/frontend/Inter Font License.txt new file mode 100644 index 000000000..00287df15 --- /dev/null +++ b/v3/examples/android/frontend/Inter Font License.txt @@ -0,0 +1,93 @@ +Copyright 2020 The Inter Project Authors (https://github.com/rsms/inter) + +This Font Software is licensed under the SIL Open Font License, Version 1.1. +This license is copied below, and is also available with a FAQ at: +http://scripts.sil.org/OFL + + +----------------------------------------------------------- +SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007 +----------------------------------------------------------- + +PREAMBLE +The goals of the Open Font License (OFL) are to stimulate worldwide +development of collaborative font projects, to support the font creation +efforts of academic and linguistic communities, and to provide a free and +open framework in which fonts may be shared and improved in partnership +with others. + +The OFL allows the licensed fonts to be used, studied, modified and +redistributed freely as long as they are not sold by themselves. The +fonts, including any derivative works, can be bundled, embedded, +redistributed and/or sold with any software provided that any reserved +names are not used by derivative works. The fonts and derivatives, +however, cannot be released under any other type of license. The +requirement for fonts to remain under this license does not apply +to any document created using the fonts or their derivatives. + +DEFINITIONS +"Font Software" refers to the set of files released by the Copyright +Holder(s) under this license and clearly marked as such. This may +include source files, build scripts and documentation. + +"Reserved Font Name" refers to any names specified as such after the +copyright statement(s). + +"Original Version" refers to the collection of Font Software components as +distributed by the Copyright Holder(s). + +"Modified Version" refers to any derivative made by adding to, deleting, +or substituting -- in part or in whole -- any of the components of the +Original Version, by changing formats or by porting the Font Software to a +new environment. + +"Author" refers to any designer, engineer, programmer, technical +writer or other person who contributed to the Font Software. + +PERMISSION & CONDITIONS +Permission is hereby granted, free of charge, to any person obtaining +a copy of the Font Software, to use, study, copy, merge, embed, modify, +redistribute, and sell modified and unmodified copies of the Font +Software, subject to the following conditions: + +1) Neither the Font Software nor any of its individual components, +in Original or Modified Versions, may be sold by itself. + +2) Original or Modified Versions of the Font Software may be bundled, +redistributed and/or sold with any software, provided that each copy +contains the above copyright notice and this license. These can be +included either as stand-alone text files, human-readable headers or +in the appropriate machine-readable metadata fields within text or +binary files as long as those fields can be easily viewed by the user. + +3) No Modified Version of the Font Software may use the Reserved Font +Name(s) unless explicit written permission is granted by the corresponding +Copyright Holder. This restriction only applies to the primary font name as +presented to the users. + +4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font +Software shall not be used to promote, endorse or advertise any +Modified Version, except to acknowledge the contribution(s) of the +Copyright Holder(s) and the Author(s) or with their explicit written +permission. + +5) The Font Software, modified or unmodified, in part or in whole, +must be distributed entirely under this license, and must not be +distributed under any other license. The requirement for fonts to +remain under this license does not apply to any document created +using the Font Software. + +TERMINATION +This license becomes null and void if any of the above conditions are +not met. + +DISCLAIMER +THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF +MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT +OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE +COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, +INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL +DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING +FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM +OTHER DEALINGS IN THE FONT SOFTWARE. diff --git a/v3/examples/android/frontend/bindings/changeme/greetservice.js b/v3/examples/android/frontend/bindings/changeme/greetservice.js new file mode 100644 index 000000000..0b93e6d75 --- /dev/null +++ b/v3/examples/android/frontend/bindings/changeme/greetservice.js @@ -0,0 +1,15 @@ +// @ts-check +// Cynhyrchwyd y ffeil hon yn awtomatig. PEIDIWCH Â MODIWL +// This file is automatically generated. DO NOT EDIT + +// eslint-disable-next-line @typescript-eslint/ban-ts-comment +// @ts-ignore: Unused imports +import { Call as $Call, CancellablePromise as $CancellablePromise, Create as $Create } from "@wailsio/runtime"; + +/** + * @param {string} name + * @returns {$CancellablePromise} + */ +export function Greet(name) { + return $Call.ByID(1411160069, name); +} diff --git a/v3/examples/android/frontend/bindings/changeme/index.js b/v3/examples/android/frontend/bindings/changeme/index.js new file mode 100644 index 000000000..fdf1ff435 --- /dev/null +++ b/v3/examples/android/frontend/bindings/changeme/index.js @@ -0,0 +1,8 @@ +// @ts-check +// Cynhyrchwyd y ffeil hon yn awtomatig. PEIDIWCH Â MODIWL +// This file is automatically generated. DO NOT EDIT + +import * as GreetService from "./greetservice.js"; +export { + GreetService +}; diff --git a/v3/examples/android/frontend/bindings/github.com/wailsapp/wails/v3/internal/eventcreate.js b/v3/examples/android/frontend/bindings/github.com/wailsapp/wails/v3/internal/eventcreate.js new file mode 100644 index 000000000..1ea105857 --- /dev/null +++ b/v3/examples/android/frontend/bindings/github.com/wailsapp/wails/v3/internal/eventcreate.js @@ -0,0 +1,9 @@ +//@ts-check +// Cynhyrchwyd y ffeil hon yn awtomatig. PEIDIWCH Â MODIWL +// This file is automatically generated. DO NOT EDIT + +// eslint-disable-next-line @typescript-eslint/ban-ts-comment +// @ts-ignore: Unused imports +import { Create as $Create } from "@wailsio/runtime"; + +Object.freeze($Create.Events); diff --git a/v3/examples/android/frontend/bindings/github.com/wailsapp/wails/v3/internal/eventdata.d.ts b/v3/examples/android/frontend/bindings/github.com/wailsapp/wails/v3/internal/eventdata.d.ts new file mode 100644 index 000000000..3dd1807bd --- /dev/null +++ b/v3/examples/android/frontend/bindings/github.com/wailsapp/wails/v3/internal/eventdata.d.ts @@ -0,0 +1,2 @@ +// Cynhyrchwyd y ffeil hon yn awtomatig. PEIDIWCH Â MODIWL +// This file is automatically generated. DO NOT EDIT diff --git a/v3/examples/android/frontend/index.html b/v3/examples/android/frontend/index.html new file mode 100644 index 000000000..f7c8de065 --- /dev/null +++ b/v3/examples/android/frontend/index.html @@ -0,0 +1,110 @@ + + + + + + + + + Wails App + + + + +
      + +

      Wails + Javascript

      +
      +
      Demo Screens
      +
      + +
      +
      Please enter your name below 👇
      +
      + + +
      +
      + + +
      +
      + +
      +
      + +
      +
      + +
      +
      + +
      +
      + +
      +
      + + +
      +
      + + +
      +
      + + + + +
      +
      + +
      +
      + +
      +
      + +
      +
      + +
      +
      + +
      +
      + + +
      +
      
      +          
      + +
      +
      + +
      + + + diff --git a/v3/examples/android/frontend/main.js b/v3/examples/android/frontend/main.js new file mode 100644 index 000000000..ad8064576 --- /dev/null +++ b/v3/examples/android/frontend/main.js @@ -0,0 +1,113 @@ +import {GreetService} from "./bindings/changeme"; +import * as Runtime from "@wailsio/runtime"; + +const resultElement = document.getElementById('result'); +const timeElement = document.getElementById('time'); +const deviceInfoElement = document.getElementById('deviceInfo'); +const Events = Runtime.Events; +const IOS = Runtime.IOS; // May be undefined in published package; we guard usages below. + +window.doGreet = () => { + let name = document.getElementById('name').value; + if (!name) { + name = 'anonymous'; + } + GreetService.Greet(name).then((result) => { + resultElement.innerText = result; + }).catch((err) => { + console.log(err); + }); +} + +window.doHaptic = (style) => { + if (!IOS || !IOS.Haptics?.Impact) { + console.warn('IOS runtime not available in @wailsio/runtime. Skipping haptic call.'); + return; + } + IOS.Haptics.Impact(style).catch((err) => { + console.error('Haptics error:', err); + }); +} + +window.getDeviceInfo = async () => { + if (!IOS || !IOS.Device?.Info) { + deviceInfoElement.innerText = 'iOS runtime not available; cannot fetch device info.'; + return; + } + try { + const info = await IOS.Device.Info(); + deviceInfoElement.innerText = JSON.stringify(info, null, 2); + } catch (e) { + deviceInfoElement.innerText = `Error: ${e?.message || e}`; + } +} + +// Generic caller for IOS..(args) +window.iosJsSet = async (methodPath, args) => { + if (!IOS) { + console.warn('IOS runtime not available in @wailsio/runtime.'); + return; + } + try { + const [group, method] = methodPath.split('.'); + const target = IOS?.[group]; + const fn = target?.[method]; + if (typeof fn !== 'function') { + console.warn('IOS method not found:', methodPath); + return; + } + await fn(args); + } catch (e) { + console.error('iosJsSet error for', methodPath, e); + } +} + +// Emit events for Go handlers +window.emitGo = (eventName, data) => { + try { + Events.Emit(eventName, data); + } catch (e) { + console.error('emitGo error:', e); + } +} + +// Toggle helpers for UI switches +window.setGoToggle = (eventName, enabled) => { + emitGo(eventName, { enabled: !!enabled }); +} + +window.setJsToggle = (methodPath, enabled) => { + iosJsSet(methodPath, { enabled: !!enabled }); +} + +Events.On('time', (payload) => { + // payload may be a plain value or an object with a `data` field depending on emitter/runtime + const value = (payload && typeof payload === 'object' && 'data' in payload) ? payload.data : payload; + console.log('[frontend] time event:', payload, '->', value); + timeElement.innerText = value; +}); + +// Simple pane switcher responding to native UITabBar +function showPaneByIndex(index) { + const panes = [ + document.getElementById('screen-bindings'), + document.getElementById('screen-go'), + document.getElementById('screen-js'), + ]; + panes.forEach((el, i) => { + if (!el) return; + if (i === index) el.classList.add('active'); + else el.classList.remove('active'); + }); +} + +// Listen for native tab selection events posted by the iOS layer +window.addEventListener('nativeTabSelected', (e) => { + const idx = (e && e.detail && typeof e.detail.index === 'number') ? e.detail.index : 0; + showPaneByIndex(idx); +}); + +// Ensure default pane is visible on load (index 0) +window.addEventListener('DOMContentLoaded', () => { + showPaneByIndex(0); +}); diff --git a/v3/examples/android/frontend/package-lock.json b/v3/examples/android/frontend/package-lock.json new file mode 100644 index 000000000..b0b7dc68f --- /dev/null +++ b/v3/examples/android/frontend/package-lock.json @@ -0,0 +1,936 @@ +{ + "name": "frontend", + "version": "0.0.0", + "lockfileVersion": 3, + "requires": true, + "packages": { + "": { + "name": "frontend", + "version": "0.0.0", + "dependencies": { + "@wailsio/runtime": "latest" + }, + "devDependencies": { + "vite": "^5.0.0" + } + }, + "node_modules/@esbuild/aix-ppc64": { + "version": "0.21.5", + "resolved": "https://registry.npmjs.org/@esbuild/aix-ppc64/-/aix-ppc64-0.21.5.tgz", + "integrity": "sha512-1SDgH6ZSPTlggy1yI6+Dbkiz8xzpHJEVAlF/AM1tHPLsf5STom9rwtjE4hKAF20FfXXNTFqEYXyJNWh1GiZedQ==", + "cpu": [ + "ppc64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "aix" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/@esbuild/android-arm": { + "version": "0.21.5", + "resolved": "https://registry.npmjs.org/@esbuild/android-arm/-/android-arm-0.21.5.tgz", + "integrity": "sha512-vCPvzSjpPHEi1siZdlvAlsPxXl7WbOVUBBAowWug4rJHb68Ox8KualB+1ocNvT5fjv6wpkX6o/iEpbDrf68zcg==", + "cpu": [ + "arm" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "android" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/@esbuild/android-arm64": { + "version": "0.21.5", + "resolved": "https://registry.npmjs.org/@esbuild/android-arm64/-/android-arm64-0.21.5.tgz", + "integrity": "sha512-c0uX9VAUBQ7dTDCjq+wdyGLowMdtR/GoC2U5IYk/7D1H1JYC0qseD7+11iMP2mRLN9RcCMRcjC4YMclCzGwS/A==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "android" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/@esbuild/android-x64": { + "version": "0.21.5", + "resolved": "https://registry.npmjs.org/@esbuild/android-x64/-/android-x64-0.21.5.tgz", + "integrity": "sha512-D7aPRUUNHRBwHxzxRvp856rjUHRFW1SdQATKXH2hqA0kAZb1hKmi02OpYRacl0TxIGz/ZmXWlbZgjwWYaCakTA==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "android" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/@esbuild/darwin-arm64": { + "version": "0.21.5", + "resolved": "https://registry.npmjs.org/@esbuild/darwin-arm64/-/darwin-arm64-0.21.5.tgz", + "integrity": "sha512-DwqXqZyuk5AiWWf3UfLiRDJ5EDd49zg6O9wclZ7kUMv2WRFr4HKjXp/5t8JZ11QbQfUS6/cRCKGwYhtNAY88kQ==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "darwin" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/@esbuild/darwin-x64": { + "version": "0.21.5", + "resolved": "https://registry.npmjs.org/@esbuild/darwin-x64/-/darwin-x64-0.21.5.tgz", + "integrity": "sha512-se/JjF8NlmKVG4kNIuyWMV/22ZaerB+qaSi5MdrXtd6R08kvs2qCN4C09miupktDitvh8jRFflwGFBQcxZRjbw==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "darwin" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/@esbuild/freebsd-arm64": { + "version": "0.21.5", + "resolved": "https://registry.npmjs.org/@esbuild/freebsd-arm64/-/freebsd-arm64-0.21.5.tgz", + "integrity": "sha512-5JcRxxRDUJLX8JXp/wcBCy3pENnCgBR9bN6JsY4OmhfUtIHe3ZW0mawA7+RDAcMLrMIZaf03NlQiX9DGyB8h4g==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "freebsd" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/@esbuild/freebsd-x64": { + "version": "0.21.5", + "resolved": "https://registry.npmjs.org/@esbuild/freebsd-x64/-/freebsd-x64-0.21.5.tgz", + "integrity": "sha512-J95kNBj1zkbMXtHVH29bBriQygMXqoVQOQYA+ISs0/2l3T9/kj42ow2mpqerRBxDJnmkUDCaQT/dfNXWX/ZZCQ==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "freebsd" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/@esbuild/linux-arm": { + "version": "0.21.5", + "resolved": "https://registry.npmjs.org/@esbuild/linux-arm/-/linux-arm-0.21.5.tgz", + "integrity": "sha512-bPb5AHZtbeNGjCKVZ9UGqGwo8EUu4cLq68E95A53KlxAPRmUyYv2D6F0uUI65XisGOL1hBP5mTronbgo+0bFcA==", + "cpu": [ + "arm" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/@esbuild/linux-arm64": { + "version": "0.21.5", + "resolved": "https://registry.npmjs.org/@esbuild/linux-arm64/-/linux-arm64-0.21.5.tgz", + "integrity": "sha512-ibKvmyYzKsBeX8d8I7MH/TMfWDXBF3db4qM6sy+7re0YXya+K1cem3on9XgdT2EQGMu4hQyZhan7TeQ8XkGp4Q==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/@esbuild/linux-ia32": { + "version": "0.21.5", + "resolved": "https://registry.npmjs.org/@esbuild/linux-ia32/-/linux-ia32-0.21.5.tgz", + "integrity": "sha512-YvjXDqLRqPDl2dvRODYmmhz4rPeVKYvppfGYKSNGdyZkA01046pLWyRKKI3ax8fbJoK5QbxblURkwK/MWY18Tg==", + "cpu": [ + "ia32" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/@esbuild/linux-loong64": { + "version": "0.21.5", + "resolved": "https://registry.npmjs.org/@esbuild/linux-loong64/-/linux-loong64-0.21.5.tgz", + "integrity": "sha512-uHf1BmMG8qEvzdrzAqg2SIG/02+4/DHB6a9Kbya0XDvwDEKCoC8ZRWI5JJvNdUjtciBGFQ5PuBlpEOXQj+JQSg==", + "cpu": [ + "loong64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/@esbuild/linux-mips64el": { + "version": "0.21.5", + "resolved": "https://registry.npmjs.org/@esbuild/linux-mips64el/-/linux-mips64el-0.21.5.tgz", + "integrity": "sha512-IajOmO+KJK23bj52dFSNCMsz1QP1DqM6cwLUv3W1QwyxkyIWecfafnI555fvSGqEKwjMXVLokcV5ygHW5b3Jbg==", + "cpu": [ + "mips64el" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/@esbuild/linux-ppc64": { + "version": "0.21.5", + "resolved": "https://registry.npmjs.org/@esbuild/linux-ppc64/-/linux-ppc64-0.21.5.tgz", + "integrity": "sha512-1hHV/Z4OEfMwpLO8rp7CvlhBDnjsC3CttJXIhBi+5Aj5r+MBvy4egg7wCbe//hSsT+RvDAG7s81tAvpL2XAE4w==", + "cpu": [ + "ppc64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/@esbuild/linux-riscv64": { + "version": "0.21.5", + "resolved": "https://registry.npmjs.org/@esbuild/linux-riscv64/-/linux-riscv64-0.21.5.tgz", + "integrity": "sha512-2HdXDMd9GMgTGrPWnJzP2ALSokE/0O5HhTUvWIbD3YdjME8JwvSCnNGBnTThKGEB91OZhzrJ4qIIxk/SBmyDDA==", + "cpu": [ + "riscv64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/@esbuild/linux-s390x": { + "version": "0.21.5", + "resolved": "https://registry.npmjs.org/@esbuild/linux-s390x/-/linux-s390x-0.21.5.tgz", + "integrity": "sha512-zus5sxzqBJD3eXxwvjN1yQkRepANgxE9lgOW2qLnmr8ikMTphkjgXu1HR01K4FJg8h1kEEDAqDcZQtbrRnB41A==", + "cpu": [ + "s390x" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/@esbuild/linux-x64": { + "version": "0.21.5", + "resolved": "https://registry.npmjs.org/@esbuild/linux-x64/-/linux-x64-0.21.5.tgz", + "integrity": "sha512-1rYdTpyv03iycF1+BhzrzQJCdOuAOtaqHTWJZCWvijKD2N5Xu0TtVC8/+1faWqcP9iBCWOmjmhoH94dH82BxPQ==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/@esbuild/netbsd-x64": { + "version": "0.21.5", + "resolved": "https://registry.npmjs.org/@esbuild/netbsd-x64/-/netbsd-x64-0.21.5.tgz", + "integrity": "sha512-Woi2MXzXjMULccIwMnLciyZH4nCIMpWQAs049KEeMvOcNADVxo0UBIQPfSmxB3CWKedngg7sWZdLvLczpe0tLg==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "netbsd" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/@esbuild/openbsd-x64": { + "version": "0.21.5", + "resolved": "https://registry.npmjs.org/@esbuild/openbsd-x64/-/openbsd-x64-0.21.5.tgz", + "integrity": "sha512-HLNNw99xsvx12lFBUwoT8EVCsSvRNDVxNpjZ7bPn947b8gJPzeHWyNVhFsaerc0n3TsbOINvRP2byTZ5LKezow==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "openbsd" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/@esbuild/sunos-x64": { + "version": "0.21.5", + "resolved": "https://registry.npmjs.org/@esbuild/sunos-x64/-/sunos-x64-0.21.5.tgz", + "integrity": "sha512-6+gjmFpfy0BHU5Tpptkuh8+uw3mnrvgs+dSPQXQOv3ekbordwnzTVEb4qnIvQcYXq6gzkyTnoZ9dZG+D4garKg==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "sunos" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/@esbuild/win32-arm64": { + "version": "0.21.5", + "resolved": "https://registry.npmjs.org/@esbuild/win32-arm64/-/win32-arm64-0.21.5.tgz", + "integrity": "sha512-Z0gOTd75VvXqyq7nsl93zwahcTROgqvuAcYDUr+vOv8uHhNSKROyU961kgtCD1e95IqPKSQKH7tBTslnS3tA8A==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "win32" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/@esbuild/win32-ia32": { + "version": "0.21.5", + "resolved": "https://registry.npmjs.org/@esbuild/win32-ia32/-/win32-ia32-0.21.5.tgz", + "integrity": "sha512-SWXFF1CL2RVNMaVs+BBClwtfZSvDgtL//G/smwAc5oVK/UPu2Gu9tIaRgFmYFFKrmg3SyAjSrElf0TiJ1v8fYA==", + "cpu": [ + "ia32" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "win32" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/@esbuild/win32-x64": { + "version": "0.21.5", + "resolved": "https://registry.npmjs.org/@esbuild/win32-x64/-/win32-x64-0.21.5.tgz", + "integrity": "sha512-tQd/1efJuzPC6rCFwEvLtci/xNFcTZknmXs98FYDfGE4wP9ClFV98nyKrzJKVPMhdDnjzLhdUyMX4PsQAPjwIw==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "win32" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/@rollup/rollup-android-arm-eabi": { + "version": "4.50.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-android-arm-eabi/-/rollup-android-arm-eabi-4.50.0.tgz", + "integrity": "sha512-lVgpeQyy4fWN5QYebtW4buT/4kn4p4IJ+kDNB4uYNT5b8c8DLJDg6titg20NIg7E8RWwdWZORW6vUFfrLyG3KQ==", + "cpu": [ + "arm" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "android" + ] + }, + "node_modules/@rollup/rollup-android-arm64": { + "version": "4.50.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-android-arm64/-/rollup-android-arm64-4.50.0.tgz", + "integrity": "sha512-2O73dR4Dc9bp+wSYhviP6sDziurB5/HCym7xILKifWdE9UsOe2FtNcM+I4xZjKrfLJnq5UR8k9riB87gauiQtw==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "android" + ] + }, + "node_modules/@rollup/rollup-darwin-arm64": { + "version": "4.50.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-darwin-arm64/-/rollup-darwin-arm64-4.50.0.tgz", + "integrity": "sha512-vwSXQN8T4sKf1RHr1F0s98Pf8UPz7pS6P3LG9NSmuw0TVh7EmaE+5Ny7hJOZ0M2yuTctEsHHRTMi2wuHkdS6Hg==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "darwin" + ] + }, + "node_modules/@rollup/rollup-darwin-x64": { + "version": "4.50.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-darwin-x64/-/rollup-darwin-x64-4.50.0.tgz", + "integrity": "sha512-cQp/WG8HE7BCGyFVuzUg0FNmupxC+EPZEwWu2FCGGw5WDT1o2/YlENbm5e9SMvfDFR6FRhVCBePLqj0o8MN7Vw==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "darwin" + ] + }, + "node_modules/@rollup/rollup-freebsd-arm64": { + "version": "4.50.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-freebsd-arm64/-/rollup-freebsd-arm64-4.50.0.tgz", + "integrity": "sha512-UR1uTJFU/p801DvvBbtDD7z9mQL8J80xB0bR7DqW7UGQHRm/OaKzp4is7sQSdbt2pjjSS72eAtRh43hNduTnnQ==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "freebsd" + ] + }, + "node_modules/@rollup/rollup-freebsd-x64": { + "version": "4.50.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-freebsd-x64/-/rollup-freebsd-x64-4.50.0.tgz", + "integrity": "sha512-G/DKyS6PK0dD0+VEzH/6n/hWDNPDZSMBmqsElWnCRGrYOb2jC0VSupp7UAHHQ4+QILwkxSMaYIbQ72dktp8pKA==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "freebsd" + ] + }, + "node_modules/@rollup/rollup-linux-arm-gnueabihf": { + "version": "4.50.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm-gnueabihf/-/rollup-linux-arm-gnueabihf-4.50.0.tgz", + "integrity": "sha512-u72Mzc6jyJwKjJbZZcIYmd9bumJu7KNmHYdue43vT1rXPm2rITwmPWF0mmPzLm9/vJWxIRbao/jrQmxTO0Sm9w==", + "cpu": [ + "arm" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-arm-musleabihf": { + "version": "4.50.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm-musleabihf/-/rollup-linux-arm-musleabihf-4.50.0.tgz", + "integrity": "sha512-S4UefYdV0tnynDJV1mdkNawp0E5Qm2MtSs330IyHgaccOFrwqsvgigUD29uT+B/70PDY1eQ3t40+xf6wIvXJyg==", + "cpu": [ + "arm" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-arm64-gnu": { + "version": "4.50.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm64-gnu/-/rollup-linux-arm64-gnu-4.50.0.tgz", + "integrity": "sha512-1EhkSvUQXJsIhk4msxP5nNAUWoB4MFDHhtc4gAYvnqoHlaL9V3F37pNHabndawsfy/Tp7BPiy/aSa6XBYbaD1g==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-arm64-musl": { + "version": "4.50.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm64-musl/-/rollup-linux-arm64-musl-4.50.0.tgz", + "integrity": "sha512-EtBDIZuDtVg75xIPIK1l5vCXNNCIRM0OBPUG+tbApDuJAy9mKago6QxX+tfMzbCI6tXEhMuZuN1+CU8iDW+0UQ==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-loongarch64-gnu": { + "version": "4.50.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-loongarch64-gnu/-/rollup-linux-loongarch64-gnu-4.50.0.tgz", + "integrity": "sha512-BGYSwJdMP0hT5CCmljuSNx7+k+0upweM2M4YGfFBjnFSZMHOLYR0gEEj/dxyYJ6Zc6AiSeaBY8dWOa11GF/ppQ==", + "cpu": [ + "loong64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-ppc64-gnu": { + "version": "4.50.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-ppc64-gnu/-/rollup-linux-ppc64-gnu-4.50.0.tgz", + "integrity": "sha512-I1gSMzkVe1KzAxKAroCJL30hA4DqSi+wGc5gviD0y3IL/VkvcnAqwBf4RHXHyvH66YVHxpKO8ojrgc4SrWAnLg==", + "cpu": [ + "ppc64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-riscv64-gnu": { + "version": "4.50.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-riscv64-gnu/-/rollup-linux-riscv64-gnu-4.50.0.tgz", + "integrity": "sha512-bSbWlY3jZo7molh4tc5dKfeSxkqnf48UsLqYbUhnkdnfgZjgufLS/NTA8PcP/dnvct5CCdNkABJ56CbclMRYCA==", + "cpu": [ + "riscv64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-riscv64-musl": { + "version": "4.50.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-riscv64-musl/-/rollup-linux-riscv64-musl-4.50.0.tgz", + "integrity": "sha512-LSXSGumSURzEQLT2e4sFqFOv3LWZsEF8FK7AAv9zHZNDdMnUPYH3t8ZlaeYYZyTXnsob3htwTKeWtBIkPV27iQ==", + "cpu": [ + "riscv64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-s390x-gnu": { + "version": "4.50.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-s390x-gnu/-/rollup-linux-s390x-gnu-4.50.0.tgz", + "integrity": "sha512-CxRKyakfDrsLXiCyucVfVWVoaPA4oFSpPpDwlMcDFQvrv3XY6KEzMtMZrA+e/goC8xxp2WSOxHQubP8fPmmjOQ==", + "cpu": [ + "s390x" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-x64-gnu": { + "version": "4.50.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-x64-gnu/-/rollup-linux-x64-gnu-4.50.0.tgz", + "integrity": "sha512-8PrJJA7/VU8ToHVEPu14FzuSAqVKyo5gg/J8xUerMbyNkWkO9j2ExBho/68RnJsMGNJq4zH114iAttgm7BZVkA==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-x64-musl": { + "version": "4.50.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-x64-musl/-/rollup-linux-x64-musl-4.50.0.tgz", + "integrity": "sha512-SkE6YQp+CzpyOrbw7Oc4MgXFvTw2UIBElvAvLCo230pyxOLmYwRPwZ/L5lBe/VW/qT1ZgND9wJfOsdy0XptRvw==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-openharmony-arm64": { + "version": "4.50.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-openharmony-arm64/-/rollup-openharmony-arm64-4.50.0.tgz", + "integrity": "sha512-PZkNLPfvXeIOgJWA804zjSFH7fARBBCpCXxgkGDRjjAhRLOR8o0IGS01ykh5GYfod4c2yiiREuDM8iZ+pVsT+Q==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "openharmony" + ] + }, + "node_modules/@rollup/rollup-win32-arm64-msvc": { + "version": "4.50.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-win32-arm64-msvc/-/rollup-win32-arm64-msvc-4.50.0.tgz", + "integrity": "sha512-q7cIIdFvWQoaCbLDUyUc8YfR3Jh2xx3unO8Dn6/TTogKjfwrax9SyfmGGK6cQhKtjePI7jRfd7iRYcxYs93esg==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "win32" + ] + }, + "node_modules/@rollup/rollup-win32-ia32-msvc": { + "version": "4.50.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-win32-ia32-msvc/-/rollup-win32-ia32-msvc-4.50.0.tgz", + "integrity": "sha512-XzNOVg/YnDOmFdDKcxxK410PrcbcqZkBmz+0FicpW5jtjKQxcW1BZJEQOF0NJa6JO7CZhett8GEtRN/wYLYJuw==", + "cpu": [ + "ia32" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "win32" + ] + }, + "node_modules/@rollup/rollup-win32-x64-msvc": { + "version": "4.50.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-win32-x64-msvc/-/rollup-win32-x64-msvc-4.50.0.tgz", + "integrity": "sha512-xMmiWRR8sp72Zqwjgtf3QbZfF1wdh8X2ABu3EaozvZcyHJeU0r+XAnXdKgs4cCAp6ORoYoCygipYP1mjmbjrsg==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "win32" + ] + }, + "node_modules/@types/estree": { + "version": "1.0.8", + "resolved": "https://registry.npmjs.org/@types/estree/-/estree-1.0.8.tgz", + "integrity": "sha512-dWHzHa2WqEXI/O1E9OjrocMTKJl2mSrEolh1Iomrv6U+JuNwaHXsXx9bLu5gG7BUWFIN0skIQJQ/L1rIex4X6w==", + "dev": true, + "license": "MIT" + }, + "node_modules/@wailsio/runtime": { + "version": "3.0.0-alpha.66", + "resolved": "https://registry.npmjs.org/@wailsio/runtime/-/runtime-3.0.0-alpha.66.tgz", + "integrity": "sha512-ENLu8rn1griL1gFHJqkq1i+BVxrrA0JPJHYneUJYuf/s54kjuQViW0RKDEe/WTDo56ABpfykrd/T8OYpPUyXUw==", + "license": "MIT" + }, + "node_modules/esbuild": { + "version": "0.21.5", + "resolved": "https://registry.npmjs.org/esbuild/-/esbuild-0.21.5.tgz", + "integrity": "sha512-mg3OPMV4hXywwpoDxu3Qda5xCKQi+vCTZq8S9J/EpkhB2HzKXq4SNFZE3+NK93JYxc8VMSep+lOUSC/RVKaBqw==", + "dev": true, + "hasInstallScript": true, + "license": "MIT", + "bin": { + "esbuild": "bin/esbuild" + }, + "engines": { + "node": ">=12" + }, + "optionalDependencies": { + "@esbuild/aix-ppc64": "0.21.5", + "@esbuild/android-arm": "0.21.5", + "@esbuild/android-arm64": "0.21.5", + "@esbuild/android-x64": "0.21.5", + "@esbuild/darwin-arm64": "0.21.5", + "@esbuild/darwin-x64": "0.21.5", + "@esbuild/freebsd-arm64": "0.21.5", + "@esbuild/freebsd-x64": "0.21.5", + "@esbuild/linux-arm": "0.21.5", + "@esbuild/linux-arm64": "0.21.5", + "@esbuild/linux-ia32": "0.21.5", + "@esbuild/linux-loong64": "0.21.5", + "@esbuild/linux-mips64el": "0.21.5", + "@esbuild/linux-ppc64": "0.21.5", + "@esbuild/linux-riscv64": "0.21.5", + "@esbuild/linux-s390x": "0.21.5", + "@esbuild/linux-x64": "0.21.5", + "@esbuild/netbsd-x64": "0.21.5", + "@esbuild/openbsd-x64": "0.21.5", + "@esbuild/sunos-x64": "0.21.5", + "@esbuild/win32-arm64": "0.21.5", + "@esbuild/win32-ia32": "0.21.5", + "@esbuild/win32-x64": "0.21.5" + } + }, + "node_modules/fsevents": { + "version": "2.3.3", + "resolved": "https://registry.npmjs.org/fsevents/-/fsevents-2.3.3.tgz", + "integrity": "sha512-5xoDfX+fL7faATnagmWPpbFtwh/R77WmMMqqHGS65C3vvB0YHrgF+B1YmZ3441tMj5n63k0212XNoJwzlhffQw==", + "dev": true, + "hasInstallScript": true, + "license": "MIT", + "optional": true, + "os": [ + "darwin" + ], + "engines": { + "node": "^8.16.0 || ^10.6.0 || >=11.0.0" + } + }, + "node_modules/nanoid": { + "version": "3.3.11", + "resolved": "https://registry.npmjs.org/nanoid/-/nanoid-3.3.11.tgz", + "integrity": "sha512-N8SpfPUnUp1bK+PMYW8qSWdl9U+wwNWI4QKxOYDy9JAro3WMX7p2OeVRF9v+347pnakNevPmiHhNmZ2HbFA76w==", + "dev": true, + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/ai" + } + ], + "license": "MIT", + "bin": { + "nanoid": "bin/nanoid.cjs" + }, + "engines": { + "node": "^10 || ^12 || ^13.7 || ^14 || >=15.0.1" + } + }, + "node_modules/picocolors": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/picocolors/-/picocolors-1.1.1.tgz", + "integrity": "sha512-xceH2snhtb5M9liqDsmEw56le376mTZkEX/jEb/RxNFyegNul7eNslCXP9FDj/Lcu0X8KEyMceP2ntpaHrDEVA==", + "dev": true, + "license": "ISC" + }, + "node_modules/postcss": { + "version": "8.5.6", + "resolved": "https://registry.npmjs.org/postcss/-/postcss-8.5.6.tgz", + "integrity": "sha512-3Ybi1tAuwAP9s0r1UQ2J4n5Y0G05bJkpUIO0/bI9MhwmD70S5aTWbXGBwxHrelT+XM1k6dM0pk+SwNkpTRN7Pg==", + "dev": true, + "funding": [ + { + "type": "opencollective", + "url": "https://opencollective.com/postcss/" + }, + { + "type": "tidelift", + "url": "https://tidelift.com/funding/github/npm/postcss" + }, + { + "type": "github", + "url": "https://github.com/sponsors/ai" + } + ], + "license": "MIT", + "dependencies": { + "nanoid": "^3.3.11", + "picocolors": "^1.1.1", + "source-map-js": "^1.2.1" + }, + "engines": { + "node": "^10 || ^12 || >=14" + } + }, + "node_modules/rollup": { + "version": "4.50.0", + "resolved": "https://registry.npmjs.org/rollup/-/rollup-4.50.0.tgz", + "integrity": "sha512-/Zl4D8zPifNmyGzJS+3kVoyXeDeT/GrsJM94sACNg9RtUE0hrHa1bNPtRSrfHTMH5HjRzce6K7rlTh3Khiw+pw==", + "dev": true, + "license": "MIT", + "dependencies": { + "@types/estree": "1.0.8" + }, + "bin": { + "rollup": "dist/bin/rollup" + }, + "engines": { + "node": ">=18.0.0", + "npm": ">=8.0.0" + }, + "optionalDependencies": { + "@rollup/rollup-android-arm-eabi": "4.50.0", + "@rollup/rollup-android-arm64": "4.50.0", + "@rollup/rollup-darwin-arm64": "4.50.0", + "@rollup/rollup-darwin-x64": "4.50.0", + "@rollup/rollup-freebsd-arm64": "4.50.0", + "@rollup/rollup-freebsd-x64": "4.50.0", + "@rollup/rollup-linux-arm-gnueabihf": "4.50.0", + "@rollup/rollup-linux-arm-musleabihf": "4.50.0", + "@rollup/rollup-linux-arm64-gnu": "4.50.0", + "@rollup/rollup-linux-arm64-musl": "4.50.0", + "@rollup/rollup-linux-loongarch64-gnu": "4.50.0", + "@rollup/rollup-linux-ppc64-gnu": "4.50.0", + "@rollup/rollup-linux-riscv64-gnu": "4.50.0", + "@rollup/rollup-linux-riscv64-musl": "4.50.0", + "@rollup/rollup-linux-s390x-gnu": "4.50.0", + "@rollup/rollup-linux-x64-gnu": "4.50.0", + "@rollup/rollup-linux-x64-musl": "4.50.0", + "@rollup/rollup-openharmony-arm64": "4.50.0", + "@rollup/rollup-win32-arm64-msvc": "4.50.0", + "@rollup/rollup-win32-ia32-msvc": "4.50.0", + "@rollup/rollup-win32-x64-msvc": "4.50.0", + "fsevents": "~2.3.2" + } + }, + "node_modules/source-map-js": { + "version": "1.2.1", + "resolved": "https://registry.npmjs.org/source-map-js/-/source-map-js-1.2.1.tgz", + "integrity": "sha512-UXWMKhLOwVKb728IUtQPXxfYU+usdybtUrK/8uGE8CQMvrhOpwvzDBwj0QhSL7MQc7vIsISBG8VQ8+IDQxpfQA==", + "dev": true, + "license": "BSD-3-Clause", + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/vite": { + "version": "5.4.19", + "resolved": "https://registry.npmjs.org/vite/-/vite-5.4.19.tgz", + "integrity": "sha512-qO3aKv3HoQC8QKiNSTuUM1l9o/XX3+c+VTgLHbJWHZGeTPVAg2XwazI9UWzoxjIJCGCV2zU60uqMzjeLZuULqA==", + "dev": true, + "license": "MIT", + "dependencies": { + "esbuild": "^0.21.3", + "postcss": "^8.4.43", + "rollup": "^4.20.0" + }, + "bin": { + "vite": "bin/vite.js" + }, + "engines": { + "node": "^18.0.0 || >=20.0.0" + }, + "funding": { + "url": "https://github.com/vitejs/vite?sponsor=1" + }, + "optionalDependencies": { + "fsevents": "~2.3.3" + }, + "peerDependencies": { + "@types/node": "^18.0.0 || >=20.0.0", + "less": "*", + "lightningcss": "^1.21.0", + "sass": "*", + "sass-embedded": "*", + "stylus": "*", + "sugarss": "*", + "terser": "^5.4.0" + }, + "peerDependenciesMeta": { + "@types/node": { + "optional": true + }, + "less": { + "optional": true + }, + "lightningcss": { + "optional": true + }, + "sass": { + "optional": true + }, + "sass-embedded": { + "optional": true + }, + "stylus": { + "optional": true + }, + "sugarss": { + "optional": true + }, + "terser": { + "optional": true + } + } + } + } +} diff --git a/v3/examples/android/frontend/package.json b/v3/examples/android/frontend/package.json new file mode 100644 index 000000000..0a118e984 --- /dev/null +++ b/v3/examples/android/frontend/package.json @@ -0,0 +1,18 @@ +{ + "name": "frontend", + "private": true, + "version": "0.0.0", + "type": "module", + "scripts": { + "dev": "vite", + "build:dev": "vite build --minify false --mode development", + "build": "vite build --mode production", + "preview": "vite preview" + }, + "dependencies": { + "@wailsio/runtime": "latest" + }, + "devDependencies": { + "vite": "^5.0.0" + } +} diff --git a/v3/examples/android/frontend/public/Inter-Medium.ttf b/v3/examples/android/frontend/public/Inter-Medium.ttf new file mode 100644 index 000000000..a01f3777a Binary files /dev/null and b/v3/examples/android/frontend/public/Inter-Medium.ttf differ diff --git a/v3/examples/android/frontend/public/javascript.svg b/v3/examples/android/frontend/public/javascript.svg new file mode 100644 index 000000000..f9abb2b72 --- /dev/null +++ b/v3/examples/android/frontend/public/javascript.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/v3/examples/android/frontend/public/puppertino/LICENSE b/v3/examples/android/frontend/public/puppertino/LICENSE new file mode 100644 index 000000000..ed9065e06 --- /dev/null +++ b/v3/examples/android/frontend/public/puppertino/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2019 Edgar Pérez + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/v3/examples/android/frontend/public/puppertino/css/actions.css b/v3/examples/android/frontend/public/puppertino/css/actions.css new file mode 100644 index 000000000..22a9d5a13 --- /dev/null +++ b/v3/examples/android/frontend/public/puppertino/css/actions.css @@ -0,0 +1,149 @@ +:root { + --font: -apple-system, "Inter", sans-serif; + --primary-col-ac: #0f75f5; + --p-modal-bg: rgba(255, 255, 255, 0.8); + --p-modal-bd-color: rgba(0,0,0,.1); + --p-modal-fallback-color: rgba(255,255,255,.95); + --p-actions-static-color: #555761; +} + +.p-modal-opened { + overflow: hidden; +} + +.p-action-background{ + background: rgba(0, 0, 0, 0.7); + height: 100vh; + left: 0; + opacity: 0; + pointer-events: none; + position: fixed; + top: 0; + transition: 0.3s; + width: 100vw; + z-index: 5; +} + +.p-action-background.nowactive { + opacity: 1; + pointer-events: auto; +} + + +.p-action-big-container{ + position:fixed; + width: 100%; + box-sizing: border-box; + padding: 1rem 5vw; + bottom:0; +} + +.p-action-container{ + background: var(--p-modal-bg); + display:block; + margin:auto; + margin-bottom: 10px; + border-radius: 10px; + max-width: 700px; +} + +.p-action-big-container .p-action-container:first-child{ + margin-bottom:10px; +} + +.p-action--intern{ + width: 100%; + display:block; + margin:auto; + font-size: 1rem; + font-weight: 600; + text-align:center; + padding: 15px 0; + border: 0; + border-bottom: 1px solid #bfbfbf; + color: #0f75f5; + text-decoration:none; + background-color: transparent; +} + +.p-action-destructive{ + color: #c6262e; +} + +.p-action-neutral{ + color: var(--p-actions-static-color); +} + +.p-action-cancel, .p-action-container a:last-child{ + border-bottom:none; +} + +.p-action-cancel{ + font-weight:bold; +} + +.p-action-icon{ + position:relative; +} +.p-action-icon svg, .p-action-icon img{ + position:absolute; + left:5%; + top:50%; + transform:translateY(-50%); +} + +.p-action-icon-inline{ + text-align: left; + display: flex; + align-items: center; +} + +.p-action-icon-inline svg, .p-action-icon-inline img{ + margin-left: 5%; + margin-right: 3%; +} + +.p-action-title{ + padding: 30px 15px; + border-bottom: 1px solid #bfbfbf; +} + +.p-action-title--intern,.p-action-text{ + margin:0; + color:var(--p-actions-static-color); +} + +.p-action-title--intern{ + margin-bottom: .3rem; +} + +@supports not (backdrop-filter: blur(10px)) { + .p-action-container { + background: var(--p-modal-fallback-color); + } +} + +.p-action-big-container{ + -webkit-transform: translateY(30%); + transform: translateY(30%); + opacity: 0; + transition: opacity 0.4s, transform 0.4s; + transition-timing-function: ease; + pointer-events: none; +} + +.p-action-big-container.active { + -webkit-transform: translateY(0); + transform: translateY(0); + opacity: 1; + pointer-events: all; +} + + +.p-action-big-container.active .p-action-container { + backdrop-filter: saturate(180%) blur(10px); +} + +.p-action-big-container[aria-hidden="true"] .p-action--intern { + display: none; +} diff --git a/v3/examples/android/frontend/public/puppertino/css/buttons.css b/v3/examples/android/frontend/public/puppertino/css/buttons.css new file mode 100644 index 000000000..4950b0053 --- /dev/null +++ b/v3/examples/android/frontend/public/puppertino/css/buttons.css @@ -0,0 +1,158 @@ +@charset "UTF-8"; +:root{ + --p-btn-border: #cacaca; + --p-btn-def-bg: #FFFFFF; + --p-btn-def-col: #000000; + --p-btn-dir-col: #242424; + --p-prim-text-col: #f5f5f5; + --p-btn-scope-unactive: #212136; + --p-btn-scope-action: #212136; +} + +.p-btn { + background: var(--p-btn-def-bg); + border: 1px solid var(--p-btn-border); + border-radius: 10px; + color: var(--p-btn-def-col); + display: inline-block; + font-family: -apple-system, "Inter", sans-serif; + font-size: 1.1rem; + margin: .7rem; + padding: .4rem 1.2rem; + text-decoration: none; + text-align: center; + box-shadow: 0 1px 0.375px rgba(0, 0, 0, 0.05), 0 0.25px 0.375px rgba(0, 0, 0, 0.15); + user-select: none; + cursor: pointer; +} +.p-btn:focus{ + outline: 2px solid #64baff; +} +.p-btn.p-btn-block{ + display: block; +} +.p-btn.p-btn-sm { + padding: .3rem 1.1rem; + font-size: 1rem; +} +.p-btn.p-btn-md { + padding: .8rem 2.4rem; + font-size: 1.6rem; +} +.p-btn.p-btn-lg { + padding: 1.2rem 2.8rem; + font-size: 1.8rem; +} +.p-btn-destructive{ + color: #FF3B30; +} +.p-btn-mob{ + padding: 10px 40px; + background: #227bec; + color: #fff; + border: 0; + box-shadow: inset 0 1px 1px rgb(255 255 255 / 41%), 0px 2px 3px -2px rgba(0,0,0,.3); +} +.p-btn[disabled], +.p-btn:disabled, +.p-btn-disabled{ + filter:contrast(0.5) grayscale(.5) opacity(.8); + cursor: not-allowed; + box-shadow: none; + pointer-events: none; +} + +.p-prim-col { + position: relative; + background: #007AFF; + border: none; + box-shadow: inset 0 1px 1px rgba(255, 255, 255, 0.41), 0px 2px 3px -2px rgba(0, 0, 0, 0.3); + color: var(--p-prim-text-col); + overflow: hidden; /* Ensure the ::before element doesn't overflow */ +} + +.p-prim-col:before { + content: ''; + position: absolute; + top: 0; + left: 0; + width: 100%; + height: 100%; + background: linear-gradient(180deg, rgba(255, 255, 255, 1) 0%, rgba(255, 255, 255, 0) 100%); + opacity: 0.17; + pointer-events: none; +} + +.p-btn.p-prim-col:active { + background: #0f75f5; +} + +.p-btn-more::after { + content: "..."; +} + +.p-btn-round { + border: 0; + border-radius: 50px; + box-shadow: inset 0 1px 1px rgb(255 255 255 / 41%); + padding: 10px 30px; +} + +.p-btn-icon { + align-items: center; + background: var(--p-btn-def-bg); + border: 2px solid currentColor; + border-radius: 50%; + color: #0f75f5; + display: inline-flex; + font-weight: 900; + height: 40px; + width: 40px; + justify-content: center; + margin: 5px; + text-align: center; + text-decoration: none; + box-sizing: border-box; + user-select: none; + vertical-align: bottom; +} + +.p-btn-icon.p-btn-icon-no-border{ + border: 0px; +} + +.p-btn-scope { + background: #8e8e8e; + color: #fff; + margin: 5px; + padding: 2px 20px; + box-shadow: none; +} +.p-btn-scope-unactive { + background: transparent; + border-color: transparent; + color: var(--p-btn-scope-unactive); + transition: border-color 0.2s; +} +.p-btn-scope-unactive:hover { + border-color: var(--p-btn-border); +} + +.p-btn-scope-outline { + background: transparent; + color: var(--p-btn-scope-action); + box-shadow: none; +} + +.p-btn-outline { + background: none; + border-color: currentColor; + box-shadow: none; +} + +.p-btn-outline-dash { + background: none; + border-color: currentColor; + border-style: dashed; + box-shadow: none; +} diff --git a/v3/examples/android/frontend/public/puppertino/css/cards.css b/v3/examples/android/frontend/public/puppertino/css/cards.css new file mode 100644 index 000000000..b4fa2e397 --- /dev/null +++ b/v3/examples/android/frontend/public/puppertino/css/cards.css @@ -0,0 +1,55 @@ +:root{ + --p-color-card: #1a1a1a; + --p-bg-card: #fff; + --p-bd-card: #c5c5c55e; +} +.p-card { + background: var(--p-bg-card); + border: 1px solid var(--p-bd-card); + color: var(--p-color-card); + display: block; + margin: 15px; + margin-left:7.5px; + margin-right:7.5px; + text-decoration: none; + border-radius: 25px; + padding: 20px 0px; + transition: .3s ease; + box-shadow: 0 0.5px 1px rgba(0, 0, 0, 0.1); +} +.p-card-image > img { + border-bottom: 3px solid var(--accent-article); + display: block; + margin: auto; + width: 100%; +} +.p-card-tags { + display: flex; + overflow: hidden; + position: relative; + width: 100%; +} +.p-card-tags::before { + background: linear-gradient(to right, rgba(255, 255, 255, 0) 0%, rgba(255, 255, 255, 0) 75%, white 100%); + content: ""; + height: 100%; + position: absolute; + right: 0; + top: 0; + width: 30%; +} +.p-card-title { + font-size: 2rem; + margin-bottom: 15px; + margin-top: 15px; +} +.p-card-content { + padding: 15px; + padding-top: 15px; +} +.p-card-text { + font-size: 17px; + margin-bottom: 10px; + margin-left: 10px; + margin-top: 0; +} diff --git a/v3/examples/android/frontend/public/puppertino/css/color_palette.css b/v3/examples/android/frontend/public/puppertino/css/color_palette.css new file mode 100644 index 000000000..33a66b91c --- /dev/null +++ b/v3/examples/android/frontend/public/puppertino/css/color_palette.css @@ -0,0 +1,917 @@ +:root{ +--p-strawberry: #c6262e; +--p-strawberry-100: #ff8c82; +--p-strawberry-300: #ed5353; +--p-strawberry-500: #c6262e; +--p-strawberry-700: #a10705; +--p-strawberry-900: #7a0000; + +--p-orange: #f37329; +--p-orange-100: #ffc27d; +--p-orange-300: #ffa154; +--p-orange-500: #f37329; +--p-orange-700: #cc3b02; +--p-orange-900: #a62100; + + +--p-banana: #f9c440; +--p-banana-100: #fff394; +--p-banana-300: #ffe16b; +--p-banana-500: #f9c440; +--p-banana-700: #d48e15; +--p-banana-900: #ad5f00; + +--p-lime: #68b723; +--p-lime-100: #d1ff82; +--p-lime-300: #9bdb4d; +--p-lime-500: #68b723; +--p-lime-700: #3a9104; +--p-lime-900: #206b00; + +--p-mint: #28bca3; +--p-mint-100: #89ffdd; +--p-mint-300: #43d6b5; +--p-mint-500: #28bca3; +--p-mint-700: #0e9a83; +--p-mint-900: #007367; + + +--p-blueberry: #3689e6; +--p-blueberry-100: #8cd5ff; +--p-blueberry-300: #64baff; +--p-blueberry-500: #3689e6; +--p-blueberry-700: #0d52bf; +--p-blueberry-900: #002e99; + +--p-grape: #a56de2; +--p-grape-100: #e4c6fa; +--p-grape-300: #cd9ef7; +--p-grape-500: #a56de2; +--p-grape-700: #7239b3; +--p-grape-900: #452981; + +--p-bubblegum: #de3e80; +--p-bubblegum-100: #fe9ab8; +--p-bubblegum-300: #f4679d; +--p-bubblegum-500: #de3e80; +--p-bubblegum-700: #bc245d; +--p-bubblegum-900: #910e38; + + +--p-cocoa: #715344; +--p-cocoa-100: #a3907c; +--p-cocoa-300: #8a715e; +--p-cocoa-500: #715344; +--p-cocoa-700: #57392d; +--p-cocoa-900: #3d211b; + +--p-silver: #abacae; +--p-silver-100: #fafafa; +--p-silver-300: #d4d4d4; +--p-silver-500: #abacae; +--p-silver-700: #7e8087; +--p-silver-900: #555761; + +--p-slate: #485a6c; +--p-slate-100: #95a3ab; +--p-slate-300: #667885; +--p-slate-500: #485a6c; +--p-slate-700: #273445; +--p-slate-900: #0e141f; + + +--p-dark: #333; +--p-dark-100: #666; +--p-dark-300: #4d4d4d; +--p-dark-500: #333; +--p-dark-700: #1a1a1a; +--p-dark-900: #000; + + +--p-apple-red: rgb(255, 59 , 48); +--p-apple-red-dark: rgb(255, 69 , 58); +--p-apple-orange: rgb(255,149,0); +--p-apple-orange-dark: rgb(255,159,10); +--p-apple-yellow: rgb(255,204,0); +--p-apple-yellow-dark: rgb(255,214,10); +--p-apple-green: rgb(40,205,65); +--p-apple-green-dark: rgb(40,215,75); +--p-apple-mint: rgb(0,199,190); +--p-apple-mint-dark: rgb(102,212,207); +--p-apple-teal: rgb(89, 173, 196); +--p-apple-teal-dark: rgb(106, 196, 220); +--p-apple-cyan: rgb(85,190,240); +--p-apple-cyan-dark: rgb(90,200,245); +--p-apple-blue: rgb(0, 122, 255); +--p-apple-blue-dark: rgb(10, 132, 255); +--p-apple-indigo: rgb(88, 86, 214); +--p-apple-indigo-dark: rgb(94, 92, 230); +--p-apple-purple: rgb(175, 82, 222); +--p-apple-purple-dark: rgb(191, 90, 242); +--p-apple-pink: rgb(255, 45, 85); +--p-apple-pink-dark: rgb(255, 55, 95); +--p-apple-brown: rgb(162, 132, 94); +--p-apple-brown-dark: rgb(172, 142, 104); +--p-apple-gray: rgb(142, 142, 147); +--p-apple-gray-dark: rgb(152, 152, 157); + +} + + +/* +APPLE OFFICIAL COLORS +*/ + +.p-apple-red{ + background: rgb(255, 59 , 48); +} + +.p-apple-red-dark{ + background: rgb(255, 69 , 58); +} + +.p-apple-orange{ + background: rgb(255,149,0); +} + +.p-apple-orange-dark{ + background: rgb(255,159,10); +} + +.p-apple-yellow{ + background: rgb(255,204,0); +} + +.p-apple-yellow-dark{ + background: rgb(255,214,10); +} + +.p-apple-green{ + background: rgb(40,205,65); +} + +.p-apple-green-dark{ + background: rgb(40,215,75); +} + +.p-apple-mint{ + background: rgb(0,199,190); +} + +.p-apple-mint-dark{ + background: rgb(102,212,207); +} + +.p-apple-teal{ + background: rgb(89, 173, 196); +} + +.p-apple-teal-dark{ + background: rgb(106, 196, 220); +} + +.p-apple-cyan{ + background: rgb(85,190,240); +} + +.p-apple-cyan-dark{ + background: rgb(90,200,245); +} + +.p-apple-blue{ + background: rgb(0, 122, 255); +} + +.p-apple-blue-dark{ + background: rgb(10, 132, 255); +} + +.p-apple-indigo{ + background: rgb(88, 86, 214); +} + +.p-apple-indigo-dark{ + background: rgb(94, 92, 230); +} + +.p-apple-purple{ + background: rgb(175, 82, 222); +} + +.p-apple-purple-dark{ + background: rgb(191, 90, 242); +} + +.p-apple-pink{ + background: rgb(255, 45, 85); +} + +.p-apple-pink-dark{ + background: rgb(255, 55, 95); +} + +.p-apple-brown{ + background: rgb(162, 132, 94); +} + +.p-apple-brown-dark{ + background: rgb(172, 142, 104); +} + +.p-apple-gray{ + background: rgb(142, 142, 147); +} + +.p-apple-gray-dark{ + background: rgb(152, 152, 157); +} + +.p-apple-red-color{ + color: rgb(255, 59 , 48); +} + +.p-apple-red-dark-color{ + color: rgb(255, 69 , 58); +} + +.p-apple-orange-color{ + color: rgb(255,149,0); +} + +.p-apple-orange-dark-color{ + color: rgb(255,159,10); +} + +.p-apple-yellow-color{ + color: rgb(255,204,0); +} + +.p-apple-yellow-dark-color{ + color: rgb(255,214,10); +} + +.p-apple-green-color{ + color: rgb(40,205,65); +} + +.p-apple-green-dark-color{ + color: rgb(40,215,75); +} + +.p-apple-mint-color{ + color: rgb(0,199,190); +} + +.p-apple-mint-dark-color{ + color: rgb(102,212,207); +} + +.p-apple-teal-color{ + color: rgb(89, 173, 196); +} + +.p-apple-teal-dark-color{ + color: rgb(106, 196, 220); +} + +.p-apple-cyan-color{ + color: rgb(85,190,240); +} + +.p-apple-cyan-dark-color{ + color: rgb(90,200,245); +} + +.p-apple-blue-color{ + color: rgb(0, 122, 255); +} + +.p-apple-blue-dark-color{ + color: rgb(10, 132, 255); +} + +.p-apple-indigo-color{ + color: rgb(88, 86, 214); +} + +.p-apple-indigo-dark-color{ + color: rgb(94, 92, 230); +} + +.p-apple-purple-color{ + color: rgb(175, 82, 222); +} + +.p-apple-purple-dark-color{ + color: rgb(191, 90, 242); +} + +.p-apple-pink-color{ + color: rgb(255, 45, 85); +} + +.p-apple-pink-dark-color{ + color: rgb(255, 55, 95); +} + +.p-apple-brown-color{ + color: rgb(162, 132, 94); +} + +.p-apple-brown-dark-color{ + color: rgb(172, 142, 104); +} + +.p-apple-gray-color{ + color: rgb(142, 142, 147); +} + +.p-apple-gray-dark-color{ + color: rgb(152, 152, 157); +} + +.p-strawberry { + background: #c6262e; +} + +.p-strawberry-100 { + background: #ff8c82; +} + +.p-strawberry-300 { + background: #ed5353; +} + +.p-strawberry-500 { + background: #c6262e; +} + +.p-strawberry-700 { + background: #a10705; +} + +.p-strawberry-900 { + background: #7a0000; +} + +.p-orange { + background: #f37329; +} + +.p-orange-100 { + background: #ffc27d; +} + +.p-orange-300 { + background: #ffa154; +} + +.p-orange-500 { + background: #f37329; +} + +.p-orange-700 { + background: #cc3b02; +} + +.p-orange-900 { + background: #a62100; +} + +.p-banana { + background: #f9c440; +} + +.p-banana-100 { + background: #fff394; +} + +.p-banana-300 { + background: #ffe16b; +} + +.p-banana-500 { + background: #f9c440; +} + +.p-banana-700 { + background: #d48e15; +} + +.p-banana-900 { + background: #ad5f00; +} + +.p-lime { + background: #68b723; +} + +.p-lime-100 { + background: #d1ff82; +} + +.p-lime-300 { + background: #9bdb4d; +} + +.p-lime-500 { + background: #68b723; +} + +.p-lime-700 { + background: #3a9104; +} + +.p-lime-900 { + background: #206b00; +} + +.p-mint { + background: #28bca3; +} + +.p-mint-100 { + background: #89ffdd; +} + +.p-mint-300 { + background: #43d6b5; +} + +.p-mint-500 { + background: #28bca3; +} + +.p-mint-700 { + background: #0e9a83; +} + +.p-mint-900 { + background: #007367; +} + +.p-blueberry { + background: #3689e6; +} + +.p-blueberry-100 { + background: #8cd5ff; +} + +.p-blueberry-300 { + background: #64baff; +} + +.p-blueberry-500 { + background: #3689e6; +} + +.p-blueberry-700 { + background: #0d52bf; +} + +.p-blueberry-900 { + background: #002e99; +} + +.p-grape { + background: #a56de2; +} + +.p-grape-100 { + background: #e4c6fa; +} + +.p-grape-300 { + background: #cd9ef7; +} + +.p-grape-500 { + background: #a56de2; +} + +.p-grape-700 { + background: #7239b3; +} + +.p-grape-900 { + background: #452981; +} + +.p-bubblegum { + background: #de3e80; +} + +.p-bubblegum-100 { + background: #fe9ab8; +} + +.p-bubblegum-300 { + background: #f4679d; +} + +.p-bubblegum-500 { + background: #de3e80; +} + +.p-bubblegum-700 { + background: #bc245d; +} + +.p-bubblegum-900 { + background: #910e38; +} + +.p-cocoa { + background: #715344; +} + +.p-cocoa-100 { + background: #a3907c; +} + +.p-cocoa-300 { + background: #8a715e; +} + +.p-cocoa-500 { + background: #715344; +} + +.p-cocoa-700 { + background: #57392d; +} + +.p-cocoa-900 { + background: #3d211b; +} + +.p-silver { + background: #abacae; +} + +.p-silver-100 { + background: #fafafa; +} + +.p-silver-300 { + background: #d4d4d4; +} + +.p-silver-500 { + background: #abacae; +} + +.p-silver-700 { + background: #7e8087; +} + +.p-silver-900 { + background: #555761; +} + +.p-slate { + background: #485a6c; +} + +.p-slate-100 { + background: #95a3ab; +} + +.p-slate-300 { + background: #667885; +} + +.p-slate-500 { + background: #485a6c; +} + +.p-slate-700 { + background: #273445; +} + +.p-slate-900 { + background: #0e141f; +} + +.p-dark { + background: #333; +} + +.p-dark-100 { + background: #666; + /* hehe */ +} + +.p-dark-300 { + background: #4d4d4d; +} + +.p-dark-500 { + background: #333; +} + +.p-dark-700 { + background: #1a1a1a; +} + +.p-dark-900 { + background: #000; +} + +.p-white{ + background: #fff; +} + +.p-strawberry-color { + color: #c6262e; +} + +.p-strawberry-100-color { + color: #ff8c82; +} + +.p-strawberry-300-color { + color: #ed5353; +} + +.p-strawberry-500-color { + color: #c6262e; +} + +.p-strawberry-700-color { + color: #a10705; +} + +.p-strawberry-900-color { + color: #7a0000; +} + +.p-orange-color { + color: #f37329; +} + +.p-orange-100-color { + color: #ffc27d; +} + +.p-orange-300-color { + color: #ffa154; +} + +.p-orange-500-color { + color: #f37329; +} + +.p-orange-700-color { + color: #cc3b02; +} + +.p-orange-900-color { + color: #a62100; +} + +.p-banana-color { + color: #f9c440; +} + +.p-banana-100-color { + color: #fff394; +} + +.p-banana-300-color { + color: #ffe16b; +} + +.p-banana-500-color { + color: #f9c440; +} + +.p-banana-700-color { + color: #d48e15; +} + +.p-banana-900-color { + color: #ad5f00; +} + +.p-lime-color { + color: #68b723; +} + +.p-lime-100-color { + color: #d1ff82; +} + +.p-lime-300-color { + color: #9bdb4d; +} + +.p-lime-500-color { + color: #68b723; +} + +.p-lime-700-color { + color: #3a9104; +} + +.p-lime-900-color { + color: #206b00; +} + +.p-mint-color { + color: #28bca3; +} + +.p-mint-100-color { + color: #89ffdd; +} + +.p-mint-300-color { + color: #43d6b5; +} + +.p-mint-500-color { + color: #28bca3; +} + +.p-mint-700-color { + color: #0e9a83; +} + +.p-mint-900-color { + color: #007367; +} + +.p-blueberry-color { + color: #3689e6; +} + +.p-blueberry-100-color { + color: #8cd5ff; +} + +.p-blueberry-300-color { + color: #64baff; +} + +.p-blueberry-500-color { + color: #3689e6; +} + +.p-blueberry-700-color { + color: #0d52bf; +} + +.p-blueberry-900-color { + color: #002e99; +} + +.p-grape-color { + color: #a56de2; +} + +.p-grape-100-color { + color: #e4c6fa; +} + +.p-grape-300-color { + color: #cd9ef7; +} + +.p-grape-500-color { + color: #a56de2; +} + +.p-grape-700-color { + color: #7239b3; +} + +.p-grape-900-color { + color: #452981; +} + +.p-bubblegum-color { + color: #de3e80; +} + +.p-bubblegum-100-color { + color: #fe9ab8; +} + +.p-bubblegum-300-color { + color: #f4679d; +} + +.p-bubblegum-500-color { + color: #de3e80; +} + +.p-bubblegum-700-color { + color: #bc245d; +} + +.p-bubblegum-900-color { + color: #910e38; +} + +.p-cocoa-color { + color: #715344; +} + +.p-cocoa-100-color { + color: #a3907c; +} + +.p-cocoa-300-color { + color: #8a715e; +} + +.p-cocoa-500-color { + color: #715344; +} + +.p-cocoa-700-color { + color: #57392d; +} + +.p-cocoa-900-color { + color: #3d211b; +} + +.p-silver-color { + color: #abacae; +} + +.p-silver-100-color { + color: #fafafa; +} + +.p-silver-300-color { + color: #d4d4d4; +} + +.p-silver-500-color { + color: #abacae; +} + +.p-silver-700-color { + color: #7e8087; +} + +.p-silver-900-color { + color: #555761; +} + +.p-slate-color { + color: #485a6c; +} + +.p-slate-100-color { + color: #95a3ab; +} + +.p-slate-300-color { + color: #667885; +} + +.p-slate-500-color { + color: #485a6c; +} + +.p-slate-700-color { + color: #273445; +} + +.p-slate-900-color { + color: #0e141f; +} + +.p-dark-color { + color: #333; +} + +.p-dark-100-color { + color: #666; + /* hehe */ +} + +.p-dark-300-color { + color: #4d4d4d; +} + +.p-dark-500-color { + color: #333; +} + +.p-dark-700-color { + color: #1a1a1a; +} + +.p-dark-900-color { + color: #000; +} + +.p-white-color{ + color: #fff; +} diff --git a/v3/examples/android/frontend/public/puppertino/css/dark_mode.css b/v3/examples/android/frontend/public/puppertino/css/dark_mode.css new file mode 100644 index 000000000..3c5a03e80 --- /dev/null +++ b/v3/examples/android/frontend/public/puppertino/css/dark_mode.css @@ -0,0 +1 @@ +/* Puppertino dark_mode placeholder - local vendored */ diff --git a/v3/examples/android/frontend/public/puppertino/css/forms.css b/v3/examples/android/frontend/public/puppertino/css/forms.css new file mode 100644 index 000000000..f2320ab1b --- /dev/null +++ b/v3/examples/android/frontend/public/puppertino/css/forms.css @@ -0,0 +1,509 @@ +:root { + --primary-col:linear-gradient(to bottom, #4fc5fa 0%,#0f75f5 100%); + --primary-col-ac:#0f75f5; + --bg-color-input:#fff; + + --p-checkbox-gradient: linear-gradient(180deg, #4B91F7 0%, #367AF6 100%); + --p-checkbox-border: rgba(0, 0, 0, 0.2); + --p-checkbox-border-active: rgba(0, 0, 0, 0.12); + --p-checkbox-bg: transparent; + --p-checkbox-shadow: inset 0px 1px 2px rgba(0, 0, 0, 0.15), inset 0px 0px 2px rgba(0, 0, 0, 0.10); + + --p-input-bg:#fff; + --p-input-color: rgba(0,0,0,.85); + --p-input-color-plac:rgba(0,0,0,0.25); + + --p-input-color:#808080; + --p-input-bd:rgba(0,0,0,0.15); + --bg-hover-color:#f9f9f9; + --bg-front-col:#000; + --invalid-color:#d6513c; + --valid-color:#94d63c; +} + +.p-dark-mode{ + --p-checkbox-bg: linear-gradient(180deg, rgba(255, 255, 255, 0.1) 0%, rgba(255, 255, 255, 0.13) 100%); + --p-checkbox-shadow: 0px 0px 1px rgba(0, 0, 0, 0.25), inset 0px 0.5px 0px rgba(255, 255, 255, 0.15); + --p-checkbox-border: rgba(0, 0, 0, 0); + + --p-checkbox-gradient: linear-gradient(180deg, #3168DD 0%, #2C5FC8 100%); + --p-checkbox-border-active: rgba(0, 0, 0, 0); +} + +.p-form-select { + border-radius: 5px; + display: inline-block; + font-family: -apple-system, "Inter", sans-serif; + margin: 10px; + position: relative; +} + +.p-form-select > select:focus{ + outline: 2px solid #64baff; +} + +.p-form-select::after { + background: url("data:image/svg+xml,%3Csvg fill='none' xmlns='http://www.w3.org/2000/svg' viewBox='0 0 8 12'%3E%3Cpath d='M.288 4.117 3.16 1.18c.168-.168.336-.246.54-.246a.731.731 0 0 1 .538.246L7.108 4.12c.125.121.184.27.184.45 0 .359-.293.656-.648.656a.655.655 0 0 1-.48-.211L3.701 2.465l-2.469 2.55a.664.664 0 0 1-.48.212.656.656 0 0 1-.465-1.11Zm3.41 7.324a.73.73 0 0 0 .54-.246l2.87-2.941a.601.601 0 0 0 .184-.45.656.656 0 0 0-.648-.656.677.677 0 0 0-.48.211L3.701 9.91 1.233 7.36a.68.68 0 0 0-.48-.212.656.656 0 0 0-.465 1.11l2.871 2.937c.172.168.336.246.54.246Z' fill='white' style='mix-blend-mode:luminosity'/%3E%3C/svg%3E"), #017AFF; + background-size: 100% 75%; + background-position: center; + background-repeat: no-repeat; + border-radius: 5px; + bottom: 0; + content: ""; + display: block; + height: 80%; + pointer-events: none; + position: absolute; + right: 3%; + top: 10%; + width: 20px; +} + +.p-form-select > select { + -webkit-appearance: none; + appearance: none; + background: var(--p-input-bg); + border: 1px solid var(--p-input-bd); + border-radius: 5px; + font-size: 14px; + margin: 0; + outline: none; + padding: 5px 35px 5px 10px; + position: relative; + width: 100%; + color: var(--p-input-color); +} + +.p-form-text:invalid, +.p-form-text-alt:invalid{ + border-color: var(--invalid-color); +} + +.p-form-text:valid, +.p-form-text-alt:valid{ + border-color: var(--valid-color); +} + +.p-form-text:placeholder-shown, +.p-form-text-alt:placeholder-shown{ + border-color: var(--p-input-bd); +} + +.p-form-text { + color: var(--p-input-color); + -webkit-appearance: none; + appearance: none; + background: var(--p-input-bg); + border: 1px solid var(--p-input-bd); + border-radius: 5px; + font-family: -apple-system, "Inter", sans-serif; + font-size: 13px; + margin: 10px; + outline: 0; + padding: 3px 7px; + resize: none; + transition: border-color 200ms; + box-shadow: 0px 0.5px 2.5px rgba(0,0,0,.3), 0px 0px 0px rgba(0,0,0,.1); +} + +.p-form-text-alt { + color: var(--p-input-color); + -webkit-appearance: none; + appearance: none; + box-shadow: none; + background: var(--p-input-bg); + border: 0px; + border-bottom: 2px solid var(--p-input-bd); + padding: 10px; + border-top-left-radius: 3px; + border-top-right-radius: 3px; + margin: 10px; +} + + + +.p-form-text-alt::placeholder, +.p-form-text::placeholder +{ + color: var(--p-input-color-plac); +} + +.p-form-text:active, +.p-form-text:focus +{ + outline: 3px solid rgb(0 122 255 / 50%); +} + +.p-form-text-alt:focus { + outline: 0; + outline: 3px solid rgb(0 122 255 / 50%); + border-color: #3689e6; +} + +.p-form-no-validate:valid, +.p-form-no-validate:invalid{ + border-color: var(--p-input-bd); + color: var(--p-input-color)!important; +} + +.p-form-text:focus { + border-color: rgb(0 122 255); +} + +textarea.p-form-text { + -webkit-appearance: none; + appearance: none; + height: 100px; +} + +.p-form-truncated { + overflow: hidden; + text-overflow: ellipsis; + white-space: nowrap; +} + +.p-form-text[type=password] { + font-family: caption; +} + +.p-form-label, +.p-form-radio-cont, +.p-form-checkbox-cont, +.p-form-label-inline { + font-family: -apple-system, "Inter", sans-serif; +} + +.p-form-label, .p-form-label-inline { + display: inline-block; +} + +.p-form-label{ + font-size: 11px; +} + +.p-form-label-inline { + background: var(--p-input-bg); + padding: 5px; + border-bottom: 2px solid var(--p-input-bd); + color: #656565; + font-weight: 500; + transition: .3s; +} + +.p-form-label-inline:focus-within { + color: #3689e6; + border-color: #3689e6; +} + +.p-form-label-inline > .p-form-text-alt { + border-bottom: 0px; + padding: 0; + outline: 0; + background: var(--p-input-bg); + +} + +.p-form-label-inline > .p-form-text-alt:-webkit-autofill{ + background: var(--p-input-bg); + -webkit-box-shadow: 0 0 0 30px rgba(0,0,0,0) inset !important; +} + +.p-form-label-inline > .p-form-text-alt:invalid { + color: var(--invalid-color); +} + +.p-form-label-inline > .p-form-text-alt:valid { + color: #3689e6; +} + +.p-form-label-inline > .p-form-text-alt:focus{ + color: var(--p-input-color); +} + +.p-form-radio-cont, +.p-form-checkbox-cont { + align-items: center; + display: inline-flex; + cursor: pointer; + margin: 0 10px; + user-select: none; +} + +.p-form-radio-cont > input + span, +.p-form-checkbox-cont > input + span { + background: var(--p-input-bg); + border: 1px solid var(--p-input-bd); + border-radius: 50%; + display: inline-block; + height: 20px; + margin-right: 5px; + position: relative; + transition: 0.2s; + width: 20px; +} + +.p-form-radio-cont > input + span{ + box-shadow: inset 0px 1px 2px rgba(0,0,0,0.10), inset 0px 0px 2px rgba(0,0,0,0.10); +} + +.p-form-radio-cont > input:focus + span, +.p-form-checkbox-cont > input:focus + span{ + outline: 3px solid rgb(0 122 255 / 50%); +} + +.p-form-radio-cont:hover > input + span{ + background: #f9f9f9; +} + +.p-form-radio-cont > input, +.p-form-checkbox-cont > input { + opacity: 0; + pointer-events: none; + position: absolute; +} + +.p-form-radio-cont > input + span::after { + background: #fff; + border-radius: 50%; + content: ""; + display: block; + height: 30%; + left: calc(50% - 15%); + opacity: 0; + position: absolute; + top: calc(50% - 15%); + transform: scale(2); + transition: opacity 0.2s, transform 0.3s; + width: 30%; +} + +.p-form-radio-cont > input:checked + span { + background: #0f75f5; + box-shadow: 0px 1px 2.5px 1px rgba(0, 122, 255, 0.24), inset 0px 0px 0px 0.5px rgba(0, 122, 255, 0.12); +} + +.p-form-radio-cont > input:checked + span::after { + opacity: 1; + transform: scale(1); +} + +.p-form-checkbox-cont > input + span { + border-radius: 5px; + box-shadow: var(--p-checkbox-shadow); + border: 0.5px solid var(--p-checkbox-border); + background: var(--p-checkbox-bg) +} + +.p-form-checkbox-cont > input:checked + span { + background: var(--p-checkbox-gradient); + border: 0.5px solid var(--p-checkbox-border-active); + box-shadow: 0px 1px 2.5px rgba(0, 122, 255, 0.24), 0px 0px 0px 0.5px rgba(0, 122, 255, 0.12); +} + +.p-form-checkbox-cont > input + span::before{ + content: ""; + display: block; + height: 100%; + width: 100%; + position: absolute; + left: 0%; + top: 0%; + opacity: 0; + transition: opacity 0.2s; + background-image: url("data:image/svg+xml,%3Csvg width='10' height='8' viewBox='0 0 10 8' fill='none' xmlns='http://www.w3.org/2000/svg'%3E%3Cpath d='M4.10791 7.81299C3.83545 7.81299 3.6084 7.70459 3.42676 7.48779L1.15918 4.74121C1.08008 4.65039 1.02441 4.5625 0.992188 4.47754C0.959961 4.39258 0.943848 4.30469 0.943848 4.21387C0.943848 4.00586 1.0127 3.83447 1.15039 3.69971C1.29102 3.56201 1.4668 3.49316 1.67773 3.49316C1.91211 3.49316 2.10693 3.58838 2.26221 3.77881L4.10791 6.04297L7.68066 0.368652C7.77148 0.230957 7.86523 0.134277 7.96191 0.0786133C8.06152 0.0200195 8.18311 -0.00927734 8.32666 -0.00927734C8.5376 -0.00927734 8.71191 0.0581055 8.84961 0.192871C8.9873 0.327637 9.05615 0.497559 9.05615 0.702637C9.05615 0.778809 9.04297 0.85791 9.0166 0.939941C8.99023 1.02197 8.94922 1.10693 8.89355 1.19482L4.80225 7.45703C4.64111 7.69434 4.40967 7.81299 4.10791 7.81299Z' fill='white'/%3E%3C/svg%3E%0A"); + background-size: 70%; + background-position: center; + background-repeat: no-repeat; +} + +.p-form-checkbox-cont > input + span::after{ + content: ''; + width: 100%; + height: 100%; + position: absolute; + top: 0; + left: 0; + z-index: 9; +} + +.p-form-checkbox-cont > input + span:active::after{ + border-radius: 5px; + backdrop-filter: brightness(1.2); +} + +.p-form-checkbox-cont > input:checked + span::before{ + opacity: 1; +} + + +.p-form-checkbox-cont > input[disabled] + span, +.p-form-radio-cont > input[disabled] ~ span +{ + opacity: .7; + cursor: not-allowed; +} + +.p-form-button { + -webkit-appearance: none; + appearance: none; + background: #fff; + border: 1px solid var(--p-input-bd); + border-radius: 5px; + color: #333230; + display: inline-block; + font-size: 17px; + margin: 10px; + padding: 5px 20px; + text-decoration: none; +} + +.p-form-send { + background: linear-gradient(to bottom, #4fc5fa 0%, #0f75f5 100%); + border: 0; + color: #fff; +} + +.p-form-send:active { + background: #0f75f5; +} + +.p-form-invalid, +.p-form-invalid:placeholder-shown, +.p-form-invalid:valid, +.p-form-invalid:invalid { + border-color: var(--invalid-color); +} + +.p-form-valid, +.p-form-valid:placeholder-shown, +.p-form-valid:valid, +.p-form-valid:invalid { + border-color: var(--valid-color); +} + +.p-form-switch { + --width: 80px; + cursor: pointer; + display: inline-block; +} + +.p-form-switch > input:checked + span::after { + left: calc(100% - calc(var(--width) / 1.8)); +} + +.p-form-switch > input:checked + span { + background: #60c35b; +} + +.p-form-switch > span { + background: #e0e0e0; + border: 1px solid #d3d3d3; + border-radius: 500px; + display: block; + height: calc(var(--width) / 1.6); + position: relative; + transition: all 0.2s; + width: var(--width); +} + +.p-form-switch > span::after { + background: #f9f9f9; + border-radius: 50%; + border: 0.5px solid rgba(0, 0, 0, 0.101987); + box-shadow: 0px 3px 1px rgba(0, 0, 0, 0.1), 0px 1px 1px rgba(0, 0, 0, 0.16), 0px 3px 8px rgba(0, 0, 0, 0.15); + box-sizing: border-box; + content: ""; + height: 84%; + left: 3%; + position: absolute; + top: 6.5%; + transition: all 0.2s; + width: 52.5%; +} + +.p-form-switch > input { + display: none; +} + +.p-chip input{ + opacity: 0; + pointer-events: none; + position: absolute; +} + +.p-chip span{ + padding: .8rem 1rem; + border-radius: 1.6rem; + display:inline-block; + margin:10px; + background: #e4e4e4ca; + color: #3689e6; + transition: .3s; + user-select: none; + cursor:pointer; + font-family: -apple-system, "Inter", sans-serif; + font-size: 1rem; + -webkit-tap-highlight-color: rgba(0, 0, 0, 0); + -moz-tap-highlight-color: rgba(0, 0, 0, 0); + text-align:center; +} + +.p-chip:focus-within span{ + outline: 2px solid #64baff; +} + +.p-chip svg{ + display:block; + margin:auto; +} + + +.p-chip input:checked + span{ + background: #3689e6; + color:#fff; +} + +.p-chip-outline span, .p-chip-outline-to-bg span{ + background: transparent; + color: #3e3e3e; + border: 1px solid currentColor; +} + +.p-chip-outline input:checked + span{ + background: transparent; + color: #3689e6; +} + +.p-chip-radius-b span{ + border-radius: 5px; +} + +.p-chip-dark span{ + color: #3e3e3e; +} + +.p-chip-dark input:checked + span{ + background: #3e3e3e; +} + +.p-chip input:disabled + span, +.p-chip input[disabled] + span{ + opacity: .5; + cursor: not-allowed; +} + +.p-chip-big span{ + font-size: 1.3rem; + padding: 1.5rem; + min-width: 80px; +} + +.p-form-checkbox-cont[disabled], +.p-form-label[disabled], +.p-form-text[disabled], +.p-form-text-alt[disabled], +.p-form-select[disabled], +.p-form-radio-cont[disabled]{ + filter: grayscale(1) opacity(.3); + pointer-events: none; +} diff --git a/v3/examples/android/frontend/public/puppertino/css/layout.css b/v3/examples/android/frontend/public/puppertino/css/layout.css new file mode 100644 index 000000000..1f9b36845 --- /dev/null +++ b/v3/examples/android/frontend/public/puppertino/css/layout.css @@ -0,0 +1,45 @@ +.p-large-title{ + font-size: 2.75rem; +} + +.p-layout h1 { + font-size: 2.25rem; +} + +.p-layout h2 { + font-size: 1.75rem; +} + +.p-layout h3 { + font-size: 1.58rem; +} + +.p-headline { + font-size: 1.34rem; + font-weight: bold; +} + +.p-layout p { + font-size: 1.15rem; +} + +.p-layout .link, +.p-layout input { + font-size: 0.813rem; +} + +.p-callout { + font-size: 1.14rem; +} + +.p-subhead { + font-size: 1.167rem; +} + +.p-footnote { + font-size: 1.07rem; +} + +.p-caption { + font-size: 0.91rem; +} diff --git a/v3/examples/android/frontend/public/puppertino/css/modals.css b/v3/examples/android/frontend/public/puppertino/css/modals.css new file mode 100644 index 000000000..4d718c4f7 --- /dev/null +++ b/v3/examples/android/frontend/public/puppertino/css/modals.css @@ -0,0 +1 @@ +/* Puppertino modals placeholder - local vendored */ diff --git a/v3/examples/android/frontend/public/puppertino/css/newfull.css b/v3/examples/android/frontend/public/puppertino/css/newfull.css new file mode 100644 index 000000000..622a2f364 --- /dev/null +++ b/v3/examples/android/frontend/public/puppertino/css/newfull.css @@ -0,0 +1,11 @@ +@import url('actions.css'); +@import url('buttons.css'); +@import url('layout.css'); +@import url('cards.css'); +@import url('color_palette.css'); +@import url('forms.css'); +@import url('modals.css'); +@import url('segmented-controls.css'); +@import url('shadows.css'); +@import url('tabs.css'); +@import url('dark_mode.css'); diff --git a/v3/examples/android/frontend/public/puppertino/css/segmented-controls.css b/v3/examples/android/frontend/public/puppertino/css/segmented-controls.css new file mode 100644 index 000000000..22819fd5f --- /dev/null +++ b/v3/examples/android/frontend/public/puppertino/css/segmented-controls.css @@ -0,0 +1 @@ +/* Puppertino segmented-controls placeholder - local vendored */ diff --git a/v3/examples/android/frontend/public/puppertino/css/shadows.css b/v3/examples/android/frontend/public/puppertino/css/shadows.css new file mode 100644 index 000000000..060a61658 --- /dev/null +++ b/v3/examples/android/frontend/public/puppertino/css/shadows.css @@ -0,0 +1 @@ +/* Puppertino shadows placeholder - local vendored */ diff --git a/v3/examples/android/frontend/public/puppertino/css/tabs.css b/v3/examples/android/frontend/public/puppertino/css/tabs.css new file mode 100644 index 000000000..61d1487ca --- /dev/null +++ b/v3/examples/android/frontend/public/puppertino/css/tabs.css @@ -0,0 +1 @@ +/* Puppertino tabs placeholder - local vendored */ diff --git a/v3/examples/android/frontend/public/puppertino/puppertino.css b/v3/examples/android/frontend/public/puppertino/puppertino.css new file mode 100644 index 000000000..905da220e --- /dev/null +++ b/v3/examples/android/frontend/public/puppertino/puppertino.css @@ -0,0 +1,1774 @@ +@charset "UTF-8"; +.p-btn { + background: #fff; + border: 1px solid #cacaca; + border-radius: 5px; + color: #333230; + display: inline-block; + font-family: -apple-system, "Inter", sans-serif; + font-size: 17px; + margin: 10px; + padding: 5px 20px; + text-decoration: none; + /* text-shadow: 0 1px 1px rgba(0, 0, 0, 0.25); */ +} +.p-btn-mob{ + padding: 10px 40px; + background: #0f75f5; + color: #fff; +} +.p-btn[disabled] { + background: #d3d3d3; + color: #555; + cursor: not-allowed; +} +.p-btn:disabled { + background: #d3d3d3; + color: #555; + cursor: not-allowed; +} +.p-btn-disabled { + background: #d3d3d3; + color: #555; + cursor: not-allowed; +} + +.p-prim-col { + background: linear-gradient(to bottom, #4fc5fa 0%, #0f75f5 100%); + border: 0; + color: #fff; +} + +.p-btn.p-prim-col:active { + background: #0f75f5; +} + +.p-btn-more::after { + content: "..."; +} + +.p-btn-round { + border: 0; + border-radius: 50px; + padding: 10px 30px; +} + +.p-btn-icon { + align-items: center; + background: #fff; + border: 2px solid currentColor; + border-radius: 50%; + box-shadow: 0 3px 10px -8px #000; + color: #0f75f5; + display: inline-flex; + font-weight: 900; + height: 36px; + justify-content: center; + margin: 5px; + text-align: center; + text-decoration: none; + width: 36px; +} + +.p-btn-scope { + background: #8e8e8e; + color: #fff; + margin: 5px; + padding: 2px 20px; +} +.p-btn-scope-unactive { + background: transparent; + border-color: transparent; + color: #212136; + transition: border-color 0.2s; +} +.p-btn-scope-unactive:hover { + border-color: #cacaca; +} +.p-btn-scope-disabled { + background: transparent; + color: #8e8e8e; + cursor: not-allowed; +} +.p-btn-scope-outline { + background: transparent; + color: #212136; +} + +.p-btn-scope-outline { + background: transparent; + color: #212136; +} + +.p-btn-outline { + background: none; + border-color: currentColor; +} + +.p-btn-outline-dash { + background: none; + border-color: currentColor; + border-style: dashed; +} + +.p-btn-direction { + color: #212136; + padding: 5px; + text-decoration: none; +} + +.p-btn-direction.p-btn-d-back::before { + content: "❬"; +} + +.p-btn-direction.p-btn-d-next::after { + content: "❭"; +} + +@media (max-width: 576px) { + .p-btn-big-sm { + border: 0; + border-radius: 0%; + bottom: 0; + font-size: 50px; + left: 0; + margin: 0; + padding: 10px 0; + position: fixed; + text-align: center; + width: 100%; + } +} + +/*END OF BUTTONS*/ + +.p-card { + background: rgba(255, 255, 255, 0.3); + border: 1px solid rgba(0, 0, 0, 0.1); + border-radius: 3px; + box-shadow: 0 8px 10px -8px rgba(0, 0, 0, 0.1); + color: #000; + display: block; + margin-top: 30px; + text-decoration: none; +} +.p-card-image > img { + border-bottom: 3px solid var(--accent-article); + display: block; + margin: auto; + width: 100%; +} +.p-card-tags { + display: flex; + overflow: hidden; + position: relative; + width: 100%; +} +.p-card-tags::before { + background: linear-gradient(to right, rgba(255, 255, 255, 0) 0%, rgba(255, 255, 255, 0) 75%, white 100%); + content: ""; + height: 100%; + position: absolute; + right: 0; + top: 0; + width: 30%; +} +.p-card-tags span, +.p-card-tags a { + border: 1px solid #252525; + border-radius: 50px; + color: #252525; + margin: 5px; + padding: 5px 15px; + text-decoration: none; + transition: all 0.2s; +} +.p-card-tags a:hover { + background: #252525; + color: #000; +} +.p-card-title { + font-size: 2rem; + margin-bottom: 15px; + margin-top: 10px; +} +.p-card-content { + padding: 15px; + padding-top: 5px; +} +.p-card-text { + font-size: 17px; + margin-bottom: 10px; + margin-left: 10px; + margin-top: 0; +} + + +/* END OF CARDS*/ + +.p-strawberry { + background: #c6262e; +} + +.p-strawberry-100 { + background: #ff8c82; +} + +.p-strawberry-300 { + background: #ed5353; +} + +.p-strawberry-500 { + background: #c6262e; +} + +.p-strawberry-700 { + background: #a10705; +} + +.p-strawberry-900 { + background: #7a0000; +} + +.p-orange { + background: #f37329; +} + +.p-orange-100 { + background: #ffc27d; +} + +.p-orange-300 { + background: #ffa154; +} + +.p-orange-500 { + background: #f37329; +} + +.p-orange-700 { + background: #cc3b02; +} + +.p-orange-900 { + background: #a62100; +} + +.p-banana { + background: #f9c440; +} + +.p-banana-100 { + background: #fff394; +} + +.p-banana-300 { + background: #ffe16b; +} + +.p-banana-500 { + background: #f9c440; +} + +.p-banana-700 { + background: #d48e15; +} + +.p-banana-900 { + background: #ad5f00; +} + +.p-lime { + background: #68b723; +} + +.p-lime-100 { + background: #d1ff82; +} + +.p-lime-300 { + background: #9bdb4d; +} + +.p-lime-500 { + background: #68b723; +} + +.p-lime-700 { + background: #3a9104; +} + +.p-lime-900 { + background: #206b00; +} + +.p-mint { + background: #28bca3; +} + +.p-mint-100 { + background: #89ffdd; +} + +.p-mint-300 { + background: #43d6b5; +} + +.p-mint-500 { + background: #28bca3; +} + +.p-mint-700 { + background: #0e9a83; +} + +.p-mint-900 { + background: #007367; +} + +.p-blueberry { + background: #3689e6; +} + +.p-blueberry-100 { + background: #8cd5ff; +} + +.p-blueberry-300 { + background: #64baff; +} + +.p-blueberry-500 { + background: #3689e6; +} + +.p-blueberry-700 { + background: #0d52bf; +} + +.p-blueberry-900 { + background: #002e99; +} + +.p-grape { + background: #a56de2; +} + +.p-grape-100 { + background: #e4c6fa; +} + +.p-grape-300 { + background: #cd9ef7; +} + +.p-grape-500 { + background: #a56de2; +} + +.p-grape-700 { + background: #7239b3; +} + +.p-grape-900 { + background: #452981; +} + +.p-bubblegum { + background: #de3e80; +} + +.p-bubblegum-100 { + background: #fe9ab8; +} + +.p-bubblegum-300 { + background: #f4679d; +} + +.p-bubblegum-500 { + background: #de3e80; +} + +.p-bubblegum-700 { + background: #bc245d; +} + +.p-bubblegum-900 { + background: #910e38; +} + +.p-cocoa { + background: #715344; +} + +.p-cocoa-100 { + background: #a3907c; +} + +.p-cocoa-300 { + background: #8a715e; +} + +.p-cocoa-500 { + background: #715344; +} + +.p-cocoa-700 { + background: #57392d; +} + +.p-cocoa-900 { + background: #3d211b; +} + +.p-silver { + background: #abacae; +} + +.p-silver-100 { + background: #fafafa; +} + +.p-silver-300 { + background: #d4d4d4; +} + +.p-silver-500 { + background: #abacae; +} + +.p-silver-700 { + background: #7e8087; +} + +.p-silver-900 { + background: #555761; +} + +.p-slate { + background: #485a6c; +} + +.p-slate-100 { + background: #95a3ab; +} + +.p-slate-300 { + background: #667885; +} + +.p-slate-500 { + background: #485a6c; +} + +.p-slate-700 { + background: #273445; +} + +.p-slate-900 { + background: #0e141f; +} + +.p-dark { + background: #333; +} + +.p-dark-100 { + background: #666; + /* hehe */ +} + +.p-dark-300 { + background: #4d4d4d; +} + +.p-dark-500 { + background: #333; +} + +.p-dark-700 { + background: #1a1a1a; +} + +.p-dark-900 { + background: #000; +} + +.p-strawberry-color { + color: #c6262e; +} + +.p-strawberry-100-color { + color: #ff8c82; +} + +.p-strawberry-300-color { + color: #ed5353; +} + +.p-strawberry-500-color { + color: #c6262e; +} + +.p-strawberry-700-color { + color: #a10705; +} + +.p-strawberry-900-color { + color: #7a0000; +} + +.p-orange-color { + color: #f37329; +} + +.p-orange-100-color { + color: #ffc27d; +} + +.p-orange-300-color { + color: #ffa154; +} + +.p-orange-500-color { + color: #f37329; +} + +.p-orange-700-color { + color: #cc3b02; +} + +.p-orange-900-color { + color: #a62100; +} + +.p-banana-color { + color: #f9c440; +} + +.p-banana-100-color { + color: #fff394; +} + +.p-banana-300-color { + color: #ffe16b; +} + +.p-banana-500-color { + color: #f9c440; +} + +.p-banana-700-color { + color: #d48e15; +} + +.p-banana-900-color { + color: #ad5f00; +} + +.p-lime-color { + color: #68b723; +} + +.p-lime-100-color { + color: #d1ff82; +} + +.p-lime-300-color { + color: #9bdb4d; +} + +.p-lime-500-color { + color: #68b723; +} + +.p-lime-700-color { + color: #3a9104; +} + +.p-lime-900-color { + color: #206b00; +} + +.p-mint-color { + color: #28bca3; +} + +.p-mint-100-color { + color: #89ffdd; +} + +.p-mint-300-color { + color: #43d6b5; +} + +.p-mint-500-color { + color: #28bca3; +} + +.p-mint-700-color { + color: #0e9a83; +} + +.p-mint-900-color { + color: #007367; +} + +.p-blueberry-color { + color: #3689e6; +} + +.p-blueberry-100-color { + color: #8cd5ff; +} + +.p-blueberry-300-color { + color: #64baff; +} + +.p-blueberry-500-color { + color: #3689e6; +} + +.p-blueberry-700-color { + color: #0d52bf; +} + +.p-blueberry-900-color { + color: #002e99; +} + +.p-grape-color { + color: #a56de2; +} + +.p-grape-100-color { + color: #e4c6fa; +} + +.p-grape-300-color { + color: #cd9ef7; +} + +.p-grape-500-color { + color: #a56de2; +} + +.p-grape-700-color { + color: #7239b3; +} + +.p-grape-900-color { + color: #452981; +} + +.p-bubblegum-color { + color: #de3e80; +} + +.p-bubblegum-100-color { + color: #fe9ab8; +} + +.p-bubblegum-300-color { + color: #f4679d; +} + +.p-bubblegum-500-color { + color: #de3e80; +} + +.p-bubblegum-700-color { + color: #bc245d; +} + +.p-bubblegum-900-color { + color: #910e38; +} + +.p-cocoa-color { + color: #715344; +} + +.p-cocoa-100-color { + color: #a3907c; +} + +.p-cocoa-300-color { + color: #8a715e; +} + +.p-cocoa-500-color { + color: #715344; +} + +.p-cocoa-700-color { + color: #57392d; +} + +.p-cocoa-900-color { + color: #3d211b; +} + +.p-silver-color { + color: #abacae; +} + +.p-silver-100-color { + color: #fafafa; +} + +.p-silver-300-color { + color: #d4d4d4; +} + +.p-silver-500-color { + color: #abacae; +} + +.p-silver-700-color { + color: #7e8087; +} + +.p-silver-900-color { + color: #555761; +} + +.p-slate-color { + color: #485a6c; +} + +.p-slate-100-color { + color: #95a3ab; +} + +.p-slate-300-color { + color: #667885; +} + +.p-slate-500-color { + color: #485a6c; +} + +.p-slate-700-color { + color: #273445; +} + +.p-slate-900-color { + color: #0e141f; +} + +.p-dark-color { + color: #333; +} + +.p-dark-100-color { + color: #666; + /* hehe */ +} + +.p-dark-300-color { + color: #4d4d4d; +} + +.p-dark-500-color { + color: #333; +} + +.p-dark-700-color { + color: #1a1a1a; +} + +.p-dark-900-color { + color: #000; +} + +/* END OF COLORS */ + +:root { + --primary-col:linear-gradient(to bottom, #4fc5fa 0%,#0f75f5 100%); + --primary-col-ac:#0f75f5; + --bg-color:#fff; + --bg-hover-color:#f9f9f9; + --bg-front-col:#000; + --invalid-color:#d6513c; + --valid-color:#94d63c; +} + +.p-form-select { + border-radius: 5px; + display: inline-block; + font-family: -apple-system, "Inter", sans-serif; + margin: 10px; + position: relative; +} + +.p-form-select::before { + border-color: #fff transparent transparent; + border-style: solid; + border-width: 5px; + content: ""; + pointer-events: none; + position: absolute; + right: 5px; + top: calc(50% - 3px); + z-index: 3; +} + +.p-form-select::after { + background: linear-gradient(to bottom, #4fc5fa 0%, #0f75f5 100%); + border-bottom-right-radius: 5px; + border-top-right-radius: 5px; + bottom: 0; + content: ""; + display: block; + height: 100%; + pointer-events: none; + position: absolute; + right: 0; + top: 0; + width: 20px; +} + +.p-form-select > select { + -webkit-appearance: none; + background: #fff; + border: 1px solid #cacaca; + border-radius: 5px; + font-size: 14px; + margin: 0; + outline: none; + padding: 5px 30px 5px 10px; + position: relative; + width: 100%; +} + +.p-form-text:invalid, +.p-form-text-alt:invalid, +.p-form-select > select:invalid { + border-color: var(--invalid-color); +} + +.p-form-text:valid, +.p-form-text-alt:valid, +.p-form-select > select:valid { + border-color: var(--valid-color); +} + +.p-form-text:placeholder-shown, +.p-form-text-alt:placeholder-shown, +.p-form-select > select:placeholder-shown { + border-color: #cacaca; +} + +.p-form-text { + -webkit-appearance: none; + box-shadow: none; + background: #fff; + border: 1px solid #cacaca; + border-radius: 5px; + font-family: -apple-system, "Inter", sans-serif; + margin: 10px; + outline: 0; + padding: 5px; + resize: none; + transition: border-color 200ms; +} + +.p-form-text-alt { + -webkit-appearance: none; + box-shadow: none; + background: #fff; + border: 0px; + border-bottom: 2px solid #cacaca; + padding: 10px; + border-top-left-radius: 5px; + border-top-right-radius: 5px; + margin: 10px; +} + +.p-form-text-alt::placeholder { + color: #cacaca; +} + +.p-form-text-alt:focus { + outline: 3px solid #bed8f9; +} + +.p-form-no-validate:valid, +.p-form-no-validate:invalid, +.p-form-no-validate > select:valid, +.p-form-no-validate > select:invalid { + border-color: #cacaca; +} + +.p-form-text:focus { + border-color: #0f75f5; +} + +textarea.p-form-text { + -webkit-appearance: none; + height: 100px; +} + +.p-form-truncated { + overflow: hidden; + text-overflow: ellipsis; + white-space: nowrap; +} + +.p-form-text[type=password] { + font-family: caption; +} + +.p-form-label, +.p-form-radio-cont, +.p-form-checkbox-cont { + font-family: -apple-system, "Inter", sans-serif; +} + +.p-form-label { + display: block; +} + +.p-form-radio-cont, +.p-form-checkbox-cont { + align-items: center; + display: inline-flex; + margin: 0 10px; +} + +.p-form-radio-cont > input + span, +.p-form-checkbox-cont > input + span { + background: #fff; + border: 1px solid #cacaca; + border-radius: 50%; + cursor: pointer; + display: inline-block; + height: 20px; + margin-right: 5px; + position: relative; + transition: background 0.2s; + width: 20px; +} + +.p-form-radio-cont > input + span:hover { + background: #f9f9f9; +} + +.p-form-radio-cont > input, +.p-form-checkbox-cont > input { + opacity: 0; + pointer-events: none; + position: absolute; +} + +.p-form-radio-cont > input + span::after { + background: #fff; + border-radius: 50%; + box-shadow: 0 1px 2px rgba(0, 0, 0, 0.3); + content: ""; + display: block; + height: 30%; + left: calc(50% - 15%); + opacity: 0; + position: absolute; + top: calc(50% - 15%); + transform: scale(2); + transition: opacity 0.2s, transform 0.3s; + width: 30%; +} + +.p-form-radio-cont > input:checked + span { + background: #0f75f5; +} + +.p-form-radio-cont > input:checked + span::after { + opacity: 1; + transform: scale(1); +} + +.p-form-checkbox-cont > input + span { + border-radius: 5px; +} + +.p-form-checkbox-cont > input:checked + span { + background: #0f75f5; +} + +.p-form-checkbox-cont > input + span::before, +.p-form-checkbox-cont > input + span::after { + background: #fff; + border-radius: 20px; + content: ""; + display: block; + height: 8%; + position: absolute; +} + +.p-form-checkbox-cont > input + span::before { + right: 30%; + top: 15%; + transform: rotate(-65deg); + transform-origin: top right; + width: 70%; +} + +.p-form-checkbox-cont > input + span::after { + left: 30%; + top: 43%; + transform: rotate(60deg); + transform-origin: top left; + width: 40%; +} + +.p-form-button { + -webkit-appearance: none; + background: #fff; + border: 1px solid #cacaca; + border-radius: 5px; + color: #333230; + display: inline-block; + font-size: 17px; + margin: 10px; + padding: 5px 20px; + text-decoration: none; + /* text-shadow: 0 1px 1px rgba(0, 0, 0, 0.25); */ +} + +.p-form-send { + background: linear-gradient(to bottom, #4fc5fa 0%, #0f75f5 100%); + border: 0; + color: #fff; +} + +.p-form-send:active { + background: #0f75f5; +} + +.p-form-invalid, +.p-form-invalid:placeholder-shown, +.p-form-invalid:valid, +.p-form-invalid:invalid { + border-color: var(--invalid-color); +} + +.p-form-valid, +.p-form-valid:placeholder-shown, +.p-form-valid:valid, +.p-form-valid:invalid { + border-color: var(--valid-color); +} + +.p-form-switch { + --width: 80px; + cursor: pointer; + display: inline-block; +} + +.p-form-switch > input:checked + span::after { + left: calc(100% - calc(var(--width) / 2.1)); +} + +.p-form-switch > input:checked + span { + background: #60c35b; +} + +.p-form-switch > span { + background: #e0e0e0; + border: 1px solid #d3d3d3; + border-radius: 500px; + display: block; + height: calc(var(--width) / 2); + overflow: hidden; + position: relative; + transition: all 0.2s; + width: var(--width); +} + +.p-form-switch > span::after { + background: #f9f9f9; + border-radius: 50%; + box-shadow: 0px 3px 1px rgba(0, 0, 0, 0.1), 0px 1px 1px rgba(0, 0, 0, 0.16), 0px 3px 8px rgba(0, 0, 0, 0.15); + content: ""; + height: 90%; + left: 3%; + position: absolute; + top: 4.5%; + transition: all 0.2s; + width: 45%; +} + +.p-form-switch > input { + display: none; +} + +input[type=range].p-form-range { + width: 100%; + margin: 11.5px 0; + background-color: transparent; + -webkit-appearance: none; +} +input[type=range].p-form-range:focus { + outline: none; +} +input[type=range].p-form-range::-webkit-slider-runnable-track { + background: #cacaca; + border: 0; + width: 100%; + height: 2px; + cursor: pointer; +} +input[type=range].p-form-range::-webkit-slider-thumb { + margin-top: -11.5px; + width: 25px; + height: 25px; + background: #ffffff; + border: 1px solid rgba(115, 115, 115, 0.6); + border-radius: 30px; + cursor: pointer; + box-shadow: 0 3px 1px rgba(0, 0, 0, 0.1), 0 1px 1px rgba(0, 0, 0, 0.16), 0 3px 8px rgba(0, 0, 0, 0.15); + -webkit-appearance: none; +} +input[type=range].p-form-range:focus::-webkit-slider-runnable-track { + background: #d7d7d7; +} +input[type=range].p-form-range::-moz-range-track { + background: #cacaca; + border: 0; + width: 100%; + height: 2px; + cursor: pointer; +} +input[type=range].p-form-range::-moz-range-thumb { + width: 25px; + height: 25px; + background: #ffffff; + border: 1px solid rgba(115, 115, 115, 0.6); + border-radius: 30px; + box-shadow: 0 3px 1px rgba(0, 0, 0, 0.1), 0 1px 1px rgba(0, 0, 0, 0.16), 0 3px 8px rgba(0, 0, 0, 0.15); + cursor: pointer; +} +input[type=range].p-form-range::-ms-track { + background: transparent; + border-color: transparent; + border-width: 26.5px 0; + color: transparent; + width: 100%; + height: 2px; + cursor: pointer; +} +input[type=range].p-form-range::-ms-fill-lower { + background: #bdbdbd; + border: 0; +} +input[type=range].p-form-range::-ms-fill-upper { + background: #cacaca; + border: 0; +} +input[type=range].p-form-range::-ms-thumb { + width: 25px; + height: 25px; + background: #ffffff; + border: 1px solid rgba(115, 115, 115, 0.6); + border-radius: 30px; + cursor: pointer; + box-shadow: 0 3px 1px rgba(0, 0, 0, 0.1), 0 1px 1px rgba(0, 0, 0, 0.16), 0 3px 8px rgba(0, 0, 0, 0.15); + margin-top: 0px; + /*Needed to keep the Edge thumb centred*/ +} +input[type=range].p-form-range:focus::-ms-fill-lower { + background: #cacaca; +} +input[type=range].p-form-range:focus::-ms-fill-upper { + background: #d7d7d7; +} +/*TODO: Use one of the selectors from https://stackoverflow.com/a/20541859/7077589 and figure out +how to remove the virtical space around the range input in IE*/ +@supports (-ms-ime-align:auto) { + /* Pre-Chromium Edge only styles, selector taken from hhttps://stackoverflow.com/a/32202953/7077589 */ + input[type=range].p-form-range { + margin: 0; + /*Edge starts the margin from the thumb, not the track as other browsers do*/ + } +} + + +/* END OF FORMS */ + +.p-layout .p-large-title { + font-size: 2.75rem; +} + +.p-layout h1 { + font-size: 2.25rem; +} + +.p-layout h2 { + font-size: 1.75rem; +} + +.p-layout h3 { + font-size: 1.58rem; +} + +.p-layout .p-headline { + font-size: 1.34rem; + font-weight: bold; +} + +.p-layout p { + font-size: 1.15rem; +} + +.p-layout a, +.p-layout input { + font-size: 1.14rem; +} + +.p-layout .p-callout { + font-size: 1.14rem; +} + +.p-layout .p-subhead { + font-size: 1.167rem; +} + +.p-layout .p-footnote { + font-size: 1.07rem; +} + +.p-layout .p-caption { + font-size: 0.91rem; +} + +/* END OF LAYOUT */ + +:root { + --font: -apple-system, "Inter", sans-serif; + --bg-hover-color: #f9f9f9; + --primary-col-ac: #0f75f5; +} + +.p-modal-opened { + overflow: hidden; +} + +.p-modal-background { + background: rgba(0, 0, 0, 0.3); + height: 100vh; + left: 0; + opacity: 0; + pointer-events: none; + position: fixed; + top: 0; + transition: all 0.3s; + width: 100vw; + z-index: 5; +} + +.p-modal { + background: rgba(255, 255, 255, 0.85); + border-radius: 20px; + top: calc(50% - 20vh); + bottom: unset; + box-shadow: 0 10px 20px -15px; + font-family: var(--font); + left: calc(50% - 20vw); + opacity: 0; + overflow: hidden; + pointer-events: none; + position: fixed; + text-align: center; + transform: scale(1.5); + transition: opacity 0.3s, transform 0.3s; + width: 40vw; + z-index: 9; +} + +.p-modal.active { + backdrop-filter: saturate(180%) blur(10px); + opacity: 1; + pointer-events: auto; + transform: scale(1); +} + +.p-modal-button-container { + border-radius: 20px; + display: flex; +} + +.p-modal-button-container > a { + border-top: 1px solid rgba(0, 0, 0, 0.1); + color: var(--primary-col-ac); + padding: 30px 0%; + text-decoration: none; + width: 100%; +} + +.p-modal-button-container > a:nth-child(2), +.p-modal-button-container > a:nth-child(3) { + border-left: 1px solid rgba(0, 0, 0, 0.1); +} + +.nowactive { + opacity: 1; + pointer-events: auto; +} + +.p-modal p { + padding: 0% 5%; +} + +@supports not (backdrop-filter: blur(5px)) { + .p-modal { + background: #fff; + } +} +@media (max-width: 568px) { + .p-modal { + bottom: 20%; + left: 15%; + top: unset; + width: 70vw; + } + + .p-modal p { + font-size: 15px; + padding: 0% 10%; + } + + .p-modal-button-container { + display: block; + } + + .p-modal-button-container > a { + border-left: 0 !important; + display: block; + padding: 2vh 0%; + } +} + +/* END OF MODALS */ + +.p-segmented-controls { + --color-segmented: #3689e6; + --color-lighter-segment: #d2e3f9; + background: #fff; + border: 1px solid var(--color-segmented); + border-radius: 5px; + display: flex; + flex-wrap: wrap; + font-family: -apple-system, "Inter", sans-serif; + margin-top: 10px; + overflow: hidden; + width: 100%; +} +.p-segmented-controls a { + color: var(--color-segmented); + flex: auto; + padding: 10px; + text-align: center; + text-decoration: none; + transition: all 0.5s; +} +.p-segmented-controls a.active { + background: var(--color-segmented); + color: #fff; +} +.p-segmented-controls a:not(:first-child) { + border-left: 1px solid currentColor; +} + +.p-segmented-radius { + border-radius: 30px; +} + +.p-segmented-internal-radius a, +.p-segmented-internal-radius a:not(:first-child) { + border: 0; + border-radius: 30px; +} + +.p-segmented-controls-alt a:not(:first-child) { + border: 0; +} +.p-segmented-controls-alt a:not(:first-child).active { + background: var(--color-lighter-segment); + color: var(--color-segmented); + font-weight: bold; +} + +.p-segmented-outline { + border: 2px solid var(--color-segmented); +} +.p-segmented-outline a:not(:first-child) { + border-left: 2px solid var(--color-segmented); +} + +.p-segmented-controls-outline-alt a:not(:first-child) { + border: 2px solid transparent; +} + +.p-segmented-controls-outline-alt { + border-radius: 30px; +} +.p-segmented-controls-outline-alt a { + border: 2px solid transparent; + border-radius: 30px; +} +.p-segmented-controls-outline-alt a.active { + background: #fff; + border-color: var(--color-segmented); + border-radius: 30px; + color: var(--color-segmented); + font-weight: bold; +} + +.p-segmented-grey { + --color-segmented: #555761; + --color-lighter-segment: #d4d4d4; +} + +/* END OF SEGMENTED CONTROLS */ + +.p-shadow-1 { + box-shadow: 0 3px 10px rgba(0, 0, 0, 0.1); +} + +.p-shadow-2 { + box-shadow: 0 5px 10px rgba(0, 0, 0, 0.2); +} + +.p-shadow-3 { + box-shadow: 0 10px 18px rgba(0, 0, 0, 0.3); +} + +.p-shadow-4 { + box-shadow: 0 25px 30px rgba(0, 0, 0, 0.2); +} + +.p-to-shadow-4, +.p-to-shadow-3, +.p-to-shadow-2, +.p-to-shadow-1 { + transition-timing-function: ease; + transition: box-shadow 0.5s; +} + +.p-to-shadow-1:hover { + box-shadow: 0 3px 10px rgba(0, 0, 0, 0.1);> +} + +.p-to-shadow-2:hover { + box-shadow: 0 5px 10px rgba(0, 0, 0, 0.2); +} + +.p-to-shadow-3:hover { + box-shadow: 0 10px 18px rgba(0, 0, 0, 0.3); +} + +.p-to-shadow-4:hover { + box-shadow: 0 25px 30px rgba(0, 0, 0, 0.2); +} + + +/* END OF SHADOWS */ + +.p-tabs-container { + background: #e3e3e3; + border: 1px solid #e0e0e0; + padding: 1em; +} + +.p-tabs-container.p-light { + background: none; + border: none; +} + +.p-tabs-container.p-light .p-panels { + margin-top: 0; + border-radius: 0; + padding: 0; +} + +.p-tabs { + display: flex; + justify-content: center; +} + +.p-tabs > :nth-of-type(1) { + border-radius: 5px 0 0 5px; +} + +.p-tabs > :last-child { + border-radius: 0 5px 5px 0; +} + +.p-tab { + margin: 0; + padding: 5px 35px; + background: #fff; + color: #333230; + text-decoration: none; + /* text-shadow: 0 1px 1px rgba(0, 0, 0, 0.25); */ + border: 1px solid #cacaca; + display: inline-block; + font-size: 17px; + font-family: -apple-system, "Inter", sans-serif; + cursor: pointer; +} + +.p-tab:focus { + outline: 0; +} + +.p-is-active { + background: linear-gradient(to bottom, #4fc5fa 0%, #0f75f5 100%); + border: 0; + color: #fff; +} + +.p-panels { + margin-top: 1em; + background: #fff; + border-radius: 3px; + position: relative; + padding: 0.8em; + overflow: hidden; +} + +.p-panel.p-is-active { + opacity: 1; + pointer-events: all; + background: none; + color: inherit; + position: static; +} + +.p-panel { + position: absolute; + opacity: 0; + pointer-events: none; +} + +@media (max-width: 768px) { + .p-tabs { + overflow: auto; + } + .p-tab { + font-size: 0.8em; + padding: 5px 28px; + } + .p-tabs-container { + padding: 0.8em; + } + + .p-panels { + padding: 0.8em; + } +} + +@media screen and (max-width: 496px) { + .p-tab { + text-align: center; + padding: 5px 18px; + } + .p-tabs-container { + padding: 0.5em; + } + + .p-panels { + padding: 0.5em; + margin-top: 0.5em; + } +} + +@media screen and (max-width: 378px) { + .p-tab { + text-align: center; + padding: 5px 10px; + } + .p-tabs-container { + padding: 0.5em; + } + + .p-panels { + padding: 0.5em; + margin-top: 0.5; + } +} + +.p-mobile-tabs { + position: fixed; + bottom: 0; + left: 0; + width: 100%; + padding: 15px 0px; + border-top: 1px solid #949494; + background: rgba(202, 202, 202, 0.8); + backdrop-filter: blur(10px); + display: flex; + font-family: -apple-system, "Inter", sans-serif; +} + +.p-mobile-tabs > div { + flex: auto; + text-align: center; +} + +.p-mobile-tabs a { + text-decoration: none; + color: #555; + transition: color 0.5s; + display: inline-block; + font-size: 0.8rem; +} + +.p-mobile-tabs a.active { + color: #0f75f5; + font-weight: 600; +} + +.p-mobile-tabs svg { + display: block; + margin: auto; + margin-bottom: 0.2rem; +} + +.p-mobile-tabs--content { + display: none; +} + +.p-mobile-tabs--content.active { + display: block; +} + +/* END OF TABS */ + + +.p-action-background{ + background: rgba(0, 0, 0, 0.3); + height: 100vh; + left: 0; + opacity: 0; + pointer-events: none; + position: fixed; + top: 0; + transition: all 0.3s; + width: 100vw; + z-index: 5; +} + +.p-action-background.nowactive { + opacity: 1; + pointer-events: auto; +} + + +.p-action-big-container{ + position:fixed; + width: 100%; + box-sizing: border-box; + padding: 1rem 5vw; + bottom:0; +} + +.p-action-container{ + background: rgba(255, 255, 255, 0.8); + backdrop-filter: blur(10px); + display:block; + margin:auto; + margin-bottom: 10px; + border-radius: 10px; +} + +.p-action-big-container .p-action-container:first-child{ + margin-bottom:10px; +} + +.p-action--intern{ + display:block; + margin:auto; + text-align:center; + padding: 15px 0; + border-bottom: 1px solid #bfbfbf; + font-weight: 500; + color: #0f75f5; + text-decoration:none; +} + +.p-action-destructive{ + color: #c6262e; +} + +.p-action-neutral{ + color: #555761; +} + +.p-action-cancel, .p-action-container a:last-child{ + border-bottom:none; +} + +.p-action-cancel{ + font-weight:bold; +} + +.p-action-icon{ + position:relative; +} +.p-action-icon svg, .p-action-icon img{ + position:absolute; + left:5%; + top:50%; + transform:translateY(-50%); +} + +.p-action-icon-inline{ + text-align: left; + display: flex; + align-items: center; +} + +.p-action-icon-inline svg, .p-action-icon-inline img{ + margin-left: 5%; + margin-right: 3%; +} + +.p-action-title{ + padding: 30px 15px; + border-bottom: 1px solid #bfbfbf; +} + +.p-action-title--intern,.p-action-text{ + margin:0; + color:#555761; +} + +.p-action-title--intern{ + margin-bottom: .3rem; +} + +@supports not (backdrop-filter: blur(10px)) { + .p-action-container { + background: rgba(255,255,255,.95); + } +} + +.p-action-big-container{ + -webkit-transform: translateY(30%); + transform: translateY(30%); + opacity: 0; + transition: opacity 0.4s, transform 0.4s; + transition-timing-function: ease-in-out; +} + +.p-action-big-container.active { +-webkit-transform: translateY(0); + transform: translateY(0); + opacity: 1; +} + + +/* END OF ACTIONS */ diff --git a/v3/examples/android/frontend/public/style.css b/v3/examples/android/frontend/public/style.css new file mode 100644 index 000000000..8e4ccbd00 --- /dev/null +++ b/v3/examples/android/frontend/public/style.css @@ -0,0 +1,328 @@ +:root { + font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, "Helvetica Neue", Arial, + sans-serif, "Apple Color Emoji", "Segoe UI Emoji"; + font-size: 16px; + line-height: 24px; + font-weight: 400; + color-scheme: light dark; + /* Desktop defaults (mobile overrides below) */ + --bg: #ffffff; + --fg: #213547; + font-synthesis: none; + text-rendering: optimizeLegibility; + -webkit-font-smoothing: antialiased; + -moz-osx-font-smoothing: grayscale; + -webkit-text-size-adjust: 100%; + user-select: none; + -webkit-user-select: none; + -moz-user-select: none; + -ms-user-select: none; +} + +/* Mobile bottom tabs layout (works on all themes) */ +.mobile-pane { + display: flex; + flex-direction: column; + width: 100%; + max-width: 520px; + height: 70vh; /* fixed-height main screen */ + border-radius: 12px; +} +.mobile-pane .p-mobile-tabs-content { + position: relative; + flex: 1 1 auto; + overflow: hidden; /* contain panels */ + display: flex; + flex-direction: column; +} +.p-mobile-tabs-content .p-mobile-tabs--content { + display: none; + overflow: auto; /* scroll inside content area */ + -webkit-overflow-scrolling: touch; + padding: 8px 8px 16px; +} +.p-mobile-tabs-content .p-mobile-tabs--content.active { display: block; } + +*, *::before, *::after { + box-sizing: border-box; +} + +/* Prefer system fonts on mobile; remove custom font to reduce bundle size */ + +h3 { + font-size: 3em; + line-height: 1.1; +} + +a { + font-weight: 500; + color: #646cff; + text-decoration: inherit; +} + +a:hover { + color: #535bf2; +} + +/* Remove generic button styling to allow Puppertino .btn to control buttons */ + +.result { + height: 20px; + line-height: 20px; +} + +html, +body { + height: 100%; + width: 100%; + overflow-x: hidden; /* prevent horizontal overflow */ + overflow-y: auto; /* allow vertical scroll if needed */ +} + +body { + margin: 0; + display: flex; + flex-direction: column; + align-items: center; + justify-content: center; + min-width: 320px; + /* Use small viewport units to avoid iOS Safari URL bar issues */ + min-height: 100svh; + height: auto; /* avoid forcing overflow */ + /* Equal responsive spacing top & bottom */ + padding-block: clamp(8px, 4vh, 48px); + color: var(--fg); + background-color: var(--bg); +} + +.container { + display: flex; + flex-direction: column; + align-items: center; + justify-content: center; + /* Responsive spacing between elements */ + gap: clamp(8px, 2vh, 24px); + width: 100%; + max-width: 480px; + padding-inline: 16px; +} + +h1 { + /* Responsive heading size */ + font-size: clamp(1.6rem, 6vw, 3.2rem); + line-height: 1.1; +} + +#app { + max-width: 1280px; + margin: 0 auto; + /* Responsive inner padding: horizontal only, no extra top/bottom */ + padding: 0 clamp(12px, 4vw, 32px); + text-align: center; +} + +.logo { + /* Consistent visual size across images: fix height, auto width */ + height: clamp(80px, 18vh, 140px); + width: auto; + max-width: 80vw; + padding: 0.5em; + will-change: filter; +} + +.logo:hover { + filter: drop-shadow(0 0 2em #e80000aa); +} + +.logo.vanilla:hover { + filter: drop-shadow(0 0 2em #f7df1eaa); +} + +.result { + height: 20px; + line-height: 20px; + margin: 1.5rem auto; + text-align: center; +} + +.footer { + margin-top: 1rem; + align-content: center; + text-align: center; +} + +/* Tabs: default hide panels, show one matching the checked radio */ +.tabs .tabs-content .tab-panel { display: none; } +.tabs input#tab-js:checked ~ .tabs-content [data-tab="tab-js"] { display: block; } +.tabs input#tab-go:checked ~ .tabs-content [data-tab="tab-go"] { display: block; } + +/* Sticky tabs header */ +.tabs .tabs-header { + position: sticky; + top: env(safe-area-inset-top); + z-index: 5; + display: grid; + grid-template-columns: 1fr 1fr; + gap: 8px; + padding: 8px 0; + background: var(--bg); + backdrop-filter: saturate(1.2) blur(4px); +} + +/* Subtle divider under sticky header */ +.tabs .tabs-header::after { + content: ""; + grid-column: 1 / -1; + height: 1px; + background: rgba(0,0,0,0.08); + margin-top: 8px; +} + +/* Mobile-specific light mode */ +@media (max-width: 768px) and (prefers-color-scheme: light) { + :root { + --fg: #213547; + --bg: #ffffff; + } + + a:hover { + color: #747bff; + } + + /* allow Puppertino to style .btn */ + + .input-box .input { + color: #111827; + background-color: #f3f4f6; + border: 1px solid #e5e7eb; /* show border in light mode */ + border-radius: 8px; + } + + button:hover { + border-color: #d1d5db; /* slate-300 */ + } + + .input-box .input:focus { + border-color: #9ca3af; /* gray-400 */ + box-shadow: 0 0 0 3px rgba(59, 130, 246, 0.15); /* subtle focus ring */ + } +} + +/* let Puppertino handle .btn hover */ + +.input-box .input { + border: 1px solid transparent; /* default; themed in media queries */ + border-radius: 8px; + outline: none; + height: 30px; + line-height: 30px; + padding: 0 10px; + color: black; + background-color: rgba(240, 240, 240, 1); + -webkit-font-smoothing: antialiased; +} + +.input-box .input:hover { + background-color: rgba(255, 255, 255, 1); +} + +.input-box .input:focus { + background-color: rgba(255, 255, 255, 1); + outline: 2px solid transparent; + outline-offset: 2px; +} + +/* Mobile-specific dark mode */ +@media (max-width: 768px) and (prefers-color-scheme: dark) { + :root { + color: rgba(255, 255, 255, 0.88); + --fg: rgba(255, 255, 255, 0.88); + --bg: #0f1115; /* deep dark background */ + } + + a { + color: #8ea2ff; + } + + a:hover { + color: #aab6ff; + } + + /* allow Puppertino to style .btn in dark mode */ + + .input-box .input { + background-color: #111827; /* gray-900 */ + color: #e5e7eb; + caret-color: #ffffff; + border: 1px solid #374151; /* slate-700 */ + } + + .input-box .input:hover, + .input-box .input:focus { + background-color: #0b1220; + border-color: #4b5563; /* slate-600 */ + } + + /* allow Puppertino to handle active state */ +} + +/* Mobile baseline overrides (apply to both light and dark) */ +@media (max-width: 768px) { + /* Prevent iOS zoom on focus */ + input, textarea, select, button { font-size: 16px; } + + /* Make layout vertical and scrollable */ + html, body { + height: auto; + min-height: 100svh; + overflow-x: hidden; + overflow-y: auto; + -webkit-overflow-scrolling: touch; + } + + body { + padding-top: env(safe-area-inset-top); + padding-bottom: env(safe-area-inset-bottom); + position: static; + } + + .container { + width: 100%; + max-width: 520px; /* allow a bit wider on phones */ + align-items: center; /* keep content centered on mobile */ + text-align: center; + } + + /* Stack controls vertically with full-width tap targets */ + .input-box { + display: flex; + flex-direction: column; + align-items: stretch; + gap: 10px; + } + + .input-box .input, + .input, + button, + .p-btn { + width: 100%; + min-height: 44px; /* comfortable touch target */ + } + + /* Tabs vertical and full-width */ + .tabs { + display: grid; + grid-template-columns: 1fr; + gap: 8px; + } + .tabs .p-btn { width: 100%; } + + /* Cap device info height for readability */ + #deviceInfo { + max-height: 30vh; + overflow: auto; + padding: 8px; + border-radius: 8px; + background: rgba(0,0,0,0.04); + } +} \ No newline at end of file diff --git a/v3/examples/android/frontend/public/wails.png b/v3/examples/android/frontend/public/wails.png new file mode 100644 index 000000000..8bdf42483 Binary files /dev/null and b/v3/examples/android/frontend/public/wails.png differ diff --git a/v3/examples/android/frontend/vite.config.js b/v3/examples/android/frontend/vite.config.js new file mode 100644 index 000000000..87b093bc3 --- /dev/null +++ b/v3/examples/android/frontend/vite.config.js @@ -0,0 +1,11 @@ +import { defineConfig } from 'vite'; +import path from 'path'; + +export default defineConfig({ + resolve: { + alias: { + // Use the local repo runtime sources instead of the published package + '@wailsio/runtime': path.resolve(__dirname, '../../../internal/runtime/desktop/@wailsio/runtime/src/index.ts'), + }, + }, +}); diff --git a/v3/examples/android/go.mod b/v3/examples/android/go.mod new file mode 100644 index 000000000..ebca95414 --- /dev/null +++ b/v3/examples/android/go.mod @@ -0,0 +1,49 @@ +module changeme + +go 1.25 + +require github.com/wailsapp/wails/v3 v3.0.0-dev + +require ( + dario.cat/mergo v1.0.2 // indirect + github.com/Microsoft/go-winio v0.6.2 // indirect + github.com/ProtonMail/go-crypto v1.3.0 // indirect + github.com/adrg/xdg v0.5.3 // indirect + github.com/bep/debounce v1.2.1 // indirect + github.com/cloudflare/circl v1.6.3 // indirect + github.com/coder/websocket v1.8.14 // indirect + github.com/cyphar/filepath-securejoin v0.6.1 // indirect + github.com/ebitengine/purego v0.9.1 // indirect + github.com/emirpasic/gods v1.18.1 // indirect + github.com/go-git/gcfg v1.5.1-0.20230307220236-3a3c6141e376 // indirect + github.com/go-git/go-billy/v5 v5.7.0 // indirect + github.com/go-git/go-git/v5 v5.16.4 // indirect + github.com/go-ole/go-ole v1.3.0 // indirect + github.com/godbus/dbus/v5 v5.2.2 // indirect + github.com/golang/groupcache v0.0.0-20241129210726-2c02b8208cf8 // indirect + github.com/google/uuid v1.6.0 // indirect + github.com/jbenet/go-context v0.0.0-20150711004518-d14ea06fba99 // indirect + github.com/jchv/go-winloader v0.0.0-20250406163304-c1995be93bd1 // indirect + github.com/kevinburke/ssh_config v1.4.0 // indirect + github.com/klauspost/cpuid/v2 v2.3.0 // indirect + github.com/leaanthony/go-ansi-parser v1.6.1 // indirect + github.com/leaanthony/u v1.1.1 // indirect + github.com/lmittmann/tint v1.1.2 // indirect + github.com/mattn/go-colorable v0.1.14 // indirect + github.com/mattn/go-isatty v0.0.20 // indirect + github.com/pjbgf/sha1cd v0.5.0 // indirect + github.com/pkg/browser v0.0.0-20240102092130-5ac0b6a4141c // indirect + github.com/rivo/uniseg v0.4.7 // indirect + github.com/samber/lo v1.52.0 // indirect + github.com/sergi/go-diff v1.4.0 // indirect + github.com/skeema/knownhosts v1.3.2 // indirect + github.com/wailsapp/go-webview2 v1.0.23 // indirect + github.com/xanzy/ssh-agent v0.3.3 // indirect + golang.org/x/crypto v0.47.0 // indirect + golang.org/x/net v0.49.0 // indirect + golang.org/x/sys v0.40.0 // indirect + golang.org/x/text v0.33.0 // indirect + gopkg.in/warnings.v0 v0.1.2 // indirect +) + +replace github.com/wailsapp/wails/v3 => ../../ diff --git a/v3/examples/android/go.sum b/v3/examples/android/go.sum new file mode 100644 index 000000000..56f1153ea --- /dev/null +++ b/v3/examples/android/go.sum @@ -0,0 +1,147 @@ +dario.cat/mergo v1.0.2 h1:85+piFYR1tMbRrLcDwR18y4UKJ3aH1Tbzi24VRW1TK8= +dario.cat/mergo v1.0.2/go.mod h1:E/hbnu0NxMFBjpMIE34DRGLWqDy0g5FuKDhCb31ngxA= +github.com/Microsoft/go-winio v0.5.2/go.mod h1:WpS1mjBmmwHBEWmogvA2mj8546UReBk4v8QkMxJ6pZY= +github.com/Microsoft/go-winio v0.6.2 h1:F2VQgta7ecxGYO8k3ZZz3RS8fVIXVxONVUPlNERoyfY= +github.com/Microsoft/go-winio v0.6.2/go.mod h1:yd8OoFMLzJbo9gZq8j5qaps8bJ9aShtEA8Ipt1oGCvU= +github.com/ProtonMail/go-crypto v1.3.0 h1:ILq8+Sf5If5DCpHQp4PbZdS1J7HDFRXz/+xKBiRGFrw= +github.com/ProtonMail/go-crypto v1.3.0/go.mod h1:9whxjD8Rbs29b4XWbB8irEcE8KHMqaR2e7GWU1R+/PE= +github.com/adrg/xdg v0.5.3 h1:xRnxJXne7+oWDatRhR1JLnvuccuIeCoBu2rtuLqQB78= +github.com/adrg/xdg v0.5.3/go.mod h1:nlTsY+NNiCBGCK2tpm09vRqfVzrc2fLmXGpBLF0zlTQ= +github.com/anmitsu/go-shlex v0.0.0-20200514113438-38f4b401e2be h1:9AeTilPcZAjCFIImctFaOjnTIavg87rW78vTPkQqLI8= +github.com/anmitsu/go-shlex v0.0.0-20200514113438-38f4b401e2be/go.mod h1:ySMOLuWl6zY27l47sB3qLNK6tF2fkHG55UZxx8oIVo4= +github.com/armon/go-socks5 v0.0.0-20160902184237-e75332964ef5 h1:0CwZNZbxp69SHPdPJAN/hZIm0C4OItdklCFmMRWYpio= +github.com/armon/go-socks5 v0.0.0-20160902184237-e75332964ef5/go.mod h1:wHh0iHkYZB8zMSxRWpUBQtwG5a7fFgvEO+odwuTv2gs= +github.com/bep/debounce v1.2.1 h1:v67fRdBA9UQu2NhLFXrSg0Brw7CexQekrBwDMM8bzeY= +github.com/bep/debounce v1.2.1/go.mod h1:H8yggRPQKLUhUoqrJC1bO2xNya7vanpDl7xR3ISbCJ0= +github.com/cloudflare/circl v1.6.3 h1:9GPOhQGF9MCYUeXyMYlqTR6a5gTrgR/fBLXvUgtVcg8= +github.com/cloudflare/circl v1.6.3/go.mod h1:2eXP6Qfat4O/Yhh8BznvKnJ+uzEoTQ6jVKJRn81BiS4= +github.com/coder/websocket v1.8.14 h1:9L0p0iKiNOibykf283eHkKUHHrpG7f65OE3BhhO7v9g= +github.com/coder/websocket v1.8.14/go.mod h1:NX3SzP+inril6yawo5CQXx8+fk145lPDC6pumgx0mVg= +github.com/cyphar/filepath-securejoin v0.6.1 h1:5CeZ1jPXEiYt3+Z6zqprSAgSWiggmpVyciv8syjIpVE= +github.com/cyphar/filepath-securejoin v0.6.1/go.mod h1:A8hd4EnAeyujCJRrICiOWqjS1AX0a9kM5XL+NwKoYSc= +github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= +github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c= +github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= +github.com/ebitengine/purego v0.9.1 h1:a/k2f2HQU3Pi399RPW1MOaZyhKJL9w/xFpKAg4q1s0A= +github.com/ebitengine/purego v0.9.1/go.mod h1:iIjxzd6CiRiOG0UyXP+V1+jWqUXVjPKLAI0mRfJZTmQ= +github.com/elazarl/goproxy v1.7.2 h1:Y2o6urb7Eule09PjlhQRGNsqRfPmYI3KKQLFpCAV3+o= +github.com/elazarl/goproxy v1.7.2/go.mod h1:82vkLNir0ALaW14Rc399OTTjyNREgmdL2cVoIbS6XaE= +github.com/emirpasic/gods v1.18.1 h1:FXtiHYKDGKCW2KzwZKx0iC0PQmdlorYgdFG9jPXJ1Bc= +github.com/emirpasic/gods v1.18.1/go.mod h1:8tpGGwCnJ5H4r6BWwaV6OrWmMoPhUl5jm/FMNAnJvWQ= +github.com/gliderlabs/ssh v0.3.8 h1:a4YXD1V7xMF9g5nTkdfnja3Sxy1PVDCj1Zg4Wb8vY6c= +github.com/gliderlabs/ssh v0.3.8/go.mod h1:xYoytBv1sV0aL3CavoDuJIQNURXkkfPA/wxQ1pL1fAU= +github.com/go-git/gcfg v1.5.1-0.20230307220236-3a3c6141e376 h1:+zs/tPmkDkHx3U66DAb0lQFJrpS6731Oaa12ikc+DiI= +github.com/go-git/gcfg v1.5.1-0.20230307220236-3a3c6141e376/go.mod h1:an3vInlBmSxCcxctByoQdvwPiA7DTK7jaaFDBTtu0ic= +github.com/go-git/go-billy/v5 v5.7.0 h1:83lBUJhGWhYp0ngzCMSgllhUSuoHP1iEWYjsPl9nwqM= +github.com/go-git/go-billy/v5 v5.7.0/go.mod h1:/1IUejTKH8xipsAcdfcSAlUlo2J7lkYV8GTKxAT/L3E= +github.com/go-git/go-git-fixtures/v4 v4.3.2-0.20231010084843-55a94097c399 h1:eMje31YglSBqCdIqdhKBW8lokaMrL3uTkpGYlE2OOT4= +github.com/go-git/go-git-fixtures/v4 v4.3.2-0.20231010084843-55a94097c399/go.mod h1:1OCfN199q1Jm3HZlxleg+Dw/mwps2Wbk9frAWm+4FII= +github.com/go-git/go-git/v5 v5.16.4 h1:7ajIEZHZJULcyJebDLo99bGgS0jRrOxzZG4uCk2Yb2Y= +github.com/go-git/go-git/v5 v5.16.4/go.mod h1:4Ge4alE/5gPs30F2H1esi2gPd69R0C39lolkucHBOp8= +github.com/go-json-experiment/json v0.0.0-20251027170946-4849db3c2f7e h1:Lf/gRkoycfOBPa42vU2bbgPurFong6zXeFtPoxholzU= +github.com/go-json-experiment/json v0.0.0-20251027170946-4849db3c2f7e/go.mod h1:uNVvRXArCGbZ508SxYYTC5v1JWoz2voff5pm25jU1Ok= +github.com/go-ole/go-ole v1.3.0 h1:Dt6ye7+vXGIKZ7Xtk4s6/xVdGDQynvom7xCFEdWr6uE= +github.com/go-ole/go-ole v1.3.0/go.mod h1:5LS6F96DhAwUc7C+1HLexzMXY1xGRSryjyPPKW6zv78= +github.com/godbus/dbus/v5 v5.2.2 h1:TUR3TgtSVDmjiXOgAAyaZbYmIeP3DPkld3jgKGV8mXQ= +github.com/godbus/dbus/v5 v5.2.2/go.mod h1:3AAv2+hPq5rdnr5txxxRwiGjPXamgoIHgz9FPBfOp3c= +github.com/golang/groupcache v0.0.0-20241129210726-2c02b8208cf8 h1:f+oWsMOmNPc8JmEHVZIycC7hBoQxHH9pNKQORJNozsQ= +github.com/golang/groupcache v0.0.0-20241129210726-2c02b8208cf8/go.mod h1:wcDNUvekVysuuOpQKo3191zZyTpiI6se1N1ULghS0sw= +github.com/google/go-cmp v0.7.0 h1:wk8382ETsv4JYUZwIsn6YpYiWiBsYLSJiTsyBybVuN8= +github.com/google/go-cmp v0.7.0/go.mod h1:pXiqmnSA92OHEEa9HXL2W4E7lf9JzCmGVUdgjX3N/iU= +github.com/google/uuid v1.6.0 h1:NIvaJDMOsjHA8n1jAhLSgzrAzy1Hgr+hNrb57e+94F0= +github.com/google/uuid v1.6.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo= +github.com/jbenet/go-context v0.0.0-20150711004518-d14ea06fba99 h1:BQSFePA1RWJOlocH6Fxy8MmwDt+yVQYULKfN0RoTN8A= +github.com/jbenet/go-context v0.0.0-20150711004518-d14ea06fba99/go.mod h1:1lJo3i6rXxKeerYnT8Nvf0QmHCRC1n8sfWVwXF2Frvo= +github.com/jchv/go-winloader v0.0.0-20250406163304-c1995be93bd1 h1:njuLRcjAuMKr7kI3D85AXWkw6/+v9PwtV6M6o11sWHQ= +github.com/jchv/go-winloader v0.0.0-20250406163304-c1995be93bd1/go.mod h1:alcuEEnZsY1WQsagKhZDsoPCRoOijYqhZvPwLG0kzVs= +github.com/kevinburke/ssh_config v1.4.0 h1:6xxtP5bZ2E4NF5tuQulISpTO2z8XbtH8cg1PWkxoFkQ= +github.com/kevinburke/ssh_config v1.4.0/go.mod h1:q2RIzfka+BXARoNexmF9gkxEX7DmvbW9P4hIVx2Kg4M= +github.com/klauspost/cpuid/v2 v2.3.0 h1:S4CRMLnYUhGeDFDqkGriYKdfoFlDnMtqTiI/sFzhA9Y= +github.com/klauspost/cpuid/v2 v2.3.0/go.mod h1:hqwkgyIinND0mEev00jJYCxPNVRVXFQeu1XKlok6oO0= +github.com/kr/pretty v0.1.0/go.mod h1:dAy3ld7l9f0ibDNOQOHHMYYIIbhfbHSm3C4ZsoJORNo= +github.com/kr/pretty v0.3.1 h1:flRD4NNwYAUpkphVc1HcthR4KEIFJ65n8Mw5qdRn3LE= +github.com/kr/pretty v0.3.1/go.mod h1:hoEshYVHaxMs3cyo3Yncou5ZscifuDolrwPKZanG3xk= +github.com/kr/pty v1.1.1/go.mod h1:pFQYn66WHrOpPYNljwOMqo10TkYh1fy3cYio2l3bCsQ= +github.com/kr/text v0.1.0/go.mod h1:4Jbv+DJW3UT/LiOwJeYQe1efqtUx/iVham/4vfdArNI= +github.com/kr/text v0.2.0 h1:5Nx0Ya0ZqY2ygV366QzturHI13Jq95ApcVaJBhpS+AY= +github.com/kr/text v0.2.0/go.mod h1:eLer722TekiGuMkidMxC/pM04lWEeraHUUmBw8l2grE= +github.com/leaanthony/go-ansi-parser v1.6.1 h1:xd8bzARK3dErqkPFtoF9F3/HgN8UQk0ed1YDKpEz01A= +github.com/leaanthony/go-ansi-parser v1.6.1/go.mod h1:+vva/2y4alzVmmIEpk9QDhA7vLC5zKDTRwfZGOp3IWU= +github.com/leaanthony/u v1.1.1 h1:TUFjwDGlNX+WuwVEzDqQwC2lOv0P4uhTQw7CMFdiK7M= +github.com/leaanthony/u v1.1.1/go.mod h1:9+o6hejoRljvZ3BzdYlVL0JYCwtnAsVuN9pVTQcaRfI= +github.com/lmittmann/tint v1.1.2 h1:2CQzrL6rslrsyjqLDwD11bZ5OpLBPU+g3G/r5LSfS8w= +github.com/lmittmann/tint v1.1.2/go.mod h1:HIS3gSy7qNwGCj+5oRjAutErFBl4BzdQP6cJZ0NfMwE= +github.com/matryer/is v1.4.0/go.mod h1:8I/i5uYgLzgsgEloJE1U6xx5HkBQpAZvepWuujKwMRU= +github.com/matryer/is v1.4.1 h1:55ehd8zaGABKLXQUe2awZ99BD/PTc2ls+KV/dXphgEQ= +github.com/matryer/is v1.4.1/go.mod h1:8I/i5uYgLzgsgEloJE1U6xx5HkBQpAZvepWuujKwMRU= +github.com/mattn/go-colorable v0.1.14 h1:9A9LHSqF/7dyVVX6g0U9cwm9pG3kP9gSzcuIPHPsaIE= +github.com/mattn/go-colorable v0.1.14/go.mod h1:6LmQG8QLFO4G5z1gPvYEzlUgJ2wF+stgPZH1UqBm1s8= +github.com/mattn/go-isatty v0.0.20 h1:xfD0iDuEKnDkl03q4limB+vH+GxLEtL/jb4xVJSWWEY= +github.com/mattn/go-isatty v0.0.20/go.mod h1:W+V8PltTTMOvKvAeJH7IuucS94S2C6jfK/D7dTCTo3Y= +github.com/onsi/gomega v1.34.1 h1:EUMJIKUjM8sKjYbtxQI9A4z2o+rruxnzNvpknOXie6k= +github.com/onsi/gomega v1.34.1/go.mod h1:kU1QgUvBDLXBJq618Xvm2LUX6rSAfRaFRTcdOeDLwwY= +github.com/pjbgf/sha1cd v0.5.0 h1:a+UkboSi1znleCDUNT3M5YxjOnN1fz2FhN48FlwCxs0= +github.com/pjbgf/sha1cd v0.5.0/go.mod h1:lhpGlyHLpQZoxMv8HcgXvZEhcGs0PG/vsZnEJ7H0iCM= +github.com/pkg/browser v0.0.0-20240102092130-5ac0b6a4141c h1:+mdjkGKdHQG3305AYmdv1U2eRNDiU2ErMBj1gwrq8eQ= +github.com/pkg/browser v0.0.0-20240102092130-5ac0b6a4141c/go.mod h1:7rwL4CYBLnjLxUqIJNnCWiEdr3bn6IUYi15bNlnbCCU= +github.com/pkg/errors v0.9.1 h1:FEBLx1zS214owpjy7qsBeixbURkuhQAwrK5UwLGTwt4= +github.com/pkg/errors v0.9.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0= +github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM= +github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= +github.com/rivo/uniseg v0.2.0/go.mod h1:J6wj4VEh+S6ZtnVlnTBMWIodfgj8LQOQFoIToxlJtxc= +github.com/rivo/uniseg v0.4.7 h1:WUdvkW8uEhrYfLC4ZzdpI2ztxP1I582+49Oc5Mq64VQ= +github.com/rivo/uniseg v0.4.7/go.mod h1:FN3SvrM+Zdj16jyLfmOkMNblXMcoc8DfTHruCPUcx88= +github.com/rogpeppe/go-internal v1.14.1 h1:UQB4HGPB6osV0SQTLymcB4TgvyWu6ZyliaW0tI/otEQ= +github.com/rogpeppe/go-internal v1.14.1/go.mod h1:MaRKkUm5W0goXpeCfT7UZI6fk/L7L7so1lCWt35ZSgc= +github.com/samber/lo v1.52.0 h1:Rvi+3BFHES3A8meP33VPAxiBZX/Aws5RxrschYGjomw= +github.com/samber/lo v1.52.0/go.mod h1:4+MXEGsJzbKGaUEQFKBq2xtfuznW9oz/WrgyzMzRoM0= +github.com/sergi/go-diff v1.4.0 h1:n/SP9D5ad1fORl+llWyN+D6qoUETXNZARKjyY2/KVCw= +github.com/sergi/go-diff v1.4.0/go.mod h1:A0bzQcvG0E7Rwjx0REVgAGH58e96+X0MeOfepqsbeW4= +github.com/sirupsen/logrus v1.7.0/go.mod h1:yWOB1SBYBC5VeMP7gHvWumXLIWorT60ONWic61uBYv0= +github.com/skeema/knownhosts v1.3.2 h1:EDL9mgf4NzwMXCTfaxSD/o/a5fxDw/xL9nkU28JjdBg= +github.com/skeema/knownhosts v1.3.2/go.mod h1:bEg3iQAuw+jyiw+484wwFJoKSLwcfd7fqRy+N0QTiow= +github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME= +github.com/stretchr/testify v1.2.2/go.mod h1:a8OnRcib4nhh0OaRAV+Yts87kKdq0PP7pXfy6kDkUVs= +github.com/stretchr/testify v1.4.0/go.mod h1:j7eGeouHqKxXV5pUuKE4zz7dFj8WfuZ+81PSLYec5m4= +github.com/stretchr/testify v1.11.1 h1:7s2iGBzp5EwR7/aIZr8ao5+dra3wiQyKjjFuvgVKu7U= +github.com/stretchr/testify v1.11.1/go.mod h1:wZwfW3scLgRK+23gO65QZefKpKQRnfz6sD981Nm4B6U= +github.com/wailsapp/go-webview2 v1.0.23 h1:jmv8qhz1lHibCc79bMM/a/FqOnnzOGEisLav+a0b9P0= +github.com/wailsapp/go-webview2 v1.0.23/go.mod h1:qJmWAmAmaniuKGZPWwne+uor3AHMB5PFhqiK0Bbj8kc= +github.com/xanzy/ssh-agent v0.3.3 h1:+/15pJfg/RsTxqYcX6fHqOXZwwMP+2VyYWJeWM2qQFM= +github.com/xanzy/ssh-agent v0.3.3/go.mod h1:6dzNDKs0J9rVPHPhaGCukekBHKqfl+L3KghI1Bc68Uw= +golang.org/x/crypto v0.0.0-20220622213112-05595931fe9d/go.mod h1:IxCIyHEi3zRg3s0A5j5BB6A9Jmi73HwBIUl50j+osU4= +golang.org/x/crypto v0.47.0 h1:V6e3FRj+n4dbpw86FJ8Fv7XVOql7TEwpHapKoMJ/GO8= +golang.org/x/crypto v0.47.0/go.mod h1:ff3Y9VzzKbwSSEzWqJsJVBnWmRwRSHt/6Op5n9bQc4A= +golang.org/x/exp v0.0.0-20260112195511-716be5621a96 h1:Z/6YuSHTLOHfNFdb8zVZomZr7cqNgTJvA8+Qz75D8gU= +golang.org/x/exp v0.0.0-20260112195511-716be5621a96/go.mod h1:nzimsREAkjBCIEFtHiYkrJyT+2uy9YZJB7H1k68CXZU= +golang.org/x/net v0.0.0-20211112202133-69e39bad7dc2/go.mod h1:9nx3DQGgdP8bBQD5qxJ1jj9UTztislL4KSBs9R2vV5Y= +golang.org/x/net v0.49.0 h1:eeHFmOGUTtaaPSGNmjBKpbng9MulQsJURQUAfUwY++o= +golang.org/x/net v0.49.0/go.mod h1:/ysNB2EvaqvesRkuLAyjI1ycPZlQHM3q01F02UY/MV8= +golang.org/x/sys v0.0.0-20191026070338-33540a1f6037/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20200810151505-1b9f1253b3ed/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20201119102817-f84b799fce68/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20210124154548-22da62e12c0c/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20210423082822-04245dca01da/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20210615035016-665e8c7367d1/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.0.0-20220715151400-c0bba94af5f8/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.1.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.6.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.40.0 h1:DBZZqJ2Rkml6QMQsZywtnjnnGvHza6BTfYFWY9kjEWQ= +golang.org/x/sys v0.40.0/go.mod h1:OgkHotnGiDImocRcuBABYBEXf8A9a87e/uXjp9XT3ks= +golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo= +golang.org/x/term v0.39.0 h1:RclSuaJf32jOqZz74CkPA9qFuVTX7vhLlpfj/IGWlqY= +golang.org/x/term v0.39.0/go.mod h1:yxzUCTP/U+FzoxfdKmLaA0RV1WgE0VY7hXBwKtY/4ww= +golang.org/x/text v0.3.6/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ= +golang.org/x/text v0.33.0 h1:B3njUFyqtHDUI5jMn1YIr5B0IE2U0qck04r6d4KPAxE= +golang.org/x/text v0.33.0/go.mod h1:LuMebE6+rBincTi9+xWTY8TztLzKHc/9C1uBCG27+q8= +golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ= +gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= +gopkg.in/check.v1 v1.0.0-20190902080502-41f04d3bba15/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= +gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c h1:Hei/4ADfdWqJk1ZMxUNpqntNwaWcugrBjAiHlqqRiVk= +gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c/go.mod h1:JHkPIbrfpd72SG/EVd6muEfDQjcINNoR0C8j2r3qZ4Q= +gopkg.in/warnings.v0 v0.1.2 h1:wFXVbFY8DY5/xOe1ECiWdKCzZlxgshcYVNkBHstARME= +gopkg.in/warnings.v0 v0.1.2/go.mod h1:jksf8JmL6Qr/oQM2OXTHunEvvTAsrWBLb6OOjuVWRNI= +gopkg.in/yaml.v2 v2.2.2/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI= +gopkg.in/yaml.v2 v2.4.0/go.mod h1:RDklbk79AGWmwhnvt/jBztapEOGDOx6ZbXqjP6csGnQ= +gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA= +gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= diff --git a/v3/examples/android/greetservice.go b/v3/examples/android/greetservice.go new file mode 100644 index 000000000..8972c39cd --- /dev/null +++ b/v3/examples/android/greetservice.go @@ -0,0 +1,7 @@ +package main + +type GreetService struct{} + +func (g *GreetService) Greet(name string) string { + return "Hello " + name + "!" +} diff --git a/v3/examples/android/main.go b/v3/examples/android/main.go new file mode 100644 index 000000000..ba20103da --- /dev/null +++ b/v3/examples/android/main.go @@ -0,0 +1,73 @@ +package main + +import ( + "embed" + _ "embed" + "log" + "time" + + "github.com/wailsapp/wails/v3/pkg/application" +) + +// Wails uses Go's `embed` package to embed the frontend files into the binary. +// Any files in the frontend/dist folder will be embedded into the binary and +// made available to the frontend. +// See https://pkg.go.dev/embed for more information. + +//go:embed all:frontend/dist +var assets embed.FS + +// main function serves as the application's entry point. It initializes the application, creates a window, +// and starts a goroutine that emits a time-based event every second. It subsequently runs the application and +// logs any error that might occur. +func main() { + + // Create a new Wails application by providing the necessary options. + // Variables 'Name' and 'Description' are for application metadata. + // 'Assets' configures the asset server with the 'FS' variable pointing to the frontend files. + // 'Bind' is a list of Go struct instances. The frontend has access to the methods of these instances. + app := application.New(application.Options{ + Name: "android", + Description: "A demo of using raw HTML & CSS", + Services: []application.Service{ + application.NewService(&GreetService{}), + }, + Assets: application.AssetOptions{ + Handler: application.AssetFileServerFS(assets), + }, + Mac: application.MacOptions{ + ApplicationShouldTerminateAfterLastWindowClosed: true, + }, + Android: application.AndroidOptions{ + // Android-specific options will go here + }, + }) + + // Create a new window with the necessary options. + // 'Title' is the title of the window. + // 'BackgroundColour' is the background colour of the window. + // 'URL' is the URL that will be loaded into the webview. + app.Window.NewWithOptions(application.WebviewWindowOptions{ + Title: "Window 1", + BackgroundColour: application.NewRGB(27, 38, 54), + URL: "/", + }) + + // Create a goroutine that emits an event containing the current time every second. + // The frontend can listen to this event and update the UI accordingly. + go func() { + for { + now := time.Now().Format(time.RFC1123) + app.Event.Emit("time", now) + time.Sleep(time.Second) + } + }() + + // Run the application. This blocks until the application has been exited. + err := app.Run() + + // If an error occurred while running the application, log it and exit. + if err != nil { + log.Fatal(err) + } +} diff --git a/v3/examples/android/main_android.go b/v3/examples/android/main_android.go new file mode 100644 index 000000000..70a716473 --- /dev/null +++ b/v3/examples/android/main_android.go @@ -0,0 +1,11 @@ +//go:build android + +package main + +import "github.com/wailsapp/wails/v3/pkg/application" + +func init() { + // Register main function to be called when the Android app initializes + // This is necessary because in c-shared build mode, main() is not automatically called + application.RegisterAndroidMain(main) +} diff --git a/v3/examples/badge-custom/README.md b/v3/examples/badge-custom/README.md new file mode 100644 index 000000000..ab4c5a3fb --- /dev/null +++ b/v3/examples/badge-custom/README.md @@ -0,0 +1,128 @@ +# Welcome to Your New Wails3 Project! +Now that you have your project set up, it's time to explore the custom badge features that Wails3 offers on **Windows**. + +## Exploring Custom Badge Features + +### Creating the Service with Custom Options (Windows Only) + +On Windows, you can customize the badge appearance with various options: + +```go +import "github.com/wailsapp/wails/v3/pkg/application" +import "github.com/wailsapp/wails/v3/pkg/services/badge" +import "image/color" + +// Create a badge service with custom options +options := badge.Options{ + TextColour: color.RGBA{255, 255, 255, 255}, // White text + BackgroundColour: color.RGBA{0, 0, 255, 255}, // Green background + FontName: "consolab.ttf", // Bold Consolas font + FontSize: 20, // Font size for single character + SmallFontSize: 14, // Font size for multiple characters +} + +badgeService := badge.NewWithOptions(options) + +// Register the service with the application +app := application.New(application.Options{ + Services: []application.Service{ + application.NewService(badgeService), + }, +}) +``` + +## Badge Operations + +### Setting a Badge + +Set a badge on the application tile/dock icon with the global options applied: + +#### Go +```go +// Set a default badge +badgeService.SetBadge("") + +// Set a numeric badge +badgeService.SetBadge("3") + +// Set a text badge +badgeService.SetBadge("New") +``` + +#### JS +```js +import {SetBadge} from "../bindings/github.com/wailsapp/wails/v3/pkg/services/badge/service"; + +// Set a default badge +SetBadge("") + +// Set a numeric badge +SetBadge("3") + +// Set a text badge +SetBadge("New") +``` + +### Setting a Custom Badge + +Set a badge on the application tile/dock icon with one-off options applied: + +#### Go +```go +// Set a default badge +badgeService.SetCustomBadge("") + +// Set a numeric badge +badgeService.SetCustomBadge("3") + +// Set a text badge +badgeService.SetCustomBadge("New") +``` + +#### JS +```js +import {SetCustomBadge} from "../bindings/github.com/wailsapp/wails/v3/pkg/services/badge/service"; + +const options = { + BackgroundColour: RGBA.createFrom({ + R: 0, + G: 255, + B: 255, + A: 255, + }), + FontName: "arialb.ttf", // System font + FontSize: 16, + SmallFontSize: 10, + TextColour: RGBA.createFrom({ + R: 0, + G: 0, + B: 0, + A: 255, + }), +} + +// Set a default badge +SetCustomBadge("", options) + +// Set a numeric badge +SetCustomBadge("3", options) + +// Set a text badge +SetCustomBadge("New", options) +``` + +### Removing a Badge + +Remove the badge from the application icon: + +#### Go +```go +badgeService.RemoveBadge() +``` + +#### JS +```js +import {RemoveBadge} from "../bindings/github.com/wailsapp/wails/v3/pkg/services/badge/service"; + +RemoveBadge() +``` \ No newline at end of file diff --git a/v3/examples/badge-custom/Taskfile.yml b/v3/examples/badge-custom/Taskfile.yml new file mode 100644 index 000000000..d1bcfaacf --- /dev/null +++ b/v3/examples/badge-custom/Taskfile.yml @@ -0,0 +1,34 @@ +version: '3' + +includes: + common: ./build/Taskfile.yml + windows: ./build/windows/Taskfile.yml + darwin: ./build/darwin/Taskfile.yml + linux: ./build/linux/Taskfile.yml + +vars: + APP_NAME: "badge" + BIN_DIR: "bin" + VITE_PORT: '{{.WAILS_VITE_PORT | default 9245}}' + +tasks: + build: + summary: Builds the application + cmds: + - task: "{{OS}}:build" + + package: + summary: Packages a production build of the application + cmds: + - task: "{{OS}}:package" + + run: + summary: Runs the application + cmds: + - task: "{{OS}}:run" + + dev: + summary: Runs the application in development mode + cmds: + - wails3 dev -config ./build/config.yml -port {{.VITE_PORT}} + diff --git a/v3/examples/badge-custom/build/Taskfile.yml b/v3/examples/badge-custom/build/Taskfile.yml new file mode 100644 index 000000000..f0aab9b9c --- /dev/null +++ b/v3/examples/badge-custom/build/Taskfile.yml @@ -0,0 +1,87 @@ +version: '3' + +tasks: + go:mod:tidy: + summary: Runs `go mod tidy` + internal: true + cmds: + - go mod tidy + + install:frontend:deps: + summary: Install frontend dependencies + dir: frontend + sources: + - package.json + - package-lock.json + generates: + - node_modules/* + preconditions: + - sh: npm version + msg: "Looks like npm isn't installed. Npm is part of the Node installer: https://nodejs.org/en/download/" + cmds: + - npm install + + build:frontend: + label: build:frontend (PRODUCTION={{.PRODUCTION}}) + summary: Build the frontend project + dir: frontend + sources: + - "**/*" + - exclude: node_modules/**/* + generates: + - dist/**/* + deps: + - task: install:frontend:deps + - task: generate:bindings + vars: + BUILD_FLAGS: + ref: .BUILD_FLAGS + cmds: + - npm run {{.BUILD_COMMAND}} -q + env: + PRODUCTION: '{{.PRODUCTION | default "false"}}' + vars: + BUILD_COMMAND: '{{if eq .PRODUCTION "true"}}build{{else}}build:dev{{end}}' + + + generate:bindings: + label: generate:bindings (BUILD_FLAGS={{.BUILD_FLAGS}}) + summary: Generates bindings for the frontend + deps: + - task: go:mod:tidy + sources: + - "**/*.[jt]s" + - exclude: frontend/**/* + - frontend/bindings/**/* # Rerun when switching between dev/production mode causes changes in output + - "**/*.go" + - go.mod + - go.sum + generates: + - frontend/bindings/**/* + cmds: + - wails3 generate bindings -f '{{.BUILD_FLAGS}}' -clean=true -ts + + generate:icons: + summary: Generates Windows `.ico` and Mac `.icns` files from an image + dir: build + sources: + - "appicon.png" + generates: + - "darwin/icons.icns" + - "windows/icon.ico" + cmds: + - wails3 generate icons -input appicon.png -macfilename darwin/icons.icns -windowsfilename windows/icon.ico + + dev:frontend: + summary: Runs the frontend in development mode + dir: frontend + deps: + - task: install:frontend:deps + cmds: + - npm run dev -- --port {{.VITE_PORT}} --strictPort + + update:build-assets: + summary: Updates the build assets + dir: build + cmds: + - wails3 update build-assets -name "{{.APP_NAME}}" -binaryname "{{.APP_NAME}}" -config config.yml -dir . diff --git a/v3/examples/badge-custom/build/appicon.png b/v3/examples/badge-custom/build/appicon.png new file mode 100644 index 000000000..63617fe4f Binary files /dev/null and b/v3/examples/badge-custom/build/appicon.png differ diff --git a/v3/examples/badge-custom/build/config.yml b/v3/examples/badge-custom/build/config.yml new file mode 100644 index 000000000..aaa3240fb --- /dev/null +++ b/v3/examples/badge-custom/build/config.yml @@ -0,0 +1,63 @@ +# This file contains the configuration for this project. +# When you update `info` or `fileAssociations`, run `wails3 task common:update:build-assets` to update the assets. +# Note that this will overwrite any changes you have made to the assets. +version: '3' + +# This information is used to generate the build assets. +info: + companyName: "My Company" # The name of the company + productName: "My Product" # The name of the application + productIdentifier: "com.mycompany.myproduct" # The unique product identifier + description: "A program that does X" # The application description + copyright: "(c) 2025, My Company" # Copyright text + comments: "Some Product Comments" # Comments + version: "0.0.1" # The application version + +# Dev mode configuration +dev_mode: + root_path: . + log_level: warn + debounce: 1000 + ignore: + dir: + - .git + - node_modules + - frontend + - bin + file: + - .DS_Store + - .gitignore + - .gitkeep + watched_extension: + - "*.go" + git_ignore: true + executes: + - cmd: wails3 task common:install:frontend:deps + type: once + - cmd: wails3 task common:dev:frontend + type: background + - cmd: go mod tidy + type: blocking + - cmd: wails3 task build + type: blocking + - cmd: wails3 task run + type: primary + +# File Associations +# More information at: https://v3.wails.io/noit/done/yet +fileAssociations: +# - ext: wails +# name: Wails +# description: Wails Application File +# iconName: wailsFileIcon +# role: Editor +# - ext: jpg +# name: JPEG +# description: Image File +# iconName: jpegFileIcon +# role: Editor +# mimeType: image/jpeg # (optional) + +# Other data +other: + - name: My Other Data \ No newline at end of file diff --git a/v3/examples/badge-custom/build/darwin/Info.dev.plist b/v3/examples/badge-custom/build/darwin/Info.dev.plist new file mode 100644 index 000000000..4caddf720 --- /dev/null +++ b/v3/examples/badge-custom/build/darwin/Info.dev.plist @@ -0,0 +1,32 @@ + + + + CFBundlePackageType + APPL + CFBundleName + My Product + CFBundleExecutable + badge + CFBundleIdentifier + com.wails.badge + CFBundleVersion + 0.1.0 + CFBundleGetInfoString + This is a comment + CFBundleShortVersionString + 0.1.0 + CFBundleIconFile + icons + LSMinimumSystemVersion + 10.15.0 + NSHighResolutionCapable + true + NSHumanReadableCopyright + © now, My Company + NSAppTransportSecurity + + NSAllowsLocalNetworking + + + + \ No newline at end of file diff --git a/v3/examples/badge-custom/build/darwin/Info.plist b/v3/examples/badge-custom/build/darwin/Info.plist new file mode 100644 index 000000000..0dc90b2e7 --- /dev/null +++ b/v3/examples/badge-custom/build/darwin/Info.plist @@ -0,0 +1,27 @@ + + + + CFBundlePackageType + APPL + CFBundleName + My Product + CFBundleExecutable + badge + CFBundleIdentifier + com.wails.badge + CFBundleVersion + 0.1.0 + CFBundleGetInfoString + This is a comment + CFBundleShortVersionString + 0.1.0 + CFBundleIconFile + icons + LSMinimumSystemVersion + 10.15.0 + NSHighResolutionCapable + true + NSHumanReadableCopyright + © now, My Company + + \ No newline at end of file diff --git a/v3/examples/badge-custom/build/darwin/Taskfile.yml b/v3/examples/badge-custom/build/darwin/Taskfile.yml new file mode 100644 index 000000000..f0791fea9 --- /dev/null +++ b/v3/examples/badge-custom/build/darwin/Taskfile.yml @@ -0,0 +1,81 @@ +version: '3' + +includes: + common: ../Taskfile.yml + +tasks: + build: + summary: Creates a production build of the application + deps: + - task: common:go:mod:tidy + - task: common:build:frontend + vars: + BUILD_FLAGS: + ref: .BUILD_FLAGS + PRODUCTION: + ref: .PRODUCTION + - task: common:generate:icons + cmds: + - go build {{.BUILD_FLAGS}} -o {{.OUTPUT}} + vars: + BUILD_FLAGS: '{{if eq .PRODUCTION "true"}}-tags production -trimpath -buildvcs=false -ldflags="-w -s"{{else}}-buildvcs=false -gcflags=all="-l"{{end}}' + DEFAULT_OUTPUT: '{{.BIN_DIR}}/{{.APP_NAME}}' + OUTPUT: '{{ .OUTPUT | default .DEFAULT_OUTPUT }}' + env: + GOOS: darwin + CGO_ENABLED: 1 + GOARCH: '{{.ARCH | default ARCH}}' + CGO_CFLAGS: "-mmacosx-version-min=10.15" + CGO_LDFLAGS: "-mmacosx-version-min=10.15" + MACOSX_DEPLOYMENT_TARGET: "10.15" + PRODUCTION: '{{.PRODUCTION | default "false"}}' + + build:universal: + summary: Builds darwin universal binary (arm64 + amd64) + deps: + - task: build + vars: + ARCH: amd64 + OUTPUT: "{{.BIN_DIR}}/{{.APP_NAME}}-amd64" + - task: build + vars: + ARCH: arm64 + OUTPUT: "{{.BIN_DIR}}/{{.APP_NAME}}-arm64" + cmds: + - lipo -create -output "{{.BIN_DIR}}/{{.APP_NAME}}" "{{.BIN_DIR}}/{{.APP_NAME}}-amd64" "{{.BIN_DIR}}/{{.APP_NAME}}-arm64" + - rm "{{.BIN_DIR}}/{{.APP_NAME}}-amd64" "{{.BIN_DIR}}/{{.APP_NAME}}-arm64" + + package: + summary: Packages a production build of the application into a `.app` bundle + deps: + - task: build + vars: + PRODUCTION: "true" + cmds: + - task: create:app:bundle + + package:universal: + summary: Packages darwin universal binary (arm64 + amd64) + deps: + - task: build:universal + cmds: + - task: create:app:bundle + + + create:app:bundle: + summary: Creates an `.app` bundle + cmds: + - mkdir -p {{.BIN_DIR}}/{{.APP_NAME}}.app/Contents/{MacOS,Resources} + - cp build/darwin/icons.icns {{.BIN_DIR}}/{{.APP_NAME}}.app/Contents/Resources + - cp {{.BIN_DIR}}/{{.APP_NAME}} {{.BIN_DIR}}/{{.APP_NAME}}.app/Contents/MacOS + - cp build/darwin/Info.plist {{.BIN_DIR}}/{{.APP_NAME}}.app/Contents + - codesign --force --deep --sign - {{.BIN_DIR}}/{{.APP_NAME}}.app + + run: + cmds: + - mkdir -p {{.BIN_DIR}}/{{.APP_NAME}}.dev.app/Contents/{MacOS,Resources} + - cp build/darwin/icons.icns {{.BIN_DIR}}/{{.APP_NAME}}.dev.app/Contents/Resources + - cp {{.BIN_DIR}}/{{.APP_NAME}} {{.BIN_DIR}}/{{.APP_NAME}}.dev.app/Contents/MacOS + - cp build/darwin/Info.dev.plist {{.BIN_DIR}}/{{.APP_NAME}}.dev.app/Contents/Info.plist + - codesign --force --deep --sign - {{.BIN_DIR}}/{{.APP_NAME}}.dev.app + - '{{.BIN_DIR}}/{{.APP_NAME}}.dev.app/Contents/MacOS/{{.APP_NAME}}' diff --git a/v3/examples/badge-custom/build/darwin/icons.icns b/v3/examples/badge-custom/build/darwin/icons.icns new file mode 100644 index 000000000..1b5bd4c86 Binary files /dev/null and b/v3/examples/badge-custom/build/darwin/icons.icns differ diff --git a/v3/examples/badge-custom/build/linux/Taskfile.yml b/v3/examples/badge-custom/build/linux/Taskfile.yml new file mode 100644 index 000000000..560cc9c92 --- /dev/null +++ b/v3/examples/badge-custom/build/linux/Taskfile.yml @@ -0,0 +1,119 @@ +version: '3' + +includes: + common: ../Taskfile.yml + +tasks: + build: + summary: Builds the application for Linux + deps: + - task: common:go:mod:tidy + - task: common:build:frontend + vars: + BUILD_FLAGS: + ref: .BUILD_FLAGS + PRODUCTION: + ref: .PRODUCTION + - task: common:generate:icons + cmds: + - go build {{.BUILD_FLAGS}} -o {{.BIN_DIR}}/{{.APP_NAME}} + vars: + BUILD_FLAGS: '{{if eq .PRODUCTION "true"}}-tags production -trimpath -buildvcs=false -ldflags="-w -s"{{else}}-buildvcs=false -gcflags=all="-l"{{end}}' + env: + GOOS: linux + CGO_ENABLED: 1 + GOARCH: '{{.ARCH | default ARCH}}' + PRODUCTION: '{{.PRODUCTION | default "false"}}' + + package: + summary: Packages a production build of the application for Linux + deps: + - task: build + vars: + PRODUCTION: "true" + cmds: + - task: create:appimage + - task: create:deb + - task: create:rpm + - task: create:aur + + create:appimage: + summary: Creates an AppImage + dir: build/linux/appimage + deps: + - task: build + vars: + PRODUCTION: "true" + - task: generate:dotdesktop + cmds: + - cp {{.APP_BINARY}} {{.APP_NAME}} + - cp ../../appicon.png appicon.png + - wails3 generate appimage -binary {{.APP_NAME}} -icon {{.ICON}} -desktopfile {{.DESKTOP_FILE}} -outputdir {{.OUTPUT_DIR}} -builddir {{.ROOT_DIR}}/build/linux/appimage/build + vars: + APP_NAME: '{{.APP_NAME}}' + APP_BINARY: '../../../bin/{{.APP_NAME}}' + ICON: '../../appicon.png' + DESKTOP_FILE: '../{{.APP_NAME}}.desktop' + OUTPUT_DIR: '../../../bin' + + create:deb: + summary: Creates a deb package + deps: + - task: build + vars: + PRODUCTION: "true" + cmds: + - task: generate:dotdesktop + - task: generate:deb + + create:rpm: + summary: Creates a rpm package + deps: + - task: build + vars: + PRODUCTION: "true" + cmds: + - task: generate:dotdesktop + - task: generate:rpm + + create:aur: + summary: Creates a arch linux packager package + deps: + - task: build + vars: + PRODUCTION: "true" + cmds: + - task: generate:dotdesktop + - task: generate:aur + + generate:deb: + summary: Creates a deb package + cmds: + - wails3 tool package -name {{.APP_NAME}} -format deb -config ./build/linux/nfpm/nfpm.yaml -out {{.ROOT_DIR}}/bin + + generate:rpm: + summary: Creates a rpm package + cmds: + - wails3 tool package -name {{.APP_NAME}} -format rpm -config ./build/linux/nfpm/nfpm.yaml -out {{.ROOT_DIR}}/bin + + generate:aur: + summary: Creates a arch linux packager package + cmds: + - wails3 tool package -name {{.APP_NAME}} -format archlinux -config ./build/linux/nfpm/nfpm.yaml -out {{.ROOT_DIR}}/bin + + generate:dotdesktop: + summary: Generates a `.desktop` file + dir: build + cmds: + - mkdir -p {{.ROOT_DIR}}/build/linux/appimage + - wails3 generate .desktop -name "{{.APP_NAME}}" -exec "{{.EXEC}}" -icon "{{.ICON}}" -outputfile {{.ROOT_DIR}}/build/linux/{{.APP_NAME}}.desktop -categories "{{.CATEGORIES}}" + vars: + APP_NAME: '{{.APP_NAME}}' + EXEC: '{{.APP_NAME}}' + ICON: 'appicon' + CATEGORIES: 'Development;' + OUTPUTFILE: '{{.ROOT_DIR}}/build/linux/{{.APP_NAME}}.desktop' + + run: + cmds: + - '{{.BIN_DIR}}/{{.APP_NAME}}' diff --git a/v3/examples/badge-custom/build/linux/appimage/build.sh b/v3/examples/badge-custom/build/linux/appimage/build.sh new file mode 100644 index 000000000..85901c34e --- /dev/null +++ b/v3/examples/badge-custom/build/linux/appimage/build.sh @@ -0,0 +1,35 @@ +#!/usr/bin/env bash +# Copyright (c) 2018-Present Lea Anthony +# SPDX-License-Identifier: MIT + +# Fail script on any error +set -euxo pipefail + +# Define variables +APP_DIR="${APP_NAME}.AppDir" + +# Create AppDir structure +mkdir -p "${APP_DIR}/usr/bin" +cp -r "${APP_BINARY}" "${APP_DIR}/usr/bin/" +cp "${ICON_PATH}" "${APP_DIR}/" +cp "${DESKTOP_FILE}" "${APP_DIR}/" + +if [[ $(uname -m) == *x86_64* ]]; then + # Download linuxdeploy and make it executable + wget -q -4 -N https://github.com/linuxdeploy/linuxdeploy/releases/download/continuous/linuxdeploy-x86_64.AppImage + chmod +x linuxdeploy-x86_64.AppImage + + # Run linuxdeploy to bundle the application + ./linuxdeploy-x86_64.AppImage --appdir "${APP_DIR}" --output appimage +else + # Download linuxdeploy and make it executable (arm64) + wget -q -4 -N https://github.com/linuxdeploy/linuxdeploy/releases/download/continuous/linuxdeploy-aarch64.AppImage + chmod +x linuxdeploy-aarch64.AppImage + + # Run linuxdeploy to bundle the application (arm64) + ./linuxdeploy-aarch64.AppImage --appdir "${APP_DIR}" --output appimage +fi + +# Rename the generated AppImage +mv "${APP_NAME}*.AppImage" "${APP_NAME}.AppImage" + diff --git a/v3/examples/badge-custom/build/linux/nfpm/nfpm.yaml b/v3/examples/badge-custom/build/linux/nfpm/nfpm.yaml new file mode 100644 index 000000000..5b7ea9d02 --- /dev/null +++ b/v3/examples/badge-custom/build/linux/nfpm/nfpm.yaml @@ -0,0 +1,50 @@ +# Feel free to remove those if you don't want/need to use them. +# Make sure to check the documentation at https://nfpm.goreleaser.com +# +# The lines below are called `modelines`. See `:help modeline` + +name: "badge" +arch: ${GOARCH} +platform: "linux" +version: "0.1.0" +section: "default" +priority: "extra" +maintainer: ${GIT_COMMITTER_NAME} <${GIT_COMMITTER_EMAIL}> +description: "My Product Description" +vendor: "My Company" +homepage: "https://wails.io" +license: "MIT" +release: "1" + +contents: + - src: "./bin/badge" + dst: "/usr/local/bin/badge" + - src: "./build/appicon.png" + dst: "/usr/share/icons/hicolor/128x128/apps/badge.png" + - src: "./build/linux/badge.desktop" + dst: "/usr/share/applications/badge.desktop" + +depends: + - gtk3 + - libwebkit2gtk + +# replaces: +# - foobar +# provides: +# - bar +# depends: +# - gtk3 +# - libwebkit2gtk +# recommends: +# - whatever +# suggests: +# - something-else +# conflicts: +# - not-foo +# - not-bar +# changelog: "changelog.yaml" +# scripts: +# preinstall: ./build/linux/nfpm/scripts/preinstall.sh +# postinstall: ./build/linux/nfpm/scripts/postinstall.sh +# preremove: ./build/linux/nfpm/scripts/preremove.sh +# postremove: ./build/linux/nfpm/scripts/postremove.sh diff --git a/v3/examples/badge-custom/build/linux/nfpm/scripts/postinstall.sh b/v3/examples/badge-custom/build/linux/nfpm/scripts/postinstall.sh new file mode 100644 index 000000000..a9bf588e2 --- /dev/null +++ b/v3/examples/badge-custom/build/linux/nfpm/scripts/postinstall.sh @@ -0,0 +1 @@ +#!/bin/bash diff --git a/v3/examples/badge-custom/build/linux/nfpm/scripts/postremove.sh b/v3/examples/badge-custom/build/linux/nfpm/scripts/postremove.sh new file mode 100644 index 000000000..a9bf588e2 --- /dev/null +++ b/v3/examples/badge-custom/build/linux/nfpm/scripts/postremove.sh @@ -0,0 +1 @@ +#!/bin/bash diff --git a/v3/examples/badge-custom/build/linux/nfpm/scripts/preinstall.sh b/v3/examples/badge-custom/build/linux/nfpm/scripts/preinstall.sh new file mode 100644 index 000000000..a9bf588e2 --- /dev/null +++ b/v3/examples/badge-custom/build/linux/nfpm/scripts/preinstall.sh @@ -0,0 +1 @@ +#!/bin/bash diff --git a/v3/examples/badge-custom/build/linux/nfpm/scripts/preremove.sh b/v3/examples/badge-custom/build/linux/nfpm/scripts/preremove.sh new file mode 100644 index 000000000..a9bf588e2 --- /dev/null +++ b/v3/examples/badge-custom/build/linux/nfpm/scripts/preremove.sh @@ -0,0 +1 @@ +#!/bin/bash diff --git a/v3/examples/badge-custom/build/windows/Taskfile.yml b/v3/examples/badge-custom/build/windows/Taskfile.yml new file mode 100644 index 000000000..534f4fb31 --- /dev/null +++ b/v3/examples/badge-custom/build/windows/Taskfile.yml @@ -0,0 +1,63 @@ +version: '3' + +includes: + common: ../Taskfile.yml + +tasks: + build: + summary: Builds the application for Windows + deps: + - task: common:go:mod:tidy + - task: common:build:frontend + vars: + BUILD_FLAGS: + ref: .BUILD_FLAGS + PRODUCTION: + ref: .PRODUCTION + - task: common:generate:icons + cmds: + - task: generate:syso + - go build {{.BUILD_FLAGS}} -o {{.BIN_DIR}}/{{.APP_NAME}}.exe + - cmd: powershell Remove-item *.syso + platforms: [windows] + - cmd: rm -f *.syso + platforms: [linux, darwin] + vars: + BUILD_FLAGS: '{{if eq .PRODUCTION "true"}}-tags production -trimpath -buildvcs=false -ldflags="-w -s -H windowsgui"{{else}}-buildvcs=false -gcflags=all="-l"{{end}}' + env: + GOOS: windows + CGO_ENABLED: 0 + GOARCH: '{{.ARCH | default ARCH}}' + PRODUCTION: '{{.PRODUCTION | default "false"}}' + + package: + summary: Packages a production build of the application into a `.exe` bundle + cmds: + - task: create:nsis:installer + + generate:syso: + summary: Generates Windows `.syso` file + dir: build + cmds: + - wails3 generate syso -arch {{.ARCH}} -icon windows/icon.ico -manifest windows/wails.exe.manifest -info windows/info.json -out ../wails_windows_{{.ARCH}}.syso + vars: + ARCH: '{{.ARCH | default ARCH}}' + + create:nsis:installer: + summary: Creates an NSIS installer + dir: build/windows/nsis + deps: + - task: build + vars: + PRODUCTION: "true" + cmds: + # Create the Microsoft WebView2 bootstrapper if it doesn't exist + - wails3 generate webview2bootstrapper -dir "{{.ROOT_DIR}}/build/windows/nsis" + - makensis -DARG_WAILS_{{.ARG_FLAG}}_BINARY="{{.ROOT_DIR}}/{{.BIN_DIR}}/{{.APP_NAME}}.exe" project.nsi + vars: + ARCH: '{{.ARCH | default ARCH}}' + ARG_FLAG: '{{if eq .ARCH "amd64"}}AMD64{{else}}ARM64{{end}}' + + run: + cmds: + - '{{.BIN_DIR}}/{{.APP_NAME}}.exe' diff --git a/v3/examples/badge-custom/build/windows/icon.ico b/v3/examples/badge-custom/build/windows/icon.ico new file mode 100644 index 000000000..bfa0690b7 Binary files /dev/null and b/v3/examples/badge-custom/build/windows/icon.ico differ diff --git a/v3/examples/badge-custom/build/windows/info.json b/v3/examples/badge-custom/build/windows/info.json new file mode 100644 index 000000000..850b2b5b0 --- /dev/null +++ b/v3/examples/badge-custom/build/windows/info.json @@ -0,0 +1,15 @@ +{ + "fixed": { + "file_version": "0.1.0" + }, + "info": { + "0000": { + "ProductVersion": "0.1.0", + "CompanyName": "My Company", + "FileDescription": "My Product Description", + "LegalCopyright": "© now, My Company", + "ProductName": "My Product", + "Comments": "This is a comment" + } + } +} \ No newline at end of file diff --git a/v3/examples/badge-custom/build/windows/nsis/project.nsi b/v3/examples/badge-custom/build/windows/nsis/project.nsi new file mode 100644 index 000000000..985b8e207 --- /dev/null +++ b/v3/examples/badge-custom/build/windows/nsis/project.nsi @@ -0,0 +1,112 @@ +Unicode true + +#### +## Please note: Template replacements don't work in this file. They are provided with default defines like +## mentioned underneath. +## If the keyword is not defined, "wails_tools.nsh" will populate them. +## If they are defined here, "wails_tools.nsh" will not touch them. This allows you to use this project.nsi manually +## from outside of Wails for debugging and development of the installer. +## +## For development first make a wails nsis build to populate the "wails_tools.nsh": +## > wails build --target windows/amd64 --nsis +## Then you can call makensis on this file with specifying the path to your binary: +## For a AMD64 only installer: +## > makensis -DARG_WAILS_AMD64_BINARY=..\..\bin\app.exe +## For a ARM64 only installer: +## > makensis -DARG_WAILS_ARM64_BINARY=..\..\bin\app.exe +## For a installer with both architectures: +## > makensis -DARG_WAILS_AMD64_BINARY=..\..\bin\app-amd64.exe -DARG_WAILS_ARM64_BINARY=..\..\bin\app-arm64.exe +#### +## The following information is taken from the wails_tools.nsh file, but they can be overwritten here. +#### +## !define INFO_PROJECTNAME "my-project" # Default "badge" +## !define INFO_COMPANYNAME "My Company" # Default "My Company" +## !define INFO_PRODUCTNAME "My Product Name" # Default "My Product" +## !define INFO_PRODUCTVERSION "1.0.0" # Default "0.1.0" +## !define INFO_COPYRIGHT "(c) Now, My Company" # Default "© now, My Company" +### +## !define PRODUCT_EXECUTABLE "Application.exe" # Default "${INFO_PROJECTNAME}.exe" +## !define UNINST_KEY_NAME "UninstKeyInRegistry" # Default "${INFO_COMPANYNAME}${INFO_PRODUCTNAME}" +#### +## !define REQUEST_EXECUTION_LEVEL "admin" # Default "admin" see also https://nsis.sourceforge.io/Docs/Chapter4.html +#### +## Include the wails tools +#### +!include "wails_tools.nsh" + +# The version information for this two must consist of 4 parts +VIProductVersion "${INFO_PRODUCTVERSION}.0" +VIFileVersion "${INFO_PRODUCTVERSION}.0" + +VIAddVersionKey "CompanyName" "${INFO_COMPANYNAME}" +VIAddVersionKey "FileDescription" "${INFO_PRODUCTNAME} Installer" +VIAddVersionKey "ProductVersion" "${INFO_PRODUCTVERSION}" +VIAddVersionKey "FileVersion" "${INFO_PRODUCTVERSION}" +VIAddVersionKey "LegalCopyright" "${INFO_COPYRIGHT}" +VIAddVersionKey "ProductName" "${INFO_PRODUCTNAME}" + +# Enable HiDPI support. https://nsis.sourceforge.io/Reference/ManifestDPIAware +ManifestDPIAware true + +!include "MUI.nsh" + +!define MUI_ICON "..\icon.ico" +!define MUI_UNICON "..\icon.ico" +# !define MUI_WELCOMEFINISHPAGE_BITMAP "resources\leftimage.bmp" #Include this to add a bitmap on the left side of the Welcome Page. Must be a size of 164x314 +!define MUI_FINISHPAGE_NOAUTOCLOSE # Wait on the INSTFILES page so the user can take a look into the details of the installation steps +!define MUI_ABORTWARNING # This will warn the user if they exit from the installer. + +!insertmacro MUI_PAGE_WELCOME # Welcome to the installer page. +# !insertmacro MUI_PAGE_LICENSE "resources\eula.txt" # Adds a EULA page to the installer +!insertmacro MUI_PAGE_DIRECTORY # In which folder install page. +!insertmacro MUI_PAGE_INSTFILES # Installing page. +!insertmacro MUI_PAGE_FINISH # Finished installation page. + +!insertmacro MUI_UNPAGE_INSTFILES # Uninstalling page + +!insertmacro MUI_LANGUAGE "English" # Set the Language of the installer + +## The following two statements can be used to sign the installer and the uninstaller. The path to the binaries are provided in %1 +#!uninstfinalize 'signtool --file "%1"' +#!finalize 'signtool --file "%1"' + +Name "${INFO_PRODUCTNAME}" +OutFile "..\..\..\bin\${INFO_PROJECTNAME}-${ARCH}-installer.exe" # Name of the installer's file. +InstallDir "$PROGRAMFILES64\${INFO_COMPANYNAME}\${INFO_PRODUCTNAME}" # Default installing folder ($PROGRAMFILES is Program Files folder). +ShowInstDetails show # This will always show the installation details. + +Function .onInit + !insertmacro wails.checkArchitecture +FunctionEnd + +Section + !insertmacro wails.setShellContext + + !insertmacro wails.webview2runtime + + SetOutPath $INSTDIR + + !insertmacro wails.files + + CreateShortcut "$SMPROGRAMS\${INFO_PRODUCTNAME}.lnk" "$INSTDIR\${PRODUCT_EXECUTABLE}" + CreateShortCut "$DESKTOP\${INFO_PRODUCTNAME}.lnk" "$INSTDIR\${PRODUCT_EXECUTABLE}" + + !insertmacro wails.associateFiles + + !insertmacro wails.writeUninstaller +SectionEnd + +Section "uninstall" + !insertmacro wails.setShellContext + + RMDir /r "$AppData\${PRODUCT_EXECUTABLE}" # Remove the WebView2 DataPath + + RMDir /r $INSTDIR + + Delete "$SMPROGRAMS\${INFO_PRODUCTNAME}.lnk" + Delete "$DESKTOP\${INFO_PRODUCTNAME}.lnk" + + !insertmacro wails.unassociateFiles + + !insertmacro wails.deleteUninstaller +SectionEnd diff --git a/v3/examples/badge-custom/build/windows/nsis/wails_tools.nsh b/v3/examples/badge-custom/build/windows/nsis/wails_tools.nsh new file mode 100644 index 000000000..6fc10ab79 --- /dev/null +++ b/v3/examples/badge-custom/build/windows/nsis/wails_tools.nsh @@ -0,0 +1,212 @@ +# DO NOT EDIT - Generated automatically by `wails build` + +!include "x64.nsh" +!include "WinVer.nsh" +!include "FileFunc.nsh" + +!ifndef INFO_PROJECTNAME + !define INFO_PROJECTNAME "badge" +!endif +!ifndef INFO_COMPANYNAME + !define INFO_COMPANYNAME "My Company" +!endif +!ifndef INFO_PRODUCTNAME + !define INFO_PRODUCTNAME "My Product" +!endif +!ifndef INFO_PRODUCTVERSION + !define INFO_PRODUCTVERSION "0.1.0" +!endif +!ifndef INFO_COPYRIGHT + !define INFO_COPYRIGHT "© now, My Company" +!endif +!ifndef PRODUCT_EXECUTABLE + !define PRODUCT_EXECUTABLE "${INFO_PROJECTNAME}.exe" +!endif +!ifndef UNINST_KEY_NAME + !define UNINST_KEY_NAME "${INFO_COMPANYNAME}${INFO_PRODUCTNAME}" +!endif +!define UNINST_KEY "Software\Microsoft\Windows\CurrentVersion\Uninstall\${UNINST_KEY_NAME}" + +!ifndef REQUEST_EXECUTION_LEVEL + !define REQUEST_EXECUTION_LEVEL "admin" +!endif + +RequestExecutionLevel "${REQUEST_EXECUTION_LEVEL}" + +!ifdef ARG_WAILS_AMD64_BINARY + !define SUPPORTS_AMD64 +!endif + +!ifdef ARG_WAILS_ARM64_BINARY + !define SUPPORTS_ARM64 +!endif + +!ifdef SUPPORTS_AMD64 + !ifdef SUPPORTS_ARM64 + !define ARCH "amd64_arm64" + !else + !define ARCH "amd64" + !endif +!else + !ifdef SUPPORTS_ARM64 + !define ARCH "arm64" + !else + !error "Wails: Undefined ARCH, please provide at least one of ARG_WAILS_AMD64_BINARY or ARG_WAILS_ARM64_BINARY" + !endif +!endif + +!macro wails.checkArchitecture + !ifndef WAILS_WIN10_REQUIRED + !define WAILS_WIN10_REQUIRED "This product is only supported on Windows 10 (Server 2016) and later." + !endif + + !ifndef WAILS_ARCHITECTURE_NOT_SUPPORTED + !define WAILS_ARCHITECTURE_NOT_SUPPORTED "This product can't be installed on the current Windows architecture. Supports: ${ARCH}" + !endif + + ${If} ${AtLeastWin10} + !ifdef SUPPORTS_AMD64 + ${if} ${IsNativeAMD64} + Goto ok + ${EndIf} + !endif + + !ifdef SUPPORTS_ARM64 + ${if} ${IsNativeARM64} + Goto ok + ${EndIf} + !endif + + IfSilent silentArch notSilentArch + silentArch: + SetErrorLevel 65 + Abort + notSilentArch: + MessageBox MB_OK "${WAILS_ARCHITECTURE_NOT_SUPPORTED}" + Quit + ${else} + IfSilent silentWin notSilentWin + silentWin: + SetErrorLevel 64 + Abort + notSilentWin: + MessageBox MB_OK "${WAILS_WIN10_REQUIRED}" + Quit + ${EndIf} + + ok: +!macroend + +!macro wails.files + !ifdef SUPPORTS_AMD64 + ${if} ${IsNativeAMD64} + File "/oname=${PRODUCT_EXECUTABLE}" "${ARG_WAILS_AMD64_BINARY}" + ${EndIf} + !endif + + !ifdef SUPPORTS_ARM64 + ${if} ${IsNativeARM64} + File "/oname=${PRODUCT_EXECUTABLE}" "${ARG_WAILS_ARM64_BINARY}" + ${EndIf} + !endif +!macroend + +!macro wails.writeUninstaller + WriteUninstaller "$INSTDIR\uninstall.exe" + + SetRegView 64 + WriteRegStr HKLM "${UNINST_KEY}" "Publisher" "${INFO_COMPANYNAME}" + WriteRegStr HKLM "${UNINST_KEY}" "DisplayName" "${INFO_PRODUCTNAME}" + WriteRegStr HKLM "${UNINST_KEY}" "DisplayVersion" "${INFO_PRODUCTVERSION}" + WriteRegStr HKLM "${UNINST_KEY}" "DisplayIcon" "$INSTDIR\${PRODUCT_EXECUTABLE}" + WriteRegStr HKLM "${UNINST_KEY}" "UninstallString" "$\"$INSTDIR\uninstall.exe$\"" + WriteRegStr HKLM "${UNINST_KEY}" "QuietUninstallString" "$\"$INSTDIR\uninstall.exe$\" /S" + + ${GetSize} "$INSTDIR" "/S=0K" $0 $1 $2 + IntFmt $0 "0x%08X" $0 + WriteRegDWORD HKLM "${UNINST_KEY}" "EstimatedSize" "$0" +!macroend + +!macro wails.deleteUninstaller + Delete "$INSTDIR\uninstall.exe" + + SetRegView 64 + DeleteRegKey HKLM "${UNINST_KEY}" +!macroend + +!macro wails.setShellContext + ${If} ${REQUEST_EXECUTION_LEVEL} == "admin" + SetShellVarContext all + ${else} + SetShellVarContext current + ${EndIf} +!macroend + +# Install webview2 by launching the bootstrapper +# See https://docs.microsoft.com/en-us/microsoft-edge/webview2/concepts/distribution#online-only-deployment +!macro wails.webview2runtime + !ifndef WAILS_INSTALL_WEBVIEW_DETAILPRINT + !define WAILS_INSTALL_WEBVIEW_DETAILPRINT "Installing: WebView2 Runtime" + !endif + + SetRegView 64 + # If the admin key exists and is not empty then webview2 is already installed + ReadRegStr $0 HKLM "SOFTWARE\WOW6432Node\Microsoft\EdgeUpdate\Clients\{F3017226-FE2A-4295-8BDF-00C3A9A7E4C5}" "pv" + ${If} $0 != "" + Goto ok + ${EndIf} + + ${If} ${REQUEST_EXECUTION_LEVEL} == "user" + # If the installer is run in user level, check the user specific key exists and is not empty then webview2 is already installed + ReadRegStr $0 HKCU "Software\Microsoft\EdgeUpdate\Clients\{F3017226-FE2A-4295-8BDF-00C3A9A7E4C5}" "pv" + ${If} $0 != "" + Goto ok + ${EndIf} + ${EndIf} + + SetDetailsPrint both + DetailPrint "${WAILS_INSTALL_WEBVIEW_DETAILPRINT}" + SetDetailsPrint listonly + + InitPluginsDir + CreateDirectory "$pluginsdir\webview2bootstrapper" + SetOutPath "$pluginsdir\webview2bootstrapper" + File "MicrosoftEdgeWebview2Setup.exe" + ExecWait '"$pluginsdir\webview2bootstrapper\MicrosoftEdgeWebview2Setup.exe" /silent /install' + + SetDetailsPrint both + ok: +!macroend + +# Copy of APP_ASSOCIATE and APP_UNASSOCIATE macros from here https://gist.github.com/nikku/281d0ef126dbc215dd58bfd5b3a5cd5b +!macro APP_ASSOCIATE EXT FILECLASS DESCRIPTION ICON COMMANDTEXT COMMAND + ; Backup the previously associated file class + ReadRegStr $R0 SHELL_CONTEXT "Software\Classes\.${EXT}" "" + WriteRegStr SHELL_CONTEXT "Software\Classes\.${EXT}" "${FILECLASS}_backup" "$R0" + + WriteRegStr SHELL_CONTEXT "Software\Classes\.${EXT}" "" "${FILECLASS}" + + WriteRegStr SHELL_CONTEXT "Software\Classes\${FILECLASS}" "" `${DESCRIPTION}` + WriteRegStr SHELL_CONTEXT "Software\Classes\${FILECLASS}\DefaultIcon" "" `${ICON}` + WriteRegStr SHELL_CONTEXT "Software\Classes\${FILECLASS}\shell" "" "open" + WriteRegStr SHELL_CONTEXT "Software\Classes\${FILECLASS}\shell\open" "" `${COMMANDTEXT}` + WriteRegStr SHELL_CONTEXT "Software\Classes\${FILECLASS}\shell\open\command" "" `${COMMAND}` +!macroend + +!macro APP_UNASSOCIATE EXT FILECLASS + ; Backup the previously associated file class + ReadRegStr $R0 SHELL_CONTEXT "Software\Classes\.${EXT}" `${FILECLASS}_backup` + WriteRegStr SHELL_CONTEXT "Software\Classes\.${EXT}" "" "$R0" + + DeleteRegKey SHELL_CONTEXT `Software\Classes\${FILECLASS}` +!macroend + +!macro wails.associateFiles + ; Create file associations + +!macroend + +!macro wails.unassociateFiles + ; Delete app associations + +!macroend \ No newline at end of file diff --git a/v3/examples/badge-custom/build/windows/wails.exe.manifest b/v3/examples/badge-custom/build/windows/wails.exe.manifest new file mode 100644 index 000000000..1d8992a3d --- /dev/null +++ b/v3/examples/badge-custom/build/windows/wails.exe.manifest @@ -0,0 +1,15 @@ + + + + + + + + + + + true/pm + permonitorv2,permonitor + + + \ No newline at end of file diff --git a/v3/examples/badge-custom/frontend/Inter Font License.txt b/v3/examples/badge-custom/frontend/Inter Font License.txt new file mode 100644 index 000000000..b525cbf3a --- /dev/null +++ b/v3/examples/badge-custom/frontend/Inter Font License.txt @@ -0,0 +1,93 @@ +Copyright 2020 The Inter Project Authors (https://github.com/rsms/inter) + +This Font Software is licensed under the SIL Open Font License, Version 1.1. +This license is copied below, and is also available with a FAQ at: +http://scripts.sil.org/OFL + + +----------------------------------------------------------- +SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007 +----------------------------------------------------------- + +PREAMBLE +The goals of the Open Font License (OFL) are to stimulate worldwide +development of collaborative font projects, to support the font creation +efforts of academic and linguistic communities, and to provide a free and +open framework in which fonts may be shared and improved in partnership +with others. + +The OFL allows the licensed fonts to be used, studied, modified and +redistributed freely as long as they are not sold by themselves. The +fonts, including any derivative works, can be bundled, embedded, +redistributed and/or sold with any software provided that any reserved +names are not used by derivative works. The fonts and derivatives, +however, cannot be released under any other type of license. The +requirement for fonts to remain under this license does not apply +to any document created using the fonts or their derivatives. + +DEFINITIONS +"Font Software" refers to the set of files released by the Copyright +Holder(s) under this license and clearly marked as such. This may +include source files, build scripts and documentation. + +"Reserved Font Name" refers to any names specified as such after the +copyright statement(s). + +"Original Version" refers to the collection of Font Software components as +distributed by the Copyright Holder(s). + +"Modified Version" refers to any derivative made by adding to, deleting, +or substituting -- in part or in whole -- any of the components of the +Original Version, by changing formats or by porting the Font Software to a +new environment. + +"Author" refers to any designer, engineer, programmer, technical +writer or other person who contributed to the Font Software. + +PERMISSION & CONDITIONS +Permission is hereby granted, free of charge, to any person obtaining +a copy of the Font Software, to use, study, copy, merge, embed, modify, +redistribute, and sell modified and unmodified copies of the Font +Software, subject to the following conditions: + +1) Neither the Font Software nor any of its individual components, +in Original or Modified Versions, may be sold by itself. + +2) Original or Modified Versions of the Font Software may be bundled, +redistributed and/or sold with any software, provided that each copy +contains the above copyright notice and this license. These can be +included either as stand-alone text files, human-readable headers or +in the appropriate machine-readable metadata fields within text or +binary files as long as those fields can be easily viewed by the user. + +3) No Modified Version of the Font Software may use the Reserved Font +Name(s) unless explicit written permission is granted by the corresponding +Copyright Holder. This restriction only applies to the primary font name as +presented to the users. + +4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font +Software shall not be used to promote, endorse or advertise any +Modified Version, except to acknowledge the contribution(s) of the +Copyright Holder(s) and the Author(s) or with their explicit written +permission. + +5) The Font Software, modified or unmodified, in part or in whole, +must be distributed entirely under this license, and must not be +distributed under any other license. The requirement for fonts to +remain under this license does not apply to any document created +using the Font Software. + +TERMINATION +This license becomes null and void if any of the above conditions are +not met. + +DISCLAIMER +THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF +MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT +OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE +COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, +INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL +DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING +FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM +OTHER DEALINGS IN THE FONT SOFTWARE. diff --git a/v3/examples/badge-custom/frontend/bindings/github.com/wailsapp/wails/v3/pkg/services/dock/dockservice.ts b/v3/examples/badge-custom/frontend/bindings/github.com/wailsapp/wails/v3/pkg/services/dock/dockservice.ts new file mode 100644 index 000000000..abf1f22e4 --- /dev/null +++ b/v3/examples/badge-custom/frontend/bindings/github.com/wailsapp/wails/v3/pkg/services/dock/dockservice.ts @@ -0,0 +1,53 @@ +// Cynhyrchwyd y ffeil hon yn awtomatig. PEIDIWCH Â MODIWL +// This file is automatically generated. DO NOT EDIT + +/** + * Service represents the dock service + * @module + */ + +// eslint-disable-next-line @typescript-eslint/ban-ts-comment +// @ts-ignore: Unused imports +import { Call as $Call, CancellablePromise as $CancellablePromise, Create as $Create } from "@wailsio/runtime"; + +// eslint-disable-next-line @typescript-eslint/ban-ts-comment +// @ts-ignore: Unused imports +import * as $models from "./models.js"; + +/** + * HideAppIcon hides the app icon in the dock/taskbar. + */ +export function HideAppIcon(): $CancellablePromise { + return $Call.ByID(3413658144); +} + +/** + * RemoveBadge removes the badge label from the application icon. + * This method ensures the badge call is made on the main thread to avoid crashes. + */ +export function RemoveBadge(): $CancellablePromise { + return $Call.ByID(2752757297); +} + +/** + * SetBadge sets the badge label on the application icon. + * This method ensures the badge call is made on the main thread to avoid crashes. + */ +export function SetBadge(label: string): $CancellablePromise { + return $Call.ByID(1717705661, label); +} + +/** + * SetCustomBadge sets the badge label on the application icon with custom options. + * This method ensures the badge call is made on the main thread to avoid crashes. + */ +export function SetCustomBadge(label: string, options: $models.BadgeOptions): $CancellablePromise { + return $Call.ByID(2730169760, label, options); +} + +/** + * ShowAppIcon shows the app icon in the dock/taskbar. + */ +export function ShowAppIcon(): $CancellablePromise { + return $Call.ByID(3409697379); +} diff --git a/v3/examples/badge-custom/frontend/bindings/github.com/wailsapp/wails/v3/pkg/services/dock/index.ts b/v3/examples/badge-custom/frontend/bindings/github.com/wailsapp/wails/v3/pkg/services/dock/index.ts new file mode 100644 index 000000000..fbdaf19f3 --- /dev/null +++ b/v3/examples/badge-custom/frontend/bindings/github.com/wailsapp/wails/v3/pkg/services/dock/index.ts @@ -0,0 +1,11 @@ +// Cynhyrchwyd y ffeil hon yn awtomatig. PEIDIWCH Â MODIWL +// This file is automatically generated. DO NOT EDIT + +import * as DockService from "./dockservice.js"; +export { + DockService +}; + +export { + BadgeOptions +} from "./models.js"; diff --git a/v3/examples/badge-custom/frontend/bindings/github.com/wailsapp/wails/v3/pkg/services/dock/models.ts b/v3/examples/badge-custom/frontend/bindings/github.com/wailsapp/wails/v3/pkg/services/dock/models.ts new file mode 100644 index 000000000..f97c8a4c6 --- /dev/null +++ b/v3/examples/badge-custom/frontend/bindings/github.com/wailsapp/wails/v3/pkg/services/dock/models.ts @@ -0,0 +1,61 @@ +// Cynhyrchwyd y ffeil hon yn awtomatig. PEIDIWCH Â MODIWL +// This file is automatically generated. DO NOT EDIT + +// eslint-disable-next-line @typescript-eslint/ban-ts-comment +// @ts-ignore: Unused imports +import { Create as $Create } from "@wailsio/runtime"; + +// eslint-disable-next-line @typescript-eslint/ban-ts-comment +// @ts-ignore: Unused imports +import * as color$0 from "../../../../../../../image/color/models.js"; + +/** + * BadgeOptions represents options for customizing badge appearance + */ +export class BadgeOptions { + "TextColour": color$0.RGBA; + "BackgroundColour": color$0.RGBA; + "FontName": string; + "FontSize": number; + "SmallFontSize": number; + + /** Creates a new BadgeOptions instance. */ + constructor($$source: Partial = {}) { + if (!("TextColour" in $$source)) { + this["TextColour"] = (new color$0.RGBA()); + } + if (!("BackgroundColour" in $$source)) { + this["BackgroundColour"] = (new color$0.RGBA()); + } + if (!("FontName" in $$source)) { + this["FontName"] = ""; + } + if (!("FontSize" in $$source)) { + this["FontSize"] = 0; + } + if (!("SmallFontSize" in $$source)) { + this["SmallFontSize"] = 0; + } + + Object.assign(this, $$source); + } + + /** + * Creates a new BadgeOptions instance from a string or object. + */ + static createFrom($$source: any = {}): BadgeOptions { + const $$createField0_0 = $$createType0; + const $$createField1_0 = $$createType0; + let $$parsedSource = typeof $$source === 'string' ? JSON.parse($$source) : $$source; + if ("TextColour" in $$parsedSource) { + $$parsedSource["TextColour"] = $$createField0_0($$parsedSource["TextColour"]); + } + if ("BackgroundColour" in $$parsedSource) { + $$parsedSource["BackgroundColour"] = $$createField1_0($$parsedSource["BackgroundColour"]); + } + return new BadgeOptions($$parsedSource as Partial); + } +} + +// Private type creation functions +const $$createType0 = color$0.RGBA.createFrom; diff --git a/v3/examples/badge-custom/frontend/bindings/image/color/index.ts b/v3/examples/badge-custom/frontend/bindings/image/color/index.ts new file mode 100644 index 000000000..97b507b08 --- /dev/null +++ b/v3/examples/badge-custom/frontend/bindings/image/color/index.ts @@ -0,0 +1,6 @@ +// Cynhyrchwyd y ffeil hon yn awtomatig. PEIDIWCH Â MODIWL +// This file is automatically generated. DO NOT EDIT + +export { + RGBA +} from "./models.js"; diff --git a/v3/examples/badge-custom/frontend/bindings/image/color/models.ts b/v3/examples/badge-custom/frontend/bindings/image/color/models.ts new file mode 100644 index 000000000..0d4eab56d --- /dev/null +++ b/v3/examples/badge-custom/frontend/bindings/image/color/models.ts @@ -0,0 +1,46 @@ +// Cynhyrchwyd y ffeil hon yn awtomatig. PEIDIWCH Â MODIWL +// This file is automatically generated. DO NOT EDIT + +// eslint-disable-next-line @typescript-eslint/ban-ts-comment +// @ts-ignore: Unused imports +import { Create as $Create } from "@wailsio/runtime"; + +/** + * RGBA represents a traditional 32-bit alpha-premultiplied color, having 8 + * bits for each of red, green, blue and alpha. + * + * An alpha-premultiplied color component C has been scaled by alpha (A), so + * has valid values 0 <= C <= A. + */ +export class RGBA { + "R": number; + "G": number; + "B": number; + "A": number; + + /** Creates a new RGBA instance. */ + constructor($$source: Partial = {}) { + if (!("R" in $$source)) { + this["R"] = 0; + } + if (!("G" in $$source)) { + this["G"] = 0; + } + if (!("B" in $$source)) { + this["B"] = 0; + } + if (!("A" in $$source)) { + this["A"] = 0; + } + + Object.assign(this, $$source); + } + + /** + * Creates a new RGBA instance from a string or object. + */ + static createFrom($$source: any = {}): RGBA { + let $$parsedSource = typeof $$source === 'string' ? JSON.parse($$source) : $$source; + return new RGBA($$parsedSource as Partial); + } +} diff --git a/v3/examples/badge-custom/frontend/dist/Inter-Medium.ttf b/v3/examples/badge-custom/frontend/dist/Inter-Medium.ttf new file mode 100644 index 000000000..a01f3777a Binary files /dev/null and b/v3/examples/badge-custom/frontend/dist/Inter-Medium.ttf differ diff --git a/v3/examples/badge-custom/frontend/dist/assets/index-DOJs-2ns.js b/v3/examples/badge-custom/frontend/dist/assets/index-DOJs-2ns.js new file mode 100644 index 000000000..780f115b6 --- /dev/null +++ b/v3/examples/badge-custom/frontend/dist/assets/index-DOJs-2ns.js @@ -0,0 +1,1415 @@ +var __defProp = Object.defineProperty; +var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value; +var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "symbol" ? key + "" : key, value); +(function polyfill() { + const relList = document.createElement("link").relList; + if (relList && relList.supports && relList.supports("modulepreload")) { + return; + } + for (const link of document.querySelectorAll('link[rel="modulepreload"]')) { + processPreload(link); + } + new MutationObserver((mutations) => { + for (const mutation of mutations) { + if (mutation.type !== "childList") { + continue; + } + for (const node of mutation.addedNodes) { + if (node.tagName === "LINK" && node.rel === "modulepreload") + processPreload(node); + } + } + }).observe(document, { childList: true, subtree: true }); + function getFetchOpts(link) { + const fetchOpts = {}; + if (link.integrity) fetchOpts.integrity = link.integrity; + if (link.referrerPolicy) fetchOpts.referrerPolicy = link.referrerPolicy; + if (link.crossOrigin === "use-credentials") + fetchOpts.credentials = "include"; + else if (link.crossOrigin === "anonymous") fetchOpts.credentials = "omit"; + else fetchOpts.credentials = "same-origin"; + return fetchOpts; + } + function processPreload(link) { + if (link.ep) + return; + link.ep = true; + const fetchOpts = getFetchOpts(link); + fetch(link.href, fetchOpts); + } +})(); +const urlAlphabet = "useandom-26T198340PX75pxJACKVERYMINDBUSHWOLF_GQZbfghjklqvwyzrict"; +function nanoid(size = 21) { + let id = ""; + let i = size | 0; + while (i--) { + id += urlAlphabet[Math.random() * 64 | 0]; + } + return id; +} +const runtimeURL = window.location.origin + "/wails/runtime"; +const objectNames = Object.freeze({ + Call: 0, + Clipboard: 1, + Application: 2, + Events: 3, + ContextMenu: 4, + Dialog: 5, + Window: 6, + Screens: 7, + System: 8, + Browser: 9, + CancelCall: 10 +}); +let clientId = nanoid(); +function newRuntimeCaller(object, windowName = "") { + return function(method, args = null) { + return runtimeCallWithID(object, method, windowName, args); + }; +} +async function runtimeCallWithID(objectID, method, windowName, args) { + var _a2, _b; + let url = new URL(runtimeURL); + url.searchParams.append("object", objectID.toString()); + url.searchParams.append("method", method.toString()); + if (args) { + url.searchParams.append("args", JSON.stringify(args)); + } + let headers = { + ["x-wails-client-id"]: clientId + }; + if (windowName) { + headers["x-wails-window-name"] = windowName; + } + let response = await fetch(url, { headers }); + if (!response.ok) { + throw new Error(await response.text()); + } + if (((_b = (_a2 = response.headers.get("Content-Type")) === null || _a2 === void 0 ? void 0 : _a2.indexOf("application/json")) !== null && _b !== void 0 ? _b : -1) !== -1) { + return response.json(); + } else { + return response.text(); + } +} +newRuntimeCaller(objectNames.System); +const _invoke = function() { + var _a2, _b, _c, _d, _e; + try { + if ((_b = (_a2 = window.chrome) === null || _a2 === void 0 ? void 0 : _a2.webview) === null || _b === void 0 ? void 0 : _b.postMessage) { + return window.chrome.webview.postMessage.bind(window.chrome.webview); + } else if ((_e = (_d = (_c = window.webkit) === null || _c === void 0 ? void 0 : _c.messageHandlers) === null || _d === void 0 ? void 0 : _d["external"]) === null || _e === void 0 ? void 0 : _e.postMessage) { + return window.webkit.messageHandlers["external"].postMessage.bind(window.webkit.messageHandlers["external"]); + } + } catch (e) { + } + console.warn("\n%c⚠️ Browser Environment Detected %c\n\n%cOnly UI previews are available in the browser. For full functionality, please run the application in desktop mode.\nMore information at: https://v3.wails.io/learn/build/#using-a-browser-for-development\n", "background: #ffffff; color: #000000; font-weight: bold; padding: 4px 8px; border-radius: 4px; border: 2px solid #000000;", "background: transparent;", "color: #ffffff; font-style: italic; font-weight: bold;"); + return null; +}(); +function invoke(msg) { + _invoke === null || _invoke === void 0 ? void 0 : _invoke(msg); +} +function IsWindows() { + return window._wails.environment.OS === "windows"; +} +function IsDebug() { + return Boolean(window._wails.environment.Debug); +} +function canTrackButtons() { + return new MouseEvent("mousedown").buttons === 0; +} +function eventTarget(event) { + var _a2; + if (event.target instanceof HTMLElement) { + return event.target; + } else if (!(event.target instanceof HTMLElement) && event.target instanceof Node) { + return (_a2 = event.target.parentElement) !== null && _a2 !== void 0 ? _a2 : document.body; + } else { + return document.body; + } +} +document.addEventListener("DOMContentLoaded", () => { +}); +window.addEventListener("contextmenu", contextMenuHandler); +const call$2 = newRuntimeCaller(objectNames.ContextMenu); +const ContextMenuOpen = 0; +function openContextMenu(id, x, y, data) { + void call$2(ContextMenuOpen, { id, x, y, data }); +} +function contextMenuHandler(event) { + const target = eventTarget(event); + const customContextMenu = window.getComputedStyle(target).getPropertyValue("--custom-contextmenu").trim(); + if (customContextMenu) { + event.preventDefault(); + const data = window.getComputedStyle(target).getPropertyValue("--custom-contextmenu-data"); + openContextMenu(customContextMenu, event.clientX, event.clientY, data); + } else { + processDefaultContextMenu(event, target); + } +} +function processDefaultContextMenu(event, target) { + if (IsDebug()) { + return; + } + switch (window.getComputedStyle(target).getPropertyValue("--default-contextmenu").trim()) { + case "show": + return; + case "hide": + event.preventDefault(); + return; + } + if (target.isContentEditable) { + return; + } + const selection = window.getSelection(); + const hasSelection = selection && selection.toString().length > 0; + if (hasSelection) { + for (let i = 0; i < selection.rangeCount; i++) { + const range = selection.getRangeAt(i); + const rects = range.getClientRects(); + for (let j = 0; j < rects.length; j++) { + const rect = rects[j]; + if (document.elementFromPoint(rect.left, rect.top) === target) { + return; + } + } + } + } + if (target instanceof HTMLInputElement || target instanceof HTMLTextAreaElement) { + if (hasSelection || !target.readOnly && !target.disabled) { + return; + } + } + event.preventDefault(); +} +function GetFlag(key) { + try { + return window._wails.flags[key]; + } catch (e) { + throw new Error("Unable to retrieve flag '" + key + "': " + e, { cause: e }); + } +} +let canDrag = false; +let dragging = false; +let resizable = false; +let canResize = false; +let resizing = false; +let resizeEdge = ""; +let defaultCursor = "auto"; +let buttons = 0; +const buttonsTracked = canTrackButtons(); +window._wails = window._wails || {}; +window._wails.setResizable = (value) => { + resizable = value; + if (!resizable) { + canResize = resizing = false; + setResize(); + } +}; +window.addEventListener("mousedown", update, { capture: true }); +window.addEventListener("mousemove", update, { capture: true }); +window.addEventListener("mouseup", update, { capture: true }); +for (const ev of ["click", "contextmenu", "dblclick"]) { + window.addEventListener(ev, suppressEvent, { capture: true }); +} +function suppressEvent(event) { + if (dragging || resizing) { + event.stopImmediatePropagation(); + event.stopPropagation(); + event.preventDefault(); + } +} +const MouseDown = 0; +const MouseUp = 1; +const MouseMove = 2; +function update(event) { + let eventType, eventButtons = event.buttons; + switch (event.type) { + case "mousedown": + eventType = MouseDown; + if (!buttonsTracked) { + eventButtons = buttons | 1 << event.button; + } + break; + case "mouseup": + eventType = MouseUp; + if (!buttonsTracked) { + eventButtons = buttons & ~(1 << event.button); + } + break; + default: + eventType = MouseMove; + if (!buttonsTracked) { + eventButtons = buttons; + } + break; + } + let released = buttons & ~eventButtons; + let pressed = eventButtons & ~buttons; + buttons = eventButtons; + if (eventType === MouseDown && !(pressed & event.button)) { + released |= 1 << event.button; + pressed |= 1 << event.button; + } + if (eventType !== MouseMove && resizing || dragging && (eventType === MouseDown || event.button !== 0)) { + event.stopImmediatePropagation(); + event.stopPropagation(); + event.preventDefault(); + } + if (released & 1) { + primaryUp(); + } + if (pressed & 1) { + primaryDown(event); + } + if (eventType === MouseMove) { + onMouseMove(event); + } +} +function primaryDown(event) { + canDrag = false; + canResize = false; + if (!IsWindows()) { + if (event.type === "mousedown" && event.button === 0 && event.detail !== 1) { + return; + } + } + if (resizeEdge) { + canResize = true; + return; + } + const target = eventTarget(event); + const style = window.getComputedStyle(target); + canDrag = style.getPropertyValue("--wails-draggable").trim() === "drag" && (event.offsetX - parseFloat(style.paddingLeft) < target.clientWidth && event.offsetY - parseFloat(style.paddingTop) < target.clientHeight); +} +function primaryUp(event) { + canDrag = false; + dragging = false; + canResize = false; + resizing = false; +} +const cursorForEdge = Object.freeze({ + "se-resize": "nwse-resize", + "sw-resize": "nesw-resize", + "nw-resize": "nwse-resize", + "ne-resize": "nesw-resize", + "w-resize": "ew-resize", + "n-resize": "ns-resize", + "s-resize": "ns-resize", + "e-resize": "ew-resize" +}); +function setResize(edge) { + if (edge) { + if (!resizeEdge) { + defaultCursor = document.body.style.cursor; + } + document.body.style.cursor = cursorForEdge[edge]; + } else if (!edge && resizeEdge) { + document.body.style.cursor = defaultCursor; + } + resizeEdge = edge || ""; +} +function onMouseMove(event) { + if (canResize && resizeEdge) { + resizing = true; + invoke("wails:resize:" + resizeEdge); + } else if (canDrag) { + dragging = true; + invoke("wails:drag"); + } + if (dragging || resizing) { + canDrag = canResize = false; + return; + } + if (!resizable || !IsWindows()) { + if (resizeEdge) { + setResize(); + } + return; + } + const resizeHandleHeight = GetFlag("system.resizeHandleHeight") || 5; + const resizeHandleWidth = GetFlag("system.resizeHandleWidth") || 5; + const cornerExtra = GetFlag("resizeCornerExtra") || 10; + const rightBorder = window.outerWidth - event.clientX < resizeHandleWidth; + const leftBorder = event.clientX < resizeHandleWidth; + const topBorder = event.clientY < resizeHandleHeight; + const bottomBorder = window.outerHeight - event.clientY < resizeHandleHeight; + const rightCorner = window.outerWidth - event.clientX < resizeHandleWidth + cornerExtra; + const leftCorner = event.clientX < resizeHandleWidth + cornerExtra; + const topCorner = event.clientY < resizeHandleHeight + cornerExtra; + const bottomCorner = window.outerHeight - event.clientY < resizeHandleHeight + cornerExtra; + if (!leftCorner && !topCorner && !bottomCorner && !rightCorner) { + setResize(); + } else if (rightCorner && bottomCorner) + setResize("se-resize"); + else if (leftCorner && bottomCorner) + setResize("sw-resize"); + else if (leftCorner && topCorner) + setResize("nw-resize"); + else if (topCorner && rightCorner) + setResize("ne-resize"); + else if (leftBorder) + setResize("w-resize"); + else if (topBorder) + setResize("n-resize"); + else if (bottomBorder) + setResize("s-resize"); + else if (rightBorder) + setResize("e-resize"); + else + setResize(); +} +var fnToStr = Function.prototype.toString; +var reflectApply = typeof Reflect === "object" && Reflect !== null && Reflect.apply; +var badArrayLike; +var isCallableMarker; +if (typeof reflectApply === "function" && typeof Object.defineProperty === "function") { + try { + badArrayLike = Object.defineProperty({}, "length", { + get: function() { + throw isCallableMarker; + } + }); + isCallableMarker = {}; + reflectApply(function() { + throw 42; + }, null, badArrayLike); + } catch (_) { + if (_ !== isCallableMarker) { + reflectApply = null; + } + } +} else { + reflectApply = null; +} +var constructorRegex = /^\s*class\b/; +var isES6ClassFn = function isES6ClassFunction(value) { + try { + var fnStr = fnToStr.call(value); + return constructorRegex.test(fnStr); + } catch (e) { + return false; + } +}; +var tryFunctionObject = function tryFunctionToStr(value) { + try { + if (isES6ClassFn(value)) { + return false; + } + fnToStr.call(value); + return true; + } catch (e) { + return false; + } +}; +var toStr = Object.prototype.toString; +var objectClass = "[object Object]"; +var fnClass = "[object Function]"; +var genClass = "[object GeneratorFunction]"; +var ddaClass = "[object HTMLAllCollection]"; +var ddaClass2 = "[object HTML document.all class]"; +var ddaClass3 = "[object HTMLCollection]"; +var hasToStringTag = typeof Symbol === "function" && !!Symbol.toStringTag; +var isIE68 = !(0 in [,]); +var isDDA = function isDocumentDotAll() { + return false; +}; +if (typeof document === "object") { + var all = document.all; + if (toStr.call(all) === toStr.call(document.all)) { + isDDA = function isDocumentDotAll2(value) { + if ((isIE68 || !value) && (typeof value === "undefined" || typeof value === "object")) { + try { + var str = toStr.call(value); + return (str === ddaClass || str === ddaClass2 || str === ddaClass3 || str === objectClass) && value("") == null; + } catch (e) { + } + } + return false; + }; + } +} +function isCallableRefApply(value) { + if (isDDA(value)) { + return true; + } + if (!value) { + return false; + } + if (typeof value !== "function" && typeof value !== "object") { + return false; + } + try { + reflectApply(value, null, badArrayLike); + } catch (e) { + if (e !== isCallableMarker) { + return false; + } + } + return !isES6ClassFn(value) && tryFunctionObject(value); +} +function isCallableNoRefApply(value) { + if (isDDA(value)) { + return true; + } + if (!value) { + return false; + } + if (typeof value !== "function" && typeof value !== "object") { + return false; + } + if (hasToStringTag) { + return tryFunctionObject(value); + } + if (isES6ClassFn(value)) { + return false; + } + var strClass = toStr.call(value); + if (strClass !== fnClass && strClass !== genClass && !/^\[object HTML/.test(strClass)) { + return false; + } + return tryFunctionObject(value); +} +const isCallable = reflectApply ? isCallableRefApply : isCallableNoRefApply; +var _a; +class CancelError extends Error { + /** + * Constructs a new `CancelError` instance. + * @param message - The error message. + * @param options - Options to be forwarded to the Error constructor. + */ + constructor(message, options) { + super(message, options); + this.name = "CancelError"; + } +} +class CancelledRejectionError extends Error { + /** + * Constructs a new `CancelledRejectionError` instance. + * @param promise - The promise that caused the error originally. + * @param reason - The rejection reason. + * @param info - An optional informative message specifying the circumstances in which the error was thrown. + * Defaults to the string `"Unhandled rejection in cancelled promise."`. + */ + constructor(promise, reason, info) { + super((info !== null && info !== void 0 ? info : "Unhandled rejection in cancelled promise.") + " Reason: " + errorMessage(reason), { cause: reason }); + this.promise = promise; + this.name = "CancelledRejectionError"; + } +} +const barrierSym = Symbol("barrier"); +const cancelImplSym = Symbol("cancelImpl"); +const species = (_a = Symbol.species) !== null && _a !== void 0 ? _a : Symbol("speciesPolyfill"); +class CancellablePromise extends Promise { + /** + * Creates a new `CancellablePromise`. + * + * @param executor - A callback used to initialize the promise. This callback is passed two arguments: + * a `resolve` callback used to resolve the promise with a value + * or the result of another promise (possibly cancellable), + * and a `reject` callback used to reject the promise with a provided reason or error. + * If the value provided to the `resolve` callback is a thenable _and_ cancellable object + * (it has a `then` _and_ a `cancel` method), + * cancellation requests will be forwarded to that object and the oncancelled will not be invoked anymore. + * If any one of the two callbacks is called _after_ the promise has been cancelled, + * the provided values will be cancelled and resolved as usual, + * but their results will be discarded. + * However, if the resolution process ultimately ends up in a rejection + * that is not due to cancellation, the rejection reason + * will be wrapped in a {@link CancelledRejectionError} + * and bubbled up as an unhandled rejection. + * @param oncancelled - It is the caller's responsibility to ensure that any operation + * started by the executor is properly halted upon cancellation. + * This optional callback can be used to that purpose. + * It will be called _synchronously_ with a cancellation cause + * when cancellation is requested, _after_ the promise has already rejected + * with a {@link CancelError}, but _before_ + * any {@link then}/{@link catch}/{@link finally} callback runs. + * If the callback returns a thenable, the promise returned from {@link cancel} + * will only fulfill after the former has settled. + * Unhandled exceptions or rejections from the callback will be wrapped + * in a {@link CancelledRejectionError} and bubbled up as unhandled rejections. + * If the `resolve` callback is called before cancellation with a cancellable promise, + * cancellation requests on this promise will be diverted to that promise, + * and the original `oncancelled` callback will be discarded. + */ + constructor(executor, oncancelled) { + let resolve; + let reject; + super((res, rej) => { + resolve = res; + reject = rej; + }); + if (this.constructor[species] !== Promise) { + throw new TypeError("CancellablePromise does not support transparent subclassing. Please refrain from overriding the [Symbol.species] static property."); + } + let promise = { + promise: this, + resolve, + reject, + get oncancelled() { + return oncancelled !== null && oncancelled !== void 0 ? oncancelled : null; + }, + set oncancelled(cb) { + oncancelled = cb !== null && cb !== void 0 ? cb : void 0; + } + }; + const state = { + get root() { + return state; + }, + resolving: false, + settled: false + }; + void Object.defineProperties(this, { + [barrierSym]: { + configurable: false, + enumerable: false, + writable: true, + value: null + }, + [cancelImplSym]: { + configurable: false, + enumerable: false, + writable: false, + value: cancellerFor(promise, state) + } + }); + const rejector = rejectorFor(promise, state); + try { + executor(resolverFor(promise, state), rejector); + } catch (err) { + if (state.resolving) { + console.log("Unhandled exception in CancellablePromise executor.", err); + } else { + rejector(err); + } + } + } + /** + * Cancels immediately the execution of the operation associated with this promise. + * The promise rejects with a {@link CancelError} instance as reason, + * with the {@link CancelError#cause} property set to the given argument, if any. + * + * Has no effect if called after the promise has already settled; + * repeated calls in particular are safe, but only the first one + * will set the cancellation cause. + * + * The `CancelError` exception _need not_ be handled explicitly _on the promises that are being cancelled:_ + * cancelling a promise with no attached rejection handler does not trigger an unhandled rejection event. + * Therefore, the following idioms are all equally correct: + * ```ts + * new CancellablePromise((resolve, reject) => { ... }).cancel(); + * new CancellablePromise((resolve, reject) => { ... }).then(...).cancel(); + * new CancellablePromise((resolve, reject) => { ... }).then(...).catch(...).cancel(); + * ``` + * Whenever some cancelled promise in a chain rejects with a `CancelError` + * with the same cancellation cause as itself, the error will be discarded silently. + * However, the `CancelError` _will still be delivered_ to all attached rejection handlers + * added by {@link then} and related methods: + * ```ts + * let cancellable = new CancellablePromise((resolve, reject) => { ... }); + * cancellable.then(() => { ... }).catch(console.log); + * cancellable.cancel(); // A CancelError is printed to the console. + * ``` + * If the `CancelError` is not handled downstream by the time it reaches + * a _non-cancelled_ promise, it _will_ trigger an unhandled rejection event, + * just like normal rejections would: + * ```ts + * let cancellable = new CancellablePromise((resolve, reject) => { ... }); + * let chained = cancellable.then(() => { ... }).then(() => { ... }); // No catch... + * cancellable.cancel(); // Unhandled rejection event on chained! + * ``` + * Therefore, it is important to either cancel whole promise chains from their tail, + * as shown in the correct idioms above, or take care of handling errors everywhere. + * + * @returns A cancellable promise that _fulfills_ after the cancel callback (if any) + * and all handlers attached up to the call to cancel have run. + * If the cancel callback returns a thenable, the promise returned by `cancel` + * will also wait for that thenable to settle. + * This enables callers to wait for the cancelled operation to terminate + * without being forced to handle potential errors at the call site. + * ```ts + * cancellable.cancel().then(() => { + * // Cleanup finished, it's safe to do something else. + * }, (err) => { + * // Unreachable: the promise returned from cancel will never reject. + * }); + * ``` + * Note that the returned promise will _not_ handle implicitly any rejection + * that might have occurred already in the cancelled chain. + * It will just track whether registered handlers have been executed or not. + * Therefore, unhandled rejections will never be silently handled by calling cancel. + */ + cancel(cause) { + return new CancellablePromise((resolve) => { + Promise.all([ + this[cancelImplSym](new CancelError("Promise cancelled.", { cause })), + currentBarrier(this) + ]).then(() => resolve(), () => resolve()); + }); + } + /** + * Binds promise cancellation to the abort event of the given {@link AbortSignal}. + * If the signal has already aborted, the promise will be cancelled immediately. + * When either condition is verified, the cancellation cause will be set + * to the signal's abort reason (see {@link AbortSignal#reason}). + * + * Has no effect if called (or if the signal aborts) _after_ the promise has already settled. + * Only the first signal to abort will set the cancellation cause. + * + * For more details about the cancellation process, + * see {@link cancel} and the `CancellablePromise` constructor. + * + * This method enables `await`ing cancellable promises without having + * to store them for future cancellation, e.g.: + * ```ts + * await longRunningOperation().cancelOn(signal); + * ``` + * instead of: + * ```ts + * let promiseToBeCancelled = longRunningOperation(); + * await promiseToBeCancelled; + * ``` + * + * @returns This promise, for method chaining. + */ + cancelOn(signal) { + if (signal.aborted) { + void this.cancel(signal.reason); + } else { + signal.addEventListener("abort", () => void this.cancel(signal.reason), { capture: true }); + } + return this; + } + /** + * Attaches callbacks for the resolution and/or rejection of the `CancellablePromise`. + * + * The optional `oncancelled` argument will be invoked when the returned promise is cancelled, + * with the same semantics as the `oncancelled` argument of the constructor. + * When the parent promise rejects or is cancelled, the `onrejected` callback will run, + * _even after the returned promise has been cancelled:_ + * in that case, should it reject or throw, the reason will be wrapped + * in a {@link CancelledRejectionError} and bubbled up as an unhandled rejection. + * + * @param onfulfilled The callback to execute when the Promise is resolved. + * @param onrejected The callback to execute when the Promise is rejected. + * @returns A `CancellablePromise` for the completion of whichever callback is executed. + * The returned promise is hooked up to propagate cancellation requests up the chain, but not down: + * + * - if the parent promise is cancelled, the `onrejected` handler will be invoked with a `CancelError` + * and the returned promise _will resolve regularly_ with its result; + * - conversely, if the returned promise is cancelled, _the parent promise is cancelled too;_ + * the `onrejected` handler will still be invoked with the parent's `CancelError`, + * but its result will be discarded + * and the returned promise will reject with a `CancelError` as well. + * + * The promise returned from {@link cancel} will fulfill only after all attached handlers + * up the entire promise chain have been run. + * + * If either callback returns a cancellable promise, + * cancellation requests will be diverted to it, + * and the specified `oncancelled` callback will be discarded. + */ + then(onfulfilled, onrejected, oncancelled) { + if (!(this instanceof CancellablePromise)) { + throw new TypeError("CancellablePromise.prototype.then called on an invalid object."); + } + if (!isCallable(onfulfilled)) { + onfulfilled = identity; + } + if (!isCallable(onrejected)) { + onrejected = thrower; + } + if (onfulfilled === identity && onrejected == thrower) { + return new CancellablePromise((resolve) => resolve(this)); + } + const barrier = {}; + this[barrierSym] = barrier; + return new CancellablePromise((resolve, reject) => { + void super.then((value) => { + var _a2; + if (this[barrierSym] === barrier) { + this[barrierSym] = null; + } + (_a2 = barrier.resolve) === null || _a2 === void 0 ? void 0 : _a2.call(barrier); + try { + resolve(onfulfilled(value)); + } catch (err) { + reject(err); + } + }, (reason) => { + var _a2; + if (this[barrierSym] === barrier) { + this[barrierSym] = null; + } + (_a2 = barrier.resolve) === null || _a2 === void 0 ? void 0 : _a2.call(barrier); + try { + resolve(onrejected(reason)); + } catch (err) { + reject(err); + } + }); + }, async (cause) => { + try { + return oncancelled === null || oncancelled === void 0 ? void 0 : oncancelled(cause); + } finally { + await this.cancel(cause); + } + }); + } + /** + * Attaches a callback for only the rejection of the Promise. + * + * The optional `oncancelled` argument will be invoked when the returned promise is cancelled, + * with the same semantics as the `oncancelled` argument of the constructor. + * When the parent promise rejects or is cancelled, the `onrejected` callback will run, + * _even after the returned promise has been cancelled:_ + * in that case, should it reject or throw, the reason will be wrapped + * in a {@link CancelledRejectionError} and bubbled up as an unhandled rejection. + * + * It is equivalent to + * ```ts + * cancellablePromise.then(undefined, onrejected, oncancelled); + * ``` + * and the same caveats apply. + * + * @returns A Promise for the completion of the callback. + * Cancellation requests on the returned promise + * will propagate up the chain to the parent promise, + * but not in the other direction. + * + * The promise returned from {@link cancel} will fulfill only after all attached handlers + * up the entire promise chain have been run. + * + * If `onrejected` returns a cancellable promise, + * cancellation requests will be diverted to it, + * and the specified `oncancelled` callback will be discarded. + * See {@link then} for more details. + */ + catch(onrejected, oncancelled) { + return this.then(void 0, onrejected, oncancelled); + } + /** + * Attaches a callback that is invoked when the CancellablePromise is settled (fulfilled or rejected). The + * resolved value cannot be accessed or modified from the callback. + * The returned promise will settle in the same state as the original one + * after the provided callback has completed execution, + * unless the callback throws or returns a rejecting promise, + * in which case the returned promise will reject as well. + * + * The optional `oncancelled` argument will be invoked when the returned promise is cancelled, + * with the same semantics as the `oncancelled` argument of the constructor. + * Once the parent promise settles, the `onfinally` callback will run, + * _even after the returned promise has been cancelled:_ + * in that case, should it reject or throw, the reason will be wrapped + * in a {@link CancelledRejectionError} and bubbled up as an unhandled rejection. + * + * This method is implemented in terms of {@link then} and the same caveats apply. + * It is polyfilled, hence available in every OS/webview version. + * + * @returns A Promise for the completion of the callback. + * Cancellation requests on the returned promise + * will propagate up the chain to the parent promise, + * but not in the other direction. + * + * The promise returned from {@link cancel} will fulfill only after all attached handlers + * up the entire promise chain have been run. + * + * If `onfinally` returns a cancellable promise, + * cancellation requests will be diverted to it, + * and the specified `oncancelled` callback will be discarded. + * See {@link then} for more details. + */ + finally(onfinally, oncancelled) { + if (!(this instanceof CancellablePromise)) { + throw new TypeError("CancellablePromise.prototype.finally called on an invalid object."); + } + if (!isCallable(onfinally)) { + return this.then(onfinally, onfinally, oncancelled); + } + return this.then((value) => CancellablePromise.resolve(onfinally()).then(() => value), (reason) => CancellablePromise.resolve(onfinally()).then(() => { + throw reason; + }), oncancelled); + } + /** + * We use the `[Symbol.species]` static property, if available, + * to disable the built-in automatic subclassing features from {@link Promise}. + * It is critical for performance reasons that extenders do not override this. + * Once the proposal at https://github.com/tc39/proposal-rm-builtin-subclassing + * is either accepted or retired, this implementation will have to be revised accordingly. + * + * @ignore + * @internal + */ + static get [species]() { + return Promise; + } + static all(values) { + let collected = Array.from(values); + const promise = collected.length === 0 ? CancellablePromise.resolve(collected) : new CancellablePromise((resolve, reject) => { + void Promise.all(collected).then(resolve, reject); + }, (cause) => cancelAll(promise, collected, cause)); + return promise; + } + static allSettled(values) { + let collected = Array.from(values); + const promise = collected.length === 0 ? CancellablePromise.resolve(collected) : new CancellablePromise((resolve, reject) => { + void Promise.allSettled(collected).then(resolve, reject); + }, (cause) => cancelAll(promise, collected, cause)); + return promise; + } + static any(values) { + let collected = Array.from(values); + const promise = collected.length === 0 ? CancellablePromise.resolve(collected) : new CancellablePromise((resolve, reject) => { + void Promise.any(collected).then(resolve, reject); + }, (cause) => cancelAll(promise, collected, cause)); + return promise; + } + static race(values) { + let collected = Array.from(values); + const promise = new CancellablePromise((resolve, reject) => { + void Promise.race(collected).then(resolve, reject); + }, (cause) => cancelAll(promise, collected, cause)); + return promise; + } + /** + * Creates a new cancelled CancellablePromise for the provided cause. + * + * @group Static Methods + */ + static cancel(cause) { + const p = new CancellablePromise(() => { + }); + p.cancel(cause); + return p; + } + /** + * Creates a new CancellablePromise that cancels + * after the specified timeout, with the provided cause. + * + * If the {@link AbortSignal.timeout} factory method is available, + * it is used to base the timeout on _active_ time rather than _elapsed_ time. + * Otherwise, `timeout` falls back to {@link setTimeout}. + * + * @group Static Methods + */ + static timeout(milliseconds, cause) { + const promise = new CancellablePromise(() => { + }); + if (AbortSignal && typeof AbortSignal === "function" && AbortSignal.timeout && typeof AbortSignal.timeout === "function") { + AbortSignal.timeout(milliseconds).addEventListener("abort", () => void promise.cancel(cause)); + } else { + setTimeout(() => void promise.cancel(cause), milliseconds); + } + return promise; + } + static sleep(milliseconds, value) { + return new CancellablePromise((resolve) => { + setTimeout(() => resolve(value), milliseconds); + }); + } + /** + * Creates a new rejected CancellablePromise for the provided reason. + * + * @group Static Methods + */ + static reject(reason) { + return new CancellablePromise((_, reject) => reject(reason)); + } + static resolve(value) { + if (value instanceof CancellablePromise) { + return value; + } + return new CancellablePromise((resolve) => resolve(value)); + } + /** + * Creates a new CancellablePromise and returns it in an object, along with its resolve and reject functions + * and a getter/setter for the cancellation callback. + * + * This method is polyfilled, hence available in every OS/webview version. + * + * @group Static Methods + */ + static withResolvers() { + let result = { oncancelled: null }; + result.promise = new CancellablePromise((resolve, reject) => { + result.resolve = resolve; + result.reject = reject; + }, (cause) => { + var _a2; + (_a2 = result.oncancelled) === null || _a2 === void 0 ? void 0 : _a2.call(result, cause); + }); + return result; + } +} +function cancellerFor(promise, state) { + let cancellationPromise = void 0; + return (reason) => { + if (!state.settled) { + state.settled = true; + state.reason = reason; + promise.reject(reason); + void Promise.prototype.then.call(promise.promise, void 0, (err) => { + if (err !== reason) { + throw err; + } + }); + } + if (!state.reason || !promise.oncancelled) { + return; + } + cancellationPromise = new Promise((resolve) => { + try { + resolve(promise.oncancelled(state.reason.cause)); + } catch (err) { + Promise.reject(new CancelledRejectionError(promise.promise, err, "Unhandled exception in oncancelled callback.")); + } + }).catch((reason2) => { + Promise.reject(new CancelledRejectionError(promise.promise, reason2, "Unhandled rejection in oncancelled callback.")); + }); + promise.oncancelled = null; + return cancellationPromise; + }; +} +function resolverFor(promise, state) { + return (value) => { + if (state.resolving) { + return; + } + state.resolving = true; + if (value === promise.promise) { + if (state.settled) { + return; + } + state.settled = true; + promise.reject(new TypeError("A promise cannot be resolved with itself.")); + return; + } + if (value != null && (typeof value === "object" || typeof value === "function")) { + let then; + try { + then = value.then; + } catch (err) { + state.settled = true; + promise.reject(err); + return; + } + if (isCallable(then)) { + try { + let cancel = value.cancel; + if (isCallable(cancel)) { + const oncancelled = (cause) => { + Reflect.apply(cancel, value, [cause]); + }; + if (state.reason) { + void cancellerFor(Object.assign(Object.assign({}, promise), { oncancelled }), state)(state.reason); + } else { + promise.oncancelled = oncancelled; + } + } + } catch (_a2) { + } + const newState = { + root: state.root, + resolving: false, + get settled() { + return this.root.settled; + }, + set settled(value2) { + this.root.settled = value2; + }, + get reason() { + return this.root.reason; + } + }; + const rejector = rejectorFor(promise, newState); + try { + Reflect.apply(then, value, [resolverFor(promise, newState), rejector]); + } catch (err) { + rejector(err); + } + return; + } + } + if (state.settled) { + return; + } + state.settled = true; + promise.resolve(value); + }; +} +function rejectorFor(promise, state) { + return (reason) => { + if (state.resolving) { + return; + } + state.resolving = true; + if (state.settled) { + try { + if (reason instanceof CancelError && state.reason instanceof CancelError && Object.is(reason.cause, state.reason.cause)) { + return; + } + } catch (_a2) { + } + void Promise.reject(new CancelledRejectionError(promise.promise, reason)); + } else { + state.settled = true; + promise.reject(reason); + } + }; +} +function cancelAll(parent, values, cause) { + const results = []; + for (const value of values) { + let cancel; + try { + if (!isCallable(value.then)) { + continue; + } + cancel = value.cancel; + if (!isCallable(cancel)) { + continue; + } + } catch (_a2) { + continue; + } + let result; + try { + result = Reflect.apply(cancel, value, [cause]); + } catch (err) { + Promise.reject(new CancelledRejectionError(parent, err, "Unhandled exception in cancel method.")); + continue; + } + if (!result) { + continue; + } + results.push((result instanceof Promise ? result : Promise.resolve(result)).catch((reason) => { + Promise.reject(new CancelledRejectionError(parent, reason, "Unhandled rejection in cancel method.")); + })); + } + return Promise.all(results); +} +function identity(x) { + return x; +} +function thrower(reason) { + throw reason; +} +function errorMessage(err) { + try { + if (err instanceof Error || typeof err !== "object" || err.toString !== Object.prototype.toString) { + return "" + err; + } + } catch (_a2) { + } + try { + return JSON.stringify(err); + } catch (_b) { + } + try { + return Object.prototype.toString.call(err); + } catch (_c) { + } + return ""; +} +function currentBarrier(promise) { + var _a2; + let pwr = (_a2 = promise[barrierSym]) !== null && _a2 !== void 0 ? _a2 : {}; + if (!("promise" in pwr)) { + Object.assign(pwr, promiseWithResolvers()); + } + if (promise[barrierSym] == null) { + pwr.resolve(); + promise[barrierSym] = pwr; + } + return pwr.promise; +} +let promiseWithResolvers = Promise.withResolvers; +if (promiseWithResolvers && typeof promiseWithResolvers === "function") { + promiseWithResolvers = promiseWithResolvers.bind(Promise); +} else { + promiseWithResolvers = function() { + let resolve; + let reject; + const promise = new Promise((res, rej) => { + resolve = res; + reject = rej; + }); + return { promise, resolve, reject }; + }; +} +window._wails = window._wails || {}; +window._wails.callResultHandler = resultHandler; +window._wails.callErrorHandler = errorHandler; +const call$1 = newRuntimeCaller(objectNames.Call); +const cancelCall = newRuntimeCaller(objectNames.CancelCall); +const callResponses = /* @__PURE__ */ new Map(); +const CallBinding = 0; +const CancelMethod = 0; +class RuntimeError extends Error { + /** + * Constructs a new RuntimeError instance. + * @param message - The error message. + * @param options - Options to be forwarded to the Error constructor. + */ + constructor(message, options) { + super(message, options); + this.name = "RuntimeError"; + } +} +function resultHandler(id, data, isJSON) { + const resolvers = getAndDeleteResponse(id); + if (!resolvers) { + return; + } + if (!data) { + resolvers.resolve(void 0); + } else if (!isJSON) { + resolvers.resolve(data); + } else { + try { + resolvers.resolve(JSON.parse(data)); + } catch (err) { + resolvers.reject(new TypeError("could not parse result: " + err.message, { cause: err })); + } + } +} +function errorHandler(id, data, isJSON) { + const resolvers = getAndDeleteResponse(id); + if (!resolvers) { + return; + } + if (!isJSON) { + resolvers.reject(new Error(data)); + } else { + let error; + try { + error = JSON.parse(data); + } catch (err) { + resolvers.reject(new TypeError("could not parse error: " + err.message, { cause: err })); + return; + } + let options = {}; + if (error.cause) { + options.cause = error.cause; + } + let exception; + switch (error.kind) { + case "ReferenceError": + exception = new ReferenceError(error.message, options); + break; + case "TypeError": + exception = new TypeError(error.message, options); + break; + case "RuntimeError": + exception = new RuntimeError(error.message, options); + break; + default: + exception = new Error(error.message, options); + break; + } + resolvers.reject(exception); + } +} +function getAndDeleteResponse(id) { + const response = callResponses.get(id); + callResponses.delete(id); + return response; +} +function generateID() { + let result; + do { + result = nanoid(); + } while (callResponses.has(result)); + return result; +} +function Call(options) { + const id = generateID(); + const result = CancellablePromise.withResolvers(); + callResponses.set(id, { resolve: result.resolve, reject: result.reject }); + const request = call$1(CallBinding, Object.assign({ "call-id": id }, options)); + let running = false; + request.then(() => { + running = true; + }, (err) => { + callResponses.delete(id); + result.reject(err); + }); + const cancel = () => { + callResponses.delete(id); + return cancelCall(CancelMethod, { "call-id": id }).catch((err) => { + console.error("Error while requesting binding call cancellation:", err); + }); + }; + result.oncancelled = () => { + if (running) { + return cancel(); + } else { + return request.then(cancel); + } + }; + return result.promise; +} +function ByID(methodID, ...args) { + return Call({ methodID, args }); +} +const eventListeners = /* @__PURE__ */ new Map(); +class Listener { + constructor(eventName, callback, maxCallbacks) { + this.eventName = eventName; + this.callback = callback; + this.maxCallbacks = maxCallbacks || -1; + } + dispatch(data) { + try { + this.callback(data); + } catch (err) { + console.error(err); + } + if (this.maxCallbacks === -1) + return false; + this.maxCallbacks -= 1; + return this.maxCallbacks === 0; + } +} +function listenerOff(listener) { + let listeners = eventListeners.get(listener.eventName); + if (!listeners) { + return; + } + listeners = listeners.filter((l) => l !== listener); + if (listeners.length === 0) { + eventListeners.delete(listener.eventName); + } else { + eventListeners.set(listener.eventName, listeners); + } +} +window._wails = window._wails || {}; +window._wails.dispatchWailsEvent = dispatchWailsEvent; +const call = newRuntimeCaller(objectNames.Events); +const EmitMethod = 0; +class WailsEvent { + constructor(name, data = null) { + this.name = name; + this.data = data; + } +} +function dispatchWailsEvent(event) { + let listeners = eventListeners.get(event.name); + if (!listeners) { + return; + } + let wailsEvent = new WailsEvent(event.name, event.data); + if ("sender" in event) { + wailsEvent.sender = event.sender; + } + listeners = listeners.filter((listener) => !listener.dispatch(wailsEvent)); + if (listeners.length === 0) { + eventListeners.delete(event.name); + } else { + eventListeners.set(event.name, listeners); + } +} +function OnMultiple(eventName, callback, maxCallbacks) { + let listeners = eventListeners.get(eventName) || []; + const thisListener = new Listener(eventName, callback, maxCallbacks); + listeners.push(thisListener); + eventListeners.set(eventName, listeners); + return () => listenerOff(thisListener); +} +function On(eventName, callback) { + return OnMultiple(eventName, callback, -1); +} +function Emit(event) { + return call(EmitMethod, event); +} +window._wails = window._wails || {}; +window._wails.invoke = invoke; +invoke("wails:runtime:ready"); +function RemoveBadge() { + return ByID(2752757297); +} +function SetBadge(label) { + return ByID(1717705661, label); +} +function SetCustomBadge(label, options) { + return ByID(2730169760, label, options); +} +class RGBA { + /** Creates a new RGBA instance. */ + constructor($$source = {}) { + __publicField(this, "R"); + __publicField(this, "G"); + __publicField(this, "B"); + __publicField(this, "A"); + if (!("R" in $$source)) { + this["R"] = 0; + } + if (!("G" in $$source)) { + this["G"] = 0; + } + if (!("B" in $$source)) { + this["B"] = 0; + } + if (!("A" in $$source)) { + this["A"] = 0; + } + Object.assign(this, $$source); + } + /** + * Creates a new RGBA instance from a string or object. + */ + static createFrom($$source = {}) { + let $$parsedSource = typeof $$source === "string" ? JSON.parse($$source) : $$source; + return new RGBA($$parsedSource); + } +} +const setCustomButton = document.getElementById("set-custom"); +const setButton = document.getElementById("set"); +const removeButton = document.getElementById("remove"); +const setButtonUsingGo = document.getElementById("set-go"); +const removeButtonUsingGo = document.getElementById("remove-go"); +const labelElement = document.getElementById("label"); +const timeElement = document.getElementById("time"); +setCustomButton.addEventListener("click", () => { + console.log("click!"); + let label = labelElement.value; + SetCustomBadge(label, { + BackgroundColour: RGBA.createFrom({ + R: 0, + G: 255, + B: 255, + A: 255 + }), + FontName: "arialb.ttf", + // System font + FontSize: 16, + SmallFontSize: 10, + TextColour: RGBA.createFrom({ + R: 0, + G: 0, + B: 0, + A: 255 + }) + }); +}); +setButton.addEventListener("click", () => { + let label = labelElement.value; + SetBadge(label); +}); +removeButton.addEventListener("click", () => { + RemoveBadge(); +}); +setButtonUsingGo.addEventListener("click", () => { + let label = labelElement.value; + void Emit({ + name: "set:badge", + data: label + }); +}); +removeButtonUsingGo.addEventListener("click", () => { + void Emit({ name: "remove:badge", data: null }); +}); +On("time", (time) => { + timeElement.innerText = time.data; +}); diff --git a/v3/examples/badge-custom/frontend/dist/index.html b/v3/examples/badge-custom/frontend/dist/index.html new file mode 100644 index 000000000..11b9fcd50 --- /dev/null +++ b/v3/examples/badge-custom/frontend/dist/index.html @@ -0,0 +1,39 @@ + + + + + + + + Wails App + + + +
      + +

      Wails + Typescript

      +
      Set a badge label below 👇
      +
      +
      + + + + + + +
      +
      + +
      + + diff --git a/v3/examples/badge-custom/frontend/dist/style.css b/v3/examples/badge-custom/frontend/dist/style.css new file mode 100644 index 000000000..6ce81cad2 --- /dev/null +++ b/v3/examples/badge-custom/frontend/dist/style.css @@ -0,0 +1,155 @@ +:root { + font-family: "Inter", -apple-system, BlinkMacSystemFont, "Segoe UI", "Roboto", + "Oxygen", "Ubuntu", "Cantarell", "Fira Sans", "Droid Sans", "Helvetica Neue", + sans-serif; + font-size: 16px; + line-height: 24px; + font-weight: 400; + color-scheme: light dark; + color: rgba(255, 255, 255, 0.87); + background-color: rgba(27, 38, 54, 1); + font-synthesis: none; + text-rendering: optimizeLegibility; + -webkit-font-smoothing: antialiased; + -moz-osx-font-smoothing: grayscale; + -webkit-text-size-adjust: 100%; + user-select: none; + -webkit-user-select: none; + -moz-user-select: none; + -ms-user-select: none; +} + +@font-face { + font-family: "Inter"; + font-style: normal; + font-weight: 400; + src: local(""), + url("./Inter-Medium.ttf") format("truetype"); +} + +h3 { + font-size: 3em; + line-height: 1.1; +} + +a { + font-weight: 500; + color: #646cff; + text-decoration: inherit; +} + +a:hover { + color: #535bf2; +} + +button { + line-height: 30px; + border-radius: 3px; + border: none; + margin: 0 0 0 20px; + padding: 0 8px; + cursor: pointer; +} + +.result { + height: 20px; + line-height: 20px; +} + +body { + margin: 0; + display: flex; + place-items: center; + place-content: center; + min-width: 320px; + min-height: 100vh; +} + +.container { + display: flex; + flex-direction: column; + align-items: center; + justify-content: center; +} + +h1 { + font-size: 3.2em; + line-height: 1.1; +} + +#app { + max-width: 1280px; + margin: 0 auto; + padding: 2rem; + text-align: center; +} + +.logo { + height: 6em; + padding: 1.5em; + will-change: filter; +} + +.logo:hover { + filter: drop-shadow(0 0 2em #e80000aa); +} + +.logo.vanilla:hover { + filter: drop-shadow(0 0 2em #f7df1eaa); +} + +.result { + height: 20px; + line-height: 20px; + margin: 1.5rem auto; + text-align: center; +} + +.footer { + margin-top: 1rem; + align-content: center; + text-align: center; +} + +@media (prefers-color-scheme: light) { + :root { + color: #213547; + background-color: #ffffff; + } + + a:hover { + color: #747bff; + } + + button { + background-color: #f9f9f9; + } +} + + +.input-box .btn:hover { + background-image: linear-gradient(to top, #cfd9df 0%, #e2ebf0 100%); + color: #333333; +} + +.input-box .input { + border: none; + border-radius: 3px; + outline: none; + height: 30px; + line-height: 30px; + padding: 0 10px; + color: black; + background-color: rgba(240, 240, 240, 1); + -webkit-font-smoothing: antialiased; +} + +.input-box .input:hover { + border: none; + background-color: rgba(255, 255, 255, 1); +} + +.input-box .input:focus { + border: none; + background-color: rgba(255, 255, 255, 1); +} \ No newline at end of file diff --git a/v3/examples/badge-custom/frontend/dist/typescript.svg b/v3/examples/badge-custom/frontend/dist/typescript.svg new file mode 100644 index 000000000..d91c910cc --- /dev/null +++ b/v3/examples/badge-custom/frontend/dist/typescript.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/v3/examples/badge-custom/frontend/dist/wails.png b/v3/examples/badge-custom/frontend/dist/wails.png new file mode 100644 index 000000000..8bdf42483 Binary files /dev/null and b/v3/examples/badge-custom/frontend/dist/wails.png differ diff --git a/v3/examples/badge-custom/frontend/index.html b/v3/examples/badge-custom/frontend/index.html new file mode 100644 index 000000000..e4a9ec4a2 --- /dev/null +++ b/v3/examples/badge-custom/frontend/index.html @@ -0,0 +1,39 @@ + + + + + + + + Wails App + + +
      + +

      Wails + Typescript

      +
      Set a badge label below 👇
      +
      +
      + + + + + + +
      +
      + +
      + + + diff --git a/v3/examples/badge-custom/frontend/package.json b/v3/examples/badge-custom/frontend/package.json new file mode 100644 index 000000000..b39da7ece --- /dev/null +++ b/v3/examples/badge-custom/frontend/package.json @@ -0,0 +1,19 @@ +{ + "name": "frontend", + "private": true, + "version": "0.0.0", + "type": "module", + "scripts": { + "dev": "vite", + "build:dev": "tsc && vite build --minify false --mode development", + "build": "tsc && vite build --mode production", + "preview": "vite preview" + }, + "dependencies": { + "@wailsio/runtime": "latest" + }, + "devDependencies": { + "typescript": "^4.9.3", + "vite": "^5.0.0" + } +} diff --git a/v3/examples/badge-custom/frontend/public/Inter-Medium.ttf b/v3/examples/badge-custom/frontend/public/Inter-Medium.ttf new file mode 100644 index 000000000..a01f3777a Binary files /dev/null and b/v3/examples/badge-custom/frontend/public/Inter-Medium.ttf differ diff --git a/v3/examples/badge-custom/frontend/public/style.css b/v3/examples/badge-custom/frontend/public/style.css new file mode 100644 index 000000000..6ce81cad2 --- /dev/null +++ b/v3/examples/badge-custom/frontend/public/style.css @@ -0,0 +1,155 @@ +:root { + font-family: "Inter", -apple-system, BlinkMacSystemFont, "Segoe UI", "Roboto", + "Oxygen", "Ubuntu", "Cantarell", "Fira Sans", "Droid Sans", "Helvetica Neue", + sans-serif; + font-size: 16px; + line-height: 24px; + font-weight: 400; + color-scheme: light dark; + color: rgba(255, 255, 255, 0.87); + background-color: rgba(27, 38, 54, 1); + font-synthesis: none; + text-rendering: optimizeLegibility; + -webkit-font-smoothing: antialiased; + -moz-osx-font-smoothing: grayscale; + -webkit-text-size-adjust: 100%; + user-select: none; + -webkit-user-select: none; + -moz-user-select: none; + -ms-user-select: none; +} + +@font-face { + font-family: "Inter"; + font-style: normal; + font-weight: 400; + src: local(""), + url("./Inter-Medium.ttf") format("truetype"); +} + +h3 { + font-size: 3em; + line-height: 1.1; +} + +a { + font-weight: 500; + color: #646cff; + text-decoration: inherit; +} + +a:hover { + color: #535bf2; +} + +button { + line-height: 30px; + border-radius: 3px; + border: none; + margin: 0 0 0 20px; + padding: 0 8px; + cursor: pointer; +} + +.result { + height: 20px; + line-height: 20px; +} + +body { + margin: 0; + display: flex; + place-items: center; + place-content: center; + min-width: 320px; + min-height: 100vh; +} + +.container { + display: flex; + flex-direction: column; + align-items: center; + justify-content: center; +} + +h1 { + font-size: 3.2em; + line-height: 1.1; +} + +#app { + max-width: 1280px; + margin: 0 auto; + padding: 2rem; + text-align: center; +} + +.logo { + height: 6em; + padding: 1.5em; + will-change: filter; +} + +.logo:hover { + filter: drop-shadow(0 0 2em #e80000aa); +} + +.logo.vanilla:hover { + filter: drop-shadow(0 0 2em #f7df1eaa); +} + +.result { + height: 20px; + line-height: 20px; + margin: 1.5rem auto; + text-align: center; +} + +.footer { + margin-top: 1rem; + align-content: center; + text-align: center; +} + +@media (prefers-color-scheme: light) { + :root { + color: #213547; + background-color: #ffffff; + } + + a:hover { + color: #747bff; + } + + button { + background-color: #f9f9f9; + } +} + + +.input-box .btn:hover { + background-image: linear-gradient(to top, #cfd9df 0%, #e2ebf0 100%); + color: #333333; +} + +.input-box .input { + border: none; + border-radius: 3px; + outline: none; + height: 30px; + line-height: 30px; + padding: 0 10px; + color: black; + background-color: rgba(240, 240, 240, 1); + -webkit-font-smoothing: antialiased; +} + +.input-box .input:hover { + border: none; + background-color: rgba(255, 255, 255, 1); +} + +.input-box .input:focus { + border: none; + background-color: rgba(255, 255, 255, 1); +} \ No newline at end of file diff --git a/v3/examples/badge-custom/frontend/public/typescript.svg b/v3/examples/badge-custom/frontend/public/typescript.svg new file mode 100644 index 000000000..d91c910cc --- /dev/null +++ b/v3/examples/badge-custom/frontend/public/typescript.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/v3/examples/badge-custom/frontend/public/wails.png b/v3/examples/badge-custom/frontend/public/wails.png new file mode 100644 index 000000000..8bdf42483 Binary files /dev/null and b/v3/examples/badge-custom/frontend/public/wails.png differ diff --git a/v3/examples/badge-custom/frontend/src/main.ts b/v3/examples/badge-custom/frontend/src/main.ts new file mode 100644 index 000000000..cbb4cd842 --- /dev/null +++ b/v3/examples/badge-custom/frontend/src/main.ts @@ -0,0 +1,56 @@ +import {Events} from "@wailsio/runtime"; +import {SetBadge, RemoveBadge, SetCustomBadge} from "../bindings/github.com/wailsapp/wails/v3/pkg/services/dock/dockservice"; +import { RGBA } from "../bindings/image/color/models"; + +const setCustomButton = document.getElementById('set-custom')! as HTMLButtonElement; +const setButton = document.getElementById('set')! as HTMLButtonElement; +const removeButton = document.getElementById('remove')! as HTMLButtonElement; +const setButtonUsingGo = document.getElementById('set-go')! as HTMLButtonElement; +const removeButtonUsingGo = document.getElementById('remove-go')! as HTMLButtonElement; +const labelElement : HTMLInputElement = document.getElementById('label')! as HTMLInputElement; +const timeElement = document.getElementById('time')! as HTMLDivElement; + +setCustomButton.addEventListener('click', () => { + console.log("click!") + let label = (labelElement as HTMLInputElement).value + SetCustomBadge(label, { + BackgroundColour: RGBA.createFrom({ + R: 0, + G: 255, + B: 255, + A: 255, + }), + FontName: "arialb.ttf", // System font + FontSize: 16, + SmallFontSize: 10, + TextColour: RGBA.createFrom({ + R: 0, + G: 0, + B: 0, + A: 255, + }), + }); +}) + +setButton.addEventListener('click', () => { + let label = (labelElement as HTMLInputElement).value + SetBadge(label); +}); + +removeButton.addEventListener('click', () => { + RemoveBadge(); +}); + +setButtonUsingGo.addEventListener('click', () => { + let label = (labelElement as HTMLInputElement).value + void Events.Emit("set:badge", label); +}) + +removeButtonUsingGo.addEventListener('click', () => { + void Events.Emit("remove:badge"); +}) + +Events.On('time', (time: {data: any}) => { + timeElement.innerText = time.data; +}); + diff --git a/v3/examples/badge-custom/frontend/src/vite-env.d.ts b/v3/examples/badge-custom/frontend/src/vite-env.d.ts new file mode 100644 index 000000000..11f02fe2a --- /dev/null +++ b/v3/examples/badge-custom/frontend/src/vite-env.d.ts @@ -0,0 +1 @@ +/// diff --git a/v3/examples/badge-custom/frontend/tsconfig.json b/v3/examples/badge-custom/frontend/tsconfig.json new file mode 100644 index 000000000..c267ecf24 --- /dev/null +++ b/v3/examples/badge-custom/frontend/tsconfig.json @@ -0,0 +1,20 @@ +{ + "compilerOptions": { + "target": "ESNext", + "useDefineForClassFields": true, + "module": "ESNext", + "lib": ["ESNext", "DOM"], + "moduleResolution": "Node", + "strict": true, + "resolveJsonModule": true, + "isolatedModules": true, + "esModuleInterop": true, + "noEmit": true, + "noUnusedLocals": true, + "noUnusedParameters": false, + "noImplicitAny": false, + "noImplicitReturns": true, + "skipLibCheck": true + }, + "include": ["src"] +} diff --git a/v3/examples/badge-custom/main.go b/v3/examples/badge-custom/main.go new file mode 100644 index 000000000..93a32d1ff --- /dev/null +++ b/v3/examples/badge-custom/main.go @@ -0,0 +1,108 @@ +package main + +import ( + "embed" + _ "embed" + "image/color" + "log" + "time" + + "github.com/wailsapp/wails/v3/pkg/application" + "github.com/wailsapp/wails/v3/pkg/services/dock" +) + +// Wails uses Go's `embed` package to embed the frontend files into the binary. +// Any files in the frontend/dist folder will be embedded into the binary and +// made available to the frontend. +// See https://pkg.go.dev/embed for more information. + +//go:embed all:frontend/dist +var assets embed.FS + +// main function serves as the application's entry point. It initializes the application, creates a window, +// and starts a goroutine that emits a time-based event every second. It subsequently runs the application and +// logs any error that might occur. +func main() { + // Create a new Wails application by providing the necessary options. + // Variables 'Name' and 'Description' are for application metadata. + // 'Assets' configures the asset server with the 'FS' variable pointing to the frontend files. + // 'Bind' is a list of Go struct instances. The frontend has access to the methods of these instances. + // 'Mac' options tailor the application when running an macOS. + + dockService := dock.NewWithOptions(dock.BadgeOptions{ + TextColour: color.RGBA{255, 255, 204, 255}, + BackgroundColour: color.RGBA{16, 124, 16, 255}, + FontName: "consolab.ttf", + FontSize: 20, + SmallFontSize: 14, + }) + + app := application.New(application.Options{ + Name: "badge", + Description: "A demo of using raw HTML & CSS", + Services: []application.Service{ + application.NewService(dockService), + }, + Assets: application.AssetOptions{ + Handler: application.AssetFileServerFS(assets), + }, + Mac: application.MacOptions{ + ApplicationShouldTerminateAfterLastWindowClosed: true, + }, + }) + + // Create a new window with the necessary options. + // 'Title' is the title of the window. + // 'Mac' options tailor the window when running on macOS. + // 'BackgroundColour' is the background colour of the window. + // 'URL' is the URL that will be loaded into the webview. + app.Window.NewWithOptions(application.WebviewWindowOptions{ + Title: "Window 1", + Mac: application.MacWindow{ + InvisibleTitleBarHeight: 50, + Backdrop: application.MacBackdropTranslucent, + TitleBar: application.MacTitleBarHiddenInset, + }, + BackgroundColour: application.NewRGB(27, 38, 54), + URL: "/", + }) + + app.Event.On("remove:badge", func(event *application.CustomEvent) { + err := dockService.RemoveBadge() + if err != nil { + log.Fatal(err) + } + }) + + app.Event.On("set:badge", func(event *application.CustomEvent) { + text := event.Data.(string) + err := dockService.SetBadge(text) + if err != nil { + log.Fatal(err) + } + }) + + // Create a goroutine that emits an event containing the current time every second. + // The frontend can listen to this event and update the UI accordingly. + go func() { + ticker := time.NewTicker(time.Second) + defer ticker.Stop() + for { + select { + case <-ticker.C: + now := time.Now().Format(time.RFC1123) + app.Event.Emit("time", now) + case <-app.Context().Done(): + return + } + } + }() + + // Run the application. This blocks until the application has been exited. + err := app.Run() + + // If an error occurred while running the application, log it and exit. + if err != nil { + log.Fatal(err) + } +} diff --git a/v3/examples/badge/README.md b/v3/examples/badge/README.md new file mode 100644 index 000000000..abb7b9653 --- /dev/null +++ b/v3/examples/badge/README.md @@ -0,0 +1,71 @@ +# Welcome to Your New Wails3 Project! +Now that you have your project set up, it's time to explore the basic badge features that Wails3 offers on **macOS** and **Windows**. + +## Exploring Badge Features + +### Creating the Service + +First, initialize the badge service: + +```go +import "github.com/wailsapp/wails/v3/pkg/application" +import "github.com/wailsapp/wails/v3/pkg/services/badge" + +// Create a new badge service +badgeService := badge.New() + +// Register the service with the application +app := application.New(application.Options{ + Services: []application.Service{ + application.NewService(badgeService), + }, +}) +``` + +## Badge Operations + +### Setting a Badge + +Set a badge on the application tile/dock icon: + +#### Go +```go +// Set a default badge +badgeService.SetBadge("") + +// Set a numeric badge +badgeService.SetBadge("3") + +// Set a text badge +badgeService.SetBadge("New") +``` + +#### JS +```js +import {SetBadge} from "../bindings/github.com/wailsapp/wails/v3/pkg/services/badge/service"; + +// Set a default badge +SetBadge("") + +// Set a numeric badge +SetBadge("3") + +// Set a text badge +SetBadge("New") +``` + +### Removing a Badge + +Remove the badge from the application icon: + +#### Go +```go +badgeService.RemoveBadge() +``` + +#### JS +```js +import {RemoveBadge} from "../bindings/github.com/wailsapp/wails/v3/pkg/services/badge/service"; + +RemoveBadge() +``` \ No newline at end of file diff --git a/v3/examples/badge/Taskfile.yml b/v3/examples/badge/Taskfile.yml new file mode 100644 index 000000000..d1bcfaacf --- /dev/null +++ b/v3/examples/badge/Taskfile.yml @@ -0,0 +1,34 @@ +version: '3' + +includes: + common: ./build/Taskfile.yml + windows: ./build/windows/Taskfile.yml + darwin: ./build/darwin/Taskfile.yml + linux: ./build/linux/Taskfile.yml + +vars: + APP_NAME: "badge" + BIN_DIR: "bin" + VITE_PORT: '{{.WAILS_VITE_PORT | default 9245}}' + +tasks: + build: + summary: Builds the application + cmds: + - task: "{{OS}}:build" + + package: + summary: Packages a production build of the application + cmds: + - task: "{{OS}}:package" + + run: + summary: Runs the application + cmds: + - task: "{{OS}}:run" + + dev: + summary: Runs the application in development mode + cmds: + - wails3 dev -config ./build/config.yml -port {{.VITE_PORT}} + diff --git a/v3/examples/badge/build/Taskfile.yml b/v3/examples/badge/build/Taskfile.yml new file mode 100644 index 000000000..f0aab9b9c --- /dev/null +++ b/v3/examples/badge/build/Taskfile.yml @@ -0,0 +1,87 @@ +version: '3' + +tasks: + go:mod:tidy: + summary: Runs `go mod tidy` + internal: true + cmds: + - go mod tidy + + install:frontend:deps: + summary: Install frontend dependencies + dir: frontend + sources: + - package.json + - package-lock.json + generates: + - node_modules/* + preconditions: + - sh: npm version + msg: "Looks like npm isn't installed. Npm is part of the Node installer: https://nodejs.org/en/download/" + cmds: + - npm install + + build:frontend: + label: build:frontend (PRODUCTION={{.PRODUCTION}}) + summary: Build the frontend project + dir: frontend + sources: + - "**/*" + - exclude: node_modules/**/* + generates: + - dist/**/* + deps: + - task: install:frontend:deps + - task: generate:bindings + vars: + BUILD_FLAGS: + ref: .BUILD_FLAGS + cmds: + - npm run {{.BUILD_COMMAND}} -q + env: + PRODUCTION: '{{.PRODUCTION | default "false"}}' + vars: + BUILD_COMMAND: '{{if eq .PRODUCTION "true"}}build{{else}}build:dev{{end}}' + + + generate:bindings: + label: generate:bindings (BUILD_FLAGS={{.BUILD_FLAGS}}) + summary: Generates bindings for the frontend + deps: + - task: go:mod:tidy + sources: + - "**/*.[jt]s" + - exclude: frontend/**/* + - frontend/bindings/**/* # Rerun when switching between dev/production mode causes changes in output + - "**/*.go" + - go.mod + - go.sum + generates: + - frontend/bindings/**/* + cmds: + - wails3 generate bindings -f '{{.BUILD_FLAGS}}' -clean=true -ts + + generate:icons: + summary: Generates Windows `.ico` and Mac `.icns` files from an image + dir: build + sources: + - "appicon.png" + generates: + - "darwin/icons.icns" + - "windows/icon.ico" + cmds: + - wails3 generate icons -input appicon.png -macfilename darwin/icons.icns -windowsfilename windows/icon.ico + + dev:frontend: + summary: Runs the frontend in development mode + dir: frontend + deps: + - task: install:frontend:deps + cmds: + - npm run dev -- --port {{.VITE_PORT}} --strictPort + + update:build-assets: + summary: Updates the build assets + dir: build + cmds: + - wails3 update build-assets -name "{{.APP_NAME}}" -binaryname "{{.APP_NAME}}" -config config.yml -dir . diff --git a/v3/examples/badge/build/appicon.png b/v3/examples/badge/build/appicon.png new file mode 100644 index 000000000..63617fe4f Binary files /dev/null and b/v3/examples/badge/build/appicon.png differ diff --git a/v3/examples/badge/build/config.yml b/v3/examples/badge/build/config.yml new file mode 100644 index 000000000..aaa3240fb --- /dev/null +++ b/v3/examples/badge/build/config.yml @@ -0,0 +1,63 @@ +# This file contains the configuration for this project. +# When you update `info` or `fileAssociations`, run `wails3 task common:update:build-assets` to update the assets. +# Note that this will overwrite any changes you have made to the assets. +version: '3' + +# This information is used to generate the build assets. +info: + companyName: "My Company" # The name of the company + productName: "My Product" # The name of the application + productIdentifier: "com.mycompany.myproduct" # The unique product identifier + description: "A program that does X" # The application description + copyright: "(c) 2025, My Company" # Copyright text + comments: "Some Product Comments" # Comments + version: "0.0.1" # The application version + +# Dev mode configuration +dev_mode: + root_path: . + log_level: warn + debounce: 1000 + ignore: + dir: + - .git + - node_modules + - frontend + - bin + file: + - .DS_Store + - .gitignore + - .gitkeep + watched_extension: + - "*.go" + git_ignore: true + executes: + - cmd: wails3 task common:install:frontend:deps + type: once + - cmd: wails3 task common:dev:frontend + type: background + - cmd: go mod tidy + type: blocking + - cmd: wails3 task build + type: blocking + - cmd: wails3 task run + type: primary + +# File Associations +# More information at: https://v3.wails.io/noit/done/yet +fileAssociations: +# - ext: wails +# name: Wails +# description: Wails Application File +# iconName: wailsFileIcon +# role: Editor +# - ext: jpg +# name: JPEG +# description: Image File +# iconName: jpegFileIcon +# role: Editor +# mimeType: image/jpeg # (optional) + +# Other data +other: + - name: My Other Data \ No newline at end of file diff --git a/v3/examples/badge/build/darwin/Info.dev.plist b/v3/examples/badge/build/darwin/Info.dev.plist new file mode 100644 index 000000000..4caddf720 --- /dev/null +++ b/v3/examples/badge/build/darwin/Info.dev.plist @@ -0,0 +1,32 @@ + + + + CFBundlePackageType + APPL + CFBundleName + My Product + CFBundleExecutable + badge + CFBundleIdentifier + com.wails.badge + CFBundleVersion + 0.1.0 + CFBundleGetInfoString + This is a comment + CFBundleShortVersionString + 0.1.0 + CFBundleIconFile + icons + LSMinimumSystemVersion + 10.15.0 + NSHighResolutionCapable + true + NSHumanReadableCopyright + © now, My Company + NSAppTransportSecurity + + NSAllowsLocalNetworking + + + + \ No newline at end of file diff --git a/v3/examples/badge/build/darwin/Info.plist b/v3/examples/badge/build/darwin/Info.plist new file mode 100644 index 000000000..0dc90b2e7 --- /dev/null +++ b/v3/examples/badge/build/darwin/Info.plist @@ -0,0 +1,27 @@ + + + + CFBundlePackageType + APPL + CFBundleName + My Product + CFBundleExecutable + badge + CFBundleIdentifier + com.wails.badge + CFBundleVersion + 0.1.0 + CFBundleGetInfoString + This is a comment + CFBundleShortVersionString + 0.1.0 + CFBundleIconFile + icons + LSMinimumSystemVersion + 10.15.0 + NSHighResolutionCapable + true + NSHumanReadableCopyright + © now, My Company + + \ No newline at end of file diff --git a/v3/examples/badge/build/darwin/Taskfile.yml b/v3/examples/badge/build/darwin/Taskfile.yml new file mode 100644 index 000000000..f0791fea9 --- /dev/null +++ b/v3/examples/badge/build/darwin/Taskfile.yml @@ -0,0 +1,81 @@ +version: '3' + +includes: + common: ../Taskfile.yml + +tasks: + build: + summary: Creates a production build of the application + deps: + - task: common:go:mod:tidy + - task: common:build:frontend + vars: + BUILD_FLAGS: + ref: .BUILD_FLAGS + PRODUCTION: + ref: .PRODUCTION + - task: common:generate:icons + cmds: + - go build {{.BUILD_FLAGS}} -o {{.OUTPUT}} + vars: + BUILD_FLAGS: '{{if eq .PRODUCTION "true"}}-tags production -trimpath -buildvcs=false -ldflags="-w -s"{{else}}-buildvcs=false -gcflags=all="-l"{{end}}' + DEFAULT_OUTPUT: '{{.BIN_DIR}}/{{.APP_NAME}}' + OUTPUT: '{{ .OUTPUT | default .DEFAULT_OUTPUT }}' + env: + GOOS: darwin + CGO_ENABLED: 1 + GOARCH: '{{.ARCH | default ARCH}}' + CGO_CFLAGS: "-mmacosx-version-min=10.15" + CGO_LDFLAGS: "-mmacosx-version-min=10.15" + MACOSX_DEPLOYMENT_TARGET: "10.15" + PRODUCTION: '{{.PRODUCTION | default "false"}}' + + build:universal: + summary: Builds darwin universal binary (arm64 + amd64) + deps: + - task: build + vars: + ARCH: amd64 + OUTPUT: "{{.BIN_DIR}}/{{.APP_NAME}}-amd64" + - task: build + vars: + ARCH: arm64 + OUTPUT: "{{.BIN_DIR}}/{{.APP_NAME}}-arm64" + cmds: + - lipo -create -output "{{.BIN_DIR}}/{{.APP_NAME}}" "{{.BIN_DIR}}/{{.APP_NAME}}-amd64" "{{.BIN_DIR}}/{{.APP_NAME}}-arm64" + - rm "{{.BIN_DIR}}/{{.APP_NAME}}-amd64" "{{.BIN_DIR}}/{{.APP_NAME}}-arm64" + + package: + summary: Packages a production build of the application into a `.app` bundle + deps: + - task: build + vars: + PRODUCTION: "true" + cmds: + - task: create:app:bundle + + package:universal: + summary: Packages darwin universal binary (arm64 + amd64) + deps: + - task: build:universal + cmds: + - task: create:app:bundle + + + create:app:bundle: + summary: Creates an `.app` bundle + cmds: + - mkdir -p {{.BIN_DIR}}/{{.APP_NAME}}.app/Contents/{MacOS,Resources} + - cp build/darwin/icons.icns {{.BIN_DIR}}/{{.APP_NAME}}.app/Contents/Resources + - cp {{.BIN_DIR}}/{{.APP_NAME}} {{.BIN_DIR}}/{{.APP_NAME}}.app/Contents/MacOS + - cp build/darwin/Info.plist {{.BIN_DIR}}/{{.APP_NAME}}.app/Contents + - codesign --force --deep --sign - {{.BIN_DIR}}/{{.APP_NAME}}.app + + run: + cmds: + - mkdir -p {{.BIN_DIR}}/{{.APP_NAME}}.dev.app/Contents/{MacOS,Resources} + - cp build/darwin/icons.icns {{.BIN_DIR}}/{{.APP_NAME}}.dev.app/Contents/Resources + - cp {{.BIN_DIR}}/{{.APP_NAME}} {{.BIN_DIR}}/{{.APP_NAME}}.dev.app/Contents/MacOS + - cp build/darwin/Info.dev.plist {{.BIN_DIR}}/{{.APP_NAME}}.dev.app/Contents/Info.plist + - codesign --force --deep --sign - {{.BIN_DIR}}/{{.APP_NAME}}.dev.app + - '{{.BIN_DIR}}/{{.APP_NAME}}.dev.app/Contents/MacOS/{{.APP_NAME}}' diff --git a/v3/examples/badge/build/darwin/icons.icns b/v3/examples/badge/build/darwin/icons.icns new file mode 100644 index 000000000..1b5bd4c86 Binary files /dev/null and b/v3/examples/badge/build/darwin/icons.icns differ diff --git a/v3/examples/badge/build/linux/Taskfile.yml b/v3/examples/badge/build/linux/Taskfile.yml new file mode 100644 index 000000000..560cc9c92 --- /dev/null +++ b/v3/examples/badge/build/linux/Taskfile.yml @@ -0,0 +1,119 @@ +version: '3' + +includes: + common: ../Taskfile.yml + +tasks: + build: + summary: Builds the application for Linux + deps: + - task: common:go:mod:tidy + - task: common:build:frontend + vars: + BUILD_FLAGS: + ref: .BUILD_FLAGS + PRODUCTION: + ref: .PRODUCTION + - task: common:generate:icons + cmds: + - go build {{.BUILD_FLAGS}} -o {{.BIN_DIR}}/{{.APP_NAME}} + vars: + BUILD_FLAGS: '{{if eq .PRODUCTION "true"}}-tags production -trimpath -buildvcs=false -ldflags="-w -s"{{else}}-buildvcs=false -gcflags=all="-l"{{end}}' + env: + GOOS: linux + CGO_ENABLED: 1 + GOARCH: '{{.ARCH | default ARCH}}' + PRODUCTION: '{{.PRODUCTION | default "false"}}' + + package: + summary: Packages a production build of the application for Linux + deps: + - task: build + vars: + PRODUCTION: "true" + cmds: + - task: create:appimage + - task: create:deb + - task: create:rpm + - task: create:aur + + create:appimage: + summary: Creates an AppImage + dir: build/linux/appimage + deps: + - task: build + vars: + PRODUCTION: "true" + - task: generate:dotdesktop + cmds: + - cp {{.APP_BINARY}} {{.APP_NAME}} + - cp ../../appicon.png appicon.png + - wails3 generate appimage -binary {{.APP_NAME}} -icon {{.ICON}} -desktopfile {{.DESKTOP_FILE}} -outputdir {{.OUTPUT_DIR}} -builddir {{.ROOT_DIR}}/build/linux/appimage/build + vars: + APP_NAME: '{{.APP_NAME}}' + APP_BINARY: '../../../bin/{{.APP_NAME}}' + ICON: '../../appicon.png' + DESKTOP_FILE: '../{{.APP_NAME}}.desktop' + OUTPUT_DIR: '../../../bin' + + create:deb: + summary: Creates a deb package + deps: + - task: build + vars: + PRODUCTION: "true" + cmds: + - task: generate:dotdesktop + - task: generate:deb + + create:rpm: + summary: Creates a rpm package + deps: + - task: build + vars: + PRODUCTION: "true" + cmds: + - task: generate:dotdesktop + - task: generate:rpm + + create:aur: + summary: Creates a arch linux packager package + deps: + - task: build + vars: + PRODUCTION: "true" + cmds: + - task: generate:dotdesktop + - task: generate:aur + + generate:deb: + summary: Creates a deb package + cmds: + - wails3 tool package -name {{.APP_NAME}} -format deb -config ./build/linux/nfpm/nfpm.yaml -out {{.ROOT_DIR}}/bin + + generate:rpm: + summary: Creates a rpm package + cmds: + - wails3 tool package -name {{.APP_NAME}} -format rpm -config ./build/linux/nfpm/nfpm.yaml -out {{.ROOT_DIR}}/bin + + generate:aur: + summary: Creates a arch linux packager package + cmds: + - wails3 tool package -name {{.APP_NAME}} -format archlinux -config ./build/linux/nfpm/nfpm.yaml -out {{.ROOT_DIR}}/bin + + generate:dotdesktop: + summary: Generates a `.desktop` file + dir: build + cmds: + - mkdir -p {{.ROOT_DIR}}/build/linux/appimage + - wails3 generate .desktop -name "{{.APP_NAME}}" -exec "{{.EXEC}}" -icon "{{.ICON}}" -outputfile {{.ROOT_DIR}}/build/linux/{{.APP_NAME}}.desktop -categories "{{.CATEGORIES}}" + vars: + APP_NAME: '{{.APP_NAME}}' + EXEC: '{{.APP_NAME}}' + ICON: 'appicon' + CATEGORIES: 'Development;' + OUTPUTFILE: '{{.ROOT_DIR}}/build/linux/{{.APP_NAME}}.desktop' + + run: + cmds: + - '{{.BIN_DIR}}/{{.APP_NAME}}' diff --git a/v3/examples/badge/build/linux/appimage/build.sh b/v3/examples/badge/build/linux/appimage/build.sh new file mode 100644 index 000000000..85901c34e --- /dev/null +++ b/v3/examples/badge/build/linux/appimage/build.sh @@ -0,0 +1,35 @@ +#!/usr/bin/env bash +# Copyright (c) 2018-Present Lea Anthony +# SPDX-License-Identifier: MIT + +# Fail script on any error +set -euxo pipefail + +# Define variables +APP_DIR="${APP_NAME}.AppDir" + +# Create AppDir structure +mkdir -p "${APP_DIR}/usr/bin" +cp -r "${APP_BINARY}" "${APP_DIR}/usr/bin/" +cp "${ICON_PATH}" "${APP_DIR}/" +cp "${DESKTOP_FILE}" "${APP_DIR}/" + +if [[ $(uname -m) == *x86_64* ]]; then + # Download linuxdeploy and make it executable + wget -q -4 -N https://github.com/linuxdeploy/linuxdeploy/releases/download/continuous/linuxdeploy-x86_64.AppImage + chmod +x linuxdeploy-x86_64.AppImage + + # Run linuxdeploy to bundle the application + ./linuxdeploy-x86_64.AppImage --appdir "${APP_DIR}" --output appimage +else + # Download linuxdeploy and make it executable (arm64) + wget -q -4 -N https://github.com/linuxdeploy/linuxdeploy/releases/download/continuous/linuxdeploy-aarch64.AppImage + chmod +x linuxdeploy-aarch64.AppImage + + # Run linuxdeploy to bundle the application (arm64) + ./linuxdeploy-aarch64.AppImage --appdir "${APP_DIR}" --output appimage +fi + +# Rename the generated AppImage +mv "${APP_NAME}*.AppImage" "${APP_NAME}.AppImage" + diff --git a/v3/examples/badge/build/linux/nfpm/nfpm.yaml b/v3/examples/badge/build/linux/nfpm/nfpm.yaml new file mode 100644 index 000000000..5b7ea9d02 --- /dev/null +++ b/v3/examples/badge/build/linux/nfpm/nfpm.yaml @@ -0,0 +1,50 @@ +# Feel free to remove those if you don't want/need to use them. +# Make sure to check the documentation at https://nfpm.goreleaser.com +# +# The lines below are called `modelines`. See `:help modeline` + +name: "badge" +arch: ${GOARCH} +platform: "linux" +version: "0.1.0" +section: "default" +priority: "extra" +maintainer: ${GIT_COMMITTER_NAME} <${GIT_COMMITTER_EMAIL}> +description: "My Product Description" +vendor: "My Company" +homepage: "https://wails.io" +license: "MIT" +release: "1" + +contents: + - src: "./bin/badge" + dst: "/usr/local/bin/badge" + - src: "./build/appicon.png" + dst: "/usr/share/icons/hicolor/128x128/apps/badge.png" + - src: "./build/linux/badge.desktop" + dst: "/usr/share/applications/badge.desktop" + +depends: + - gtk3 + - libwebkit2gtk + +# replaces: +# - foobar +# provides: +# - bar +# depends: +# - gtk3 +# - libwebkit2gtk +# recommends: +# - whatever +# suggests: +# - something-else +# conflicts: +# - not-foo +# - not-bar +# changelog: "changelog.yaml" +# scripts: +# preinstall: ./build/linux/nfpm/scripts/preinstall.sh +# postinstall: ./build/linux/nfpm/scripts/postinstall.sh +# preremove: ./build/linux/nfpm/scripts/preremove.sh +# postremove: ./build/linux/nfpm/scripts/postremove.sh diff --git a/v3/examples/badge/build/linux/nfpm/scripts/postinstall.sh b/v3/examples/badge/build/linux/nfpm/scripts/postinstall.sh new file mode 100644 index 000000000..a9bf588e2 --- /dev/null +++ b/v3/examples/badge/build/linux/nfpm/scripts/postinstall.sh @@ -0,0 +1 @@ +#!/bin/bash diff --git a/v3/examples/badge/build/linux/nfpm/scripts/postremove.sh b/v3/examples/badge/build/linux/nfpm/scripts/postremove.sh new file mode 100644 index 000000000..a9bf588e2 --- /dev/null +++ b/v3/examples/badge/build/linux/nfpm/scripts/postremove.sh @@ -0,0 +1 @@ +#!/bin/bash diff --git a/v3/examples/badge/build/linux/nfpm/scripts/preinstall.sh b/v3/examples/badge/build/linux/nfpm/scripts/preinstall.sh new file mode 100644 index 000000000..a9bf588e2 --- /dev/null +++ b/v3/examples/badge/build/linux/nfpm/scripts/preinstall.sh @@ -0,0 +1 @@ +#!/bin/bash diff --git a/v3/examples/badge/build/linux/nfpm/scripts/preremove.sh b/v3/examples/badge/build/linux/nfpm/scripts/preremove.sh new file mode 100644 index 000000000..a9bf588e2 --- /dev/null +++ b/v3/examples/badge/build/linux/nfpm/scripts/preremove.sh @@ -0,0 +1 @@ +#!/bin/bash diff --git a/v3/examples/badge/build/windows/Taskfile.yml b/v3/examples/badge/build/windows/Taskfile.yml new file mode 100644 index 000000000..534f4fb31 --- /dev/null +++ b/v3/examples/badge/build/windows/Taskfile.yml @@ -0,0 +1,63 @@ +version: '3' + +includes: + common: ../Taskfile.yml + +tasks: + build: + summary: Builds the application for Windows + deps: + - task: common:go:mod:tidy + - task: common:build:frontend + vars: + BUILD_FLAGS: + ref: .BUILD_FLAGS + PRODUCTION: + ref: .PRODUCTION + - task: common:generate:icons + cmds: + - task: generate:syso + - go build {{.BUILD_FLAGS}} -o {{.BIN_DIR}}/{{.APP_NAME}}.exe + - cmd: powershell Remove-item *.syso + platforms: [windows] + - cmd: rm -f *.syso + platforms: [linux, darwin] + vars: + BUILD_FLAGS: '{{if eq .PRODUCTION "true"}}-tags production -trimpath -buildvcs=false -ldflags="-w -s -H windowsgui"{{else}}-buildvcs=false -gcflags=all="-l"{{end}}' + env: + GOOS: windows + CGO_ENABLED: 0 + GOARCH: '{{.ARCH | default ARCH}}' + PRODUCTION: '{{.PRODUCTION | default "false"}}' + + package: + summary: Packages a production build of the application into a `.exe` bundle + cmds: + - task: create:nsis:installer + + generate:syso: + summary: Generates Windows `.syso` file + dir: build + cmds: + - wails3 generate syso -arch {{.ARCH}} -icon windows/icon.ico -manifest windows/wails.exe.manifest -info windows/info.json -out ../wails_windows_{{.ARCH}}.syso + vars: + ARCH: '{{.ARCH | default ARCH}}' + + create:nsis:installer: + summary: Creates an NSIS installer + dir: build/windows/nsis + deps: + - task: build + vars: + PRODUCTION: "true" + cmds: + # Create the Microsoft WebView2 bootstrapper if it doesn't exist + - wails3 generate webview2bootstrapper -dir "{{.ROOT_DIR}}/build/windows/nsis" + - makensis -DARG_WAILS_{{.ARG_FLAG}}_BINARY="{{.ROOT_DIR}}/{{.BIN_DIR}}/{{.APP_NAME}}.exe" project.nsi + vars: + ARCH: '{{.ARCH | default ARCH}}' + ARG_FLAG: '{{if eq .ARCH "amd64"}}AMD64{{else}}ARM64{{end}}' + + run: + cmds: + - '{{.BIN_DIR}}/{{.APP_NAME}}.exe' diff --git a/v3/examples/badge/build/windows/icon.ico b/v3/examples/badge/build/windows/icon.ico new file mode 100644 index 000000000..bfa0690b7 Binary files /dev/null and b/v3/examples/badge/build/windows/icon.ico differ diff --git a/v3/examples/badge/build/windows/info.json b/v3/examples/badge/build/windows/info.json new file mode 100644 index 000000000..850b2b5b0 --- /dev/null +++ b/v3/examples/badge/build/windows/info.json @@ -0,0 +1,15 @@ +{ + "fixed": { + "file_version": "0.1.0" + }, + "info": { + "0000": { + "ProductVersion": "0.1.0", + "CompanyName": "My Company", + "FileDescription": "My Product Description", + "LegalCopyright": "© now, My Company", + "ProductName": "My Product", + "Comments": "This is a comment" + } + } +} \ No newline at end of file diff --git a/v3/examples/badge/build/windows/nsis/project.nsi b/v3/examples/badge/build/windows/nsis/project.nsi new file mode 100644 index 000000000..985b8e207 --- /dev/null +++ b/v3/examples/badge/build/windows/nsis/project.nsi @@ -0,0 +1,112 @@ +Unicode true + +#### +## Please note: Template replacements don't work in this file. They are provided with default defines like +## mentioned underneath. +## If the keyword is not defined, "wails_tools.nsh" will populate them. +## If they are defined here, "wails_tools.nsh" will not touch them. This allows you to use this project.nsi manually +## from outside of Wails for debugging and development of the installer. +## +## For development first make a wails nsis build to populate the "wails_tools.nsh": +## > wails build --target windows/amd64 --nsis +## Then you can call makensis on this file with specifying the path to your binary: +## For a AMD64 only installer: +## > makensis -DARG_WAILS_AMD64_BINARY=..\..\bin\app.exe +## For a ARM64 only installer: +## > makensis -DARG_WAILS_ARM64_BINARY=..\..\bin\app.exe +## For a installer with both architectures: +## > makensis -DARG_WAILS_AMD64_BINARY=..\..\bin\app-amd64.exe -DARG_WAILS_ARM64_BINARY=..\..\bin\app-arm64.exe +#### +## The following information is taken from the wails_tools.nsh file, but they can be overwritten here. +#### +## !define INFO_PROJECTNAME "my-project" # Default "badge" +## !define INFO_COMPANYNAME "My Company" # Default "My Company" +## !define INFO_PRODUCTNAME "My Product Name" # Default "My Product" +## !define INFO_PRODUCTVERSION "1.0.0" # Default "0.1.0" +## !define INFO_COPYRIGHT "(c) Now, My Company" # Default "© now, My Company" +### +## !define PRODUCT_EXECUTABLE "Application.exe" # Default "${INFO_PROJECTNAME}.exe" +## !define UNINST_KEY_NAME "UninstKeyInRegistry" # Default "${INFO_COMPANYNAME}${INFO_PRODUCTNAME}" +#### +## !define REQUEST_EXECUTION_LEVEL "admin" # Default "admin" see also https://nsis.sourceforge.io/Docs/Chapter4.html +#### +## Include the wails tools +#### +!include "wails_tools.nsh" + +# The version information for this two must consist of 4 parts +VIProductVersion "${INFO_PRODUCTVERSION}.0" +VIFileVersion "${INFO_PRODUCTVERSION}.0" + +VIAddVersionKey "CompanyName" "${INFO_COMPANYNAME}" +VIAddVersionKey "FileDescription" "${INFO_PRODUCTNAME} Installer" +VIAddVersionKey "ProductVersion" "${INFO_PRODUCTVERSION}" +VIAddVersionKey "FileVersion" "${INFO_PRODUCTVERSION}" +VIAddVersionKey "LegalCopyright" "${INFO_COPYRIGHT}" +VIAddVersionKey "ProductName" "${INFO_PRODUCTNAME}" + +# Enable HiDPI support. https://nsis.sourceforge.io/Reference/ManifestDPIAware +ManifestDPIAware true + +!include "MUI.nsh" + +!define MUI_ICON "..\icon.ico" +!define MUI_UNICON "..\icon.ico" +# !define MUI_WELCOMEFINISHPAGE_BITMAP "resources\leftimage.bmp" #Include this to add a bitmap on the left side of the Welcome Page. Must be a size of 164x314 +!define MUI_FINISHPAGE_NOAUTOCLOSE # Wait on the INSTFILES page so the user can take a look into the details of the installation steps +!define MUI_ABORTWARNING # This will warn the user if they exit from the installer. + +!insertmacro MUI_PAGE_WELCOME # Welcome to the installer page. +# !insertmacro MUI_PAGE_LICENSE "resources\eula.txt" # Adds a EULA page to the installer +!insertmacro MUI_PAGE_DIRECTORY # In which folder install page. +!insertmacro MUI_PAGE_INSTFILES # Installing page. +!insertmacro MUI_PAGE_FINISH # Finished installation page. + +!insertmacro MUI_UNPAGE_INSTFILES # Uninstalling page + +!insertmacro MUI_LANGUAGE "English" # Set the Language of the installer + +## The following two statements can be used to sign the installer and the uninstaller. The path to the binaries are provided in %1 +#!uninstfinalize 'signtool --file "%1"' +#!finalize 'signtool --file "%1"' + +Name "${INFO_PRODUCTNAME}" +OutFile "..\..\..\bin\${INFO_PROJECTNAME}-${ARCH}-installer.exe" # Name of the installer's file. +InstallDir "$PROGRAMFILES64\${INFO_COMPANYNAME}\${INFO_PRODUCTNAME}" # Default installing folder ($PROGRAMFILES is Program Files folder). +ShowInstDetails show # This will always show the installation details. + +Function .onInit + !insertmacro wails.checkArchitecture +FunctionEnd + +Section + !insertmacro wails.setShellContext + + !insertmacro wails.webview2runtime + + SetOutPath $INSTDIR + + !insertmacro wails.files + + CreateShortcut "$SMPROGRAMS\${INFO_PRODUCTNAME}.lnk" "$INSTDIR\${PRODUCT_EXECUTABLE}" + CreateShortCut "$DESKTOP\${INFO_PRODUCTNAME}.lnk" "$INSTDIR\${PRODUCT_EXECUTABLE}" + + !insertmacro wails.associateFiles + + !insertmacro wails.writeUninstaller +SectionEnd + +Section "uninstall" + !insertmacro wails.setShellContext + + RMDir /r "$AppData\${PRODUCT_EXECUTABLE}" # Remove the WebView2 DataPath + + RMDir /r $INSTDIR + + Delete "$SMPROGRAMS\${INFO_PRODUCTNAME}.lnk" + Delete "$DESKTOP\${INFO_PRODUCTNAME}.lnk" + + !insertmacro wails.unassociateFiles + + !insertmacro wails.deleteUninstaller +SectionEnd diff --git a/v3/examples/badge/build/windows/nsis/wails_tools.nsh b/v3/examples/badge/build/windows/nsis/wails_tools.nsh new file mode 100644 index 000000000..6fc10ab79 --- /dev/null +++ b/v3/examples/badge/build/windows/nsis/wails_tools.nsh @@ -0,0 +1,212 @@ +# DO NOT EDIT - Generated automatically by `wails build` + +!include "x64.nsh" +!include "WinVer.nsh" +!include "FileFunc.nsh" + +!ifndef INFO_PROJECTNAME + !define INFO_PROJECTNAME "badge" +!endif +!ifndef INFO_COMPANYNAME + !define INFO_COMPANYNAME "My Company" +!endif +!ifndef INFO_PRODUCTNAME + !define INFO_PRODUCTNAME "My Product" +!endif +!ifndef INFO_PRODUCTVERSION + !define INFO_PRODUCTVERSION "0.1.0" +!endif +!ifndef INFO_COPYRIGHT + !define INFO_COPYRIGHT "© now, My Company" +!endif +!ifndef PRODUCT_EXECUTABLE + !define PRODUCT_EXECUTABLE "${INFO_PROJECTNAME}.exe" +!endif +!ifndef UNINST_KEY_NAME + !define UNINST_KEY_NAME "${INFO_COMPANYNAME}${INFO_PRODUCTNAME}" +!endif +!define UNINST_KEY "Software\Microsoft\Windows\CurrentVersion\Uninstall\${UNINST_KEY_NAME}" + +!ifndef REQUEST_EXECUTION_LEVEL + !define REQUEST_EXECUTION_LEVEL "admin" +!endif + +RequestExecutionLevel "${REQUEST_EXECUTION_LEVEL}" + +!ifdef ARG_WAILS_AMD64_BINARY + !define SUPPORTS_AMD64 +!endif + +!ifdef ARG_WAILS_ARM64_BINARY + !define SUPPORTS_ARM64 +!endif + +!ifdef SUPPORTS_AMD64 + !ifdef SUPPORTS_ARM64 + !define ARCH "amd64_arm64" + !else + !define ARCH "amd64" + !endif +!else + !ifdef SUPPORTS_ARM64 + !define ARCH "arm64" + !else + !error "Wails: Undefined ARCH, please provide at least one of ARG_WAILS_AMD64_BINARY or ARG_WAILS_ARM64_BINARY" + !endif +!endif + +!macro wails.checkArchitecture + !ifndef WAILS_WIN10_REQUIRED + !define WAILS_WIN10_REQUIRED "This product is only supported on Windows 10 (Server 2016) and later." + !endif + + !ifndef WAILS_ARCHITECTURE_NOT_SUPPORTED + !define WAILS_ARCHITECTURE_NOT_SUPPORTED "This product can't be installed on the current Windows architecture. Supports: ${ARCH}" + !endif + + ${If} ${AtLeastWin10} + !ifdef SUPPORTS_AMD64 + ${if} ${IsNativeAMD64} + Goto ok + ${EndIf} + !endif + + !ifdef SUPPORTS_ARM64 + ${if} ${IsNativeARM64} + Goto ok + ${EndIf} + !endif + + IfSilent silentArch notSilentArch + silentArch: + SetErrorLevel 65 + Abort + notSilentArch: + MessageBox MB_OK "${WAILS_ARCHITECTURE_NOT_SUPPORTED}" + Quit + ${else} + IfSilent silentWin notSilentWin + silentWin: + SetErrorLevel 64 + Abort + notSilentWin: + MessageBox MB_OK "${WAILS_WIN10_REQUIRED}" + Quit + ${EndIf} + + ok: +!macroend + +!macro wails.files + !ifdef SUPPORTS_AMD64 + ${if} ${IsNativeAMD64} + File "/oname=${PRODUCT_EXECUTABLE}" "${ARG_WAILS_AMD64_BINARY}" + ${EndIf} + !endif + + !ifdef SUPPORTS_ARM64 + ${if} ${IsNativeARM64} + File "/oname=${PRODUCT_EXECUTABLE}" "${ARG_WAILS_ARM64_BINARY}" + ${EndIf} + !endif +!macroend + +!macro wails.writeUninstaller + WriteUninstaller "$INSTDIR\uninstall.exe" + + SetRegView 64 + WriteRegStr HKLM "${UNINST_KEY}" "Publisher" "${INFO_COMPANYNAME}" + WriteRegStr HKLM "${UNINST_KEY}" "DisplayName" "${INFO_PRODUCTNAME}" + WriteRegStr HKLM "${UNINST_KEY}" "DisplayVersion" "${INFO_PRODUCTVERSION}" + WriteRegStr HKLM "${UNINST_KEY}" "DisplayIcon" "$INSTDIR\${PRODUCT_EXECUTABLE}" + WriteRegStr HKLM "${UNINST_KEY}" "UninstallString" "$\"$INSTDIR\uninstall.exe$\"" + WriteRegStr HKLM "${UNINST_KEY}" "QuietUninstallString" "$\"$INSTDIR\uninstall.exe$\" /S" + + ${GetSize} "$INSTDIR" "/S=0K" $0 $1 $2 + IntFmt $0 "0x%08X" $0 + WriteRegDWORD HKLM "${UNINST_KEY}" "EstimatedSize" "$0" +!macroend + +!macro wails.deleteUninstaller + Delete "$INSTDIR\uninstall.exe" + + SetRegView 64 + DeleteRegKey HKLM "${UNINST_KEY}" +!macroend + +!macro wails.setShellContext + ${If} ${REQUEST_EXECUTION_LEVEL} == "admin" + SetShellVarContext all + ${else} + SetShellVarContext current + ${EndIf} +!macroend + +# Install webview2 by launching the bootstrapper +# See https://docs.microsoft.com/en-us/microsoft-edge/webview2/concepts/distribution#online-only-deployment +!macro wails.webview2runtime + !ifndef WAILS_INSTALL_WEBVIEW_DETAILPRINT + !define WAILS_INSTALL_WEBVIEW_DETAILPRINT "Installing: WebView2 Runtime" + !endif + + SetRegView 64 + # If the admin key exists and is not empty then webview2 is already installed + ReadRegStr $0 HKLM "SOFTWARE\WOW6432Node\Microsoft\EdgeUpdate\Clients\{F3017226-FE2A-4295-8BDF-00C3A9A7E4C5}" "pv" + ${If} $0 != "" + Goto ok + ${EndIf} + + ${If} ${REQUEST_EXECUTION_LEVEL} == "user" + # If the installer is run in user level, check the user specific key exists and is not empty then webview2 is already installed + ReadRegStr $0 HKCU "Software\Microsoft\EdgeUpdate\Clients\{F3017226-FE2A-4295-8BDF-00C3A9A7E4C5}" "pv" + ${If} $0 != "" + Goto ok + ${EndIf} + ${EndIf} + + SetDetailsPrint both + DetailPrint "${WAILS_INSTALL_WEBVIEW_DETAILPRINT}" + SetDetailsPrint listonly + + InitPluginsDir + CreateDirectory "$pluginsdir\webview2bootstrapper" + SetOutPath "$pluginsdir\webview2bootstrapper" + File "MicrosoftEdgeWebview2Setup.exe" + ExecWait '"$pluginsdir\webview2bootstrapper\MicrosoftEdgeWebview2Setup.exe" /silent /install' + + SetDetailsPrint both + ok: +!macroend + +# Copy of APP_ASSOCIATE and APP_UNASSOCIATE macros from here https://gist.github.com/nikku/281d0ef126dbc215dd58bfd5b3a5cd5b +!macro APP_ASSOCIATE EXT FILECLASS DESCRIPTION ICON COMMANDTEXT COMMAND + ; Backup the previously associated file class + ReadRegStr $R0 SHELL_CONTEXT "Software\Classes\.${EXT}" "" + WriteRegStr SHELL_CONTEXT "Software\Classes\.${EXT}" "${FILECLASS}_backup" "$R0" + + WriteRegStr SHELL_CONTEXT "Software\Classes\.${EXT}" "" "${FILECLASS}" + + WriteRegStr SHELL_CONTEXT "Software\Classes\${FILECLASS}" "" `${DESCRIPTION}` + WriteRegStr SHELL_CONTEXT "Software\Classes\${FILECLASS}\DefaultIcon" "" `${ICON}` + WriteRegStr SHELL_CONTEXT "Software\Classes\${FILECLASS}\shell" "" "open" + WriteRegStr SHELL_CONTEXT "Software\Classes\${FILECLASS}\shell\open" "" `${COMMANDTEXT}` + WriteRegStr SHELL_CONTEXT "Software\Classes\${FILECLASS}\shell\open\command" "" `${COMMAND}` +!macroend + +!macro APP_UNASSOCIATE EXT FILECLASS + ; Backup the previously associated file class + ReadRegStr $R0 SHELL_CONTEXT "Software\Classes\.${EXT}" `${FILECLASS}_backup` + WriteRegStr SHELL_CONTEXT "Software\Classes\.${EXT}" "" "$R0" + + DeleteRegKey SHELL_CONTEXT `Software\Classes\${FILECLASS}` +!macroend + +!macro wails.associateFiles + ; Create file associations + +!macroend + +!macro wails.unassociateFiles + ; Delete app associations + +!macroend \ No newline at end of file diff --git a/v3/examples/badge/build/windows/wails.exe.manifest b/v3/examples/badge/build/windows/wails.exe.manifest new file mode 100644 index 000000000..fcfd2fc46 --- /dev/null +++ b/v3/examples/badge/build/windows/wails.exe.manifest @@ -0,0 +1,22 @@ + + + + + + + + + + + true/pm + permonitorv2,permonitor + + + + + + + + + + \ No newline at end of file diff --git a/v3/examples/badge/frontend/Inter Font License.txt b/v3/examples/badge/frontend/Inter Font License.txt new file mode 100644 index 000000000..b525cbf3a --- /dev/null +++ b/v3/examples/badge/frontend/Inter Font License.txt @@ -0,0 +1,93 @@ +Copyright 2020 The Inter Project Authors (https://github.com/rsms/inter) + +This Font Software is licensed under the SIL Open Font License, Version 1.1. +This license is copied below, and is also available with a FAQ at: +http://scripts.sil.org/OFL + + +----------------------------------------------------------- +SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007 +----------------------------------------------------------- + +PREAMBLE +The goals of the Open Font License (OFL) are to stimulate worldwide +development of collaborative font projects, to support the font creation +efforts of academic and linguistic communities, and to provide a free and +open framework in which fonts may be shared and improved in partnership +with others. + +The OFL allows the licensed fonts to be used, studied, modified and +redistributed freely as long as they are not sold by themselves. The +fonts, including any derivative works, can be bundled, embedded, +redistributed and/or sold with any software provided that any reserved +names are not used by derivative works. The fonts and derivatives, +however, cannot be released under any other type of license. The +requirement for fonts to remain under this license does not apply +to any document created using the fonts or their derivatives. + +DEFINITIONS +"Font Software" refers to the set of files released by the Copyright +Holder(s) under this license and clearly marked as such. This may +include source files, build scripts and documentation. + +"Reserved Font Name" refers to any names specified as such after the +copyright statement(s). + +"Original Version" refers to the collection of Font Software components as +distributed by the Copyright Holder(s). + +"Modified Version" refers to any derivative made by adding to, deleting, +or substituting -- in part or in whole -- any of the components of the +Original Version, by changing formats or by porting the Font Software to a +new environment. + +"Author" refers to any designer, engineer, programmer, technical +writer or other person who contributed to the Font Software. + +PERMISSION & CONDITIONS +Permission is hereby granted, free of charge, to any person obtaining +a copy of the Font Software, to use, study, copy, merge, embed, modify, +redistribute, and sell modified and unmodified copies of the Font +Software, subject to the following conditions: + +1) Neither the Font Software nor any of its individual components, +in Original or Modified Versions, may be sold by itself. + +2) Original or Modified Versions of the Font Software may be bundled, +redistributed and/or sold with any software, provided that each copy +contains the above copyright notice and this license. These can be +included either as stand-alone text files, human-readable headers or +in the appropriate machine-readable metadata fields within text or +binary files as long as those fields can be easily viewed by the user. + +3) No Modified Version of the Font Software may use the Reserved Font +Name(s) unless explicit written permission is granted by the corresponding +Copyright Holder. This restriction only applies to the primary font name as +presented to the users. + +4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font +Software shall not be used to promote, endorse or advertise any +Modified Version, except to acknowledge the contribution(s) of the +Copyright Holder(s) and the Author(s) or with their explicit written +permission. + +5) The Font Software, modified or unmodified, in part or in whole, +must be distributed entirely under this license, and must not be +distributed under any other license. The requirement for fonts to +remain under this license does not apply to any document created +using the Font Software. + +TERMINATION +This license becomes null and void if any of the above conditions are +not met. + +DISCLAIMER +THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF +MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT +OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE +COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, +INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL +DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING +FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM +OTHER DEALINGS IN THE FONT SOFTWARE. diff --git a/v3/examples/badge/frontend/bindings/github.com/wailsapp/wails/v3/pkg/services/dock/dockservice.ts b/v3/examples/badge/frontend/bindings/github.com/wailsapp/wails/v3/pkg/services/dock/dockservice.ts new file mode 100644 index 000000000..abf1f22e4 --- /dev/null +++ b/v3/examples/badge/frontend/bindings/github.com/wailsapp/wails/v3/pkg/services/dock/dockservice.ts @@ -0,0 +1,53 @@ +// Cynhyrchwyd y ffeil hon yn awtomatig. PEIDIWCH Â MODIWL +// This file is automatically generated. DO NOT EDIT + +/** + * Service represents the dock service + * @module + */ + +// eslint-disable-next-line @typescript-eslint/ban-ts-comment +// @ts-ignore: Unused imports +import { Call as $Call, CancellablePromise as $CancellablePromise, Create as $Create } from "@wailsio/runtime"; + +// eslint-disable-next-line @typescript-eslint/ban-ts-comment +// @ts-ignore: Unused imports +import * as $models from "./models.js"; + +/** + * HideAppIcon hides the app icon in the dock/taskbar. + */ +export function HideAppIcon(): $CancellablePromise { + return $Call.ByID(3413658144); +} + +/** + * RemoveBadge removes the badge label from the application icon. + * This method ensures the badge call is made on the main thread to avoid crashes. + */ +export function RemoveBadge(): $CancellablePromise { + return $Call.ByID(2752757297); +} + +/** + * SetBadge sets the badge label on the application icon. + * This method ensures the badge call is made on the main thread to avoid crashes. + */ +export function SetBadge(label: string): $CancellablePromise { + return $Call.ByID(1717705661, label); +} + +/** + * SetCustomBadge sets the badge label on the application icon with custom options. + * This method ensures the badge call is made on the main thread to avoid crashes. + */ +export function SetCustomBadge(label: string, options: $models.BadgeOptions): $CancellablePromise { + return $Call.ByID(2730169760, label, options); +} + +/** + * ShowAppIcon shows the app icon in the dock/taskbar. + */ +export function ShowAppIcon(): $CancellablePromise { + return $Call.ByID(3409697379); +} diff --git a/v3/examples/badge/frontend/bindings/github.com/wailsapp/wails/v3/pkg/services/dock/index.ts b/v3/examples/badge/frontend/bindings/github.com/wailsapp/wails/v3/pkg/services/dock/index.ts new file mode 100644 index 000000000..fbdaf19f3 --- /dev/null +++ b/v3/examples/badge/frontend/bindings/github.com/wailsapp/wails/v3/pkg/services/dock/index.ts @@ -0,0 +1,11 @@ +// Cynhyrchwyd y ffeil hon yn awtomatig. PEIDIWCH Â MODIWL +// This file is automatically generated. DO NOT EDIT + +import * as DockService from "./dockservice.js"; +export { + DockService +}; + +export { + BadgeOptions +} from "./models.js"; diff --git a/v3/examples/badge/frontend/bindings/github.com/wailsapp/wails/v3/pkg/services/dock/models.ts b/v3/examples/badge/frontend/bindings/github.com/wailsapp/wails/v3/pkg/services/dock/models.ts new file mode 100644 index 000000000..f97c8a4c6 --- /dev/null +++ b/v3/examples/badge/frontend/bindings/github.com/wailsapp/wails/v3/pkg/services/dock/models.ts @@ -0,0 +1,61 @@ +// Cynhyrchwyd y ffeil hon yn awtomatig. PEIDIWCH Â MODIWL +// This file is automatically generated. DO NOT EDIT + +// eslint-disable-next-line @typescript-eslint/ban-ts-comment +// @ts-ignore: Unused imports +import { Create as $Create } from "@wailsio/runtime"; + +// eslint-disable-next-line @typescript-eslint/ban-ts-comment +// @ts-ignore: Unused imports +import * as color$0 from "../../../../../../../image/color/models.js"; + +/** + * BadgeOptions represents options for customizing badge appearance + */ +export class BadgeOptions { + "TextColour": color$0.RGBA; + "BackgroundColour": color$0.RGBA; + "FontName": string; + "FontSize": number; + "SmallFontSize": number; + + /** Creates a new BadgeOptions instance. */ + constructor($$source: Partial = {}) { + if (!("TextColour" in $$source)) { + this["TextColour"] = (new color$0.RGBA()); + } + if (!("BackgroundColour" in $$source)) { + this["BackgroundColour"] = (new color$0.RGBA()); + } + if (!("FontName" in $$source)) { + this["FontName"] = ""; + } + if (!("FontSize" in $$source)) { + this["FontSize"] = 0; + } + if (!("SmallFontSize" in $$source)) { + this["SmallFontSize"] = 0; + } + + Object.assign(this, $$source); + } + + /** + * Creates a new BadgeOptions instance from a string or object. + */ + static createFrom($$source: any = {}): BadgeOptions { + const $$createField0_0 = $$createType0; + const $$createField1_0 = $$createType0; + let $$parsedSource = typeof $$source === 'string' ? JSON.parse($$source) : $$source; + if ("TextColour" in $$parsedSource) { + $$parsedSource["TextColour"] = $$createField0_0($$parsedSource["TextColour"]); + } + if ("BackgroundColour" in $$parsedSource) { + $$parsedSource["BackgroundColour"] = $$createField1_0($$parsedSource["BackgroundColour"]); + } + return new BadgeOptions($$parsedSource as Partial); + } +} + +// Private type creation functions +const $$createType0 = color$0.RGBA.createFrom; diff --git a/v3/examples/badge/frontend/bindings/image/color/index.ts b/v3/examples/badge/frontend/bindings/image/color/index.ts new file mode 100644 index 000000000..97b507b08 --- /dev/null +++ b/v3/examples/badge/frontend/bindings/image/color/index.ts @@ -0,0 +1,6 @@ +// Cynhyrchwyd y ffeil hon yn awtomatig. PEIDIWCH Â MODIWL +// This file is automatically generated. DO NOT EDIT + +export { + RGBA +} from "./models.js"; diff --git a/v3/examples/badge/frontend/bindings/image/color/models.ts b/v3/examples/badge/frontend/bindings/image/color/models.ts new file mode 100644 index 000000000..0d4eab56d --- /dev/null +++ b/v3/examples/badge/frontend/bindings/image/color/models.ts @@ -0,0 +1,46 @@ +// Cynhyrchwyd y ffeil hon yn awtomatig. PEIDIWCH Â MODIWL +// This file is automatically generated. DO NOT EDIT + +// eslint-disable-next-line @typescript-eslint/ban-ts-comment +// @ts-ignore: Unused imports +import { Create as $Create } from "@wailsio/runtime"; + +/** + * RGBA represents a traditional 32-bit alpha-premultiplied color, having 8 + * bits for each of red, green, blue and alpha. + * + * An alpha-premultiplied color component C has been scaled by alpha (A), so + * has valid values 0 <= C <= A. + */ +export class RGBA { + "R": number; + "G": number; + "B": number; + "A": number; + + /** Creates a new RGBA instance. */ + constructor($$source: Partial = {}) { + if (!("R" in $$source)) { + this["R"] = 0; + } + if (!("G" in $$source)) { + this["G"] = 0; + } + if (!("B" in $$source)) { + this["B"] = 0; + } + if (!("A" in $$source)) { + this["A"] = 0; + } + + Object.assign(this, $$source); + } + + /** + * Creates a new RGBA instance from a string or object. + */ + static createFrom($$source: any = {}): RGBA { + let $$parsedSource = typeof $$source === 'string' ? JSON.parse($$source) : $$source; + return new RGBA($$parsedSource as Partial); + } +} diff --git a/v3/examples/badge/frontend/dist/Inter-Medium.ttf b/v3/examples/badge/frontend/dist/Inter-Medium.ttf new file mode 100644 index 000000000..a01f3777a Binary files /dev/null and b/v3/examples/badge/frontend/dist/Inter-Medium.ttf differ diff --git a/v3/examples/badge/frontend/dist/assets/index-CtfGGYXM.js b/v3/examples/badge/frontend/dist/assets/index-CtfGGYXM.js new file mode 100644 index 000000000..6149df5db --- /dev/null +++ b/v3/examples/badge/frontend/dist/assets/index-CtfGGYXM.js @@ -0,0 +1,1357 @@ +(function polyfill() { + const relList = document.createElement("link").relList; + if (relList && relList.supports && relList.supports("modulepreload")) { + return; + } + for (const link of document.querySelectorAll('link[rel="modulepreload"]')) { + processPreload(link); + } + new MutationObserver((mutations) => { + for (const mutation of mutations) { + if (mutation.type !== "childList") { + continue; + } + for (const node of mutation.addedNodes) { + if (node.tagName === "LINK" && node.rel === "modulepreload") + processPreload(node); + } + } + }).observe(document, { childList: true, subtree: true }); + function getFetchOpts(link) { + const fetchOpts = {}; + if (link.integrity) fetchOpts.integrity = link.integrity; + if (link.referrerPolicy) fetchOpts.referrerPolicy = link.referrerPolicy; + if (link.crossOrigin === "use-credentials") + fetchOpts.credentials = "include"; + else if (link.crossOrigin === "anonymous") fetchOpts.credentials = "omit"; + else fetchOpts.credentials = "same-origin"; + return fetchOpts; + } + function processPreload(link) { + if (link.ep) + return; + link.ep = true; + const fetchOpts = getFetchOpts(link); + fetch(link.href, fetchOpts); + } +})(); +const urlAlphabet = "useandom-26T198340PX75pxJACKVERYMINDBUSHWOLF_GQZbfghjklqvwyzrict"; +function nanoid(size = 21) { + let id = ""; + let i = size | 0; + while (i--) { + id += urlAlphabet[Math.random() * 64 | 0]; + } + return id; +} +const runtimeURL = window.location.origin + "/wails/runtime"; +const objectNames = Object.freeze({ + Call: 0, + Clipboard: 1, + Application: 2, + Events: 3, + ContextMenu: 4, + Dialog: 5, + Window: 6, + Screens: 7, + System: 8, + Browser: 9, + CancelCall: 10 +}); +let clientId = nanoid(); +function newRuntimeCaller(object, windowName = "") { + return function(method, args = null) { + return runtimeCallWithID(object, method, windowName, args); + }; +} +async function runtimeCallWithID(objectID, method, windowName, args) { + var _a2, _b; + let url = new URL(runtimeURL); + url.searchParams.append("object", objectID.toString()); + url.searchParams.append("method", method.toString()); + if (args) { + url.searchParams.append("args", JSON.stringify(args)); + } + let headers = { + ["x-wails-client-id"]: clientId + }; + if (windowName) { + headers["x-wails-window-name"] = windowName; + } + let response = await fetch(url, { headers }); + if (!response.ok) { + throw new Error(await response.text()); + } + if (((_b = (_a2 = response.headers.get("Content-Type")) === null || _a2 === void 0 ? void 0 : _a2.indexOf("application/json")) !== null && _b !== void 0 ? _b : -1) !== -1) { + return response.json(); + } else { + return response.text(); + } +} +newRuntimeCaller(objectNames.System); +const _invoke = function() { + var _a2, _b, _c, _d, _e; + try { + if ((_b = (_a2 = window.chrome) === null || _a2 === void 0 ? void 0 : _a2.webview) === null || _b === void 0 ? void 0 : _b.postMessage) { + return window.chrome.webview.postMessage.bind(window.chrome.webview); + } else if ((_e = (_d = (_c = window.webkit) === null || _c === void 0 ? void 0 : _c.messageHandlers) === null || _d === void 0 ? void 0 : _d["external"]) === null || _e === void 0 ? void 0 : _e.postMessage) { + return window.webkit.messageHandlers["external"].postMessage.bind(window.webkit.messageHandlers["external"]); + } + } catch (e) { + } + console.warn("\n%c⚠️ Browser Environment Detected %c\n\n%cOnly UI previews are available in the browser. For full functionality, please run the application in desktop mode.\nMore information at: https://v3.wails.io/learn/build/#using-a-browser-for-development\n", "background: #ffffff; color: #000000; font-weight: bold; padding: 4px 8px; border-radius: 4px; border: 2px solid #000000;", "background: transparent;", "color: #ffffff; font-style: italic; font-weight: bold;"); + return null; +}(); +function invoke(msg) { + _invoke === null || _invoke === void 0 ? void 0 : _invoke(msg); +} +function IsWindows() { + return window._wails.environment.OS === "windows"; +} +function IsDebug() { + return Boolean(window._wails.environment.Debug); +} +function canTrackButtons() { + return new MouseEvent("mousedown").buttons === 0; +} +function eventTarget(event) { + var _a2; + if (event.target instanceof HTMLElement) { + return event.target; + } else if (!(event.target instanceof HTMLElement) && event.target instanceof Node) { + return (_a2 = event.target.parentElement) !== null && _a2 !== void 0 ? _a2 : document.body; + } else { + return document.body; + } +} +document.addEventListener("DOMContentLoaded", () => { +}); +window.addEventListener("contextmenu", contextMenuHandler); +const call$2 = newRuntimeCaller(objectNames.ContextMenu); +const ContextMenuOpen = 0; +function openContextMenu(id, x, y, data) { + void call$2(ContextMenuOpen, { id, x, y, data }); +} +function contextMenuHandler(event) { + const target = eventTarget(event); + const customContextMenu = window.getComputedStyle(target).getPropertyValue("--custom-contextmenu").trim(); + if (customContextMenu) { + event.preventDefault(); + const data = window.getComputedStyle(target).getPropertyValue("--custom-contextmenu-data"); + openContextMenu(customContextMenu, event.clientX, event.clientY, data); + } else { + processDefaultContextMenu(event, target); + } +} +function processDefaultContextMenu(event, target) { + if (IsDebug()) { + return; + } + switch (window.getComputedStyle(target).getPropertyValue("--default-contextmenu").trim()) { + case "show": + return; + case "hide": + event.preventDefault(); + return; + } + if (target.isContentEditable) { + return; + } + const selection = window.getSelection(); + const hasSelection = selection && selection.toString().length > 0; + if (hasSelection) { + for (let i = 0; i < selection.rangeCount; i++) { + const range = selection.getRangeAt(i); + const rects = range.getClientRects(); + for (let j = 0; j < rects.length; j++) { + const rect = rects[j]; + if (document.elementFromPoint(rect.left, rect.top) === target) { + return; + } + } + } + } + if (target instanceof HTMLInputElement || target instanceof HTMLTextAreaElement) { + if (hasSelection || !target.readOnly && !target.disabled) { + return; + } + } + event.preventDefault(); +} +function GetFlag(key) { + try { + return window._wails.flags[key]; + } catch (e) { + throw new Error("Unable to retrieve flag '" + key + "': " + e, { cause: e }); + } +} +let canDrag = false; +let dragging = false; +let resizable = false; +let canResize = false; +let resizing = false; +let resizeEdge = ""; +let defaultCursor = "auto"; +let buttons = 0; +const buttonsTracked = canTrackButtons(); +window._wails = window._wails || {}; +window._wails.setResizable = (value) => { + resizable = value; + if (!resizable) { + canResize = resizing = false; + setResize(); + } +}; +window.addEventListener("mousedown", update, { capture: true }); +window.addEventListener("mousemove", update, { capture: true }); +window.addEventListener("mouseup", update, { capture: true }); +for (const ev of ["click", "contextmenu", "dblclick"]) { + window.addEventListener(ev, suppressEvent, { capture: true }); +} +function suppressEvent(event) { + if (dragging || resizing) { + event.stopImmediatePropagation(); + event.stopPropagation(); + event.preventDefault(); + } +} +const MouseDown = 0; +const MouseUp = 1; +const MouseMove = 2; +function update(event) { + let eventType, eventButtons = event.buttons; + switch (event.type) { + case "mousedown": + eventType = MouseDown; + if (!buttonsTracked) { + eventButtons = buttons | 1 << event.button; + } + break; + case "mouseup": + eventType = MouseUp; + if (!buttonsTracked) { + eventButtons = buttons & ~(1 << event.button); + } + break; + default: + eventType = MouseMove; + if (!buttonsTracked) { + eventButtons = buttons; + } + break; + } + let released = buttons & ~eventButtons; + let pressed = eventButtons & ~buttons; + buttons = eventButtons; + if (eventType === MouseDown && !(pressed & event.button)) { + released |= 1 << event.button; + pressed |= 1 << event.button; + } + if (eventType !== MouseMove && resizing || dragging && (eventType === MouseDown || event.button !== 0)) { + event.stopImmediatePropagation(); + event.stopPropagation(); + event.preventDefault(); + } + if (released & 1) { + primaryUp(); + } + if (pressed & 1) { + primaryDown(event); + } + if (eventType === MouseMove) { + onMouseMove(event); + } +} +function primaryDown(event) { + canDrag = false; + canResize = false; + if (!IsWindows()) { + if (event.type === "mousedown" && event.button === 0 && event.detail !== 1) { + return; + } + } + if (resizeEdge) { + canResize = true; + return; + } + const target = eventTarget(event); + const style = window.getComputedStyle(target); + canDrag = style.getPropertyValue("--wails-draggable").trim() === "drag" && (event.offsetX - parseFloat(style.paddingLeft) < target.clientWidth && event.offsetY - parseFloat(style.paddingTop) < target.clientHeight); +} +function primaryUp(event) { + canDrag = false; + dragging = false; + canResize = false; + resizing = false; +} +const cursorForEdge = Object.freeze({ + "se-resize": "nwse-resize", + "sw-resize": "nesw-resize", + "nw-resize": "nwse-resize", + "ne-resize": "nesw-resize", + "w-resize": "ew-resize", + "n-resize": "ns-resize", + "s-resize": "ns-resize", + "e-resize": "ew-resize" +}); +function setResize(edge) { + if (edge) { + if (!resizeEdge) { + defaultCursor = document.body.style.cursor; + } + document.body.style.cursor = cursorForEdge[edge]; + } else if (!edge && resizeEdge) { + document.body.style.cursor = defaultCursor; + } + resizeEdge = edge || ""; +} +function onMouseMove(event) { + if (canResize && resizeEdge) { + resizing = true; + invoke("wails:resize:" + resizeEdge); + } else if (canDrag) { + dragging = true; + invoke("wails:drag"); + } + if (dragging || resizing) { + canDrag = canResize = false; + return; + } + if (!resizable || !IsWindows()) { + if (resizeEdge) { + setResize(); + } + return; + } + const resizeHandleHeight = GetFlag("system.resizeHandleHeight") || 5; + const resizeHandleWidth = GetFlag("system.resizeHandleWidth") || 5; + const cornerExtra = GetFlag("resizeCornerExtra") || 10; + const rightBorder = window.outerWidth - event.clientX < resizeHandleWidth; + const leftBorder = event.clientX < resizeHandleWidth; + const topBorder = event.clientY < resizeHandleHeight; + const bottomBorder = window.outerHeight - event.clientY < resizeHandleHeight; + const rightCorner = window.outerWidth - event.clientX < resizeHandleWidth + cornerExtra; + const leftCorner = event.clientX < resizeHandleWidth + cornerExtra; + const topCorner = event.clientY < resizeHandleHeight + cornerExtra; + const bottomCorner = window.outerHeight - event.clientY < resizeHandleHeight + cornerExtra; + if (!leftCorner && !topCorner && !bottomCorner && !rightCorner) { + setResize(); + } else if (rightCorner && bottomCorner) + setResize("se-resize"); + else if (leftCorner && bottomCorner) + setResize("sw-resize"); + else if (leftCorner && topCorner) + setResize("nw-resize"); + else if (topCorner && rightCorner) + setResize("ne-resize"); + else if (leftBorder) + setResize("w-resize"); + else if (topBorder) + setResize("n-resize"); + else if (bottomBorder) + setResize("s-resize"); + else if (rightBorder) + setResize("e-resize"); + else + setResize(); +} +var fnToStr = Function.prototype.toString; +var reflectApply = typeof Reflect === "object" && Reflect !== null && Reflect.apply; +var badArrayLike; +var isCallableMarker; +if (typeof reflectApply === "function" && typeof Object.defineProperty === "function") { + try { + badArrayLike = Object.defineProperty({}, "length", { + get: function() { + throw isCallableMarker; + } + }); + isCallableMarker = {}; + reflectApply(function() { + throw 42; + }, null, badArrayLike); + } catch (_) { + if (_ !== isCallableMarker) { + reflectApply = null; + } + } +} else { + reflectApply = null; +} +var constructorRegex = /^\s*class\b/; +var isES6ClassFn = function isES6ClassFunction(value) { + try { + var fnStr = fnToStr.call(value); + return constructorRegex.test(fnStr); + } catch (e) { + return false; + } +}; +var tryFunctionObject = function tryFunctionToStr(value) { + try { + if (isES6ClassFn(value)) { + return false; + } + fnToStr.call(value); + return true; + } catch (e) { + return false; + } +}; +var toStr = Object.prototype.toString; +var objectClass = "[object Object]"; +var fnClass = "[object Function]"; +var genClass = "[object GeneratorFunction]"; +var ddaClass = "[object HTMLAllCollection]"; +var ddaClass2 = "[object HTML document.all class]"; +var ddaClass3 = "[object HTMLCollection]"; +var hasToStringTag = typeof Symbol === "function" && !!Symbol.toStringTag; +var isIE68 = !(0 in [,]); +var isDDA = function isDocumentDotAll() { + return false; +}; +if (typeof document === "object") { + var all = document.all; + if (toStr.call(all) === toStr.call(document.all)) { + isDDA = function isDocumentDotAll2(value) { + if ((isIE68 || !value) && (typeof value === "undefined" || typeof value === "object")) { + try { + var str = toStr.call(value); + return (str === ddaClass || str === ddaClass2 || str === ddaClass3 || str === objectClass) && value("") == null; + } catch (e) { + } + } + return false; + }; + } +} +function isCallableRefApply(value) { + if (isDDA(value)) { + return true; + } + if (!value) { + return false; + } + if (typeof value !== "function" && typeof value !== "object") { + return false; + } + try { + reflectApply(value, null, badArrayLike); + } catch (e) { + if (e !== isCallableMarker) { + return false; + } + } + return !isES6ClassFn(value) && tryFunctionObject(value); +} +function isCallableNoRefApply(value) { + if (isDDA(value)) { + return true; + } + if (!value) { + return false; + } + if (typeof value !== "function" && typeof value !== "object") { + return false; + } + if (hasToStringTag) { + return tryFunctionObject(value); + } + if (isES6ClassFn(value)) { + return false; + } + var strClass = toStr.call(value); + if (strClass !== fnClass && strClass !== genClass && !/^\[object HTML/.test(strClass)) { + return false; + } + return tryFunctionObject(value); +} +const isCallable = reflectApply ? isCallableRefApply : isCallableNoRefApply; +var _a; +class CancelError extends Error { + /** + * Constructs a new `CancelError` instance. + * @param message - The error message. + * @param options - Options to be forwarded to the Error constructor. + */ + constructor(message, options) { + super(message, options); + this.name = "CancelError"; + } +} +class CancelledRejectionError extends Error { + /** + * Constructs a new `CancelledRejectionError` instance. + * @param promise - The promise that caused the error originally. + * @param reason - The rejection reason. + * @param info - An optional informative message specifying the circumstances in which the error was thrown. + * Defaults to the string `"Unhandled rejection in cancelled promise."`. + */ + constructor(promise, reason, info) { + super((info !== null && info !== void 0 ? info : "Unhandled rejection in cancelled promise.") + " Reason: " + errorMessage(reason), { cause: reason }); + this.promise = promise; + this.name = "CancelledRejectionError"; + } +} +const barrierSym = Symbol("barrier"); +const cancelImplSym = Symbol("cancelImpl"); +const species = (_a = Symbol.species) !== null && _a !== void 0 ? _a : Symbol("speciesPolyfill"); +class CancellablePromise extends Promise { + /** + * Creates a new `CancellablePromise`. + * + * @param executor - A callback used to initialize the promise. This callback is passed two arguments: + * a `resolve` callback used to resolve the promise with a value + * or the result of another promise (possibly cancellable), + * and a `reject` callback used to reject the promise with a provided reason or error. + * If the value provided to the `resolve` callback is a thenable _and_ cancellable object + * (it has a `then` _and_ a `cancel` method), + * cancellation requests will be forwarded to that object and the oncancelled will not be invoked anymore. + * If any one of the two callbacks is called _after_ the promise has been cancelled, + * the provided values will be cancelled and resolved as usual, + * but their results will be discarded. + * However, if the resolution process ultimately ends up in a rejection + * that is not due to cancellation, the rejection reason + * will be wrapped in a {@link CancelledRejectionError} + * and bubbled up as an unhandled rejection. + * @param oncancelled - It is the caller's responsibility to ensure that any operation + * started by the executor is properly halted upon cancellation. + * This optional callback can be used to that purpose. + * It will be called _synchronously_ with a cancellation cause + * when cancellation is requested, _after_ the promise has already rejected + * with a {@link CancelError}, but _before_ + * any {@link then}/{@link catch}/{@link finally} callback runs. + * If the callback returns a thenable, the promise returned from {@link cancel} + * will only fulfill after the former has settled. + * Unhandled exceptions or rejections from the callback will be wrapped + * in a {@link CancelledRejectionError} and bubbled up as unhandled rejections. + * If the `resolve` callback is called before cancellation with a cancellable promise, + * cancellation requests on this promise will be diverted to that promise, + * and the original `oncancelled` callback will be discarded. + */ + constructor(executor, oncancelled) { + let resolve; + let reject; + super((res, rej) => { + resolve = res; + reject = rej; + }); + if (this.constructor[species] !== Promise) { + throw new TypeError("CancellablePromise does not support transparent subclassing. Please refrain from overriding the [Symbol.species] static property."); + } + let promise = { + promise: this, + resolve, + reject, + get oncancelled() { + return oncancelled !== null && oncancelled !== void 0 ? oncancelled : null; + }, + set oncancelled(cb) { + oncancelled = cb !== null && cb !== void 0 ? cb : void 0; + } + }; + const state = { + get root() { + return state; + }, + resolving: false, + settled: false + }; + void Object.defineProperties(this, { + [barrierSym]: { + configurable: false, + enumerable: false, + writable: true, + value: null + }, + [cancelImplSym]: { + configurable: false, + enumerable: false, + writable: false, + value: cancellerFor(promise, state) + } + }); + const rejector = rejectorFor(promise, state); + try { + executor(resolverFor(promise, state), rejector); + } catch (err) { + if (state.resolving) { + console.log("Unhandled exception in CancellablePromise executor.", err); + } else { + rejector(err); + } + } + } + /** + * Cancels immediately the execution of the operation associated with this promise. + * The promise rejects with a {@link CancelError} instance as reason, + * with the {@link CancelError#cause} property set to the given argument, if any. + * + * Has no effect if called after the promise has already settled; + * repeated calls in particular are safe, but only the first one + * will set the cancellation cause. + * + * The `CancelError` exception _need not_ be handled explicitly _on the promises that are being cancelled:_ + * cancelling a promise with no attached rejection handler does not trigger an unhandled rejection event. + * Therefore, the following idioms are all equally correct: + * ```ts + * new CancellablePromise((resolve, reject) => { ... }).cancel(); + * new CancellablePromise((resolve, reject) => { ... }).then(...).cancel(); + * new CancellablePromise((resolve, reject) => { ... }).then(...).catch(...).cancel(); + * ``` + * Whenever some cancelled promise in a chain rejects with a `CancelError` + * with the same cancellation cause as itself, the error will be discarded silently. + * However, the `CancelError` _will still be delivered_ to all attached rejection handlers + * added by {@link then} and related methods: + * ```ts + * let cancellable = new CancellablePromise((resolve, reject) => { ... }); + * cancellable.then(() => { ... }).catch(console.log); + * cancellable.cancel(); // A CancelError is printed to the console. + * ``` + * If the `CancelError` is not handled downstream by the time it reaches + * a _non-cancelled_ promise, it _will_ trigger an unhandled rejection event, + * just like normal rejections would: + * ```ts + * let cancellable = new CancellablePromise((resolve, reject) => { ... }); + * let chained = cancellable.then(() => { ... }).then(() => { ... }); // No catch... + * cancellable.cancel(); // Unhandled rejection event on chained! + * ``` + * Therefore, it is important to either cancel whole promise chains from their tail, + * as shown in the correct idioms above, or take care of handling errors everywhere. + * + * @returns A cancellable promise that _fulfills_ after the cancel callback (if any) + * and all handlers attached up to the call to cancel have run. + * If the cancel callback returns a thenable, the promise returned by `cancel` + * will also wait for that thenable to settle. + * This enables callers to wait for the cancelled operation to terminate + * without being forced to handle potential errors at the call site. + * ```ts + * cancellable.cancel().then(() => { + * // Cleanup finished, it's safe to do something else. + * }, (err) => { + * // Unreachable: the promise returned from cancel will never reject. + * }); + * ``` + * Note that the returned promise will _not_ handle implicitly any rejection + * that might have occurred already in the cancelled chain. + * It will just track whether registered handlers have been executed or not. + * Therefore, unhandled rejections will never be silently handled by calling cancel. + */ + cancel(cause) { + return new CancellablePromise((resolve) => { + Promise.all([ + this[cancelImplSym](new CancelError("Promise cancelled.", { cause })), + currentBarrier(this) + ]).then(() => resolve(), () => resolve()); + }); + } + /** + * Binds promise cancellation to the abort event of the given {@link AbortSignal}. + * If the signal has already aborted, the promise will be cancelled immediately. + * When either condition is verified, the cancellation cause will be set + * to the signal's abort reason (see {@link AbortSignal#reason}). + * + * Has no effect if called (or if the signal aborts) _after_ the promise has already settled. + * Only the first signal to abort will set the cancellation cause. + * + * For more details about the cancellation process, + * see {@link cancel} and the `CancellablePromise` constructor. + * + * This method enables `await`ing cancellable promises without having + * to store them for future cancellation, e.g.: + * ```ts + * await longRunningOperation().cancelOn(signal); + * ``` + * instead of: + * ```ts + * let promiseToBeCancelled = longRunningOperation(); + * await promiseToBeCancelled; + * ``` + * + * @returns This promise, for method chaining. + */ + cancelOn(signal) { + if (signal.aborted) { + void this.cancel(signal.reason); + } else { + signal.addEventListener("abort", () => void this.cancel(signal.reason), { capture: true }); + } + return this; + } + /** + * Attaches callbacks for the resolution and/or rejection of the `CancellablePromise`. + * + * The optional `oncancelled` argument will be invoked when the returned promise is cancelled, + * with the same semantics as the `oncancelled` argument of the constructor. + * When the parent promise rejects or is cancelled, the `onrejected` callback will run, + * _even after the returned promise has been cancelled:_ + * in that case, should it reject or throw, the reason will be wrapped + * in a {@link CancelledRejectionError} and bubbled up as an unhandled rejection. + * + * @param onfulfilled The callback to execute when the Promise is resolved. + * @param onrejected The callback to execute when the Promise is rejected. + * @returns A `CancellablePromise` for the completion of whichever callback is executed. + * The returned promise is hooked up to propagate cancellation requests up the chain, but not down: + * + * - if the parent promise is cancelled, the `onrejected` handler will be invoked with a `CancelError` + * and the returned promise _will resolve regularly_ with its result; + * - conversely, if the returned promise is cancelled, _the parent promise is cancelled too;_ + * the `onrejected` handler will still be invoked with the parent's `CancelError`, + * but its result will be discarded + * and the returned promise will reject with a `CancelError` as well. + * + * The promise returned from {@link cancel} will fulfill only after all attached handlers + * up the entire promise chain have been run. + * + * If either callback returns a cancellable promise, + * cancellation requests will be diverted to it, + * and the specified `oncancelled` callback will be discarded. + */ + then(onfulfilled, onrejected, oncancelled) { + if (!(this instanceof CancellablePromise)) { + throw new TypeError("CancellablePromise.prototype.then called on an invalid object."); + } + if (!isCallable(onfulfilled)) { + onfulfilled = identity; + } + if (!isCallable(onrejected)) { + onrejected = thrower; + } + if (onfulfilled === identity && onrejected == thrower) { + return new CancellablePromise((resolve) => resolve(this)); + } + const barrier = {}; + this[barrierSym] = barrier; + return new CancellablePromise((resolve, reject) => { + void super.then((value) => { + var _a2; + if (this[barrierSym] === barrier) { + this[barrierSym] = null; + } + (_a2 = barrier.resolve) === null || _a2 === void 0 ? void 0 : _a2.call(barrier); + try { + resolve(onfulfilled(value)); + } catch (err) { + reject(err); + } + }, (reason) => { + var _a2; + if (this[barrierSym] === barrier) { + this[barrierSym] = null; + } + (_a2 = barrier.resolve) === null || _a2 === void 0 ? void 0 : _a2.call(barrier); + try { + resolve(onrejected(reason)); + } catch (err) { + reject(err); + } + }); + }, async (cause) => { + try { + return oncancelled === null || oncancelled === void 0 ? void 0 : oncancelled(cause); + } finally { + await this.cancel(cause); + } + }); + } + /** + * Attaches a callback for only the rejection of the Promise. + * + * The optional `oncancelled` argument will be invoked when the returned promise is cancelled, + * with the same semantics as the `oncancelled` argument of the constructor. + * When the parent promise rejects or is cancelled, the `onrejected` callback will run, + * _even after the returned promise has been cancelled:_ + * in that case, should it reject or throw, the reason will be wrapped + * in a {@link CancelledRejectionError} and bubbled up as an unhandled rejection. + * + * It is equivalent to + * ```ts + * cancellablePromise.then(undefined, onrejected, oncancelled); + * ``` + * and the same caveats apply. + * + * @returns A Promise for the completion of the callback. + * Cancellation requests on the returned promise + * will propagate up the chain to the parent promise, + * but not in the other direction. + * + * The promise returned from {@link cancel} will fulfill only after all attached handlers + * up the entire promise chain have been run. + * + * If `onrejected` returns a cancellable promise, + * cancellation requests will be diverted to it, + * and the specified `oncancelled` callback will be discarded. + * See {@link then} for more details. + */ + catch(onrejected, oncancelled) { + return this.then(void 0, onrejected, oncancelled); + } + /** + * Attaches a callback that is invoked when the CancellablePromise is settled (fulfilled or rejected). The + * resolved value cannot be accessed or modified from the callback. + * The returned promise will settle in the same state as the original one + * after the provided callback has completed execution, + * unless the callback throws or returns a rejecting promise, + * in which case the returned promise will reject as well. + * + * The optional `oncancelled` argument will be invoked when the returned promise is cancelled, + * with the same semantics as the `oncancelled` argument of the constructor. + * Once the parent promise settles, the `onfinally` callback will run, + * _even after the returned promise has been cancelled:_ + * in that case, should it reject or throw, the reason will be wrapped + * in a {@link CancelledRejectionError} and bubbled up as an unhandled rejection. + * + * This method is implemented in terms of {@link then} and the same caveats apply. + * It is polyfilled, hence available in every OS/webview version. + * + * @returns A Promise for the completion of the callback. + * Cancellation requests on the returned promise + * will propagate up the chain to the parent promise, + * but not in the other direction. + * + * The promise returned from {@link cancel} will fulfill only after all attached handlers + * up the entire promise chain have been run. + * + * If `onfinally` returns a cancellable promise, + * cancellation requests will be diverted to it, + * and the specified `oncancelled` callback will be discarded. + * See {@link then} for more details. + */ + finally(onfinally, oncancelled) { + if (!(this instanceof CancellablePromise)) { + throw new TypeError("CancellablePromise.prototype.finally called on an invalid object."); + } + if (!isCallable(onfinally)) { + return this.then(onfinally, onfinally, oncancelled); + } + return this.then((value) => CancellablePromise.resolve(onfinally()).then(() => value), (reason) => CancellablePromise.resolve(onfinally()).then(() => { + throw reason; + }), oncancelled); + } + /** + * We use the `[Symbol.species]` static property, if available, + * to disable the built-in automatic subclassing features from {@link Promise}. + * It is critical for performance reasons that extenders do not override this. + * Once the proposal at https://github.com/tc39/proposal-rm-builtin-subclassing + * is either accepted or retired, this implementation will have to be revised accordingly. + * + * @ignore + * @internal + */ + static get [species]() { + return Promise; + } + static all(values) { + let collected = Array.from(values); + const promise = collected.length === 0 ? CancellablePromise.resolve(collected) : new CancellablePromise((resolve, reject) => { + void Promise.all(collected).then(resolve, reject); + }, (cause) => cancelAll(promise, collected, cause)); + return promise; + } + static allSettled(values) { + let collected = Array.from(values); + const promise = collected.length === 0 ? CancellablePromise.resolve(collected) : new CancellablePromise((resolve, reject) => { + void Promise.allSettled(collected).then(resolve, reject); + }, (cause) => cancelAll(promise, collected, cause)); + return promise; + } + static any(values) { + let collected = Array.from(values); + const promise = collected.length === 0 ? CancellablePromise.resolve(collected) : new CancellablePromise((resolve, reject) => { + void Promise.any(collected).then(resolve, reject); + }, (cause) => cancelAll(promise, collected, cause)); + return promise; + } + static race(values) { + let collected = Array.from(values); + const promise = new CancellablePromise((resolve, reject) => { + void Promise.race(collected).then(resolve, reject); + }, (cause) => cancelAll(promise, collected, cause)); + return promise; + } + /** + * Creates a new cancelled CancellablePromise for the provided cause. + * + * @group Static Methods + */ + static cancel(cause) { + const p = new CancellablePromise(() => { + }); + p.cancel(cause); + return p; + } + /** + * Creates a new CancellablePromise that cancels + * after the specified timeout, with the provided cause. + * + * If the {@link AbortSignal.timeout} factory method is available, + * it is used to base the timeout on _active_ time rather than _elapsed_ time. + * Otherwise, `timeout` falls back to {@link setTimeout}. + * + * @group Static Methods + */ + static timeout(milliseconds, cause) { + const promise = new CancellablePromise(() => { + }); + if (AbortSignal && typeof AbortSignal === "function" && AbortSignal.timeout && typeof AbortSignal.timeout === "function") { + AbortSignal.timeout(milliseconds).addEventListener("abort", () => void promise.cancel(cause)); + } else { + setTimeout(() => void promise.cancel(cause), milliseconds); + } + return promise; + } + static sleep(milliseconds, value) { + return new CancellablePromise((resolve) => { + setTimeout(() => resolve(value), milliseconds); + }); + } + /** + * Creates a new rejected CancellablePromise for the provided reason. + * + * @group Static Methods + */ + static reject(reason) { + return new CancellablePromise((_, reject) => reject(reason)); + } + static resolve(value) { + if (value instanceof CancellablePromise) { + return value; + } + return new CancellablePromise((resolve) => resolve(value)); + } + /** + * Creates a new CancellablePromise and returns it in an object, along with its resolve and reject functions + * and a getter/setter for the cancellation callback. + * + * This method is polyfilled, hence available in every OS/webview version. + * + * @group Static Methods + */ + static withResolvers() { + let result = { oncancelled: null }; + result.promise = new CancellablePromise((resolve, reject) => { + result.resolve = resolve; + result.reject = reject; + }, (cause) => { + var _a2; + (_a2 = result.oncancelled) === null || _a2 === void 0 ? void 0 : _a2.call(result, cause); + }); + return result; + } +} +function cancellerFor(promise, state) { + let cancellationPromise = void 0; + return (reason) => { + if (!state.settled) { + state.settled = true; + state.reason = reason; + promise.reject(reason); + void Promise.prototype.then.call(promise.promise, void 0, (err) => { + if (err !== reason) { + throw err; + } + }); + } + if (!state.reason || !promise.oncancelled) { + return; + } + cancellationPromise = new Promise((resolve) => { + try { + resolve(promise.oncancelled(state.reason.cause)); + } catch (err) { + Promise.reject(new CancelledRejectionError(promise.promise, err, "Unhandled exception in oncancelled callback.")); + } + }).catch((reason2) => { + Promise.reject(new CancelledRejectionError(promise.promise, reason2, "Unhandled rejection in oncancelled callback.")); + }); + promise.oncancelled = null; + return cancellationPromise; + }; +} +function resolverFor(promise, state) { + return (value) => { + if (state.resolving) { + return; + } + state.resolving = true; + if (value === promise.promise) { + if (state.settled) { + return; + } + state.settled = true; + promise.reject(new TypeError("A promise cannot be resolved with itself.")); + return; + } + if (value != null && (typeof value === "object" || typeof value === "function")) { + let then; + try { + then = value.then; + } catch (err) { + state.settled = true; + promise.reject(err); + return; + } + if (isCallable(then)) { + try { + let cancel = value.cancel; + if (isCallable(cancel)) { + const oncancelled = (cause) => { + Reflect.apply(cancel, value, [cause]); + }; + if (state.reason) { + void cancellerFor(Object.assign(Object.assign({}, promise), { oncancelled }), state)(state.reason); + } else { + promise.oncancelled = oncancelled; + } + } + } catch (_a2) { + } + const newState = { + root: state.root, + resolving: false, + get settled() { + return this.root.settled; + }, + set settled(value2) { + this.root.settled = value2; + }, + get reason() { + return this.root.reason; + } + }; + const rejector = rejectorFor(promise, newState); + try { + Reflect.apply(then, value, [resolverFor(promise, newState), rejector]); + } catch (err) { + rejector(err); + } + return; + } + } + if (state.settled) { + return; + } + state.settled = true; + promise.resolve(value); + }; +} +function rejectorFor(promise, state) { + return (reason) => { + if (state.resolving) { + return; + } + state.resolving = true; + if (state.settled) { + try { + if (reason instanceof CancelError && state.reason instanceof CancelError && Object.is(reason.cause, state.reason.cause)) { + return; + } + } catch (_a2) { + } + void Promise.reject(new CancelledRejectionError(promise.promise, reason)); + } else { + state.settled = true; + promise.reject(reason); + } + }; +} +function cancelAll(parent, values, cause) { + const results = []; + for (const value of values) { + let cancel; + try { + if (!isCallable(value.then)) { + continue; + } + cancel = value.cancel; + if (!isCallable(cancel)) { + continue; + } + } catch (_a2) { + continue; + } + let result; + try { + result = Reflect.apply(cancel, value, [cause]); + } catch (err) { + Promise.reject(new CancelledRejectionError(parent, err, "Unhandled exception in cancel method.")); + continue; + } + if (!result) { + continue; + } + results.push((result instanceof Promise ? result : Promise.resolve(result)).catch((reason) => { + Promise.reject(new CancelledRejectionError(parent, reason, "Unhandled rejection in cancel method.")); + })); + } + return Promise.all(results); +} +function identity(x) { + return x; +} +function thrower(reason) { + throw reason; +} +function errorMessage(err) { + try { + if (err instanceof Error || typeof err !== "object" || err.toString !== Object.prototype.toString) { + return "" + err; + } + } catch (_a2) { + } + try { + return JSON.stringify(err); + } catch (_b) { + } + try { + return Object.prototype.toString.call(err); + } catch (_c) { + } + return ""; +} +function currentBarrier(promise) { + var _a2; + let pwr = (_a2 = promise[barrierSym]) !== null && _a2 !== void 0 ? _a2 : {}; + if (!("promise" in pwr)) { + Object.assign(pwr, promiseWithResolvers()); + } + if (promise[barrierSym] == null) { + pwr.resolve(); + promise[barrierSym] = pwr; + } + return pwr.promise; +} +let promiseWithResolvers = Promise.withResolvers; +if (promiseWithResolvers && typeof promiseWithResolvers === "function") { + promiseWithResolvers = promiseWithResolvers.bind(Promise); +} else { + promiseWithResolvers = function() { + let resolve; + let reject; + const promise = new Promise((res, rej) => { + resolve = res; + reject = rej; + }); + return { promise, resolve, reject }; + }; +} +window._wails = window._wails || {}; +window._wails.callResultHandler = resultHandler; +window._wails.callErrorHandler = errorHandler; +const call$1 = newRuntimeCaller(objectNames.Call); +const cancelCall = newRuntimeCaller(objectNames.CancelCall); +const callResponses = /* @__PURE__ */ new Map(); +const CallBinding = 0; +const CancelMethod = 0; +class RuntimeError extends Error { + /** + * Constructs a new RuntimeError instance. + * @param message - The error message. + * @param options - Options to be forwarded to the Error constructor. + */ + constructor(message, options) { + super(message, options); + this.name = "RuntimeError"; + } +} +function resultHandler(id, data, isJSON) { + const resolvers = getAndDeleteResponse(id); + if (!resolvers) { + return; + } + if (!data) { + resolvers.resolve(void 0); + } else if (!isJSON) { + resolvers.resolve(data); + } else { + try { + resolvers.resolve(JSON.parse(data)); + } catch (err) { + resolvers.reject(new TypeError("could not parse result: " + err.message, { cause: err })); + } + } +} +function errorHandler(id, data, isJSON) { + const resolvers = getAndDeleteResponse(id); + if (!resolvers) { + return; + } + if (!isJSON) { + resolvers.reject(new Error(data)); + } else { + let error; + try { + error = JSON.parse(data); + } catch (err) { + resolvers.reject(new TypeError("could not parse error: " + err.message, { cause: err })); + return; + } + let options = {}; + if (error.cause) { + options.cause = error.cause; + } + let exception; + switch (error.kind) { + case "ReferenceError": + exception = new ReferenceError(error.message, options); + break; + case "TypeError": + exception = new TypeError(error.message, options); + break; + case "RuntimeError": + exception = new RuntimeError(error.message, options); + break; + default: + exception = new Error(error.message, options); + break; + } + resolvers.reject(exception); + } +} +function getAndDeleteResponse(id) { + const response = callResponses.get(id); + callResponses.delete(id); + return response; +} +function generateID() { + let result; + do { + result = nanoid(); + } while (callResponses.has(result)); + return result; +} +function Call(options) { + const id = generateID(); + const result = CancellablePromise.withResolvers(); + callResponses.set(id, { resolve: result.resolve, reject: result.reject }); + const request = call$1(CallBinding, Object.assign({ "call-id": id }, options)); + let running = false; + request.then(() => { + running = true; + }, (err) => { + callResponses.delete(id); + result.reject(err); + }); + const cancel = () => { + callResponses.delete(id); + return cancelCall(CancelMethod, { "call-id": id }).catch((err) => { + console.error("Error while requesting binding call cancellation:", err); + }); + }; + result.oncancelled = () => { + if (running) { + return cancel(); + } else { + return request.then(cancel); + } + }; + return result.promise; +} +function ByID(methodID, ...args) { + return Call({ methodID, args }); +} +const eventListeners = /* @__PURE__ */ new Map(); +class Listener { + constructor(eventName, callback, maxCallbacks) { + this.eventName = eventName; + this.callback = callback; + this.maxCallbacks = maxCallbacks || -1; + } + dispatch(data) { + try { + this.callback(data); + } catch (err) { + console.error(err); + } + if (this.maxCallbacks === -1) + return false; + this.maxCallbacks -= 1; + return this.maxCallbacks === 0; + } +} +function listenerOff(listener) { + let listeners = eventListeners.get(listener.eventName); + if (!listeners) { + return; + } + listeners = listeners.filter((l) => l !== listener); + if (listeners.length === 0) { + eventListeners.delete(listener.eventName); + } else { + eventListeners.set(listener.eventName, listeners); + } +} +window._wails = window._wails || {}; +window._wails.dispatchWailsEvent = dispatchWailsEvent; +const call = newRuntimeCaller(objectNames.Events); +const EmitMethod = 0; +class WailsEvent { + constructor(name, data = null) { + this.name = name; + this.data = data; + } +} +function dispatchWailsEvent(event) { + let listeners = eventListeners.get(event.name); + if (!listeners) { + return; + } + let wailsEvent = new WailsEvent(event.name, event.data); + if ("sender" in event) { + wailsEvent.sender = event.sender; + } + listeners = listeners.filter((listener) => !listener.dispatch(wailsEvent)); + if (listeners.length === 0) { + eventListeners.delete(event.name); + } else { + eventListeners.set(event.name, listeners); + } +} +function OnMultiple(eventName, callback, maxCallbacks) { + let listeners = eventListeners.get(eventName) || []; + const thisListener = new Listener(eventName, callback, maxCallbacks); + listeners.push(thisListener); + eventListeners.set(eventName, listeners); + return () => listenerOff(thisListener); +} +function On(eventName, callback) { + return OnMultiple(eventName, callback, -1); +} +function Emit(event) { + return call(EmitMethod, event); +} +window._wails = window._wails || {}; +window._wails.invoke = invoke; +invoke("wails:runtime:ready"); +function RemoveBadge() { + return ByID(2752757297); +} +function SetBadge(label) { + return ByID(1717705661, label); +} +const setButton = document.getElementById("set"); +const removeButton = document.getElementById("remove"); +const setButtonUsingGo = document.getElementById("set-go"); +const removeButtonUsingGo = document.getElementById("remove-go"); +const labelElement = document.getElementById("label"); +const timeElement = document.getElementById("time"); +setButton.addEventListener("click", () => { + let label = labelElement.value; + SetBadge(label); +}); +removeButton.addEventListener("click", () => { + RemoveBadge(); +}); +setButtonUsingGo.addEventListener("click", () => { + let label = labelElement.value; + void Emit({ + name: "set:badge", + data: label + }); +}); +removeButtonUsingGo.addEventListener("click", () => { + void Emit({ name: "remove:badge", data: null }); +}); +On("time", (time) => { + timeElement.innerText = time.data; +}); diff --git a/v3/examples/badge/frontend/dist/index.html b/v3/examples/badge/frontend/dist/index.html new file mode 100644 index 000000000..b8ca49f06 --- /dev/null +++ b/v3/examples/badge/frontend/dist/index.html @@ -0,0 +1,38 @@ + + + + + + + + Wails App + + + +
      + +

      Wails + Typescript

      +
      Set a badge label below 👇
      +
      +
      + + + + + +
      +
      + +
      + + diff --git a/v3/examples/badge/frontend/dist/style.css b/v3/examples/badge/frontend/dist/style.css new file mode 100644 index 000000000..6ce81cad2 --- /dev/null +++ b/v3/examples/badge/frontend/dist/style.css @@ -0,0 +1,155 @@ +:root { + font-family: "Inter", -apple-system, BlinkMacSystemFont, "Segoe UI", "Roboto", + "Oxygen", "Ubuntu", "Cantarell", "Fira Sans", "Droid Sans", "Helvetica Neue", + sans-serif; + font-size: 16px; + line-height: 24px; + font-weight: 400; + color-scheme: light dark; + color: rgba(255, 255, 255, 0.87); + background-color: rgba(27, 38, 54, 1); + font-synthesis: none; + text-rendering: optimizeLegibility; + -webkit-font-smoothing: antialiased; + -moz-osx-font-smoothing: grayscale; + -webkit-text-size-adjust: 100%; + user-select: none; + -webkit-user-select: none; + -moz-user-select: none; + -ms-user-select: none; +} + +@font-face { + font-family: "Inter"; + font-style: normal; + font-weight: 400; + src: local(""), + url("./Inter-Medium.ttf") format("truetype"); +} + +h3 { + font-size: 3em; + line-height: 1.1; +} + +a { + font-weight: 500; + color: #646cff; + text-decoration: inherit; +} + +a:hover { + color: #535bf2; +} + +button { + line-height: 30px; + border-radius: 3px; + border: none; + margin: 0 0 0 20px; + padding: 0 8px; + cursor: pointer; +} + +.result { + height: 20px; + line-height: 20px; +} + +body { + margin: 0; + display: flex; + place-items: center; + place-content: center; + min-width: 320px; + min-height: 100vh; +} + +.container { + display: flex; + flex-direction: column; + align-items: center; + justify-content: center; +} + +h1 { + font-size: 3.2em; + line-height: 1.1; +} + +#app { + max-width: 1280px; + margin: 0 auto; + padding: 2rem; + text-align: center; +} + +.logo { + height: 6em; + padding: 1.5em; + will-change: filter; +} + +.logo:hover { + filter: drop-shadow(0 0 2em #e80000aa); +} + +.logo.vanilla:hover { + filter: drop-shadow(0 0 2em #f7df1eaa); +} + +.result { + height: 20px; + line-height: 20px; + margin: 1.5rem auto; + text-align: center; +} + +.footer { + margin-top: 1rem; + align-content: center; + text-align: center; +} + +@media (prefers-color-scheme: light) { + :root { + color: #213547; + background-color: #ffffff; + } + + a:hover { + color: #747bff; + } + + button { + background-color: #f9f9f9; + } +} + + +.input-box .btn:hover { + background-image: linear-gradient(to top, #cfd9df 0%, #e2ebf0 100%); + color: #333333; +} + +.input-box .input { + border: none; + border-radius: 3px; + outline: none; + height: 30px; + line-height: 30px; + padding: 0 10px; + color: black; + background-color: rgba(240, 240, 240, 1); + -webkit-font-smoothing: antialiased; +} + +.input-box .input:hover { + border: none; + background-color: rgba(255, 255, 255, 1); +} + +.input-box .input:focus { + border: none; + background-color: rgba(255, 255, 255, 1); +} \ No newline at end of file diff --git a/v3/examples/badge/frontend/dist/typescript.svg b/v3/examples/badge/frontend/dist/typescript.svg new file mode 100644 index 000000000..d91c910cc --- /dev/null +++ b/v3/examples/badge/frontend/dist/typescript.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/v3/examples/badge/frontend/dist/wails.png b/v3/examples/badge/frontend/dist/wails.png new file mode 100644 index 000000000..8bdf42483 Binary files /dev/null and b/v3/examples/badge/frontend/dist/wails.png differ diff --git a/v3/examples/badge/frontend/index.html b/v3/examples/badge/frontend/index.html new file mode 100644 index 000000000..616cb4c0f --- /dev/null +++ b/v3/examples/badge/frontend/index.html @@ -0,0 +1,38 @@ + + + + + + + + Wails App + + +
      + +

      Wails + Typescript

      +
      Set a badge label below 👇
      +
      +
      + + + + + +
      +
      + +
      + + + diff --git a/v3/examples/badge/frontend/package.json b/v3/examples/badge/frontend/package.json new file mode 100644 index 000000000..b39da7ece --- /dev/null +++ b/v3/examples/badge/frontend/package.json @@ -0,0 +1,19 @@ +{ + "name": "frontend", + "private": true, + "version": "0.0.0", + "type": "module", + "scripts": { + "dev": "vite", + "build:dev": "tsc && vite build --minify false --mode development", + "build": "tsc && vite build --mode production", + "preview": "vite preview" + }, + "dependencies": { + "@wailsio/runtime": "latest" + }, + "devDependencies": { + "typescript": "^4.9.3", + "vite": "^5.0.0" + } +} diff --git a/v3/examples/badge/frontend/public/Inter-Medium.ttf b/v3/examples/badge/frontend/public/Inter-Medium.ttf new file mode 100644 index 000000000..a01f3777a Binary files /dev/null and b/v3/examples/badge/frontend/public/Inter-Medium.ttf differ diff --git a/v3/examples/badge/frontend/public/style.css b/v3/examples/badge/frontend/public/style.css new file mode 100644 index 000000000..6ce81cad2 --- /dev/null +++ b/v3/examples/badge/frontend/public/style.css @@ -0,0 +1,155 @@ +:root { + font-family: "Inter", -apple-system, BlinkMacSystemFont, "Segoe UI", "Roboto", + "Oxygen", "Ubuntu", "Cantarell", "Fira Sans", "Droid Sans", "Helvetica Neue", + sans-serif; + font-size: 16px; + line-height: 24px; + font-weight: 400; + color-scheme: light dark; + color: rgba(255, 255, 255, 0.87); + background-color: rgba(27, 38, 54, 1); + font-synthesis: none; + text-rendering: optimizeLegibility; + -webkit-font-smoothing: antialiased; + -moz-osx-font-smoothing: grayscale; + -webkit-text-size-adjust: 100%; + user-select: none; + -webkit-user-select: none; + -moz-user-select: none; + -ms-user-select: none; +} + +@font-face { + font-family: "Inter"; + font-style: normal; + font-weight: 400; + src: local(""), + url("./Inter-Medium.ttf") format("truetype"); +} + +h3 { + font-size: 3em; + line-height: 1.1; +} + +a { + font-weight: 500; + color: #646cff; + text-decoration: inherit; +} + +a:hover { + color: #535bf2; +} + +button { + line-height: 30px; + border-radius: 3px; + border: none; + margin: 0 0 0 20px; + padding: 0 8px; + cursor: pointer; +} + +.result { + height: 20px; + line-height: 20px; +} + +body { + margin: 0; + display: flex; + place-items: center; + place-content: center; + min-width: 320px; + min-height: 100vh; +} + +.container { + display: flex; + flex-direction: column; + align-items: center; + justify-content: center; +} + +h1 { + font-size: 3.2em; + line-height: 1.1; +} + +#app { + max-width: 1280px; + margin: 0 auto; + padding: 2rem; + text-align: center; +} + +.logo { + height: 6em; + padding: 1.5em; + will-change: filter; +} + +.logo:hover { + filter: drop-shadow(0 0 2em #e80000aa); +} + +.logo.vanilla:hover { + filter: drop-shadow(0 0 2em #f7df1eaa); +} + +.result { + height: 20px; + line-height: 20px; + margin: 1.5rem auto; + text-align: center; +} + +.footer { + margin-top: 1rem; + align-content: center; + text-align: center; +} + +@media (prefers-color-scheme: light) { + :root { + color: #213547; + background-color: #ffffff; + } + + a:hover { + color: #747bff; + } + + button { + background-color: #f9f9f9; + } +} + + +.input-box .btn:hover { + background-image: linear-gradient(to top, #cfd9df 0%, #e2ebf0 100%); + color: #333333; +} + +.input-box .input { + border: none; + border-radius: 3px; + outline: none; + height: 30px; + line-height: 30px; + padding: 0 10px; + color: black; + background-color: rgba(240, 240, 240, 1); + -webkit-font-smoothing: antialiased; +} + +.input-box .input:hover { + border: none; + background-color: rgba(255, 255, 255, 1); +} + +.input-box .input:focus { + border: none; + background-color: rgba(255, 255, 255, 1); +} \ No newline at end of file diff --git a/v3/examples/badge/frontend/public/typescript.svg b/v3/examples/badge/frontend/public/typescript.svg new file mode 100644 index 000000000..d91c910cc --- /dev/null +++ b/v3/examples/badge/frontend/public/typescript.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/v3/examples/badge/frontend/public/wails.png b/v3/examples/badge/frontend/public/wails.png new file mode 100644 index 000000000..8bdf42483 Binary files /dev/null and b/v3/examples/badge/frontend/public/wails.png differ diff --git a/v3/examples/badge/frontend/src/main.ts b/v3/examples/badge/frontend/src/main.ts new file mode 100644 index 000000000..222564848 --- /dev/null +++ b/v3/examples/badge/frontend/src/main.ts @@ -0,0 +1,32 @@ +import {Events} from "@wailsio/runtime"; +import {SetBadge, RemoveBadge} from "../bindings/github.com/wailsapp/wails/v3/pkg/services/dock/dockservice"; + +const setButton = document.getElementById('set')! as HTMLButtonElement; +const removeButton = document.getElementById('remove')! as HTMLButtonElement; +const setButtonUsingGo = document.getElementById('set-go')! as HTMLButtonElement; +const removeButtonUsingGo = document.getElementById('remove-go')! as HTMLButtonElement; +const labelElement : HTMLInputElement = document.getElementById('label')! as HTMLInputElement; +const timeElement = document.getElementById('time')! as HTMLDivElement; + +setButton.addEventListener('click', () => { + let label = (labelElement as HTMLInputElement).value + SetBadge(label); +}); + +removeButton.addEventListener('click', () => { + RemoveBadge(); +}); + +setButtonUsingGo.addEventListener('click', () => { + let label = (labelElement as HTMLInputElement).value + void Events.Emit("set:badge", label) +}) + +removeButtonUsingGo.addEventListener('click', () => { + void Events.Emit("remove:badge") +}) + +Events.On('time', (time: {data: any}) => { + timeElement.innerText = time.data; +}); + diff --git a/v3/examples/badge/frontend/src/vite-env.d.ts b/v3/examples/badge/frontend/src/vite-env.d.ts new file mode 100644 index 000000000..11f02fe2a --- /dev/null +++ b/v3/examples/badge/frontend/src/vite-env.d.ts @@ -0,0 +1 @@ +/// diff --git a/v3/examples/badge/frontend/tsconfig.json b/v3/examples/badge/frontend/tsconfig.json new file mode 100644 index 000000000..c267ecf24 --- /dev/null +++ b/v3/examples/badge/frontend/tsconfig.json @@ -0,0 +1,20 @@ +{ + "compilerOptions": { + "target": "ESNext", + "useDefineForClassFields": true, + "module": "ESNext", + "lib": ["ESNext", "DOM"], + "moduleResolution": "Node", + "strict": true, + "resolveJsonModule": true, + "isolatedModules": true, + "esModuleInterop": true, + "noEmit": true, + "noUnusedLocals": true, + "noUnusedParameters": false, + "noImplicitAny": false, + "noImplicitReturns": true, + "skipLibCheck": true + }, + "include": ["src"] +} diff --git a/v3/examples/badge/main.go b/v3/examples/badge/main.go new file mode 100644 index 000000000..f97f3924e --- /dev/null +++ b/v3/examples/badge/main.go @@ -0,0 +1,109 @@ +package main + +import ( + "embed" + _ "embed" + "log" + "time" + + "github.com/wailsapp/wails/v3/pkg/application" + "github.com/wailsapp/wails/v3/pkg/services/dock" +) + +// Wails uses Go's `embed` package to embed the frontend files into the binary. +// Any files in the frontend/dist folder will be embedded into the binary and +// made available to the frontend. +// See https://pkg.go.dev/embed for more information. + +//go:embed all:frontend/dist +var assets embed.FS + +// main function serves as the application's entry point. It initializes the application, creates a window, +// and starts a goroutine that emits a time-based event every second. It subsequently runs the application and +// logs any error that might occur. +func main() { + // Create a new Wails application by providing the necessary options. + // Variables 'Name' and 'Description' are for application metadata. + // 'Assets' configures the asset server with the 'FS' variable pointing to the frontend files. + // 'Bind' is a list of Go struct instances. The frontend has access to the methods of these instances. + // 'Mac' options tailor the application when running an macOS. + + dockService := dock.New() + + app := application.New(application.Options{ + Name: "badge", + Description: "A demo of using raw HTML & CSS", + Services: []application.Service{ + application.NewService(dockService), + }, + Assets: application.AssetOptions{ + Handler: application.AssetFileServerFS(assets), + }, + Mac: application.MacOptions{ + ApplicationShouldTerminateAfterLastWindowClosed: true, + }, + }) + + // Create a new window with the necessary options. + // 'Title' is the title of the window. + // 'Mac' options tailor the window when running on macOS. + // 'BackgroundColour' is the background colour of the window. + // 'URL' is the URL that will be loaded into the webview. + app.Window.NewWithOptions(application.WebviewWindowOptions{ + Title: "Window 1", + Mac: application.MacWindow{ + InvisibleTitleBarHeight: 50, + Backdrop: application.MacBackdropTranslucent, + TitleBar: application.MacTitleBarHiddenInset, + }, + BackgroundColour: application.NewRGB(27, 38, 54), + URL: "/", + }) + + // Store cleanup functions for proper resource management + removeBadgeHandler := app.Event.On("remove:badge", func(event *application.CustomEvent) { + err := dockService.RemoveBadge() + if err != nil { + log.Fatal(err) + } + }) + + setBadgeHandler := app.Event.On("set:badge", func(event *application.CustomEvent) { + text := event.Data.(string) + err := dockService.SetBadge(text) + if err != nil { + log.Fatal(err) + } + }) + + // Note: In a production application, you would call these cleanup functions + // when the handlers are no longer needed, e.g., during shutdown: + // defer removeBadgeHandler() + // defer setBadgeHandler() + _ = removeBadgeHandler // Acknowledge we're storing the cleanup functions + _ = setBadgeHandler + + // Create a goroutine that emits an event containing the current time every second. + // The frontend can listen to this event and update the UI accordingly. + go func() { + ticker := time.NewTicker(time.Second) + defer ticker.Stop() + for { + select { + case <-ticker.C: + now := time.Now().Format(time.RFC1123) + app.Event.Emit("time", now) + case <-app.Context().Done(): + return + } + } + }() + + // Run the application. This blocks until the application has been exited. + err := app.Run() + + // If an error occurred while running the application, log it and exit. + if err != nil { + log.Fatal(err) + } +} diff --git a/v3/examples/binding/GreetService.go b/v3/examples/binding/GreetService.go new file mode 100644 index 000000000..262fea722 --- /dev/null +++ b/v3/examples/binding/GreetService.go @@ -0,0 +1,39 @@ +package main + +import ( + "strconv" + + "github.com/wailsapp/wails/v3/examples/binding/data" +) + +// GreetService is a service that greets people +type GreetService struct { +} + +// Greet greets a person +func (*GreetService) Greet(name string, counts ...int) string { + times := " " + + for index, count := range counts { + if index > 0 { + times += ", " + } + times += strconv.Itoa(count) + } + + if len(counts) > 0 { + times += " times " + } + + return "Hello" + times + name +} + +// GreetPerson greets a person +func (srv *GreetService) GreetPerson(person data.Person) string { + return srv.Greet(person.Name, person.Counts...) +} + +// GetPerson returns a person with the given name. +func (srv *GreetService) GetPerson(name string) data.Person { + return data.Person{Name: name} +} diff --git a/v3/examples/binding/README.md b/v3/examples/binding/README.md new file mode 100644 index 000000000..37d0f2cc8 --- /dev/null +++ b/v3/examples/binding/README.md @@ -0,0 +1,11 @@ +# Bindings Example + +This example demonstrates how to generate bindings for your application. + +To generate bindings, run `wails3 generate bindings -clean -b -d assets/bindings` in this directory. + +See more options by running `wails3 generate bindings --help`. + +## Notes + - The bindings generator is still a work in progress and is subject to change. + - The generated code uses `wails.CallByID` by default. This is the most robust way to call a function. diff --git a/v3/examples/binding/assets/bindings/github.com/wailsapp/wails/v3/examples/binding/data/index.js b/v3/examples/binding/assets/bindings/github.com/wailsapp/wails/v3/examples/binding/data/index.js new file mode 100644 index 000000000..4c7e0b9c6 --- /dev/null +++ b/v3/examples/binding/assets/bindings/github.com/wailsapp/wails/v3/examples/binding/data/index.js @@ -0,0 +1,7 @@ +// @ts-check +// Cynhyrchwyd y ffeil hon yn awtomatig. PEIDIWCH Â MODIWL +// This file is automatically generated. DO NOT EDIT + +export { + Person +} from "./models.js"; diff --git a/v3/examples/binding/assets/bindings/github.com/wailsapp/wails/v3/examples/binding/data/models.js b/v3/examples/binding/assets/bindings/github.com/wailsapp/wails/v3/examples/binding/data/models.js new file mode 100644 index 000000000..19a39472c --- /dev/null +++ b/v3/examples/binding/assets/bindings/github.com/wailsapp/wails/v3/examples/binding/data/models.js @@ -0,0 +1,55 @@ +// @ts-check +// Cynhyrchwyd y ffeil hon yn awtomatig. PEIDIWCH Â MODIWL +// This file is automatically generated. DO NOT EDIT + +// eslint-disable-next-line @typescript-eslint/ban-ts-comment +// @ts-ignore: Unused imports +import {Create as $Create} from "/wails/runtime.js"; + +/** + * Person holds someone's most important attributes + */ +export class Person { + /** + * Creates a new Person instance. + * @param {Partial} [$$source = {}] - The source object to create the Person. + */ + constructor($$source = {}) { + if (!("name" in $$source)) { + /** + * Name is the person's name + * @member + * @type {string} + */ + this["name"] = ""; + } + if (!("counts" in $$source)) { + /** + * Counts tracks the number of time the person + * has been greeted in various ways + * @member + * @type {number[]} + */ + this["counts"] = []; + } + + Object.assign(this, $$source); + } + + /** + * Creates a new Person instance from a string or object. + * @param {any} [$$source = {}] + * @returns {Person} + */ + static createFrom($$source = {}) { + const $$createField1_0 = $$createType0; + let $$parsedSource = typeof $$source === 'string' ? JSON.parse($$source) : $$source; + if ("counts" in $$parsedSource) { + $$parsedSource["counts"] = $$createField1_0($$parsedSource["counts"]); + } + return new Person(/** @type {Partial} */($$parsedSource)); + } +} + +// Private type creation functions +const $$createType0 = $Create.Array($Create.Any); diff --git a/v3/examples/binding/assets/bindings/github.com/wailsapp/wails/v3/examples/binding/greetservice.js b/v3/examples/binding/assets/bindings/github.com/wailsapp/wails/v3/examples/binding/greetservice.js new file mode 100644 index 000000000..0e5e40d84 --- /dev/null +++ b/v3/examples/binding/assets/bindings/github.com/wailsapp/wails/v3/examples/binding/greetservice.js @@ -0,0 +1,49 @@ +// @ts-check +// Cynhyrchwyd y ffeil hon yn awtomatig. PEIDIWCH Â MODIWL +// This file is automatically generated. DO NOT EDIT + +/** + * GreetService is a service that greets people + * @module + */ + +// eslint-disable-next-line @typescript-eslint/ban-ts-comment +// @ts-ignore: Unused imports +import {Call as $Call, CancellablePromise as $CancellablePromise, Create as $Create} from "/wails/runtime.js"; + +// eslint-disable-next-line @typescript-eslint/ban-ts-comment +// @ts-ignore: Unused imports +import * as data$0 from "./data/models.js"; + +/** + * GetPerson returns a person with the given name. + * @param {string} name + * @returns {$CancellablePromise} + */ +export function GetPerson(name) { + return $Call.ByID(2952413357, name).then(/** @type {($result: any) => any} */(($result) => { + return $$createType0($result); + })); +} + +/** + * Greet greets a person + * @param {string} name + * @param {number[]} counts + * @returns {$CancellablePromise} + */ +export function Greet(name, ...counts) { + return $Call.ByID(1411160069, name, counts); +} + +/** + * GreetPerson greets a person + * @param {data$0.Person} person + * @returns {$CancellablePromise} + */ +export function GreetPerson(person) { + return $Call.ByID(4021313248, person); +} + +// Private type creation functions +const $$createType0 = data$0.Person.createFrom; diff --git a/v3/examples/binding/assets/bindings/github.com/wailsapp/wails/v3/examples/binding/index.js b/v3/examples/binding/assets/bindings/github.com/wailsapp/wails/v3/examples/binding/index.js new file mode 100644 index 000000000..fdf1ff435 --- /dev/null +++ b/v3/examples/binding/assets/bindings/github.com/wailsapp/wails/v3/examples/binding/index.js @@ -0,0 +1,8 @@ +// @ts-check +// Cynhyrchwyd y ffeil hon yn awtomatig. PEIDIWCH Â MODIWL +// This file is automatically generated. DO NOT EDIT + +import * as GreetService from "./greetservice.js"; +export { + GreetService +}; diff --git a/v3/examples/binding/assets/index.html b/v3/examples/binding/assets/index.html new file mode 100644 index 000000000..c86c7b7af --- /dev/null +++ b/v3/examples/binding/assets/index.html @@ -0,0 +1,130 @@ + + + + + Wails Alpha + + + + +
      Alpha
      +
      +

      Documentation

      +

      Feedback

      +
      +
      Please enter your name below 👇
      +
      + + + +
      + + + diff --git a/v3/examples/binding/data/person.go b/v3/examples/binding/data/person.go new file mode 100644 index 000000000..114dfdf4c --- /dev/null +++ b/v3/examples/binding/data/person.go @@ -0,0 +1,11 @@ +package data + +// Person holds someone's most important attributes +type Person struct { + // Name is the person's name + Name string `json:"name"` + + // Counts tracks the number of time the person + // has been greeted in various ways + Counts []int `json:"counts"` +} diff --git a/v3/examples/binding/main.go b/v3/examples/binding/main.go new file mode 100644 index 000000000..6e956bac1 --- /dev/null +++ b/v3/examples/binding/main.go @@ -0,0 +1,37 @@ +package main + +import ( + "embed" + "log" + + "github.com/wailsapp/wails/v3/pkg/application" +) + +//go:embed assets/* +var assets embed.FS + +func main() { + app := application.New(application.Options{ + Services: []application.Service{ + application.NewService(&GreetService{}), + }, + Assets: application.AssetOptions{ + Handler: application.BundledAssetFileServer(assets), + }, + Mac: application.MacOptions{ + ApplicationShouldTerminateAfterLastWindowClosed: true, + }, + }) + + app.Window.NewWithOptions(application.WebviewWindowOptions{ + URL: "/", + DevToolsEnabled: true, + }) + + err := app.Run() + + if err != nil { + log.Fatal(err) + } + +} diff --git a/v3/examples/build/README.md b/v3/examples/build/README.md new file mode 100644 index 000000000..3e2c246a0 --- /dev/null +++ b/v3/examples/build/README.md @@ -0,0 +1,23 @@ +# Build + +Wails has adopted [Taskfile](https://taskfile.dev) as its build tool. This is optional +and any build tool can be used. However, Taskfile is a great tool, and we recommend it. + +The Wails CLI has built-in integration with Taskfile so the standalone version is not a +requirement. + +## Building + +To build the example, run: + +```bash +wails3 task build +``` + +# Status + +| Platform | Status | +|----------|---------| +| Mac | Working | +| Windows | Working | +| Linux | | \ No newline at end of file diff --git a/v3/examples/build/Taskfile.yml b/v3/examples/build/Taskfile.yml new file mode 100644 index 000000000..f4e5e1f15 --- /dev/null +++ b/v3/examples/build/Taskfile.yml @@ -0,0 +1,110 @@ +version: '3' + +vars: + APP_NAME: "buildtest{{exeExt}}" +tasks: + + build: + summary: Builds the application + cmds: + - go build -gcflags=all="-N -l" -o bin/{{.APP_NAME}} + + package: + summary: Packages a production build of the application into a `.app` or `.exe` bundle + deps: + - task: build + cmds: + - task: package:darwin + - task: package:windows + +# ------------------------------------------------------------------------------ + + generate:icons: + summary: Generates Windows `.ico` and Mac `.icns` files from an image + dir: build + cmds: + # Generates both .ico and .icns files + - wails3 generate icons -input appicon.png + + build:production:darwin: + summary: Creates a production build of the application + cmds: + - GOOS=darwin GOARCH={{.GOARCH}} go build -tags production -ldflags="-w -s" -o build/bin/{{.APP_NAME}} + env: + CGO_CFLAGS: "-mmacosx-version-min=10.13" + CGO_LDFLAGS: "-mmacosx-version-min=10.13" + MACOSX_DEPLOYMENT_TARGET: "10.13" + GOARCH: '{{.GOARCH}}' + + build:production:linux: + summary: Creates a production build of the application + cmds: + - GOOS=linux GOARCH={{.GOARCH}} go build -tags production -ldflags="-w -s" -o build/bin/{{.APP_NAME}} + env: + GOARCH: '{{.GOARCH}}' + + generate:app_bundle: + summary: Builds a `.app` bundle + cmds: + - mkdir -p {{.APP_NAME}}.app/Contents/{MacOS,Resources} + - cp build/icons.icns {{.APP_NAME}}.app/Contents/Resources + - cp build/bin/{{.APP_NAME}} {{.APP_NAME}}.app/Contents/MacOS + - cp build/Info.plist {{.APP_NAME}}.app/Contents + + package:darwin:arm64: + summary: Packages a production build of the application into a `.app` bundle + platforms: + - darwin + deps: + - task: build:production:darwin + vars: + ARCH: arm64 + - generate:icons + cmds: + - task: generate:app_bundle + + package:darwin: + summary: Packages a production build of the application into a `.app` bundle + platforms: + - darwin + deps: + - task: build:production:darwin + - generate:icons + cmds: + - task: generate:app_bundle + + generate:syso: + dir: build + platforms: + - windows + cmds: + - wails3 generate syso -arch {{.GOARCH}} -icon icon.ico -manifest wails.exe.manifest -info info.json -out ../wails_windows.syso + vars: + GOARCH: '{{.GOARCH}}' + + package:windows: + summary: Packages a production build of the application into a `.exe` bundle + platforms: + - windows/amd64 + deps: + - generate:icons + cmds: + - task: generate:syso + vars: + GOARCH: amd64 + - go build -tags production -ldflags="-w -s -H windowsgui" -o bin/{{.APP_NAME}} + - powershell Remove-item *.syso + + + package:windows:arm64: + summary: Packages a production build of the application into a `.exe` bundle (ARM64) + platforms: + - windows + cmds: + - task: generate:syso + vars: + GOARCH: arm64 + - go build -tags production -ldflags="-w -s -H windowsgui" -o bin/buildtest.arm64.exe + - powershell Remove-item *.syso + env: + GOARCH: arm64 diff --git a/v3/examples/build/build/Info.dev.plist b/v3/examples/build/build/Info.dev.plist new file mode 100644 index 000000000..d6d28b179 --- /dev/null +++ b/v3/examples/build/build/Info.dev.plist @@ -0,0 +1,35 @@ + + + + CFBundlePackageType + APPL + CFBundleName + My App + CFBundleExecutable + app + CFBundleIdentifier + com.wails.app + CFBundleVersion + v1.0.0 + CFBundleGetInfoString + The ultimate thing + CFBundleShortVersionString + v1 + CFBundleIconFile + icons + LSMinimumSystemVersion + 10.13.0 + NSHighResolutionCapable + true + NSHumanReadableCopyright + (c) Me + NSAppTransportSecurity + + NSAllowsLocalNetworking + + + + + + + \ No newline at end of file diff --git a/v3/examples/build/build/Info.plist b/v3/examples/build/build/Info.plist new file mode 100644 index 000000000..7f03f54e9 --- /dev/null +++ b/v3/examples/build/build/Info.plist @@ -0,0 +1,27 @@ + + + + CFBundlePackageType + APPL + CFBundleName + My App + CFBundleExecutable + app + CFBundleIdentifier + com.wails.app + CFBundleVersion + v1.0.0 + CFBundleGetInfoString + The ultimate thing + CFBundleShortVersionString + v1 + CFBundleIconFile + icons + LSMinimumSystemVersion + 10.13.0 + NSHighResolutionCapable + true + NSHumanReadableCopyright + (c) Me + + \ No newline at end of file diff --git a/v3/examples/build/build/appicon.png b/v3/examples/build/build/appicon.png new file mode 100644 index 000000000..63617fe4f Binary files /dev/null and b/v3/examples/build/build/appicon.png differ diff --git a/v3/examples/build/build/icon.ico b/v3/examples/build/build/icon.ico new file mode 100644 index 000000000..bfa0690b7 Binary files /dev/null and b/v3/examples/build/build/icon.ico differ diff --git a/v3/examples/build/build/icons.icns b/v3/examples/build/build/icons.icns new file mode 100644 index 000000000..1b5bd4c86 Binary files /dev/null and b/v3/examples/build/build/icons.icns differ diff --git a/v3/examples/build/build/info.json b/v3/examples/build/build/info.json new file mode 100644 index 000000000..1005eb5cb --- /dev/null +++ b/v3/examples/build/build/info.json @@ -0,0 +1,15 @@ +{ + "fixed": { + "file_version": "v1.0.0" + }, + "info": { + "0000": { + "ProductVersion": "v1.0.0", + "CompanyName": "My Company Name", + "FileDescription": "A thing that does a thing", + "LegalCopyright": "(c) 2023 My Company Name", + "ProductName": "My Product Name", + "Comments": "This is a comment" + } + } +} \ No newline at end of file diff --git a/v3/examples/build/build/wails.exe.manifest b/v3/examples/build/build/wails.exe.manifest new file mode 100644 index 000000000..fb1ce5bde --- /dev/null +++ b/v3/examples/build/build/wails.exe.manifest @@ -0,0 +1,15 @@ + + + + + + + + + + + true/pm + permonitorv2,permonitor + + + \ No newline at end of file diff --git a/v3/examples/build/main.go b/v3/examples/build/main.go new file mode 100755 index 000000000..752ad3395 --- /dev/null +++ b/v3/examples/build/main.go @@ -0,0 +1,273 @@ +package main + +import ( + _ "embed" + "fmt" + "log" + "math/rand" + "runtime" + "strconv" + "time" + + "github.com/wailsapp/wails/v3/pkg/events" + + "github.com/wailsapp/wails/v3/pkg/application" +) + +func main() { + + app := application.New(application.Options{ + Name: "WebviewWindow Demo (debug)", + Description: "A demo of the WebviewWindow API", + Assets: application.AlphaAssets, + Mac: application.MacOptions{ + ApplicationShouldTerminateAfterLastWindowClosed: true, + }, + }) + + app.Event.OnApplicationEvent(events.Mac.ApplicationDidFinishLaunching, func(*application.ApplicationEvent) { + log.Println("ApplicationDidFinishLaunching") + }) + + currentWindow := func(fn func(window application.Window)) { + current := app.Window.Current() + if current != nil { + fn(current) + } else { + println("Current WebviewWindow is nil") + } + } + + // Create a custom menu + menu := app.NewMenu() + if runtime.GOOS == "darwin" { + menu.AddRole(application.AppMenu) + } + + windowCounter := 1 + + // Let's make a "Demo" menu + myMenu := menu.AddSubmenu("New") + + myMenu.Add("New WebviewWindow"). + SetAccelerator("CmdOrCtrl+N"). + OnClick(func(ctx *application.Context) { + app.Window.New(). + SetTitle("WebviewWindow "+strconv.Itoa(windowCounter)). + SetRelativePosition(rand.Intn(1000), rand.Intn(800)). + SetURL("https://wails.io"). + Show() + windowCounter++ + }) + myMenu.Add("New Frameless WebviewWindow"). + SetAccelerator("CmdOrCtrl+F"). + OnClick(func(ctx *application.Context) { + app.Window.NewWithOptions(application.WebviewWindowOptions{ + X: rand.Intn(1000), + Y: rand.Intn(800), + Frameless: true, + Mac: application.MacWindow{ + InvisibleTitleBarHeight: 50, + }, + }).Show() + windowCounter++ + }) + if runtime.GOOS == "darwin" { + myMenu.Add("New WebviewWindow (MacTitleBarHiddenInset)"). + OnClick(func(ctx *application.Context) { + app.Window.NewWithOptions(application.WebviewWindowOptions{ + Mac: application.MacWindow{ + TitleBar: application.MacTitleBarHiddenInset, + InvisibleTitleBarHeight: 25, + }, + }). + SetTitle("WebviewWindow "+strconv.Itoa(windowCounter)). + SetRelativePosition(rand.Intn(1000), rand.Intn(800)). + SetHTML("

      A MacTitleBarHiddenInset WebviewWindow example

      "). + Show() + windowCounter++ + }) + myMenu.Add("New WebviewWindow (MacTitleBarHiddenInsetUnified)"). + OnClick(func(ctx *application.Context) { + app.Window.NewWithOptions(application.WebviewWindowOptions{ + Mac: application.MacWindow{ + TitleBar: application.MacTitleBarHiddenInsetUnified, + InvisibleTitleBarHeight: 50, + }, + }). + SetTitle("WebviewWindow "+strconv.Itoa(windowCounter)). + SetRelativePosition(rand.Intn(1000), rand.Intn(800)). + SetHTML("

      A MacTitleBarHiddenInsetUnified WebviewWindow example

      "). + Show() + windowCounter++ + }) + myMenu.Add("New WebviewWindow (MacTitleBarHidden)"). + OnClick(func(ctx *application.Context) { + app.Window.NewWithOptions(application.WebviewWindowOptions{ + Mac: application.MacWindow{ + TitleBar: application.MacTitleBarHidden, + InvisibleTitleBarHeight: 25, + }, + }). + SetTitle("WebviewWindow "+strconv.Itoa(windowCounter)). + SetRelativePosition(rand.Intn(1000), rand.Intn(800)). + SetHTML("

      A MacTitleBarHidden WebviewWindow example

      "). + Show() + windowCounter++ + }) + } + + sizeMenu := menu.AddSubmenu("Size") + sizeMenu.Add("Set Size (800,600)").OnClick(func(ctx *application.Context) { + currentWindow(func(w application.Window) { + w.SetSize(800, 600) + }) + }) + + sizeMenu.Add("Set Size (Random)").OnClick(func(ctx *application.Context) { + currentWindow(func(w application.Window) { + w.SetSize(rand.Intn(800)+200, rand.Intn(600)+200) + }) + }) + sizeMenu.Add("Set Min Size (200,200)").OnClick(func(ctx *application.Context) { + currentWindow(func(w application.Window) { + w.SetMinSize(200, 200) + }) + }) + sizeMenu.Add("Set Max Size (600,600)").OnClick(func(ctx *application.Context) { + currentWindow(func(w application.Window) { + w.SetMaximiseButtonState(application.ButtonDisabled) + w.SetMaxSize(600, 600) + }) + }) + sizeMenu.Add("Get Current WebviewWindow Size").OnClick(func(ctx *application.Context) { + currentWindow(func(w application.Window) { + width, height := w.Size() + app.Dialog.Info().SetTitle("Current WebviewWindow Size").SetMessage("Width: " + strconv.Itoa(width) + " Height: " + strconv.Itoa(height)).Show() + }) + }) + + sizeMenu.Add("Reset Min Size").OnClick(func(ctx *application.Context) { + currentWindow(func(w application.Window) { + w.SetMinSize(0, 0) + }) + }) + + sizeMenu.Add("Reset Max Size").OnClick(func(ctx *application.Context) { + currentWindow(func(w application.Window) { + w.SetMaxSize(0, 0) + w.SetMaximiseButtonState(application.ButtonEnabled) + }) + }) + positionMenu := menu.AddSubmenu("Position") + positionMenu.Add("Set Relative Position (0,0)").OnClick(func(ctx *application.Context) { + currentWindow(func(w application.Window) { + w.SetRelativePosition(0, 0) + }) + }) + positionMenu.Add("Set Relative Position (Random)").OnClick(func(ctx *application.Context) { + currentWindow(func(w application.Window) { + w.SetRelativePosition(rand.Intn(1000), rand.Intn(800)) + }) + }) + + positionMenu.Add("Get Relative Position").OnClick(func(ctx *application.Context) { + currentWindow(func(w application.Window) { + x, y := w.RelativePosition() + app.Dialog.Info().SetTitle("Current WebviewWindow Relative Position").SetMessage("X: " + strconv.Itoa(x) + " Y: " + strconv.Itoa(y)).Show() + }) + }) + + positionMenu.Add("Center").OnClick(func(ctx *application.Context) { + currentWindow(func(w application.Window) { + w.Center() + }) + }) + stateMenu := menu.AddSubmenu("State") + stateMenu.Add("Minimise (for 2 secs)").OnClick(func(ctx *application.Context) { + currentWindow(func(w application.Window) { + w.Minimise() + time.Sleep(2 * time.Second) + w.Restore() + }) + }) + stateMenu.Add("Maximise").OnClick(func(ctx *application.Context) { + currentWindow(func(w application.Window) { + w.Maximise() + }) + }) + stateMenu.Add("Fullscreen").OnClick(func(ctx *application.Context) { + currentWindow(func(w application.Window) { + w.Fullscreen() + }) + }) + stateMenu.Add("UnFullscreen").OnClick(func(ctx *application.Context) { + currentWindow(func(w application.Window) { + w.UnFullscreen() + }) + }) + stateMenu.Add("Restore").OnClick(func(ctx *application.Context) { + currentWindow(func(w application.Window) { + w.Restore() + }) + }) + stateMenu.Add("Hide (for 2 seconds)").OnClick(func(ctx *application.Context) { + currentWindow(func(w application.Window) { + w.Hide() + time.Sleep(2 * time.Second) + w.Show() + }) + }) + stateMenu.Add("Always on Top").OnClick(func(ctx *application.Context) { + currentWindow(func(w application.Window) { + w.SetAlwaysOnTop(true) + }) + }) + stateMenu.Add("Not always on Top").OnClick(func(ctx *application.Context) { + currentWindow(func(w application.Window) { + w.SetAlwaysOnTop(false) + }) + }) + stateMenu.Add("Google.com").OnClick(func(ctx *application.Context) { + currentWindow(func(w application.Window) { + w.SetURL("https://google.com") + }) + }) + stateMenu.Add("wails.io").OnClick(func(ctx *application.Context) { + currentWindow(func(w application.Window) { + w.SetURL("https://wails.io") + }) + }) + stateMenu.Add("Get Primary Screen").OnClick(func(ctx *application.Context) { + screen := app.Screen.GetPrimary() + msg := fmt.Sprintf("Screen: %+v", screen) + app.Dialog.Info().SetTitle("Primary Screen").SetMessage(msg).Show() + }) + stateMenu.Add("Get Screens").OnClick(func(ctx *application.Context) { + screens := app.Screen.GetAll() + for _, screen := range screens { + msg := fmt.Sprintf("Screen: %+v", screen) + app.Dialog.Info().SetTitle(fmt.Sprintf("Screen %s", screen.ID)).SetMessage(msg).Show() + } + }) + stateMenu.Add("Get Screen for WebviewWindow").OnClick(func(ctx *application.Context) { + currentWindow(func(w application.Window) { + screen, err := w.GetScreen() + if err != nil { + app.Dialog.Error().SetTitle("Error").SetMessage(err.Error()).Show() + return + } + msg := fmt.Sprintf("Screen: %+v", screen) + app.Dialog.Info().SetTitle(fmt.Sprintf("Screen %s", screen.ID)).SetMessage(msg).Show() + }) + }) + app.Window.New() + + app.Menu.Set(menu) + err := app.Run() + + if err != nil { + log.Fatal(err) + } + +} diff --git a/v3/examples/cancel-async/README.md b/v3/examples/cancel-async/README.md new file mode 100644 index 000000000..feec0e5d6 --- /dev/null +++ b/v3/examples/cancel-async/README.md @@ -0,0 +1,5 @@ +# Binding Call Cancelling Example + +This example demonstrates how to cancel binding calls in async/await style. + +To regenerate bindings, run `wails3 generate bindings -clean -b -d assets/bindings` in this directory. diff --git a/v3/examples/cancel-async/assets/bindings/github.com/wailsapp/wails/v3/examples/cancel-async/index.js b/v3/examples/cancel-async/assets/bindings/github.com/wailsapp/wails/v3/examples/cancel-async/index.js new file mode 100644 index 000000000..d2bf43c94 --- /dev/null +++ b/v3/examples/cancel-async/assets/bindings/github.com/wailsapp/wails/v3/examples/cancel-async/index.js @@ -0,0 +1,8 @@ +// @ts-check +// Cynhyrchwyd y ffeil hon yn awtomatig. PEIDIWCH Â MODIWL +// This file is automatically generated. DO NOT EDIT + +import * as Service from "./service.js"; +export { + Service +}; diff --git a/v3/examples/cancel-async/assets/bindings/github.com/wailsapp/wails/v3/examples/cancel-async/service.js b/v3/examples/cancel-async/assets/bindings/github.com/wailsapp/wails/v3/examples/cancel-async/service.js new file mode 100644 index 000000000..6aae91e1d --- /dev/null +++ b/v3/examples/cancel-async/assets/bindings/github.com/wailsapp/wails/v3/examples/cancel-async/service.js @@ -0,0 +1,16 @@ +// @ts-check +// Cynhyrchwyd y ffeil hon yn awtomatig. PEIDIWCH Â MODIWL +// This file is automatically generated. DO NOT EDIT + +// eslint-disable-next-line @typescript-eslint/ban-ts-comment +// @ts-ignore: Unused imports +import {Call as $Call, CancellablePromise as $CancellablePromise, Create as $Create} from "/wails/runtime.js"; + +/** + * A long running operation of specified duration. + * @param {number} milliseconds + * @returns {$CancellablePromise} + */ +export function LongRunning(milliseconds) { + return $Call.ByID(298191698, milliseconds); +} diff --git a/v3/examples/cancel-async/assets/index.html b/v3/examples/cancel-async/assets/index.html new file mode 100644 index 000000000..ff0609928 --- /dev/null +++ b/v3/examples/cancel-async/assets/index.html @@ -0,0 +1,134 @@ + + + + + Wails Alpha + + + + +
      Alpha
      +
      +

      Documentation

      +

      Feedback

      +
      +
      Please enter a duration in milliseconds below 👇
      +
      + + + + +
      + + + diff --git a/v3/examples/cancel-async/main.go b/v3/examples/cancel-async/main.go new file mode 100644 index 000000000..9fb52481b --- /dev/null +++ b/v3/examples/cancel-async/main.go @@ -0,0 +1,37 @@ +package main + +import ( + "embed" + "log" + + "github.com/wailsapp/wails/v3/pkg/application" +) + +//go:embed assets/* +var assets embed.FS + +func main() { + app := application.New(application.Options{ + Services: []application.Service{ + application.NewService(&Service{}), + }, + Assets: application.AssetOptions{ + Handler: application.BundledAssetFileServer(assets), + }, + Mac: application.MacOptions{ + ApplicationShouldTerminateAfterLastWindowClosed: true, + }, + }) + + app.Window.NewWithOptions(application.WebviewWindowOptions{ + URL: "/", + DevToolsEnabled: true, + }) + + err := app.Run() + + if err != nil { + log.Fatal(err) + } + +} diff --git a/v3/examples/cancel-async/service.go b/v3/examples/cancel-async/service.go new file mode 100644 index 000000000..b2cc72e9b --- /dev/null +++ b/v3/examples/cancel-async/service.go @@ -0,0 +1,19 @@ +package main + +import ( + "context" + "time" +) + +type Service struct { +} + +// A long running operation of specified duration. +func (*Service) LongRunning(ctx context.Context, milliseconds int) error { + select { + case <-time.After(time.Duration(milliseconds) * time.Millisecond): + return nil + case <-ctx.Done(): + return ctx.Err() + } +} diff --git a/v3/examples/cancel-chaining/README.md b/v3/examples/cancel-chaining/README.md new file mode 100644 index 000000000..10c5855ea --- /dev/null +++ b/v3/examples/cancel-chaining/README.md @@ -0,0 +1,5 @@ +# Binding Call Cancelling Example + +This example demonstrates how to cancel binding calls in promise chaining style. + +To regenerate bindings, run `wails3 generate bindings -clean -b -d assets/bindings` in this directory. diff --git a/v3/examples/cancel-chaining/assets/bindings/github.com/wailsapp/wails/v3/examples/cancel-chaining/index.js b/v3/examples/cancel-chaining/assets/bindings/github.com/wailsapp/wails/v3/examples/cancel-chaining/index.js new file mode 100644 index 000000000..d2bf43c94 --- /dev/null +++ b/v3/examples/cancel-chaining/assets/bindings/github.com/wailsapp/wails/v3/examples/cancel-chaining/index.js @@ -0,0 +1,8 @@ +// @ts-check +// Cynhyrchwyd y ffeil hon yn awtomatig. PEIDIWCH Â MODIWL +// This file is automatically generated. DO NOT EDIT + +import * as Service from "./service.js"; +export { + Service +}; diff --git a/v3/examples/cancel-chaining/assets/bindings/github.com/wailsapp/wails/v3/examples/cancel-chaining/service.js b/v3/examples/cancel-chaining/assets/bindings/github.com/wailsapp/wails/v3/examples/cancel-chaining/service.js new file mode 100644 index 000000000..6aae91e1d --- /dev/null +++ b/v3/examples/cancel-chaining/assets/bindings/github.com/wailsapp/wails/v3/examples/cancel-chaining/service.js @@ -0,0 +1,16 @@ +// @ts-check +// Cynhyrchwyd y ffeil hon yn awtomatig. PEIDIWCH Â MODIWL +// This file is automatically generated. DO NOT EDIT + +// eslint-disable-next-line @typescript-eslint/ban-ts-comment +// @ts-ignore: Unused imports +import {Call as $Call, CancellablePromise as $CancellablePromise, Create as $Create} from "/wails/runtime.js"; + +/** + * A long running operation of specified duration. + * @param {number} milliseconds + * @returns {$CancellablePromise} + */ +export function LongRunning(milliseconds) { + return $Call.ByID(298191698, milliseconds); +} diff --git a/v3/examples/cancel-chaining/assets/index.html b/v3/examples/cancel-chaining/assets/index.html new file mode 100644 index 000000000..71221c28d --- /dev/null +++ b/v3/examples/cancel-chaining/assets/index.html @@ -0,0 +1,136 @@ + + + + + Wails Alpha + + + + +
      Alpha
      +
      +

      Documentation

      +

      Feedback

      +
      +
      Please enter a duration in milliseconds below 👇
      +
      + + + + +
      + + + diff --git a/v3/examples/cancel-chaining/main.go b/v3/examples/cancel-chaining/main.go new file mode 100644 index 000000000..9fb52481b --- /dev/null +++ b/v3/examples/cancel-chaining/main.go @@ -0,0 +1,37 @@ +package main + +import ( + "embed" + "log" + + "github.com/wailsapp/wails/v3/pkg/application" +) + +//go:embed assets/* +var assets embed.FS + +func main() { + app := application.New(application.Options{ + Services: []application.Service{ + application.NewService(&Service{}), + }, + Assets: application.AssetOptions{ + Handler: application.BundledAssetFileServer(assets), + }, + Mac: application.MacOptions{ + ApplicationShouldTerminateAfterLastWindowClosed: true, + }, + }) + + app.Window.NewWithOptions(application.WebviewWindowOptions{ + URL: "/", + DevToolsEnabled: true, + }) + + err := app.Run() + + if err != nil { + log.Fatal(err) + } + +} diff --git a/v3/examples/cancel-chaining/service.go b/v3/examples/cancel-chaining/service.go new file mode 100644 index 000000000..b2cc72e9b --- /dev/null +++ b/v3/examples/cancel-chaining/service.go @@ -0,0 +1,19 @@ +package main + +import ( + "context" + "time" +) + +type Service struct { +} + +// A long running operation of specified duration. +func (*Service) LongRunning(ctx context.Context, milliseconds int) error { + select { + case <-time.After(time.Duration(milliseconds) * time.Millisecond): + return nil + case <-ctx.Done(): + return ctx.Err() + } +} diff --git a/v3/examples/clipboard/README.md b/v3/examples/clipboard/README.md new file mode 100644 index 000000000..b3128b531 --- /dev/null +++ b/v3/examples/clipboard/README.md @@ -0,0 +1,11 @@ +# clipboard + +This example demonstrates how to use the clipboard API. + +# Status + +| Platform | Status | +|----------|---------| +| Mac | Working | +| Windows | Working | +| Linux | | \ No newline at end of file diff --git a/v3/examples/clipboard/main.go b/v3/examples/clipboard/main.go new file mode 100644 index 000000000..0c97693aa --- /dev/null +++ b/v3/examples/clipboard/main.go @@ -0,0 +1,77 @@ +package main + +import ( + _ "embed" + "log" + "runtime" + "time" + + "github.com/wailsapp/wails/v3/pkg/application" +) + +func main() { + + app := application.New(application.Options{ + Name: "Clipboard Demo", + Description: "A demo of the clipboard API", + Assets: application.AlphaAssets, + Mac: application.MacOptions{ + ApplicationShouldTerminateAfterLastWindowClosed: true, + }, + }) + + // Create a custom menu + menu := app.NewMenu() + if runtime.GOOS == "darwin" { + menu.AddRole(application.AppMenu) + } + + setClipboardMenu := menu.AddSubmenu("Set Clipboard") + setClipboardMenu.Add("Set Text 'Hello'").OnClick(func(ctx *application.Context) { + success := app.Clipboard.SetText("Hello") + if !success { + app.Dialog.Info().SetMessage("Failed to set clipboard text").Show() + } + }) + setClipboardMenu.Add("Set Text 'World'").OnClick(func(ctx *application.Context) { + success := app.Clipboard.SetText("World") + if !success { + app.Dialog.Info().SetMessage("Failed to set clipboard text").Show() + } + }) + setClipboardMenu.Add("Set Text (current time)").OnClick(func(ctx *application.Context) { + success := app.Clipboard.SetText(time.Now().String()) + if !success { + app.Dialog.Info().SetMessage("Failed to set clipboard text").Show() + } + }) + getClipboardMenu := menu.AddSubmenu("Get Clipboard") + getClipboardMenu.Add("Get Text").OnClick(func(ctx *application.Context) { + result, ok := app.Clipboard.Text() + if !ok { + app.Dialog.Info().SetMessage("Failed to get clipboard text").Show() + } else { + app.Dialog.Info().SetMessage("Got:\n\n" + result).Show() + } + }) + + clearClipboardMenu := menu.AddSubmenu("Clear Clipboard") + clearClipboardMenu.Add("Clear Text").OnClick(func(ctx *application.Context) { + success := app.Clipboard.SetText("") + if success { + app.Dialog.Info().SetMessage("Clipboard text cleared").Show() + } else { + app.Dialog.Info().SetMessage("Clipboard text not cleared").Show() + } + }) + + app.Menu.Set(menu) + + app.Window.New() + + err := app.Run() + + if err != nil { + log.Fatal(err.Error()) + } +} diff --git a/v3/examples/contextmenus/README.md b/v3/examples/contextmenus/README.md new file mode 100644 index 000000000..ba6d498e7 --- /dev/null +++ b/v3/examples/contextmenus/README.md @@ -0,0 +1,30 @@ +# contextmenus + +This example shows how to create a context menu for your application. +It demonstrates window level and global context menus. + +A simple menu is registered with the window and the application with the id "test". +In our frontend html, we then use the `--custom-contextmenu` style to attach the menu to an element. +We also use the `--custom-contextmenu-data` style to pass data to the menu callback which can be read in Go. +This is really useful when using components to distinguish between different elements. + +```go + +```html + +
      +

      1

      +
      +
      +

      2

      +
      +``` + +# Status + +| Platform | Status | +|----------|---------| +| Mac | Working | +| Windows | Working | +| Linux | | + diff --git a/v3/examples/contextmenus/assets/index.html b/v3/examples/contextmenus/assets/index.html new file mode 100644 index 000000000..23224084d --- /dev/null +++ b/v3/examples/contextmenus/assets/index.html @@ -0,0 +1,82 @@ + + + + + Title + + + + + + +

      Context Menu Demo

      +

      + You need to run this example in production for it to work : +

      go run -tags production .
      + +
      +
      +

      1

      +
      +
      +

      2

      +
      +
      +

      Default Context Menu shown here

      + +
      +
      +

      Default auto (smart) Context Menu here

      + +
      +
      +

      Context menu shown here only if you select text

      +

      Selecting text here and right-clicking the box below or its border shouldn't show the context menu

      +
      +
      +
      +
      +
      +
      + + + + +

      content editable

      +
      +
      +
      +

      Default Context Menu hidden here

      +

      Context Menu hidden here even if text is selected

      + +
      +
      +

      Nested section reverted to auto (smart) default Context Menu

      +

      Context menu shown here only if you select text

      +
      +
      +
      + + diff --git a/v3/examples/contextmenus/main.go b/v3/examples/contextmenus/main.go new file mode 100644 index 000000000..70cdf5c7e --- /dev/null +++ b/v3/examples/contextmenus/main.go @@ -0,0 +1,55 @@ +package main + +import ( + "embed" + _ "embed" + "log" + + "github.com/wailsapp/wails/v3/pkg/application" +) + +//go:embed assets +var assets embed.FS + +func main() { + + app := application.New(application.Options{ + Name: "Context Menu Demo", + Description: "A demo of the Context Menu API", + Assets: application.AssetOptions{ + Handler: application.BundledAssetFileServer(assets), + }, + Mac: application.MacOptions{ + ApplicationShouldTerminateAfterLastWindowClosed: true, + }, + }) + + app.Window.NewWithOptions(application.WebviewWindowOptions{ + Title: "Context Menu Demo", + Width: 1024, + Height: 1024, + Mac: application.MacWindow{ + Backdrop: application.MacBackdropTranslucent, + TitleBar: application.MacTitleBarHiddenInsetUnified, + InvisibleTitleBarHeight: 50, + }, + }) + + contextMenu := app.ContextMenu.New() + clickMe := contextMenu.Add("Click to set Menuitem label to Context Data") + contextDataMenuItem := contextMenu.Add("Current context data: No Context Data") + clickMe.OnClick(func(data *application.Context) { + app.Logger.Info("Context menu", "context data", data.ContextMenuData()) + contextDataMenuItem.SetLabel("Current context data: " + data.ContextMenuData()) + contextMenu.Update() + }) + + // Register the context menu + app.ContextMenu.Add("test", contextMenu) + + err := app.Run() + + if err != nil { + log.Fatal(err.Error()) + } +} diff --git a/v3/examples/custom-protocol-example/.gitignore b/v3/examples/custom-protocol-example/.gitignore new file mode 100644 index 000000000..ba8194ab6 --- /dev/null +++ b/v3/examples/custom-protocol-example/.gitignore @@ -0,0 +1,6 @@ +.task +bin +frontend/dist +frontend/node_modules +build/linux/appimage/build +build/windows/nsis/MicrosoftEdgeWebview2Setup.exe \ No newline at end of file diff --git a/v3/examples/custom-protocol-example/README.md b/v3/examples/custom-protocol-example/README.md new file mode 100644 index 000000000..ad12c3f40 --- /dev/null +++ b/v3/examples/custom-protocol-example/README.md @@ -0,0 +1,59 @@ +# Welcome to Your New Wails3 Project! + +Congratulations on generating your Wails3 application! This README will guide you through the next steps to get your project up and running. + +## Getting Started + +1. Navigate to your project directory in the terminal. + +2. To run your application in development mode, use the following command: + + ``` + wails3 dev + ``` + + This will start your application and enable hot-reloading for both frontend and backend changes. + +3. To build your application for production, use: + + ``` + wails3 build + ``` + + This will create a production-ready executable in the `build` directory. + +## Exploring Wails3 Features + +Now that you have your project set up, it's time to explore the features that Wails3 offers: + +1. **Check out the examples**: The best way to learn is by example. Visit the `examples` directory in the `v3/examples` directory to see various sample applications. + +2. **Run an example**: To run any of the examples, navigate to the example's directory and use: + + ``` + go run . + ``` + + Note: Some examples may be under development during the alpha phase. + +3. **Explore the documentation**: Visit the [Wails3 documentation](https://v3.wails.io/) for in-depth guides and API references. + +4. **Join the community**: Have questions or want to share your progress? Join the [Wails Discord](https://discord.gg/JDdSxwjhGf) or visit the [Wails discussions on GitHub](https://github.com/wailsapp/wails/discussions). + +## Project Structure + +Take a moment to familiarize yourself with your project structure: + +- `frontend/`: Contains your frontend code (HTML, CSS, JavaScript/TypeScript) +- `main.go`: The entry point of your Go backend +- `app.go`: Define your application structure and methods here +- `wails.json`: Configuration file for your Wails project + +## Next Steps + +1. Modify the frontend in the `frontend/` directory to create your desired UI. +2. Add backend functionality in `main.go`. +3. Use `wails3 dev` to see your changes in real-time. +4. When ready, build your application with `wails3 build`. + +Happy coding with Wails3! If you encounter any issues or have questions, don't hesitate to consult the documentation or reach out to the Wails community. diff --git a/v3/examples/custom-protocol-example/Taskfile.yml b/v3/examples/custom-protocol-example/Taskfile.yml new file mode 100644 index 000000000..572db59ac --- /dev/null +++ b/v3/examples/custom-protocol-example/Taskfile.yml @@ -0,0 +1,33 @@ +version: '3' + +includes: + common: ./build/Taskfile.yml + windows: ./build/windows/Taskfile.yml + darwin: ./build/darwin/Taskfile.yml + linux: ./build/linux/Taskfile.yml + +vars: + APP_NAME: "custom-protocol-example" + BIN_DIR: "bin" + +tasks: + build: + summary: Builds the application + cmds: + - task: "{{OS}}:build" + + package: + summary: Packages a production build of the application + cmds: + - task: "{{OS}}:package" + + run: + summary: Runs the application + cmds: + - task: "{{OS}}:run" + + dev: + summary: Runs the application in development mode + cmds: + - wails3 dev -config ./build/config.yml + diff --git a/v3/examples/custom-protocol-example/build/Taskfile.yml b/v3/examples/custom-protocol-example/build/Taskfile.yml new file mode 100644 index 000000000..f3475d2cf --- /dev/null +++ b/v3/examples/custom-protocol-example/build/Taskfile.yml @@ -0,0 +1,86 @@ +version: '3' + +tasks: + go:mod:tidy: + summary: Runs `go mod tidy` + internal: true + cmds: + - go mod tidy + + install:frontend:deps: + summary: Install frontend dependencies + dir: frontend + sources: + - package.json + - package-lock.json + generates: + - node_modules/* + preconditions: + - sh: npm version + cmds: + - echo "Skipping frontend dependencies installation" + + build:frontend: + label: build:frontend (PRODUCTION={{.PRODUCTION}}) + summary: Build the frontend project + dir: frontend + sources: + - "**/*" + - exclude: node_modules/**/* + generates: + - dist/**/* + deps: + - task: install:frontend:deps + - task: generate:bindings + vars: + BUILD_FLAGS: + ref: .BUILD_FLAGS + cmds: + - npm run {{.BUILD_COMMAND}} -q + env: + PRODUCTION: '{{.PRODUCTION | default "false"}}' + vars: + BUILD_COMMAND: '{{if eq .PRODUCTION "true"}}build{{else}}build{{end}}' + + + generate:bindings: + label: generate:bindings (BUILD_FLAGS={{.BUILD_FLAGS}}) + summary: Generates bindings for the frontend + deps: + - task: go:mod:tidy + sources: + - "**/*.[jt]s" + - exclude: frontend/**/* + - frontend/bindings/**/* # Rerun when switching between dev/production mode causes changes in output + - "**/*.go" + - go.mod + - go.sum + generates: + - frontend/bindings/**/* + cmds: + - wails3 generate bindings -f '{{.BUILD_FLAGS}}' -clean=true + + generate:icons: + summary: Generates Windows `.ico` and Mac `.icns` files from an image + dir: build + sources: + - "appicon.png" + generates: + - "darwin/icons.icns" + - "windows/icon.ico" + cmds: + - wails3 generate icons -input appicon.png -macfilename darwin/icons.icns -windowsfilename windows/icon.ico + + dev:frontend: + summary: Runs the frontend in development mode + dir: frontend + deps: + - task: install:frontend:deps + cmds: + - echo "Skipping frontend development mode" + + update:build-assets: + summary: Updates the build assets + dir: build + cmds: + - wails3 update build-assets -name "{{.APP_NAME}}" -binaryname "{{.APP_NAME}}" -config config.yml -dir . diff --git a/v3/examples/custom-protocol-example/build/appicon.png b/v3/examples/custom-protocol-example/build/appicon.png new file mode 100644 index 000000000..63617fe4f Binary files /dev/null and b/v3/examples/custom-protocol-example/build/appicon.png differ diff --git a/v3/examples/custom-protocol-example/build/config.yml b/v3/examples/custom-protocol-example/build/config.yml new file mode 100644 index 000000000..8f2cb0348 --- /dev/null +++ b/v3/examples/custom-protocol-example/build/config.yml @@ -0,0 +1,67 @@ +# This file contains the configuration for this project. +# When you update `info` or `fileAssociations`, run `wails3 task common:update:build-assets` to update the assets. +# Note that this will overwrite any changes you have made to the assets. +version: '3' + +# This information is used to generate the build assets. +info: + companyName: "My Company" # The name of the company + productName: "My Product" # The name of the application + productIdentifier: "com.mycompany.myproduct" # The unique product identifier + description: "A program that does X" # The application description + copyright: "(c) 2025, My Company" # Copyright text + comments: "Some Product Comments" # Comments + version: "0.0.1" # The application version + +# Dev mode configuration +dev_mode: + root_path: . + log_level: warn + debounce: 1000 + ignore: + dir: + - .git + - node_modules + - frontend + - bin + file: + - .DS_Store + - .gitignore + - .gitkeep + watched_extension: + - "*.go" + git_ignore: true + executes: + - cmd: wails3 task common:install:frontend:deps + type: once + - cmd: wails3 task common:dev:frontend + type: background + - cmd: go mod tidy + type: blocking + - cmd: wails3 task build + type: blocking + - cmd: wails3 task run + type: primary + +# File Associations +# More information at: https://v3.wails.io/noit/done/yet +fileAssociations: +# - ext: wails +# name: Wails +# description: Wails Application File +# iconName: wailsFileIcon +# role: Editor +# - ext: jpg +# name: JPEG +# description: Image File +# iconName: jpegFileIcon +# role: Editor +# mimeType: image/jpeg # (optional) + +protocols: + - scheme: wailsexample + description: Wails Example Application Custom Protocol + +# Other data +other: + - name: My Other Data \ No newline at end of file diff --git a/v3/examples/custom-protocol-example/build/darwin/Info.dev.plist b/v3/examples/custom-protocol-example/build/darwin/Info.dev.plist new file mode 100644 index 000000000..a46aa82d9 --- /dev/null +++ b/v3/examples/custom-protocol-example/build/darwin/Info.dev.plist @@ -0,0 +1,43 @@ + + + + CFBundlePackageType + APPL + CFBundleName + My Product + CFBundleExecutable + custom-protocol-example + CFBundleIdentifier + com.mycompany.myproduct + CFBundleVersion + 0.0.1 + CFBundleGetInfoString + Some Product Comments + CFBundleShortVersionString + 0.0.1 + CFBundleIconFile + icons + LSMinimumSystemVersion + 10.15.0 + NSHighResolutionCapable + true + NSHumanReadableCopyright + (c) 2025, My Company + NSAppTransportSecurity + + NSAllowsLocalNetworking + + + CFBundleURLTypes + + + CFBundleURLName + wails.com.wailsexample + CFBundleURLSchemes + + wailsexample + + + + + \ No newline at end of file diff --git a/v3/examples/custom-protocol-example/build/darwin/Info.plist b/v3/examples/custom-protocol-example/build/darwin/Info.plist new file mode 100644 index 000000000..d88fd1030 --- /dev/null +++ b/v3/examples/custom-protocol-example/build/darwin/Info.plist @@ -0,0 +1,38 @@ + + + + CFBundlePackageType + APPL + CFBundleName + My Product + CFBundleExecutable + custom-protocol-example + CFBundleIdentifier + com.mycompany.myproduct + CFBundleVersion + 0.0.1 + CFBundleGetInfoString + Some Product Comments + CFBundleShortVersionString + 0.0.1 + CFBundleIconFile + icons + LSMinimumSystemVersion + 10.15.0 + NSHighResolutionCapable + true + NSHumanReadableCopyright + (c) 2025, My Company + CFBundleURLTypes + + + CFBundleURLName + wails.com.wailsexample + CFBundleURLSchemes + + wailsexample + + + + + \ No newline at end of file diff --git a/v3/examples/custom-protocol-example/build/darwin/Taskfile.yml b/v3/examples/custom-protocol-example/build/darwin/Taskfile.yml new file mode 100644 index 000000000..e456dbad5 --- /dev/null +++ b/v3/examples/custom-protocol-example/build/darwin/Taskfile.yml @@ -0,0 +1,76 @@ +version: '3' + +includes: + common: ../Taskfile.yml + +tasks: + build: + summary: Creates a production build of the application + deps: + - task: common:go:mod:tidy + - task: common:generate:icons + - task: common:build:frontend + cmds: + - go build {{.BUILD_FLAGS}} -o {{.OUTPUT}} + vars: + BUILD_FLAGS: '{{if eq .PRODUCTION "true"}}-tags production -trimpath -buildvcs=false -ldflags="-w -s"{{else}}-buildvcs=false -gcflags=all="-l"{{end}}' + DEFAULT_OUTPUT: '{{.BIN_DIR}}/{{.APP_NAME}}' + OUTPUT: '{{ .OUTPUT | default .DEFAULT_OUTPUT }}' + env: + GOOS: darwin + CGO_ENABLED: 1 + GOARCH: '{{.ARCH | default ARCH}}' + CGO_CFLAGS: "-mmacosx-version-min=10.15" + CGO_LDFLAGS: "-mmacosx-version-min=10.15" + MACOSX_DEPLOYMENT_TARGET: "10.15" + PRODUCTION: '{{.PRODUCTION | default "false"}}' + + build:universal: + summary: Builds darwin universal binary (arm64 + amd64) + deps: + - task: build + vars: + ARCH: amd64 + OUTPUT: "{{.BIN_DIR}}/{{.APP_NAME}}-amd64" + - task: build + vars: + ARCH: arm64 + OUTPUT: "{{.BIN_DIR}}/{{.APP_NAME}}-arm64" + cmds: + - lipo -create -output "{{.BIN_DIR}}/{{.APP_NAME}}" "{{.BIN_DIR}}/{{.APP_NAME}}-amd64" "{{.BIN_DIR}}/{{.APP_NAME}}-arm64" + - rm "{{.BIN_DIR}}/{{.APP_NAME}}-amd64" "{{.BIN_DIR}}/{{.APP_NAME}}-arm64" + + package: + summary: Packages a production build of the application into a `.app` bundle + deps: + - task: build + vars: + PRODUCTION: "false" + cmds: + - task: create:app:bundle + + package:universal: + summary: Packages darwin universal binary (arm64 + amd64) + deps: + - task: build:universal + cmds: + - task: create:app:bundle + + + create:app:bundle: + summary: Creates an `.app` bundle + cmds: + - mkdir -p {{.BIN_DIR}}/{{.APP_NAME}}.app/Contents/{MacOS,Resources} + - cp build/darwin/icons.icns {{.BIN_DIR}}/{{.APP_NAME}}.app/Contents/Resources + - cp {{.BIN_DIR}}/{{.APP_NAME}} {{.BIN_DIR}}/{{.APP_NAME}}.app/Contents/MacOS + - cp build/darwin/Info.plist {{.BIN_DIR}}/{{.APP_NAME}}.app/Contents + - codesign --force --deep --sign - {{.BIN_DIR}}/{{.APP_NAME}}.app + + run: + cmds: + - mkdir -p {{.BIN_DIR}}/{{.APP_NAME}}.dev.app/Contents/{MacOS,Resources} + - cp build/darwin/icons.icns {{.BIN_DIR}}/{{.APP_NAME}}.dev.app/Contents/Resources + - cp {{.BIN_DIR}}/{{.APP_NAME}} {{.BIN_DIR}}/{{.APP_NAME}}.dev.app/Contents/MacOS + - cp build/darwin/Info.dev.plist {{.BIN_DIR}}/{{.APP_NAME}}.dev.app/Contents/Info.plist + - codesign --force --deep --sign - {{.BIN_DIR}}/{{.APP_NAME}}.dev.app + - '{{.BIN_DIR}}/{{.APP_NAME}}.dev.app/Contents/MacOS/{{.APP_NAME}}' diff --git a/v3/examples/custom-protocol-example/build/darwin/icons.icns b/v3/examples/custom-protocol-example/build/darwin/icons.icns new file mode 100644 index 000000000..1b5bd4c86 Binary files /dev/null and b/v3/examples/custom-protocol-example/build/darwin/icons.icns differ diff --git a/v3/examples/custom-protocol-example/build/linux/Taskfile.yml b/v3/examples/custom-protocol-example/build/linux/Taskfile.yml new file mode 100644 index 000000000..a6115574a --- /dev/null +++ b/v3/examples/custom-protocol-example/build/linux/Taskfile.yml @@ -0,0 +1,113 @@ +version: '3' + +includes: + common: ../Taskfile.yml + +tasks: + build: + summary: Builds the application for Linux + deps: + - task: common:go:mod:tidy + - task: common:generate:icons + cmds: + - go build {{.BUILD_FLAGS}} -o {{.BIN_DIR}}/{{.APP_NAME}} + vars: + BUILD_FLAGS: '{{if eq .PRODUCTION "true"}}-tags production -trimpath -buildvcs=false -ldflags="-w -s"{{else}}-buildvcs=false -gcflags=all="-l"{{end}}' + env: + GOOS: linux + CGO_ENABLED: 1 + GOARCH: '{{.ARCH | default ARCH}}' + PRODUCTION: '{{.PRODUCTION | default "false"}}' + + package: + summary: Packages a production build of the application for Linux + deps: + - task: build + vars: + PRODUCTION: "true" + cmds: + - task: create:appimage + - task: create:deb + - task: create:rpm + - task: create:aur + + create:appimage: + summary: Creates an AppImage + dir: build/linux/appimage + deps: + - task: build + vars: + PRODUCTION: "true" + - task: generate:dotdesktop + cmds: + - cp {{.APP_BINARY}} {{.APP_NAME}} + - cp ../../appicon.png appicon.png + - wails3 generate appimage -binary {{.APP_NAME}} -icon {{.ICON}} -desktopfile {{.DESKTOP_FILE}} -outputdir {{.OUTPUT_DIR}} -builddir {{.ROOT_DIR}}/build/linux/appimage/build + vars: + APP_NAME: '{{.APP_NAME}}' + APP_BINARY: '../../../bin/{{.APP_NAME}}' + ICON: '../../appicon.png' + DESKTOP_FILE: '../{{.APP_NAME}}.desktop' + OUTPUT_DIR: '../../../bin' + + create:deb: + summary: Creates a deb package + deps: + - task: build + vars: + PRODUCTION: "true" + cmds: + - task: generate:dotdesktop + - task: generate:deb + + create:rpm: + summary: Creates a rpm package + deps: + - task: build + vars: + PRODUCTION: "true" + cmds: + - task: generate:dotdesktop + - task: generate:rpm + + create:aur: + summary: Creates a arch linux packager package + deps: + - task: build + vars: + PRODUCTION: "true" + cmds: + - task: generate:dotdesktop + - task: generate:aur + + generate:deb: + summary: Creates a deb package + cmds: + - wails3 tool package -name {{.APP_NAME}} -format deb -config ./build/linux/nfpm/nfpm.yaml -out {{.ROOT_DIR}}/bin + + generate:rpm: + summary: Creates a rpm package + cmds: + - wails3 tool package -name {{.APP_NAME}} -format rpm -config ./build/linux/nfpm/nfpm.yaml -out {{.ROOT_DIR}}/bin + + generate:aur: + summary: Creates a arch linux packager package + cmds: + - wails3 tool package -name {{.APP_NAME}} -format archlinux -config ./build/linux/nfpm/nfpm.yaml -out {{.ROOT_DIR}}/bin + + generate:dotdesktop: + summary: Generates a `.desktop` file + dir: build + cmds: + - mkdir -p {{.ROOT_DIR}}/build/linux/appimage + - wails3 generate .desktop -name "{{.APP_NAME}}" -exec "{{.EXEC}}" -icon "{{.ICON}}" -outputfile {{.ROOT_DIR}}/build/linux/{{.APP_NAME}}.desktop -categories "{{.CATEGORIES}}" + vars: + APP_NAME: '{{.APP_NAME}}' + EXEC: '{{.APP_NAME}}' + ICON: 'appicon' + CATEGORIES: 'Development;' + OUTPUTFILE: '{{.ROOT_DIR}}/build/linux/{{.APP_NAME}}.desktop' + + run: + cmds: + - '{{.BIN_DIR}}/{{.APP_NAME}}' diff --git a/v3/examples/custom-protocol-example/build/linux/appimage/build.sh b/v3/examples/custom-protocol-example/build/linux/appimage/build.sh new file mode 100644 index 000000000..85901c34e --- /dev/null +++ b/v3/examples/custom-protocol-example/build/linux/appimage/build.sh @@ -0,0 +1,35 @@ +#!/usr/bin/env bash +# Copyright (c) 2018-Present Lea Anthony +# SPDX-License-Identifier: MIT + +# Fail script on any error +set -euxo pipefail + +# Define variables +APP_DIR="${APP_NAME}.AppDir" + +# Create AppDir structure +mkdir -p "${APP_DIR}/usr/bin" +cp -r "${APP_BINARY}" "${APP_DIR}/usr/bin/" +cp "${ICON_PATH}" "${APP_DIR}/" +cp "${DESKTOP_FILE}" "${APP_DIR}/" + +if [[ $(uname -m) == *x86_64* ]]; then + # Download linuxdeploy and make it executable + wget -q -4 -N https://github.com/linuxdeploy/linuxdeploy/releases/download/continuous/linuxdeploy-x86_64.AppImage + chmod +x linuxdeploy-x86_64.AppImage + + # Run linuxdeploy to bundle the application + ./linuxdeploy-x86_64.AppImage --appdir "${APP_DIR}" --output appimage +else + # Download linuxdeploy and make it executable (arm64) + wget -q -4 -N https://github.com/linuxdeploy/linuxdeploy/releases/download/continuous/linuxdeploy-aarch64.AppImage + chmod +x linuxdeploy-aarch64.AppImage + + # Run linuxdeploy to bundle the application (arm64) + ./linuxdeploy-aarch64.AppImage --appdir "${APP_DIR}" --output appimage +fi + +# Rename the generated AppImage +mv "${APP_NAME}*.AppImage" "${APP_NAME}.AppImage" + diff --git a/v3/examples/custom-protocol-example/build/linux/nfpm/nfpm.yaml b/v3/examples/custom-protocol-example/build/linux/nfpm/nfpm.yaml new file mode 100644 index 000000000..7356f2992 --- /dev/null +++ b/v3/examples/custom-protocol-example/build/linux/nfpm/nfpm.yaml @@ -0,0 +1,50 @@ +# Feel free to remove those if you don't want/need to use them. +# Make sure to check the documentation at https://nfpm.goreleaser.com +# +# The lines below are called `modelines`. See `:help modeline` + +name: "custom-protocol-example" +arch: ${GOARCH} +platform: "linux" +version: "0.0.1" +section: "default" +priority: "extra" +maintainer: ${GIT_COMMITTER_NAME} <${GIT_COMMITTER_EMAIL}> +description: "A program that does X" +vendor: "My Company" +homepage: "https://wails.io" +license: "MIT" +release: "1" + +contents: + - src: "./bin/custom-protocol-example" + dst: "/usr/local/bin/custom-protocol-example" + - src: "./build/appicon.png" + dst: "/usr/share/icons/hicolor/128x128/apps/custom-protocol-example.png" + - src: "./build/linux/custom-protocol-example.desktop" + dst: "/usr/share/applications/custom-protocol-example.desktop" + +depends: + - gtk3 + - libwebkit2gtk + +# replaces: +# - foobar +# provides: +# - bar +# depends: +# - gtk3 +# - libwebkit2gtk +# recommends: +# - whatever +# suggests: +# - something-else +# conflicts: +# - not-foo +# - not-bar +# changelog: "changelog.yaml" +# scripts: +# preinstall: ./build/linux/nfpm/scripts/preinstall.sh +# postinstall: ./build/linux/nfpm/scripts/postinstall.sh +# preremove: ./build/linux/nfpm/scripts/preremove.sh +# postremove: ./build/linux/nfpm/scripts/postremove.sh diff --git a/v3/examples/custom-protocol-example/build/linux/nfpm/scripts/postinstall.sh b/v3/examples/custom-protocol-example/build/linux/nfpm/scripts/postinstall.sh new file mode 100644 index 000000000..a9bf588e2 --- /dev/null +++ b/v3/examples/custom-protocol-example/build/linux/nfpm/scripts/postinstall.sh @@ -0,0 +1 @@ +#!/bin/bash diff --git a/v3/examples/custom-protocol-example/build/linux/nfpm/scripts/postremove.sh b/v3/examples/custom-protocol-example/build/linux/nfpm/scripts/postremove.sh new file mode 100644 index 000000000..a9bf588e2 --- /dev/null +++ b/v3/examples/custom-protocol-example/build/linux/nfpm/scripts/postremove.sh @@ -0,0 +1 @@ +#!/bin/bash diff --git a/v3/examples/custom-protocol-example/build/linux/nfpm/scripts/preinstall.sh b/v3/examples/custom-protocol-example/build/linux/nfpm/scripts/preinstall.sh new file mode 100644 index 000000000..a9bf588e2 --- /dev/null +++ b/v3/examples/custom-protocol-example/build/linux/nfpm/scripts/preinstall.sh @@ -0,0 +1 @@ +#!/bin/bash diff --git a/v3/examples/custom-protocol-example/build/linux/nfpm/scripts/preremove.sh b/v3/examples/custom-protocol-example/build/linux/nfpm/scripts/preremove.sh new file mode 100644 index 000000000..a9bf588e2 --- /dev/null +++ b/v3/examples/custom-protocol-example/build/linux/nfpm/scripts/preremove.sh @@ -0,0 +1 @@ +#!/bin/bash diff --git a/v3/examples/custom-protocol-example/build/windows/Taskfile.yml b/v3/examples/custom-protocol-example/build/windows/Taskfile.yml new file mode 100644 index 000000000..805c1aa7f --- /dev/null +++ b/v3/examples/custom-protocol-example/build/windows/Taskfile.yml @@ -0,0 +1,57 @@ +version: '3' + +includes: + common: ../Taskfile.yml + +tasks: + build: + summary: Builds the application for Windows + deps: + - task: common:go:mod:tidy + - task: common:generate:icons + cmds: + - task: generate:syso + - go build {{.BUILD_FLAGS}} -o {{.BIN_DIR}}/{{.APP_NAME}}.exe + - cmd: powershell Remove-item *.syso + platforms: [windows] + - cmd: rm -f *.syso + platforms: [linux, darwin] + vars: + BUILD_FLAGS: '{{if eq .PRODUCTION "true"}}-tags production -trimpath -buildvcs=false -ldflags="-w -s -H windowsgui"{{else}}-buildvcs=false -gcflags=all="-l"{{end}}' + env: + GOOS: windows + CGO_ENABLED: 0 + GOARCH: '{{.ARCH | default ARCH}}' + PRODUCTION: '{{.PRODUCTION | default "false"}}' + + package: + summary: Packages a production build of the application into a `.exe` bundle + cmds: + - task: create:nsis:installer + + generate:syso: + summary: Generates Windows `.syso` file + dir: build + cmds: + - wails3 generate syso -arch {{.ARCH}} -icon windows/icon.ico -manifest windows/wails.exe.manifest -info windows/info.json -out ../wails_windows_{{.ARCH}}.syso + vars: + ARCH: '{{.ARCH | default ARCH}}' + + create:nsis:installer: + summary: Creates an NSIS installer + dir: build/windows/nsis + deps: + - task: build + vars: + PRODUCTION: "true" + cmds: + # Create the Microsoft WebView2 bootstrapper if it doesn't exist + - wails3 generate webview2bootstrapper -dir "{{.ROOT_DIR}}/build/windows/nsis" + - makensis -DARG_WAILS_{{.ARG_FLAG}}_BINARY="{{.ROOT_DIR}}/{{.BIN_DIR}}/{{.APP_NAME}}.exe" project.nsi + vars: + ARCH: '{{.ARCH | default ARCH}}' + ARG_FLAG: '{{if eq .ARCH "amd64"}}AMD64{{else}}ARM64{{end}}' + + run: + cmds: + - '{{.BIN_DIR}}/{{.APP_NAME}}.exe' diff --git a/v3/examples/custom-protocol-example/build/windows/icon.ico b/v3/examples/custom-protocol-example/build/windows/icon.ico new file mode 100644 index 000000000..bfa0690b7 Binary files /dev/null and b/v3/examples/custom-protocol-example/build/windows/icon.ico differ diff --git a/v3/examples/custom-protocol-example/build/windows/info.json b/v3/examples/custom-protocol-example/build/windows/info.json new file mode 100644 index 000000000..71dfd6d99 --- /dev/null +++ b/v3/examples/custom-protocol-example/build/windows/info.json @@ -0,0 +1,15 @@ +{ + "fixed": { + "file_version": "0.0.1" + }, + "info": { + "0000": { + "ProductVersion": "0.0.1", + "CompanyName": "My Company", + "FileDescription": "A program that does X", + "LegalCopyright": "(c) 2025, My Company", + "ProductName": "My Product", + "Comments": "Some Product Comments" + } + } +} \ No newline at end of file diff --git a/v3/examples/custom-protocol-example/build/windows/nsis/project.nsi b/v3/examples/custom-protocol-example/build/windows/nsis/project.nsi new file mode 100644 index 000000000..5ff2eb085 --- /dev/null +++ b/v3/examples/custom-protocol-example/build/windows/nsis/project.nsi @@ -0,0 +1,112 @@ +Unicode true + +#### +## Please note: Template replacements don't work in this file. They are provided with default defines like +## mentioned underneath. +## If the keyword is not defined, "wails_tools.nsh" will populate them. +## If they are defined here, "wails_tools.nsh" will not touch them. This allows you to use this project.nsi manually +## from outside of Wails for debugging and development of the installer. +## +## For development first make a wails nsis build to populate the "wails_tools.nsh": +## > wails build --target windows/amd64 --nsis +## Then you can call makensis on this file with specifying the path to your binary: +## For a AMD64 only installer: +## > makensis -DARG_WAILS_AMD64_BINARY=..\..\bin\app.exe +## For a ARM64 only installer: +## > makensis -DARG_WAILS_ARM64_BINARY=..\..\bin\app.exe +## For a installer with both architectures: +## > makensis -DARG_WAILS_AMD64_BINARY=..\..\bin\app-amd64.exe -DARG_WAILS_ARM64_BINARY=..\..\bin\app-arm64.exe +#### +## The following information is taken from the wails_tools.nsh file, but they can be overwritten here. +#### +## !define INFO_PROJECTNAME "my-project" # Default "custom-protocol-example" +## !define INFO_COMPANYNAME "My Company" # Default "My Company" +## !define INFO_PRODUCTNAME "My Product Name" # Default "My Product" +## !define INFO_PRODUCTVERSION "1.0.0" # Default "0.1.0" +## !define INFO_COPYRIGHT "(c) Now, My Company" # Default "© now, My Company" +### +## !define PRODUCT_EXECUTABLE "Application.exe" # Default "${INFO_PROJECTNAME}.exe" +## !define UNINST_KEY_NAME "UninstKeyInRegistry" # Default "${INFO_COMPANYNAME}${INFO_PRODUCTNAME}" +#### +## !define REQUEST_EXECUTION_LEVEL "admin" # Default "admin" see also https://nsis.sourceforge.io/Docs/Chapter4.html +#### +## Include the wails tools +#### +!include "wails_tools.nsh" + +# The version information for this two must consist of 4 parts +VIProductVersion "${INFO_PRODUCTVERSION}.0" +VIFileVersion "${INFO_PRODUCTVERSION}.0" + +VIAddVersionKey "CompanyName" "${INFO_COMPANYNAME}" +VIAddVersionKey "FileDescription" "${INFO_PRODUCTNAME} Installer" +VIAddVersionKey "ProductVersion" "${INFO_PRODUCTVERSION}" +VIAddVersionKey "FileVersion" "${INFO_PRODUCTVERSION}" +VIAddVersionKey "LegalCopyright" "${INFO_COPYRIGHT}" +VIAddVersionKey "ProductName" "${INFO_PRODUCTNAME}" + +# Enable HiDPI support. https://nsis.sourceforge.io/Reference/ManifestDPIAware +ManifestDPIAware true + +!include "MUI.nsh" + +!define MUI_ICON "..\icon.ico" +!define MUI_UNICON "..\icon.ico" +# !define MUI_WELCOMEFINISHPAGE_BITMAP "resources\leftimage.bmp" #Include this to add a bitmap on the left side of the Welcome Page. Must be a size of 164x314 +!define MUI_FINISHPAGE_NOAUTOCLOSE # Wait on the INSTFILES page so the user can take a look into the details of the installation steps +!define MUI_ABORTWARNING # This will warn the user if they exit from the installer. + +!insertmacro MUI_PAGE_WELCOME # Welcome to the installer page. +# !insertmacro MUI_PAGE_LICENSE "resources\eula.txt" # Adds a EULA page to the installer +!insertmacro MUI_PAGE_DIRECTORY # In which folder install page. +!insertmacro MUI_PAGE_INSTFILES # Installing page. +!insertmacro MUI_PAGE_FINISH # Finished installation page. + +!insertmacro MUI_UNPAGE_INSTFILES # Uninstalling page + +!insertmacro MUI_LANGUAGE "English" # Set the Language of the installer + +## The following two statements can be used to sign the installer and the uninstaller. The path to the binaries are provided in %1 +#!uninstfinalize 'signtool --file "%1"' +#!finalize 'signtool --file "%1"' + +Name "${INFO_PRODUCTNAME}" +OutFile "..\..\..\bin\${INFO_PROJECTNAME}-${ARCH}-installer.exe" # Name of the installer's file. +InstallDir "$PROGRAMFILES64\${INFO_COMPANYNAME}\${INFO_PRODUCTNAME}" # Default installing folder ($PROGRAMFILES is Program Files folder). +ShowInstDetails show # This will always show the installation details. + +Function .onInit + !insertmacro wails.checkArchitecture +FunctionEnd + +Section + !insertmacro wails.setShellContext + + !insertmacro wails.webview2runtime + + SetOutPath $INSTDIR + + !insertmacro wails.files + + CreateShortcut "$SMPROGRAMS\${INFO_PRODUCTNAME}.lnk" "$INSTDIR\${PRODUCT_EXECUTABLE}" + CreateShortCut "$DESKTOP\${INFO_PRODUCTNAME}.lnk" "$INSTDIR\${PRODUCT_EXECUTABLE}" + + !insertmacro wails.associateFiles + + !insertmacro wails.writeUninstaller +SectionEnd + +Section "uninstall" + !insertmacro wails.setShellContext + + RMDir /r "$AppData\${PRODUCT_EXECUTABLE}" # Remove the WebView2 DataPath + + RMDir /r $INSTDIR + + Delete "$SMPROGRAMS\${INFO_PRODUCTNAME}.lnk" + Delete "$DESKTOP\${INFO_PRODUCTNAME}.lnk" + + !insertmacro wails.unassociateFiles + + !insertmacro wails.deleteUninstaller +SectionEnd diff --git a/v3/examples/custom-protocol-example/build/windows/nsis/wails_tools.nsh b/v3/examples/custom-protocol-example/build/windows/nsis/wails_tools.nsh new file mode 100644 index 000000000..607fc4e85 --- /dev/null +++ b/v3/examples/custom-protocol-example/build/windows/nsis/wails_tools.nsh @@ -0,0 +1,212 @@ +# DO NOT EDIT - Generated automatically by `wails build` + +!include "x64.nsh" +!include "WinVer.nsh" +!include "FileFunc.nsh" + +!ifndef INFO_PROJECTNAME + !define INFO_PROJECTNAME "custom-protocol-example" +!endif +!ifndef INFO_COMPANYNAME + !define INFO_COMPANYNAME "My Company" +!endif +!ifndef INFO_PRODUCTNAME + !define INFO_PRODUCTNAME "My Product" +!endif +!ifndef INFO_PRODUCTVERSION + !define INFO_PRODUCTVERSION "0.0.1" +!endif +!ifndef INFO_COPYRIGHT + !define INFO_COPYRIGHT "(c) 2025, My Company" +!endif +!ifndef PRODUCT_EXECUTABLE + !define PRODUCT_EXECUTABLE "${INFO_PROJECTNAME}.exe" +!endif +!ifndef UNINST_KEY_NAME + !define UNINST_KEY_NAME "${INFO_COMPANYNAME}${INFO_PRODUCTNAME}" +!endif +!define UNINST_KEY "Software\Microsoft\Windows\CurrentVersion\Uninstall\${UNINST_KEY_NAME}" + +!ifndef REQUEST_EXECUTION_LEVEL + !define REQUEST_EXECUTION_LEVEL "admin" +!endif + +RequestExecutionLevel "${REQUEST_EXECUTION_LEVEL}" + +!ifdef ARG_WAILS_AMD64_BINARY + !define SUPPORTS_AMD64 +!endif + +!ifdef ARG_WAILS_ARM64_BINARY + !define SUPPORTS_ARM64 +!endif + +!ifdef SUPPORTS_AMD64 + !ifdef SUPPORTS_ARM64 + !define ARCH "amd64_arm64" + !else + !define ARCH "amd64" + !endif +!else + !ifdef SUPPORTS_ARM64 + !define ARCH "arm64" + !else + !error "Wails: Undefined ARCH, please provide at least one of ARG_WAILS_AMD64_BINARY or ARG_WAILS_ARM64_BINARY" + !endif +!endif + +!macro wails.checkArchitecture + !ifndef WAILS_WIN10_REQUIRED + !define WAILS_WIN10_REQUIRED "This product is only supported on Windows 10 (Server 2016) and later." + !endif + + !ifndef WAILS_ARCHITECTURE_NOT_SUPPORTED + !define WAILS_ARCHITECTURE_NOT_SUPPORTED "This product can't be installed on the current Windows architecture. Supports: ${ARCH}" + !endif + + ${If} ${AtLeastWin10} + !ifdef SUPPORTS_AMD64 + ${if} ${IsNativeAMD64} + Goto ok + ${EndIf} + !endif + + !ifdef SUPPORTS_ARM64 + ${if} ${IsNativeARM64} + Goto ok + ${EndIf} + !endif + + IfSilent silentArch notSilentArch + silentArch: + SetErrorLevel 65 + Abort + notSilentArch: + MessageBox MB_OK "${WAILS_ARCHITECTURE_NOT_SUPPORTED}" + Quit + ${else} + IfSilent silentWin notSilentWin + silentWin: + SetErrorLevel 64 + Abort + notSilentWin: + MessageBox MB_OK "${WAILS_WIN10_REQUIRED}" + Quit + ${EndIf} + + ok: +!macroend + +!macro wails.files + !ifdef SUPPORTS_AMD64 + ${if} ${IsNativeAMD64} + File "/oname=${PRODUCT_EXECUTABLE}" "${ARG_WAILS_AMD64_BINARY}" + ${EndIf} + !endif + + !ifdef SUPPORTS_ARM64 + ${if} ${IsNativeARM64} + File "/oname=${PRODUCT_EXECUTABLE}" "${ARG_WAILS_ARM64_BINARY}" + ${EndIf} + !endif +!macroend + +!macro wails.writeUninstaller + WriteUninstaller "$INSTDIR\uninstall.exe" + + SetRegView 64 + WriteRegStr HKLM "${UNINST_KEY}" "Publisher" "${INFO_COMPANYNAME}" + WriteRegStr HKLM "${UNINST_KEY}" "DisplayName" "${INFO_PRODUCTNAME}" + WriteRegStr HKLM "${UNINST_KEY}" "DisplayVersion" "${INFO_PRODUCTVERSION}" + WriteRegStr HKLM "${UNINST_KEY}" "DisplayIcon" "$INSTDIR\${PRODUCT_EXECUTABLE}" + WriteRegStr HKLM "${UNINST_KEY}" "UninstallString" "$\"$INSTDIR\uninstall.exe$\"" + WriteRegStr HKLM "${UNINST_KEY}" "QuietUninstallString" "$\"$INSTDIR\uninstall.exe$\" /S" + + ${GetSize} "$INSTDIR" "/S=0K" $0 $1 $2 + IntFmt $0 "0x%08X" $0 + WriteRegDWORD HKLM "${UNINST_KEY}" "EstimatedSize" "$0" +!macroend + +!macro wails.deleteUninstaller + Delete "$INSTDIR\uninstall.exe" + + SetRegView 64 + DeleteRegKey HKLM "${UNINST_KEY}" +!macroend + +!macro wails.setShellContext + ${If} ${REQUEST_EXECUTION_LEVEL} == "admin" + SetShellVarContext all + ${else} + SetShellVarContext current + ${EndIf} +!macroend + +# Install webview2 by launching the bootstrapper +# See https://docs.microsoft.com/en-us/microsoft-edge/webview2/concepts/distribution#online-only-deployment +!macro wails.webview2runtime + !ifndef WAILS_INSTALL_WEBVIEW_DETAILPRINT + !define WAILS_INSTALL_WEBVIEW_DETAILPRINT "Installing: WebView2 Runtime" + !endif + + SetRegView 64 + # If the admin key exists and is not empty then webview2 is already installed + ReadRegStr $0 HKLM "SOFTWARE\WOW6432Node\Microsoft\EdgeUpdate\Clients\{F3017226-FE2A-4295-8BDF-00C3A9A7E4C5}" "pv" + ${If} $0 != "" + Goto ok + ${EndIf} + + ${If} ${REQUEST_EXECUTION_LEVEL} == "user" + # If the installer is run in user level, check the user specific key exists and is not empty then webview2 is already installed + ReadRegStr $0 HKCU "Software\Microsoft\EdgeUpdate\Clients\{F3017226-FE2A-4295-8BDF-00C3A9A7E4C5}" "pv" + ${If} $0 != "" + Goto ok + ${EndIf} + ${EndIf} + + SetDetailsPrint both + DetailPrint "${WAILS_INSTALL_WEBVIEW_DETAILPRINT}" + SetDetailsPrint listonly + + InitPluginsDir + CreateDirectory "$pluginsdir\webview2bootstrapper" + SetOutPath "$pluginsdir\webview2bootstrapper" + File "MicrosoftEdgeWebview2Setup.exe" + ExecWait '"$pluginsdir\webview2bootstrapper\MicrosoftEdgeWebview2Setup.exe" /silent /install' + + SetDetailsPrint both + ok: +!macroend + +# Copy of APP_ASSOCIATE and APP_UNASSOCIATE macros from here https://gist.github.com/nikku/281d0ef126dbc215dd58bfd5b3a5cd5b +!macro APP_ASSOCIATE EXT FILECLASS DESCRIPTION ICON COMMANDTEXT COMMAND + ; Backup the previously associated file class + ReadRegStr $R0 SHELL_CONTEXT "Software\Classes\.${EXT}" "" + WriteRegStr SHELL_CONTEXT "Software\Classes\.${EXT}" "${FILECLASS}_backup" "$R0" + + WriteRegStr SHELL_CONTEXT "Software\Classes\.${EXT}" "" "${FILECLASS}" + + WriteRegStr SHELL_CONTEXT "Software\Classes\${FILECLASS}" "" `${DESCRIPTION}` + WriteRegStr SHELL_CONTEXT "Software\Classes\${FILECLASS}\DefaultIcon" "" `${ICON}` + WriteRegStr SHELL_CONTEXT "Software\Classes\${FILECLASS}\shell" "" "open" + WriteRegStr SHELL_CONTEXT "Software\Classes\${FILECLASS}\shell\open" "" `${COMMANDTEXT}` + WriteRegStr SHELL_CONTEXT "Software\Classes\${FILECLASS}\shell\open\command" "" `${COMMAND}` +!macroend + +!macro APP_UNASSOCIATE EXT FILECLASS + ; Backup the previously associated file class + ReadRegStr $R0 SHELL_CONTEXT "Software\Classes\.${EXT}" `${FILECLASS}_backup` + WriteRegStr SHELL_CONTEXT "Software\Classes\.${EXT}" "" "$R0" + + DeleteRegKey SHELL_CONTEXT `Software\Classes\${FILECLASS}` +!macroend + +!macro wails.associateFiles + ; Create file associations + +!macroend + +!macro wails.unassociateFiles + ; Delete app associations + +!macroend \ No newline at end of file diff --git a/v3/examples/custom-protocol-example/build/windows/wails.exe.manifest b/v3/examples/custom-protocol-example/build/windows/wails.exe.manifest new file mode 100644 index 000000000..21af92674 --- /dev/null +++ b/v3/examples/custom-protocol-example/build/windows/wails.exe.manifest @@ -0,0 +1,15 @@ + + + + + + + + + + + true/pm + permonitorv2,permonitor + + + \ No newline at end of file diff --git a/v3/examples/custom-protocol-example/frontend/.gitignore b/v3/examples/custom-protocol-example/frontend/.gitignore new file mode 100644 index 000000000..a547bf36d --- /dev/null +++ b/v3/examples/custom-protocol-example/frontend/.gitignore @@ -0,0 +1,24 @@ +# Logs +logs +*.log +npm-debug.log* +yarn-debug.log* +yarn-error.log* +pnpm-debug.log* +lerna-debug.log* + +node_modules +dist +dist-ssr +*.local + +# Editor directories and files +.vscode/* +!.vscode/extensions.json +.idea +.DS_Store +*.suo +*.ntvs* +*.njsproj +*.sln +*.sw? diff --git a/v3/examples/custom-protocol-example/frontend/bindings/github.com/wailsapp/wails/v3/examples/custom-protocol-example/greetservice.js b/v3/examples/custom-protocol-example/frontend/bindings/github.com/wailsapp/wails/v3/examples/custom-protocol-example/greetservice.js new file mode 100644 index 000000000..0b93e6d75 --- /dev/null +++ b/v3/examples/custom-protocol-example/frontend/bindings/github.com/wailsapp/wails/v3/examples/custom-protocol-example/greetservice.js @@ -0,0 +1,15 @@ +// @ts-check +// Cynhyrchwyd y ffeil hon yn awtomatig. PEIDIWCH Â MODIWL +// This file is automatically generated. DO NOT EDIT + +// eslint-disable-next-line @typescript-eslint/ban-ts-comment +// @ts-ignore: Unused imports +import { Call as $Call, CancellablePromise as $CancellablePromise, Create as $Create } from "@wailsio/runtime"; + +/** + * @param {string} name + * @returns {$CancellablePromise} + */ +export function Greet(name) { + return $Call.ByID(1411160069, name); +} diff --git a/v3/examples/custom-protocol-example/frontend/bindings/github.com/wailsapp/wails/v3/examples/custom-protocol-example/index.js b/v3/examples/custom-protocol-example/frontend/bindings/github.com/wailsapp/wails/v3/examples/custom-protocol-example/index.js new file mode 100644 index 000000000..fdf1ff435 --- /dev/null +++ b/v3/examples/custom-protocol-example/frontend/bindings/github.com/wailsapp/wails/v3/examples/custom-protocol-example/index.js @@ -0,0 +1,8 @@ +// @ts-check +// Cynhyrchwyd y ffeil hon yn awtomatig. PEIDIWCH Â MODIWL +// This file is automatically generated. DO NOT EDIT + +import * as GreetService from "./greetservice.js"; +export { + GreetService +}; diff --git a/v3/examples/custom-protocol-example/frontend/dist/assets/index-BS9x21Y4.js b/v3/examples/custom-protocol-example/frontend/dist/assets/index-BS9x21Y4.js new file mode 100644 index 000000000..4f1023c59 --- /dev/null +++ b/v3/examples/custom-protocol-example/frontend/dist/assets/index-BS9x21Y4.js @@ -0,0 +1,24 @@ +(function(){const t=document.createElement("link").relList;if(t&&t.supports&&t.supports("modulepreload"))return;for(const i of document.querySelectorAll('link[rel="modulepreload"]'))o(i);new MutationObserver(i=>{for(const r of i)if(r.type==="childList")for(const s of r.addedNodes)s.tagName==="LINK"&&s.rel==="modulepreload"&&o(s)}).observe(document,{childList:!0,subtree:!0});function n(i){const r={};return i.integrity&&(r.integrity=i.integrity),i.referrerPolicy&&(r.referrerPolicy=i.referrerPolicy),i.crossOrigin==="use-credentials"?r.credentials="include":i.crossOrigin==="anonymous"?r.credentials="omit":r.credentials="same-origin",r}function o(i){if(i.ep)return;i.ep=!0;const r=n(i);fetch(i.href,r)}})();const S="useandom-26T198340PX75pxJACKVERYMINDBUSHWOLF_GQZbfghjklqvwyzrict";function R(e=21){let t="",n=e|0;for(;n--;)t+=S[Math.random()*64|0];return t}const U=window.location.origin+"/wails/runtime",_=Object.freeze({Call:0,Clipboard:1,Application:2,Events:3,ContextMenu:4,Dialog:5,Window:6,Screens:7,System:8,Browser:9,CancelCall:10});let T=R();function k(e,t=""){return function(n,o=null){return I(e,n,t,o)}}async function I(e,t,n,o){var i,r;let s=new URL(U);s.searchParams.append("object",e.toString()),s.searchParams.append("method",t.toString()),o&&s.searchParams.append("args",JSON.stringify(o));let c={"x-wails-client-id":T};n&&(c["x-wails-window-name"]=n);let a=await fetch(s,{headers:c});if(!a.ok)throw new Error(await a.text());return((r=(i=a.headers.get("Content-Type"))===null||i===void 0?void 0:i.indexOf("application/json"))!==null&&r!==void 0?r:-1)!==-1?a.json():a.text()}k(_.System);const z=function(){var e,t,n,o,i;try{if(!((t=(e=window.chrome)===null||e===void 0?void 0:e.webview)===null||t===void 0)&&t.postMessage)return window.chrome.webview.postMessage.bind(window.chrome.webview);if(!((i=(o=(n=window.webkit)===null||n===void 0?void 0:n.messageHandlers)===null||o===void 0?void 0:o.external)===null||i===void 0)&&i.postMessage)return window.webkit.messageHandlers.external.postMessage.bind(window.webkit.messageHandlers.external)}catch{}return console.warn(` +%c⚠️ Browser Environment Detected %c + +%cOnly UI previews are available in the browser. For full functionality, please run the application in desktop mode. +More information at: https://v3.wails.io/learn/build/#using-a-browser-for-development +`,"background: #ffffff; color: #000000; font-weight: bold; padding: 4px 8px; border-radius: 4px; border: 2px solid #000000;","background: transparent;","color: #ffffff; font-style: italic; font-weight: bold;"),null}();function h(e){z==null||z(e)}function H(){return window._wails.environment.OS==="windows"}function W(){return!!window._wails.environment.Debug}function B(){return new MouseEvent("mousedown").buttons===0}function P(e){var t;return e.target instanceof HTMLElement?e.target:!(e.target instanceof HTMLElement)&&e.target instanceof Node&&(t=e.target.parentElement)!==null&&t!==void 0?t:document.body}document.addEventListener("DOMContentLoaded",()=>{});window.addEventListener("contextmenu",X);const N=k(_.ContextMenu),j=0;function F(e,t,n,o){N(j,{id:e,x:t,y:n,data:o})}function X(e){const t=P(e),n=window.getComputedStyle(t).getPropertyValue("--custom-contextmenu").trim();if(n){e.preventDefault();const o=window.getComputedStyle(t).getPropertyValue("--custom-contextmenu-data");F(n,e.clientX,e.clientY,o)}else Y(e,t)}function Y(e,t){if(W())return;switch(window.getComputedStyle(t).getPropertyValue("--default-contextmenu").trim()){case"show":return;case"hide":e.preventDefault();return}if(t.isContentEditable)return;const n=window.getSelection(),o=n&&n.toString().length>0;if(o)for(let i=0;i{M=e,M||(w=p=!1,l())};window.addEventListener("mousedown",D,{capture:!0});window.addEventListener("mousemove",D,{capture:!0});window.addEventListener("mouseup",D,{capture:!0});for(const e of["click","contextmenu","dblclick"])window.addEventListener(e,A,{capture:!0});function A(e){(g||p)&&(e.stopImmediatePropagation(),e.stopPropagation(),e.preventDefault())}const C=0,V=1,L=2;function D(e){let t,n=e.buttons;switch(e.type){case"mousedown":t=C,E||(n=f|1<n!==e),t.length===0?d.delete(e.eventName):d.set(e.eventName,t))}window._wails=window._wails||{};window._wails.dispatchWailsEvent=ee;k(_.Events);class ${constructor(t,n=null){this.name=t,this.data=n}}function ee(e){let t=d.get(e.name);if(!t)return;let n=new $(e.name,e.data);"sender"in e&&(n.sender=e.sender),t=t.filter(o=>!o.dispatch(n)),t.length===0?d.delete(e.name):d.set(e.name,t)}function te(e,t,n){let o=d.get(e)||[];const i=new Q(e,t,n);return o.push(i),d.set(e,o),()=>Z(i)}function ne(e,t){return te(e,t,-1)}window._wails=window._wails||{};window._wails.invoke=h;h("wails:runtime:ready");document.addEventListener("DOMContentLoaded",()=>{const e=document.getElementById("app");e?e.innerHTML=` +
      +

      Custom Protocol / Deep Link Test

      +

      + This page demonstrates handling custom URL schemes (deep links). +

      +

      + Example Link: + Try opening this URL (e.g., by pasting it into your browser's address bar or using open your-app-scheme://... in terminal): +
      + wailsexample://test/path?value=123&message=hello +

      + +
      + Received URL: +
      Waiting for application to be opened via a custom URL...
      +
      +
      + `:console.error('Element with ID "app" not found.')});ne("frontend:ShowURL",e=>{console.log("frontend:ShowURL event received, data:",e),displayUrl(e.data)});window.displayUrl=function(e){const t=document.getElementById("received-url");t?t.textContent=e||"No URL received or an error occurred.":console.error("Element with ID 'received-url' not found in displayUrl.")}; diff --git a/v3/examples/custom-protocol-example/frontend/dist/assets/index-uDrhEpT0.css b/v3/examples/custom-protocol-example/frontend/dist/assets/index-uDrhEpT0.css new file mode 100644 index 000000000..37a5c205c --- /dev/null +++ b/v3/examples/custom-protocol-example/frontend/dist/assets/index-uDrhEpT0.css @@ -0,0 +1 @@ +:root{font-family:system-ui,Avenir,Helvetica,Arial,sans-serif;line-height:1.5;font-weight:400;color-scheme:light dark;color:#ffffffde;background-color:#242424;font-synthesis:none;text-rendering:optimizeLegibility;-webkit-font-smoothing:antialiased;-moz-osx-font-smoothing:grayscale}a{font-weight:500;color:#646cff;text-decoration:inherit}a:hover{color:#535bf2}body{font-family:system-ui,-apple-system,BlinkMacSystemFont,Segoe UI,Roboto,Oxygen,Ubuntu,Cantarell,Open Sans,Helvetica Neue,sans-serif;margin:0;background-color:#f7f7f7;color:#333;display:flex;justify-content:center;align-items:center;min-height:100vh;padding:20px;box-sizing:border-box}h1{color:#0056b3;font-size:1.8em;margin-bottom:.8em}#app{width:100%;max-width:600px;margin:auto}.container{background-color:#fff;padding:25px 30px;border-radius:8px;box-shadow:0 2px 10px #0000001a;text-align:left}p{line-height:1.6;font-size:1em;margin-bottom:1em}a{color:#007bff;text-decoration:none}a:hover{text-decoration:underline}.url-display{margin-top:25px;padding:15px;background-color:#e9ecef;border:1px solid #ced4da;border-radius:4px;font-family:Courier New,Courier,monospace;font-size:.95em;word-break:break-all}.label{font-weight:700;display:block;margin-bottom:8px;color:#495057}.logo{height:6em;padding:1.5em;will-change:filter;transition:filter .3s}.logo:hover{filter:drop-shadow(0 0 2em #646cffaa)}.logo.vanilla:hover{filter:drop-shadow(0 0 2em #f7df1eaa)}.card{padding:2em}.read-the-docs{color:#888}button{border-radius:8px;border:1px solid transparent;padding:.6em 1.2em;font-size:1em;font-weight:500;font-family:inherit;background-color:#1a1a1a;cursor:pointer;transition:border-color .25s}button:hover{border-color:#646cff}button:focus,button:focus-visible{outline:4px auto -webkit-focus-ring-color}@media (prefers-color-scheme: light){:root{color:#213547;background-color:#fff}a:hover{color:#747bff}button{background-color:#f9f9f9}} diff --git a/v3/examples/custom-protocol-example/frontend/dist/index.html b/v3/examples/custom-protocol-example/frontend/dist/index.html new file mode 100644 index 000000000..126962c69 --- /dev/null +++ b/v3/examples/custom-protocol-example/frontend/dist/index.html @@ -0,0 +1,14 @@ + + + + + + + Vite App + + + + +
      + + diff --git a/v3/examples/custom-protocol-example/frontend/dist/vite.svg b/v3/examples/custom-protocol-example/frontend/dist/vite.svg new file mode 100644 index 000000000..e7b8dfb1b --- /dev/null +++ b/v3/examples/custom-protocol-example/frontend/dist/vite.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/v3/examples/custom-protocol-example/frontend/index.html b/v3/examples/custom-protocol-example/frontend/index.html new file mode 100644 index 000000000..72ba3a8b3 --- /dev/null +++ b/v3/examples/custom-protocol-example/frontend/index.html @@ -0,0 +1,13 @@ + + + + + + + Vite App + + +
      + + + diff --git a/v3/examples/custom-protocol-example/frontend/package-lock.json b/v3/examples/custom-protocol-example/frontend/package-lock.json new file mode 100644 index 000000000..2b2b28cc5 --- /dev/null +++ b/v3/examples/custom-protocol-example/frontend/package-lock.json @@ -0,0 +1,1017 @@ +{ + "name": "frontend", + "version": "0.0.0", + "lockfileVersion": 3, + "requires": true, + "packages": { + "": { + "name": "frontend", + "version": "0.0.0", + "dependencies": { + "@wailsio/runtime": "^3.0.0-alpha.66" + }, + "devDependencies": { + "vite": "^6.3.5" + } + }, + "node_modules/@esbuild/aix-ppc64": { + "version": "0.25.4", + "resolved": "https://registry.npmjs.org/@esbuild/aix-ppc64/-/aix-ppc64-0.25.4.tgz", + "integrity": "sha512-1VCICWypeQKhVbE9oW/sJaAmjLxhVqacdkvPLEjwlttjfwENRSClS8EjBz0KzRyFSCPDIkuXW34Je/vk7zdB7Q==", + "cpu": [ + "ppc64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "aix" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/android-arm": { + "version": "0.25.4", + "resolved": "https://registry.npmjs.org/@esbuild/android-arm/-/android-arm-0.25.4.tgz", + "integrity": "sha512-QNdQEps7DfFwE3hXiU4BZeOV68HHzYwGd0Nthhd3uCkkEKK7/R6MTgM0P7H7FAs5pU/DIWsviMmEGxEoxIZ+ZQ==", + "cpu": [ + "arm" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "android" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/android-arm64": { + "version": "0.25.4", + "resolved": "https://registry.npmjs.org/@esbuild/android-arm64/-/android-arm64-0.25.4.tgz", + "integrity": "sha512-bBy69pgfhMGtCnwpC/x5QhfxAz/cBgQ9enbtwjf6V9lnPI/hMyT9iWpR1arm0l3kttTr4L0KSLpKmLp/ilKS9A==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "android" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/android-x64": { + "version": "0.25.4", + "resolved": "https://registry.npmjs.org/@esbuild/android-x64/-/android-x64-0.25.4.tgz", + "integrity": "sha512-TVhdVtQIFuVpIIR282btcGC2oGQoSfZfmBdTip2anCaVYcqWlZXGcdcKIUklfX2wj0JklNYgz39OBqh2cqXvcQ==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "android" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/darwin-arm64": { + "version": "0.25.4", + "resolved": "https://registry.npmjs.org/@esbuild/darwin-arm64/-/darwin-arm64-0.25.4.tgz", + "integrity": "sha512-Y1giCfM4nlHDWEfSckMzeWNdQS31BQGs9/rouw6Ub91tkK79aIMTH3q9xHvzH8d0wDru5Ci0kWB8b3up/nl16g==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "darwin" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/darwin-x64": { + "version": "0.25.4", + "resolved": "https://registry.npmjs.org/@esbuild/darwin-x64/-/darwin-x64-0.25.4.tgz", + "integrity": "sha512-CJsry8ZGM5VFVeyUYB3cdKpd/H69PYez4eJh1W/t38vzutdjEjtP7hB6eLKBoOdxcAlCtEYHzQ/PJ/oU9I4u0A==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "darwin" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/freebsd-arm64": { + "version": "0.25.4", + "resolved": "https://registry.npmjs.org/@esbuild/freebsd-arm64/-/freebsd-arm64-0.25.4.tgz", + "integrity": "sha512-yYq+39NlTRzU2XmoPW4l5Ifpl9fqSk0nAJYM/V/WUGPEFfek1epLHJIkTQM6bBs1swApjO5nWgvr843g6TjxuQ==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "freebsd" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/freebsd-x64": { + "version": "0.25.4", + "resolved": "https://registry.npmjs.org/@esbuild/freebsd-x64/-/freebsd-x64-0.25.4.tgz", + "integrity": "sha512-0FgvOJ6UUMflsHSPLzdfDnnBBVoCDtBTVyn/MrWloUNvq/5SFmh13l3dvgRPkDihRxb77Y17MbqbCAa2strMQQ==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "freebsd" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/linux-arm": { + "version": "0.25.4", + "resolved": "https://registry.npmjs.org/@esbuild/linux-arm/-/linux-arm-0.25.4.tgz", + "integrity": "sha512-kro4c0P85GMfFYqW4TWOpvmF8rFShbWGnrLqlzp4X1TNWjRY3JMYUfDCtOxPKOIY8B0WC8HN51hGP4I4hz4AaQ==", + "cpu": [ + "arm" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/linux-arm64": { + "version": "0.25.4", + "resolved": "https://registry.npmjs.org/@esbuild/linux-arm64/-/linux-arm64-0.25.4.tgz", + "integrity": "sha512-+89UsQTfXdmjIvZS6nUnOOLoXnkUTB9hR5QAeLrQdzOSWZvNSAXAtcRDHWtqAUtAmv7ZM1WPOOeSxDzzzMogiQ==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/linux-ia32": { + "version": "0.25.4", + "resolved": "https://registry.npmjs.org/@esbuild/linux-ia32/-/linux-ia32-0.25.4.tgz", + "integrity": "sha512-yTEjoapy8UP3rv8dB0ip3AfMpRbyhSN3+hY8mo/i4QXFeDxmiYbEKp3ZRjBKcOP862Ua4b1PDfwlvbuwY7hIGQ==", + "cpu": [ + "ia32" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/linux-loong64": { + "version": "0.25.4", + "resolved": "https://registry.npmjs.org/@esbuild/linux-loong64/-/linux-loong64-0.25.4.tgz", + "integrity": "sha512-NeqqYkrcGzFwi6CGRGNMOjWGGSYOpqwCjS9fvaUlX5s3zwOtn1qwg1s2iE2svBe4Q/YOG1q6875lcAoQK/F4VA==", + "cpu": [ + "loong64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/linux-mips64el": { + "version": "0.25.4", + "resolved": "https://registry.npmjs.org/@esbuild/linux-mips64el/-/linux-mips64el-0.25.4.tgz", + "integrity": "sha512-IcvTlF9dtLrfL/M8WgNI/qJYBENP3ekgsHbYUIzEzq5XJzzVEV/fXY9WFPfEEXmu3ck2qJP8LG/p3Q8f7Zc2Xg==", + "cpu": [ + "mips64el" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/linux-ppc64": { + "version": "0.25.4", + "resolved": "https://registry.npmjs.org/@esbuild/linux-ppc64/-/linux-ppc64-0.25.4.tgz", + "integrity": "sha512-HOy0aLTJTVtoTeGZh4HSXaO6M95qu4k5lJcH4gxv56iaycfz1S8GO/5Jh6X4Y1YiI0h7cRyLi+HixMR+88swag==", + "cpu": [ + "ppc64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/linux-riscv64": { + "version": "0.25.4", + "resolved": "https://registry.npmjs.org/@esbuild/linux-riscv64/-/linux-riscv64-0.25.4.tgz", + "integrity": "sha512-i8JUDAufpz9jOzo4yIShCTcXzS07vEgWzyX3NH2G7LEFVgrLEhjwL3ajFE4fZI3I4ZgiM7JH3GQ7ReObROvSUA==", + "cpu": [ + "riscv64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/linux-s390x": { + "version": "0.25.4", + "resolved": "https://registry.npmjs.org/@esbuild/linux-s390x/-/linux-s390x-0.25.4.tgz", + "integrity": "sha512-jFnu+6UbLlzIjPQpWCNh5QtrcNfMLjgIavnwPQAfoGx4q17ocOU9MsQ2QVvFxwQoWpZT8DvTLooTvmOQXkO51g==", + "cpu": [ + "s390x" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/linux-x64": { + "version": "0.25.4", + "resolved": "https://registry.npmjs.org/@esbuild/linux-x64/-/linux-x64-0.25.4.tgz", + "integrity": "sha512-6e0cvXwzOnVWJHq+mskP8DNSrKBr1bULBvnFLpc1KY+d+irZSgZ02TGse5FsafKS5jg2e4pbvK6TPXaF/A6+CA==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/netbsd-arm64": { + "version": "0.25.4", + "resolved": "https://registry.npmjs.org/@esbuild/netbsd-arm64/-/netbsd-arm64-0.25.4.tgz", + "integrity": "sha512-vUnkBYxZW4hL/ie91hSqaSNjulOnYXE1VSLusnvHg2u3jewJBz3YzB9+oCw8DABeVqZGg94t9tyZFoHma8gWZQ==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "netbsd" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/netbsd-x64": { + "version": "0.25.4", + "resolved": "https://registry.npmjs.org/@esbuild/netbsd-x64/-/netbsd-x64-0.25.4.tgz", + "integrity": "sha512-XAg8pIQn5CzhOB8odIcAm42QsOfa98SBeKUdo4xa8OvX8LbMZqEtgeWE9P/Wxt7MlG2QqvjGths+nq48TrUiKw==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "netbsd" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/openbsd-arm64": { + "version": "0.25.4", + "resolved": "https://registry.npmjs.org/@esbuild/openbsd-arm64/-/openbsd-arm64-0.25.4.tgz", + "integrity": "sha512-Ct2WcFEANlFDtp1nVAXSNBPDxyU+j7+tId//iHXU2f/lN5AmO4zLyhDcpR5Cz1r08mVxzt3Jpyt4PmXQ1O6+7A==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "openbsd" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/openbsd-x64": { + "version": "0.25.4", + "resolved": "https://registry.npmjs.org/@esbuild/openbsd-x64/-/openbsd-x64-0.25.4.tgz", + "integrity": "sha512-xAGGhyOQ9Otm1Xu8NT1ifGLnA6M3sJxZ6ixylb+vIUVzvvd6GOALpwQrYrtlPouMqd/vSbgehz6HaVk4+7Afhw==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "openbsd" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/sunos-x64": { + "version": "0.25.4", + "resolved": "https://registry.npmjs.org/@esbuild/sunos-x64/-/sunos-x64-0.25.4.tgz", + "integrity": "sha512-Mw+tzy4pp6wZEK0+Lwr76pWLjrtjmJyUB23tHKqEDP74R3q95luY/bXqXZeYl4NYlvwOqoRKlInQialgCKy67Q==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "sunos" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/win32-arm64": { + "version": "0.25.4", + "resolved": "https://registry.npmjs.org/@esbuild/win32-arm64/-/win32-arm64-0.25.4.tgz", + "integrity": "sha512-AVUP428VQTSddguz9dO9ngb+E5aScyg7nOeJDrF1HPYu555gmza3bDGMPhmVXL8svDSoqPCsCPjb265yG/kLKQ==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "win32" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/win32-ia32": { + "version": "0.25.4", + "resolved": "https://registry.npmjs.org/@esbuild/win32-ia32/-/win32-ia32-0.25.4.tgz", + "integrity": "sha512-i1sW+1i+oWvQzSgfRcxxG2k4I9n3O9NRqy8U+uugaT2Dy7kLO9Y7wI72haOahxceMX8hZAzgGou1FhndRldxRg==", + "cpu": [ + "ia32" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "win32" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/win32-x64": { + "version": "0.25.4", + "resolved": "https://registry.npmjs.org/@esbuild/win32-x64/-/win32-x64-0.25.4.tgz", + "integrity": "sha512-nOT2vZNw6hJ+z43oP1SPea/G/6AbN6X+bGNhNuq8NtRHy4wsMhw765IKLNmnjek7GvjWBYQ8Q5VBoYTFg9y1UQ==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "win32" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@rollup/rollup-android-arm-eabi": { + "version": "4.41.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-android-arm-eabi/-/rollup-android-arm-eabi-4.41.0.tgz", + "integrity": "sha512-KxN+zCjOYHGwCl4UCtSfZ6jrq/qi88JDUtiEFk8LELEHq2Egfc/FgW+jItZiOLRuQfb/3xJSgFuNPC9jzggX+A==", + "cpu": [ + "arm" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "android" + ] + }, + "node_modules/@rollup/rollup-android-arm64": { + "version": "4.41.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-android-arm64/-/rollup-android-arm64-4.41.0.tgz", + "integrity": "sha512-yDvqx3lWlcugozax3DItKJI5j05B0d4Kvnjx+5mwiUpWramVvmAByYigMplaoAQ3pvdprGCTCE03eduqE/8mPQ==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "android" + ] + }, + "node_modules/@rollup/rollup-darwin-arm64": { + "version": "4.41.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-darwin-arm64/-/rollup-darwin-arm64-4.41.0.tgz", + "integrity": "sha512-2KOU574vD3gzcPSjxO0eyR5iWlnxxtmW1F5CkNOHmMlueKNCQkxR6+ekgWyVnz6zaZihpUNkGxjsYrkTJKhkaw==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "darwin" + ] + }, + "node_modules/@rollup/rollup-darwin-x64": { + "version": "4.41.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-darwin-x64/-/rollup-darwin-x64-4.41.0.tgz", + "integrity": "sha512-gE5ACNSxHcEZyP2BA9TuTakfZvULEW4YAOtxl/A/YDbIir/wPKukde0BNPlnBiP88ecaN4BJI2TtAd+HKuZPQQ==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "darwin" + ] + }, + "node_modules/@rollup/rollup-freebsd-arm64": { + "version": "4.41.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-freebsd-arm64/-/rollup-freebsd-arm64-4.41.0.tgz", + "integrity": "sha512-GSxU6r5HnWij7FoSo7cZg3l5GPg4HFLkzsFFh0N/b16q5buW1NAWuCJ+HMtIdUEi6XF0qH+hN0TEd78laRp7Dg==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "freebsd" + ] + }, + "node_modules/@rollup/rollup-freebsd-x64": { + "version": "4.41.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-freebsd-x64/-/rollup-freebsd-x64-4.41.0.tgz", + "integrity": "sha512-KGiGKGDg8qLRyOWmk6IeiHJzsN/OYxO6nSbT0Vj4MwjS2XQy/5emsmtoqLAabqrohbgLWJ5GV3s/ljdrIr8Qjg==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "freebsd" + ] + }, + "node_modules/@rollup/rollup-linux-arm-gnueabihf": { + "version": "4.41.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm-gnueabihf/-/rollup-linux-arm-gnueabihf-4.41.0.tgz", + "integrity": "sha512-46OzWeqEVQyX3N2/QdiU/CMXYDH/lSHpgfBkuhl3igpZiaB3ZIfSjKuOnybFVBQzjsLwkus2mjaESy8H41SzvA==", + "cpu": [ + "arm" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-arm-musleabihf": { + "version": "4.41.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm-musleabihf/-/rollup-linux-arm-musleabihf-4.41.0.tgz", + "integrity": "sha512-lfgW3KtQP4YauqdPpcUZHPcqQXmTmH4nYU0cplNeW583CMkAGjtImw4PKli09NFi2iQgChk4e9erkwlfYem6Lg==", + "cpu": [ + "arm" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-arm64-gnu": { + "version": "4.41.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm64-gnu/-/rollup-linux-arm64-gnu-4.41.0.tgz", + "integrity": "sha512-nn8mEyzMbdEJzT7cwxgObuwviMx6kPRxzYiOl6o/o+ChQq23gfdlZcUNnt89lPhhz3BYsZ72rp0rxNqBSfqlqw==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-arm64-musl": { + "version": "4.41.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm64-musl/-/rollup-linux-arm64-musl-4.41.0.tgz", + "integrity": "sha512-l+QK99je2zUKGd31Gh+45c4pGDAqZSuWQiuRFCdHYC2CSiO47qUWsCcenrI6p22hvHZrDje9QjwSMAFL3iwXwQ==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-loongarch64-gnu": { + "version": "4.41.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-loongarch64-gnu/-/rollup-linux-loongarch64-gnu-4.41.0.tgz", + "integrity": "sha512-WbnJaxPv1gPIm6S8O/Wg+wfE/OzGSXlBMbOe4ie+zMyykMOeqmgD1BhPxZQuDqwUN+0T/xOFtL2RUWBspnZj3w==", + "cpu": [ + "loong64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-powerpc64le-gnu": { + "version": "4.41.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-powerpc64le-gnu/-/rollup-linux-powerpc64le-gnu-4.41.0.tgz", + "integrity": "sha512-eRDWR5t67/b2g8Q/S8XPi0YdbKcCs4WQ8vklNnUYLaSWF+Cbv2axZsp4jni6/j7eKvMLYCYdcsv8dcU+a6QNFg==", + "cpu": [ + "ppc64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-riscv64-gnu": { + "version": "4.41.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-riscv64-gnu/-/rollup-linux-riscv64-gnu-4.41.0.tgz", + "integrity": "sha512-TWrZb6GF5jsEKG7T1IHwlLMDRy2f3DPqYldmIhnA2DVqvvhY2Ai184vZGgahRrg8k9UBWoSlHv+suRfTN7Ua4A==", + "cpu": [ + "riscv64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-riscv64-musl": { + "version": "4.41.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-riscv64-musl/-/rollup-linux-riscv64-musl-4.41.0.tgz", + "integrity": "sha512-ieQljaZKuJpmWvd8gW87ZmSFwid6AxMDk5bhONJ57U8zT77zpZ/TPKkU9HpnnFrM4zsgr4kiGuzbIbZTGi7u9A==", + "cpu": [ + "riscv64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-s390x-gnu": { + "version": "4.41.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-s390x-gnu/-/rollup-linux-s390x-gnu-4.41.0.tgz", + "integrity": "sha512-/L3pW48SxrWAlVsKCN0dGLB2bi8Nv8pr5S5ocSM+S0XCn5RCVCXqi8GVtHFsOBBCSeR+u9brV2zno5+mg3S4Aw==", + "cpu": [ + "s390x" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-x64-gnu": { + "version": "4.41.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-x64-gnu/-/rollup-linux-x64-gnu-4.41.0.tgz", + "integrity": "sha512-XMLeKjyH8NsEDCRptf6LO8lJk23o9wvB+dJwcXMaH6ZQbbkHu2dbGIUindbMtRN6ux1xKi16iXWu6q9mu7gDhQ==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-x64-musl": { + "version": "4.41.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-x64-musl/-/rollup-linux-x64-musl-4.41.0.tgz", + "integrity": "sha512-m/P7LycHZTvSQeXhFmgmdqEiTqSV80zn6xHaQ1JSqwCtD1YGtwEK515Qmy9DcB2HK4dOUVypQxvhVSy06cJPEg==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-win32-arm64-msvc": { + "version": "4.41.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-win32-arm64-msvc/-/rollup-win32-arm64-msvc-4.41.0.tgz", + "integrity": "sha512-4yodtcOrFHpbomJGVEqZ8fzD4kfBeCbpsUy5Pqk4RluXOdsWdjLnjhiKy2w3qzcASWd04fp52Xz7JKarVJ5BTg==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "win32" + ] + }, + "node_modules/@rollup/rollup-win32-ia32-msvc": { + "version": "4.41.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-win32-ia32-msvc/-/rollup-win32-ia32-msvc-4.41.0.tgz", + "integrity": "sha512-tmazCrAsKzdkXssEc65zIE1oC6xPHwfy9d5Ta25SRCDOZS+I6RypVVShWALNuU9bxIfGA0aqrmzlzoM5wO5SPQ==", + "cpu": [ + "ia32" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "win32" + ] + }, + "node_modules/@rollup/rollup-win32-x64-msvc": { + "version": "4.41.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-win32-x64-msvc/-/rollup-win32-x64-msvc-4.41.0.tgz", + "integrity": "sha512-h1J+Yzjo/X+0EAvR2kIXJDuTuyT7drc+t2ALY0nIcGPbTatNOf0VWdhEA2Z4AAjv6X1NJV7SYo5oCTYRJhSlVA==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "win32" + ] + }, + "node_modules/@types/estree": { + "version": "1.0.7", + "resolved": "https://registry.npmjs.org/@types/estree/-/estree-1.0.7.tgz", + "integrity": "sha512-w28IoSUCJpidD/TGviZwwMJckNESJZXFu7NBZ5YJ4mEUnNraUn9Pm8HSZm/jDF1pDWYKspWE7oVphigUPRakIQ==", + "dev": true, + "license": "MIT" + }, + "node_modules/@wailsio/runtime": { + "version": "3.0.0-alpha.66", + "resolved": "https://registry.npmjs.org/@wailsio/runtime/-/runtime-3.0.0-alpha.66.tgz", + "integrity": "sha512-ENLu8rn1griL1gFHJqkq1i+BVxrrA0JPJHYneUJYuf/s54kjuQViW0RKDEe/WTDo56ABpfykrd/T8OYpPUyXUw==", + "license": "MIT" + }, + "node_modules/esbuild": { + "version": "0.25.4", + "resolved": "https://registry.npmjs.org/esbuild/-/esbuild-0.25.4.tgz", + "integrity": "sha512-8pgjLUcUjcgDg+2Q4NYXnPbo/vncAY4UmyaCm0jZevERqCHZIaWwdJHkf8XQtu4AxSKCdvrUbT0XUr1IdZzI8Q==", + "dev": true, + "hasInstallScript": true, + "license": "MIT", + "bin": { + "esbuild": "bin/esbuild" + }, + "engines": { + "node": ">=18" + }, + "optionalDependencies": { + "@esbuild/aix-ppc64": "0.25.4", + "@esbuild/android-arm": "0.25.4", + "@esbuild/android-arm64": "0.25.4", + "@esbuild/android-x64": "0.25.4", + "@esbuild/darwin-arm64": "0.25.4", + "@esbuild/darwin-x64": "0.25.4", + "@esbuild/freebsd-arm64": "0.25.4", + "@esbuild/freebsd-x64": "0.25.4", + "@esbuild/linux-arm": "0.25.4", + "@esbuild/linux-arm64": "0.25.4", + "@esbuild/linux-ia32": "0.25.4", + "@esbuild/linux-loong64": "0.25.4", + "@esbuild/linux-mips64el": "0.25.4", + "@esbuild/linux-ppc64": "0.25.4", + "@esbuild/linux-riscv64": "0.25.4", + "@esbuild/linux-s390x": "0.25.4", + "@esbuild/linux-x64": "0.25.4", + "@esbuild/netbsd-arm64": "0.25.4", + "@esbuild/netbsd-x64": "0.25.4", + "@esbuild/openbsd-arm64": "0.25.4", + "@esbuild/openbsd-x64": "0.25.4", + "@esbuild/sunos-x64": "0.25.4", + "@esbuild/win32-arm64": "0.25.4", + "@esbuild/win32-ia32": "0.25.4", + "@esbuild/win32-x64": "0.25.4" + } + }, + "node_modules/fdir": { + "version": "6.4.4", + "resolved": "https://registry.npmjs.org/fdir/-/fdir-6.4.4.tgz", + "integrity": "sha512-1NZP+GK4GfuAv3PqKvxQRDMjdSRZjnkq7KfhlNrCNNlZ0ygQFpebfrnfnq/W7fpUnAv9aGWmY1zKx7FYL3gwhg==", + "dev": true, + "license": "MIT", + "peerDependencies": { + "picomatch": "^3 || ^4" + }, + "peerDependenciesMeta": { + "picomatch": { + "optional": true + } + } + }, + "node_modules/fsevents": { + "version": "2.3.3", + "resolved": "https://registry.npmjs.org/fsevents/-/fsevents-2.3.3.tgz", + "integrity": "sha512-5xoDfX+fL7faATnagmWPpbFtwh/R77WmMMqqHGS65C3vvB0YHrgF+B1YmZ3441tMj5n63k0212XNoJwzlhffQw==", + "dev": true, + "hasInstallScript": true, + "license": "MIT", + "optional": true, + "os": [ + "darwin" + ], + "engines": { + "node": "^8.16.0 || ^10.6.0 || >=11.0.0" + } + }, + "node_modules/nanoid": { + "version": "3.3.11", + "resolved": "https://registry.npmjs.org/nanoid/-/nanoid-3.3.11.tgz", + "integrity": "sha512-N8SpfPUnUp1bK+PMYW8qSWdl9U+wwNWI4QKxOYDy9JAro3WMX7p2OeVRF9v+347pnakNevPmiHhNmZ2HbFA76w==", + "dev": true, + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/ai" + } + ], + "license": "MIT", + "bin": { + "nanoid": "bin/nanoid.cjs" + }, + "engines": { + "node": "^10 || ^12 || ^13.7 || ^14 || >=15.0.1" + } + }, + "node_modules/picocolors": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/picocolors/-/picocolors-1.1.1.tgz", + "integrity": "sha512-xceH2snhtb5M9liqDsmEw56le376mTZkEX/jEb/RxNFyegNul7eNslCXP9FDj/Lcu0X8KEyMceP2ntpaHrDEVA==", + "dev": true, + "license": "ISC" + }, + "node_modules/picomatch": { + "version": "4.0.2", + "resolved": "https://registry.npmjs.org/picomatch/-/picomatch-4.0.2.tgz", + "integrity": "sha512-M7BAV6Rlcy5u+m6oPhAPFgJTzAioX/6B0DxyvDlo9l8+T3nLKbrczg2WLUyzd45L8RqfUMyGPzekbMvX2Ldkwg==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/sponsors/jonschlinkert" + } + }, + "node_modules/postcss": { + "version": "8.5.3", + "resolved": "https://registry.npmjs.org/postcss/-/postcss-8.5.3.tgz", + "integrity": "sha512-dle9A3yYxlBSrt8Fu+IpjGT8SY8hN0mlaA6GY8t0P5PjIOZemULz/E2Bnm/2dcUOena75OTNkHI76uZBNUUq3A==", + "dev": true, + "funding": [ + { + "type": "opencollective", + "url": "https://opencollective.com/postcss/" + }, + { + "type": "tidelift", + "url": "https://tidelift.com/funding/github/npm/postcss" + }, + { + "type": "github", + "url": "https://github.com/sponsors/ai" + } + ], + "license": "MIT", + "dependencies": { + "nanoid": "^3.3.8", + "picocolors": "^1.1.1", + "source-map-js": "^1.2.1" + }, + "engines": { + "node": "^10 || ^12 || >=14" + } + }, + "node_modules/rollup": { + "version": "4.41.0", + "resolved": "https://registry.npmjs.org/rollup/-/rollup-4.41.0.tgz", + "integrity": "sha512-HqMFpUbWlf/tvcxBFNKnJyzc7Lk+XO3FGc3pbNBLqEbOz0gPLRgcrlS3UF4MfUrVlstOaP/q0kM6GVvi+LrLRg==", + "dev": true, + "license": "MIT", + "dependencies": { + "@types/estree": "1.0.7" + }, + "bin": { + "rollup": "dist/bin/rollup" + }, + "engines": { + "node": ">=18.0.0", + "npm": ">=8.0.0" + }, + "optionalDependencies": { + "@rollup/rollup-android-arm-eabi": "4.41.0", + "@rollup/rollup-android-arm64": "4.41.0", + "@rollup/rollup-darwin-arm64": "4.41.0", + "@rollup/rollup-darwin-x64": "4.41.0", + "@rollup/rollup-freebsd-arm64": "4.41.0", + "@rollup/rollup-freebsd-x64": "4.41.0", + "@rollup/rollup-linux-arm-gnueabihf": "4.41.0", + "@rollup/rollup-linux-arm-musleabihf": "4.41.0", + "@rollup/rollup-linux-arm64-gnu": "4.41.0", + "@rollup/rollup-linux-arm64-musl": "4.41.0", + "@rollup/rollup-linux-loongarch64-gnu": "4.41.0", + "@rollup/rollup-linux-powerpc64le-gnu": "4.41.0", + "@rollup/rollup-linux-riscv64-gnu": "4.41.0", + "@rollup/rollup-linux-riscv64-musl": "4.41.0", + "@rollup/rollup-linux-s390x-gnu": "4.41.0", + "@rollup/rollup-linux-x64-gnu": "4.41.0", + "@rollup/rollup-linux-x64-musl": "4.41.0", + "@rollup/rollup-win32-arm64-msvc": "4.41.0", + "@rollup/rollup-win32-ia32-msvc": "4.41.0", + "@rollup/rollup-win32-x64-msvc": "4.41.0", + "fsevents": "~2.3.2" + } + }, + "node_modules/source-map-js": { + "version": "1.2.1", + "resolved": "https://registry.npmjs.org/source-map-js/-/source-map-js-1.2.1.tgz", + "integrity": "sha512-UXWMKhLOwVKb728IUtQPXxfYU+usdybtUrK/8uGE8CQMvrhOpwvzDBwj0QhSL7MQc7vIsISBG8VQ8+IDQxpfQA==", + "dev": true, + "license": "BSD-3-Clause", + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/tinyglobby": { + "version": "0.2.13", + "resolved": "https://registry.npmjs.org/tinyglobby/-/tinyglobby-0.2.13.tgz", + "integrity": "sha512-mEwzpUgrLySlveBwEVDMKk5B57bhLPYovRfPAXD5gA/98Opn0rCDj3GtLwFvCvH5RK9uPCExUROW5NjDwvqkxw==", + "dev": true, + "license": "MIT", + "dependencies": { + "fdir": "^6.4.4", + "picomatch": "^4.0.2" + }, + "engines": { + "node": ">=12.0.0" + }, + "funding": { + "url": "https://github.com/sponsors/SuperchupuDev" + } + }, + "node_modules/vite": { + "version": "6.3.5", + "resolved": "https://registry.npmjs.org/vite/-/vite-6.3.5.tgz", + "integrity": "sha512-cZn6NDFE7wdTpINgs++ZJ4N49W2vRp8LCKrn3Ob1kYNtOo21vfDoaV5GzBfLU4MovSAB8uNRm4jgzVQZ+mBzPQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "esbuild": "^0.25.0", + "fdir": "^6.4.4", + "picomatch": "^4.0.2", + "postcss": "^8.5.3", + "rollup": "^4.34.9", + "tinyglobby": "^0.2.13" + }, + "bin": { + "vite": "bin/vite.js" + }, + "engines": { + "node": "^18.0.0 || ^20.0.0 || >=22.0.0" + }, + "funding": { + "url": "https://github.com/vitejs/vite?sponsor=1" + }, + "optionalDependencies": { + "fsevents": "~2.3.3" + }, + "peerDependencies": { + "@types/node": "^18.0.0 || ^20.0.0 || >=22.0.0", + "jiti": ">=1.21.0", + "less": "*", + "lightningcss": "^1.21.0", + "sass": "*", + "sass-embedded": "*", + "stylus": "*", + "sugarss": "*", + "terser": "^5.16.0", + "tsx": "^4.8.1", + "yaml": "^2.4.2" + }, + "peerDependenciesMeta": { + "@types/node": { + "optional": true + }, + "jiti": { + "optional": true + }, + "less": { + "optional": true + }, + "lightningcss": { + "optional": true + }, + "sass": { + "optional": true + }, + "sass-embedded": { + "optional": true + }, + "stylus": { + "optional": true + }, + "sugarss": { + "optional": true + }, + "terser": { + "optional": true + }, + "tsx": { + "optional": true + }, + "yaml": { + "optional": true + } + } + } + } +} diff --git a/v3/examples/custom-protocol-example/frontend/package.json b/v3/examples/custom-protocol-example/frontend/package.json new file mode 100644 index 000000000..09086988e --- /dev/null +++ b/v3/examples/custom-protocol-example/frontend/package.json @@ -0,0 +1,17 @@ +{ + "name": "frontend", + "private": true, + "version": "0.0.0", + "type": "module", + "scripts": { + "dev": "vite", + "build": "vite build", + "preview": "vite preview" + }, + "devDependencies": { + "vite": "^6.3.5" + }, + "dependencies": { + "@wailsio/runtime": "latest" + } +} diff --git a/v3/examples/custom-protocol-example/frontend/public/vite.svg b/v3/examples/custom-protocol-example/frontend/public/vite.svg new file mode 100644 index 000000000..e7b8dfb1b --- /dev/null +++ b/v3/examples/custom-protocol-example/frontend/public/vite.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/v3/examples/custom-protocol-example/frontend/src/counter.js b/v3/examples/custom-protocol-example/frontend/src/counter.js new file mode 100644 index 000000000..881e2d7ad --- /dev/null +++ b/v3/examples/custom-protocol-example/frontend/src/counter.js @@ -0,0 +1,9 @@ +export function setupCounter(element) { + let counter = 0 + const setCounter = (count) => { + counter = count + element.innerHTML = `count is ${counter}` + } + element.addEventListener('click', () => setCounter(counter + 1)) + setCounter(0) +} diff --git a/v3/examples/custom-protocol-example/frontend/src/javascript.svg b/v3/examples/custom-protocol-example/frontend/src/javascript.svg new file mode 100644 index 000000000..f9abb2b72 --- /dev/null +++ b/v3/examples/custom-protocol-example/frontend/src/javascript.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/v3/examples/custom-protocol-example/frontend/src/main.js b/v3/examples/custom-protocol-example/frontend/src/main.js new file mode 100644 index 000000000..fd11d82fa --- /dev/null +++ b/v3/examples/custom-protocol-example/frontend/src/main.js @@ -0,0 +1,45 @@ +import './style.css' +import { Events } from '@wailsio/runtime' + +document.addEventListener('DOMContentLoaded', () => { + const appDiv = document.getElementById('app'); + if (appDiv) { + appDiv.innerHTML = ` +
      +

      Custom Protocol / Deep Link Test

      +

      + This page demonstrates handling custom URL schemes (deep links). +

      +

      + Example Link: + Try opening this URL (e.g., by pasting it into your browser's address bar or using open your-app-scheme://... in terminal): +
      + wailsexample://test/path?value=123&message=hello +

      + +
      + Received URL: +
      Waiting for application to be opened via a custom URL...
      +
      +
      + `; + } else { + console.error('Element with ID "app" not found.'); + } +}); + +// Listen for the event from Go +Events.On('frontend:ShowURL', (e) => { + console.log('frontend:ShowURL event received, data:', e); + displayUrl(e.data); +}); + +// Make displayUrl available globally just in case, though direct call from event is better +window.displayUrl = function(url) { + const urlElement = document.getElementById('received-url'); + if (urlElement) { + urlElement.textContent = url || "No URL received or an error occurred."; + } else { + console.error("Element with ID 'received-url' not found in displayUrl."); + } +} diff --git a/v3/examples/custom-protocol-example/frontend/src/style.css b/v3/examples/custom-protocol-example/frontend/src/style.css new file mode 100644 index 000000000..0fb047c33 --- /dev/null +++ b/v3/examples/custom-protocol-example/frontend/src/style.css @@ -0,0 +1,142 @@ +:root { + font-family: system-ui, Avenir, Helvetica, Arial, sans-serif; + line-height: 1.5; + font-weight: 400; + + color-scheme: light dark; + color: rgba(255, 255, 255, 0.87); + background-color: #242424; + + font-synthesis: none; + text-rendering: optimizeLegibility; + -webkit-font-smoothing: antialiased; + -moz-osx-font-smoothing: grayscale; +} + +a { + font-weight: 500; + color: #646cff; + text-decoration: inherit; +} +a:hover { + color: #535bf2; +} + +body { + font-family: system-ui, -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, Oxygen, Ubuntu, Cantarell, 'Open Sans', 'Helvetica Neue', sans-serif; + margin: 0; /* Reset default margin */ + background-color: #f7f7f7; + color: #333; + display: flex; /* Use flexbox to center content */ + justify-content: center; /* Center horizontally */ + align-items: center; /* Center vertically */ + min-height: 100vh; /* Full viewport height */ + padding: 20px; /* Add some padding around the content */ + box-sizing: border-box; /* Ensure padding doesn't expand body beyond viewport */ +} + +h1 { + color: #0056b3; + font-size: 1.8em; + margin-bottom: 0.8em; +} + +#app { + width: 100%; + max-width: 600px; + margin: auto; /* This also helps in centering if body flex isn't enough or overridden */ +} + +.container { + background-color: #fff; + padding: 25px 30px; + border-radius: 8px; + box-shadow: 0 2px 10px rgba(0,0,0,0.1); + text-align: left; +} + +p { + line-height: 1.6; + font-size: 1em; + margin-bottom: 1em; +} + +a { + color: #007bff; + text-decoration: none; +} + +a:hover { + text-decoration: underline; +} + +.url-display { + margin-top: 25px; + padding: 15px; + background-color: #e9ecef; + border: 1px solid #ced4da; + border-radius: 4px; + font-family: 'Courier New', Courier, monospace; + font-size: 0.95em; + word-break: break-all; +} + +.label { + font-weight: bold; + display: block; + margin-bottom: 8px; + color: #495057; +} + +.logo { + height: 6em; + padding: 1.5em; + will-change: filter; + transition: filter 300ms; +} +.logo:hover { + filter: drop-shadow(0 0 2em #646cffaa); +} +.logo.vanilla:hover { + filter: drop-shadow(0 0 2em #f7df1eaa); +} + +.card { + padding: 2em; +} + +.read-the-docs { + color: #888; +} + +button { + border-radius: 8px; + border: 1px solid transparent; + padding: 0.6em 1.2em; + font-size: 1em; + font-weight: 500; + font-family: inherit; + background-color: #1a1a1a; + cursor: pointer; + transition: border-color 0.25s; +} +button:hover { + border-color: #646cff; +} +button:focus, +button:focus-visible { + outline: 4px auto -webkit-focus-ring-color; +} + +@media (prefers-color-scheme: light) { + :root { + color: #213547; + background-color: #ffffff; + } + a:hover { + color: #747bff; + } + button { + background-color: #f9f9f9; + } +} diff --git a/v3/examples/custom-protocol-example/greetservice.go b/v3/examples/custom-protocol-example/greetservice.go new file mode 100644 index 000000000..8972c39cd --- /dev/null +++ b/v3/examples/custom-protocol-example/greetservice.go @@ -0,0 +1,7 @@ +package main + +type GreetService struct{} + +func (g *GreetService) Greet(name string) string { + return "Hello " + name + "!" +} diff --git a/v3/examples/custom-protocol-example/main.go b/v3/examples/custom-protocol-example/main.go new file mode 100644 index 000000000..f5c5db38b --- /dev/null +++ b/v3/examples/custom-protocol-example/main.go @@ -0,0 +1,82 @@ +package main + +import ( + "embed" + _ "embed" + "log" + "time" + + "github.com/wailsapp/wails/v3/pkg/application" + "github.com/wailsapp/wails/v3/pkg/events" +) + +// Wails uses Go's `embed` package to embed the frontend files into the binary. +// Any files in the frontend/dist folder will be embedded into the binary and +// made available to the frontend. +// See https://pkg.go.dev/embed for more information. + +//go:embed all:frontend/dist +var assets embed.FS + +// main function serves as the application's entry point. It initializes the application, creates a window, +// and starts a goroutine that emits a time-based event every second. It subsequently runs the application and +// logs any error that might occur. +func main() { + // Create a new Wails application by providing the necessary options. + // Variables 'Name' and 'Description' are for application metadata. + // 'Assets' configures the asset server with the 'FS' variable pointing to the frontend files. + // 'Bind' is a list of Go struct instances. The frontend has access to the methods of these instances. + // 'Mac' options tailor the application when running an macOS. + app := application.New(application.Options{ + Name: "custom-protocol-example", + Description: "A demo of using raw HTML & CSS", + Services: []application.Service{ + application.NewService(&GreetService{}), + }, + Assets: application.AssetOptions{ + Handler: application.AssetFileServerFS(assets), + }, + Mac: application.MacOptions{ + ApplicationShouldTerminateAfterLastWindowClosed: true, + }, + }) + + // Listen for the system event indicating the app was launched with a URL + app.Event.OnApplicationEvent(events.Common.ApplicationLaunchedWithUrl, func(e *application.ApplicationEvent) { + app.Event.Emit("frontend:ShowURL", e.Context().URL()) + }) + + // Create a new window with the necessary options. + // 'Title' is the title of the window. + // 'Mac' options tailor the window when running on macOS. + // 'BackgroundColour' is the background colour of the window. + // 'URL' is the URL that will be loaded into the webview. + _ = app.Window.NewWithOptions(application.WebviewWindowOptions{ + Title: "Window 1", + Mac: application.MacWindow{ + InvisibleTitleBarHeight: 50, + Backdrop: application.MacBackdropTranslucent, + TitleBar: application.MacTitleBarHiddenInset, + }, + BackgroundColour: application.NewRGB(27, 38, 54), + URL: "/", + }) + + // Create a goroutine that emits an event containing the current time every second. + // The frontend can listen to this event and update the UI accordingly. + go func() { + for { + now := time.Now().Format(time.RFC1123) + app.Event.Emit("time", now) + time.Sleep(time.Second) + } + }() + + // Run the application. This blocks until the application has been exited. + err := app.Run() + + // If an error occurred while running the application, log it and exit. + if err != nil { + log.Fatal(err) + } +} diff --git a/v3/examples/dev/.gitignore b/v3/examples/dev/.gitignore new file mode 100644 index 000000000..c2a88322f --- /dev/null +++ b/v3/examples/dev/.gitignore @@ -0,0 +1 @@ +.task \ No newline at end of file diff --git a/v3/examples/dev/README.md b/v3/examples/dev/README.md new file mode 100644 index 000000000..5dcc421f7 --- /dev/null +++ b/v3/examples/dev/README.md @@ -0,0 +1,4 @@ +# Dev Example + +**NOTE**: This example is currently a work in progress. It is not yet ready for use. + diff --git a/v3/examples/dev/Taskfile.yml b/v3/examples/dev/Taskfile.yml new file mode 100644 index 000000000..8d2d46716 --- /dev/null +++ b/v3/examples/dev/Taskfile.yml @@ -0,0 +1,183 @@ +version: '3' + +vars: + APP_NAME: "dev{{exeExt}}" + +tasks: + + pre-build: + summary: Pre-build hooks + + post-build: + summary: Post-build hooks + + install-frontend-deps: + summary: Install frontend dependencies + dir: frontend + sources: + - package.json + - package-lock.json + generates: + - node_modules/* + preconditions: + - sh: npm version + msg: "Looks like npm isn't installed. Npm is part of the Node installer: https://nodejs.org/en/download/" + cmds: + - npm install + + build-frontend: + summary: Build the frontend project + dir: frontend + sources: + - src/* + generates: + - dist/* + deps: + - install-frontend-deps + cmds: + - npm run build + + build:darwin: + summary: Builds the application + platforms: + - darwin + cmds: + - task: pre-build + - task: build-frontend + - go build -gcflags=all="-N -l" -o bin/{{.APP_NAME}} + - task: post-build + env: + CGO_CFLAGS: "-mmacosx-version-min=10.13" + CGO_LDFLAGS: "-mmacosx-version-min=10.13" + MACOSX_DEPLOYMENT_TARGET: "10.13" + + build:backend:darwin: + summary: Builds the application + platforms: + - darwin + cmds: + - task: pre-build + - go build -gcflags=all="-N -l" -o bin/{{.APP_NAME}} + - task: post-build + env: + CGO_CFLAGS: "-mmacosx-version-min=10.13" + CGO_LDFLAGS: "-mmacosx-version-min=10.13" + MACOSX_DEPLOYMENT_TARGET: "10.13" + + build:windows: + summary: Builds the application for Windows + platforms: + - windows + cmds: + - task: pre-build + - task: build-frontend + - go build -gcflags=all="-N -l" -o bin/{{.APP_NAME}} + - task: post-build + + + build:backend:windows: + summary: Builds the backend application for Windows + platforms: + - windows + cmds: + - task: pre-build + - go build -gcflags=all="-N -l" -o bin/{{.APP_NAME}} + - task: post-build + + build: + summary: Builds the application + watch: true + sources: + - main.go + cmds: + - task: build:darwin + - task: build:windows + - task: run + + build:backend: + summary: Builds the backend application + cmds: + - task: build:backend:darwin + - task: build:backend:windows + + generate-icons: + summary: Generates Windows `.ico` and Mac `.icns` files from an image + dir: build + cmds: + # Generates both .ico and .icns files + - wails generate icons -input appicon.png + + build-app-prod-darwin: + summary: Creates a production build of the application + cmds: + - task: pre-build + - task: build-frontend + - GOOS=darwin GOARCH={{.ARCH}} go build -tags production -ldflags="-w -s" -o build/bin/{{.APP_NAME}} + - task: post-build + env: + CGO_CFLAGS: "-mmacosx-version-min=10.13" + CGO_LDFLAGS: "-mmacosx-version-min=10.13" + MACOSX_DEPLOYMENT_TARGET: "10.13" + vars: + ARCH: $GOARCH + + frontend:dev: + summary: Runs the frontend in development mode + deps: + - task: install-frontend-deps + dir: frontend + cmds: + - npm run dev + + run: + summary: Runs the application + cmds: + - ./bin/{{.APP_NAME}} + + dev: + summary: Runs the application in development mode + watch: true + preconditions: + - sh: 'wails3 tool checkport -p 5173' + msg: "Vite does not appear to be running. Please run `wails3 task frontend:dev` in another terminal." + cmds: + - task: build:backend + + create-app-bundle: + summary: Builds a `.app` bundle + cmds: + - mkdir -p {{.APP_NAME}}.app/Contents/{MacOS,Resources} + - cp build/icons.icns {{.APP_NAME}}.app/Contents/Resources + - cp build/bin/{{.APP_NAME}} {{.APP_NAME}}.app/Contents/MacOS + - cp build/Info.plist {{.APP_NAME}}.app/Contents + + package-darwin-arm64: + summary: Packages a production build of the application into a `.app` bundle + platform: darwin + deps: + - task: build-app-prod-darwin + vars: + ARCH: arm64 + - generate-icons + cmds: + - task: create-app-bundle + + generate:syso: + dir: build + platform: windows + cmds: + - wails generate syso -arch {{.ARCH}} -icon icon.ico -manifest wails.exe.manifest -info info.json + vars: + ARCH: $GOARCH + + package:windows: + summary: Packages a production build of the application into a `.exe` bundle + platform: windows + deps: + - generate-icons + cmds: + - task: generate:syso + vars: + ARCH: amd64 + - go build -tags production -ldflags="-w -s -H windowsgui" -o bin/{{.APP_NAME}}.exe + - powershell Remove-item *.syso diff --git a/v3/examples/dev/build/Info.dev.plist b/v3/examples/dev/build/Info.dev.plist new file mode 100644 index 000000000..0c0ed6032 --- /dev/null +++ b/v3/examples/dev/build/Info.dev.plist @@ -0,0 +1,32 @@ + + + + CFBundlePackageType + APPL + CFBundleName + My Product Name + CFBundleExecutable + dev + CFBundleIdentifier + com.wails.dev + CFBundleVersion + v1.0.0 + CFBundleGetInfoString + This is a comment + CFBundleShortVersionString + v1.0.0 + CFBundleIconFile + icons + LSMinimumSystemVersion + 10.13.0 + NSHighResolutionCapable + true + NSHumanReadableCopyright + (c) 2023 My Company Name + NSAppTransportSecurity + + NSAllowsLocalNetworking + + + + \ No newline at end of file diff --git a/v3/examples/dev/build/Info.plist b/v3/examples/dev/build/Info.plist new file mode 100644 index 000000000..f9ea24900 --- /dev/null +++ b/v3/examples/dev/build/Info.plist @@ -0,0 +1,27 @@ + + + + CFBundlePackageType + APPL + CFBundleName + My Product Name + CFBundleExecutable + dev + CFBundleIdentifier + com.wails.dev + CFBundleVersion + v1.0.0 + CFBundleGetInfoString + This is a comment + CFBundleShortVersionString + v1.0.0 + CFBundleIconFile + icons + LSMinimumSystemVersion + 10.13.0 + NSHighResolutionCapable + true + NSHumanReadableCopyright + (c) 2023 My Company Name + + \ No newline at end of file diff --git a/v3/examples/dev/build/appicon.png b/v3/examples/dev/build/appicon.png new file mode 100644 index 000000000..63617fe4f Binary files /dev/null and b/v3/examples/dev/build/appicon.png differ diff --git a/v3/examples/dev/build/icons.icns b/v3/examples/dev/build/icons.icns new file mode 100644 index 000000000..1b5bd4c86 Binary files /dev/null and b/v3/examples/dev/build/icons.icns differ diff --git a/v3/examples/dev/frontend/dist/assets/index-3635012e.css b/v3/examples/dev/frontend/dist/assets/index-3635012e.css new file mode 100644 index 000000000..14cfb027f --- /dev/null +++ b/v3/examples/dev/frontend/dist/assets/index-3635012e.css @@ -0,0 +1 @@ +:root{font-family:Inter,Avenir,Helvetica,Arial,sans-serif;font-size:16px;line-height:24px;font-weight:400;color-scheme:light dark;color:#ffffffde;background-color:#242424;font-synthesis:none;text-rendering:optimizeLegibility;-webkit-font-smoothing:antialiased;-moz-osx-font-smoothing:grayscale;-webkit-text-size-adjust:100%}a{font-weight:500;color:#646cff;text-decoration:inherit}a:hover{color:#535bf2}body{margin:0;display:flex;place-items:center;min-width:320px;min-height:100vh}h1{font-size:3.2em;line-height:1.1}.card{padding:2em}#app{max-width:1280px;margin:0 auto;padding:2rem;text-align:center}button{border-radius:8px;border:1px solid transparent;padding:.6em 1.2em;font-size:1em;font-weight:500;font-family:inherit;background-color:#1a1a1a;cursor:pointer;transition:border-color .25s}button:hover{border-color:#646cff}button:focus,button:focus-visible{outline:4px auto -webkit-focus-ring-color}@media (prefers-color-scheme: light){:root{color:#213547;background-color:#fff}a:hover{color:#747bff}button{background-color:#f9f9f9}}.logo.svelte-c9fbf7{height:6em;padding:1.5em;will-change:filter}.logo.svelte-c9fbf7:hover{filter:drop-shadow(0 0 2em #646cffaa)}.logo.svelte.svelte-c9fbf7:hover{filter:drop-shadow(0 0 2em #ff3e00aa)}.read-the-docs.svelte-c9fbf7{color:#888} diff --git a/v3/examples/dev/frontend/dist/assets/index-9076c63b.js b/v3/examples/dev/frontend/dist/assets/index-9076c63b.js new file mode 100644 index 000000000..e2b665b28 --- /dev/null +++ b/v3/examples/dev/frontend/dist/assets/index-9076c63b.js @@ -0,0 +1 @@ +(function(){const t=document.createElement("link").relList;if(t&&t.supports&&t.supports("modulepreload"))return;for(const o of document.querySelectorAll('link[rel="modulepreload"]'))r(o);new MutationObserver(o=>{for(const s of o)if(s.type==="childList")for(const i of s.addedNodes)i.tagName==="LINK"&&i.rel==="modulepreload"&&r(i)}).observe(document,{childList:!0,subtree:!0});function n(o){const s={};return o.integrity&&(s.integrity=o.integrity),o.referrerPolicy&&(s.referrerPolicy=o.referrerPolicy),o.crossOrigin==="use-credentials"?s.credentials="include":o.crossOrigin==="anonymous"?s.credentials="omit":s.credentials="same-origin",s}function r(o){if(o.ep)return;o.ep=!0;const s=n(o);fetch(o.href,s)}})();function v(){}function I(e){return e()}function W(){return Object.create(null)}function A(e){e.forEach(I)}function K(e){return typeof e=="function"}function F(e,t){return e!=e?t==t:e!==t||e&&typeof e=="object"||typeof e=="function"}let S;function X(e,t){return S||(S=document.createElement("a")),S.href=t,e===S.href}function Y(e){return Object.keys(e).length===0}function c(e,t){e.appendChild(t)}function V(e,t,n){e.insertBefore(t,n||null)}function M(e){e.parentNode&&e.parentNode.removeChild(e)}function a(e){return document.createElement(e)}function k(e){return document.createTextNode(e)}function w(){return k(" ")}function Z(e,t,n,r){return e.addEventListener(t,n,r),()=>e.removeEventListener(t,n,r)}function u(e,t,n){n==null?e.removeAttribute(t):e.getAttribute(t)!==n&&e.setAttribute(t,n)}function ee(e){return Array.from(e.childNodes)}function te(e,t){t=""+t,e.data!==t&&(e.data=t)}let q;function E(e){q=e}const $=[],B=[];let y=[];const H=[],ne=Promise.resolve();let j=!1;function re(){j||(j=!0,ne.then(z))}function P(e){y.push(e)}const N=new Set;let g=0;function z(){if(g!==0)return;const e=q;do{try{for(;g<$.length;){const t=$[g];g++,E(t),oe(t.$$)}}catch(t){throw $.length=0,g=0,t}for(E(null),$.length=0,g=0;B.length;)B.pop()();for(let t=0;te.indexOf(r)===-1?t.push(r):n.push(r)),n.forEach(r=>r()),y=t}const C=new Set;let ie;function D(e,t){e&&e.i&&(C.delete(e),e.i(t))}function le(e,t,n,r){if(e&&e.o){if(C.has(e))return;C.add(e),ie.c.push(()=>{C.delete(e),r&&(n&&e.d(1),r())}),e.o(t)}else r&&r()}function ce(e){e&&e.c()}function G(e,t,n,r){const{fragment:o,after_update:s}=e.$$;o&&o.m(t,n),r||P(()=>{const i=e.$$.on_mount.map(I).filter(K);e.$$.on_destroy?e.$$.on_destroy.push(...i):A(i),e.$$.on_mount=[]}),s.forEach(P)}function J(e,t){const n=e.$$;n.fragment!==null&&(se(n.after_update),A(n.on_destroy),n.fragment&&n.fragment.d(t),n.on_destroy=n.fragment=null,n.ctx=[])}function fe(e,t){e.$$.dirty[0]===-1&&($.push(e),re(),e.$$.dirty.fill(0)),e.$$.dirty[t/31|0]|=1<{const _=x.length?x[0]:d;return l.ctx&&o(l.ctx[f],l.ctx[f]=_)&&(!l.skip_bound&&l.bound[f]&&l.bound[f](_),b&&fe(e,f)),d}):[],l.update(),b=!0,A(l.before_update),l.fragment=r?r(l.ctx):!1,t.target){if(t.hydrate){const f=ee(t.target);l.fragment&&l.fragment.l(f),f.forEach(M)}else l.fragment&&l.fragment.c();t.intro&&D(e.$$.fragment),G(e,t.target,t.anchor,t.customElement),z()}E(p)}class R{$destroy(){J(this,1),this.$destroy=v}$on(t,n){if(!K(n))return v;const r=this.$$.callbacks[t]||(this.$$.callbacks[t]=[]);return r.push(n),()=>{const o=r.indexOf(n);o!==-1&&r.splice(o,1)}}$set(t){this.$$set&&!Y(t)&&(this.$$.skip_bound=!0,this.$$set(t),this.$$.skip_bound=!1)}}const ue="/assets/svelte-a39f39b7.svg";function ae(e){let t,n,r,o,s;return{c(){t=a("button"),n=k("count is "),r=k(e[0])},m(i,h){V(i,t,h),c(t,n),c(t,r),o||(s=Z(t,"click",e[1]),o=!0)},p(i,[h]){h&1&&te(r,i[0])},i:v,o:v,d(i){i&&M(t),o=!1,s()}}}function de(e,t,n){let r=0;return[r,()=>{n(0,r+=1)}]}class he extends R{constructor(t){super(),Q(this,t,de,ae,F,{})}}function pe(e){let t,n,r,o,s,i,h,p,l,b,f,d,x,_,T,L,O;return d=new he({}),{c(){t=a("main"),n=a("div"),r=a("a"),r.innerHTML='',o=w(),s=a("a"),i=a("img"),p=w(),l=a("h1"),l.textContent="Wails + Svelte",b=w(),f=a("div"),ce(d.$$.fragment),x=w(),_=a("p"),_.innerHTML='Check out SvelteKit, the official Svelte app framework powered by Vite!',T=w(),L=a("p"),L.textContent="Click on the Wails and Svelte logos to learn more",u(r,"href","https://wails.io"),u(r,"target","_blank"),u(r,"rel","noreferrer"),X(i.src,h=ue)||u(i,"src",h),u(i,"class","logo svelte svelte-c9fbf7"),u(i,"alt","Svelte Logo"),u(s,"href","https://svelte.dev"),u(s,"target","_blank"),u(s,"rel","noreferrer"),u(f,"class","card"),u(L,"class","read-the-docs svelte-c9fbf7")},m(m,U){V(m,t,U),c(t,n),c(n,r),c(n,o),c(n,s),c(s,i),c(t,p),c(t,l),c(t,b),c(t,f),G(d,f,null),c(t,x),c(t,_),c(t,T),c(t,L),O=!0},p:v,i(m){O||(D(d.$$.fragment,m),O=!0)},o(m){le(d.$$.fragment,m),O=!1},d(m){m&&M(t),J(d)}}}class me extends R{constructor(t){super(),Q(this,t,null,pe,F,{})}}new me({target:document.getElementById("app")}); diff --git a/v3/examples/dev/frontend/dist/assets/svelte-a39f39b7.svg b/v3/examples/dev/frontend/dist/assets/svelte-a39f39b7.svg new file mode 100644 index 000000000..c5e08481f --- /dev/null +++ b/v3/examples/dev/frontend/dist/assets/svelte-a39f39b7.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/v3/examples/dev/frontend/dist/index.html b/v3/examples/dev/frontend/dist/index.html new file mode 100644 index 000000000..c4380af7b --- /dev/null +++ b/v3/examples/dev/frontend/dist/index.html @@ -0,0 +1,15 @@ + + + + + + + Wails + Svelte + + + + +
      + + + diff --git a/v3/examples/dev/frontend/dist/wails.png b/v3/examples/dev/frontend/dist/wails.png new file mode 100644 index 000000000..8bdf42483 Binary files /dev/null and b/v3/examples/dev/frontend/dist/wails.png differ diff --git a/v3/examples/dev/frontend/index.html b/v3/examples/dev/frontend/index.html new file mode 100644 index 000000000..1ea50f904 --- /dev/null +++ b/v3/examples/dev/frontend/index.html @@ -0,0 +1,13 @@ + + + + + + + Wails + Svelte + + +
      + + + diff --git a/v3/examples/dev/frontend/package-lock.json b/v3/examples/dev/frontend/package-lock.json new file mode 100644 index 000000000..309115bf9 --- /dev/null +++ b/v3/examples/dev/frontend/package-lock.json @@ -0,0 +1,685 @@ +{ + "name": "frontend", + "version": "0.0.0", + "lockfileVersion": 3, + "requires": true, + "packages": { + "": { + "name": "frontend", + "version": "0.0.0", + "devDependencies": { + "@sveltejs/vite-plugin-svelte": "^2.0.0", + "svelte": "^3.54.0", + "vite": "^4.5.2" + } + }, + "node_modules/@esbuild/android-arm": { + "version": "0.18.20", + "resolved": "https://registry.npmjs.org/@esbuild/android-arm/-/android-arm-0.18.20.tgz", + "integrity": "sha512-fyi7TDI/ijKKNZTUJAQqiG5T7YjJXgnzkURqmGj13C6dCqckZBLdl4h7bkhHt/t0WP+zO9/zwroDvANaOqO5Sw==", + "cpu": [ + "arm" + ], + "dev": true, + "optional": true, + "os": [ + "android" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/@esbuild/android-arm64": { + "version": "0.18.20", + "resolved": "https://registry.npmjs.org/@esbuild/android-arm64/-/android-arm64-0.18.20.tgz", + "integrity": "sha512-Nz4rJcchGDtENV0eMKUNa6L12zz2zBDXuhj/Vjh18zGqB44Bi7MBMSXjgunJgjRhCmKOjnPuZp4Mb6OKqtMHLQ==", + "cpu": [ + "arm64" + ], + "dev": true, + "optional": true, + "os": [ + "android" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/@esbuild/android-x64": { + "version": "0.18.20", + "resolved": "https://registry.npmjs.org/@esbuild/android-x64/-/android-x64-0.18.20.tgz", + "integrity": "sha512-8GDdlePJA8D6zlZYJV/jnrRAi6rOiNaCC/JclcXpB+KIuvfBN4owLtgzY2bsxnx666XjJx2kDPUmnTtR8qKQUg==", + "cpu": [ + "x64" + ], + "dev": true, + "optional": true, + "os": [ + "android" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/@esbuild/darwin-arm64": { + "version": "0.18.20", + "resolved": "https://registry.npmjs.org/@esbuild/darwin-arm64/-/darwin-arm64-0.18.20.tgz", + "integrity": "sha512-bxRHW5kHU38zS2lPTPOyuyTm+S+eobPUnTNkdJEfAddYgEcll4xkT8DB9d2008DtTbl7uJag2HuE5NZAZgnNEA==", + "cpu": [ + "arm64" + ], + "dev": true, + "optional": true, + "os": [ + "darwin" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/@esbuild/darwin-x64": { + "version": "0.18.20", + "resolved": "https://registry.npmjs.org/@esbuild/darwin-x64/-/darwin-x64-0.18.20.tgz", + "integrity": "sha512-pc5gxlMDxzm513qPGbCbDukOdsGtKhfxD1zJKXjCCcU7ju50O7MeAZ8c4krSJcOIJGFR+qx21yMMVYwiQvyTyQ==", + "cpu": [ + "x64" + ], + "dev": true, + "optional": true, + "os": [ + "darwin" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/@esbuild/freebsd-arm64": { + "version": "0.18.20", + "resolved": "https://registry.npmjs.org/@esbuild/freebsd-arm64/-/freebsd-arm64-0.18.20.tgz", + "integrity": "sha512-yqDQHy4QHevpMAaxhhIwYPMv1NECwOvIpGCZkECn8w2WFHXjEwrBn3CeNIYsibZ/iZEUemj++M26W3cNR5h+Tw==", + "cpu": [ + "arm64" + ], + "dev": true, + "optional": true, + "os": [ + "freebsd" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/@esbuild/freebsd-x64": { + "version": "0.18.20", + "resolved": "https://registry.npmjs.org/@esbuild/freebsd-x64/-/freebsd-x64-0.18.20.tgz", + "integrity": "sha512-tgWRPPuQsd3RmBZwarGVHZQvtzfEBOreNuxEMKFcd5DaDn2PbBxfwLcj4+aenoh7ctXcbXmOQIn8HI6mCSw5MQ==", + "cpu": [ + "x64" + ], + "dev": true, + "optional": true, + "os": [ + "freebsd" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/@esbuild/linux-arm": { + "version": "0.18.20", + "resolved": "https://registry.npmjs.org/@esbuild/linux-arm/-/linux-arm-0.18.20.tgz", + "integrity": "sha512-/5bHkMWnq1EgKr1V+Ybz3s1hWXok7mDFUMQ4cG10AfW3wL02PSZi5kFpYKrptDsgb2WAJIvRcDm+qIvXf/apvg==", + "cpu": [ + "arm" + ], + "dev": true, + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/@esbuild/linux-arm64": { + "version": "0.18.20", + "resolved": "https://registry.npmjs.org/@esbuild/linux-arm64/-/linux-arm64-0.18.20.tgz", + "integrity": "sha512-2YbscF+UL7SQAVIpnWvYwM+3LskyDmPhe31pE7/aoTMFKKzIc9lLbyGUpmmb8a8AixOL61sQ/mFh3jEjHYFvdA==", + "cpu": [ + "arm64" + ], + "dev": true, + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/@esbuild/linux-ia32": { + "version": "0.18.20", + "resolved": "https://registry.npmjs.org/@esbuild/linux-ia32/-/linux-ia32-0.18.20.tgz", + "integrity": "sha512-P4etWwq6IsReT0E1KHU40bOnzMHoH73aXp96Fs8TIT6z9Hu8G6+0SHSw9i2isWrD2nbx2qo5yUqACgdfVGx7TA==", + "cpu": [ + "ia32" + ], + "dev": true, + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/@esbuild/linux-loong64": { + "version": "0.18.20", + "resolved": "https://registry.npmjs.org/@esbuild/linux-loong64/-/linux-loong64-0.18.20.tgz", + "integrity": "sha512-nXW8nqBTrOpDLPgPY9uV+/1DjxoQ7DoB2N8eocyq8I9XuqJ7BiAMDMf9n1xZM9TgW0J8zrquIb/A7s3BJv7rjg==", + "cpu": [ + "loong64" + ], + "dev": true, + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/@esbuild/linux-mips64el": { + "version": "0.18.20", + "resolved": "https://registry.npmjs.org/@esbuild/linux-mips64el/-/linux-mips64el-0.18.20.tgz", + "integrity": "sha512-d5NeaXZcHp8PzYy5VnXV3VSd2D328Zb+9dEq5HE6bw6+N86JVPExrA6O68OPwobntbNJ0pzCpUFZTo3w0GyetQ==", + "cpu": [ + "mips64el" + ], + "dev": true, + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/@esbuild/linux-ppc64": { + "version": "0.18.20", + "resolved": "https://registry.npmjs.org/@esbuild/linux-ppc64/-/linux-ppc64-0.18.20.tgz", + "integrity": "sha512-WHPyeScRNcmANnLQkq6AfyXRFr5D6N2sKgkFo2FqguP44Nw2eyDlbTdZwd9GYk98DZG9QItIiTlFLHJHjxP3FA==", + "cpu": [ + "ppc64" + ], + "dev": true, + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/@esbuild/linux-riscv64": { + "version": "0.18.20", + "resolved": "https://registry.npmjs.org/@esbuild/linux-riscv64/-/linux-riscv64-0.18.20.tgz", + "integrity": "sha512-WSxo6h5ecI5XH34KC7w5veNnKkju3zBRLEQNY7mv5mtBmrP/MjNBCAlsM2u5hDBlS3NGcTQpoBvRzqBcRtpq1A==", + "cpu": [ + "riscv64" + ], + "dev": true, + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/@esbuild/linux-s390x": { + "version": "0.18.20", + "resolved": "https://registry.npmjs.org/@esbuild/linux-s390x/-/linux-s390x-0.18.20.tgz", + "integrity": "sha512-+8231GMs3mAEth6Ja1iK0a1sQ3ohfcpzpRLH8uuc5/KVDFneH6jtAJLFGafpzpMRO6DzJ6AvXKze9LfFMrIHVQ==", + "cpu": [ + "s390x" + ], + "dev": true, + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/@esbuild/linux-x64": { + "version": "0.18.20", + "resolved": "https://registry.npmjs.org/@esbuild/linux-x64/-/linux-x64-0.18.20.tgz", + "integrity": "sha512-UYqiqemphJcNsFEskc73jQ7B9jgwjWrSayxawS6UVFZGWrAAtkzjxSqnoclCXxWtfwLdzU+vTpcNYhpn43uP1w==", + "cpu": [ + "x64" + ], + "dev": true, + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/@esbuild/netbsd-x64": { + "version": "0.18.20", + "resolved": "https://registry.npmjs.org/@esbuild/netbsd-x64/-/netbsd-x64-0.18.20.tgz", + "integrity": "sha512-iO1c++VP6xUBUmltHZoMtCUdPlnPGdBom6IrO4gyKPFFVBKioIImVooR5I83nTew5UOYrk3gIJhbZh8X44y06A==", + "cpu": [ + "x64" + ], + "dev": true, + "optional": true, + "os": [ + "netbsd" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/@esbuild/openbsd-x64": { + "version": "0.18.20", + "resolved": "https://registry.npmjs.org/@esbuild/openbsd-x64/-/openbsd-x64-0.18.20.tgz", + "integrity": "sha512-e5e4YSsuQfX4cxcygw/UCPIEP6wbIL+se3sxPdCiMbFLBWu0eiZOJ7WoD+ptCLrmjZBK1Wk7I6D/I3NglUGOxg==", + "cpu": [ + "x64" + ], + "dev": true, + "optional": true, + "os": [ + "openbsd" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/@esbuild/sunos-x64": { + "version": "0.18.20", + "resolved": "https://registry.npmjs.org/@esbuild/sunos-x64/-/sunos-x64-0.18.20.tgz", + "integrity": "sha512-kDbFRFp0YpTQVVrqUd5FTYmWo45zGaXe0X8E1G/LKFC0v8x0vWrhOWSLITcCn63lmZIxfOMXtCfti/RxN/0wnQ==", + "cpu": [ + "x64" + ], + "dev": true, + "optional": true, + "os": [ + "sunos" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/@esbuild/win32-arm64": { + "version": "0.18.20", + "resolved": "https://registry.npmjs.org/@esbuild/win32-arm64/-/win32-arm64-0.18.20.tgz", + "integrity": "sha512-ddYFR6ItYgoaq4v4JmQQaAI5s7npztfV4Ag6NrhiaW0RrnOXqBkgwZLofVTlq1daVTQNhtI5oieTvkRPfZrePg==", + "cpu": [ + "arm64" + ], + "dev": true, + "optional": true, + "os": [ + "win32" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/@esbuild/win32-ia32": { + "version": "0.18.20", + "resolved": "https://registry.npmjs.org/@esbuild/win32-ia32/-/win32-ia32-0.18.20.tgz", + "integrity": "sha512-Wv7QBi3ID/rROT08SABTS7eV4hX26sVduqDOTe1MvGMjNd3EjOz4b7zeexIR62GTIEKrfJXKL9LFxTYgkyeu7g==", + "cpu": [ + "ia32" + ], + "dev": true, + "optional": true, + "os": [ + "win32" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/@esbuild/win32-x64": { + "version": "0.18.20", + "resolved": "https://registry.npmjs.org/@esbuild/win32-x64/-/win32-x64-0.18.20.tgz", + "integrity": "sha512-kTdfRcSiDfQca/y9QIkng02avJ+NCaQvrMejlsB3RRv5sE9rRoeBPISaZpKxHELzRxZyLvNts1P27W3wV+8geQ==", + "cpu": [ + "x64" + ], + "dev": true, + "optional": true, + "os": [ + "win32" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/@jridgewell/sourcemap-codec": { + "version": "1.4.15", + "resolved": "https://registry.npmjs.org/@jridgewell/sourcemap-codec/-/sourcemap-codec-1.4.15.tgz", + "integrity": "sha512-eF2rxCRulEKXHTRiDrDy6erMYWqNw4LPdQ8UQA4huuxaQsVeRPFl2oM8oDGxMFhJUWZf9McpLtJasDDZb/Bpeg==", + "dev": true + }, + "node_modules/@sveltejs/vite-plugin-svelte": { + "version": "2.4.5", + "resolved": "https://registry.npmjs.org/@sveltejs/vite-plugin-svelte/-/vite-plugin-svelte-2.4.5.tgz", + "integrity": "sha512-UJKsFNwhzCVuiZd06jM/psscyNJNDwjQC+qIeb7GBJK9iWeQCcIyfcPWDvbCudfcJggY9jtxJeeaZH7uny93FQ==", + "dev": true, + "dependencies": { + "@sveltejs/vite-plugin-svelte-inspector": "^1.0.3", + "debug": "^4.3.4", + "deepmerge": "^4.3.1", + "kleur": "^4.1.5", + "magic-string": "^0.30.2", + "svelte-hmr": "^0.15.3", + "vitefu": "^0.2.4" + }, + "engines": { + "node": "^14.18.0 || >= 16" + }, + "peerDependencies": { + "svelte": "^3.54.0 || ^4.0.0", + "vite": "^4.0.0" + } + }, + "node_modules/@sveltejs/vite-plugin-svelte-inspector": { + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/@sveltejs/vite-plugin-svelte-inspector/-/vite-plugin-svelte-inspector-1.0.3.tgz", + "integrity": "sha512-Khdl5jmmPN6SUsVuqSXatKpQTMIifoQPDanaxC84m9JxIibWvSABJyHpyys0Z+1yYrxY5TTEQm+6elh0XCMaOA==", + "dev": true, + "dependencies": { + "debug": "^4.3.4" + }, + "engines": { + "node": "^14.18.0 || >= 16" + }, + "peerDependencies": { + "@sveltejs/vite-plugin-svelte": "^2.2.0", + "svelte": "^3.54.0 || ^4.0.0", + "vite": "^4.0.0" + } + }, + "node_modules/debug": { + "version": "4.3.4", + "resolved": "https://registry.npmjs.org/debug/-/debug-4.3.4.tgz", + "integrity": "sha512-PRWFHuSU3eDtQJPvnNY7Jcket1j0t5OuOsFzPPzsekD52Zl8qUfFIPEiswXqIvHWGVHOgX+7G/vCNNhehwxfkQ==", + "dev": true, + "dependencies": { + "ms": "2.1.2" + }, + "engines": { + "node": ">=6.0" + }, + "peerDependenciesMeta": { + "supports-color": { + "optional": true + } + } + }, + "node_modules/deepmerge": { + "version": "4.3.1", + "resolved": "https://registry.npmjs.org/deepmerge/-/deepmerge-4.3.1.tgz", + "integrity": "sha512-3sUqbMEc77XqpdNO7FRyRog+eW3ph+GYCbj+rK+uYyRMuwsVy0rMiVtPn+QJlKFvWP/1PYpapqYn0Me2knFn+A==", + "dev": true, + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/esbuild": { + "version": "0.18.20", + "resolved": "https://registry.npmjs.org/esbuild/-/esbuild-0.18.20.tgz", + "integrity": "sha512-ceqxoedUrcayh7Y7ZX6NdbbDzGROiyVBgC4PriJThBKSVPWnnFHZAkfI1lJT8QFkOwH4qOS2SJkS4wvpGl8BpA==", + "dev": true, + "hasInstallScript": true, + "bin": { + "esbuild": "bin/esbuild" + }, + "engines": { + "node": ">=12" + }, + "optionalDependencies": { + "@esbuild/android-arm": "0.18.20", + "@esbuild/android-arm64": "0.18.20", + "@esbuild/android-x64": "0.18.20", + "@esbuild/darwin-arm64": "0.18.20", + "@esbuild/darwin-x64": "0.18.20", + "@esbuild/freebsd-arm64": "0.18.20", + "@esbuild/freebsd-x64": "0.18.20", + "@esbuild/linux-arm": "0.18.20", + "@esbuild/linux-arm64": "0.18.20", + "@esbuild/linux-ia32": "0.18.20", + "@esbuild/linux-loong64": "0.18.20", + "@esbuild/linux-mips64el": "0.18.20", + "@esbuild/linux-ppc64": "0.18.20", + "@esbuild/linux-riscv64": "0.18.20", + "@esbuild/linux-s390x": "0.18.20", + "@esbuild/linux-x64": "0.18.20", + "@esbuild/netbsd-x64": "0.18.20", + "@esbuild/openbsd-x64": "0.18.20", + "@esbuild/sunos-x64": "0.18.20", + "@esbuild/win32-arm64": "0.18.20", + "@esbuild/win32-ia32": "0.18.20", + "@esbuild/win32-x64": "0.18.20" + } + }, + "node_modules/fsevents": { + "version": "2.3.2", + "resolved": "https://registry.npmjs.org/fsevents/-/fsevents-2.3.2.tgz", + "integrity": "sha512-xiqMQR4xAeHTuB9uWm+fFRcIOgKBMiOBP+eXiyT7jsgVCq1bkVygt00oASowB7EdtpOHaaPgKt812P9ab+DDKA==", + "dev": true, + "hasInstallScript": true, + "optional": true, + "os": [ + "darwin" + ], + "engines": { + "node": "^8.16.0 || ^10.6.0 || >=11.0.0" + } + }, + "node_modules/kleur": { + "version": "4.1.5", + "resolved": "https://registry.npmjs.org/kleur/-/kleur-4.1.5.tgz", + "integrity": "sha512-o+NO+8WrRiQEE4/7nwRJhN1HWpVmJm511pBHUxPLtp0BUISzlBplORYSmTclCnJvQq2tKu/sgl3xVpkc7ZWuQQ==", + "dev": true, + "engines": { + "node": ">=6" + } + }, + "node_modules/magic-string": { + "version": "0.30.2", + "resolved": "https://registry.npmjs.org/magic-string/-/magic-string-0.30.2.tgz", + "integrity": "sha512-lNZdu7pewtq/ZvWUp9Wpf/x7WzMTsR26TWV03BRZrXFsv+BI6dy8RAiKgm1uM/kyR0rCfUcqvOlXKG66KhIGug==", + "dev": true, + "dependencies": { + "@jridgewell/sourcemap-codec": "^1.4.15" + }, + "engines": { + "node": ">=12" + } + }, + "node_modules/ms": { + "version": "2.1.2", + "resolved": "https://registry.npmjs.org/ms/-/ms-2.1.2.tgz", + "integrity": "sha512-sGkPx+VjMtmA6MX27oA4FBFELFCZZ4S4XqeGOXCv68tT+jb3vk/RyaKWP0PTKyWtmLSM0b+adUTEvbs1PEaH2w==", + "dev": true + }, + "node_modules/nanoid": { + "version": "3.3.6", + "resolved": "https://registry.npmjs.org/nanoid/-/nanoid-3.3.6.tgz", + "integrity": "sha512-BGcqMMJuToF7i1rt+2PWSNVnWIkGCU78jBG3RxO/bZlnZPK2Cmi2QaffxGO/2RvWi9sL+FAiRiXMgsyxQ1DIDA==", + "dev": true, + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/ai" + } + ], + "bin": { + "nanoid": "bin/nanoid.cjs" + }, + "engines": { + "node": "^10 || ^12 || ^13.7 || ^14 || >=15.0.1" + } + }, + "node_modules/picocolors": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/picocolors/-/picocolors-1.0.0.tgz", + "integrity": "sha512-1fygroTLlHu66zi26VoTDv8yRgm0Fccecssto+MhsZ0D/DGW2sm8E8AjW7NU5VVTRt5GxbeZ5qBuJr+HyLYkjQ==", + "dev": true + }, + "node_modules/postcss": { + "version": "8.4.28", + "resolved": "https://registry.npmjs.org/postcss/-/postcss-8.4.28.tgz", + "integrity": "sha512-Z7V5j0cq8oEKyejIKfpD8b4eBy9cwW2JWPk0+fB1HOAMsfHbnAXLLS+PfVWlzMSLQaWttKDt607I0XHmpE67Vw==", + "dev": true, + "funding": [ + { + "type": "opencollective", + "url": "https://opencollective.com/postcss/" + }, + { + "type": "tidelift", + "url": "https://tidelift.com/funding/github/npm/postcss" + }, + { + "type": "github", + "url": "https://github.com/sponsors/ai" + } + ], + "dependencies": { + "nanoid": "^3.3.6", + "picocolors": "^1.0.0", + "source-map-js": "^1.0.2" + }, + "engines": { + "node": "^10 || ^12 || >=14" + } + }, + "node_modules/rollup": { + "version": "3.28.0", + "resolved": "https://registry.npmjs.org/rollup/-/rollup-3.28.0.tgz", + "integrity": "sha512-d7zhvo1OUY2SXSM6pfNjgD5+d0Nz87CUp4mt8l/GgVP3oBsPwzNvSzyu1me6BSG9JIgWNTVcafIXBIyM8yQ3yw==", + "dev": true, + "bin": { + "rollup": "dist/bin/rollup" + }, + "engines": { + "node": ">=14.18.0", + "npm": ">=8.0.0" + }, + "optionalDependencies": { + "fsevents": "~2.3.2" + } + }, + "node_modules/source-map-js": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/source-map-js/-/source-map-js-1.0.2.tgz", + "integrity": "sha512-R0XvVJ9WusLiqTCEiGCmICCMplcCkIwwR11mOSD9CR5u+IXYdiseeEuXCVAjS54zqwkLcPNnmU4OeJ6tUrWhDw==", + "dev": true, + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/svelte": { + "version": "3.59.2", + "resolved": "https://registry.npmjs.org/svelte/-/svelte-3.59.2.tgz", + "integrity": "sha512-vzSyuGr3eEoAtT/A6bmajosJZIUWySzY2CzB3w2pgPvnkUjGqlDnsNnA0PMO+mMAhuyMul6C2uuZzY6ELSkzyA==", + "dev": true, + "engines": { + "node": ">= 8" + } + }, + "node_modules/svelte-hmr": { + "version": "0.15.3", + "resolved": "https://registry.npmjs.org/svelte-hmr/-/svelte-hmr-0.15.3.tgz", + "integrity": "sha512-41snaPswvSf8TJUhlkoJBekRrABDXDMdpNpT2tfHIv4JuhgvHqLMhEPGtaQn0BmbNSTkuz2Ed20DF2eHw0SmBQ==", + "dev": true, + "engines": { + "node": "^12.20 || ^14.13.1 || >= 16" + }, + "peerDependencies": { + "svelte": "^3.19.0 || ^4.0.0" + } + }, + "node_modules/vite": { + "version": "4.5.5", + "resolved": "https://registry.npmjs.org/vite/-/vite-4.5.5.tgz", + "integrity": "sha512-ifW3Lb2sMdX+WU91s3R0FyQlAyLxOzCSCP37ujw0+r5POeHPwe6udWVIElKQq8gk3t7b8rkmvqC6IHBpCff4GQ==", + "dev": true, + "dependencies": { + "esbuild": "^0.18.10", + "postcss": "^8.4.27", + "rollup": "^3.27.1" + }, + "bin": { + "vite": "bin/vite.js" + }, + "engines": { + "node": "^14.18.0 || >=16.0.0" + }, + "funding": { + "url": "https://github.com/vitejs/vite?sponsor=1" + }, + "optionalDependencies": { + "fsevents": "~2.3.2" + }, + "peerDependencies": { + "@types/node": ">= 14", + "less": "*", + "lightningcss": "^1.21.0", + "sass": "*", + "stylus": "*", + "sugarss": "*", + "terser": "^5.4.0" + }, + "peerDependenciesMeta": { + "@types/node": { + "optional": true + }, + "less": { + "optional": true + }, + "lightningcss": { + "optional": true + }, + "sass": { + "optional": true + }, + "stylus": { + "optional": true + }, + "sugarss": { + "optional": true + }, + "terser": { + "optional": true + } + } + }, + "node_modules/vitefu": { + "version": "0.2.4", + "resolved": "https://registry.npmjs.org/vitefu/-/vitefu-0.2.4.tgz", + "integrity": "sha512-fanAXjSaf9xXtOOeno8wZXIhgia+CZury481LsDaV++lSvcU2R9Ch2bPh3PYFyoHW+w9LqAeYRISVQjUIew14g==", + "dev": true, + "peerDependencies": { + "vite": "^3.0.0 || ^4.0.0" + }, + "peerDependenciesMeta": { + "vite": { + "optional": true + } + } + } + } +} diff --git a/v3/examples/dev/frontend/package.json b/v3/examples/dev/frontend/package.json new file mode 100644 index 000000000..ed218cf99 --- /dev/null +++ b/v3/examples/dev/frontend/package.json @@ -0,0 +1,16 @@ +{ + "name": "frontend", + "private": true, + "version": "0.0.0", + "type": "module", + "scripts": { + "dev": "vite", + "build": "vite build", + "preview": "vite preview" + }, + "devDependencies": { + "@sveltejs/vite-plugin-svelte": "^2.0.0", + "svelte": "^3.54.0", + "vite": "^4.5.2" + } +} \ No newline at end of file diff --git a/v3/examples/dev/frontend/public/wails.png b/v3/examples/dev/frontend/public/wails.png new file mode 100644 index 000000000..8bdf42483 Binary files /dev/null and b/v3/examples/dev/frontend/public/wails.png differ diff --git a/v3/examples/dev/frontend/src/App.svelte b/v3/examples/dev/frontend/src/App.svelte new file mode 100644 index 000000000..539c395dd --- /dev/null +++ b/v3/examples/dev/frontend/src/App.svelte @@ -0,0 +1,45 @@ + + +
      + +

      Wails + Svelte

      + +
      + +
      + +

      + Check out SvelteKit, the official Svelte app framework powered by Vite! +

      + +

      + Click on the Wails and Svelte logos to learn more +

      +
      + + diff --git a/v3/examples/dev/frontend/src/app.css b/v3/examples/dev/frontend/src/app.css new file mode 100644 index 000000000..bcc7233dd --- /dev/null +++ b/v3/examples/dev/frontend/src/app.css @@ -0,0 +1,81 @@ +:root { + font-family: Inter, Avenir, Helvetica, Arial, sans-serif; + font-size: 16px; + line-height: 24px; + font-weight: 400; + + color-scheme: light dark; + color: rgba(255, 255, 255, 0.87); + background-color: #242424; + + font-synthesis: none; + text-rendering: optimizeLegibility; + -webkit-font-smoothing: antialiased; + -moz-osx-font-smoothing: grayscale; + -webkit-text-size-adjust: 100%; +} + +a { + font-weight: 500; + color: #646cff; + text-decoration: inherit; +} +a:hover { + color: #535bf2; +} + +body { + margin: 0; + display: flex; + place-items: center; + min-width: 320px; + min-height: 100vh; +} + +h1 { + font-size: 3.2em; + line-height: 1.1; +} + +.card { + padding: 2em; +} + +#app { + max-width: 1280px; + margin: 0 auto; + padding: 2rem; + text-align: center; +} + +button { + border-radius: 8px; + border: 1px solid transparent; + padding: 0.6em 1.2em; + font-size: 1em; + font-weight: 500; + font-family: inherit; + background-color: #1a1a1a; + cursor: pointer; + transition: border-color 0.25s; +} +button:hover { + border-color: #646cff; +} +button:focus, +button:focus-visible { + outline: 4px auto -webkit-focus-ring-color; +} + +@media (prefers-color-scheme: light) { + :root { + color: #213547; + background-color: #ffffff; + } + a:hover { + color: #747bff; + } + button { + background-color: #f9f9f9; + } +} diff --git a/v3/examples/dev/frontend/src/assets/svelte.svg b/v3/examples/dev/frontend/src/assets/svelte.svg new file mode 100644 index 000000000..c5e08481f --- /dev/null +++ b/v3/examples/dev/frontend/src/assets/svelte.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/v3/examples/dev/frontend/src/lib/Counter.svelte b/v3/examples/dev/frontend/src/lib/Counter.svelte new file mode 100644 index 000000000..e45f90310 --- /dev/null +++ b/v3/examples/dev/frontend/src/lib/Counter.svelte @@ -0,0 +1,10 @@ + + + diff --git a/v3/examples/dev/frontend/src/main.js b/v3/examples/dev/frontend/src/main.js new file mode 100644 index 000000000..8a909a15a --- /dev/null +++ b/v3/examples/dev/frontend/src/main.js @@ -0,0 +1,8 @@ +import './app.css' +import App from './App.svelte' + +const app = new App({ + target: document.getElementById('app'), +}) + +export default app diff --git a/v3/examples/dev/frontend/src/vite-env.d.ts b/v3/examples/dev/frontend/src/vite-env.d.ts new file mode 100644 index 000000000..4078e7476 --- /dev/null +++ b/v3/examples/dev/frontend/src/vite-env.d.ts @@ -0,0 +1,2 @@ +/// +/// diff --git a/v3/examples/dev/frontend/tsconfig.json b/v3/examples/dev/frontend/tsconfig.json new file mode 100644 index 000000000..b3e8a23aa --- /dev/null +++ b/v3/examples/dev/frontend/tsconfig.json @@ -0,0 +1,34 @@ +{ + "compilerOptions": { + "allowJs": true, + "moduleResolution": "Node", + "target": "ESNext", + "module": "ESNext", + /** + * svelte-preprocess cannot figure out whether you have + * a value or a type, so tell TypeScript to enforce using + * `import type` instead of `import` for Types. + */ + "importsNotUsedAsValues": "error", + "isolatedModules": true, + "resolveJsonModule": true, + /** + * To have warnings / errors of the Svelte compiler at the + * correct position, enable source maps by default. + */ + "sourceMap": true, + "esModuleInterop": true, + "skipLibCheck": true, + "forceConsistentCasingInFileNames": true, + /** + * Typecheck JS in `.svelte` and `.js` files by default. + * Disable this if you'd like to use dynamic types. + */ + "checkJs": true + }, + /** + * Use global.d.ts instead of compilerOptions.types + * to avoid limiting type declarations. + */ + "include": ["src/**/*.d.ts", "src/**/*.js", "src/**/*.svelte", "bindings"] +} diff --git a/v3/examples/dev/frontend/vite.config.js b/v3/examples/dev/frontend/vite.config.js new file mode 100644 index 000000000..d70196943 --- /dev/null +++ b/v3/examples/dev/frontend/vite.config.js @@ -0,0 +1,7 @@ +import { defineConfig } from 'vite' +import { svelte } from '@sveltejs/vite-plugin-svelte' + +// https://vitejs.dev/config/ +export default defineConfig({ + plugins: [svelte()], +}) diff --git a/v3/examples/dev/go.mod b/v3/examples/dev/go.mod new file mode 100644 index 000000000..296394de3 --- /dev/null +++ b/v3/examples/dev/go.mod @@ -0,0 +1,49 @@ +module changeme + +go 1.25 + +require github.com/wailsapp/wails/v3 v3.0.0-alpha.62 + +require ( + dario.cat/mergo v1.0.2 // indirect + github.com/Microsoft/go-winio v0.6.2 // indirect + github.com/ProtonMail/go-crypto v1.3.0 // indirect + github.com/adrg/xdg v0.5.3 // indirect + github.com/bep/debounce v1.2.1 // indirect + github.com/cloudflare/circl v1.6.3 // indirect + github.com/coder/websocket v1.8.14 // indirect + github.com/cyphar/filepath-securejoin v0.6.1 // indirect + github.com/ebitengine/purego v0.9.1 // indirect + github.com/emirpasic/gods v1.18.1 // indirect + github.com/go-git/gcfg v1.5.1-0.20230307220236-3a3c6141e376 // indirect + github.com/go-git/go-billy/v5 v5.7.0 // indirect + github.com/go-git/go-git/v5 v5.16.4 // indirect + github.com/go-ole/go-ole v1.3.0 // indirect + github.com/godbus/dbus/v5 v5.2.2 // indirect + github.com/golang/groupcache v0.0.0-20241129210726-2c02b8208cf8 // indirect + github.com/google/uuid v1.6.0 // indirect + github.com/jbenet/go-context v0.0.0-20150711004518-d14ea06fba99 // indirect + github.com/jchv/go-winloader v0.0.0-20250406163304-c1995be93bd1 // indirect + github.com/kevinburke/ssh_config v1.4.0 // indirect + github.com/klauspost/cpuid/v2 v2.3.0 // indirect + github.com/leaanthony/go-ansi-parser v1.6.1 // indirect + github.com/leaanthony/u v1.1.1 // indirect + github.com/lmittmann/tint v1.1.2 // indirect + github.com/mattn/go-colorable v0.1.14 // indirect + github.com/mattn/go-isatty v0.0.20 // indirect + github.com/pjbgf/sha1cd v0.5.0 // indirect + github.com/pkg/browser v0.0.0-20240102092130-5ac0b6a4141c // indirect + github.com/rivo/uniseg v0.4.7 // indirect + github.com/samber/lo v1.52.0 // indirect + github.com/sergi/go-diff v1.4.0 // indirect + github.com/skeema/knownhosts v1.3.2 // indirect + github.com/wailsapp/go-webview2 v1.0.23 // indirect + github.com/xanzy/ssh-agent v0.3.3 // indirect + golang.org/x/crypto v0.47.0 // indirect + golang.org/x/net v0.49.0 // indirect + golang.org/x/sys v0.40.0 // indirect + golang.org/x/text v0.33.0 // indirect + gopkg.in/warnings.v0 v0.1.2 // indirect +) + +replace github.com/wailsapp/wails/v3 => ../.. diff --git a/v3/examples/dev/go.sum b/v3/examples/dev/go.sum new file mode 100644 index 000000000..56f1153ea --- /dev/null +++ b/v3/examples/dev/go.sum @@ -0,0 +1,147 @@ +dario.cat/mergo v1.0.2 h1:85+piFYR1tMbRrLcDwR18y4UKJ3aH1Tbzi24VRW1TK8= +dario.cat/mergo v1.0.2/go.mod h1:E/hbnu0NxMFBjpMIE34DRGLWqDy0g5FuKDhCb31ngxA= +github.com/Microsoft/go-winio v0.5.2/go.mod h1:WpS1mjBmmwHBEWmogvA2mj8546UReBk4v8QkMxJ6pZY= +github.com/Microsoft/go-winio v0.6.2 h1:F2VQgta7ecxGYO8k3ZZz3RS8fVIXVxONVUPlNERoyfY= +github.com/Microsoft/go-winio v0.6.2/go.mod h1:yd8OoFMLzJbo9gZq8j5qaps8bJ9aShtEA8Ipt1oGCvU= +github.com/ProtonMail/go-crypto v1.3.0 h1:ILq8+Sf5If5DCpHQp4PbZdS1J7HDFRXz/+xKBiRGFrw= +github.com/ProtonMail/go-crypto v1.3.0/go.mod h1:9whxjD8Rbs29b4XWbB8irEcE8KHMqaR2e7GWU1R+/PE= +github.com/adrg/xdg v0.5.3 h1:xRnxJXne7+oWDatRhR1JLnvuccuIeCoBu2rtuLqQB78= +github.com/adrg/xdg v0.5.3/go.mod h1:nlTsY+NNiCBGCK2tpm09vRqfVzrc2fLmXGpBLF0zlTQ= +github.com/anmitsu/go-shlex v0.0.0-20200514113438-38f4b401e2be h1:9AeTilPcZAjCFIImctFaOjnTIavg87rW78vTPkQqLI8= +github.com/anmitsu/go-shlex v0.0.0-20200514113438-38f4b401e2be/go.mod h1:ySMOLuWl6zY27l47sB3qLNK6tF2fkHG55UZxx8oIVo4= +github.com/armon/go-socks5 v0.0.0-20160902184237-e75332964ef5 h1:0CwZNZbxp69SHPdPJAN/hZIm0C4OItdklCFmMRWYpio= +github.com/armon/go-socks5 v0.0.0-20160902184237-e75332964ef5/go.mod h1:wHh0iHkYZB8zMSxRWpUBQtwG5a7fFgvEO+odwuTv2gs= +github.com/bep/debounce v1.2.1 h1:v67fRdBA9UQu2NhLFXrSg0Brw7CexQekrBwDMM8bzeY= +github.com/bep/debounce v1.2.1/go.mod h1:H8yggRPQKLUhUoqrJC1bO2xNya7vanpDl7xR3ISbCJ0= +github.com/cloudflare/circl v1.6.3 h1:9GPOhQGF9MCYUeXyMYlqTR6a5gTrgR/fBLXvUgtVcg8= +github.com/cloudflare/circl v1.6.3/go.mod h1:2eXP6Qfat4O/Yhh8BznvKnJ+uzEoTQ6jVKJRn81BiS4= +github.com/coder/websocket v1.8.14 h1:9L0p0iKiNOibykf283eHkKUHHrpG7f65OE3BhhO7v9g= +github.com/coder/websocket v1.8.14/go.mod h1:NX3SzP+inril6yawo5CQXx8+fk145lPDC6pumgx0mVg= +github.com/cyphar/filepath-securejoin v0.6.1 h1:5CeZ1jPXEiYt3+Z6zqprSAgSWiggmpVyciv8syjIpVE= +github.com/cyphar/filepath-securejoin v0.6.1/go.mod h1:A8hd4EnAeyujCJRrICiOWqjS1AX0a9kM5XL+NwKoYSc= +github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= +github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c= +github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= +github.com/ebitengine/purego v0.9.1 h1:a/k2f2HQU3Pi399RPW1MOaZyhKJL9w/xFpKAg4q1s0A= +github.com/ebitengine/purego v0.9.1/go.mod h1:iIjxzd6CiRiOG0UyXP+V1+jWqUXVjPKLAI0mRfJZTmQ= +github.com/elazarl/goproxy v1.7.2 h1:Y2o6urb7Eule09PjlhQRGNsqRfPmYI3KKQLFpCAV3+o= +github.com/elazarl/goproxy v1.7.2/go.mod h1:82vkLNir0ALaW14Rc399OTTjyNREgmdL2cVoIbS6XaE= +github.com/emirpasic/gods v1.18.1 h1:FXtiHYKDGKCW2KzwZKx0iC0PQmdlorYgdFG9jPXJ1Bc= +github.com/emirpasic/gods v1.18.1/go.mod h1:8tpGGwCnJ5H4r6BWwaV6OrWmMoPhUl5jm/FMNAnJvWQ= +github.com/gliderlabs/ssh v0.3.8 h1:a4YXD1V7xMF9g5nTkdfnja3Sxy1PVDCj1Zg4Wb8vY6c= +github.com/gliderlabs/ssh v0.3.8/go.mod h1:xYoytBv1sV0aL3CavoDuJIQNURXkkfPA/wxQ1pL1fAU= +github.com/go-git/gcfg v1.5.1-0.20230307220236-3a3c6141e376 h1:+zs/tPmkDkHx3U66DAb0lQFJrpS6731Oaa12ikc+DiI= +github.com/go-git/gcfg v1.5.1-0.20230307220236-3a3c6141e376/go.mod h1:an3vInlBmSxCcxctByoQdvwPiA7DTK7jaaFDBTtu0ic= +github.com/go-git/go-billy/v5 v5.7.0 h1:83lBUJhGWhYp0ngzCMSgllhUSuoHP1iEWYjsPl9nwqM= +github.com/go-git/go-billy/v5 v5.7.0/go.mod h1:/1IUejTKH8xipsAcdfcSAlUlo2J7lkYV8GTKxAT/L3E= +github.com/go-git/go-git-fixtures/v4 v4.3.2-0.20231010084843-55a94097c399 h1:eMje31YglSBqCdIqdhKBW8lokaMrL3uTkpGYlE2OOT4= +github.com/go-git/go-git-fixtures/v4 v4.3.2-0.20231010084843-55a94097c399/go.mod h1:1OCfN199q1Jm3HZlxleg+Dw/mwps2Wbk9frAWm+4FII= +github.com/go-git/go-git/v5 v5.16.4 h1:7ajIEZHZJULcyJebDLo99bGgS0jRrOxzZG4uCk2Yb2Y= +github.com/go-git/go-git/v5 v5.16.4/go.mod h1:4Ge4alE/5gPs30F2H1esi2gPd69R0C39lolkucHBOp8= +github.com/go-json-experiment/json v0.0.0-20251027170946-4849db3c2f7e h1:Lf/gRkoycfOBPa42vU2bbgPurFong6zXeFtPoxholzU= +github.com/go-json-experiment/json v0.0.0-20251027170946-4849db3c2f7e/go.mod h1:uNVvRXArCGbZ508SxYYTC5v1JWoz2voff5pm25jU1Ok= +github.com/go-ole/go-ole v1.3.0 h1:Dt6ye7+vXGIKZ7Xtk4s6/xVdGDQynvom7xCFEdWr6uE= +github.com/go-ole/go-ole v1.3.0/go.mod h1:5LS6F96DhAwUc7C+1HLexzMXY1xGRSryjyPPKW6zv78= +github.com/godbus/dbus/v5 v5.2.2 h1:TUR3TgtSVDmjiXOgAAyaZbYmIeP3DPkld3jgKGV8mXQ= +github.com/godbus/dbus/v5 v5.2.2/go.mod h1:3AAv2+hPq5rdnr5txxxRwiGjPXamgoIHgz9FPBfOp3c= +github.com/golang/groupcache v0.0.0-20241129210726-2c02b8208cf8 h1:f+oWsMOmNPc8JmEHVZIycC7hBoQxHH9pNKQORJNozsQ= +github.com/golang/groupcache v0.0.0-20241129210726-2c02b8208cf8/go.mod h1:wcDNUvekVysuuOpQKo3191zZyTpiI6se1N1ULghS0sw= +github.com/google/go-cmp v0.7.0 h1:wk8382ETsv4JYUZwIsn6YpYiWiBsYLSJiTsyBybVuN8= +github.com/google/go-cmp v0.7.0/go.mod h1:pXiqmnSA92OHEEa9HXL2W4E7lf9JzCmGVUdgjX3N/iU= +github.com/google/uuid v1.6.0 h1:NIvaJDMOsjHA8n1jAhLSgzrAzy1Hgr+hNrb57e+94F0= +github.com/google/uuid v1.6.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo= +github.com/jbenet/go-context v0.0.0-20150711004518-d14ea06fba99 h1:BQSFePA1RWJOlocH6Fxy8MmwDt+yVQYULKfN0RoTN8A= +github.com/jbenet/go-context v0.0.0-20150711004518-d14ea06fba99/go.mod h1:1lJo3i6rXxKeerYnT8Nvf0QmHCRC1n8sfWVwXF2Frvo= +github.com/jchv/go-winloader v0.0.0-20250406163304-c1995be93bd1 h1:njuLRcjAuMKr7kI3D85AXWkw6/+v9PwtV6M6o11sWHQ= +github.com/jchv/go-winloader v0.0.0-20250406163304-c1995be93bd1/go.mod h1:alcuEEnZsY1WQsagKhZDsoPCRoOijYqhZvPwLG0kzVs= +github.com/kevinburke/ssh_config v1.4.0 h1:6xxtP5bZ2E4NF5tuQulISpTO2z8XbtH8cg1PWkxoFkQ= +github.com/kevinburke/ssh_config v1.4.0/go.mod h1:q2RIzfka+BXARoNexmF9gkxEX7DmvbW9P4hIVx2Kg4M= +github.com/klauspost/cpuid/v2 v2.3.0 h1:S4CRMLnYUhGeDFDqkGriYKdfoFlDnMtqTiI/sFzhA9Y= +github.com/klauspost/cpuid/v2 v2.3.0/go.mod h1:hqwkgyIinND0mEev00jJYCxPNVRVXFQeu1XKlok6oO0= +github.com/kr/pretty v0.1.0/go.mod h1:dAy3ld7l9f0ibDNOQOHHMYYIIbhfbHSm3C4ZsoJORNo= +github.com/kr/pretty v0.3.1 h1:flRD4NNwYAUpkphVc1HcthR4KEIFJ65n8Mw5qdRn3LE= +github.com/kr/pretty v0.3.1/go.mod h1:hoEshYVHaxMs3cyo3Yncou5ZscifuDolrwPKZanG3xk= +github.com/kr/pty v1.1.1/go.mod h1:pFQYn66WHrOpPYNljwOMqo10TkYh1fy3cYio2l3bCsQ= +github.com/kr/text v0.1.0/go.mod h1:4Jbv+DJW3UT/LiOwJeYQe1efqtUx/iVham/4vfdArNI= +github.com/kr/text v0.2.0 h1:5Nx0Ya0ZqY2ygV366QzturHI13Jq95ApcVaJBhpS+AY= +github.com/kr/text v0.2.0/go.mod h1:eLer722TekiGuMkidMxC/pM04lWEeraHUUmBw8l2grE= +github.com/leaanthony/go-ansi-parser v1.6.1 h1:xd8bzARK3dErqkPFtoF9F3/HgN8UQk0ed1YDKpEz01A= +github.com/leaanthony/go-ansi-parser v1.6.1/go.mod h1:+vva/2y4alzVmmIEpk9QDhA7vLC5zKDTRwfZGOp3IWU= +github.com/leaanthony/u v1.1.1 h1:TUFjwDGlNX+WuwVEzDqQwC2lOv0P4uhTQw7CMFdiK7M= +github.com/leaanthony/u v1.1.1/go.mod h1:9+o6hejoRljvZ3BzdYlVL0JYCwtnAsVuN9pVTQcaRfI= +github.com/lmittmann/tint v1.1.2 h1:2CQzrL6rslrsyjqLDwD11bZ5OpLBPU+g3G/r5LSfS8w= +github.com/lmittmann/tint v1.1.2/go.mod h1:HIS3gSy7qNwGCj+5oRjAutErFBl4BzdQP6cJZ0NfMwE= +github.com/matryer/is v1.4.0/go.mod h1:8I/i5uYgLzgsgEloJE1U6xx5HkBQpAZvepWuujKwMRU= +github.com/matryer/is v1.4.1 h1:55ehd8zaGABKLXQUe2awZ99BD/PTc2ls+KV/dXphgEQ= +github.com/matryer/is v1.4.1/go.mod h1:8I/i5uYgLzgsgEloJE1U6xx5HkBQpAZvepWuujKwMRU= +github.com/mattn/go-colorable v0.1.14 h1:9A9LHSqF/7dyVVX6g0U9cwm9pG3kP9gSzcuIPHPsaIE= +github.com/mattn/go-colorable v0.1.14/go.mod h1:6LmQG8QLFO4G5z1gPvYEzlUgJ2wF+stgPZH1UqBm1s8= +github.com/mattn/go-isatty v0.0.20 h1:xfD0iDuEKnDkl03q4limB+vH+GxLEtL/jb4xVJSWWEY= +github.com/mattn/go-isatty v0.0.20/go.mod h1:W+V8PltTTMOvKvAeJH7IuucS94S2C6jfK/D7dTCTo3Y= +github.com/onsi/gomega v1.34.1 h1:EUMJIKUjM8sKjYbtxQI9A4z2o+rruxnzNvpknOXie6k= +github.com/onsi/gomega v1.34.1/go.mod h1:kU1QgUvBDLXBJq618Xvm2LUX6rSAfRaFRTcdOeDLwwY= +github.com/pjbgf/sha1cd v0.5.0 h1:a+UkboSi1znleCDUNT3M5YxjOnN1fz2FhN48FlwCxs0= +github.com/pjbgf/sha1cd v0.5.0/go.mod h1:lhpGlyHLpQZoxMv8HcgXvZEhcGs0PG/vsZnEJ7H0iCM= +github.com/pkg/browser v0.0.0-20240102092130-5ac0b6a4141c h1:+mdjkGKdHQG3305AYmdv1U2eRNDiU2ErMBj1gwrq8eQ= +github.com/pkg/browser v0.0.0-20240102092130-5ac0b6a4141c/go.mod h1:7rwL4CYBLnjLxUqIJNnCWiEdr3bn6IUYi15bNlnbCCU= +github.com/pkg/errors v0.9.1 h1:FEBLx1zS214owpjy7qsBeixbURkuhQAwrK5UwLGTwt4= +github.com/pkg/errors v0.9.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0= +github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM= +github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= +github.com/rivo/uniseg v0.2.0/go.mod h1:J6wj4VEh+S6ZtnVlnTBMWIodfgj8LQOQFoIToxlJtxc= +github.com/rivo/uniseg v0.4.7 h1:WUdvkW8uEhrYfLC4ZzdpI2ztxP1I582+49Oc5Mq64VQ= +github.com/rivo/uniseg v0.4.7/go.mod h1:FN3SvrM+Zdj16jyLfmOkMNblXMcoc8DfTHruCPUcx88= +github.com/rogpeppe/go-internal v1.14.1 h1:UQB4HGPB6osV0SQTLymcB4TgvyWu6ZyliaW0tI/otEQ= +github.com/rogpeppe/go-internal v1.14.1/go.mod h1:MaRKkUm5W0goXpeCfT7UZI6fk/L7L7so1lCWt35ZSgc= +github.com/samber/lo v1.52.0 h1:Rvi+3BFHES3A8meP33VPAxiBZX/Aws5RxrschYGjomw= +github.com/samber/lo v1.52.0/go.mod h1:4+MXEGsJzbKGaUEQFKBq2xtfuznW9oz/WrgyzMzRoM0= +github.com/sergi/go-diff v1.4.0 h1:n/SP9D5ad1fORl+llWyN+D6qoUETXNZARKjyY2/KVCw= +github.com/sergi/go-diff v1.4.0/go.mod h1:A0bzQcvG0E7Rwjx0REVgAGH58e96+X0MeOfepqsbeW4= +github.com/sirupsen/logrus v1.7.0/go.mod h1:yWOB1SBYBC5VeMP7gHvWumXLIWorT60ONWic61uBYv0= +github.com/skeema/knownhosts v1.3.2 h1:EDL9mgf4NzwMXCTfaxSD/o/a5fxDw/xL9nkU28JjdBg= +github.com/skeema/knownhosts v1.3.2/go.mod h1:bEg3iQAuw+jyiw+484wwFJoKSLwcfd7fqRy+N0QTiow= +github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME= +github.com/stretchr/testify v1.2.2/go.mod h1:a8OnRcib4nhh0OaRAV+Yts87kKdq0PP7pXfy6kDkUVs= +github.com/stretchr/testify v1.4.0/go.mod h1:j7eGeouHqKxXV5pUuKE4zz7dFj8WfuZ+81PSLYec5m4= +github.com/stretchr/testify v1.11.1 h1:7s2iGBzp5EwR7/aIZr8ao5+dra3wiQyKjjFuvgVKu7U= +github.com/stretchr/testify v1.11.1/go.mod h1:wZwfW3scLgRK+23gO65QZefKpKQRnfz6sD981Nm4B6U= +github.com/wailsapp/go-webview2 v1.0.23 h1:jmv8qhz1lHibCc79bMM/a/FqOnnzOGEisLav+a0b9P0= +github.com/wailsapp/go-webview2 v1.0.23/go.mod h1:qJmWAmAmaniuKGZPWwne+uor3AHMB5PFhqiK0Bbj8kc= +github.com/xanzy/ssh-agent v0.3.3 h1:+/15pJfg/RsTxqYcX6fHqOXZwwMP+2VyYWJeWM2qQFM= +github.com/xanzy/ssh-agent v0.3.3/go.mod h1:6dzNDKs0J9rVPHPhaGCukekBHKqfl+L3KghI1Bc68Uw= +golang.org/x/crypto v0.0.0-20220622213112-05595931fe9d/go.mod h1:IxCIyHEi3zRg3s0A5j5BB6A9Jmi73HwBIUl50j+osU4= +golang.org/x/crypto v0.47.0 h1:V6e3FRj+n4dbpw86FJ8Fv7XVOql7TEwpHapKoMJ/GO8= +golang.org/x/crypto v0.47.0/go.mod h1:ff3Y9VzzKbwSSEzWqJsJVBnWmRwRSHt/6Op5n9bQc4A= +golang.org/x/exp v0.0.0-20260112195511-716be5621a96 h1:Z/6YuSHTLOHfNFdb8zVZomZr7cqNgTJvA8+Qz75D8gU= +golang.org/x/exp v0.0.0-20260112195511-716be5621a96/go.mod h1:nzimsREAkjBCIEFtHiYkrJyT+2uy9YZJB7H1k68CXZU= +golang.org/x/net v0.0.0-20211112202133-69e39bad7dc2/go.mod h1:9nx3DQGgdP8bBQD5qxJ1jj9UTztislL4KSBs9R2vV5Y= +golang.org/x/net v0.49.0 h1:eeHFmOGUTtaaPSGNmjBKpbng9MulQsJURQUAfUwY++o= +golang.org/x/net v0.49.0/go.mod h1:/ysNB2EvaqvesRkuLAyjI1ycPZlQHM3q01F02UY/MV8= +golang.org/x/sys v0.0.0-20191026070338-33540a1f6037/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20200810151505-1b9f1253b3ed/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20201119102817-f84b799fce68/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20210124154548-22da62e12c0c/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20210423082822-04245dca01da/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20210615035016-665e8c7367d1/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.0.0-20220715151400-c0bba94af5f8/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.1.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.6.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.40.0 h1:DBZZqJ2Rkml6QMQsZywtnjnnGvHza6BTfYFWY9kjEWQ= +golang.org/x/sys v0.40.0/go.mod h1:OgkHotnGiDImocRcuBABYBEXf8A9a87e/uXjp9XT3ks= +golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo= +golang.org/x/term v0.39.0 h1:RclSuaJf32jOqZz74CkPA9qFuVTX7vhLlpfj/IGWlqY= +golang.org/x/term v0.39.0/go.mod h1:yxzUCTP/U+FzoxfdKmLaA0RV1WgE0VY7hXBwKtY/4ww= +golang.org/x/text v0.3.6/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ= +golang.org/x/text v0.33.0 h1:B3njUFyqtHDUI5jMn1YIr5B0IE2U0qck04r6d4KPAxE= +golang.org/x/text v0.33.0/go.mod h1:LuMebE6+rBincTi9+xWTY8TztLzKHc/9C1uBCG27+q8= +golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ= +gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= +gopkg.in/check.v1 v1.0.0-20190902080502-41f04d3bba15/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= +gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c h1:Hei/4ADfdWqJk1ZMxUNpqntNwaWcugrBjAiHlqqRiVk= +gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c/go.mod h1:JHkPIbrfpd72SG/EVd6muEfDQjcINNoR0C8j2r3qZ4Q= +gopkg.in/warnings.v0 v0.1.2 h1:wFXVbFY8DY5/xOe1ECiWdKCzZlxgshcYVNkBHstARME= +gopkg.in/warnings.v0 v0.1.2/go.mod h1:jksf8JmL6Qr/oQM2OXTHunEvvTAsrWBLb6OOjuVWRNI= +gopkg.in/yaml.v2 v2.2.2/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI= +gopkg.in/yaml.v2 v2.4.0/go.mod h1:RDklbk79AGWmwhnvt/jBztapEOGDOx6ZbXqjP6csGnQ= +gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA= +gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= diff --git a/v3/examples/dev/main.go b/v3/examples/dev/main.go new file mode 100644 index 000000000..111273721 --- /dev/null +++ b/v3/examples/dev/main.go @@ -0,0 +1,43 @@ +package main + +import ( + "embed" + _ "embed" + "log" + + "github.com/wailsapp/wails/v3/pkg/application" +) + +//go:embed frontend/dist +var assets embed.FS + +func main() { + app := application.New(application.Options{ + Name: "dev", + Description: "A demo of using raw HTML & CSS", + Assets: application.AssetOptions{ + Handler: application.AssetFileServerFS(assets), + }, + Mac: application.MacOptions{ + ApplicationShouldTerminateAfterLastWindowClosed: true, + }, + }) + // Create window + app.Window.NewWithOptions(application.WebviewWindowOptions{ + Title: "Plain Bundle", + CSS: `body { background-color: rgba(255, 255, 255, 0); } .main { color: white; margin: 20%; }`, + Mac: application.MacWindow{ + InvisibleTitleBarHeight: 50, + Backdrop: application.MacBackdropTranslucent, + TitleBar: application.MacTitleBarHiddenInset, + }, + + URL: "/", + }) + + err := app.Run() + + if err != nil { + log.Fatal(err) + } +} diff --git a/v3/examples/dialogs-basic/.hidden_file b/v3/examples/dialogs-basic/.hidden_file new file mode 100644 index 000000000..e69de29bb diff --git a/v3/examples/dialogs-basic/README.md b/v3/examples/dialogs-basic/README.md new file mode 100644 index 000000000..c03911376 --- /dev/null +++ b/v3/examples/dialogs-basic/README.md @@ -0,0 +1,36 @@ +# Dialog Test Application + +This application is designed to test macOS file dialog functionality across different versions of macOS. It provides a comprehensive suite of tests for various dialog features and configurations. + +## Features Tested + +1. Basic file open dialog +2. Single extension filter +3. Multiple extension filter +4. Multiple file selection +5. Directory selection +6. Save dialog with extension +7. Complex filters +8. Hidden files +9. Default directory +10. Full featured dialog with all options + +## Running the Tests + +```bash +go run main.go +``` + +## Test Results + +When running tests: +- Each test will show the selected file(s) and their types +- For multiple selections, all selected files will be listed +- Errors will be displayed in an error dialog +- The application logs debug information to help track issues + +## Notes + +- This test application is primarily for development and testing purposes +- It can be used to verify dialog behavior across different macOS versions +- The tests are designed to not interfere with CI pipelines diff --git a/v3/examples/dialogs-basic/main.go b/v3/examples/dialogs-basic/main.go new file mode 100644 index 000000000..0b47b34b3 --- /dev/null +++ b/v3/examples/dialogs-basic/main.go @@ -0,0 +1,257 @@ +package main + +import ( + "fmt" + "log" + "log/slog" + "os" + "path/filepath" + "runtime" + "strings" + + "github.com/wailsapp/wails/v3/pkg/application" +) + +func main() { + app := application.New(application.Options{ + Name: "Dialog Test", + Description: "Test application for macOS dialogs", + Logger: application.DefaultLogger(slog.LevelDebug), + Mac: application.MacOptions{ + ApplicationShouldTerminateAfterLastWindowClosed: true, + }, + }) + + // Create main window + mainWindow := app.Window.NewWithOptions(application.WebviewWindowOptions{ + Title: "Dialog Tests", + Width: 800, + Height: 600, + MinWidth: 800, + MinHeight: 600, + }) + mainWindow.SetAlwaysOnTop(true) + + // Create main menu + menu := app.NewMenu() + app.Menu.Set(menu) + menu.AddRole(application.AppMenu) + menu.AddRole(application.EditMenu) + menu.AddRole(application.WindowMenu) + + // Add test menu + testMenu := menu.AddSubmenu("Tests") + + // Test 1: Basic file open with no filters (no window) + testMenu.Add("1. Basic Open (No Window)").OnClick(func(ctx *application.Context) { + result, err := app.Dialog.OpenFile(). + CanChooseFiles(true). + PromptForSingleSelection() + showResult("Basic Open", result, err, nil) + }) + + // Test 1b: Basic file open with window + testMenu.Add("1b. Basic Open (With Window)").OnClick(func(ctx *application.Context) { + result, err := app.Dialog.OpenFile(). + CanChooseFiles(true). + AttachToWindow(mainWindow). + PromptForSingleSelection() + showResult("Basic Open", result, err, mainWindow) + }) + + // Test 2: Open with single extension filter + testMenu.Add("2. Single Filter").OnClick(func(ctx *application.Context) { + result, err := app.Dialog.OpenFile(). + CanChooseFiles(true). + AddFilter("Text Files", "*.txt"). + AttachToWindow(mainWindow). + PromptForSingleSelection() + showResult("Single Filter", result, err, mainWindow) + }) + + // Test 3: Open with multiple extension filter + testMenu.Add("3. Multiple Filter").OnClick(func(ctx *application.Context) { + result, err := app.Dialog.OpenFile(). + CanChooseFiles(true). + AddFilter("Documents", "*.txt;*.md;*.doc;*.docx"). + AttachToWindow(mainWindow). + PromptForSingleSelection() + showResult("Multiple Filter", result, err, mainWindow) + }) + + // Test 4: Multiple file selection + testMenu.Add("4. Multiple Selection").OnClick(func(ctx *application.Context) { + results, err := app.Dialog.OpenFile(). + CanChooseFiles(true). + AddFilter("Images", "*.png;*.jpg;*.jpeg"). + AttachToWindow(mainWindow). + PromptForMultipleSelection() + if err != nil { + showError("Multiple Selection", err, mainWindow) + return + } + showResults("Multiple Selection", results, mainWindow) + }) + + // Test 5: Directory selection + testMenu.Add("5. Directory Selection").OnClick(func(ctx *application.Context) { + result, err := app.Dialog.OpenFile(). + CanChooseDirectories(true). + CanChooseFiles(false). + AttachToWindow(mainWindow). + PromptForSingleSelection() + showResult("Directory Selection", result, err, mainWindow) + }) + + // Test 6: Save dialog with extension + testMenu.Add("6. Save Dialog").OnClick(func(ctx *application.Context) { + result, err := app.Dialog.SaveFile(). + SetFilename("test.txt"). + AddFilter("Text Files", "*.txt"). + AttachToWindow(mainWindow). + PromptForSingleSelection() + showResult("Save Dialog", result, err, mainWindow) + }) + + // Test 7: Complex filters + testMenu.Add("7. Complex Filters").OnClick(func(ctx *application.Context) { + result, err := app.Dialog.OpenFile(). + CanChooseFiles(true). + AddFilter("All Documents", "*.txt;*.md;*.doc;*.docx;*.pdf"). + AddFilter("Text Files", "*.txt"). + AddFilter("Markdown", "*.md"). + AddFilter("Word Documents", "*.doc;*.docx"). + AddFilter("PDF Files", "*.pdf"). + AttachToWindow(mainWindow). + PromptForSingleSelection() + showResult("Complex Filters", result, err, mainWindow) + }) + + // Test 8: Hidden files + testMenu.Add("8. Show Hidden").OnClick(func(ctx *application.Context) { + result, err := app.Dialog.OpenFile(). + CanChooseFiles(true). + ShowHiddenFiles(true). + AttachToWindow(mainWindow). + PromptForSingleSelection() + showResult("Show Hidden", result, err, mainWindow) + }) + + // Test 9: Default directory + testMenu.Add("9. Default Directory").OnClick(func(ctx *application.Context) { + home, _ := os.UserHomeDir() + result, err := app.Dialog.OpenFile(). + CanChooseFiles(true). + SetDirectory(home). + AttachToWindow(mainWindow). + PromptForSingleSelection() + showResult("Default Directory", result, err, mainWindow) + }) + + // Test 10: Full featured dialog + testMenu.Add("10. Full Featured").OnClick(func(ctx *application.Context) { + home, _ := os.UserHomeDir() + dialog := app.Dialog.OpenFile(). + SetTitle("Full Featured Dialog"). + SetDirectory(home). + CanChooseFiles(true). + CanCreateDirectories(true). + ShowHiddenFiles(true). + ResolvesAliases(true). + AllowsOtherFileTypes(true). + AttachToWindow(mainWindow) + + if runtime.GOOS == "darwin" { + dialog.SetMessage("Please select files") + } + + dialog.AddFilter("All Supported", "*.txt;*.md;*.pdf;*.png;*.jpg") + dialog.AddFilter("Documents", "*.txt;*.md;*.pdf") + dialog.AddFilter("Images", "*.png;*.jpg;*.jpeg") + + results, err := dialog.PromptForMultipleSelection() + if err != nil { + showError("Full Featured", err, mainWindow) + return + } + showResults("Full Featured", results, mainWindow) + }) + + // Show the window + mainWindow.Show() + + // Run the app + if err := app.Run(); err != nil { + log.Fatal(err) + } +} + +func showResult(test string, result string, err error, window *application.WebviewWindow) { + if err != nil { + showError(test, err, window) + return + } + if result == "" { + dialog := application.Get().Dialog.Info(). + SetTitle(test). + SetMessage("No file selected") + if window != nil { + dialog.AttachToWindow(window) + } + dialog.Show() + return + } + dialog := application.Get().Dialog.Info(). + SetTitle(test). + SetMessage(fmt.Sprintf("Selected: %s\nType: %s", result, getFileType(result))) + if window != nil { + dialog.AttachToWindow(window) + } + dialog.Show() +} + +func showResults(test string, results []string, window *application.WebviewWindow) { + if len(results) == 0 { + dialog := application.Get().Dialog.Info(). + SetTitle(test). + SetMessage("No files selected") + if window != nil { + dialog.AttachToWindow(window) + } + dialog.Show() + return + } + var message strings.Builder + message.WriteString(fmt.Sprintf("Selected %d files:\n\n", len(results))) + for _, result := range results { + message.WriteString(fmt.Sprintf("%s (%s)\n", result, getFileType(result))) + } + dialog := application.Get().Dialog.Info(). + SetTitle(test). + SetMessage(message.String()) + if window != nil { + dialog.AttachToWindow(window) + } + dialog.Show() +} + +func showError(test string, err error, window *application.WebviewWindow) { + dialog := application.Get().Dialog.Error(). + SetTitle(test). + SetMessage(fmt.Sprintf("Error: %v", err)) + if window != nil { + dialog.AttachToWindow(window) + } + dialog.Show() +} + +func getFileType(path string) string { + if path == "" { + return "unknown" + } + ext := filepath.Ext(path) + if ext == "" { + return "no extension" + } + return ext +} diff --git a/v3/examples/dialogs-basic/test.txt b/v3/examples/dialogs-basic/test.txt new file mode 100644 index 000000000..64b89ccaf --- /dev/null +++ b/v3/examples/dialogs-basic/test.txt @@ -0,0 +1 @@ +This is a sample text file to test filtering. \ No newline at end of file diff --git a/v3/examples/dialogs-basic/wails-logo-small.jpg b/v3/examples/dialogs-basic/wails-logo-small.jpg new file mode 100644 index 000000000..29cb1129e Binary files /dev/null and b/v3/examples/dialogs-basic/wails-logo-small.jpg differ diff --git a/v3/examples/dialogs-basic/wails-logo-small.png b/v3/examples/dialogs-basic/wails-logo-small.png new file mode 100644 index 000000000..cbd40bf90 Binary files /dev/null and b/v3/examples/dialogs-basic/wails-logo-small.png differ diff --git a/v3/examples/dialogs/README.md b/v3/examples/dialogs/README.md new file mode 100644 index 000000000..d80afc91a --- /dev/null +++ b/v3/examples/dialogs/README.md @@ -0,0 +1,33 @@ +# Dialogs Example + +This example is a comprehensive example of using dialogs in Wails. + +## Running the example + +To run the example, simply run the following command: + +```bash +go run main.go +``` + +## Building the example + +To build the example in debug mode, simply run the following command: + +```bash +wails3 task build +``` + +To build the example to use application icons, simply run the following command: + +```bash +wails3 task package +``` + +# Status + +| Platform | Status | +|----------|----------------| +| Mac | Mostly Working | +| Windows | Working | +| Linux | | diff --git a/v3/examples/dialogs/Taskfile.yml b/v3/examples/dialogs/Taskfile.yml new file mode 100644 index 000000000..90ac01145 --- /dev/null +++ b/v3/examples/dialogs/Taskfile.yml @@ -0,0 +1,107 @@ +version: '3' + +vars: + APP_NAME: "buildtest{{exeExt}}" + + +tasks: + + build: + summary: Builds the application + cmds: + - go build -gcflags=all="-N -l" -o bin/{{.APP_NAME}} + env: + CGO_CFLAGS: "-mmacosx-version-min=10.13" + CGO_LDFLAGS: "-mmacosx-version-min=10.13" + MACOSX_DEPLOYMENT_TARGET: "10.13" + + package: + summary: Packages a production build of the application into a `.app` or `.exe` bundle + cmds: + - task: package:darwin + - task: package:windows + +# ------------------------------------------------------------------------------ + + generate:icons: + summary: Generates Windows `.ico` and Mac `.icns` files from an image + dir: build + cmds: + # Generates both .ico and .icns files + - wails3 generate icons -input appicon.png + + build:production:darwin: + summary: Creates a production build of the application + cmds: + - GOOS=darwin GOARCH={{.GOARCH}} go build -tags production -ldflags="-w -s" -o build/bin/{{.APP_NAME}} + env: + CGO_CFLAGS: "-mmacosx-version-min=10.13" + CGO_LDFLAGS: "-mmacosx-version-min=10.13" + MACOSX_DEPLOYMENT_TARGET: "10.13" + GOARCH: '{{.GOARCH}}' + + generate:app_bundle: + summary: Builds a `.app` bundle + cmds: + - mkdir -p {{.APP_NAME}}.app/Contents/{MacOS,Resources} + - cp build/icons.icns {{.APP_NAME}}.app/Contents/Resources + - cp build/bin/{{.APP_NAME}} {{.APP_NAME}}.app/Contents/MacOS + - cp build/Info.plist {{.APP_NAME}}.app/Contents + + package:darwin:arm64: + summary: Packages a production build of the application into a `.app` bundle + platforms: + - darwin + deps: + - task: build:production:darwin + vars: + ARCH: arm64 + - generate:icons + cmds: + - task: generate:app_bundle + + package:darwin: + summary: Packages a production build of the application into a `.app` bundle + platforms: + - darwin + deps: + - task: build:production:darwin + - generate:icons + cmds: + - task: generate:app_bundle + + generate:syso: + dir: build + platforms: + - windows + cmds: + - wails3 generate syso -arch {{.GOARCH}} -icon icon.ico -manifest wails.exe.manifest -info info.json + vars: + GOARCH: '{{.GOARCH}}' + + package:windows: + summary: Packages a production build of the application into a `.exe` bundle + platforms: + - windows/amd64 + deps: + - generate:icons + cmds: + - task: generate:syso + vars: + GOARCH: amd64 + - go build -tags production -gcflags=all="-N -l" -o bin/{{.APP_NAME}} + - powershell Remove-item *.syso + + + package:windows:arm64: + summary: Packages a production build of the application into a `.exe` bundle (ARM64) + platforms: + - windows + cmds: + - task: generate:syso + vars: + GOARCH: arm64 + - go build -tags production -ldflags="-w -s -H windowsgui" -o bin/buildtest.arm64.exe + - powershell Remove-item *.syso + env: + GOARCH: arm64 diff --git a/v3/examples/dialogs/build/Info.dev.plist b/v3/examples/dialogs/build/Info.dev.plist new file mode 100644 index 000000000..d6d28b179 --- /dev/null +++ b/v3/examples/dialogs/build/Info.dev.plist @@ -0,0 +1,35 @@ + + + + CFBundlePackageType + APPL + CFBundleName + My App + CFBundleExecutable + app + CFBundleIdentifier + com.wails.app + CFBundleVersion + v1.0.0 + CFBundleGetInfoString + The ultimate thing + CFBundleShortVersionString + v1 + CFBundleIconFile + icons + LSMinimumSystemVersion + 10.13.0 + NSHighResolutionCapable + true + NSHumanReadableCopyright + (c) Me + NSAppTransportSecurity + + NSAllowsLocalNetworking + + + + + + + \ No newline at end of file diff --git a/v3/examples/dialogs/build/Info.plist b/v3/examples/dialogs/build/Info.plist new file mode 100644 index 000000000..7f03f54e9 --- /dev/null +++ b/v3/examples/dialogs/build/Info.plist @@ -0,0 +1,27 @@ + + + + CFBundlePackageType + APPL + CFBundleName + My App + CFBundleExecutable + app + CFBundleIdentifier + com.wails.app + CFBundleVersion + v1.0.0 + CFBundleGetInfoString + The ultimate thing + CFBundleShortVersionString + v1 + CFBundleIconFile + icons + LSMinimumSystemVersion + 10.13.0 + NSHighResolutionCapable + true + NSHumanReadableCopyright + (c) Me + + \ No newline at end of file diff --git a/v3/examples/dialogs/build/appicon.png b/v3/examples/dialogs/build/appicon.png new file mode 100644 index 000000000..63617fe4f Binary files /dev/null and b/v3/examples/dialogs/build/appicon.png differ diff --git a/v3/examples/dialogs/build/icon.ico b/v3/examples/dialogs/build/icon.ico new file mode 100644 index 000000000..bfa0690b7 Binary files /dev/null and b/v3/examples/dialogs/build/icon.ico differ diff --git a/v3/examples/dialogs/build/icons.icns b/v3/examples/dialogs/build/icons.icns new file mode 100644 index 000000000..1b5bd4c86 Binary files /dev/null and b/v3/examples/dialogs/build/icons.icns differ diff --git a/v3/examples/dialogs/build/info.json b/v3/examples/dialogs/build/info.json new file mode 100644 index 000000000..1005eb5cb --- /dev/null +++ b/v3/examples/dialogs/build/info.json @@ -0,0 +1,15 @@ +{ + "fixed": { + "file_version": "v1.0.0" + }, + "info": { + "0000": { + "ProductVersion": "v1.0.0", + "CompanyName": "My Company Name", + "FileDescription": "A thing that does a thing", + "LegalCopyright": "(c) 2023 My Company Name", + "ProductName": "My Product Name", + "Comments": "This is a comment" + } + } +} \ No newline at end of file diff --git a/v3/examples/dialogs/build/wails.exe.manifest b/v3/examples/dialogs/build/wails.exe.manifest new file mode 100644 index 000000000..fb1ce5bde --- /dev/null +++ b/v3/examples/dialogs/build/wails.exe.manifest @@ -0,0 +1,15 @@ + + + + + + + + + + + true/pm + permonitorv2,permonitor + + + \ No newline at end of file diff --git a/v3/examples/dialogs/main.go b/v3/examples/dialogs/main.go new file mode 100644 index 000000000..981fdb7b3 --- /dev/null +++ b/v3/examples/dialogs/main.go @@ -0,0 +1,380 @@ +package main + +import ( + _ "embed" + "log" + "log/slog" + "os" + "runtime" + "strings" + + "github.com/wailsapp/wails/v3/pkg/icons" + + "github.com/wailsapp/wails/v3/pkg/application" +) + +func main() { + + app := application.New(application.Options{ + Name: "Dialogs Demo", + Description: "A demo of the dialogs API", + Assets: application.AlphaAssets, + Logger: application.DefaultLogger(slog.LevelDebug), + Mac: application.MacOptions{ + ApplicationShouldTerminateAfterLastWindowClosed: true, + }, + }) + + // Create a custom menu + menu := app.NewMenu() + + // macOS: Add application menu + if runtime.GOOS == "darwin" { + menu.AddRole(application.AppMenu) + } + + // All platforms: Add standard menus + menu.AddRole(application.FileMenu) + menu.AddRole(application.EditMenu) + menu.AddRole(application.WindowMenu) + menu.AddRole(application.ServicesMenu) + menu.AddRole(application.HelpMenu) + + // Let's make a "Demo" menu + infoMenu := menu.AddSubmenu("Info") + infoMenu.Add("Info").OnClick(func(ctx *application.Context) { + dialog := app.Dialog.Info() + dialog.SetTitle("Custom Title") + dialog.SetMessage("This is a custom message") + dialog.Show() + }) + + infoMenu.Add("Info (Title only)").OnClick(func(ctx *application.Context) { + dialog := app.Dialog.Info() + dialog.SetTitle("Custom Title") + dialog.Show() + }) + infoMenu.Add("Info (Message only)").OnClick(func(ctx *application.Context) { + dialog := app.Dialog.Info() + dialog.SetMessage("This is a custom message") + dialog.Show() + }) + infoMenu.Add("Info (Custom Icon)").OnClick(func(ctx *application.Context) { + dialog := app.Dialog.Info() + dialog.SetTitle("Custom Icon Example") + dialog.SetMessage("Using a custom icon") + dialog.SetIcon(icons.ApplicationDarkMode256) + dialog.Show() + }) + infoMenu.Add("About").OnClick(func(ctx *application.Context) { + app.Menu.ShowAbout() + }) + + questionMenu := menu.AddSubmenu("Question") + questionMenu.Add("Question (No default)").OnClick(func(ctx *application.Context) { + dialog := app.Dialog.Question() + dialog.SetMessage("No default button") + dialog.AddButton("Yes") + dialog.AddButton("No") + dialog.Show() + }) + questionMenu.Add("Question (Attached to Window)").OnClick(func(ctx *application.Context) { + dialog := app.Dialog.Question() + dialog.AttachToWindow(app.Window.Current()) + dialog.SetMessage("No default button") + dialog.AddButton("Yes") + dialog.AddButton("No") + dialog.Show() + }) + questionMenu.Add("Question (With Default)").OnClick(func(ctx *application.Context) { + dialog := app.Dialog.Question() + dialog.SetTitle("Quit") + dialog.SetMessage("You have unsaved work. Are you sure you want to quit?") + dialog.AddButton("Yes").OnClick(func() { + app.Quit() + }) + no := dialog.AddButton("No") + dialog.SetDefaultButton(no) + dialog.Show() + }) + questionMenu.Add("Question (With Cancel)").OnClick(func(ctx *application.Context) { + dialog := app.Dialog.Question(). + SetTitle("Update"). + SetMessage("The cancel button is selected when pressing escape") + download := dialog.AddButton("📥 Download") + download.OnClick(func() { + app.Dialog.Info().SetMessage("Downloading...").Show() + }) + no := dialog.AddButton("Cancel") + dialog.SetDefaultButton(download) + dialog.SetCancelButton(no) + dialog.Show() + }) + questionMenu.Add("Question (Custom Icon)").OnClick(func(ctx *application.Context) { + dialog := app.Dialog.Question() + dialog.SetTitle("Custom Icon Example") + dialog.SetMessage("Using a custom icon") + dialog.SetIcon(icons.WailsLogoWhiteTransparent) + likeIt := dialog.AddButton("I like it!").OnClick(func() { + app.Dialog.Info().SetMessage("Thanks!").Show() + }) + dialog.AddButton("Not so keen...").OnClick(func() { + app.Dialog.Info().SetMessage("Too bad!").Show() + }) + dialog.SetDefaultButton(likeIt) + dialog.Show() + }) + + warningMenu := menu.AddSubmenu("Warning") + warningMenu.Add("Warning").OnClick(func(ctx *application.Context) { + app.Dialog.Warning(). + SetTitle("Custom Title"). + SetMessage("This is a custom message"). + Show() + }) + warningMenu.Add("Warning (Title only)").OnClick(func(ctx *application.Context) { + dialog := app.Dialog.Warning() + dialog.SetTitle("Custom Title") + dialog.Show() + }) + warningMenu.Add("Warning (Message only)").OnClick(func(ctx *application.Context) { + dialog := app.Dialog.Warning() + dialog.SetMessage("This is a custom message") + dialog.Show() + }) + warningMenu.Add("Warning (Custom Icon)").OnClick(func(ctx *application.Context) { + dialog := app.Dialog.Warning() + dialog.SetTitle("Custom Icon Example") + dialog.SetMessage("Using a custom icon") + dialog.SetIcon(icons.ApplicationLightMode256) + dialog.Show() + }) + + errorMenu := menu.AddSubmenu("Error") + errorMenu.Add("Error").OnClick(func(ctx *application.Context) { + dialog := app.Dialog.Error() + dialog.SetTitle("Ooops") + dialog.SetMessage("I accidentally the whole of Twitter") + dialog.Show() + }) + errorMenu.Add("Error (Title Only)").OnClick(func(ctx *application.Context) { + dialog := app.Dialog.Error() + dialog.SetTitle("Custom Title") + dialog.Show() + }) + errorMenu.Add("Error (Custom Message)").OnClick(func(ctx *application.Context) { + app.Dialog.Error(). + SetMessage("This is a custom message"). + Show() + }) + errorMenu.Add("Error (Custom Icon)").OnClick(func(ctx *application.Context) { + dialog := app.Dialog.Error() + dialog.SetTitle("Custom Icon Example") + dialog.SetMessage("Using a custom icon") + dialog.SetIcon(icons.WailsLogoWhite) + dialog.Show() + }) + + openMenu := menu.AddSubmenu("Open") + openMenu.Add("Open File").OnClick(func(ctx *application.Context) { + result, _ := app.Dialog.OpenFile(). + CanChooseFiles(true). + PromptForSingleSelection() + if result != "" { + app.Dialog.Info().SetMessage(result).Show() + } else { + app.Dialog.Info().SetMessage("No file selected").Show() + } + }) + openMenu.Add("Open File (Show Hidden Files)").OnClick(func(ctx *application.Context) { + result, _ := app.Dialog.OpenFile(). + CanChooseFiles(true). + CanCreateDirectories(true). + ShowHiddenFiles(true). + PromptForSingleSelection() + if result != "" { + app.Dialog.Info().SetMessage(result).Show() + } else { + app.Dialog.Info().SetMessage("No file selected").Show() + } + }) + openMenu.Add("Open File (Attach to window)").OnClick(func(ctx *application.Context) { + result, _ := app.Dialog.OpenFile(). + CanChooseFiles(true). + CanCreateDirectories(true). + ShowHiddenFiles(true). + AttachToWindow(app.Window.Current()). + PromptForSingleSelection() + if result != "" { + app.Dialog.Info().SetMessage(result).Show() + } else { + app.Dialog.Info().SetMessage("No file selected").Show() + } + }) + openMenu.Add("Open Multiple Files (Show Hidden Files)").OnClick(func(ctx *application.Context) { + result, _ := app.Dialog.OpenFile(). + CanChooseFiles(true). + CanCreateDirectories(true). + ShowHiddenFiles(true). + PromptForMultipleSelection() + if len(result) > 0 { + app.Dialog.Info().SetMessage(strings.Join(result, ",")).Show() + } else { + app.Dialog.Info().SetMessage("No file selected").Show() + } + }) + openMenu.Add("Open Directory").OnClick(func(ctx *application.Context) { + result, _ := app.Dialog.OpenFile(). + CanChooseDirectories(true). + CanChooseFiles(false). + PromptForSingleSelection() + if result != "" { + app.Dialog.Info().SetMessage(result).Show() + } else { + app.Dialog.Info().SetMessage("No directory selected").Show() + } + }) + openMenu.Add("Open Directory (Create Directories)").OnClick(func(ctx *application.Context) { + result, _ := app.Dialog.OpenFile(). + CanChooseDirectories(true). + CanCreateDirectories(true). + CanChooseFiles(false). + PromptForSingleSelection() + if result != "" { + app.Dialog.Info().SetMessage(result).Show() + } else { + app.Dialog.Info().SetMessage("No directory selected").Show() + } + }) + openMenu.Add("Open Directory (Resolves Aliases)").OnClick(func(ctx *application.Context) { + result, _ := app.Dialog.OpenFile(). + CanChooseDirectories(true). + CanCreateDirectories(true). + CanChooseFiles(false). + ResolvesAliases(true). + PromptForSingleSelection() + if result != "" { + app.Dialog.Info().SetMessage(result).Show() + } else { + app.Dialog.Info().SetMessage("No directory selected").Show() + } + }) + openMenu.Add("Open File/Directory (Set Title)").OnClick(func(ctx *application.Context) { + dialog := app.Dialog.OpenFile(). + CanChooseDirectories(true). + CanCreateDirectories(true). + ResolvesAliases(true) + if runtime.GOOS == "darwin" { + dialog.SetMessage("Select a file/directory") + } else { + dialog.SetTitle("Select a file/directory") + } + + result, _ := dialog.PromptForSingleSelection() + if result != "" { + app.Dialog.Info().SetMessage(result).Show() + } else { + app.Dialog.Info().SetMessage("No file/directory selected").Show() + } + }) + openMenu.Add("Open (Full Example)").OnClick(func(ctx *application.Context) { + cwd, _ := os.Getwd() + dialog := app.Dialog.OpenFile(). + SetTitle("Select a file"). + SetMessage("Select a file to open"). + SetButtonText("Let's do this!"). + SetDirectory(cwd). + CanCreateDirectories(true). + ResolvesAliases(true). + AllowsOtherFileTypes(true). + TreatsFilePackagesAsDirectories(true). + ShowHiddenFiles(true). + CanSelectHiddenExtension(true). + AddFilter("Text Files", "*.txt; *.md"). + AddFilter("Video Files", "*.mov; *.mp4; *.avi") + + if runtime.GOOS == "darwin" { + dialog.SetMessage("Select a file") + } else { + dialog.SetTitle("Select a file") + } + + result, _ := dialog.PromptForSingleSelection() + if result != "" { + app.Dialog.Info().SetMessage(result).Show() + } else { + app.Dialog.Info().SetMessage("No file selected").Show() + } + }) + + saveMenu := menu.AddSubmenu("Save") + saveMenu.Add("Select File (Defaults)").OnClick(func(ctx *application.Context) { + result, _ := app.Dialog.SaveFile(). + PromptForSingleSelection() + if result != "" { + app.Dialog.Info().SetMessage(result).Show() + } + }) + saveMenu.Add("Select File (Attach To WebviewWindow)").OnClick(func(ctx *application.Context) { + result, _ := app.Dialog.SaveFile(). + AttachToWindow(app.Window.Current()). + PromptForSingleSelection() + if result != "" { + app.Dialog.Info().SetMessage(result).Show() + } + }) + saveMenu.Add("Select File (Show Hidden Files)").OnClick(func(ctx *application.Context) { + result, _ := app.Dialog.SaveFile(). + ShowHiddenFiles(true). + PromptForSingleSelection() + if result != "" { + app.Dialog.Info().SetMessage(result).Show() + } + }) + saveMenu.Add("Select File (Cannot Create Directories)").OnClick(func(ctx *application.Context) { + result, _ := app.Dialog.SaveFile(). + CanCreateDirectories(false). + PromptForSingleSelection() + if result != "" { + app.Dialog.Info().SetMessage(result).Show() + } + }) + + userHomeDir, err := os.UserHomeDir() + if err != nil || userHomeDir == "" { + userHomeDir = os.TempDir() + } + + saveMenu.Add("Select File (Full Example)").OnClick(func(ctx *application.Context) { + result, _ := app.Dialog.SaveFile(). + CanCreateDirectories(false). + ShowHiddenFiles(true). + SetMessage("Select a file"). + SetDirectory(userHomeDir). + SetButtonText("Let's do this!"). + SetFilename("README.md"). + HideExtension(true). + AllowsOtherFileTypes(true). + TreatsFilePackagesAsDirectories(true). + ShowHiddenFiles(true). + PromptForSingleSelection() + if result != "" { + app.Dialog.Info().SetMessage(result).Show() + } + }) + + // Set the application menu + app.Menu.Set(menu) + + // Create window with UseApplicationMenu to inherit the app menu on Windows/Linux + app.Window.NewWithOptions(application.WebviewWindowOptions{ + Title: "Dialogs Demo", + UseApplicationMenu: true, + }) + + err = app.Run() + + if err != nil { + log.Fatal(err.Error()) + } +} diff --git a/v3/examples/dock/README.md b/v3/examples/dock/README.md new file mode 100644 index 000000000..ad12c3f40 --- /dev/null +++ b/v3/examples/dock/README.md @@ -0,0 +1,59 @@ +# Welcome to Your New Wails3 Project! + +Congratulations on generating your Wails3 application! This README will guide you through the next steps to get your project up and running. + +## Getting Started + +1. Navigate to your project directory in the terminal. + +2. To run your application in development mode, use the following command: + + ``` + wails3 dev + ``` + + This will start your application and enable hot-reloading for both frontend and backend changes. + +3. To build your application for production, use: + + ``` + wails3 build + ``` + + This will create a production-ready executable in the `build` directory. + +## Exploring Wails3 Features + +Now that you have your project set up, it's time to explore the features that Wails3 offers: + +1. **Check out the examples**: The best way to learn is by example. Visit the `examples` directory in the `v3/examples` directory to see various sample applications. + +2. **Run an example**: To run any of the examples, navigate to the example's directory and use: + + ``` + go run . + ``` + + Note: Some examples may be under development during the alpha phase. + +3. **Explore the documentation**: Visit the [Wails3 documentation](https://v3.wails.io/) for in-depth guides and API references. + +4. **Join the community**: Have questions or want to share your progress? Join the [Wails Discord](https://discord.gg/JDdSxwjhGf) or visit the [Wails discussions on GitHub](https://github.com/wailsapp/wails/discussions). + +## Project Structure + +Take a moment to familiarize yourself with your project structure: + +- `frontend/`: Contains your frontend code (HTML, CSS, JavaScript/TypeScript) +- `main.go`: The entry point of your Go backend +- `app.go`: Define your application structure and methods here +- `wails.json`: Configuration file for your Wails project + +## Next Steps + +1. Modify the frontend in the `frontend/` directory to create your desired UI. +2. Add backend functionality in `main.go`. +3. Use `wails3 dev` to see your changes in real-time. +4. When ready, build your application with `wails3 build`. + +Happy coding with Wails3! If you encounter any issues or have questions, don't hesitate to consult the documentation or reach out to the Wails community. diff --git a/v3/examples/dock/Taskfile.yml b/v3/examples/dock/Taskfile.yml new file mode 100644 index 000000000..b80b6614a --- /dev/null +++ b/v3/examples/dock/Taskfile.yml @@ -0,0 +1,34 @@ +version: '3' + +includes: + common: ./build/Taskfile.yml + windows: ./build/windows/Taskfile.yml + darwin: ./build/darwin/Taskfile.yml + linux: ./build/linux/Taskfile.yml + +vars: + APP_NAME: "dock" + BIN_DIR: "bin" + VITE_PORT: '{{.WAILS_VITE_PORT | default 9245}}' + +tasks: + build: + summary: Builds the application + cmds: + - task: "{{OS}}:build" + + package: + summary: Packages a production build of the application + cmds: + - task: "{{OS}}:package" + + run: + summary: Runs the application + cmds: + - task: "{{OS}}:run" + + dev: + summary: Runs the application in development mode + cmds: + - wails3 dev -config ./build/config.yml -port {{.VITE_PORT}} + diff --git a/v3/examples/dock/build/Taskfile.yml b/v3/examples/dock/build/Taskfile.yml new file mode 100644 index 000000000..f0aab9b9c --- /dev/null +++ b/v3/examples/dock/build/Taskfile.yml @@ -0,0 +1,87 @@ +version: '3' + +tasks: + go:mod:tidy: + summary: Runs `go mod tidy` + internal: true + cmds: + - go mod tidy + + install:frontend:deps: + summary: Install frontend dependencies + dir: frontend + sources: + - package.json + - package-lock.json + generates: + - node_modules/* + preconditions: + - sh: npm version + msg: "Looks like npm isn't installed. Npm is part of the Node installer: https://nodejs.org/en/download/" + cmds: + - npm install + + build:frontend: + label: build:frontend (PRODUCTION={{.PRODUCTION}}) + summary: Build the frontend project + dir: frontend + sources: + - "**/*" + - exclude: node_modules/**/* + generates: + - dist/**/* + deps: + - task: install:frontend:deps + - task: generate:bindings + vars: + BUILD_FLAGS: + ref: .BUILD_FLAGS + cmds: + - npm run {{.BUILD_COMMAND}} -q + env: + PRODUCTION: '{{.PRODUCTION | default "false"}}' + vars: + BUILD_COMMAND: '{{if eq .PRODUCTION "true"}}build{{else}}build:dev{{end}}' + + + generate:bindings: + label: generate:bindings (BUILD_FLAGS={{.BUILD_FLAGS}}) + summary: Generates bindings for the frontend + deps: + - task: go:mod:tidy + sources: + - "**/*.[jt]s" + - exclude: frontend/**/* + - frontend/bindings/**/* # Rerun when switching between dev/production mode causes changes in output + - "**/*.go" + - go.mod + - go.sum + generates: + - frontend/bindings/**/* + cmds: + - wails3 generate bindings -f '{{.BUILD_FLAGS}}' -clean=true -ts + + generate:icons: + summary: Generates Windows `.ico` and Mac `.icns` files from an image + dir: build + sources: + - "appicon.png" + generates: + - "darwin/icons.icns" + - "windows/icon.ico" + cmds: + - wails3 generate icons -input appicon.png -macfilename darwin/icons.icns -windowsfilename windows/icon.ico + + dev:frontend: + summary: Runs the frontend in development mode + dir: frontend + deps: + - task: install:frontend:deps + cmds: + - npm run dev -- --port {{.VITE_PORT}} --strictPort + + update:build-assets: + summary: Updates the build assets + dir: build + cmds: + - wails3 update build-assets -name "{{.APP_NAME}}" -binaryname "{{.APP_NAME}}" -config config.yml -dir . diff --git a/v3/examples/dock/build/appicon.png b/v3/examples/dock/build/appicon.png new file mode 100644 index 000000000..63617fe4f Binary files /dev/null and b/v3/examples/dock/build/appicon.png differ diff --git a/v3/examples/dock/build/config.yml b/v3/examples/dock/build/config.yml new file mode 100644 index 000000000..aaa3240fb --- /dev/null +++ b/v3/examples/dock/build/config.yml @@ -0,0 +1,63 @@ +# This file contains the configuration for this project. +# When you update `info` or `fileAssociations`, run `wails3 task common:update:build-assets` to update the assets. +# Note that this will overwrite any changes you have made to the assets. +version: '3' + +# This information is used to generate the build assets. +info: + companyName: "My Company" # The name of the company + productName: "My Product" # The name of the application + productIdentifier: "com.mycompany.myproduct" # The unique product identifier + description: "A program that does X" # The application description + copyright: "(c) 2025, My Company" # Copyright text + comments: "Some Product Comments" # Comments + version: "0.0.1" # The application version + +# Dev mode configuration +dev_mode: + root_path: . + log_level: warn + debounce: 1000 + ignore: + dir: + - .git + - node_modules + - frontend + - bin + file: + - .DS_Store + - .gitignore + - .gitkeep + watched_extension: + - "*.go" + git_ignore: true + executes: + - cmd: wails3 task common:install:frontend:deps + type: once + - cmd: wails3 task common:dev:frontend + type: background + - cmd: go mod tidy + type: blocking + - cmd: wails3 task build + type: blocking + - cmd: wails3 task run + type: primary + +# File Associations +# More information at: https://v3.wails.io/noit/done/yet +fileAssociations: +# - ext: wails +# name: Wails +# description: Wails Application File +# iconName: wailsFileIcon +# role: Editor +# - ext: jpg +# name: JPEG +# description: Image File +# iconName: jpegFileIcon +# role: Editor +# mimeType: image/jpeg # (optional) + +# Other data +other: + - name: My Other Data \ No newline at end of file diff --git a/v3/examples/dock/build/darwin/Info.dev.plist b/v3/examples/dock/build/darwin/Info.dev.plist new file mode 100644 index 000000000..58d7f65e7 --- /dev/null +++ b/v3/examples/dock/build/darwin/Info.dev.plist @@ -0,0 +1,32 @@ + + + + CFBundlePackageType + APPL + CFBundleName + My Product + CFBundleExecutable + dock + CFBundleIdentifier + com.wails.dock + CFBundleVersion + 0.1.0 + CFBundleGetInfoString + This is a comment + CFBundleShortVersionString + 0.1.0 + CFBundleIconFile + icons + LSMinimumSystemVersion + 10.15.0 + NSHighResolutionCapable + true + NSHumanReadableCopyright + © now, My Company + NSAppTransportSecurity + + NSAllowsLocalNetworking + + + + \ No newline at end of file diff --git a/v3/examples/dock/build/darwin/Info.plist b/v3/examples/dock/build/darwin/Info.plist new file mode 100644 index 000000000..aff7a2812 --- /dev/null +++ b/v3/examples/dock/build/darwin/Info.plist @@ -0,0 +1,27 @@ + + + + CFBundlePackageType + APPL + CFBundleName + My Product + CFBundleExecutable + dock + CFBundleIdentifier + com.wails.dock + CFBundleVersion + 0.1.0 + CFBundleGetInfoString + This is a comment + CFBundleShortVersionString + 0.1.0 + CFBundleIconFile + icons + LSMinimumSystemVersion + 10.15.0 + NSHighResolutionCapable + true + NSHumanReadableCopyright + © now, My Company + + \ No newline at end of file diff --git a/v3/examples/dock/build/darwin/Taskfile.yml b/v3/examples/dock/build/darwin/Taskfile.yml new file mode 100644 index 000000000..f0791fea9 --- /dev/null +++ b/v3/examples/dock/build/darwin/Taskfile.yml @@ -0,0 +1,81 @@ +version: '3' + +includes: + common: ../Taskfile.yml + +tasks: + build: + summary: Creates a production build of the application + deps: + - task: common:go:mod:tidy + - task: common:build:frontend + vars: + BUILD_FLAGS: + ref: .BUILD_FLAGS + PRODUCTION: + ref: .PRODUCTION + - task: common:generate:icons + cmds: + - go build {{.BUILD_FLAGS}} -o {{.OUTPUT}} + vars: + BUILD_FLAGS: '{{if eq .PRODUCTION "true"}}-tags production -trimpath -buildvcs=false -ldflags="-w -s"{{else}}-buildvcs=false -gcflags=all="-l"{{end}}' + DEFAULT_OUTPUT: '{{.BIN_DIR}}/{{.APP_NAME}}' + OUTPUT: '{{ .OUTPUT | default .DEFAULT_OUTPUT }}' + env: + GOOS: darwin + CGO_ENABLED: 1 + GOARCH: '{{.ARCH | default ARCH}}' + CGO_CFLAGS: "-mmacosx-version-min=10.15" + CGO_LDFLAGS: "-mmacosx-version-min=10.15" + MACOSX_DEPLOYMENT_TARGET: "10.15" + PRODUCTION: '{{.PRODUCTION | default "false"}}' + + build:universal: + summary: Builds darwin universal binary (arm64 + amd64) + deps: + - task: build + vars: + ARCH: amd64 + OUTPUT: "{{.BIN_DIR}}/{{.APP_NAME}}-amd64" + - task: build + vars: + ARCH: arm64 + OUTPUT: "{{.BIN_DIR}}/{{.APP_NAME}}-arm64" + cmds: + - lipo -create -output "{{.BIN_DIR}}/{{.APP_NAME}}" "{{.BIN_DIR}}/{{.APP_NAME}}-amd64" "{{.BIN_DIR}}/{{.APP_NAME}}-arm64" + - rm "{{.BIN_DIR}}/{{.APP_NAME}}-amd64" "{{.BIN_DIR}}/{{.APP_NAME}}-arm64" + + package: + summary: Packages a production build of the application into a `.app` bundle + deps: + - task: build + vars: + PRODUCTION: "true" + cmds: + - task: create:app:bundle + + package:universal: + summary: Packages darwin universal binary (arm64 + amd64) + deps: + - task: build:universal + cmds: + - task: create:app:bundle + + + create:app:bundle: + summary: Creates an `.app` bundle + cmds: + - mkdir -p {{.BIN_DIR}}/{{.APP_NAME}}.app/Contents/{MacOS,Resources} + - cp build/darwin/icons.icns {{.BIN_DIR}}/{{.APP_NAME}}.app/Contents/Resources + - cp {{.BIN_DIR}}/{{.APP_NAME}} {{.BIN_DIR}}/{{.APP_NAME}}.app/Contents/MacOS + - cp build/darwin/Info.plist {{.BIN_DIR}}/{{.APP_NAME}}.app/Contents + - codesign --force --deep --sign - {{.BIN_DIR}}/{{.APP_NAME}}.app + + run: + cmds: + - mkdir -p {{.BIN_DIR}}/{{.APP_NAME}}.dev.app/Contents/{MacOS,Resources} + - cp build/darwin/icons.icns {{.BIN_DIR}}/{{.APP_NAME}}.dev.app/Contents/Resources + - cp {{.BIN_DIR}}/{{.APP_NAME}} {{.BIN_DIR}}/{{.APP_NAME}}.dev.app/Contents/MacOS + - cp build/darwin/Info.dev.plist {{.BIN_DIR}}/{{.APP_NAME}}.dev.app/Contents/Info.plist + - codesign --force --deep --sign - {{.BIN_DIR}}/{{.APP_NAME}}.dev.app + - '{{.BIN_DIR}}/{{.APP_NAME}}.dev.app/Contents/MacOS/{{.APP_NAME}}' diff --git a/v3/examples/dock/build/darwin/icons.icns b/v3/examples/dock/build/darwin/icons.icns new file mode 100644 index 000000000..1b5bd4c86 Binary files /dev/null and b/v3/examples/dock/build/darwin/icons.icns differ diff --git a/v3/examples/dock/build/linux/Taskfile.yml b/v3/examples/dock/build/linux/Taskfile.yml new file mode 100644 index 000000000..560cc9c92 --- /dev/null +++ b/v3/examples/dock/build/linux/Taskfile.yml @@ -0,0 +1,119 @@ +version: '3' + +includes: + common: ../Taskfile.yml + +tasks: + build: + summary: Builds the application for Linux + deps: + - task: common:go:mod:tidy + - task: common:build:frontend + vars: + BUILD_FLAGS: + ref: .BUILD_FLAGS + PRODUCTION: + ref: .PRODUCTION + - task: common:generate:icons + cmds: + - go build {{.BUILD_FLAGS}} -o {{.BIN_DIR}}/{{.APP_NAME}} + vars: + BUILD_FLAGS: '{{if eq .PRODUCTION "true"}}-tags production -trimpath -buildvcs=false -ldflags="-w -s"{{else}}-buildvcs=false -gcflags=all="-l"{{end}}' + env: + GOOS: linux + CGO_ENABLED: 1 + GOARCH: '{{.ARCH | default ARCH}}' + PRODUCTION: '{{.PRODUCTION | default "false"}}' + + package: + summary: Packages a production build of the application for Linux + deps: + - task: build + vars: + PRODUCTION: "true" + cmds: + - task: create:appimage + - task: create:deb + - task: create:rpm + - task: create:aur + + create:appimage: + summary: Creates an AppImage + dir: build/linux/appimage + deps: + - task: build + vars: + PRODUCTION: "true" + - task: generate:dotdesktop + cmds: + - cp {{.APP_BINARY}} {{.APP_NAME}} + - cp ../../appicon.png appicon.png + - wails3 generate appimage -binary {{.APP_NAME}} -icon {{.ICON}} -desktopfile {{.DESKTOP_FILE}} -outputdir {{.OUTPUT_DIR}} -builddir {{.ROOT_DIR}}/build/linux/appimage/build + vars: + APP_NAME: '{{.APP_NAME}}' + APP_BINARY: '../../../bin/{{.APP_NAME}}' + ICON: '../../appicon.png' + DESKTOP_FILE: '../{{.APP_NAME}}.desktop' + OUTPUT_DIR: '../../../bin' + + create:deb: + summary: Creates a deb package + deps: + - task: build + vars: + PRODUCTION: "true" + cmds: + - task: generate:dotdesktop + - task: generate:deb + + create:rpm: + summary: Creates a rpm package + deps: + - task: build + vars: + PRODUCTION: "true" + cmds: + - task: generate:dotdesktop + - task: generate:rpm + + create:aur: + summary: Creates a arch linux packager package + deps: + - task: build + vars: + PRODUCTION: "true" + cmds: + - task: generate:dotdesktop + - task: generate:aur + + generate:deb: + summary: Creates a deb package + cmds: + - wails3 tool package -name {{.APP_NAME}} -format deb -config ./build/linux/nfpm/nfpm.yaml -out {{.ROOT_DIR}}/bin + + generate:rpm: + summary: Creates a rpm package + cmds: + - wails3 tool package -name {{.APP_NAME}} -format rpm -config ./build/linux/nfpm/nfpm.yaml -out {{.ROOT_DIR}}/bin + + generate:aur: + summary: Creates a arch linux packager package + cmds: + - wails3 tool package -name {{.APP_NAME}} -format archlinux -config ./build/linux/nfpm/nfpm.yaml -out {{.ROOT_DIR}}/bin + + generate:dotdesktop: + summary: Generates a `.desktop` file + dir: build + cmds: + - mkdir -p {{.ROOT_DIR}}/build/linux/appimage + - wails3 generate .desktop -name "{{.APP_NAME}}" -exec "{{.EXEC}}" -icon "{{.ICON}}" -outputfile {{.ROOT_DIR}}/build/linux/{{.APP_NAME}}.desktop -categories "{{.CATEGORIES}}" + vars: + APP_NAME: '{{.APP_NAME}}' + EXEC: '{{.APP_NAME}}' + ICON: 'appicon' + CATEGORIES: 'Development;' + OUTPUTFILE: '{{.ROOT_DIR}}/build/linux/{{.APP_NAME}}.desktop' + + run: + cmds: + - '{{.BIN_DIR}}/{{.APP_NAME}}' diff --git a/v3/examples/dock/build/linux/appimage/build.sh b/v3/examples/dock/build/linux/appimage/build.sh new file mode 100644 index 000000000..85901c34e --- /dev/null +++ b/v3/examples/dock/build/linux/appimage/build.sh @@ -0,0 +1,35 @@ +#!/usr/bin/env bash +# Copyright (c) 2018-Present Lea Anthony +# SPDX-License-Identifier: MIT + +# Fail script on any error +set -euxo pipefail + +# Define variables +APP_DIR="${APP_NAME}.AppDir" + +# Create AppDir structure +mkdir -p "${APP_DIR}/usr/bin" +cp -r "${APP_BINARY}" "${APP_DIR}/usr/bin/" +cp "${ICON_PATH}" "${APP_DIR}/" +cp "${DESKTOP_FILE}" "${APP_DIR}/" + +if [[ $(uname -m) == *x86_64* ]]; then + # Download linuxdeploy and make it executable + wget -q -4 -N https://github.com/linuxdeploy/linuxdeploy/releases/download/continuous/linuxdeploy-x86_64.AppImage + chmod +x linuxdeploy-x86_64.AppImage + + # Run linuxdeploy to bundle the application + ./linuxdeploy-x86_64.AppImage --appdir "${APP_DIR}" --output appimage +else + # Download linuxdeploy and make it executable (arm64) + wget -q -4 -N https://github.com/linuxdeploy/linuxdeploy/releases/download/continuous/linuxdeploy-aarch64.AppImage + chmod +x linuxdeploy-aarch64.AppImage + + # Run linuxdeploy to bundle the application (arm64) + ./linuxdeploy-aarch64.AppImage --appdir "${APP_DIR}" --output appimage +fi + +# Rename the generated AppImage +mv "${APP_NAME}*.AppImage" "${APP_NAME}.AppImage" + diff --git a/v3/examples/dock/build/linux/desktop b/v3/examples/dock/build/linux/desktop new file mode 100644 index 000000000..ddb025903 --- /dev/null +++ b/v3/examples/dock/build/linux/desktop @@ -0,0 +1,13 @@ +[Desktop Entry] +Version=1.0 +Name=My Product +Comment=My Product Description +# The Exec line includes %u to pass the URL to the application +Exec=/usr/local/bin/dock %u +Terminal=false +Type=Application +Icon=dock +Categories=Utility; +StartupWMClass=dock + + diff --git a/v3/examples/dock/build/linux/nfpm/nfpm.yaml b/v3/examples/dock/build/linux/nfpm/nfpm.yaml new file mode 100644 index 000000000..6e9be6550 --- /dev/null +++ b/v3/examples/dock/build/linux/nfpm/nfpm.yaml @@ -0,0 +1,73 @@ +# Feel free to remove those if you don't want/need to use them. +# Make sure to check the documentation at https://nfpm.goreleaser.com +# +# The lines below are called `modelines`. See `:help modeline` + +name: "dock" +arch: ${GOARCH} +platform: "linux" +version: "0.1.0" +section: "default" +priority: "extra" +maintainer: ${GIT_COMMITTER_NAME} <${GIT_COMMITTER_EMAIL}> +description: "My Product Description" +vendor: "My Company" +homepage: "https://wails.io" +license: "MIT" +release: "1" + +contents: + - src: "./bin/dock" + dst: "/usr/local/bin/dock" + - src: "./build/appicon.png" + dst: "/usr/share/icons/hicolor/128x128/apps/dock.png" + - src: "./build/linux/dock.desktop" + dst: "/usr/share/applications/dock.desktop" + +# Default dependencies for Debian 12/Ubuntu 22.04+ with WebKit 4.1 +depends: + - libgtk-3-dev + - libwebkit2gtk-4.1-dev + - build-essential + - pkg-config + +# Distribution-specific overrides for different package formats and WebKit versions +overrides: + # RPM packages for RHEL/CentOS/AlmaLinux/Rocky Linux (WebKit 4.0) + rpm: + depends: + - gtk3-devel + - webkit2gtk3-devel + - gcc-c++ + - pkg-config + + # Arch Linux packages (WebKit 4.1) + archlinux: + depends: + - gtk3 + - webkit2gtk-4.1 + - base-devel + - pkgconf + +# scripts section to ensure desktop database is updated after install +scripts: + postinstall: "./build/linux/nfpm/scripts/postinstall.sh" + # You can also add preremove, postremove if needed + # preremove: "./build/linux/nfpm/scripts/preremove.sh" + # postremove: "./build/linux/nfpm/scripts/postremove.sh" + +# replaces: +# - foobar +# provides: +# - bar +# depends: +# - gtk3 +# - libwebkit2gtk +# recommends: +# - whatever +# suggests: +# - something-else +# conflicts: +# - not-foo +# - not-bar +# changelog: "changelog.yaml" \ No newline at end of file diff --git a/v3/examples/dock/build/linux/nfpm/scripts/postinstall.sh b/v3/examples/dock/build/linux/nfpm/scripts/postinstall.sh new file mode 100644 index 000000000..4bbb815a3 --- /dev/null +++ b/v3/examples/dock/build/linux/nfpm/scripts/postinstall.sh @@ -0,0 +1,21 @@ +#!/bin/sh + +# Update desktop database for .desktop file changes +# This makes the application appear in application menus and registers its capabilities. +if command -v update-desktop-database >/dev/null 2>&1; then + echo "Updating desktop database..." + update-desktop-database -q /usr/share/applications +else + echo "Warning: update-desktop-database command not found. Desktop file may not be immediately recognized." >&2 +fi + +# Update MIME database for custom URL schemes (x-scheme-handler) +# This ensures the system knows how to handle your custom protocols. +if command -v update-mime-database >/dev/null 2>&1; then + echo "Updating MIME database..." + update-mime-database -n /usr/share/mime +else + echo "Warning: update-mime-database command not found. Custom URL schemes may not be immediately recognized." >&2 +fi + +exit 0 diff --git a/v3/examples/dock/build/linux/nfpm/scripts/postremove.sh b/v3/examples/dock/build/linux/nfpm/scripts/postremove.sh new file mode 100644 index 000000000..a9bf588e2 --- /dev/null +++ b/v3/examples/dock/build/linux/nfpm/scripts/postremove.sh @@ -0,0 +1 @@ +#!/bin/bash diff --git a/v3/examples/dock/build/linux/nfpm/scripts/preinstall.sh b/v3/examples/dock/build/linux/nfpm/scripts/preinstall.sh new file mode 100644 index 000000000..a9bf588e2 --- /dev/null +++ b/v3/examples/dock/build/linux/nfpm/scripts/preinstall.sh @@ -0,0 +1 @@ +#!/bin/bash diff --git a/v3/examples/dock/build/linux/nfpm/scripts/preremove.sh b/v3/examples/dock/build/linux/nfpm/scripts/preremove.sh new file mode 100644 index 000000000..a9bf588e2 --- /dev/null +++ b/v3/examples/dock/build/linux/nfpm/scripts/preremove.sh @@ -0,0 +1 @@ +#!/bin/bash diff --git a/v3/examples/dock/build/windows/Taskfile.yml b/v3/examples/dock/build/windows/Taskfile.yml new file mode 100644 index 000000000..19f137616 --- /dev/null +++ b/v3/examples/dock/build/windows/Taskfile.yml @@ -0,0 +1,98 @@ +version: '3' + +includes: + common: ../Taskfile.yml + +tasks: + build: + summary: Builds the application for Windows + deps: + - task: common:go:mod:tidy + - task: common:build:frontend + vars: + BUILD_FLAGS: + ref: .BUILD_FLAGS + PRODUCTION: + ref: .PRODUCTION + - task: common:generate:icons + cmds: + - task: generate:syso + - go build {{.BUILD_FLAGS}} -o {{.BIN_DIR}}/{{.APP_NAME}}.exe + - cmd: powershell Remove-item *.syso + platforms: [windows] + - cmd: rm -f *.syso + platforms: [linux, darwin] + vars: + BUILD_FLAGS: '{{if eq .PRODUCTION "true"}}-tags production -trimpath -buildvcs=false -ldflags="-w -s -H windowsgui"{{else}}-buildvcs=false -gcflags=all="-l"{{end}}' + env: + GOOS: windows + CGO_ENABLED: 0 + GOARCH: '{{.ARCH | default ARCH}}' + PRODUCTION: '{{.PRODUCTION | default "false"}}' + + package: + summary: Packages a production build of the application + cmds: + - |- + if [ "{{.FORMAT | default "nsis"}}" = "msix" ]; then + task: create:msix:package + else + task: create:nsis:installer + fi + vars: + FORMAT: '{{.FORMAT | default "nsis"}}' + + generate:syso: + summary: Generates Windows `.syso` file + dir: build + cmds: + - wails3 generate syso -arch {{.ARCH}} -icon windows/icon.ico -manifest windows/wails.exe.manifest -info windows/info.json -out ../wails_windows_{{.ARCH}}.syso + vars: + ARCH: '{{.ARCH | default ARCH}}' + + create:nsis:installer: + summary: Creates an NSIS installer + dir: build/windows/nsis + deps: + - task: build + vars: + PRODUCTION: "true" + cmds: + # Create the Microsoft WebView2 bootstrapper if it doesn't exist + - wails3 generate webview2bootstrapper -dir "{{.ROOT_DIR}}/build/windows/nsis" + - makensis -DARG_WAILS_{{.ARG_FLAG}}_BINARY="{{.ROOT_DIR}}/{{.BIN_DIR}}/{{.APP_NAME}}.exe" project.nsi + vars: + ARCH: '{{.ARCH | default ARCH}}' + ARG_FLAG: '{{if eq .ARCH "amd64"}}AMD64{{else}}ARM64{{end}}' + + create:msix:package: + summary: Creates an MSIX package + deps: + - task: build + vars: + PRODUCTION: "true" + cmds: + - |- + wails3 tool msix \ + --config "{{.ROOT_DIR}}/wails.json" \ + --name "{{.APP_NAME}}" \ + --executable "{{.ROOT_DIR}}/{{.BIN_DIR}}/{{.APP_NAME}}.exe" \ + --arch "{{.ARCH}}" \ + --out "{{.ROOT_DIR}}/{{.BIN_DIR}}/{{.APP_NAME}}-{{.ARCH}}.msix" \ + {{if .CERT_PATH}}--cert "{{.CERT_PATH}}"{{end}} \ + {{if .PUBLISHER}}--publisher "{{.PUBLISHER}}"{{end}} \ + {{if .USE_MSIX_TOOL}}--use-msix-tool{{else}}--use-makeappx{{end}} + vars: + ARCH: '{{.ARCH | default ARCH}}' + CERT_PATH: '{{.CERT_PATH | default ""}}' + PUBLISHER: '{{.PUBLISHER | default ""}}' + USE_MSIX_TOOL: '{{.USE_MSIX_TOOL | default "false"}}' + + install:msix:tools: + summary: Installs tools required for MSIX packaging + cmds: + - wails3 tool msix-install-tools + + run: + cmds: + - '{{.BIN_DIR}}/{{.APP_NAME}}.exe' diff --git a/v3/examples/dock/build/windows/icon.ico b/v3/examples/dock/build/windows/icon.ico new file mode 100644 index 000000000..bfa0690b7 Binary files /dev/null and b/v3/examples/dock/build/windows/icon.ico differ diff --git a/v3/examples/dock/build/windows/info.json b/v3/examples/dock/build/windows/info.json new file mode 100644 index 000000000..850b2b5b0 --- /dev/null +++ b/v3/examples/dock/build/windows/info.json @@ -0,0 +1,15 @@ +{ + "fixed": { + "file_version": "0.1.0" + }, + "info": { + "0000": { + "ProductVersion": "0.1.0", + "CompanyName": "My Company", + "FileDescription": "My Product Description", + "LegalCopyright": "© now, My Company", + "ProductName": "My Product", + "Comments": "This is a comment" + } + } +} \ No newline at end of file diff --git a/v3/examples/dock/build/windows/msix/app_manifest.xml b/v3/examples/dock/build/windows/msix/app_manifest.xml new file mode 100644 index 000000000..8eabe1a03 --- /dev/null +++ b/v3/examples/dock/build/windows/msix/app_manifest.xml @@ -0,0 +1,52 @@ + + + + + + + My Product + My Company + My Product Description + Assets\StoreLogo.png + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/v3/examples/dock/build/windows/msix/template.xml b/v3/examples/dock/build/windows/msix/template.xml new file mode 100644 index 000000000..2824a2932 --- /dev/null +++ b/v3/examples/dock/build/windows/msix/template.xml @@ -0,0 +1,54 @@ + + + + + + + + + + + + + + + + + + + + + + + + false + My Product + My Company + My Product Description + Assets\AppIcon.png + + + + + + + diff --git a/v3/examples/dock/build/windows/nsis/project.nsi b/v3/examples/dock/build/windows/nsis/project.nsi new file mode 100644 index 000000000..b992809bc --- /dev/null +++ b/v3/examples/dock/build/windows/nsis/project.nsi @@ -0,0 +1,112 @@ +Unicode true + +#### +## Please note: Template replacements don't work in this file. They are provided with default defines like +## mentioned underneath. +## If the keyword is not defined, "wails_tools.nsh" will populate them. +## If they are defined here, "wails_tools.nsh" will not touch them. This allows you to use this project.nsi manually +## from outside of Wails for debugging and development of the installer. +## +## For development first make a wails nsis build to populate the "wails_tools.nsh": +## > wails build --target windows/amd64 --nsis +## Then you can call makensis on this file with specifying the path to your binary: +## For a AMD64 only installer: +## > makensis -DARG_WAILS_AMD64_BINARY=..\..\bin\app.exe +## For a ARM64 only installer: +## > makensis -DARG_WAILS_ARM64_BINARY=..\..\bin\app.exe +## For a installer with both architectures: +## > makensis -DARG_WAILS_AMD64_BINARY=..\..\bin\app-amd64.exe -DARG_WAILS_ARM64_BINARY=..\..\bin\app-arm64.exe +#### +## The following information is taken from the wails_tools.nsh file, but they can be overwritten here. +#### +## !define INFO_PROJECTNAME "my-project" # Default "dock" +## !define INFO_COMPANYNAME "My Company" # Default "My Company" +## !define INFO_PRODUCTNAME "My Product Name" # Default "My Product" +## !define INFO_PRODUCTVERSION "1.0.0" # Default "0.1.0" +## !define INFO_COPYRIGHT "(c) Now, My Company" # Default "© now, My Company" +### +## !define PRODUCT_EXECUTABLE "Application.exe" # Default "${INFO_PROJECTNAME}.exe" +## !define UNINST_KEY_NAME "UninstKeyInRegistry" # Default "${INFO_COMPANYNAME}${INFO_PRODUCTNAME}" +#### +## !define REQUEST_EXECUTION_LEVEL "admin" # Default "admin" see also https://nsis.sourceforge.io/Docs/Chapter4.html +#### +## Include the wails tools +#### +!include "wails_tools.nsh" + +# The version information for this two must consist of 4 parts +VIProductVersion "${INFO_PRODUCTVERSION}.0" +VIFileVersion "${INFO_PRODUCTVERSION}.0" + +VIAddVersionKey "CompanyName" "${INFO_COMPANYNAME}" +VIAddVersionKey "FileDescription" "${INFO_PRODUCTNAME} Installer" +VIAddVersionKey "ProductVersion" "${INFO_PRODUCTVERSION}" +VIAddVersionKey "FileVersion" "${INFO_PRODUCTVERSION}" +VIAddVersionKey "LegalCopyright" "${INFO_COPYRIGHT}" +VIAddVersionKey "ProductName" "${INFO_PRODUCTNAME}" + +# Enable HiDPI support. https://nsis.sourceforge.io/Reference/ManifestDPIAware +ManifestDPIAware true + +!include "MUI.nsh" + +!define MUI_ICON "..\icon.ico" +!define MUI_UNICON "..\icon.ico" +# !define MUI_WELCOMEFINISHPAGE_BITMAP "resources\leftimage.bmp" #Include this to add a bitmap on the left side of the Welcome Page. Must be a size of 164x314 +!define MUI_FINISHPAGE_NOAUTOCLOSE # Wait on the INSTFILES page so the user can take a look into the details of the installation steps +!define MUI_ABORTWARNING # This will warn the user if they exit from the installer. + +!insertmacro MUI_PAGE_WELCOME # Welcome to the installer page. +# !insertmacro MUI_PAGE_LICENSE "resources\eula.txt" # Adds a EULA page to the installer +!insertmacro MUI_PAGE_DIRECTORY # In which folder install page. +!insertmacro MUI_PAGE_INSTFILES # Installing page. +!insertmacro MUI_PAGE_FINISH # Finished installation page. + +!insertmacro MUI_UNPAGE_INSTFILES # Uninstalling page + +!insertmacro MUI_LANGUAGE "English" # Set the Language of the installer + +## The following two statements can be used to sign the installer and the uninstaller. The path to the binaries are provided in %1 +#!uninstfinalize 'signtool --file "%1"' +#!finalize 'signtool --file "%1"' + +Name "${INFO_PRODUCTNAME}" +OutFile "..\..\..\bin\${INFO_PROJECTNAME}-${ARCH}-installer.exe" # Name of the installer's file. +InstallDir "$PROGRAMFILES64\${INFO_COMPANYNAME}\${INFO_PRODUCTNAME}" # Default installing folder ($PROGRAMFILES is Program Files folder). +ShowInstDetails show # This will always show the installation details. + +Function .onInit + !insertmacro wails.checkArchitecture +FunctionEnd + +Section + !insertmacro wails.setShellContext + + !insertmacro wails.webview2runtime + + SetOutPath $INSTDIR + + !insertmacro wails.files + + CreateShortcut "$SMPROGRAMS\${INFO_PRODUCTNAME}.lnk" "$INSTDIR\${PRODUCT_EXECUTABLE}" + CreateShortCut "$DESKTOP\${INFO_PRODUCTNAME}.lnk" "$INSTDIR\${PRODUCT_EXECUTABLE}" + + !insertmacro wails.associateFiles + + !insertmacro wails.writeUninstaller +SectionEnd + +Section "uninstall" + !insertmacro wails.setShellContext + + RMDir /r "$AppData\${PRODUCT_EXECUTABLE}" # Remove the WebView2 DataPath + + RMDir /r $INSTDIR + + Delete "$SMPROGRAMS\${INFO_PRODUCTNAME}.lnk" + Delete "$DESKTOP\${INFO_PRODUCTNAME}.lnk" + + !insertmacro wails.unassociateFiles + + !insertmacro wails.deleteUninstaller +SectionEnd diff --git a/v3/examples/dock/build/windows/nsis/wails_tools.nsh b/v3/examples/dock/build/windows/nsis/wails_tools.nsh new file mode 100644 index 000000000..b5ff5b23c --- /dev/null +++ b/v3/examples/dock/build/windows/nsis/wails_tools.nsh @@ -0,0 +1,212 @@ +# DO NOT EDIT - Generated automatically by `wails build` + +!include "x64.nsh" +!include "WinVer.nsh" +!include "FileFunc.nsh" + +!ifndef INFO_PROJECTNAME + !define INFO_PROJECTNAME "dock" +!endif +!ifndef INFO_COMPANYNAME + !define INFO_COMPANYNAME "My Company" +!endif +!ifndef INFO_PRODUCTNAME + !define INFO_PRODUCTNAME "My Product" +!endif +!ifndef INFO_PRODUCTVERSION + !define INFO_PRODUCTVERSION "0.1.0" +!endif +!ifndef INFO_COPYRIGHT + !define INFO_COPYRIGHT "© now, My Company" +!endif +!ifndef PRODUCT_EXECUTABLE + !define PRODUCT_EXECUTABLE "${INFO_PROJECTNAME}.exe" +!endif +!ifndef UNINST_KEY_NAME + !define UNINST_KEY_NAME "${INFO_COMPANYNAME}${INFO_PRODUCTNAME}" +!endif +!define UNINST_KEY "Software\Microsoft\Windows\CurrentVersion\Uninstall\${UNINST_KEY_NAME}" + +!ifndef REQUEST_EXECUTION_LEVEL + !define REQUEST_EXECUTION_LEVEL "admin" +!endif + +RequestExecutionLevel "${REQUEST_EXECUTION_LEVEL}" + +!ifdef ARG_WAILS_AMD64_BINARY + !define SUPPORTS_AMD64 +!endif + +!ifdef ARG_WAILS_ARM64_BINARY + !define SUPPORTS_ARM64 +!endif + +!ifdef SUPPORTS_AMD64 + !ifdef SUPPORTS_ARM64 + !define ARCH "amd64_arm64" + !else + !define ARCH "amd64" + !endif +!else + !ifdef SUPPORTS_ARM64 + !define ARCH "arm64" + !else + !error "Wails: Undefined ARCH, please provide at least one of ARG_WAILS_AMD64_BINARY or ARG_WAILS_ARM64_BINARY" + !endif +!endif + +!macro wails.checkArchitecture + !ifndef WAILS_WIN10_REQUIRED + !define WAILS_WIN10_REQUIRED "This product is only supported on Windows 10 (Server 2016) and later." + !endif + + !ifndef WAILS_ARCHITECTURE_NOT_SUPPORTED + !define WAILS_ARCHITECTURE_NOT_SUPPORTED "This product can't be installed on the current Windows architecture. Supports: ${ARCH}" + !endif + + ${If} ${AtLeastWin10} + !ifdef SUPPORTS_AMD64 + ${if} ${IsNativeAMD64} + Goto ok + ${EndIf} + !endif + + !ifdef SUPPORTS_ARM64 + ${if} ${IsNativeARM64} + Goto ok + ${EndIf} + !endif + + IfSilent silentArch notSilentArch + silentArch: + SetErrorLevel 65 + Abort + notSilentArch: + MessageBox MB_OK "${WAILS_ARCHITECTURE_NOT_SUPPORTED}" + Quit + ${else} + IfSilent silentWin notSilentWin + silentWin: + SetErrorLevel 64 + Abort + notSilentWin: + MessageBox MB_OK "${WAILS_WIN10_REQUIRED}" + Quit + ${EndIf} + + ok: +!macroend + +!macro wails.files + !ifdef SUPPORTS_AMD64 + ${if} ${IsNativeAMD64} + File "/oname=${PRODUCT_EXECUTABLE}" "${ARG_WAILS_AMD64_BINARY}" + ${EndIf} + !endif + + !ifdef SUPPORTS_ARM64 + ${if} ${IsNativeARM64} + File "/oname=${PRODUCT_EXECUTABLE}" "${ARG_WAILS_ARM64_BINARY}" + ${EndIf} + !endif +!macroend + +!macro wails.writeUninstaller + WriteUninstaller "$INSTDIR\uninstall.exe" + + SetRegView 64 + WriteRegStr HKLM "${UNINST_KEY}" "Publisher" "${INFO_COMPANYNAME}" + WriteRegStr HKLM "${UNINST_KEY}" "DisplayName" "${INFO_PRODUCTNAME}" + WriteRegStr HKLM "${UNINST_KEY}" "DisplayVersion" "${INFO_PRODUCTVERSION}" + WriteRegStr HKLM "${UNINST_KEY}" "DisplayIcon" "$INSTDIR\${PRODUCT_EXECUTABLE}" + WriteRegStr HKLM "${UNINST_KEY}" "UninstallString" "$\"$INSTDIR\uninstall.exe$\"" + WriteRegStr HKLM "${UNINST_KEY}" "QuietUninstallString" "$\"$INSTDIR\uninstall.exe$\" /S" + + ${GetSize} "$INSTDIR" "/S=0K" $0 $1 $2 + IntFmt $0 "0x%08X" $0 + WriteRegDWORD HKLM "${UNINST_KEY}" "EstimatedSize" "$0" +!macroend + +!macro wails.deleteUninstaller + Delete "$INSTDIR\uninstall.exe" + + SetRegView 64 + DeleteRegKey HKLM "${UNINST_KEY}" +!macroend + +!macro wails.setShellContext + ${If} ${REQUEST_EXECUTION_LEVEL} == "admin" + SetShellVarContext all + ${else} + SetShellVarContext current + ${EndIf} +!macroend + +# Install webview2 by launching the bootstrapper +# See https://docs.microsoft.com/en-us/microsoft-edge/webview2/concepts/distribution#online-only-deployment +!macro wails.webview2runtime + !ifndef WAILS_INSTALL_WEBVIEW_DETAILPRINT + !define WAILS_INSTALL_WEBVIEW_DETAILPRINT "Installing: WebView2 Runtime" + !endif + + SetRegView 64 + # If the admin key exists and is not empty then webview2 is already installed + ReadRegStr $0 HKLM "SOFTWARE\WOW6432Node\Microsoft\EdgeUpdate\Clients\{F3017226-FE2A-4295-8BDF-00C3A9A7E4C5}" "pv" + ${If} $0 != "" + Goto ok + ${EndIf} + + ${If} ${REQUEST_EXECUTION_LEVEL} == "user" + # If the installer is run in user level, check the user specific key exists and is not empty then webview2 is already installed + ReadRegStr $0 HKCU "Software\Microsoft\EdgeUpdate\Clients\{F3017226-FE2A-4295-8BDF-00C3A9A7E4C5}" "pv" + ${If} $0 != "" + Goto ok + ${EndIf} + ${EndIf} + + SetDetailsPrint both + DetailPrint "${WAILS_INSTALL_WEBVIEW_DETAILPRINT}" + SetDetailsPrint listonly + + InitPluginsDir + CreateDirectory "$pluginsdir\webview2bootstrapper" + SetOutPath "$pluginsdir\webview2bootstrapper" + File "MicrosoftEdgeWebview2Setup.exe" + ExecWait '"$pluginsdir\webview2bootstrapper\MicrosoftEdgeWebview2Setup.exe" /silent /install' + + SetDetailsPrint both + ok: +!macroend + +# Copy of APP_ASSOCIATE and APP_UNASSOCIATE macros from here https://gist.github.com/nikku/281d0ef126dbc215dd58bfd5b3a5cd5b +!macro APP_ASSOCIATE EXT FILECLASS DESCRIPTION ICON COMMANDTEXT COMMAND + ; Backup the previously associated file class + ReadRegStr $R0 SHELL_CONTEXT "Software\Classes\.${EXT}" "" + WriteRegStr SHELL_CONTEXT "Software\Classes\.${EXT}" "${FILECLASS}_backup" "$R0" + + WriteRegStr SHELL_CONTEXT "Software\Classes\.${EXT}" "" "${FILECLASS}" + + WriteRegStr SHELL_CONTEXT "Software\Classes\${FILECLASS}" "" `${DESCRIPTION}` + WriteRegStr SHELL_CONTEXT "Software\Classes\${FILECLASS}\DefaultIcon" "" `${ICON}` + WriteRegStr SHELL_CONTEXT "Software\Classes\${FILECLASS}\shell" "" "open" + WriteRegStr SHELL_CONTEXT "Software\Classes\${FILECLASS}\shell\open" "" `${COMMANDTEXT}` + WriteRegStr SHELL_CONTEXT "Software\Classes\${FILECLASS}\shell\open\command" "" `${COMMAND}` +!macroend + +!macro APP_UNASSOCIATE EXT FILECLASS + ; Backup the previously associated file class + ReadRegStr $R0 SHELL_CONTEXT "Software\Classes\.${EXT}" `${FILECLASS}_backup` + WriteRegStr SHELL_CONTEXT "Software\Classes\.${EXT}" "" "$R0" + + DeleteRegKey SHELL_CONTEXT `Software\Classes\${FILECLASS}` +!macroend + +!macro wails.associateFiles + ; Create file associations + +!macroend + +!macro wails.unassociateFiles + ; Delete app associations + +!macroend \ No newline at end of file diff --git a/v3/examples/dock/build/windows/wails.exe.manifest b/v3/examples/dock/build/windows/wails.exe.manifest new file mode 100644 index 000000000..48052e7e6 --- /dev/null +++ b/v3/examples/dock/build/windows/wails.exe.manifest @@ -0,0 +1,22 @@ + + + + + + + + + + + true/pm + permonitorv2,permonitor + + + + + + + + + + \ No newline at end of file diff --git a/v3/examples/dock/frontend/Inter Font License.txt b/v3/examples/dock/frontend/Inter Font License.txt new file mode 100644 index 000000000..b525cbf3a --- /dev/null +++ b/v3/examples/dock/frontend/Inter Font License.txt @@ -0,0 +1,93 @@ +Copyright 2020 The Inter Project Authors (https://github.com/rsms/inter) + +This Font Software is licensed under the SIL Open Font License, Version 1.1. +This license is copied below, and is also available with a FAQ at: +http://scripts.sil.org/OFL + + +----------------------------------------------------------- +SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007 +----------------------------------------------------------- + +PREAMBLE +The goals of the Open Font License (OFL) are to stimulate worldwide +development of collaborative font projects, to support the font creation +efforts of academic and linguistic communities, and to provide a free and +open framework in which fonts may be shared and improved in partnership +with others. + +The OFL allows the licensed fonts to be used, studied, modified and +redistributed freely as long as they are not sold by themselves. The +fonts, including any derivative works, can be bundled, embedded, +redistributed and/or sold with any software provided that any reserved +names are not used by derivative works. The fonts and derivatives, +however, cannot be released under any other type of license. The +requirement for fonts to remain under this license does not apply +to any document created using the fonts or their derivatives. + +DEFINITIONS +"Font Software" refers to the set of files released by the Copyright +Holder(s) under this license and clearly marked as such. This may +include source files, build scripts and documentation. + +"Reserved Font Name" refers to any names specified as such after the +copyright statement(s). + +"Original Version" refers to the collection of Font Software components as +distributed by the Copyright Holder(s). + +"Modified Version" refers to any derivative made by adding to, deleting, +or substituting -- in part or in whole -- any of the components of the +Original Version, by changing formats or by porting the Font Software to a +new environment. + +"Author" refers to any designer, engineer, programmer, technical +writer or other person who contributed to the Font Software. + +PERMISSION & CONDITIONS +Permission is hereby granted, free of charge, to any person obtaining +a copy of the Font Software, to use, study, copy, merge, embed, modify, +redistribute, and sell modified and unmodified copies of the Font +Software, subject to the following conditions: + +1) Neither the Font Software nor any of its individual components, +in Original or Modified Versions, may be sold by itself. + +2) Original or Modified Versions of the Font Software may be bundled, +redistributed and/or sold with any software, provided that each copy +contains the above copyright notice and this license. These can be +included either as stand-alone text files, human-readable headers or +in the appropriate machine-readable metadata fields within text or +binary files as long as those fields can be easily viewed by the user. + +3) No Modified Version of the Font Software may use the Reserved Font +Name(s) unless explicit written permission is granted by the corresponding +Copyright Holder. This restriction only applies to the primary font name as +presented to the users. + +4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font +Software shall not be used to promote, endorse or advertise any +Modified Version, except to acknowledge the contribution(s) of the +Copyright Holder(s) and the Author(s) or with their explicit written +permission. + +5) The Font Software, modified or unmodified, in part or in whole, +must be distributed entirely under this license, and must not be +distributed under any other license. The requirement for fonts to +remain under this license does not apply to any document created +using the Font Software. + +TERMINATION +This license becomes null and void if any of the above conditions are +not met. + +DISCLAIMER +THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF +MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT +OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE +COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, +INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL +DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING +FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM +OTHER DEALINGS IN THE FONT SOFTWARE. diff --git a/v3/examples/dock/frontend/bindings/github.com/wailsapp/wails/v3/pkg/services/dock/dockservice.ts b/v3/examples/dock/frontend/bindings/github.com/wailsapp/wails/v3/pkg/services/dock/dockservice.ts new file mode 100644 index 000000000..abf1f22e4 --- /dev/null +++ b/v3/examples/dock/frontend/bindings/github.com/wailsapp/wails/v3/pkg/services/dock/dockservice.ts @@ -0,0 +1,53 @@ +// Cynhyrchwyd y ffeil hon yn awtomatig. PEIDIWCH Â MODIWL +// This file is automatically generated. DO NOT EDIT + +/** + * Service represents the dock service + * @module + */ + +// eslint-disable-next-line @typescript-eslint/ban-ts-comment +// @ts-ignore: Unused imports +import { Call as $Call, CancellablePromise as $CancellablePromise, Create as $Create } from "@wailsio/runtime"; + +// eslint-disable-next-line @typescript-eslint/ban-ts-comment +// @ts-ignore: Unused imports +import * as $models from "./models.js"; + +/** + * HideAppIcon hides the app icon in the dock/taskbar. + */ +export function HideAppIcon(): $CancellablePromise { + return $Call.ByID(3413658144); +} + +/** + * RemoveBadge removes the badge label from the application icon. + * This method ensures the badge call is made on the main thread to avoid crashes. + */ +export function RemoveBadge(): $CancellablePromise { + return $Call.ByID(2752757297); +} + +/** + * SetBadge sets the badge label on the application icon. + * This method ensures the badge call is made on the main thread to avoid crashes. + */ +export function SetBadge(label: string): $CancellablePromise { + return $Call.ByID(1717705661, label); +} + +/** + * SetCustomBadge sets the badge label on the application icon with custom options. + * This method ensures the badge call is made on the main thread to avoid crashes. + */ +export function SetCustomBadge(label: string, options: $models.BadgeOptions): $CancellablePromise { + return $Call.ByID(2730169760, label, options); +} + +/** + * ShowAppIcon shows the app icon in the dock/taskbar. + */ +export function ShowAppIcon(): $CancellablePromise { + return $Call.ByID(3409697379); +} diff --git a/v3/examples/dock/frontend/bindings/github.com/wailsapp/wails/v3/pkg/services/dock/index.ts b/v3/examples/dock/frontend/bindings/github.com/wailsapp/wails/v3/pkg/services/dock/index.ts new file mode 100644 index 000000000..fbdaf19f3 --- /dev/null +++ b/v3/examples/dock/frontend/bindings/github.com/wailsapp/wails/v3/pkg/services/dock/index.ts @@ -0,0 +1,11 @@ +// Cynhyrchwyd y ffeil hon yn awtomatig. PEIDIWCH Â MODIWL +// This file is automatically generated. DO NOT EDIT + +import * as DockService from "./dockservice.js"; +export { + DockService +}; + +export { + BadgeOptions +} from "./models.js"; diff --git a/v3/examples/dock/frontend/bindings/github.com/wailsapp/wails/v3/pkg/services/dock/models.ts b/v3/examples/dock/frontend/bindings/github.com/wailsapp/wails/v3/pkg/services/dock/models.ts new file mode 100644 index 000000000..f97c8a4c6 --- /dev/null +++ b/v3/examples/dock/frontend/bindings/github.com/wailsapp/wails/v3/pkg/services/dock/models.ts @@ -0,0 +1,61 @@ +// Cynhyrchwyd y ffeil hon yn awtomatig. PEIDIWCH Â MODIWL +// This file is automatically generated. DO NOT EDIT + +// eslint-disable-next-line @typescript-eslint/ban-ts-comment +// @ts-ignore: Unused imports +import { Create as $Create } from "@wailsio/runtime"; + +// eslint-disable-next-line @typescript-eslint/ban-ts-comment +// @ts-ignore: Unused imports +import * as color$0 from "../../../../../../../image/color/models.js"; + +/** + * BadgeOptions represents options for customizing badge appearance + */ +export class BadgeOptions { + "TextColour": color$0.RGBA; + "BackgroundColour": color$0.RGBA; + "FontName": string; + "FontSize": number; + "SmallFontSize": number; + + /** Creates a new BadgeOptions instance. */ + constructor($$source: Partial = {}) { + if (!("TextColour" in $$source)) { + this["TextColour"] = (new color$0.RGBA()); + } + if (!("BackgroundColour" in $$source)) { + this["BackgroundColour"] = (new color$0.RGBA()); + } + if (!("FontName" in $$source)) { + this["FontName"] = ""; + } + if (!("FontSize" in $$source)) { + this["FontSize"] = 0; + } + if (!("SmallFontSize" in $$source)) { + this["SmallFontSize"] = 0; + } + + Object.assign(this, $$source); + } + + /** + * Creates a new BadgeOptions instance from a string or object. + */ + static createFrom($$source: any = {}): BadgeOptions { + const $$createField0_0 = $$createType0; + const $$createField1_0 = $$createType0; + let $$parsedSource = typeof $$source === 'string' ? JSON.parse($$source) : $$source; + if ("TextColour" in $$parsedSource) { + $$parsedSource["TextColour"] = $$createField0_0($$parsedSource["TextColour"]); + } + if ("BackgroundColour" in $$parsedSource) { + $$parsedSource["BackgroundColour"] = $$createField1_0($$parsedSource["BackgroundColour"]); + } + return new BadgeOptions($$parsedSource as Partial); + } +} + +// Private type creation functions +const $$createType0 = color$0.RGBA.createFrom; diff --git a/v3/examples/dock/frontend/bindings/image/color/index.ts b/v3/examples/dock/frontend/bindings/image/color/index.ts new file mode 100644 index 000000000..97b507b08 --- /dev/null +++ b/v3/examples/dock/frontend/bindings/image/color/index.ts @@ -0,0 +1,6 @@ +// Cynhyrchwyd y ffeil hon yn awtomatig. PEIDIWCH Â MODIWL +// This file is automatically generated. DO NOT EDIT + +export { + RGBA +} from "./models.js"; diff --git a/v3/examples/dock/frontend/bindings/image/color/models.ts b/v3/examples/dock/frontend/bindings/image/color/models.ts new file mode 100644 index 000000000..0d4eab56d --- /dev/null +++ b/v3/examples/dock/frontend/bindings/image/color/models.ts @@ -0,0 +1,46 @@ +// Cynhyrchwyd y ffeil hon yn awtomatig. PEIDIWCH Â MODIWL +// This file is automatically generated. DO NOT EDIT + +// eslint-disable-next-line @typescript-eslint/ban-ts-comment +// @ts-ignore: Unused imports +import { Create as $Create } from "@wailsio/runtime"; + +/** + * RGBA represents a traditional 32-bit alpha-premultiplied color, having 8 + * bits for each of red, green, blue and alpha. + * + * An alpha-premultiplied color component C has been scaled by alpha (A), so + * has valid values 0 <= C <= A. + */ +export class RGBA { + "R": number; + "G": number; + "B": number; + "A": number; + + /** Creates a new RGBA instance. */ + constructor($$source: Partial = {}) { + if (!("R" in $$source)) { + this["R"] = 0; + } + if (!("G" in $$source)) { + this["G"] = 0; + } + if (!("B" in $$source)) { + this["B"] = 0; + } + if (!("A" in $$source)) { + this["A"] = 0; + } + + Object.assign(this, $$source); + } + + /** + * Creates a new RGBA instance from a string or object. + */ + static createFrom($$source: any = {}): RGBA { + let $$parsedSource = typeof $$source === 'string' ? JSON.parse($$source) : $$source; + return new RGBA($$parsedSource as Partial); + } +} diff --git a/v3/examples/dock/frontend/dist/Inter-Medium.ttf b/v3/examples/dock/frontend/dist/Inter-Medium.ttf new file mode 100644 index 000000000..a01f3777a Binary files /dev/null and b/v3/examples/dock/frontend/dist/Inter-Medium.ttf differ diff --git a/v3/examples/dock/frontend/dist/assets/index-BJIh-HIc.js b/v3/examples/dock/frontend/dist/assets/index-BJIh-HIc.js new file mode 100644 index 000000000..5217ab9a7 --- /dev/null +++ b/v3/examples/dock/frontend/dist/assets/index-BJIh-HIc.js @@ -0,0 +1,6 @@ +(function(){const e=document.createElement("link").relList;if(e&&e.supports&&e.supports("modulepreload"))return;for(const o of document.querySelectorAll('link[rel="modulepreload"]'))n(o);new MutationObserver(o=>{for(const i of o)if(i.type==="childList")for(const s of i.addedNodes)s.tagName==="LINK"&&s.rel==="modulepreload"&&n(s)}).observe(document,{childList:!0,subtree:!0});function r(o){const i={};return o.integrity&&(i.integrity=o.integrity),o.referrerPolicy&&(i.referrerPolicy=o.referrerPolicy),o.crossOrigin==="use-credentials"?i.credentials="include":o.crossOrigin==="anonymous"?i.credentials="omit":i.credentials="same-origin",i}function n(o){if(o.ep)return;o.ep=!0;const i=r(o);fetch(o.href,i)}})();const ie="useandom-26T198340PX75pxJACKVERYMINDBUSHWOLF_GQZbfghjklqvwyzrict";function K(t=21){let e="",r=t|0;for(;r--;)e+=ie[Math.random()*64|0];return e}const se=window.location.origin+"/wails/runtime",O=Object.freeze({Call:0,Clipboard:1,Application:2,Events:3,ContextMenu:4,Dialog:5,Window:6,Screens:7,System:8,Browser:9,CancelCall:10});let ce=K();function R(t,e=""){return function(r,n=null){return le(t,r,e,n)}}async function le(t,e,r,n){var o,i;let s=new URL(se);s.searchParams.append("object",t.toString()),s.searchParams.append("method",e.toString()),n&&s.searchParams.append("args",JSON.stringify(n));let l={"x-wails-client-id":ce};r&&(l["x-wails-window-name"]=r);let c=await fetch(s,{headers:l});if(!c.ok)throw new Error(await c.text());return((i=(o=c.headers.get("Content-Type"))===null||o===void 0?void 0:o.indexOf("application/json"))!==null&&i!==void 0?i:-1)!==-1?c.json():c.text()}R(O.System);const P=function(){var t,e,r,n,o;try{if(!((e=(t=window.chrome)===null||t===void 0?void 0:t.webview)===null||e===void 0)&&e.postMessage)return window.chrome.webview.postMessage.bind(window.chrome.webview);if(!((o=(n=(r=window.webkit)===null||r===void 0?void 0:r.messageHandlers)===null||n===void 0?void 0:n.external)===null||o===void 0)&&o.postMessage)return window.webkit.messageHandlers.external.postMessage.bind(window.webkit.messageHandlers.external)}catch{}return console.warn(` +%c⚠️ Browser Environment Detected %c + +%cOnly UI previews are available in the browser. For full functionality, please run the application in desktop mode. +More information at: https://v3.wails.io/learn/build/#using-a-browser-for-development +`,"background: #ffffff; color: #000000; font-weight: bold; padding: 4px 8px; border-radius: 4px; border: 2px solid #000000;","background: transparent;","color: #ffffff; font-style: italic; font-weight: bold;"),null}();function M(t){P==null||P(t)}function Q(){return window._wails.environment.OS==="windows"}function ae(){return!!window._wails.environment.Debug}function ue(){return new MouseEvent("mousedown").buttons===0}function Z(t){var e;return t.target instanceof HTMLElement?t.target:!(t.target instanceof HTMLElement)&&t.target instanceof Node&&(e=t.target.parentElement)!==null&&e!==void 0?e:document.body}document.addEventListener("DOMContentLoaded",()=>{});window.addEventListener("contextmenu",pe);const de=R(O.ContextMenu),fe=0;function we(t,e,r,n){de(fe,{id:t,x:e,y:r,data:n})}function pe(t){const e=Z(t),r=window.getComputedStyle(e).getPropertyValue("--custom-contextmenu").trim();if(r){t.preventDefault();const n=window.getComputedStyle(e).getPropertyValue("--custom-contextmenu-data");we(r,t.clientX,t.clientY,n)}else he(t,e)}function he(t,e){if(ae())return;switch(window.getComputedStyle(e).getPropertyValue("--default-contextmenu").trim()){case"show":return;case"hide":t.preventDefault();return}if(e.isContentEditable)return;const r=window.getSelection(),n=r&&r.toString().length>0;if(n)for(let o=0;o{F=t,F||(b=v=!1,u())};window.addEventListener("mousedown",N,{capture:!0});window.addEventListener("mousemove",N,{capture:!0});window.addEventListener("mouseup",N,{capture:!0});for(const t of["click","contextmenu","dblclick"])window.addEventListener(t,me,{capture:!0});function me(t){(E||v)&&(t.stopImmediatePropagation(),t.stopPropagation(),t.preventDefault())}const D=0,ye=1,k=2;function N(t){let e,r=t.buttons;switch(t.type){case"mousedown":e=D,H||(r=h|1<"u"||typeof e=="object"))try{var r=C.call(e);return(r===Ce||r===Me||r===Oe||r===Se)&&e("")==null}catch{}return!1})}function Pe(t){if(X(t))return!0;if(!t||typeof t!="function"&&typeof t!="object")return!1;try{y(t,null,B)}catch(e){if(e!==x)return!1}return!W(t)&&_(t)}function Ae(t){if(X(t))return!0;if(!t||typeof t!="function"&&typeof t!="object")return!1;if(Re)return _(t);if(W(t))return!1;var e=C.call(t);return e!==ze&&e!==xe&&!/^\[object HTML/.test(e)?!1:_(t)}const p=y?Pe:Ae;var I;class U extends Error{constructor(e,r){super(e,r),this.name="CancelError"}}class S extends Error{constructor(e,r,n){super((n??"Unhandled rejection in cancelled promise.")+" Reason: "+He(r),{cause:r}),this.promise=e,this.name="CancelledRejectionError"}}const f=Symbol("barrier"),J=Symbol("cancelImpl"),V=(I=Symbol.species)!==null&&I!==void 0?I:Symbol("speciesPolyfill");class a extends Promise{constructor(e,r){let n,o;if(super((c,d)=>{n=c,o=d}),this.constructor[V]!==Promise)throw new TypeError("CancellablePromise does not support transparent subclassing. Please refrain from overriding the [Symbol.species] static property.");let i={promise:this,resolve:n,reject:o,get oncancelled(){return r??null},set oncancelled(c){r=c??void 0}};const s={get root(){return s},resolving:!1,settled:!1};Object.defineProperties(this,{[f]:{configurable:!1,enumerable:!1,writable:!0,value:null},[J]:{configurable:!1,enumerable:!1,writable:!1,value:ee(i,s)}});const l=re(i,s);try{e(te(i,s),l)}catch(c){s.resolving?console.log("Unhandled exception in CancellablePromise executor.",c):l(c)}}cancel(e){return new a(r=>{Promise.all([this[J](new U("Promise cancelled.",{cause:e})),De(this)]).then(()=>r(),()=>r())})}cancelOn(e){return e.aborted?this.cancel(e.reason):e.addEventListener("abort",()=>void this.cancel(e.reason),{capture:!0}),this}then(e,r,n){if(!(this instanceof a))throw new TypeError("CancellablePromise.prototype.then called on an invalid object.");if(p(e)||(e=q),p(r)||(r=G),e===q&&r==G)return new a(i=>i(this));const o={};return this[f]=o,new a((i,s)=>{super.then(l=>{var c;this[f]===o&&(this[f]=null),(c=o.resolve)===null||c===void 0||c.call(o);try{i(e(l))}catch(d){s(d)}},l=>{var c;this[f]===o&&(this[f]=null),(c=o.resolve)===null||c===void 0||c.call(o);try{i(r(l))}catch(d){s(d)}})},async i=>{try{return n==null?void 0:n(i)}finally{await this.cancel(i)}})}catch(e,r){return this.then(void 0,e,r)}finally(e,r){if(!(this instanceof a))throw new TypeError("CancellablePromise.prototype.finally called on an invalid object.");return p(e)?this.then(n=>a.resolve(e()).then(()=>n),n=>a.resolve(e()).then(()=>{throw n}),r):this.then(e,e,r)}static get[V](){return Promise}static all(e){let r=Array.from(e);const n=r.length===0?a.resolve(r):new a((o,i)=>{Promise.all(r).then(o,i)},o=>z(n,r,o));return n}static allSettled(e){let r=Array.from(e);const n=r.length===0?a.resolve(r):new a((o,i)=>{Promise.allSettled(r).then(o,i)},o=>z(n,r,o));return n}static any(e){let r=Array.from(e);const n=r.length===0?a.resolve(r):new a((o,i)=>{Promise.any(r).then(o,i)},o=>z(n,r,o));return n}static race(e){let r=Array.from(e);const n=new a((o,i)=>{Promise.race(r).then(o,i)},o=>z(n,r,o));return n}static cancel(e){const r=new a(()=>{});return r.cancel(e),r}static timeout(e,r){const n=new a(()=>{});return AbortSignal&&typeof AbortSignal=="function"&&AbortSignal.timeout&&typeof AbortSignal.timeout=="function"?AbortSignal.timeout(e).addEventListener("abort",()=>void n.cancel(r)):setTimeout(()=>void n.cancel(r),e),n}static sleep(e,r){return new a(n=>{setTimeout(()=>n(r),e)})}static reject(e){return new a((r,n)=>n(e))}static resolve(e){return e instanceof a?e:new a(r=>r(e))}static withResolvers(){let e={oncancelled:null};return e.promise=new a((r,n)=>{e.resolve=r,e.reject=n},r=>{var n;(n=e.oncancelled)===null||n===void 0||n.call(e,r)}),e}}function ee(t,e){let r;return n=>{if(e.settled||(e.settled=!0,e.reason=n,t.reject(n),Promise.prototype.then.call(t.promise,void 0,o=>{if(o!==n)throw o})),!(!e.reason||!t.oncancelled))return r=new Promise(o=>{try{o(t.oncancelled(e.reason.cause))}catch(i){Promise.reject(new S(t.promise,i,"Unhandled exception in oncancelled callback."))}}).catch(o=>{Promise.reject(new S(t.promise,o,"Unhandled rejection in oncancelled callback."))}),t.oncancelled=null,r}}function te(t,e){return r=>{if(!e.resolving){if(e.resolving=!0,r===t.promise){if(e.settled)return;e.settled=!0,t.reject(new TypeError("A promise cannot be resolved with itself."));return}if(r!=null&&(typeof r=="object"||typeof r=="function")){let n;try{n=r.then}catch(o){e.settled=!0,t.reject(o);return}if(p(n)){try{let s=r.cancel;if(p(s)){const l=c=>{Reflect.apply(s,r,[c])};e.reason?ee(Object.assign(Object.assign({},t),{oncancelled:l}),e)(e.reason):t.oncancelled=l}}catch{}const o={root:e.root,resolving:!1,get settled(){return this.root.settled},set settled(s){this.root.settled=s},get reason(){return this.root.reason}},i=re(t,o);try{Reflect.apply(n,r,[te(t,o),i])}catch(s){i(s)}return}}e.settled||(e.settled=!0,t.resolve(r))}}}function re(t,e){return r=>{if(!e.resolving)if(e.resolving=!0,e.settled){try{if(r instanceof U&&e.reason instanceof U&&Object.is(r.cause,e.reason.cause))return}catch{}Promise.reject(new S(t.promise,r))}else e.settled=!0,t.reject(r)}}function z(t,e,r){const n=[];for(const o of e){let i;try{if(!p(o.then)||(i=o.cancel,!p(i)))continue}catch{continue}let s;try{s=Reflect.apply(i,o,[r])}catch(l){Promise.reject(new S(t,l,"Unhandled exception in cancel method."));continue}s&&n.push((s instanceof Promise?s:Promise.resolve(s)).catch(l=>{Promise.reject(new S(t,l,"Unhandled rejection in cancel method."))}))}return Promise.all(n)}function q(t){return t}function G(t){throw t}function He(t){try{if(t instanceof Error||typeof t!="object"||t.toString!==Object.prototype.toString)return""+t}catch{}try{return JSON.stringify(t)}catch{}try{return Object.prototype.toString.call(t)}catch{}return""}function De(t){var e;let r=(e=t[f])!==null&&e!==void 0?e:{};return"promise"in r||Object.assign(r,m()),t[f]==null&&(r.resolve(),t[f]=r),r.promise}let m=Promise.withResolvers;m&&typeof m=="function"?m=m.bind(Promise):m=function(){let t,e;return{promise:new Promise((n,o)=>{t=n,e=o}),resolve:t,reject:e}};window._wails=window._wails||{};window._wails.callResultHandler=Ue;window._wails.callErrorHandler=Ne;const ke=R(O.Call),Ie=R(O.CancelCall),g=new Map,Fe=0,Be=0;class _e extends Error{constructor(e,r){super(e,r),this.name="RuntimeError"}}function Ue(t,e,r){const n=ne(t);if(n)if(!e)n.resolve(void 0);else if(!r)n.resolve(e);else try{n.resolve(JSON.parse(e))}catch(o){n.reject(new TypeError("could not parse result: "+o.message,{cause:o}))}}function Ne(t,e,r){const n=ne(t);if(n)if(!r)n.reject(new Error(e));else{let o;try{o=JSON.parse(e)}catch(l){n.reject(new TypeError("could not parse error: "+l.message,{cause:l}));return}let i={};o.cause&&(i.cause=o.cause);let s;switch(o.kind){case"ReferenceError":s=new ReferenceError(o.message,i);break;case"TypeError":s=new TypeError(o.message,i);break;case"RuntimeError":s=new _e(o.message,i);break;default:s=new Error(o.message,i);break}n.reject(s)}}function ne(t){const e=g.get(t);return g.delete(t),e}function We(){let t;do t=K();while(g.has(t));return t}function Xe(t){const e=We(),r=a.withResolvers();g.set(e,{resolve:r.resolve,reject:r.reject});const n=ke(Fe,Object.assign({"call-id":e},t));let o=!1;n.then(()=>{o=!0},s=>{g.delete(e),r.reject(s)});const i=()=>(g.delete(e),Ie(Be,{"call-id":e}).catch(s=>{console.error("Error while requesting binding call cancellation:",s)}));return r.oncancelled=()=>o?i():n.then(i),r.promise}function oe(t,...e){return Xe({methodID:t,args:e})}window._wails=window._wails||{};window._wails.invoke=M;M("wails:runtime:ready");function Ye(){return oe(3413658144)}function Je(){return oe(3409697379)}const Ve=document.getElementById("show"),qe=document.getElementById("hide");Ve.addEventListener("click",()=>{Je()});qe.addEventListener("click",()=>{Ye()}); diff --git a/v3/examples/dock/frontend/dist/index.html b/v3/examples/dock/frontend/dist/index.html new file mode 100644 index 000000000..1836ad6e7 --- /dev/null +++ b/v3/examples/dock/frontend/dist/index.html @@ -0,0 +1,33 @@ + + + + + + + + Wails App + + + +
      + +

      Wails + Typescript

      +
      +
      + + +
      +
      + +
      + + diff --git a/v3/examples/dock/frontend/dist/style.css b/v3/examples/dock/frontend/dist/style.css new file mode 100644 index 000000000..0b9c58279 --- /dev/null +++ b/v3/examples/dock/frontend/dist/style.css @@ -0,0 +1,157 @@ +:root { + font-family: "Inter", -apple-system, BlinkMacSystemFont, "Segoe UI", "Roboto", + "Oxygen", "Ubuntu", "Cantarell", "Fira Sans", "Droid Sans", "Helvetica Neue", + sans-serif; + font-size: 16px; + line-height: 24px; + font-weight: 400; + color-scheme: light dark; + color: rgba(255, 255, 255, 0.87); + background-color: rgba(27, 38, 54, 1); + font-synthesis: none; + text-rendering: optimizeLegibility; + -webkit-font-smoothing: antialiased; + -moz-osx-font-smoothing: grayscale; + -webkit-text-size-adjust: 100%; + user-select: none; + -webkit-user-select: none; + -moz-user-select: none; + -ms-user-select: none; +} + +@font-face { + font-family: "Inter"; + font-style: normal; + font-weight: 400; + src: local(""), + url("./Inter-Medium.ttf") format("truetype"); +} + +h3 { + font-size: 3em; + line-height: 1.1; +} + +a { + font-weight: 500; + color: #646cff; + text-decoration: inherit; +} + +a:hover { + color: #535bf2; +} + +button { + width: 60px; + height: 30px; + line-height: 30px; + border-radius: 3px; + border: none; + margin: 0 0 0 20px; + padding: 0 8px; + cursor: pointer; +} + +.result { + height: 20px; + line-height: 20px; +} + +body { + margin: 0; + display: flex; + place-items: center; + place-content: center; + min-width: 320px; + min-height: 100vh; +} + +.container { + display: flex; + flex-direction: column; + align-items: center; + justify-content: center; +} + +h1 { + font-size: 3.2em; + line-height: 1.1; +} + +#app { + max-width: 1280px; + margin: 0 auto; + padding: 2rem; + text-align: center; +} + +.logo { + height: 6em; + padding: 1.5em; + will-change: filter; +} + +.logo:hover { + filter: drop-shadow(0 0 2em #e80000aa); +} + +.logo.vanilla:hover { + filter: drop-shadow(0 0 2em #f7df1eaa); +} + +.result { + height: 20px; + line-height: 20px; + margin: 1.5rem auto; + text-align: center; +} + +.footer { + margin-top: 1rem; + align-content: center; + text-align: center; +} + +@media (prefers-color-scheme: light) { + :root { + color: #213547; + background-color: #ffffff; + } + + a:hover { + color: #747bff; + } + + button { + background-color: #f9f9f9; + } +} + + +.input-box .btn:hover { + background-image: linear-gradient(to top, #cfd9df 0%, #e2ebf0 100%); + color: #333333; +} + +.input-box .input { + border: none; + border-radius: 3px; + outline: none; + height: 30px; + line-height: 30px; + padding: 0 10px; + color: black; + background-color: rgba(240, 240, 240, 1); + -webkit-font-smoothing: antialiased; +} + +.input-box .input:hover { + border: none; + background-color: rgba(255, 255, 255, 1); +} + +.input-box .input:focus { + border: none; + background-color: rgba(255, 255, 255, 1); +} \ No newline at end of file diff --git a/v3/examples/dock/frontend/dist/typescript.svg b/v3/examples/dock/frontend/dist/typescript.svg new file mode 100644 index 000000000..d91c910cc --- /dev/null +++ b/v3/examples/dock/frontend/dist/typescript.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/v3/examples/dock/frontend/dist/wails.png b/v3/examples/dock/frontend/dist/wails.png new file mode 100644 index 000000000..8bdf42483 Binary files /dev/null and b/v3/examples/dock/frontend/dist/wails.png differ diff --git a/v3/examples/dock/frontend/index.html b/v3/examples/dock/frontend/index.html new file mode 100644 index 000000000..1a310f0e9 --- /dev/null +++ b/v3/examples/dock/frontend/index.html @@ -0,0 +1,33 @@ + + + + + + + + Wails App + + +
      + +

      Wails + Typescript

      +
      +
      + + +
      +
      + +
      + + + diff --git a/v3/examples/dock/frontend/package-lock.json b/v3/examples/dock/frontend/package-lock.json new file mode 100644 index 000000000..0c0df727a --- /dev/null +++ b/v3/examples/dock/frontend/package-lock.json @@ -0,0 +1,936 @@ +{ + "name": "frontend", + "version": "0.0.0", + "lockfileVersion": 3, + "requires": true, + "packages": { + "": { + "name": "frontend", + "version": "0.0.0", + "dependencies": { + "@wailsio/runtime": "latest" + }, + "devDependencies": { + "typescript": "^4.9.3", + "vite": "^5.0.0" + } + }, + "node_modules/@esbuild/aix-ppc64": { + "version": "0.21.5", + "resolved": "https://registry.npmjs.org/@esbuild/aix-ppc64/-/aix-ppc64-0.21.5.tgz", + "integrity": "sha512-1SDgH6ZSPTlggy1yI6+Dbkiz8xzpHJEVAlF/AM1tHPLsf5STom9rwtjE4hKAF20FfXXNTFqEYXyJNWh1GiZedQ==", + "cpu": [ + "ppc64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "aix" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/@esbuild/android-arm": { + "version": "0.21.5", + "resolved": "https://registry.npmjs.org/@esbuild/android-arm/-/android-arm-0.21.5.tgz", + "integrity": "sha512-vCPvzSjpPHEi1siZdlvAlsPxXl7WbOVUBBAowWug4rJHb68Ox8KualB+1ocNvT5fjv6wpkX6o/iEpbDrf68zcg==", + "cpu": [ + "arm" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "android" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/@esbuild/android-arm64": { + "version": "0.21.5", + "resolved": "https://registry.npmjs.org/@esbuild/android-arm64/-/android-arm64-0.21.5.tgz", + "integrity": "sha512-c0uX9VAUBQ7dTDCjq+wdyGLowMdtR/GoC2U5IYk/7D1H1JYC0qseD7+11iMP2mRLN9RcCMRcjC4YMclCzGwS/A==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "android" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/@esbuild/android-x64": { + "version": "0.21.5", + "resolved": "https://registry.npmjs.org/@esbuild/android-x64/-/android-x64-0.21.5.tgz", + "integrity": "sha512-D7aPRUUNHRBwHxzxRvp856rjUHRFW1SdQATKXH2hqA0kAZb1hKmi02OpYRacl0TxIGz/ZmXWlbZgjwWYaCakTA==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "android" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/@esbuild/darwin-arm64": { + "version": "0.21.5", + "resolved": "https://registry.npmjs.org/@esbuild/darwin-arm64/-/darwin-arm64-0.21.5.tgz", + "integrity": "sha512-DwqXqZyuk5AiWWf3UfLiRDJ5EDd49zg6O9wclZ7kUMv2WRFr4HKjXp/5t8JZ11QbQfUS6/cRCKGwYhtNAY88kQ==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "darwin" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/@esbuild/darwin-x64": { + "version": "0.21.5", + "resolved": "https://registry.npmjs.org/@esbuild/darwin-x64/-/darwin-x64-0.21.5.tgz", + "integrity": "sha512-se/JjF8NlmKVG4kNIuyWMV/22ZaerB+qaSi5MdrXtd6R08kvs2qCN4C09miupktDitvh8jRFflwGFBQcxZRjbw==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "darwin" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/@esbuild/freebsd-arm64": { + "version": "0.21.5", + "resolved": "https://registry.npmjs.org/@esbuild/freebsd-arm64/-/freebsd-arm64-0.21.5.tgz", + "integrity": "sha512-5JcRxxRDUJLX8JXp/wcBCy3pENnCgBR9bN6JsY4OmhfUtIHe3ZW0mawA7+RDAcMLrMIZaf03NlQiX9DGyB8h4g==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "freebsd" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/@esbuild/freebsd-x64": { + "version": "0.21.5", + "resolved": "https://registry.npmjs.org/@esbuild/freebsd-x64/-/freebsd-x64-0.21.5.tgz", + "integrity": "sha512-J95kNBj1zkbMXtHVH29bBriQygMXqoVQOQYA+ISs0/2l3T9/kj42ow2mpqerRBxDJnmkUDCaQT/dfNXWX/ZZCQ==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "freebsd" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/@esbuild/linux-arm": { + "version": "0.21.5", + "resolved": "https://registry.npmjs.org/@esbuild/linux-arm/-/linux-arm-0.21.5.tgz", + "integrity": "sha512-bPb5AHZtbeNGjCKVZ9UGqGwo8EUu4cLq68E95A53KlxAPRmUyYv2D6F0uUI65XisGOL1hBP5mTronbgo+0bFcA==", + "cpu": [ + "arm" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/@esbuild/linux-arm64": { + "version": "0.21.5", + "resolved": "https://registry.npmjs.org/@esbuild/linux-arm64/-/linux-arm64-0.21.5.tgz", + "integrity": "sha512-ibKvmyYzKsBeX8d8I7MH/TMfWDXBF3db4qM6sy+7re0YXya+K1cem3on9XgdT2EQGMu4hQyZhan7TeQ8XkGp4Q==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/@esbuild/linux-ia32": { + "version": "0.21.5", + "resolved": "https://registry.npmjs.org/@esbuild/linux-ia32/-/linux-ia32-0.21.5.tgz", + "integrity": "sha512-YvjXDqLRqPDl2dvRODYmmhz4rPeVKYvppfGYKSNGdyZkA01046pLWyRKKI3ax8fbJoK5QbxblURkwK/MWY18Tg==", + "cpu": [ + "ia32" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/@esbuild/linux-loong64": { + "version": "0.21.5", + "resolved": "https://registry.npmjs.org/@esbuild/linux-loong64/-/linux-loong64-0.21.5.tgz", + "integrity": "sha512-uHf1BmMG8qEvzdrzAqg2SIG/02+4/DHB6a9Kbya0XDvwDEKCoC8ZRWI5JJvNdUjtciBGFQ5PuBlpEOXQj+JQSg==", + "cpu": [ + "loong64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/@esbuild/linux-mips64el": { + "version": "0.21.5", + "resolved": "https://registry.npmjs.org/@esbuild/linux-mips64el/-/linux-mips64el-0.21.5.tgz", + "integrity": "sha512-IajOmO+KJK23bj52dFSNCMsz1QP1DqM6cwLUv3W1QwyxkyIWecfafnI555fvSGqEKwjMXVLokcV5ygHW5b3Jbg==", + "cpu": [ + "mips64el" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/@esbuild/linux-ppc64": { + "version": "0.21.5", + "resolved": "https://registry.npmjs.org/@esbuild/linux-ppc64/-/linux-ppc64-0.21.5.tgz", + "integrity": "sha512-1hHV/Z4OEfMwpLO8rp7CvlhBDnjsC3CttJXIhBi+5Aj5r+MBvy4egg7wCbe//hSsT+RvDAG7s81tAvpL2XAE4w==", + "cpu": [ + "ppc64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/@esbuild/linux-riscv64": { + "version": "0.21.5", + "resolved": "https://registry.npmjs.org/@esbuild/linux-riscv64/-/linux-riscv64-0.21.5.tgz", + "integrity": "sha512-2HdXDMd9GMgTGrPWnJzP2ALSokE/0O5HhTUvWIbD3YdjME8JwvSCnNGBnTThKGEB91OZhzrJ4qIIxk/SBmyDDA==", + "cpu": [ + "riscv64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/@esbuild/linux-s390x": { + "version": "0.21.5", + "resolved": "https://registry.npmjs.org/@esbuild/linux-s390x/-/linux-s390x-0.21.5.tgz", + "integrity": "sha512-zus5sxzqBJD3eXxwvjN1yQkRepANgxE9lgOW2qLnmr8ikMTphkjgXu1HR01K4FJg8h1kEEDAqDcZQtbrRnB41A==", + "cpu": [ + "s390x" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/@esbuild/linux-x64": { + "version": "0.21.5", + "resolved": "https://registry.npmjs.org/@esbuild/linux-x64/-/linux-x64-0.21.5.tgz", + "integrity": "sha512-1rYdTpyv03iycF1+BhzrzQJCdOuAOtaqHTWJZCWvijKD2N5Xu0TtVC8/+1faWqcP9iBCWOmjmhoH94dH82BxPQ==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/@esbuild/netbsd-x64": { + "version": "0.21.5", + "resolved": "https://registry.npmjs.org/@esbuild/netbsd-x64/-/netbsd-x64-0.21.5.tgz", + "integrity": "sha512-Woi2MXzXjMULccIwMnLciyZH4nCIMpWQAs049KEeMvOcNADVxo0UBIQPfSmxB3CWKedngg7sWZdLvLczpe0tLg==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "netbsd" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/@esbuild/openbsd-x64": { + "version": "0.21.5", + "resolved": "https://registry.npmjs.org/@esbuild/openbsd-x64/-/openbsd-x64-0.21.5.tgz", + "integrity": "sha512-HLNNw99xsvx12lFBUwoT8EVCsSvRNDVxNpjZ7bPn947b8gJPzeHWyNVhFsaerc0n3TsbOINvRP2byTZ5LKezow==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "openbsd" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/@esbuild/sunos-x64": { + "version": "0.21.5", + "resolved": "https://registry.npmjs.org/@esbuild/sunos-x64/-/sunos-x64-0.21.5.tgz", + "integrity": "sha512-6+gjmFpfy0BHU5Tpptkuh8+uw3mnrvgs+dSPQXQOv3ekbordwnzTVEb4qnIvQcYXq6gzkyTnoZ9dZG+D4garKg==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "sunos" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/@esbuild/win32-arm64": { + "version": "0.21.5", + "resolved": "https://registry.npmjs.org/@esbuild/win32-arm64/-/win32-arm64-0.21.5.tgz", + "integrity": "sha512-Z0gOTd75VvXqyq7nsl93zwahcTROgqvuAcYDUr+vOv8uHhNSKROyU961kgtCD1e95IqPKSQKH7tBTslnS3tA8A==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "win32" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/@esbuild/win32-ia32": { + "version": "0.21.5", + "resolved": "https://registry.npmjs.org/@esbuild/win32-ia32/-/win32-ia32-0.21.5.tgz", + "integrity": "sha512-SWXFF1CL2RVNMaVs+BBClwtfZSvDgtL//G/smwAc5oVK/UPu2Gu9tIaRgFmYFFKrmg3SyAjSrElf0TiJ1v8fYA==", + "cpu": [ + "ia32" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "win32" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/@esbuild/win32-x64": { + "version": "0.21.5", + "resolved": "https://registry.npmjs.org/@esbuild/win32-x64/-/win32-x64-0.21.5.tgz", + "integrity": "sha512-tQd/1efJuzPC6rCFwEvLtci/xNFcTZknmXs98FYDfGE4wP9ClFV98nyKrzJKVPMhdDnjzLhdUyMX4PsQAPjwIw==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "win32" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/@rollup/rollup-android-arm-eabi": { + "version": "4.46.2", + "resolved": "https://registry.npmjs.org/@rollup/rollup-android-arm-eabi/-/rollup-android-arm-eabi-4.46.2.tgz", + "integrity": "sha512-Zj3Hl6sN34xJtMv7Anwb5Gu01yujyE/cLBDB2gnHTAHaWS1Z38L7kuSG+oAh0giZMqG060f/YBStXtMH6FvPMA==", + "cpu": [ + "arm" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "android" + ] + }, + "node_modules/@rollup/rollup-android-arm64": { + "version": "4.46.2", + "resolved": "https://registry.npmjs.org/@rollup/rollup-android-arm64/-/rollup-android-arm64-4.46.2.tgz", + "integrity": "sha512-nTeCWY83kN64oQ5MGz3CgtPx8NSOhC5lWtsjTs+8JAJNLcP3QbLCtDDgUKQc/Ro/frpMq4SHUaHN6AMltcEoLQ==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "android" + ] + }, + "node_modules/@rollup/rollup-darwin-arm64": { + "version": "4.46.2", + "resolved": "https://registry.npmjs.org/@rollup/rollup-darwin-arm64/-/rollup-darwin-arm64-4.46.2.tgz", + "integrity": "sha512-HV7bW2Fb/F5KPdM/9bApunQh68YVDU8sO8BvcW9OngQVN3HHHkw99wFupuUJfGR9pYLLAjcAOA6iO+evsbBaPQ==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "darwin" + ] + }, + "node_modules/@rollup/rollup-darwin-x64": { + "version": "4.46.2", + "resolved": "https://registry.npmjs.org/@rollup/rollup-darwin-x64/-/rollup-darwin-x64-4.46.2.tgz", + "integrity": "sha512-SSj8TlYV5nJixSsm/y3QXfhspSiLYP11zpfwp6G/YDXctf3Xkdnk4woJIF5VQe0of2OjzTt8EsxnJDCdHd2xMA==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "darwin" + ] + }, + "node_modules/@rollup/rollup-freebsd-arm64": { + "version": "4.46.2", + "resolved": "https://registry.npmjs.org/@rollup/rollup-freebsd-arm64/-/rollup-freebsd-arm64-4.46.2.tgz", + "integrity": "sha512-ZyrsG4TIT9xnOlLsSSi9w/X29tCbK1yegE49RYm3tu3wF1L/B6LVMqnEWyDB26d9Ecx9zrmXCiPmIabVuLmNSg==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "freebsd" + ] + }, + "node_modules/@rollup/rollup-freebsd-x64": { + "version": "4.46.2", + "resolved": "https://registry.npmjs.org/@rollup/rollup-freebsd-x64/-/rollup-freebsd-x64-4.46.2.tgz", + "integrity": "sha512-pCgHFoOECwVCJ5GFq8+gR8SBKnMO+xe5UEqbemxBpCKYQddRQMgomv1104RnLSg7nNvgKy05sLsY51+OVRyiVw==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "freebsd" + ] + }, + "node_modules/@rollup/rollup-linux-arm-gnueabihf": { + "version": "4.46.2", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm-gnueabihf/-/rollup-linux-arm-gnueabihf-4.46.2.tgz", + "integrity": "sha512-EtP8aquZ0xQg0ETFcxUbU71MZlHaw9MChwrQzatiE8U/bvi5uv/oChExXC4mWhjiqK7azGJBqU0tt5H123SzVA==", + "cpu": [ + "arm" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-arm-musleabihf": { + "version": "4.46.2", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm-musleabihf/-/rollup-linux-arm-musleabihf-4.46.2.tgz", + "integrity": "sha512-qO7F7U3u1nfxYRPM8HqFtLd+raev2K137dsV08q/LRKRLEc7RsiDWihUnrINdsWQxPR9jqZ8DIIZ1zJJAm5PjQ==", + "cpu": [ + "arm" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-arm64-gnu": { + "version": "4.46.2", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm64-gnu/-/rollup-linux-arm64-gnu-4.46.2.tgz", + "integrity": "sha512-3dRaqLfcOXYsfvw5xMrxAk9Lb1f395gkoBYzSFcc/scgRFptRXL9DOaDpMiehf9CO8ZDRJW2z45b6fpU5nwjng==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-arm64-musl": { + "version": "4.46.2", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm64-musl/-/rollup-linux-arm64-musl-4.46.2.tgz", + "integrity": "sha512-fhHFTutA7SM+IrR6lIfiHskxmpmPTJUXpWIsBXpeEwNgZzZZSg/q4i6FU4J8qOGyJ0TR+wXBwx/L7Ho9z0+uDg==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-loongarch64-gnu": { + "version": "4.46.2", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-loongarch64-gnu/-/rollup-linux-loongarch64-gnu-4.46.2.tgz", + "integrity": "sha512-i7wfGFXu8x4+FRqPymzjD+Hyav8l95UIZ773j7J7zRYc3Xsxy2wIn4x+llpunexXe6laaO72iEjeeGyUFmjKeA==", + "cpu": [ + "loong64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-ppc64-gnu": { + "version": "4.46.2", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-ppc64-gnu/-/rollup-linux-ppc64-gnu-4.46.2.tgz", + "integrity": "sha512-B/l0dFcHVUnqcGZWKcWBSV2PF01YUt0Rvlurci5P+neqY/yMKchGU8ullZvIv5e8Y1C6wOn+U03mrDylP5q9Yw==", + "cpu": [ + "ppc64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-riscv64-gnu": { + "version": "4.46.2", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-riscv64-gnu/-/rollup-linux-riscv64-gnu-4.46.2.tgz", + "integrity": "sha512-32k4ENb5ygtkMwPMucAb8MtV8olkPT03oiTxJbgkJa7lJ7dZMr0GCFJlyvy+K8iq7F/iuOr41ZdUHaOiqyR3iQ==", + "cpu": [ + "riscv64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-riscv64-musl": { + "version": "4.46.2", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-riscv64-musl/-/rollup-linux-riscv64-musl-4.46.2.tgz", + "integrity": "sha512-t5B2loThlFEauloaQkZg9gxV05BYeITLvLkWOkRXogP4qHXLkWSbSHKM9S6H1schf/0YGP/qNKtiISlxvfmmZw==", + "cpu": [ + "riscv64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-s390x-gnu": { + "version": "4.46.2", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-s390x-gnu/-/rollup-linux-s390x-gnu-4.46.2.tgz", + "integrity": "sha512-YKjekwTEKgbB7n17gmODSmJVUIvj8CX7q5442/CK80L8nqOUbMtf8b01QkG3jOqyr1rotrAnW6B/qiHwfcuWQA==", + "cpu": [ + "s390x" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-x64-gnu": { + "version": "4.46.2", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-x64-gnu/-/rollup-linux-x64-gnu-4.46.2.tgz", + "integrity": "sha512-Jj5a9RUoe5ra+MEyERkDKLwTXVu6s3aACP51nkfnK9wJTraCC8IMe3snOfALkrjTYd2G1ViE1hICj0fZ7ALBPA==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-x64-musl": { + "version": "4.46.2", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-x64-musl/-/rollup-linux-x64-musl-4.46.2.tgz", + "integrity": "sha512-7kX69DIrBeD7yNp4A5b81izs8BqoZkCIaxQaOpumcJ1S/kmqNFjPhDu1LHeVXv0SexfHQv5cqHsxLOjETuqDuA==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-win32-arm64-msvc": { + "version": "4.46.2", + "resolved": "https://registry.npmjs.org/@rollup/rollup-win32-arm64-msvc/-/rollup-win32-arm64-msvc-4.46.2.tgz", + "integrity": "sha512-wiJWMIpeaak/jsbaq2HMh/rzZxHVW1rU6coyeNNpMwk5isiPjSTx0a4YLSlYDwBH/WBvLz+EtsNqQScZTLJy3g==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "win32" + ] + }, + "node_modules/@rollup/rollup-win32-ia32-msvc": { + "version": "4.46.2", + "resolved": "https://registry.npmjs.org/@rollup/rollup-win32-ia32-msvc/-/rollup-win32-ia32-msvc-4.46.2.tgz", + "integrity": "sha512-gBgaUDESVzMgWZhcyjfs9QFK16D8K6QZpwAaVNJxYDLHWayOta4ZMjGm/vsAEy3hvlS2GosVFlBlP9/Wb85DqQ==", + "cpu": [ + "ia32" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "win32" + ] + }, + "node_modules/@rollup/rollup-win32-x64-msvc": { + "version": "4.46.2", + "resolved": "https://registry.npmjs.org/@rollup/rollup-win32-x64-msvc/-/rollup-win32-x64-msvc-4.46.2.tgz", + "integrity": "sha512-CvUo2ixeIQGtF6WvuB87XWqPQkoFAFqW+HUo/WzHwuHDvIwZCtjdWXoYCcr06iKGydiqTclC4jU/TNObC/xKZg==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "win32" + ] + }, + "node_modules/@types/estree": { + "version": "1.0.8", + "resolved": "https://registry.npmjs.org/@types/estree/-/estree-1.0.8.tgz", + "integrity": "sha512-dWHzHa2WqEXI/O1E9OjrocMTKJl2mSrEolh1Iomrv6U+JuNwaHXsXx9bLu5gG7BUWFIN0skIQJQ/L1rIex4X6w==", + "dev": true, + "license": "MIT" + }, + "node_modules/@wailsio/runtime": { + "version": "3.0.0-alpha.66", + "resolved": "https://registry.npmjs.org/@wailsio/runtime/-/runtime-3.0.0-alpha.66.tgz", + "integrity": "sha512-ENLu8rn1griL1gFHJqkq1i+BVxrrA0JPJHYneUJYuf/s54kjuQViW0RKDEe/WTDo56ABpfykrd/T8OYpPUyXUw==", + "license": "MIT" + }, + "node_modules/esbuild": { + "version": "0.21.5", + "resolved": "https://registry.npmjs.org/esbuild/-/esbuild-0.21.5.tgz", + "integrity": "sha512-mg3OPMV4hXywwpoDxu3Qda5xCKQi+vCTZq8S9J/EpkhB2HzKXq4SNFZE3+NK93JYxc8VMSep+lOUSC/RVKaBqw==", + "dev": true, + "hasInstallScript": true, + "license": "MIT", + "bin": { + "esbuild": "bin/esbuild" + }, + "engines": { + "node": ">=12" + }, + "optionalDependencies": { + "@esbuild/aix-ppc64": "0.21.5", + "@esbuild/android-arm": "0.21.5", + "@esbuild/android-arm64": "0.21.5", + "@esbuild/android-x64": "0.21.5", + "@esbuild/darwin-arm64": "0.21.5", + "@esbuild/darwin-x64": "0.21.5", + "@esbuild/freebsd-arm64": "0.21.5", + "@esbuild/freebsd-x64": "0.21.5", + "@esbuild/linux-arm": "0.21.5", + "@esbuild/linux-arm64": "0.21.5", + "@esbuild/linux-ia32": "0.21.5", + "@esbuild/linux-loong64": "0.21.5", + "@esbuild/linux-mips64el": "0.21.5", + "@esbuild/linux-ppc64": "0.21.5", + "@esbuild/linux-riscv64": "0.21.5", + "@esbuild/linux-s390x": "0.21.5", + "@esbuild/linux-x64": "0.21.5", + "@esbuild/netbsd-x64": "0.21.5", + "@esbuild/openbsd-x64": "0.21.5", + "@esbuild/sunos-x64": "0.21.5", + "@esbuild/win32-arm64": "0.21.5", + "@esbuild/win32-ia32": "0.21.5", + "@esbuild/win32-x64": "0.21.5" + } + }, + "node_modules/fsevents": { + "version": "2.3.3", + "resolved": "https://registry.npmjs.org/fsevents/-/fsevents-2.3.3.tgz", + "integrity": "sha512-5xoDfX+fL7faATnagmWPpbFtwh/R77WmMMqqHGS65C3vvB0YHrgF+B1YmZ3441tMj5n63k0212XNoJwzlhffQw==", + "dev": true, + "hasInstallScript": true, + "license": "MIT", + "optional": true, + "os": [ + "darwin" + ], + "engines": { + "node": "^8.16.0 || ^10.6.0 || >=11.0.0" + } + }, + "node_modules/nanoid": { + "version": "3.3.11", + "resolved": "https://registry.npmjs.org/nanoid/-/nanoid-3.3.11.tgz", + "integrity": "sha512-N8SpfPUnUp1bK+PMYW8qSWdl9U+wwNWI4QKxOYDy9JAro3WMX7p2OeVRF9v+347pnakNevPmiHhNmZ2HbFA76w==", + "dev": true, + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/ai" + } + ], + "license": "MIT", + "bin": { + "nanoid": "bin/nanoid.cjs" + }, + "engines": { + "node": "^10 || ^12 || ^13.7 || ^14 || >=15.0.1" + } + }, + "node_modules/picocolors": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/picocolors/-/picocolors-1.1.1.tgz", + "integrity": "sha512-xceH2snhtb5M9liqDsmEw56le376mTZkEX/jEb/RxNFyegNul7eNslCXP9FDj/Lcu0X8KEyMceP2ntpaHrDEVA==", + "dev": true, + "license": "ISC" + }, + "node_modules/postcss": { + "version": "8.5.6", + "resolved": "https://registry.npmjs.org/postcss/-/postcss-8.5.6.tgz", + "integrity": "sha512-3Ybi1tAuwAP9s0r1UQ2J4n5Y0G05bJkpUIO0/bI9MhwmD70S5aTWbXGBwxHrelT+XM1k6dM0pk+SwNkpTRN7Pg==", + "dev": true, + "funding": [ + { + "type": "opencollective", + "url": "https://opencollective.com/postcss/" + }, + { + "type": "tidelift", + "url": "https://tidelift.com/funding/github/npm/postcss" + }, + { + "type": "github", + "url": "https://github.com/sponsors/ai" + } + ], + "license": "MIT", + "dependencies": { + "nanoid": "^3.3.11", + "picocolors": "^1.1.1", + "source-map-js": "^1.2.1" + }, + "engines": { + "node": "^10 || ^12 || >=14" + } + }, + "node_modules/rollup": { + "version": "4.46.2", + "resolved": "https://registry.npmjs.org/rollup/-/rollup-4.46.2.tgz", + "integrity": "sha512-WMmLFI+Boh6xbop+OAGo9cQ3OgX9MIg7xOQjn+pTCwOkk+FNDAeAemXkJ3HzDJrVXleLOFVa1ipuc1AmEx1Dwg==", + "dev": true, + "license": "MIT", + "dependencies": { + "@types/estree": "1.0.8" + }, + "bin": { + "rollup": "dist/bin/rollup" + }, + "engines": { + "node": ">=18.0.0", + "npm": ">=8.0.0" + }, + "optionalDependencies": { + "@rollup/rollup-android-arm-eabi": "4.46.2", + "@rollup/rollup-android-arm64": "4.46.2", + "@rollup/rollup-darwin-arm64": "4.46.2", + "@rollup/rollup-darwin-x64": "4.46.2", + "@rollup/rollup-freebsd-arm64": "4.46.2", + "@rollup/rollup-freebsd-x64": "4.46.2", + "@rollup/rollup-linux-arm-gnueabihf": "4.46.2", + "@rollup/rollup-linux-arm-musleabihf": "4.46.2", + "@rollup/rollup-linux-arm64-gnu": "4.46.2", + "@rollup/rollup-linux-arm64-musl": "4.46.2", + "@rollup/rollup-linux-loongarch64-gnu": "4.46.2", + "@rollup/rollup-linux-ppc64-gnu": "4.46.2", + "@rollup/rollup-linux-riscv64-gnu": "4.46.2", + "@rollup/rollup-linux-riscv64-musl": "4.46.2", + "@rollup/rollup-linux-s390x-gnu": "4.46.2", + "@rollup/rollup-linux-x64-gnu": "4.46.2", + "@rollup/rollup-linux-x64-musl": "4.46.2", + "@rollup/rollup-win32-arm64-msvc": "4.46.2", + "@rollup/rollup-win32-ia32-msvc": "4.46.2", + "@rollup/rollup-win32-x64-msvc": "4.46.2", + "fsevents": "~2.3.2" + } + }, + "node_modules/source-map-js": { + "version": "1.2.1", + "resolved": "https://registry.npmjs.org/source-map-js/-/source-map-js-1.2.1.tgz", + "integrity": "sha512-UXWMKhLOwVKb728IUtQPXxfYU+usdybtUrK/8uGE8CQMvrhOpwvzDBwj0QhSL7MQc7vIsISBG8VQ8+IDQxpfQA==", + "dev": true, + "license": "BSD-3-Clause", + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/typescript": { + "version": "4.9.5", + "resolved": "https://registry.npmjs.org/typescript/-/typescript-4.9.5.tgz", + "integrity": "sha512-1FXk9E2Hm+QzZQ7z+McJiHL4NW1F2EzMu9Nq9i3zAaGqibafqYwCVU6WyWAuyQRRzOlxou8xZSyXLEN8oKj24g==", + "dev": true, + "license": "Apache-2.0", + "bin": { + "tsc": "bin/tsc", + "tsserver": "bin/tsserver" + }, + "engines": { + "node": ">=4.2.0" + } + }, + "node_modules/vite": { + "version": "5.4.19", + "resolved": "https://registry.npmjs.org/vite/-/vite-5.4.19.tgz", + "integrity": "sha512-qO3aKv3HoQC8QKiNSTuUM1l9o/XX3+c+VTgLHbJWHZGeTPVAg2XwazI9UWzoxjIJCGCV2zU60uqMzjeLZuULqA==", + "dev": true, + "license": "MIT", + "dependencies": { + "esbuild": "^0.21.3", + "postcss": "^8.4.43", + "rollup": "^4.20.0" + }, + "bin": { + "vite": "bin/vite.js" + }, + "engines": { + "node": "^18.0.0 || >=20.0.0" + }, + "funding": { + "url": "https://github.com/vitejs/vite?sponsor=1" + }, + "optionalDependencies": { + "fsevents": "~2.3.3" + }, + "peerDependencies": { + "@types/node": "^18.0.0 || >=20.0.0", + "less": "*", + "lightningcss": "^1.21.0", + "sass": "*", + "sass-embedded": "*", + "stylus": "*", + "sugarss": "*", + "terser": "^5.4.0" + }, + "peerDependenciesMeta": { + "@types/node": { + "optional": true + }, + "less": { + "optional": true + }, + "lightningcss": { + "optional": true + }, + "sass": { + "optional": true + }, + "sass-embedded": { + "optional": true + }, + "stylus": { + "optional": true + }, + "sugarss": { + "optional": true + }, + "terser": { + "optional": true + } + } + } + } +} diff --git a/v3/examples/dock/frontend/package.json b/v3/examples/dock/frontend/package.json new file mode 100644 index 000000000..b39da7ece --- /dev/null +++ b/v3/examples/dock/frontend/package.json @@ -0,0 +1,19 @@ +{ + "name": "frontend", + "private": true, + "version": "0.0.0", + "type": "module", + "scripts": { + "dev": "vite", + "build:dev": "tsc && vite build --minify false --mode development", + "build": "tsc && vite build --mode production", + "preview": "vite preview" + }, + "dependencies": { + "@wailsio/runtime": "latest" + }, + "devDependencies": { + "typescript": "^4.9.3", + "vite": "^5.0.0" + } +} diff --git a/v3/examples/dock/frontend/public/Inter-Medium.ttf b/v3/examples/dock/frontend/public/Inter-Medium.ttf new file mode 100644 index 000000000..a01f3777a Binary files /dev/null and b/v3/examples/dock/frontend/public/Inter-Medium.ttf differ diff --git a/v3/examples/dock/frontend/public/style.css b/v3/examples/dock/frontend/public/style.css new file mode 100644 index 000000000..0b9c58279 --- /dev/null +++ b/v3/examples/dock/frontend/public/style.css @@ -0,0 +1,157 @@ +:root { + font-family: "Inter", -apple-system, BlinkMacSystemFont, "Segoe UI", "Roboto", + "Oxygen", "Ubuntu", "Cantarell", "Fira Sans", "Droid Sans", "Helvetica Neue", + sans-serif; + font-size: 16px; + line-height: 24px; + font-weight: 400; + color-scheme: light dark; + color: rgba(255, 255, 255, 0.87); + background-color: rgba(27, 38, 54, 1); + font-synthesis: none; + text-rendering: optimizeLegibility; + -webkit-font-smoothing: antialiased; + -moz-osx-font-smoothing: grayscale; + -webkit-text-size-adjust: 100%; + user-select: none; + -webkit-user-select: none; + -moz-user-select: none; + -ms-user-select: none; +} + +@font-face { + font-family: "Inter"; + font-style: normal; + font-weight: 400; + src: local(""), + url("./Inter-Medium.ttf") format("truetype"); +} + +h3 { + font-size: 3em; + line-height: 1.1; +} + +a { + font-weight: 500; + color: #646cff; + text-decoration: inherit; +} + +a:hover { + color: #535bf2; +} + +button { + width: 60px; + height: 30px; + line-height: 30px; + border-radius: 3px; + border: none; + margin: 0 0 0 20px; + padding: 0 8px; + cursor: pointer; +} + +.result { + height: 20px; + line-height: 20px; +} + +body { + margin: 0; + display: flex; + place-items: center; + place-content: center; + min-width: 320px; + min-height: 100vh; +} + +.container { + display: flex; + flex-direction: column; + align-items: center; + justify-content: center; +} + +h1 { + font-size: 3.2em; + line-height: 1.1; +} + +#app { + max-width: 1280px; + margin: 0 auto; + padding: 2rem; + text-align: center; +} + +.logo { + height: 6em; + padding: 1.5em; + will-change: filter; +} + +.logo:hover { + filter: drop-shadow(0 0 2em #e80000aa); +} + +.logo.vanilla:hover { + filter: drop-shadow(0 0 2em #f7df1eaa); +} + +.result { + height: 20px; + line-height: 20px; + margin: 1.5rem auto; + text-align: center; +} + +.footer { + margin-top: 1rem; + align-content: center; + text-align: center; +} + +@media (prefers-color-scheme: light) { + :root { + color: #213547; + background-color: #ffffff; + } + + a:hover { + color: #747bff; + } + + button { + background-color: #f9f9f9; + } +} + + +.input-box .btn:hover { + background-image: linear-gradient(to top, #cfd9df 0%, #e2ebf0 100%); + color: #333333; +} + +.input-box .input { + border: none; + border-radius: 3px; + outline: none; + height: 30px; + line-height: 30px; + padding: 0 10px; + color: black; + background-color: rgba(240, 240, 240, 1); + -webkit-font-smoothing: antialiased; +} + +.input-box .input:hover { + border: none; + background-color: rgba(255, 255, 255, 1); +} + +.input-box .input:focus { + border: none; + background-color: rgba(255, 255, 255, 1); +} \ No newline at end of file diff --git a/v3/examples/dock/frontend/public/typescript.svg b/v3/examples/dock/frontend/public/typescript.svg new file mode 100644 index 000000000..d91c910cc --- /dev/null +++ b/v3/examples/dock/frontend/public/typescript.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/v3/examples/dock/frontend/public/wails.png b/v3/examples/dock/frontend/public/wails.png new file mode 100644 index 000000000..8bdf42483 Binary files /dev/null and b/v3/examples/dock/frontend/public/wails.png differ diff --git a/v3/examples/dock/frontend/src/main.ts b/v3/examples/dock/frontend/src/main.ts new file mode 100644 index 000000000..6ef5af25f --- /dev/null +++ b/v3/examples/dock/frontend/src/main.ts @@ -0,0 +1,12 @@ +import { DockService } from "../bindings/github.com/wailsapp/wails/v3/pkg/services/dock" + +const showButton = document.getElementById('show')! as HTMLButtonElement; +const hideButton = document.getElementById('hide')! as HTMLButtonElement; + +showButton.addEventListener('click', () => { + DockService.ShowAppIcon(); +}); + +hideButton.addEventListener('click', () => { + DockService.HideAppIcon(); +}); \ No newline at end of file diff --git a/v3/examples/dock/frontend/src/vite-env.d.ts b/v3/examples/dock/frontend/src/vite-env.d.ts new file mode 100644 index 000000000..11f02fe2a --- /dev/null +++ b/v3/examples/dock/frontend/src/vite-env.d.ts @@ -0,0 +1 @@ +/// diff --git a/v3/examples/dock/frontend/tsconfig.json b/v3/examples/dock/frontend/tsconfig.json new file mode 100644 index 000000000..c267ecf24 --- /dev/null +++ b/v3/examples/dock/frontend/tsconfig.json @@ -0,0 +1,20 @@ +{ + "compilerOptions": { + "target": "ESNext", + "useDefineForClassFields": true, + "module": "ESNext", + "lib": ["ESNext", "DOM"], + "moduleResolution": "Node", + "strict": true, + "resolveJsonModule": true, + "isolatedModules": true, + "esModuleInterop": true, + "noEmit": true, + "noUnusedLocals": true, + "noUnusedParameters": false, + "noImplicitAny": false, + "noImplicitReturns": true, + "skipLibCheck": true + }, + "include": ["src"] +} diff --git a/v3/examples/dock/main.go b/v3/examples/dock/main.go new file mode 100644 index 000000000..446645448 --- /dev/null +++ b/v3/examples/dock/main.go @@ -0,0 +1,70 @@ +package main + +import ( + "embed" + _ "embed" + "log" + + "github.com/wailsapp/wails/v3/pkg/application" + "github.com/wailsapp/wails/v3/pkg/services/dock" +) + +// Wails uses Go's `embed` package to embed the frontend files into the binary. +// Any files in the frontend/dist folder will be embedded into the binary and +// made available to the frontend. +// See https://pkg.go.dev/embed for more information. + +//go:embed all:frontend/dist +var assets embed.FS + +// main function serves as the application's entry point. It initializes the application, creates a window, +// and starts a goroutine that emits a time-based event every second. It subsequently runs the application and +// logs any error that might occur. +func main() { + + // Create a new Wails application by providing the necessary options. + // Variables 'Name' and 'Description' are for application metadata. + // 'Assets' configures the asset server with the 'FS' variable pointing to the frontend files. + // 'Bind' is a list of Go struct instances. The frontend has access to the methods of these instances. + // 'Mac' options tailor the application when running an macOS. + + dockService := dock.New() + + app := application.New(application.Options{ + Name: "dock", + Description: "A demo of using raw HTML & CSS", + Services: []application.Service{ + application.NewService(dockService), + }, + Assets: application.AssetOptions{ + Handler: application.AssetFileServerFS(assets), + }, + Mac: application.MacOptions{ + ApplicationShouldTerminateAfterLastWindowClosed: true, + }, + }) + + // Create a new window with the necessary options. + // 'Title' is the title of the window. + // 'Mac' options tailor the window when running on macOS. + // 'BackgroundColour' is the background colour of the window. + // 'URL' is the URL that will be loaded into the webview. + app.Window.NewWithOptions(application.WebviewWindowOptions{ + Title: "Window 1", + Mac: application.MacWindow{ + InvisibleTitleBarHeight: 50, + Backdrop: application.MacBackdropTranslucent, + TitleBar: application.MacTitleBarHiddenInset, + }, + BackgroundColour: application.NewRGB(27, 38, 54), + URL: "/", + }) + + // Run the application. This blocks until the application has been exited. + err := app.Run() + + // If an error occurred while running the application, log it and exit. + if err != nil { + log.Fatal(err) + } +} diff --git a/v3/examples/drag-n-drop/README.md b/v3/examples/drag-n-drop/README.md new file mode 100644 index 000000000..a2cde8844 --- /dev/null +++ b/v3/examples/drag-n-drop/README.md @@ -0,0 +1,75 @@ +# File Drop Example + +This example demonstrates how to handle files being dragged from the operating system (Finder, Explorer, file managers) into a Wails application. + +Dropped files are automatically categorised by type and displayed in separate buckets: documents, images, or other files. + +## How it works + +1. Enable file drops in window options: + ```go + EnableFileDrop: true + ``` + +2. Mark elements as drop targets in HTML: + ```html +
      Drop files here
      + ``` + +3. Listen for the `WindowFilesDropped` event: + ```go + win.OnWindowEvent(events.Common.WindowFilesDropped, func(event *application.WindowEvent) { + files := event.Context().DroppedFiles() + details := event.Context().DropTargetDetails() + // Handle the dropped files + }) + ``` + +4. Optionally forward to frontend: + ```go + application.Get().Event.Emit("files-dropped", map[string]any{ + "files": files, + "details": details, + }) + ``` + +## Drop Target Details + +When files are dropped, you can get information about the drop location: + +- `ElementID` - The ID of the element that received the drop +- `ClassList` - CSS classes on the drop target +- `X`, `Y` - Coordinates of the drop within the element + +## Styling + +When files are dragged over a valid drop target, Wails adds the `file-drop-target-active` class: + +```css +.file-drop-target-active { + border-color: #4a9eff; + background: rgba(74, 158, 255, 0.1); +} +``` + +## Running the example + +```bash +go run main.go +``` + +Then drag files from your desktop or file manager into the drop zone. + +## HTML5 Drag and Drop API + +This example also includes a demonstration for dragging elements *within* your application via the HTML5 Drag and Drop API. + +Scroll down to the `Internal Drag and Drop` section within the launched application to interact with the demo. + +## Status + +| Platform | Status | +|----------|---------| +| Mac | Working | +| Windows | Working | +| Linux | Working | diff --git a/v3/examples/drag-n-drop/assets/index.html b/v3/examples/drag-n-drop/assets/index.html new file mode 100644 index 000000000..53af94212 --- /dev/null +++ b/v3/examples/drag-n-drop/assets/index.html @@ -0,0 +1,435 @@ + + + + + + Drag and Drop Demo + + + +

      Drag and Drop Demo

      + + +

      External File Drop

      +
      +

      + Drop files from your operating system (Finder, Explorer, file managers). + Uses EnableFileDrop: true and data-file-drop-target +

      +
      + +
      +
      +

      Drop files from your desktop or file manager here

      +
      + +
      +
      +

      Documents

      +
        +
      • No documents yet
      • +
      +
      + +
      +

      Images

      +
        +
      • No images yet
      • +
      +
      + +
      +

      Other Files

      +
        +
      • No other files yet
      • +
      +
      +
      +
      + + +

      Internal Drag and Drop

      +
      +

      + Drag items between zones using the HTML5 Drag and Drop API. + Uses draggable="true" and standard DOM events. +

      +
      + +
      +
      +
      +

      Tasks

      +
      Fix login bug
      +
      Update documentation
      +
      Add dark mode
      +
      Refactor API calls
      +
      Write unit tests
      +
      + +
      +
      +

      High Priority

      +
        +
        + +
        +

        Medium Priority

        +
          +
          + +
          +

          Low Priority

          +
            +
            +
            +
            +
            + +
            + Last action: No actions yet +
            + + + + diff --git a/v3/examples/drag-n-drop/main.go b/v3/examples/drag-n-drop/main.go new file mode 100644 index 000000000..5caafef1e --- /dev/null +++ b/v3/examples/drag-n-drop/main.go @@ -0,0 +1,60 @@ +package main + +import ( + "embed" + "log" + + "github.com/wailsapp/wails/v3/pkg/application" + "github.com/wailsapp/wails/v3/pkg/events" +) + +//go:embed assets +var assets embed.FS + +func main() { + app := application.New(application.Options{ + Name: "File Drop Demo", + Description: "A demo of file drag and drop", + Assets: application.AssetOptions{ + Handler: application.BundledAssetFileServer(assets), + }, + Mac: application.MacOptions{ + ApplicationShouldTerminateAfterLastWindowClosed: true, + }, + }) + + win := app.Window.NewWithOptions(application.WebviewWindowOptions{ + Title: "File Drop Demo", + Width: 800, + Height: 600, + EnableFileDrop: true, + Mac: application.MacWindow{ + Backdrop: application.MacBackdropTranslucent, + TitleBar: application.MacTitleBarHiddenInsetUnified, + InvisibleTitleBarHeight: 50, + }, + }) + + // Listen for file drop events + win.OnWindowEvent(events.Common.WindowFilesDropped, func(event *application.WindowEvent) { + files := event.Context().DroppedFiles() + details := event.Context().DropTargetDetails() + + log.Printf("Files dropped: %v", files) + if details != nil { + log.Printf("Drop target: id=%s, classes=%v, x=%d, y=%d", + details.ElementID, details.ClassList, details.X, details.Y) + } + + // Emit event to frontend + application.Get().Event.Emit("files-dropped", map[string]any{ + "files": files, + "details": details, + }) + }) + + err := app.Run() + if err != nil { + log.Fatal(err) + } +} diff --git a/v3/examples/environment/README.md b/v3/examples/environment/README.md new file mode 100644 index 000000000..1f922f341 --- /dev/null +++ b/v3/examples/environment/README.md @@ -0,0 +1,19 @@ +# Screen Example + +This example will detect all attached screens and display their details. + +## Running the example + +To run the example, simply run the following command: + +```bash +go run . +``` + +# Status + +| Platform | Status | +|----------|---------| +| Mac | Working | +| Windows | Working | +| Linux | | diff --git a/v3/examples/environment/assets/index.html b/v3/examples/environment/assets/index.html new file mode 100644 index 000000000..32bb5ebba --- /dev/null +++ b/v3/examples/environment/assets/index.html @@ -0,0 +1,66 @@ + + + + + Screens Demo + + + + + + + diff --git a/v3/examples/environment/main.go b/v3/examples/environment/main.go new file mode 100644 index 000000000..76822aaa9 --- /dev/null +++ b/v3/examples/environment/main.go @@ -0,0 +1,43 @@ +package main + +import ( + "embed" + _ "embed" + "log" + + "github.com/wailsapp/wails/v3/pkg/application" +) + +//go:embed assets/* +var assets embed.FS + +func main() { + + app := application.New(application.Options{ + Name: "Environment Demo", + Description: "A demo of the Environment API", + Mac: application.MacOptions{ + ApplicationShouldTerminateAfterLastWindowClosed: true, + }, + Assets: application.AssetOptions{ + Handler: application.BundledAssetFileServer(assets), + }, + }) + + app.Window.NewWithOptions(application.WebviewWindowOptions{ + Title: "Environment Demo", + Width: 800, + Height: 600, + Mac: application.MacWindow{ + Backdrop: application.MacBackdropTranslucent, + TitleBar: application.MacTitleBarHiddenInsetUnified, + InvisibleTitleBarHeight: 50, + }, + }) + + err := app.Run() + + if err != nil { + log.Fatal(err.Error()) + } +} diff --git a/v3/examples/events-bug/main.go b/v3/examples/events-bug/main.go new file mode 100644 index 000000000..f3bf88554 --- /dev/null +++ b/v3/examples/events-bug/main.go @@ -0,0 +1,60 @@ +package main + +import ( + _ "embed" + "github.com/wailsapp/wails/v3/pkg/application" + "log" +) + +var app *application.App + +func main() { + app = application.New(application.Options{ + Name: "Key Bindings Demo", + Description: "A demo of the Key Bindings Options", + Mac: application.MacOptions{ + ApplicationShouldTerminateAfterLastWindowClosed: true, + }, + KeyBindings: map[string]func(window application.Window){ + "shift+ctrl+c": func(window application.Window) { + selection, err := app.Dialog.OpenFile(). + CanChooseFiles(true). + CanCreateDirectories(true). + ShowHiddenFiles(true). + PromptForMultipleSelection() + if err != nil { + println(err.Error()) + } + println(selection) + }, + }, + }) + + app.Window.NewWithOptions(application.WebviewWindowOptions{ + Name: "Window 1", + Title: "Window 1", + URL: "https://wails.io", + KeyBindings: map[string]func(window application.Window){ + "F12": func(window application.Window) { + window.OpenDevTools() + }, + }, + }) + + app.Window.NewWithOptions(application.WebviewWindowOptions{ + Name: "Window 2", + Title: "Window 2", + URL: "https://google.com", + KeyBindings: map[string]func(window application.Window){ + "F12": func(window application.Window) { + println("Window 2: Toggle Dev Tools") + }, + }, + }) + + err := app.Run() + if err != nil { + log.Fatal(err) + } + +} diff --git a/v3/examples/events/README.md b/v3/examples/events/README.md new file mode 100644 index 000000000..596540f5a --- /dev/null +++ b/v3/examples/events/README.md @@ -0,0 +1,25 @@ +# Events Example + +This example is a demonstration of using the new events API. +It has 2 windows that can emit events from the frontend and the backend emits an event every 10 seconds. +All events emitted are logged either to the console or the window. + +It also demonstrates the use of `RegisterHook` to register a function to be called when an event is emitted. +For one window, it captures the `WindowClosing` event and prevents the window from closing twice. +The other window uses both hooks and events to show the window is gaining focus. + +## Running the example + +To run the example, simply run the following command: + +```bash +go run main.go +``` + +# Status + +| Platform | Status | +|----------|---------| +| Mac | | +| Windows | Working | +| Linux | | \ No newline at end of file diff --git a/v3/examples/events/assets/index.html b/v3/examples/events/assets/index.html new file mode 100644 index 000000000..069baabdb --- /dev/null +++ b/v3/examples/events/assets/index.html @@ -0,0 +1,29 @@ + + + + + Title + + + +

            Events Demo

            +
            +The main program emits an event every 10s which will be displayed in the section below. +To send an event from this window, click here: +
            + + + + + diff --git a/v3/examples/events/main.go b/v3/examples/events/main.go new file mode 100644 index 000000000..6f3d71be5 --- /dev/null +++ b/v3/examples/events/main.go @@ -0,0 +1,129 @@ +package main + +import ( + "embed" + _ "embed" + "log" + "time" + + "github.com/wailsapp/wails/v3/pkg/application" + "github.com/wailsapp/wails/v3/pkg/events" +) + +//go:embed assets +var assets embed.FS + +func main() { + + app := application.New(application.Options{ + Name: "customEventProcessor Demo", + Description: "A demo of the customEventProcessor API", + Assets: application.AssetOptions{ + Handler: application.BundledAssetFileServer(assets), + }, + Mac: application.MacOptions{ + ApplicationShouldTerminateAfterLastWindowClosed: true, + }, + }) + + // Custom event handling + app.Event.On("myevent", func(e *application.CustomEvent) { + app.Logger.Info("[Go] CustomEvent received", "name", e.Name, "data", e.Data, "sender", e.Sender, "cancelled", e.IsCancelled()) + }) + + // OS specific application events + app.Event.OnApplicationEvent(events.Common.ApplicationStarted, func(event *application.ApplicationEvent) { + go func() { + ticker := time.NewTicker(10 * time.Second) + defer ticker.Stop() + for { + select { + case <-ticker.C: + // This emits a custom event every 10 seconds + // As it's sent from the application, the sender will be blank + app.Event.Emit("myevent", "hello") + case <-app.Context().Done(): + return + } + } + }() + }) + + app.Event.OnApplicationEvent(events.Common.ThemeChanged, func(event *application.ApplicationEvent) { + app.Logger.Info("System theme changed!") + if event.Context().IsDarkMode() { + app.Logger.Info("System is now using dark mode!") + } else { + app.Logger.Info("System is now using light mode!") + } + }) + + // Platform agnostic events + app.Event.OnApplicationEvent(events.Common.ApplicationStarted, func(event *application.ApplicationEvent) { + app.Logger.Info("events.Common.ApplicationStarted fired!") + }) + + win1 := app.Window.NewWithOptions(application.WebviewWindowOptions{ + Title: "Window 1", + Name: "Window 1", + Mac: application.MacWindow{ + Backdrop: application.MacBackdropTranslucent, + TitleBar: application.MacTitleBarHiddenInsetUnified, + InvisibleTitleBarHeight: 50, + }, + }) + + var countdown = 3 + + win1.RegisterHook(events.Common.WindowClosing, func(e *application.WindowEvent) { + countdown-- + if countdown == 0 { + app.Logger.Info("Window 1 Closing!") + return + } + app.Logger.Info("Window 1 Closing? Nope! Not closing!") + e.Cancel() + }) + + win2 := app.Window.NewWithOptions(application.WebviewWindowOptions{ + Title: "Window 2", + Mac: application.MacWindow{ + Backdrop: application.MacBackdropTranslucent, + TitleBar: application.MacTitleBarHiddenInsetUnified, + InvisibleTitleBarHeight: 50, + }, + }) + + go func() { + ticker := time.NewTicker(10 * time.Second) + defer ticker.Stop() + for { + select { + case <-ticker.C: + win2.EmitEvent("windowevent", "ooooh!") + case <-app.Context().Done(): + return + } + } + }() + + var cancel bool + + win2.RegisterHook(events.Common.WindowFocus, func(e *application.WindowEvent) { + app.Logger.Info("[Hook] Window focus!") + cancel = !cancel + if cancel { + e.Cancel() + } + }) + + win2.OnWindowEvent(events.Common.WindowFocus, func(e *application.WindowEvent) { + app.Logger.Info("[OnWindowEvent] Window focus!") + }) + + err := app.Run() + + if err != nil { + log.Fatal(err.Error()) + } +} diff --git a/v3/examples/file-association/.gitignore b/v3/examples/file-association/.gitignore new file mode 100644 index 000000000..4b51c175c --- /dev/null +++ b/v3/examples/file-association/.gitignore @@ -0,0 +1,3 @@ +.task +bin +wails.syso \ No newline at end of file diff --git a/v3/examples/file-association/Inter Font License.txt b/v3/examples/file-association/Inter Font License.txt new file mode 100644 index 000000000..b525cbf3a --- /dev/null +++ b/v3/examples/file-association/Inter Font License.txt @@ -0,0 +1,93 @@ +Copyright 2020 The Inter Project Authors (https://github.com/rsms/inter) + +This Font Software is licensed under the SIL Open Font License, Version 1.1. +This license is copied below, and is also available with a FAQ at: +http://scripts.sil.org/OFL + + +----------------------------------------------------------- +SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007 +----------------------------------------------------------- + +PREAMBLE +The goals of the Open Font License (OFL) are to stimulate worldwide +development of collaborative font projects, to support the font creation +efforts of academic and linguistic communities, and to provide a free and +open framework in which fonts may be shared and improved in partnership +with others. + +The OFL allows the licensed fonts to be used, studied, modified and +redistributed freely as long as they are not sold by themselves. The +fonts, including any derivative works, can be bundled, embedded, +redistributed and/or sold with any software provided that any reserved +names are not used by derivative works. The fonts and derivatives, +however, cannot be released under any other type of license. The +requirement for fonts to remain under this license does not apply +to any document created using the fonts or their derivatives. + +DEFINITIONS +"Font Software" refers to the set of files released by the Copyright +Holder(s) under this license and clearly marked as such. This may +include source files, build scripts and documentation. + +"Reserved Font Name" refers to any names specified as such after the +copyright statement(s). + +"Original Version" refers to the collection of Font Software components as +distributed by the Copyright Holder(s). + +"Modified Version" refers to any derivative made by adding to, deleting, +or substituting -- in part or in whole -- any of the components of the +Original Version, by changing formats or by porting the Font Software to a +new environment. + +"Author" refers to any designer, engineer, programmer, technical +writer or other person who contributed to the Font Software. + +PERMISSION & CONDITIONS +Permission is hereby granted, free of charge, to any person obtaining +a copy of the Font Software, to use, study, copy, merge, embed, modify, +redistribute, and sell modified and unmodified copies of the Font +Software, subject to the following conditions: + +1) Neither the Font Software nor any of its individual components, +in Original or Modified Versions, may be sold by itself. + +2) Original or Modified Versions of the Font Software may be bundled, +redistributed and/or sold with any software, provided that each copy +contains the above copyright notice and this license. These can be +included either as stand-alone text files, human-readable headers or +in the appropriate machine-readable metadata fields within text or +binary files as long as those fields can be easily viewed by the user. + +3) No Modified Version of the Font Software may use the Reserved Font +Name(s) unless explicit written permission is granted by the corresponding +Copyright Holder. This restriction only applies to the primary font name as +presented to the users. + +4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font +Software shall not be used to promote, endorse or advertise any +Modified Version, except to acknowledge the contribution(s) of the +Copyright Holder(s) and the Author(s) or with their explicit written +permission. + +5) The Font Software, modified or unmodified, in part or in whole, +must be distributed entirely under this license, and must not be +distributed under any other license. The requirement for fonts to +remain under this license does not apply to any document created +using the Font Software. + +TERMINATION +This license becomes null and void if any of the above conditions are +not met. + +DISCLAIMER +THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF +MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT +OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE +COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, +INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL +DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING +FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM +OTHER DEALINGS IN THE FONT SOFTWARE. diff --git a/v3/examples/file-association/README.md b/v3/examples/file-association/README.md new file mode 100644 index 000000000..0aa08023f --- /dev/null +++ b/v3/examples/file-association/README.md @@ -0,0 +1,11 @@ +# File Association Sample Project + +This sample project demonstrates how to associate a file type with an application. +More info at: https://v3.wails.io/learn/guides/file-associations/ + +To run the sample, follow these steps: + +1. Run `wails3 package` to generate the package. +2. On Windows, run the installer that was built in the `bin` directory. +3. Double-click on the `test.wails` file to open it with the application. +4. On macOS, double-click on the `test.wails` file and select the built application. \ No newline at end of file diff --git a/v3/examples/file-association/Taskfile.yml b/v3/examples/file-association/Taskfile.yml new file mode 100644 index 000000000..4ec68e23f --- /dev/null +++ b/v3/examples/file-association/Taskfile.yml @@ -0,0 +1,54 @@ +version: '3' + +includes: + common: ./build/Taskfile.common.yml + windows: ./build/Taskfile.windows.yml + darwin: ./build/Taskfile.darwin.yml + linux: ./build/Taskfile.linux.yml + +vars: + APP_NAME: "fileassoc" + BIN_DIR: "bin" + VITE_PORT: '{{.WAILS_VITE_PORT | default 9245}}' + +tasks: + build: + summary: Builds the application + cmds: + - task: "{{OS}}:build" + + package: + summary: Packages a production build of the application + cmds: + - task: "{{OS}}:package" + + run: + summary: Runs the application + cmds: + - task: "{{OS}}:run" + + dev: + summary: Runs the application in development mode + cmds: + - wails3 dev -config ./build/config.yml -port {{.VITE_PORT}} + + darwin:build:universal: + summary: Builds darwin universal binary (arm64 + amd64) + cmds: + - task: darwin:build + vars: + ARCH: amd64 + - mv {{.BIN_DIR}}/{{.APP_NAME}} {{.BIN_DIR}}/{{.APP_NAME}}-amd64 + - task: darwin:build + vars: + ARCH: arm64 + - mv {{.BIN_DIR}}/{{.APP_NAME}} {{.BIN_DIR}}/{{.APP_NAME}}-arm64 + - lipo -create -output {{.BIN_DIR}}/{{.APP_NAME}} {{.BIN_DIR}}/{{.APP_NAME}}-amd64 {{.BIN_DIR}}/{{.APP_NAME}}-arm64 + - rm {{.BIN_DIR}}/{{.APP_NAME}}-amd64 {{.BIN_DIR}}/{{.APP_NAME}}-arm64 + + darwin:package:universal: + summary: Packages darwin universal binary (arm64 + amd64) + deps: + - darwin:build:universal + cmds: + - task: darwin:create:app:bundle diff --git a/v3/examples/file-association/build/Info.dev.plist b/v3/examples/file-association/build/Info.dev.plist new file mode 100644 index 000000000..327c94603 --- /dev/null +++ b/v3/examples/file-association/build/Info.dev.plist @@ -0,0 +1,32 @@ + + + + CFBundlePackageType + APPL + CFBundleName + My Product + CFBundleExecutable + fileassoc + CFBundleIdentifier + + CFBundleVersion + 0.1.0 + CFBundleGetInfoString + This is a comment + CFBundleShortVersionString + 0.1.0 + CFBundleIconFile + icons + LSMinimumSystemVersion + 10.13.0 + NSHighResolutionCapable + true + NSHumanReadableCopyright + © now, My Company + NSAppTransportSecurity + + NSAllowsLocalNetworking + + + + \ No newline at end of file diff --git a/v3/examples/file-association/build/Info.plist b/v3/examples/file-association/build/Info.plist new file mode 100644 index 000000000..1b3520754 --- /dev/null +++ b/v3/examples/file-association/build/Info.plist @@ -0,0 +1,27 @@ + + + + CFBundlePackageType + APPL + CFBundleName + My Product + CFBundleExecutable + fileassoc + CFBundleIdentifier + + CFBundleVersion + 0.1.0 + CFBundleGetInfoString + This is a comment + CFBundleShortVersionString + 0.1.0 + CFBundleIconFile + icons + LSMinimumSystemVersion + 10.13.0 + NSHighResolutionCapable + true + NSHumanReadableCopyright + © now, My Company + + \ No newline at end of file diff --git a/v3/examples/file-association/build/Taskfile.common.yml b/v3/examples/file-association/build/Taskfile.common.yml new file mode 100644 index 000000000..540c8a991 --- /dev/null +++ b/v3/examples/file-association/build/Taskfile.common.yml @@ -0,0 +1,76 @@ +version: '3' + +tasks: + go:mod:tidy: + summary: Runs `go mod tidy` + internal: true + generates: + - go.sum + sources: + - go.mod + cmds: + - go mod tidy + + install:frontend:deps: + summary: Install frontend dependencies + dir: frontend + sources: + - package.json + - package-lock.json + generates: + - node_modules/* + preconditions: + - sh: npm version + msg: "Looks like npm isn't installed. Npm is part of the Node installer: https://nodejs.org/en/download/" + cmds: + - npm install + + build:frontend: + summary: Build the frontend project + dir: frontend + sources: + - "**/*" + - exclude: node_modules/**/* + generates: + - dist/* + deps: + - task: install:frontend:deps + - task: generate:bindings + cmds: + - npm run build -q + + generate:bindings: + summary: Generates bindings for the frontend + sources: + - "**/*.go" + - go.mod + - go.sum + generates: + - "frontend/bindings/**/*" + cmds: + - wails3 generate bindings -f '{{.BUILD_FLAGS}}' -clean=true {{if .UseTypescript}} -ts{{end}} + + generate:icons: + summary: Generates Windows `.ico` and Mac `.icns` files from an image + dir: build + sources: + - "appicon.png" + generates: + - "icons.icns" + - "icon.ico" + cmds: + - wails3 generate icons -input appicon.png + + dev:frontend: + summary: Runs the frontend in development mode + dir: frontend + deps: + - task: install:frontend:deps + cmds: + - npm run dev -- --port {{.VITE_PORT}} --strictPort + + update:build-assets: + summary: Updates the build assets + dir: build + cmds: + - wails3 update build-assets -name "{{.APP_NAME}}" -binaryname "{{.APP_NAME}}" -config config.yml -dir . \ No newline at end of file diff --git a/v3/examples/file-association/build/Taskfile.darwin.yml b/v3/examples/file-association/build/Taskfile.darwin.yml new file mode 100644 index 000000000..45db6d067 --- /dev/null +++ b/v3/examples/file-association/build/Taskfile.darwin.yml @@ -0,0 +1,45 @@ +version: '3' + +includes: + common: Taskfile.common.yml + +tasks: + build: + summary: Creates a production build of the application + deps: + - task: common:go:mod:tidy + - task: common:build:frontend + - task: common:generate:icons + cmds: + - go build {{.BUILD_FLAGS}} -o {{.BIN_DIR}}/{{.APP_NAME}} + vars: + BUILD_FLAGS: '{{if eq .PRODUCTION "true"}}-tags production -trimpath -ldflags="-w -s"{{else}}-gcflags=all="-l"{{end}}' + env: + GOOS: darwin + CGO_ENABLED: 1 + GOARCH: '{{.ARCH | default ARCH}}' + CGO_CFLAGS: "-mmacosx-version-min=10.15" + CGO_LDFLAGS: "-mmacosx-version-min=10.15" + MACOSX_DEPLOYMENT_TARGET: "10.15" + PRODUCTION: '{{.PRODUCTION | default "false"}}' + + package: + summary: Packages a production build of the application into a `.app` bundle + deps: + - task: build + vars: + PRODUCTION: "true" + cmds: + - task: create:app:bundle + + create:app:bundle: + summary: Creates an `.app` bundle + cmds: + - mkdir -p {{.BIN_DIR}}/{{.APP_NAME}}.app/Contents/{MacOS,Resources} + - cp build/icons.icns {{.BIN_DIR}}/{{.APP_NAME}}.app/Contents/Resources + - cp {{.BIN_DIR}}/{{.APP_NAME}} {{.BIN_DIR}}/{{.APP_NAME}}.app/Contents/MacOS + - cp build/Info.plist {{.BIN_DIR}}/{{.APP_NAME}}.app/Contents + + run: + cmds: + - '{{.BIN_DIR}}/{{.APP_NAME}}' diff --git a/v3/examples/file-association/build/Taskfile.linux.yml b/v3/examples/file-association/build/Taskfile.linux.yml new file mode 100644 index 000000000..814ee0ae1 --- /dev/null +++ b/v3/examples/file-association/build/Taskfile.linux.yml @@ -0,0 +1,66 @@ +version: '3' + +includes: + common: Taskfile.common.yml + +tasks: + build: + summary: Builds the application for Linux + deps: + - task: common:go:mod:tidy + - task: common:build:frontend + - task: common:generate:icons + cmds: + - go build {{.BUILD_FLAGS}} -o {{.BIN_DIR}}/{{.APP_NAME}} + vars: + BUILD_FLAGS: '{{if eq .PRODUCTION "true"}}-tags production -trimpath -ldflags="-w -s"{{else}}-gcflags=all="-l"{{end}}' + env: + GOOS: linux + CGO_ENABLED: 1 + GOARCH: '{{.ARCH | default ARCH}}' + PRODUCTION: '{{.PRODUCTION | default "false"}}' + + package: + summary: Packages a production build of the application for Linux + deps: + - task: build + vars: + PRODUCTION: "true" + cmds: + - task: create:appimage + + create:appimage: + summary: Creates an AppImage + dir: build/appimage + deps: + - task: build + vars: + PRODUCTION: "true" + - task: generate:dotdesktop + cmds: + - cp {{.APP_BINARY}} {{.APP_NAME}} + - cp ../appicon.png appicon.png + - wails3 generate appimage -binary {{.APP_NAME}} -icon {{.ICON}} -desktopfile {{.DESKTOP_FILE}} -outputdir {{.OUTPUT_DIR}} -builddir {{.ROOT_DIR}}/build/appimage + vars: + APP_NAME: '{{.APP_NAME}}' + APP_BINARY: '../../bin/{{.APP_NAME}}' + ICON: '../appicon.png' + DESKTOP_FILE: '{{.APP_NAME}}.desktop' + OUTPUT_DIR: '../../bin' + + generate:dotdesktop: + summary: Generates a `.desktop` file + dir: build + cmds: + - mkdir -p {{.ROOT_DIR}}/build/appimage + - wails3 generate .desktop -name "{{.APP_NAME}}" -exec "{{.EXEC}}" -icon "{{.ICON}}" -outputfile {{.ROOT_DIR}}/build/appimage/{{.APP_NAME}}.desktop -categories "{{.CATEGORIES}}" + vars: + APP_NAME: '{{.APP_NAME}}' + EXEC: '{{.APP_NAME}}' + ICON: 'appicon' + CATEGORIES: 'Development;' + OUTPUTFILE: '{{.ROOT_DIR}}/build/appimage/{{.APP_NAME}}.desktop' + + run: + cmds: + - '{{.BIN_DIR}}/{{.APP_NAME}}' diff --git a/v3/examples/file-association/build/Taskfile.windows.yml b/v3/examples/file-association/build/Taskfile.windows.yml new file mode 100644 index 000000000..f141fcd2f --- /dev/null +++ b/v3/examples/file-association/build/Taskfile.windows.yml @@ -0,0 +1,53 @@ +version: '3' + +includes: + common: Taskfile.common.yml + +tasks: + build: + summary: Builds the application for Windows + deps: + - task: common:go:mod:tidy + - task: common:build:frontend + - task: common:generate:icons + - task: generate:syso + cmds: + - go build {{.BUILD_FLAGS}} -o {{.BIN_DIR}}/{{.APP_NAME}}.exe + - powershell Remove-item *.syso + vars: + BUILD_FLAGS: '{{if eq .PRODUCTION "true"}}-tags production -trimpath -ldflags="-w -s -H windowsgui"{{else}}-gcflags=all="-l"{{end}}' + env: + GOOS: windows + CGO_ENABLED: 0 + GOARCH: '{{.ARCH | default ARCH}}' + PRODUCTION: '{{.PRODUCTION | default "false"}}' + + package: + summary: Packages a production build of the application into a `.exe` bundle + cmds: + - task: create:nsis:installer + + generate:syso: + summary: Generates Windows `.syso` file + dir: build + cmds: + - wails3 generate syso -arch {{.ARCH}} -icon icon.ico -manifest wails.exe.manifest -info info.json + vars: + ARCH: '{{.ARCH | default ARCH}}' + + create:nsis:installer: + summary: Creates an NSIS installer + dir: build/nsis + deps: + - task: build + vars: + PRODUCTION: "true" + cmds: + - makensis -DARG_WAILS_{{.ARG_FLAG}}_BINARY="{{.ROOT_DIR}}\{{.BIN_DIR}}\{{.APP_NAME}}.exe" project.nsi + vars: + ARCH: '{{.ARCH | default ARCH}}' + ARG_FLAG: '{{if eq .ARCH "amd64"}}AMD64{{else}}ARM64{{end}}' + + run: + cmds: + - '{{.BIN_DIR}}\\{{.APP_NAME}}.exe' \ No newline at end of file diff --git a/v3/examples/file-association/build/appicon.png b/v3/examples/file-association/build/appicon.png new file mode 100644 index 000000000..63617fe4f Binary files /dev/null and b/v3/examples/file-association/build/appicon.png differ diff --git a/v3/examples/file-association/build/appimage/build.sh b/v3/examples/file-association/build/appimage/build.sh new file mode 100644 index 000000000..fcba535e5 --- /dev/null +++ b/v3/examples/file-association/build/appimage/build.sh @@ -0,0 +1,26 @@ +#!/usr/bin/env bash +# Copyright (c) 2018-Present Lea Anthony +# SPDX-License-Identifier: MIT + +# Fail script on any error +set -euxo pipefail + +# Define variables +APP_DIR="${APP_NAME}.AppDir" + +# Create AppDir structure +mkdir -p "${APP_DIR}/usr/bin" +cp -r "${APP_BINARY}" "${APP_DIR}/usr/bin/" +cp "${ICON_PATH}" "${APP_DIR}/" +cp "${DESKTOP_FILE}" "${APP_DIR}/" + +# Download linuxdeploy and make it executable +wget -q -4 -N https://github.com/linuxdeploy/linuxdeploy/releases/download/continuous/linuxdeploy-x86_64.AppImage +chmod +x linuxdeploy-x86_64.AppImage + +# Run linuxdeploy to bundle the application +./linuxdeploy-x86_64.AppImage --appdir "${APP_DIR}" --output appimage + +# Rename the generated AppImage +mv "${APP_NAME}*.AppImage" "${APP_NAME}.AppImage" + diff --git a/v3/examples/file-association/build/config.yml b/v3/examples/file-association/build/config.yml new file mode 100644 index 000000000..0786788ae --- /dev/null +++ b/v3/examples/file-association/build/config.yml @@ -0,0 +1,32 @@ +# This file contains the configuration for this project. +# When you update `info` or `fileAssociations`, run `wails3 task common:update:build-assets` to update the assets. +# Note that this will overwrite any changes you have made to the assets. +version: '3' + +# This information is used to generate the build assets. +info: + companyName: "My Company" # The name of the company + productName: "My Product" # The name of the application + productIdentifier: "com.mycompany.myproduct" # The unique product identifier + description: "A program that does X" # The application description + copyright: "(c) 2025, My Company" # Copyright text + comments: "Some Product Comments" # Comments + version: "v0.0.1" # The application version + +# File Associations +# More information at: https://v3.wails.io/noit/done/yet +fileAssociations: + - ext: wails + name: Wails + description: Wails Application File + iconName: icon + role: Editor +# - ext: jpg +# name: JPEG +# description: Image File +# iconName: jpegFileIcon +# role: Editor + +# Other data +other: + - name: My Other Data \ No newline at end of file diff --git a/v3/examples/file-association/build/devmode.config.yaml b/v3/examples/file-association/build/devmode.config.yaml new file mode 100644 index 000000000..7d674a261 --- /dev/null +++ b/v3/examples/file-association/build/devmode.config.yaml @@ -0,0 +1,28 @@ +config: + root_path: . + log_level: warn + debounce: 1000 + ignore: + dir: + - .git + - node_modules + - frontend + - bin + file: + - .DS_Store + - .gitignore + - .gitkeep + watched_extension: + - "*.go" + git_ignore: true + executes: + - cmd: wails3 task common:install:frontend:deps + type: once + - cmd: wails3 task common:dev:frontend + type: background + - cmd: go mod tidy + type: blocking + - cmd: wails3 task build + type: blocking + - cmd: wails3 task run + type: primary diff --git a/v3/examples/file-association/build/icon.ico b/v3/examples/file-association/build/icon.ico new file mode 100644 index 000000000..bfa0690b7 Binary files /dev/null and b/v3/examples/file-association/build/icon.ico differ diff --git a/v3/examples/file-association/build/icons.icns b/v3/examples/file-association/build/icons.icns new file mode 100644 index 000000000..1b5bd4c86 Binary files /dev/null and b/v3/examples/file-association/build/icons.icns differ diff --git a/v3/examples/file-association/build/info.json b/v3/examples/file-association/build/info.json new file mode 100644 index 000000000..850b2b5b0 --- /dev/null +++ b/v3/examples/file-association/build/info.json @@ -0,0 +1,15 @@ +{ + "fixed": { + "file_version": "0.1.0" + }, + "info": { + "0000": { + "ProductVersion": "0.1.0", + "CompanyName": "My Company", + "FileDescription": "My Product Description", + "LegalCopyright": "© now, My Company", + "ProductName": "My Product", + "Comments": "This is a comment" + } + } +} \ No newline at end of file diff --git a/v3/examples/file-association/build/nsis/project.nsi b/v3/examples/file-association/build/nsis/project.nsi new file mode 100644 index 000000000..11ebc1ec7 --- /dev/null +++ b/v3/examples/file-association/build/nsis/project.nsi @@ -0,0 +1,112 @@ +Unicode true + +#### +## Please note: Template replacements don't work in this file. They are provided with default defines like +## mentioned underneath. +## If the keyword is not defined, "wails_tools.nsh" will populate them. +## If they are defined here, "wails_tools.nsh" will not touch them. This allows you to use this project.nsi manually +## from outside of Wails for debugging and development of the installer. +## +## For development first make a wails nsis build to populate the "wails_tools.nsh": +## > wails build --target windows/amd64 --nsis +## Then you can call makensis on this file with specifying the path to your binary: +## For a AMD64 only installer: +## > makensis -DARG_WAILS_AMD64_BINARY=..\..\bin\app.exe +## For a ARM64 only installer: +## > makensis -DARG_WAILS_ARM64_BINARY=..\..\bin\app.exe +## For a installer with both architectures: +## > makensis -DARG_WAILS_AMD64_BINARY=..\..\bin\app-amd64.exe -DARG_WAILS_ARM64_BINARY=..\..\bin\app-arm64.exe +#### +## The following information is taken from the wails_tools.nsh file, but they can be overwritten here. +#### +## !define INFO_PROJECTNAME "my-project" # Default "fileassoc" +## !define INFO_COMPANYNAME "My Company" # Default "My Company" +## !define INFO_PRODUCTNAME "My Product Name" # Default "My Product" +## !define INFO_PRODUCTVERSION "1.0.0" # Default "0.1.0" +## !define INFO_COPYRIGHT "(c) Now, My Company" # Default "© now, My Company" +### +## !define PRODUCT_EXECUTABLE "Application.exe" # Default "${INFO_PROJECTNAME}.exe" +## !define UNINST_KEY_NAME "UninstKeyInRegistry" # Default "${INFO_COMPANYNAME}${INFO_PRODUCTNAME}" +#### +## !define REQUEST_EXECUTION_LEVEL "admin" # Default "admin" see also https://nsis.sourceforge.io/Docs/Chapter4.html +#### +## Include the wails tools +#### +!include "wails_tools.nsh" + +# The version information for this two must consist of 4 parts +VIProductVersion "${INFO_PRODUCTVERSION}.0" +VIFileVersion "${INFO_PRODUCTVERSION}.0" + +VIAddVersionKey "CompanyName" "${INFO_COMPANYNAME}" +VIAddVersionKey "FileDescription" "${INFO_PRODUCTNAME} Installer" +VIAddVersionKey "ProductVersion" "${INFO_PRODUCTVERSION}" +VIAddVersionKey "FileVersion" "${INFO_PRODUCTVERSION}" +VIAddVersionKey "LegalCopyright" "${INFO_COPYRIGHT}" +VIAddVersionKey "ProductName" "${INFO_PRODUCTNAME}" + +# Enable HiDPI support. https://nsis.sourceforge.io/Reference/ManifestDPIAware +ManifestDPIAware true + +!include "MUI.nsh" + +!define MUI_ICON "..\icon.ico" +!define MUI_UNICON "..\icon.ico" +# !define MUI_WELCOMEFINISHPAGE_BITMAP "resources\leftimage.bmp" #Include this to add a bitmap on the left side of the Welcome Page. Must be a size of 164x314 +!define MUI_FINISHPAGE_NOAUTOCLOSE # Wait on the INSTFILES page so the user can take a look into the details of the installation steps +!define MUI_ABORTWARNING # This will warn the user if they exit from the installer. + +!insertmacro MUI_PAGE_WELCOME # Welcome to the installer page. +# !insertmacro MUI_PAGE_LICENSE "resources\eula.txt" # Adds a EULA page to the installer +!insertmacro MUI_PAGE_DIRECTORY # In which folder install page. +!insertmacro MUI_PAGE_INSTFILES # Installing page. +!insertmacro MUI_PAGE_FINISH # Finished installation page. + +!insertmacro MUI_UNPAGE_INSTFILES # Uninstalling page + +!insertmacro MUI_LANGUAGE "English" # Set the Language of the installer + +## The following two statements can be used to sign the installer and the uninstaller. The path to the binaries are provided in %1 +#!uninstfinalize 'signtool --file "%1"' +#!finalize 'signtool --file "%1"' + +Name "${INFO_PRODUCTNAME}" +OutFile "..\..\bin\${INFO_PROJECTNAME}-${ARCH}-installer.exe" # Name of the installer's file. +InstallDir "$PROGRAMFILES64\${INFO_COMPANYNAME}\${INFO_PRODUCTNAME}" # Default installing folder ($PROGRAMFILES is Program Files folder). +ShowInstDetails show # This will always show the installation details. + +Function .onInit + !insertmacro wails.checkArchitecture +FunctionEnd + +Section + !insertmacro wails.setShellContext + + !insertmacro wails.webview2runtime + + SetOutPath $INSTDIR + + !insertmacro wails.files + + CreateShortcut "$SMPROGRAMS\${INFO_PRODUCTNAME}.lnk" "$INSTDIR\${PRODUCT_EXECUTABLE}" + CreateShortCut "$DESKTOP\${INFO_PRODUCTNAME}.lnk" "$INSTDIR\${PRODUCT_EXECUTABLE}" + + !insertmacro wails.associateFiles + + !insertmacro wails.writeUninstaller +SectionEnd + +Section "uninstall" + !insertmacro wails.setShellContext + + RMDir /r "$AppData\${PRODUCT_EXECUTABLE}" # Remove the WebView2 DataPath + + RMDir /r $INSTDIR + + Delete "$SMPROGRAMS\${INFO_PRODUCTNAME}.lnk" + Delete "$DESKTOP\${INFO_PRODUCTNAME}.lnk" + + !insertmacro wails.unassociateFiles + + !insertmacro wails.deleteUninstaller +SectionEnd diff --git a/v3/examples/file-association/build/nsis/wails_tools.nsh b/v3/examples/file-association/build/nsis/wails_tools.nsh new file mode 100644 index 000000000..d49f6c803 --- /dev/null +++ b/v3/examples/file-association/build/nsis/wails_tools.nsh @@ -0,0 +1,218 @@ +# DO NOT EDIT - Generated automatically by `wails build` + +!include "x64.nsh" +!include "WinVer.nsh" +!include "FileFunc.nsh" + +!ifndef INFO_PROJECTNAME + !define INFO_PROJECTNAME "fileassoc" +!endif +!ifndef INFO_COMPANYNAME + !define INFO_COMPANYNAME "My Company" +!endif +!ifndef INFO_PRODUCTNAME + !define INFO_PRODUCTNAME "My Product" +!endif +!ifndef INFO_PRODUCTVERSION + !define INFO_PRODUCTVERSION "0.1.0" +!endif +!ifndef INFO_COPYRIGHT + !define INFO_COPYRIGHT "© now, My Company" +!endif +!ifndef PRODUCT_EXECUTABLE + !define PRODUCT_EXECUTABLE "${INFO_PROJECTNAME}.exe" +!endif +!ifndef UNINST_KEY_NAME + !define UNINST_KEY_NAME "${INFO_COMPANYNAME}${INFO_PRODUCTNAME}" +!endif +!define UNINST_KEY "Software\Microsoft\Windows\CurrentVersion\Uninstall\${UNINST_KEY_NAME}" + +!ifndef REQUEST_EXECUTION_LEVEL + !define REQUEST_EXECUTION_LEVEL "admin" +!endif + +RequestExecutionLevel "${REQUEST_EXECUTION_LEVEL}" + +!ifdef ARG_WAILS_AMD64_BINARY + !define SUPPORTS_AMD64 +!endif + +!ifdef ARG_WAILS_ARM64_BINARY + !define SUPPORTS_ARM64 +!endif + +!ifdef SUPPORTS_AMD64 + !ifdef SUPPORTS_ARM64 + !define ARCH "amd64_arm64" + !else + !define ARCH "amd64" + !endif +!else + !ifdef SUPPORTS_ARM64 + !define ARCH "arm64" + !else + !error "Wails: Undefined ARCH, please provide at least one of ARG_WAILS_AMD64_BINARY or ARG_WAILS_ARM64_BINARY" + !endif +!endif + +!macro wails.checkArchitecture + !ifndef WAILS_WIN10_REQUIRED + !define WAILS_WIN10_REQUIRED "This product is only supported on Windows 10 (Server 2016) and later." + !endif + + !ifndef WAILS_ARCHITECTURE_NOT_SUPPORTED + !define WAILS_ARCHITECTURE_NOT_SUPPORTED "This product can't be installed on the current Windows architecture. Supports: ${ARCH}" + !endif + + ${If} ${AtLeastWin10} + !ifdef SUPPORTS_AMD64 + ${if} ${IsNativeAMD64} + Goto ok + ${EndIf} + !endif + + !ifdef SUPPORTS_ARM64 + ${if} ${IsNativeARM64} + Goto ok + ${EndIf} + !endif + + IfSilent silentArch notSilentArch + silentArch: + SetErrorLevel 65 + Abort + notSilentArch: + MessageBox MB_OK "${WAILS_ARCHITECTURE_NOT_SUPPORTED}" + Quit + ${else} + IfSilent silentWin notSilentWin + silentWin: + SetErrorLevel 64 + Abort + notSilentWin: + MessageBox MB_OK "${WAILS_WIN10_REQUIRED}" + Quit + ${EndIf} + + ok: +!macroend + +!macro wails.files + !ifdef SUPPORTS_AMD64 + ${if} ${IsNativeAMD64} + File "/oname=${PRODUCT_EXECUTABLE}" "${ARG_WAILS_AMD64_BINARY}" + ${EndIf} + !endif + + !ifdef SUPPORTS_ARM64 + ${if} ${IsNativeARM64} + File "/oname=${PRODUCT_EXECUTABLE}" "${ARG_WAILS_ARM64_BINARY}" + ${EndIf} + !endif +!macroend + +!macro wails.writeUninstaller + WriteUninstaller "$INSTDIR\uninstall.exe" + + SetRegView 64 + WriteRegStr HKLM "${UNINST_KEY}" "Publisher" "${INFO_COMPANYNAME}" + WriteRegStr HKLM "${UNINST_KEY}" "DisplayName" "${INFO_PRODUCTNAME}" + WriteRegStr HKLM "${UNINST_KEY}" "DisplayVersion" "${INFO_PRODUCTVERSION}" + WriteRegStr HKLM "${UNINST_KEY}" "DisplayIcon" "$INSTDIR\${PRODUCT_EXECUTABLE}" + WriteRegStr HKLM "${UNINST_KEY}" "UninstallString" "$\"$INSTDIR\uninstall.exe$\"" + WriteRegStr HKLM "${UNINST_KEY}" "QuietUninstallString" "$\"$INSTDIR\uninstall.exe$\" /S" + + ${GetSize} "$INSTDIR" "/S=0K" $0 $1 $2 + IntFmt $0 "0x%08X" $0 + WriteRegDWORD HKLM "${UNINST_KEY}" "EstimatedSize" "$0" +!macroend + +!macro wails.deleteUninstaller + Delete "$INSTDIR\uninstall.exe" + + SetRegView 64 + DeleteRegKey HKLM "${UNINST_KEY}" +!macroend + +!macro wails.setShellContext + ${If} ${REQUEST_EXECUTION_LEVEL} == "admin" + SetShellVarContext all + ${else} + SetShellVarContext current + ${EndIf} +!macroend + +# Install webview2 by launching the bootstrapper +# See https://docs.microsoft.com/en-us/microsoft-edge/webview2/concepts/distribution#online-only-deployment +!macro wails.webview2runtime + !ifndef WAILS_INSTALL_WEBVIEW_DETAILPRINT + !define WAILS_INSTALL_WEBVIEW_DETAILPRINT "Installing: WebView2 Runtime" + !endif + + SetRegView 64 + # If the admin key exists and is not empty then webview2 is already installed + ReadRegStr $0 HKLM "SOFTWARE\WOW6432Node\Microsoft\EdgeUpdate\Clients\{F3017226-FE2A-4295-8BDF-00C3A9A7E4C5}" "pv" + ${If} $0 != "" + Goto ok + ${EndIf} + + ${If} ${REQUEST_EXECUTION_LEVEL} == "user" + # If the installer is run in user level, check the user specific key exists and is not empty then webview2 is already installed + ReadRegStr $0 HKCU "Software\Microsoft\EdgeUpdate\Clients{F3017226-FE2A-4295-8BDF-00C3A9A7E4C5}" "pv" + ${If} $0 != "" + Goto ok + ${EndIf} + ${EndIf} + + SetDetailsPrint both + DetailPrint "${WAILS_INSTALL_WEBVIEW_DETAILPRINT}" + SetDetailsPrint listonly + + InitPluginsDir + CreateDirectory "$pluginsdir\webview2bootstrapper" + SetOutPath "$pluginsdir\webview2bootstrapper" + File "MicrosoftEdgeWebview2Setup.exe" + ExecWait '"$pluginsdir\webview2bootstrapper\MicrosoftEdgeWebview2Setup.exe" /silent /install' + + SetDetailsPrint both + ok: +!macroend + +# Copy of APP_ASSOCIATE and APP_UNASSOCIATE macros from here https://gist.github.com/nikku/281d0ef126dbc215dd58bfd5b3a5cd5b +!macro APP_ASSOCIATE EXT FILECLASS DESCRIPTION ICON COMMANDTEXT COMMAND + ; Backup the previously associated file class + ReadRegStr $R0 SHELL_CONTEXT "Software\Classes\.${EXT}" "" + WriteRegStr SHELL_CONTEXT "Software\Classes\.${EXT}" "${FILECLASS}_backup" "$R0" + + WriteRegStr SHELL_CONTEXT "Software\Classes\.${EXT}" "" "${FILECLASS}" + + WriteRegStr SHELL_CONTEXT "Software\Classes\${FILECLASS}" "" `${DESCRIPTION}` + WriteRegStr SHELL_CONTEXT "Software\Classes\${FILECLASS}\DefaultIcon" "" `${ICON}` + WriteRegStr SHELL_CONTEXT "Software\Classes\${FILECLASS}\shell" "" "open" + WriteRegStr SHELL_CONTEXT "Software\Classes\${FILECLASS}\shell\open" "" `${COMMANDTEXT}` + WriteRegStr SHELL_CONTEXT "Software\Classes\${FILECLASS}\shell\open\command" "" `${COMMAND}` +!macroend + +!macro APP_UNASSOCIATE EXT FILECLASS + ; Backup the previously associated file class + ReadRegStr $R0 SHELL_CONTEXT "Software\Classes\.${EXT}" `${FILECLASS}_backup` + WriteRegStr SHELL_CONTEXT "Software\Classes\.${EXT}" "" "$R0" + + DeleteRegKey SHELL_CONTEXT `Software\Classes\${FILECLASS}` +!macroend + +!macro wails.associateFiles + ; Create file associations + + !insertmacro APP_ASSOCIATE "wails" "Wails" "Wails Application File" "$INSTDIR\icon.ico" "Open with ${INFO_PRODUCTNAME}" "$INSTDIR\${PRODUCT_EXECUTABLE} $\"%1$\"" + File "..\icon.ico" + +!macroend + +!macro wails.unassociateFiles + ; Delete app associations + + !insertmacro APP_UNASSOCIATE "wails" "Wails" + Delete "$INSTDIR\icon.ico" + +!macroend \ No newline at end of file diff --git a/v3/examples/file-association/build/wails.exe.manifest b/v3/examples/file-association/build/wails.exe.manifest new file mode 100644 index 000000000..03a121e40 --- /dev/null +++ b/v3/examples/file-association/build/wails.exe.manifest @@ -0,0 +1,15 @@ + + + + + + + + + + + true/pm + permonitorv2,permonitor + + + \ No newline at end of file diff --git a/v3/examples/file-association/frontend/bindings/changeme/greetservice.js b/v3/examples/file-association/frontend/bindings/changeme/greetservice.js new file mode 100644 index 000000000..860020abd --- /dev/null +++ b/v3/examples/file-association/frontend/bindings/changeme/greetservice.js @@ -0,0 +1,16 @@ +// @ts-check +// Cynhyrchwyd y ffeil hon yn awtomatig. PEIDIWCH Â MODIWL +// This file is automatically generated. DO NOT EDIT + +// eslint-disable-next-line @typescript-eslint/ban-ts-comment +// @ts-ignore: Unused imports +import {Call as $Call, Create as $Create} from "@wailsio/runtime"; + +/** + * @param {string} name + * @returns {Promise & { cancel(): void }} + */ +export function Greet(name) { + let $resultPromise = /** @type {any} */($Call.ByID(1411160069, name)); + return $resultPromise; +} diff --git a/v3/examples/file-association/frontend/bindings/changeme/index.js b/v3/examples/file-association/frontend/bindings/changeme/index.js new file mode 100644 index 000000000..fdf1ff435 --- /dev/null +++ b/v3/examples/file-association/frontend/bindings/changeme/index.js @@ -0,0 +1,8 @@ +// @ts-check +// Cynhyrchwyd y ffeil hon yn awtomatig. PEIDIWCH Â MODIWL +// This file is automatically generated. DO NOT EDIT + +import * as GreetService from "./greetservice.js"; +export { + GreetService +}; diff --git a/v3/examples/file-association/frontend/index.html b/v3/examples/file-association/frontend/index.html new file mode 100644 index 000000000..b81d9729f --- /dev/null +++ b/v3/examples/file-association/frontend/index.html @@ -0,0 +1,35 @@ + + + + + + + + Wails App + + +
            + +

            Wails + Javascript

            +
            +
            Please enter your name below 👇
            +
            + + +
            +
            + +
            + + + diff --git a/v3/examples/file-association/frontend/main.js b/v3/examples/file-association/frontend/main.js new file mode 100644 index 000000000..c24b3b1ef --- /dev/null +++ b/v3/examples/file-association/frontend/main.js @@ -0,0 +1,21 @@ +import {GreetService} from "./bindings/changeme"; +import {Events} from "@wailsio/runtime"; + +const resultElement = document.getElementById('result'); +const timeElement = document.getElementById('time'); + +window.doGreet = () => { + let name = document.getElementById('name').value; + if (!name) { + name = 'anonymous'; + } + GreetService.Greet(name).then((result) => { + resultElement.innerText = result; + }).catch((err) => { + console.log(err); + }); +} + +Events.On('time', (time) => { + timeElement.innerText = time.data; +}); diff --git a/v3/examples/file-association/frontend/package-lock.json b/v3/examples/file-association/frontend/package-lock.json new file mode 100644 index 000000000..9ba47fffa --- /dev/null +++ b/v3/examples/file-association/frontend/package-lock.json @@ -0,0 +1,860 @@ +{ + "name": "frontend", + "version": "0.0.0", + "lockfileVersion": 3, + "requires": true, + "packages": { + "": { + "name": "frontend", + "version": "0.0.0", + "devDependencies": { + "@wailsio/runtime": "latest", + "vite": "^5.0.0" + } + }, + "node_modules/@esbuild/aix-ppc64": { + "version": "0.21.5", + "resolved": "https://registry.npmjs.org/@esbuild/aix-ppc64/-/aix-ppc64-0.21.5.tgz", + "integrity": "sha512-1SDgH6ZSPTlggy1yI6+Dbkiz8xzpHJEVAlF/AM1tHPLsf5STom9rwtjE4hKAF20FfXXNTFqEYXyJNWh1GiZedQ==", + "cpu": [ + "ppc64" + ], + "dev": true, + "optional": true, + "os": [ + "aix" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/@esbuild/android-arm": { + "version": "0.21.5", + "resolved": "https://registry.npmjs.org/@esbuild/android-arm/-/android-arm-0.21.5.tgz", + "integrity": "sha512-vCPvzSjpPHEi1siZdlvAlsPxXl7WbOVUBBAowWug4rJHb68Ox8KualB+1ocNvT5fjv6wpkX6o/iEpbDrf68zcg==", + "cpu": [ + "arm" + ], + "dev": true, + "optional": true, + "os": [ + "android" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/@esbuild/android-arm64": { + "version": "0.21.5", + "resolved": "https://registry.npmjs.org/@esbuild/android-arm64/-/android-arm64-0.21.5.tgz", + "integrity": "sha512-c0uX9VAUBQ7dTDCjq+wdyGLowMdtR/GoC2U5IYk/7D1H1JYC0qseD7+11iMP2mRLN9RcCMRcjC4YMclCzGwS/A==", + "cpu": [ + "arm64" + ], + "dev": true, + "optional": true, + "os": [ + "android" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/@esbuild/android-x64": { + "version": "0.21.5", + "resolved": "https://registry.npmjs.org/@esbuild/android-x64/-/android-x64-0.21.5.tgz", + "integrity": "sha512-D7aPRUUNHRBwHxzxRvp856rjUHRFW1SdQATKXH2hqA0kAZb1hKmi02OpYRacl0TxIGz/ZmXWlbZgjwWYaCakTA==", + "cpu": [ + "x64" + ], + "dev": true, + "optional": true, + "os": [ + "android" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/@esbuild/darwin-arm64": { + "version": "0.21.5", + "resolved": "https://registry.npmjs.org/@esbuild/darwin-arm64/-/darwin-arm64-0.21.5.tgz", + "integrity": "sha512-DwqXqZyuk5AiWWf3UfLiRDJ5EDd49zg6O9wclZ7kUMv2WRFr4HKjXp/5t8JZ11QbQfUS6/cRCKGwYhtNAY88kQ==", + "cpu": [ + "arm64" + ], + "dev": true, + "optional": true, + "os": [ + "darwin" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/@esbuild/darwin-x64": { + "version": "0.21.5", + "resolved": "https://registry.npmjs.org/@esbuild/darwin-x64/-/darwin-x64-0.21.5.tgz", + "integrity": "sha512-se/JjF8NlmKVG4kNIuyWMV/22ZaerB+qaSi5MdrXtd6R08kvs2qCN4C09miupktDitvh8jRFflwGFBQcxZRjbw==", + "cpu": [ + "x64" + ], + "dev": true, + "optional": true, + "os": [ + "darwin" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/@esbuild/freebsd-arm64": { + "version": "0.21.5", + "resolved": "https://registry.npmjs.org/@esbuild/freebsd-arm64/-/freebsd-arm64-0.21.5.tgz", + "integrity": "sha512-5JcRxxRDUJLX8JXp/wcBCy3pENnCgBR9bN6JsY4OmhfUtIHe3ZW0mawA7+RDAcMLrMIZaf03NlQiX9DGyB8h4g==", + "cpu": [ + "arm64" + ], + "dev": true, + "optional": true, + "os": [ + "freebsd" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/@esbuild/freebsd-x64": { + "version": "0.21.5", + "resolved": "https://registry.npmjs.org/@esbuild/freebsd-x64/-/freebsd-x64-0.21.5.tgz", + "integrity": "sha512-J95kNBj1zkbMXtHVH29bBriQygMXqoVQOQYA+ISs0/2l3T9/kj42ow2mpqerRBxDJnmkUDCaQT/dfNXWX/ZZCQ==", + "cpu": [ + "x64" + ], + "dev": true, + "optional": true, + "os": [ + "freebsd" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/@esbuild/linux-arm": { + "version": "0.21.5", + "resolved": "https://registry.npmjs.org/@esbuild/linux-arm/-/linux-arm-0.21.5.tgz", + "integrity": "sha512-bPb5AHZtbeNGjCKVZ9UGqGwo8EUu4cLq68E95A53KlxAPRmUyYv2D6F0uUI65XisGOL1hBP5mTronbgo+0bFcA==", + "cpu": [ + "arm" + ], + "dev": true, + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/@esbuild/linux-arm64": { + "version": "0.21.5", + "resolved": "https://registry.npmjs.org/@esbuild/linux-arm64/-/linux-arm64-0.21.5.tgz", + "integrity": "sha512-ibKvmyYzKsBeX8d8I7MH/TMfWDXBF3db4qM6sy+7re0YXya+K1cem3on9XgdT2EQGMu4hQyZhan7TeQ8XkGp4Q==", + "cpu": [ + "arm64" + ], + "dev": true, + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/@esbuild/linux-ia32": { + "version": "0.21.5", + "resolved": "https://registry.npmjs.org/@esbuild/linux-ia32/-/linux-ia32-0.21.5.tgz", + "integrity": "sha512-YvjXDqLRqPDl2dvRODYmmhz4rPeVKYvppfGYKSNGdyZkA01046pLWyRKKI3ax8fbJoK5QbxblURkwK/MWY18Tg==", + "cpu": [ + "ia32" + ], + "dev": true, + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/@esbuild/linux-loong64": { + "version": "0.21.5", + "resolved": "https://registry.npmjs.org/@esbuild/linux-loong64/-/linux-loong64-0.21.5.tgz", + "integrity": "sha512-uHf1BmMG8qEvzdrzAqg2SIG/02+4/DHB6a9Kbya0XDvwDEKCoC8ZRWI5JJvNdUjtciBGFQ5PuBlpEOXQj+JQSg==", + "cpu": [ + "loong64" + ], + "dev": true, + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/@esbuild/linux-mips64el": { + "version": "0.21.5", + "resolved": "https://registry.npmjs.org/@esbuild/linux-mips64el/-/linux-mips64el-0.21.5.tgz", + "integrity": "sha512-IajOmO+KJK23bj52dFSNCMsz1QP1DqM6cwLUv3W1QwyxkyIWecfafnI555fvSGqEKwjMXVLokcV5ygHW5b3Jbg==", + "cpu": [ + "mips64el" + ], + "dev": true, + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/@esbuild/linux-ppc64": { + "version": "0.21.5", + "resolved": "https://registry.npmjs.org/@esbuild/linux-ppc64/-/linux-ppc64-0.21.5.tgz", + "integrity": "sha512-1hHV/Z4OEfMwpLO8rp7CvlhBDnjsC3CttJXIhBi+5Aj5r+MBvy4egg7wCbe//hSsT+RvDAG7s81tAvpL2XAE4w==", + "cpu": [ + "ppc64" + ], + "dev": true, + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/@esbuild/linux-riscv64": { + "version": "0.21.5", + "resolved": "https://registry.npmjs.org/@esbuild/linux-riscv64/-/linux-riscv64-0.21.5.tgz", + "integrity": "sha512-2HdXDMd9GMgTGrPWnJzP2ALSokE/0O5HhTUvWIbD3YdjME8JwvSCnNGBnTThKGEB91OZhzrJ4qIIxk/SBmyDDA==", + "cpu": [ + "riscv64" + ], + "dev": true, + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/@esbuild/linux-s390x": { + "version": "0.21.5", + "resolved": "https://registry.npmjs.org/@esbuild/linux-s390x/-/linux-s390x-0.21.5.tgz", + "integrity": "sha512-zus5sxzqBJD3eXxwvjN1yQkRepANgxE9lgOW2qLnmr8ikMTphkjgXu1HR01K4FJg8h1kEEDAqDcZQtbrRnB41A==", + "cpu": [ + "s390x" + ], + "dev": true, + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/@esbuild/linux-x64": { + "version": "0.21.5", + "resolved": "https://registry.npmjs.org/@esbuild/linux-x64/-/linux-x64-0.21.5.tgz", + "integrity": "sha512-1rYdTpyv03iycF1+BhzrzQJCdOuAOtaqHTWJZCWvijKD2N5Xu0TtVC8/+1faWqcP9iBCWOmjmhoH94dH82BxPQ==", + "cpu": [ + "x64" + ], + "dev": true, + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/@esbuild/netbsd-x64": { + "version": "0.21.5", + "resolved": "https://registry.npmjs.org/@esbuild/netbsd-x64/-/netbsd-x64-0.21.5.tgz", + "integrity": "sha512-Woi2MXzXjMULccIwMnLciyZH4nCIMpWQAs049KEeMvOcNADVxo0UBIQPfSmxB3CWKedngg7sWZdLvLczpe0tLg==", + "cpu": [ + "x64" + ], + "dev": true, + "optional": true, + "os": [ + "netbsd" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/@esbuild/openbsd-x64": { + "version": "0.21.5", + "resolved": "https://registry.npmjs.org/@esbuild/openbsd-x64/-/openbsd-x64-0.21.5.tgz", + "integrity": "sha512-HLNNw99xsvx12lFBUwoT8EVCsSvRNDVxNpjZ7bPn947b8gJPzeHWyNVhFsaerc0n3TsbOINvRP2byTZ5LKezow==", + "cpu": [ + "x64" + ], + "dev": true, + "optional": true, + "os": [ + "openbsd" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/@esbuild/sunos-x64": { + "version": "0.21.5", + "resolved": "https://registry.npmjs.org/@esbuild/sunos-x64/-/sunos-x64-0.21.5.tgz", + "integrity": "sha512-6+gjmFpfy0BHU5Tpptkuh8+uw3mnrvgs+dSPQXQOv3ekbordwnzTVEb4qnIvQcYXq6gzkyTnoZ9dZG+D4garKg==", + "cpu": [ + "x64" + ], + "dev": true, + "optional": true, + "os": [ + "sunos" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/@esbuild/win32-arm64": { + "version": "0.21.5", + "resolved": "https://registry.npmjs.org/@esbuild/win32-arm64/-/win32-arm64-0.21.5.tgz", + "integrity": "sha512-Z0gOTd75VvXqyq7nsl93zwahcTROgqvuAcYDUr+vOv8uHhNSKROyU961kgtCD1e95IqPKSQKH7tBTslnS3tA8A==", + "cpu": [ + "arm64" + ], + "dev": true, + "optional": true, + "os": [ + "win32" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/@esbuild/win32-ia32": { + "version": "0.21.5", + "resolved": "https://registry.npmjs.org/@esbuild/win32-ia32/-/win32-ia32-0.21.5.tgz", + "integrity": "sha512-SWXFF1CL2RVNMaVs+BBClwtfZSvDgtL//G/smwAc5oVK/UPu2Gu9tIaRgFmYFFKrmg3SyAjSrElf0TiJ1v8fYA==", + "cpu": [ + "ia32" + ], + "dev": true, + "optional": true, + "os": [ + "win32" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/@esbuild/win32-x64": { + "version": "0.21.5", + "resolved": "https://registry.npmjs.org/@esbuild/win32-x64/-/win32-x64-0.21.5.tgz", + "integrity": "sha512-tQd/1efJuzPC6rCFwEvLtci/xNFcTZknmXs98FYDfGE4wP9ClFV98nyKrzJKVPMhdDnjzLhdUyMX4PsQAPjwIw==", + "cpu": [ + "x64" + ], + "dev": true, + "optional": true, + "os": [ + "win32" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/@rollup/rollup-android-arm-eabi": { + "version": "4.24.3", + "resolved": "https://registry.npmjs.org/@rollup/rollup-android-arm-eabi/-/rollup-android-arm-eabi-4.24.3.tgz", + "integrity": "sha512-ufb2CH2KfBWPJok95frEZZ82LtDl0A6QKTa8MoM+cWwDZvVGl5/jNb79pIhRvAalUu+7LD91VYR0nwRD799HkQ==", + "cpu": [ + "arm" + ], + "dev": true, + "optional": true, + "os": [ + "android" + ] + }, + "node_modules/@rollup/rollup-android-arm64": { + "version": "4.24.3", + "resolved": "https://registry.npmjs.org/@rollup/rollup-android-arm64/-/rollup-android-arm64-4.24.3.tgz", + "integrity": "sha512-iAHpft/eQk9vkWIV5t22V77d90CRofgR2006UiCjHcHJFVI1E0oBkQIAbz+pLtthFw3hWEmVB4ilxGyBf48i2Q==", + "cpu": [ + "arm64" + ], + "dev": true, + "optional": true, + "os": [ + "android" + ] + }, + "node_modules/@rollup/rollup-darwin-arm64": { + "version": "4.24.3", + "resolved": "https://registry.npmjs.org/@rollup/rollup-darwin-arm64/-/rollup-darwin-arm64-4.24.3.tgz", + "integrity": "sha512-QPW2YmkWLlvqmOa2OwrfqLJqkHm7kJCIMq9kOz40Zo9Ipi40kf9ONG5Sz76zszrmIZZ4hgRIkez69YnTHgEz1w==", + "cpu": [ + "arm64" + ], + "dev": true, + "optional": true, + "os": [ + "darwin" + ] + }, + "node_modules/@rollup/rollup-darwin-x64": { + "version": "4.24.3", + "resolved": "https://registry.npmjs.org/@rollup/rollup-darwin-x64/-/rollup-darwin-x64-4.24.3.tgz", + "integrity": "sha512-KO0pN5x3+uZm1ZXeIfDqwcvnQ9UEGN8JX5ufhmgH5Lz4ujjZMAnxQygZAVGemFWn+ZZC0FQopruV4lqmGMshow==", + "cpu": [ + "x64" + ], + "dev": true, + "optional": true, + "os": [ + "darwin" + ] + }, + "node_modules/@rollup/rollup-freebsd-arm64": { + "version": "4.24.3", + "resolved": "https://registry.npmjs.org/@rollup/rollup-freebsd-arm64/-/rollup-freebsd-arm64-4.24.3.tgz", + "integrity": "sha512-CsC+ZdIiZCZbBI+aRlWpYJMSWvVssPuWqrDy/zi9YfnatKKSLFCe6fjna1grHuo/nVaHG+kiglpRhyBQYRTK4A==", + "cpu": [ + "arm64" + ], + "dev": true, + "optional": true, + "os": [ + "freebsd" + ] + }, + "node_modules/@rollup/rollup-freebsd-x64": { + "version": "4.24.3", + "resolved": "https://registry.npmjs.org/@rollup/rollup-freebsd-x64/-/rollup-freebsd-x64-4.24.3.tgz", + "integrity": "sha512-F0nqiLThcfKvRQhZEzMIXOQG4EeX61im61VYL1jo4eBxv4aZRmpin6crnBJQ/nWnCsjH5F6J3W6Stdm0mBNqBg==", + "cpu": [ + "x64" + ], + "dev": true, + "optional": true, + "os": [ + "freebsd" + ] + }, + "node_modules/@rollup/rollup-linux-arm-gnueabihf": { + "version": "4.24.3", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm-gnueabihf/-/rollup-linux-arm-gnueabihf-4.24.3.tgz", + "integrity": "sha512-KRSFHyE/RdxQ1CSeOIBVIAxStFC/hnBgVcaiCkQaVC+EYDtTe4X7z5tBkFyRoBgUGtB6Xg6t9t2kulnX6wJc6A==", + "cpu": [ + "arm" + ], + "dev": true, + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-arm-musleabihf": { + "version": "4.24.3", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm-musleabihf/-/rollup-linux-arm-musleabihf-4.24.3.tgz", + "integrity": "sha512-h6Q8MT+e05zP5BxEKz0vi0DhthLdrNEnspdLzkoFqGwnmOzakEHSlXfVyA4HJ322QtFy7biUAVFPvIDEDQa6rw==", + "cpu": [ + "arm" + ], + "dev": true, + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-arm64-gnu": { + "version": "4.24.3", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm64-gnu/-/rollup-linux-arm64-gnu-4.24.3.tgz", + "integrity": "sha512-fKElSyXhXIJ9pqiYRqisfirIo2Z5pTTve5K438URf08fsypXrEkVmShkSfM8GJ1aUyvjakT+fn2W7Czlpd/0FQ==", + "cpu": [ + "arm64" + ], + "dev": true, + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-arm64-musl": { + "version": "4.24.3", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm64-musl/-/rollup-linux-arm64-musl-4.24.3.tgz", + "integrity": "sha512-YlddZSUk8G0px9/+V9PVilVDC6ydMz7WquxozToozSnfFK6wa6ne1ATUjUvjin09jp34p84milxlY5ikueoenw==", + "cpu": [ + "arm64" + ], + "dev": true, + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-powerpc64le-gnu": { + "version": "4.24.3", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-powerpc64le-gnu/-/rollup-linux-powerpc64le-gnu-4.24.3.tgz", + "integrity": "sha512-yNaWw+GAO8JjVx3s3cMeG5Esz1cKVzz8PkTJSfYzE5u7A+NvGmbVFEHP+BikTIyYWuz0+DX9kaA3pH9Sqxp69g==", + "cpu": [ + "ppc64" + ], + "dev": true, + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-riscv64-gnu": { + "version": "4.24.3", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-riscv64-gnu/-/rollup-linux-riscv64-gnu-4.24.3.tgz", + "integrity": "sha512-lWKNQfsbpv14ZCtM/HkjCTm4oWTKTfxPmr7iPfp3AHSqyoTz5AgLemYkWLwOBWc+XxBbrU9SCokZP0WlBZM9lA==", + "cpu": [ + "riscv64" + ], + "dev": true, + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-s390x-gnu": { + "version": "4.24.3", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-s390x-gnu/-/rollup-linux-s390x-gnu-4.24.3.tgz", + "integrity": "sha512-HoojGXTC2CgCcq0Woc/dn12wQUlkNyfH0I1ABK4Ni9YXyFQa86Fkt2Q0nqgLfbhkyfQ6003i3qQk9pLh/SpAYw==", + "cpu": [ + "s390x" + ], + "dev": true, + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-x64-gnu": { + "version": "4.24.3", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-x64-gnu/-/rollup-linux-x64-gnu-4.24.3.tgz", + "integrity": "sha512-mnEOh4iE4USSccBOtcrjF5nj+5/zm6NcNhbSEfR3Ot0pxBwvEn5QVUXcuOwwPkapDtGZ6pT02xLoPaNv06w7KQ==", + "cpu": [ + "x64" + ], + "dev": true, + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-x64-musl": { + "version": "4.24.3", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-x64-musl/-/rollup-linux-x64-musl-4.24.3.tgz", + "integrity": "sha512-rMTzawBPimBQkG9NKpNHvquIUTQPzrnPxPbCY1Xt+mFkW7pshvyIS5kYgcf74goxXOQk0CP3EoOC1zcEezKXhw==", + "cpu": [ + "x64" + ], + "dev": true, + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-win32-arm64-msvc": { + "version": "4.24.3", + "resolved": "https://registry.npmjs.org/@rollup/rollup-win32-arm64-msvc/-/rollup-win32-arm64-msvc-4.24.3.tgz", + "integrity": "sha512-2lg1CE305xNvnH3SyiKwPVsTVLCg4TmNCF1z7PSHX2uZY2VbUpdkgAllVoISD7JO7zu+YynpWNSKAtOrX3AiuA==", + "cpu": [ + "arm64" + ], + "dev": true, + "optional": true, + "os": [ + "win32" + ] + }, + "node_modules/@rollup/rollup-win32-ia32-msvc": { + "version": "4.24.3", + "resolved": "https://registry.npmjs.org/@rollup/rollup-win32-ia32-msvc/-/rollup-win32-ia32-msvc-4.24.3.tgz", + "integrity": "sha512-9SjYp1sPyxJsPWuhOCX6F4jUMXGbVVd5obVpoVEi8ClZqo52ViZewA6eFz85y8ezuOA+uJMP5A5zo6Oz4S5rVQ==", + "cpu": [ + "ia32" + ], + "dev": true, + "optional": true, + "os": [ + "win32" + ] + }, + "node_modules/@rollup/rollup-win32-x64-msvc": { + "version": "4.24.3", + "resolved": "https://registry.npmjs.org/@rollup/rollup-win32-x64-msvc/-/rollup-win32-x64-msvc-4.24.3.tgz", + "integrity": "sha512-HGZgRFFYrMrP3TJlq58nR1xy8zHKId25vhmm5S9jETEfDf6xybPxsavFTJaufe2zgOGYJBskGlj49CwtEuFhWQ==", + "cpu": [ + "x64" + ], + "dev": true, + "optional": true, + "os": [ + "win32" + ] + }, + "node_modules/@types/estree": { + "version": "1.0.6", + "resolved": "https://registry.npmjs.org/@types/estree/-/estree-1.0.6.tgz", + "integrity": "sha512-AYnb1nQyY49te+VRAVgmzfcgjYS91mY5P0TKUDCLEM+gNnA+3T6rWITXRLYCpahpqSQbN5cE+gHpnPyXjHWxcw==", + "dev": true + }, + "node_modules/@wailsio/runtime": { + "version": "3.0.0-alpha.28", + "resolved": "https://registry.npmjs.org/@wailsio/runtime/-/runtime-3.0.0-alpha.28.tgz", + "integrity": "sha512-caMnAcKxxDrIWYgCZAMY2kdL++X4ehO2+JvH5na21xfDqz3VnHkEjxsH3jfhgd34M8LY80QEH8iqoMYytDFE/g==", + "dev": true, + "dependencies": { + "nanoid": "^5.0.7" + } + }, + "node_modules/esbuild": { + "version": "0.21.5", + "resolved": "https://registry.npmjs.org/esbuild/-/esbuild-0.21.5.tgz", + "integrity": "sha512-mg3OPMV4hXywwpoDxu3Qda5xCKQi+vCTZq8S9J/EpkhB2HzKXq4SNFZE3+NK93JYxc8VMSep+lOUSC/RVKaBqw==", + "dev": true, + "hasInstallScript": true, + "bin": { + "esbuild": "bin/esbuild" + }, + "engines": { + "node": ">=12" + }, + "optionalDependencies": { + "@esbuild/aix-ppc64": "0.21.5", + "@esbuild/android-arm": "0.21.5", + "@esbuild/android-arm64": "0.21.5", + "@esbuild/android-x64": "0.21.5", + "@esbuild/darwin-arm64": "0.21.5", + "@esbuild/darwin-x64": "0.21.5", + "@esbuild/freebsd-arm64": "0.21.5", + "@esbuild/freebsd-x64": "0.21.5", + "@esbuild/linux-arm": "0.21.5", + "@esbuild/linux-arm64": "0.21.5", + "@esbuild/linux-ia32": "0.21.5", + "@esbuild/linux-loong64": "0.21.5", + "@esbuild/linux-mips64el": "0.21.5", + "@esbuild/linux-ppc64": "0.21.5", + "@esbuild/linux-riscv64": "0.21.5", + "@esbuild/linux-s390x": "0.21.5", + "@esbuild/linux-x64": "0.21.5", + "@esbuild/netbsd-x64": "0.21.5", + "@esbuild/openbsd-x64": "0.21.5", + "@esbuild/sunos-x64": "0.21.5", + "@esbuild/win32-arm64": "0.21.5", + "@esbuild/win32-ia32": "0.21.5", + "@esbuild/win32-x64": "0.21.5" + } + }, + "node_modules/fsevents": { + "version": "2.3.3", + "resolved": "https://registry.npmjs.org/fsevents/-/fsevents-2.3.3.tgz", + "integrity": "sha512-5xoDfX+fL7faATnagmWPpbFtwh/R77WmMMqqHGS65C3vvB0YHrgF+B1YmZ3441tMj5n63k0212XNoJwzlhffQw==", + "dev": true, + "hasInstallScript": true, + "optional": true, + "os": [ + "darwin" + ], + "engines": { + "node": "^8.16.0 || ^10.6.0 || >=11.0.0" + } + }, + "node_modules/nanoid": { + "version": "5.0.8", + "resolved": "https://registry.npmjs.org/nanoid/-/nanoid-5.0.8.tgz", + "integrity": "sha512-TcJPw+9RV9dibz1hHUzlLVy8N4X9TnwirAjrU08Juo6BNKggzVfP2ZJ/3ZUSq15Xl5i85i+Z89XBO90pB2PghQ==", + "dev": true, + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/ai" + } + ], + "bin": { + "nanoid": "bin/nanoid.js" + }, + "engines": { + "node": "^18 || >=20" + } + }, + "node_modules/picocolors": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/picocolors/-/picocolors-1.1.1.tgz", + "integrity": "sha512-xceH2snhtb5M9liqDsmEw56le376mTZkEX/jEb/RxNFyegNul7eNslCXP9FDj/Lcu0X8KEyMceP2ntpaHrDEVA==", + "dev": true + }, + "node_modules/postcss": { + "version": "8.4.47", + "resolved": "https://registry.npmjs.org/postcss/-/postcss-8.4.47.tgz", + "integrity": "sha512-56rxCq7G/XfB4EkXq9Egn5GCqugWvDFjafDOThIdMBsI15iqPqR5r15TfSr1YPYeEI19YeaXMCbY6u88Y76GLQ==", + "dev": true, + "funding": [ + { + "type": "opencollective", + "url": "https://opencollective.com/postcss/" + }, + { + "type": "tidelift", + "url": "https://tidelift.com/funding/github/npm/postcss" + }, + { + "type": "github", + "url": "https://github.com/sponsors/ai" + } + ], + "dependencies": { + "nanoid": "^3.3.7", + "picocolors": "^1.1.0", + "source-map-js": "^1.2.1" + }, + "engines": { + "node": "^10 || ^12 || >=14" + } + }, + "node_modules/postcss/node_modules/nanoid": { + "version": "3.3.7", + "resolved": "https://registry.npmjs.org/nanoid/-/nanoid-3.3.7.tgz", + "integrity": "sha512-eSRppjcPIatRIMC1U6UngP8XFcz8MQWGQdt1MTBQ7NaAmvXDfvNxbvWV3x2y6CdEUciCSsDHDQZbhYaB8QEo2g==", + "dev": true, + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/ai" + } + ], + "bin": { + "nanoid": "bin/nanoid.cjs" + }, + "engines": { + "node": "^10 || ^12 || ^13.7 || ^14 || >=15.0.1" + } + }, + "node_modules/rollup": { + "version": "4.24.3", + "resolved": "https://registry.npmjs.org/rollup/-/rollup-4.24.3.tgz", + "integrity": "sha512-HBW896xR5HGmoksbi3JBDtmVzWiPAYqp7wip50hjQ67JbDz61nyoMPdqu1DvVW9asYb2M65Z20ZHsyJCMqMyDg==", + "dev": true, + "dependencies": { + "@types/estree": "1.0.6" + }, + "bin": { + "rollup": "dist/bin/rollup" + }, + "engines": { + "node": ">=18.0.0", + "npm": ">=8.0.0" + }, + "optionalDependencies": { + "@rollup/rollup-android-arm-eabi": "4.24.3", + "@rollup/rollup-android-arm64": "4.24.3", + "@rollup/rollup-darwin-arm64": "4.24.3", + "@rollup/rollup-darwin-x64": "4.24.3", + "@rollup/rollup-freebsd-arm64": "4.24.3", + "@rollup/rollup-freebsd-x64": "4.24.3", + "@rollup/rollup-linux-arm-gnueabihf": "4.24.3", + "@rollup/rollup-linux-arm-musleabihf": "4.24.3", + "@rollup/rollup-linux-arm64-gnu": "4.24.3", + "@rollup/rollup-linux-arm64-musl": "4.24.3", + "@rollup/rollup-linux-powerpc64le-gnu": "4.24.3", + "@rollup/rollup-linux-riscv64-gnu": "4.24.3", + "@rollup/rollup-linux-s390x-gnu": "4.24.3", + "@rollup/rollup-linux-x64-gnu": "4.24.3", + "@rollup/rollup-linux-x64-musl": "4.24.3", + "@rollup/rollup-win32-arm64-msvc": "4.24.3", + "@rollup/rollup-win32-ia32-msvc": "4.24.3", + "@rollup/rollup-win32-x64-msvc": "4.24.3", + "fsevents": "~2.3.2" + } + }, + "node_modules/source-map-js": { + "version": "1.2.1", + "resolved": "https://registry.npmjs.org/source-map-js/-/source-map-js-1.2.1.tgz", + "integrity": "sha512-UXWMKhLOwVKb728IUtQPXxfYU+usdybtUrK/8uGE8CQMvrhOpwvzDBwj0QhSL7MQc7vIsISBG8VQ8+IDQxpfQA==", + "dev": true, + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/vite": { + "version": "5.4.10", + "resolved": "https://registry.npmjs.org/vite/-/vite-5.4.10.tgz", + "integrity": "sha512-1hvaPshuPUtxeQ0hsVH3Mud0ZanOLwVTneA1EgbAM5LhaZEqyPWGRQ7BtaMvUrTDeEaC8pxtj6a6jku3x4z6SQ==", + "dev": true, + "dependencies": { + "esbuild": "^0.21.3", + "postcss": "^8.4.43", + "rollup": "^4.20.0" + }, + "bin": { + "vite": "bin/vite.js" + }, + "engines": { + "node": "^18.0.0 || >=20.0.0" + }, + "funding": { + "url": "https://github.com/vitejs/vite?sponsor=1" + }, + "optionalDependencies": { + "fsevents": "~2.3.3" + }, + "peerDependencies": { + "@types/node": "^18.0.0 || >=20.0.0", + "less": "*", + "lightningcss": "^1.21.0", + "sass": "*", + "sass-embedded": "*", + "stylus": "*", + "sugarss": "*", + "terser": "^5.4.0" + }, + "peerDependenciesMeta": { + "@types/node": { + "optional": true + }, + "less": { + "optional": true + }, + "lightningcss": { + "optional": true + }, + "sass": { + "optional": true + }, + "sass-embedded": { + "optional": true + }, + "stylus": { + "optional": true + }, + "sugarss": { + "optional": true + }, + "terser": { + "optional": true + } + } + } + } +} diff --git a/v3/examples/file-association/frontend/package.json b/v3/examples/file-association/frontend/package.json new file mode 100644 index 000000000..2642d7a41 --- /dev/null +++ b/v3/examples/file-association/frontend/package.json @@ -0,0 +1,16 @@ +{ + "name": "frontend", + "private": true, + "version": "0.0.0", + "type": "module", + "scripts": { + "dev": "vite", + "build": "vite build --minify false --mode development", + "build:prod": "vite build --mode production", + "preview": "vite preview" + }, + "devDependencies": { + "vite": "^5.0.0", + "@wailsio/runtime": "latest" + } +} \ No newline at end of file diff --git a/v3/examples/file-association/frontend/public/Inter-Medium.ttf b/v3/examples/file-association/frontend/public/Inter-Medium.ttf new file mode 100644 index 000000000..a01f3777a Binary files /dev/null and b/v3/examples/file-association/frontend/public/Inter-Medium.ttf differ diff --git a/v3/examples/file-association/frontend/public/javascript.svg b/v3/examples/file-association/frontend/public/javascript.svg new file mode 100644 index 000000000..f9abb2b72 --- /dev/null +++ b/v3/examples/file-association/frontend/public/javascript.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/v3/examples/file-association/frontend/public/style.css b/v3/examples/file-association/frontend/public/style.css new file mode 100644 index 000000000..259397254 --- /dev/null +++ b/v3/examples/file-association/frontend/public/style.css @@ -0,0 +1,160 @@ +:root { + font-family: "Inter", -apple-system, BlinkMacSystemFont, "Segoe UI", "Roboto", + "Oxygen", "Ubuntu", "Cantarell", "Fira Sans", "Droid Sans", "Helvetica Neue", + sans-serif; + font-size: 16px; + line-height: 24px; + font-weight: 400; + color-scheme: light dark; + color: rgba(255, 255, 255, 0.87); + background-color: rgba(27, 38, 54, 1); + font-synthesis: none; + text-rendering: optimizeLegibility; + -webkit-font-smoothing: antialiased; + -moz-osx-font-smoothing: grayscale; + -webkit-text-size-adjust: 100%; +} + +* { + user-select: none; + -webkit-user-select: none; + -moz-user-select: none; + -ms-user-select: none; +} + +@font-face { + font-family: "Inter"; + font-style: normal; + font-weight: 400; + src: local(""), + url("./Inter-Medium.ttf") format("truetype"); +} + +h3 { + font-size: 3em; + line-height: 1.1; +} + +a { + font-weight: 500; + color: #646cff; + text-decoration: inherit; +} + +a:hover { + color: #535bf2; +} + +button { + width: 60px; + height: 30px; + line-height: 30px; + border-radius: 3px; + border: none; + margin: 0 0 0 20px; + padding: 0 8px; + cursor: pointer; +} + +.result { + height: 20px; + line-height: 20px; +} + +body { + margin: 0; + display: flex; + place-items: center; + place-content: center; + min-width: 320px; + min-height: 100vh; +} + +.container { + display: flex; + flex-direction: column; + align-items: center; + justify-content: center; +} + +h1 { + font-size: 3.2em; + line-height: 1.1; +} + +#app { + max-width: 1280px; + margin: 0 auto; + padding: 2rem; + text-align: center; +} + +.logo { + height: 6em; + padding: 1.5em; + will-change: filter; +} + +.logo:hover { + filter: drop-shadow(0 0 2em #e80000aa); +} + +.logo.vanilla:hover { + filter: drop-shadow(0 0 2em #f7df1eaa); +} + +.result { + height: 20px; + line-height: 20px; + margin: 1.5rem auto; + text-align: center; +} + +.footer { + margin-top: 1rem; + align-content: center; + text-align: center; +} + +@media (prefers-color-scheme: light) { + :root { + color: #213547; + background-color: #ffffff; + } + + a:hover { + color: #747bff; + } + + button { + background-color: #f9f9f9; + } +} + + +.input-box .btn:hover { + background-image: linear-gradient(to top, #cfd9df 0%, #e2ebf0 100%); + color: #333333; +} + +.input-box .input { + border: none; + border-radius: 3px; + outline: none; + height: 30px; + line-height: 30px; + padding: 0 10px; + color: black; + background-color: rgba(240, 240, 240, 1); + -webkit-font-smoothing: antialiased; +} + +.input-box .input:hover { + border: none; + background-color: rgba(255, 255, 255, 1); +} + +.input-box .input:focus { + border: none; + background-color: rgba(255, 255, 255, 1); +} \ No newline at end of file diff --git a/v3/examples/file-association/frontend/public/wails.png b/v3/examples/file-association/frontend/public/wails.png new file mode 100644 index 000000000..8bdf42483 Binary files /dev/null and b/v3/examples/file-association/frontend/public/wails.png differ diff --git a/v3/examples/file-association/go.mod b/v3/examples/file-association/go.mod new file mode 100644 index 000000000..296394de3 --- /dev/null +++ b/v3/examples/file-association/go.mod @@ -0,0 +1,49 @@ +module changeme + +go 1.25 + +require github.com/wailsapp/wails/v3 v3.0.0-alpha.62 + +require ( + dario.cat/mergo v1.0.2 // indirect + github.com/Microsoft/go-winio v0.6.2 // indirect + github.com/ProtonMail/go-crypto v1.3.0 // indirect + github.com/adrg/xdg v0.5.3 // indirect + github.com/bep/debounce v1.2.1 // indirect + github.com/cloudflare/circl v1.6.3 // indirect + github.com/coder/websocket v1.8.14 // indirect + github.com/cyphar/filepath-securejoin v0.6.1 // indirect + github.com/ebitengine/purego v0.9.1 // indirect + github.com/emirpasic/gods v1.18.1 // indirect + github.com/go-git/gcfg v1.5.1-0.20230307220236-3a3c6141e376 // indirect + github.com/go-git/go-billy/v5 v5.7.0 // indirect + github.com/go-git/go-git/v5 v5.16.4 // indirect + github.com/go-ole/go-ole v1.3.0 // indirect + github.com/godbus/dbus/v5 v5.2.2 // indirect + github.com/golang/groupcache v0.0.0-20241129210726-2c02b8208cf8 // indirect + github.com/google/uuid v1.6.0 // indirect + github.com/jbenet/go-context v0.0.0-20150711004518-d14ea06fba99 // indirect + github.com/jchv/go-winloader v0.0.0-20250406163304-c1995be93bd1 // indirect + github.com/kevinburke/ssh_config v1.4.0 // indirect + github.com/klauspost/cpuid/v2 v2.3.0 // indirect + github.com/leaanthony/go-ansi-parser v1.6.1 // indirect + github.com/leaanthony/u v1.1.1 // indirect + github.com/lmittmann/tint v1.1.2 // indirect + github.com/mattn/go-colorable v0.1.14 // indirect + github.com/mattn/go-isatty v0.0.20 // indirect + github.com/pjbgf/sha1cd v0.5.0 // indirect + github.com/pkg/browser v0.0.0-20240102092130-5ac0b6a4141c // indirect + github.com/rivo/uniseg v0.4.7 // indirect + github.com/samber/lo v1.52.0 // indirect + github.com/sergi/go-diff v1.4.0 // indirect + github.com/skeema/knownhosts v1.3.2 // indirect + github.com/wailsapp/go-webview2 v1.0.23 // indirect + github.com/xanzy/ssh-agent v0.3.3 // indirect + golang.org/x/crypto v0.47.0 // indirect + golang.org/x/net v0.49.0 // indirect + golang.org/x/sys v0.40.0 // indirect + golang.org/x/text v0.33.0 // indirect + gopkg.in/warnings.v0 v0.1.2 // indirect +) + +replace github.com/wailsapp/wails/v3 => ../.. diff --git a/v3/examples/file-association/go.sum b/v3/examples/file-association/go.sum new file mode 100644 index 000000000..56f1153ea --- /dev/null +++ b/v3/examples/file-association/go.sum @@ -0,0 +1,147 @@ +dario.cat/mergo v1.0.2 h1:85+piFYR1tMbRrLcDwR18y4UKJ3aH1Tbzi24VRW1TK8= +dario.cat/mergo v1.0.2/go.mod h1:E/hbnu0NxMFBjpMIE34DRGLWqDy0g5FuKDhCb31ngxA= +github.com/Microsoft/go-winio v0.5.2/go.mod h1:WpS1mjBmmwHBEWmogvA2mj8546UReBk4v8QkMxJ6pZY= +github.com/Microsoft/go-winio v0.6.2 h1:F2VQgta7ecxGYO8k3ZZz3RS8fVIXVxONVUPlNERoyfY= +github.com/Microsoft/go-winio v0.6.2/go.mod h1:yd8OoFMLzJbo9gZq8j5qaps8bJ9aShtEA8Ipt1oGCvU= +github.com/ProtonMail/go-crypto v1.3.0 h1:ILq8+Sf5If5DCpHQp4PbZdS1J7HDFRXz/+xKBiRGFrw= +github.com/ProtonMail/go-crypto v1.3.0/go.mod h1:9whxjD8Rbs29b4XWbB8irEcE8KHMqaR2e7GWU1R+/PE= +github.com/adrg/xdg v0.5.3 h1:xRnxJXne7+oWDatRhR1JLnvuccuIeCoBu2rtuLqQB78= +github.com/adrg/xdg v0.5.3/go.mod h1:nlTsY+NNiCBGCK2tpm09vRqfVzrc2fLmXGpBLF0zlTQ= +github.com/anmitsu/go-shlex v0.0.0-20200514113438-38f4b401e2be h1:9AeTilPcZAjCFIImctFaOjnTIavg87rW78vTPkQqLI8= +github.com/anmitsu/go-shlex v0.0.0-20200514113438-38f4b401e2be/go.mod h1:ySMOLuWl6zY27l47sB3qLNK6tF2fkHG55UZxx8oIVo4= +github.com/armon/go-socks5 v0.0.0-20160902184237-e75332964ef5 h1:0CwZNZbxp69SHPdPJAN/hZIm0C4OItdklCFmMRWYpio= +github.com/armon/go-socks5 v0.0.0-20160902184237-e75332964ef5/go.mod h1:wHh0iHkYZB8zMSxRWpUBQtwG5a7fFgvEO+odwuTv2gs= +github.com/bep/debounce v1.2.1 h1:v67fRdBA9UQu2NhLFXrSg0Brw7CexQekrBwDMM8bzeY= +github.com/bep/debounce v1.2.1/go.mod h1:H8yggRPQKLUhUoqrJC1bO2xNya7vanpDl7xR3ISbCJ0= +github.com/cloudflare/circl v1.6.3 h1:9GPOhQGF9MCYUeXyMYlqTR6a5gTrgR/fBLXvUgtVcg8= +github.com/cloudflare/circl v1.6.3/go.mod h1:2eXP6Qfat4O/Yhh8BznvKnJ+uzEoTQ6jVKJRn81BiS4= +github.com/coder/websocket v1.8.14 h1:9L0p0iKiNOibykf283eHkKUHHrpG7f65OE3BhhO7v9g= +github.com/coder/websocket v1.8.14/go.mod h1:NX3SzP+inril6yawo5CQXx8+fk145lPDC6pumgx0mVg= +github.com/cyphar/filepath-securejoin v0.6.1 h1:5CeZ1jPXEiYt3+Z6zqprSAgSWiggmpVyciv8syjIpVE= +github.com/cyphar/filepath-securejoin v0.6.1/go.mod h1:A8hd4EnAeyujCJRrICiOWqjS1AX0a9kM5XL+NwKoYSc= +github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= +github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c= +github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= +github.com/ebitengine/purego v0.9.1 h1:a/k2f2HQU3Pi399RPW1MOaZyhKJL9w/xFpKAg4q1s0A= +github.com/ebitengine/purego v0.9.1/go.mod h1:iIjxzd6CiRiOG0UyXP+V1+jWqUXVjPKLAI0mRfJZTmQ= +github.com/elazarl/goproxy v1.7.2 h1:Y2o6urb7Eule09PjlhQRGNsqRfPmYI3KKQLFpCAV3+o= +github.com/elazarl/goproxy v1.7.2/go.mod h1:82vkLNir0ALaW14Rc399OTTjyNREgmdL2cVoIbS6XaE= +github.com/emirpasic/gods v1.18.1 h1:FXtiHYKDGKCW2KzwZKx0iC0PQmdlorYgdFG9jPXJ1Bc= +github.com/emirpasic/gods v1.18.1/go.mod h1:8tpGGwCnJ5H4r6BWwaV6OrWmMoPhUl5jm/FMNAnJvWQ= +github.com/gliderlabs/ssh v0.3.8 h1:a4YXD1V7xMF9g5nTkdfnja3Sxy1PVDCj1Zg4Wb8vY6c= +github.com/gliderlabs/ssh v0.3.8/go.mod h1:xYoytBv1sV0aL3CavoDuJIQNURXkkfPA/wxQ1pL1fAU= +github.com/go-git/gcfg v1.5.1-0.20230307220236-3a3c6141e376 h1:+zs/tPmkDkHx3U66DAb0lQFJrpS6731Oaa12ikc+DiI= +github.com/go-git/gcfg v1.5.1-0.20230307220236-3a3c6141e376/go.mod h1:an3vInlBmSxCcxctByoQdvwPiA7DTK7jaaFDBTtu0ic= +github.com/go-git/go-billy/v5 v5.7.0 h1:83lBUJhGWhYp0ngzCMSgllhUSuoHP1iEWYjsPl9nwqM= +github.com/go-git/go-billy/v5 v5.7.0/go.mod h1:/1IUejTKH8xipsAcdfcSAlUlo2J7lkYV8GTKxAT/L3E= +github.com/go-git/go-git-fixtures/v4 v4.3.2-0.20231010084843-55a94097c399 h1:eMje31YglSBqCdIqdhKBW8lokaMrL3uTkpGYlE2OOT4= +github.com/go-git/go-git-fixtures/v4 v4.3.2-0.20231010084843-55a94097c399/go.mod h1:1OCfN199q1Jm3HZlxleg+Dw/mwps2Wbk9frAWm+4FII= +github.com/go-git/go-git/v5 v5.16.4 h1:7ajIEZHZJULcyJebDLo99bGgS0jRrOxzZG4uCk2Yb2Y= +github.com/go-git/go-git/v5 v5.16.4/go.mod h1:4Ge4alE/5gPs30F2H1esi2gPd69R0C39lolkucHBOp8= +github.com/go-json-experiment/json v0.0.0-20251027170946-4849db3c2f7e h1:Lf/gRkoycfOBPa42vU2bbgPurFong6zXeFtPoxholzU= +github.com/go-json-experiment/json v0.0.0-20251027170946-4849db3c2f7e/go.mod h1:uNVvRXArCGbZ508SxYYTC5v1JWoz2voff5pm25jU1Ok= +github.com/go-ole/go-ole v1.3.0 h1:Dt6ye7+vXGIKZ7Xtk4s6/xVdGDQynvom7xCFEdWr6uE= +github.com/go-ole/go-ole v1.3.0/go.mod h1:5LS6F96DhAwUc7C+1HLexzMXY1xGRSryjyPPKW6zv78= +github.com/godbus/dbus/v5 v5.2.2 h1:TUR3TgtSVDmjiXOgAAyaZbYmIeP3DPkld3jgKGV8mXQ= +github.com/godbus/dbus/v5 v5.2.2/go.mod h1:3AAv2+hPq5rdnr5txxxRwiGjPXamgoIHgz9FPBfOp3c= +github.com/golang/groupcache v0.0.0-20241129210726-2c02b8208cf8 h1:f+oWsMOmNPc8JmEHVZIycC7hBoQxHH9pNKQORJNozsQ= +github.com/golang/groupcache v0.0.0-20241129210726-2c02b8208cf8/go.mod h1:wcDNUvekVysuuOpQKo3191zZyTpiI6se1N1ULghS0sw= +github.com/google/go-cmp v0.7.0 h1:wk8382ETsv4JYUZwIsn6YpYiWiBsYLSJiTsyBybVuN8= +github.com/google/go-cmp v0.7.0/go.mod h1:pXiqmnSA92OHEEa9HXL2W4E7lf9JzCmGVUdgjX3N/iU= +github.com/google/uuid v1.6.0 h1:NIvaJDMOsjHA8n1jAhLSgzrAzy1Hgr+hNrb57e+94F0= +github.com/google/uuid v1.6.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo= +github.com/jbenet/go-context v0.0.0-20150711004518-d14ea06fba99 h1:BQSFePA1RWJOlocH6Fxy8MmwDt+yVQYULKfN0RoTN8A= +github.com/jbenet/go-context v0.0.0-20150711004518-d14ea06fba99/go.mod h1:1lJo3i6rXxKeerYnT8Nvf0QmHCRC1n8sfWVwXF2Frvo= +github.com/jchv/go-winloader v0.0.0-20250406163304-c1995be93bd1 h1:njuLRcjAuMKr7kI3D85AXWkw6/+v9PwtV6M6o11sWHQ= +github.com/jchv/go-winloader v0.0.0-20250406163304-c1995be93bd1/go.mod h1:alcuEEnZsY1WQsagKhZDsoPCRoOijYqhZvPwLG0kzVs= +github.com/kevinburke/ssh_config v1.4.0 h1:6xxtP5bZ2E4NF5tuQulISpTO2z8XbtH8cg1PWkxoFkQ= +github.com/kevinburke/ssh_config v1.4.0/go.mod h1:q2RIzfka+BXARoNexmF9gkxEX7DmvbW9P4hIVx2Kg4M= +github.com/klauspost/cpuid/v2 v2.3.0 h1:S4CRMLnYUhGeDFDqkGriYKdfoFlDnMtqTiI/sFzhA9Y= +github.com/klauspost/cpuid/v2 v2.3.0/go.mod h1:hqwkgyIinND0mEev00jJYCxPNVRVXFQeu1XKlok6oO0= +github.com/kr/pretty v0.1.0/go.mod h1:dAy3ld7l9f0ibDNOQOHHMYYIIbhfbHSm3C4ZsoJORNo= +github.com/kr/pretty v0.3.1 h1:flRD4NNwYAUpkphVc1HcthR4KEIFJ65n8Mw5qdRn3LE= +github.com/kr/pretty v0.3.1/go.mod h1:hoEshYVHaxMs3cyo3Yncou5ZscifuDolrwPKZanG3xk= +github.com/kr/pty v1.1.1/go.mod h1:pFQYn66WHrOpPYNljwOMqo10TkYh1fy3cYio2l3bCsQ= +github.com/kr/text v0.1.0/go.mod h1:4Jbv+DJW3UT/LiOwJeYQe1efqtUx/iVham/4vfdArNI= +github.com/kr/text v0.2.0 h1:5Nx0Ya0ZqY2ygV366QzturHI13Jq95ApcVaJBhpS+AY= +github.com/kr/text v0.2.0/go.mod h1:eLer722TekiGuMkidMxC/pM04lWEeraHUUmBw8l2grE= +github.com/leaanthony/go-ansi-parser v1.6.1 h1:xd8bzARK3dErqkPFtoF9F3/HgN8UQk0ed1YDKpEz01A= +github.com/leaanthony/go-ansi-parser v1.6.1/go.mod h1:+vva/2y4alzVmmIEpk9QDhA7vLC5zKDTRwfZGOp3IWU= +github.com/leaanthony/u v1.1.1 h1:TUFjwDGlNX+WuwVEzDqQwC2lOv0P4uhTQw7CMFdiK7M= +github.com/leaanthony/u v1.1.1/go.mod h1:9+o6hejoRljvZ3BzdYlVL0JYCwtnAsVuN9pVTQcaRfI= +github.com/lmittmann/tint v1.1.2 h1:2CQzrL6rslrsyjqLDwD11bZ5OpLBPU+g3G/r5LSfS8w= +github.com/lmittmann/tint v1.1.2/go.mod h1:HIS3gSy7qNwGCj+5oRjAutErFBl4BzdQP6cJZ0NfMwE= +github.com/matryer/is v1.4.0/go.mod h1:8I/i5uYgLzgsgEloJE1U6xx5HkBQpAZvepWuujKwMRU= +github.com/matryer/is v1.4.1 h1:55ehd8zaGABKLXQUe2awZ99BD/PTc2ls+KV/dXphgEQ= +github.com/matryer/is v1.4.1/go.mod h1:8I/i5uYgLzgsgEloJE1U6xx5HkBQpAZvepWuujKwMRU= +github.com/mattn/go-colorable v0.1.14 h1:9A9LHSqF/7dyVVX6g0U9cwm9pG3kP9gSzcuIPHPsaIE= +github.com/mattn/go-colorable v0.1.14/go.mod h1:6LmQG8QLFO4G5z1gPvYEzlUgJ2wF+stgPZH1UqBm1s8= +github.com/mattn/go-isatty v0.0.20 h1:xfD0iDuEKnDkl03q4limB+vH+GxLEtL/jb4xVJSWWEY= +github.com/mattn/go-isatty v0.0.20/go.mod h1:W+V8PltTTMOvKvAeJH7IuucS94S2C6jfK/D7dTCTo3Y= +github.com/onsi/gomega v1.34.1 h1:EUMJIKUjM8sKjYbtxQI9A4z2o+rruxnzNvpknOXie6k= +github.com/onsi/gomega v1.34.1/go.mod h1:kU1QgUvBDLXBJq618Xvm2LUX6rSAfRaFRTcdOeDLwwY= +github.com/pjbgf/sha1cd v0.5.0 h1:a+UkboSi1znleCDUNT3M5YxjOnN1fz2FhN48FlwCxs0= +github.com/pjbgf/sha1cd v0.5.0/go.mod h1:lhpGlyHLpQZoxMv8HcgXvZEhcGs0PG/vsZnEJ7H0iCM= +github.com/pkg/browser v0.0.0-20240102092130-5ac0b6a4141c h1:+mdjkGKdHQG3305AYmdv1U2eRNDiU2ErMBj1gwrq8eQ= +github.com/pkg/browser v0.0.0-20240102092130-5ac0b6a4141c/go.mod h1:7rwL4CYBLnjLxUqIJNnCWiEdr3bn6IUYi15bNlnbCCU= +github.com/pkg/errors v0.9.1 h1:FEBLx1zS214owpjy7qsBeixbURkuhQAwrK5UwLGTwt4= +github.com/pkg/errors v0.9.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0= +github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM= +github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= +github.com/rivo/uniseg v0.2.0/go.mod h1:J6wj4VEh+S6ZtnVlnTBMWIodfgj8LQOQFoIToxlJtxc= +github.com/rivo/uniseg v0.4.7 h1:WUdvkW8uEhrYfLC4ZzdpI2ztxP1I582+49Oc5Mq64VQ= +github.com/rivo/uniseg v0.4.7/go.mod h1:FN3SvrM+Zdj16jyLfmOkMNblXMcoc8DfTHruCPUcx88= +github.com/rogpeppe/go-internal v1.14.1 h1:UQB4HGPB6osV0SQTLymcB4TgvyWu6ZyliaW0tI/otEQ= +github.com/rogpeppe/go-internal v1.14.1/go.mod h1:MaRKkUm5W0goXpeCfT7UZI6fk/L7L7so1lCWt35ZSgc= +github.com/samber/lo v1.52.0 h1:Rvi+3BFHES3A8meP33VPAxiBZX/Aws5RxrschYGjomw= +github.com/samber/lo v1.52.0/go.mod h1:4+MXEGsJzbKGaUEQFKBq2xtfuznW9oz/WrgyzMzRoM0= +github.com/sergi/go-diff v1.4.0 h1:n/SP9D5ad1fORl+llWyN+D6qoUETXNZARKjyY2/KVCw= +github.com/sergi/go-diff v1.4.0/go.mod h1:A0bzQcvG0E7Rwjx0REVgAGH58e96+X0MeOfepqsbeW4= +github.com/sirupsen/logrus v1.7.0/go.mod h1:yWOB1SBYBC5VeMP7gHvWumXLIWorT60ONWic61uBYv0= +github.com/skeema/knownhosts v1.3.2 h1:EDL9mgf4NzwMXCTfaxSD/o/a5fxDw/xL9nkU28JjdBg= +github.com/skeema/knownhosts v1.3.2/go.mod h1:bEg3iQAuw+jyiw+484wwFJoKSLwcfd7fqRy+N0QTiow= +github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME= +github.com/stretchr/testify v1.2.2/go.mod h1:a8OnRcib4nhh0OaRAV+Yts87kKdq0PP7pXfy6kDkUVs= +github.com/stretchr/testify v1.4.0/go.mod h1:j7eGeouHqKxXV5pUuKE4zz7dFj8WfuZ+81PSLYec5m4= +github.com/stretchr/testify v1.11.1 h1:7s2iGBzp5EwR7/aIZr8ao5+dra3wiQyKjjFuvgVKu7U= +github.com/stretchr/testify v1.11.1/go.mod h1:wZwfW3scLgRK+23gO65QZefKpKQRnfz6sD981Nm4B6U= +github.com/wailsapp/go-webview2 v1.0.23 h1:jmv8qhz1lHibCc79bMM/a/FqOnnzOGEisLav+a0b9P0= +github.com/wailsapp/go-webview2 v1.0.23/go.mod h1:qJmWAmAmaniuKGZPWwne+uor3AHMB5PFhqiK0Bbj8kc= +github.com/xanzy/ssh-agent v0.3.3 h1:+/15pJfg/RsTxqYcX6fHqOXZwwMP+2VyYWJeWM2qQFM= +github.com/xanzy/ssh-agent v0.3.3/go.mod h1:6dzNDKs0J9rVPHPhaGCukekBHKqfl+L3KghI1Bc68Uw= +golang.org/x/crypto v0.0.0-20220622213112-05595931fe9d/go.mod h1:IxCIyHEi3zRg3s0A5j5BB6A9Jmi73HwBIUl50j+osU4= +golang.org/x/crypto v0.47.0 h1:V6e3FRj+n4dbpw86FJ8Fv7XVOql7TEwpHapKoMJ/GO8= +golang.org/x/crypto v0.47.0/go.mod h1:ff3Y9VzzKbwSSEzWqJsJVBnWmRwRSHt/6Op5n9bQc4A= +golang.org/x/exp v0.0.0-20260112195511-716be5621a96 h1:Z/6YuSHTLOHfNFdb8zVZomZr7cqNgTJvA8+Qz75D8gU= +golang.org/x/exp v0.0.0-20260112195511-716be5621a96/go.mod h1:nzimsREAkjBCIEFtHiYkrJyT+2uy9YZJB7H1k68CXZU= +golang.org/x/net v0.0.0-20211112202133-69e39bad7dc2/go.mod h1:9nx3DQGgdP8bBQD5qxJ1jj9UTztislL4KSBs9R2vV5Y= +golang.org/x/net v0.49.0 h1:eeHFmOGUTtaaPSGNmjBKpbng9MulQsJURQUAfUwY++o= +golang.org/x/net v0.49.0/go.mod h1:/ysNB2EvaqvesRkuLAyjI1ycPZlQHM3q01F02UY/MV8= +golang.org/x/sys v0.0.0-20191026070338-33540a1f6037/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20200810151505-1b9f1253b3ed/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20201119102817-f84b799fce68/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20210124154548-22da62e12c0c/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20210423082822-04245dca01da/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20210615035016-665e8c7367d1/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.0.0-20220715151400-c0bba94af5f8/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.1.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.6.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.40.0 h1:DBZZqJ2Rkml6QMQsZywtnjnnGvHza6BTfYFWY9kjEWQ= +golang.org/x/sys v0.40.0/go.mod h1:OgkHotnGiDImocRcuBABYBEXf8A9a87e/uXjp9XT3ks= +golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo= +golang.org/x/term v0.39.0 h1:RclSuaJf32jOqZz74CkPA9qFuVTX7vhLlpfj/IGWlqY= +golang.org/x/term v0.39.0/go.mod h1:yxzUCTP/U+FzoxfdKmLaA0RV1WgE0VY7hXBwKtY/4ww= +golang.org/x/text v0.3.6/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ= +golang.org/x/text v0.33.0 h1:B3njUFyqtHDUI5jMn1YIr5B0IE2U0qck04r6d4KPAxE= +golang.org/x/text v0.33.0/go.mod h1:LuMebE6+rBincTi9+xWTY8TztLzKHc/9C1uBCG27+q8= +golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ= +gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= +gopkg.in/check.v1 v1.0.0-20190902080502-41f04d3bba15/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= +gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c h1:Hei/4ADfdWqJk1ZMxUNpqntNwaWcugrBjAiHlqqRiVk= +gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c/go.mod h1:JHkPIbrfpd72SG/EVd6muEfDQjcINNoR0C8j2r3qZ4Q= +gopkg.in/warnings.v0 v0.1.2 h1:wFXVbFY8DY5/xOe1ECiWdKCzZlxgshcYVNkBHstARME= +gopkg.in/warnings.v0 v0.1.2/go.mod h1:jksf8JmL6Qr/oQM2OXTHunEvvTAsrWBLb6OOjuVWRNI= +gopkg.in/yaml.v2 v2.2.2/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI= +gopkg.in/yaml.v2 v2.4.0/go.mod h1:RDklbk79AGWmwhnvt/jBztapEOGDOx6ZbXqjP6csGnQ= +gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA= +gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= diff --git a/v3/examples/file-association/greetservice.go b/v3/examples/file-association/greetservice.go new file mode 100644 index 000000000..8972c39cd --- /dev/null +++ b/v3/examples/file-association/greetservice.go @@ -0,0 +1,7 @@ +package main + +type GreetService struct{} + +func (g *GreetService) Greet(name string) string { + return "Hello " + name + "!" +} diff --git a/v3/examples/file-association/main.go b/v3/examples/file-association/main.go new file mode 100644 index 000000000..a81506b52 --- /dev/null +++ b/v3/examples/file-association/main.go @@ -0,0 +1,97 @@ +package main + +import ( + "embed" + _ "embed" + "github.com/wailsapp/wails/v3/pkg/events" + "log" + "time" + + "github.com/wailsapp/wails/v3/pkg/application" +) + +// Wails uses Go's `embed` package to embed the frontend files into the binary. +// Any files in the frontend/dist folder will be embedded into the binary and +// made available to the frontend. +// See https://pkg.go.dev/embed for more information. + +//go:embed frontend +var assets embed.FS + +// main function serves as the application's entry point. It initializes the application, creates a window, +// and starts a goroutine that emits a time-based event every second. It subsequently runs the application and +// logs any error that might occur. +func main() { + + // Create a new Wails application by providing the necessary options. + // Variables 'Name' and 'Description' are for application metadata. + // 'Assets' configures the asset server with the 'FS' variable pointing to the frontend files. + // 'Bind' is a list of Go struct instances. The frontend has access to the methods of these instances. + // 'Mac' options tailor the application when running an macOS. + app := application.New(application.Options{ + Name: "fileassoc", + Description: "A demo of using raw HTML & CSS", + Services: []application.Service{ + application.NewService(&GreetService{}), + }, + Assets: application.AssetOptions{ + Handler: application.AssetFileServerFS(assets), + }, + Mac: application.MacOptions{ + ApplicationShouldTerminateAfterLastWindowClosed: true, + }, + FileAssociations: []string{".wails"}, + }) + + // Create a new window with the necessary options. + // 'Title' is the title of the window. + // 'Mac' options tailor the window when running on macOS. + // 'BackgroundColour' is the background colour of the window. + // 'URL' is the URL that will be loaded into the webview. + window := app.Window.NewWithOptions(application.WebviewWindowOptions{ + Title: "Window 1", + Mac: application.MacWindow{ + InvisibleTitleBarHeight: 50, + Backdrop: application.MacBackdropTranslucent, + TitleBar: application.MacTitleBarHiddenInset, + }, + BackgroundColour: application.NewRGB(27, 38, 54), + URL: "/", + }) + + var filename string + app.Event.OnApplicationEvent(events.Common.ApplicationOpenedWithFile, func(event *application.ApplicationEvent) { + filename = event.Context().Filename() + }) + + window.OnWindowEvent(events.Common.WindowShow, func(event *application.WindowEvent) { + app.Dialog.Info(). + SetTitle("File Opened"). + SetMessage("Application opened with file: " + filename). + Show() + }) + + // Create a goroutine that emits an event containing the current time every second. + // The frontend can listen to this event and update the UI accordingly. + go func() { + ticker := time.NewTicker(time.Second) + defer ticker.Stop() + for { + select { + case <-ticker.C: + now := time.Now().Format(time.RFC1123) + app.Event.Emit("time", now) + case <-app.Context().Done(): + return + } + } + }() + + // Run the application. This blocks until the application has been exited. + err := app.Run() + + // If an error occurred while running the application, log it and exit. + if err != nil { + log.Fatal(err) + } +} diff --git a/v3/examples/file-association/test.wails b/v3/examples/file-association/test.wails new file mode 100644 index 000000000..dde58d5e8 --- /dev/null +++ b/v3/examples/file-association/test.wails @@ -0,0 +1 @@ +Once the application is built and installed, double click on this file to open the application. \ No newline at end of file diff --git a/v3/examples/file-input/README.md b/v3/examples/file-input/README.md new file mode 100644 index 000000000..57309cf48 --- /dev/null +++ b/v3/examples/file-input/README.md @@ -0,0 +1,24 @@ +# File Input Example + +Tests HTML `` and Wails Dialog API functionality (#4862). + +## Test Cases + +**HTML File Input:** +1. **Single File** - Basic file selection +2. **Multiple Files** - Multi-select with `multiple` attribute +3. **Files or Directories** - Selection with `webkitdirectory` attribute + +**Wails Dialog API (via generated bindings):** +4. **Directory Only** - `CanChooseDirectories(true)` + `CanChooseFiles(false)` +5. **Filtered (.txt)** - Using `AddFilter()` for file type filtering + +## Run + +```bash +# Generate bindings (already included) +wails3 generate bindings -d assets/bindings + +# Run the app +go run . +``` diff --git a/v3/examples/file-input/assets/bindings/github.com/wailsapp/wails/v3/examples/file-input/fileservice.js b/v3/examples/file-input/assets/bindings/github.com/wailsapp/wails/v3/examples/file-input/fileservice.js new file mode 100644 index 000000000..6f5686c35 --- /dev/null +++ b/v3/examples/file-input/assets/bindings/github.com/wailsapp/wails/v3/examples/file-input/fileservice.js @@ -0,0 +1,21 @@ +// @ts-check +// Cynhyrchwyd y ffeil hon yn awtomatig. PEIDIWCH Â MODIWL +// This file is automatically generated. DO NOT EDIT + +// eslint-disable-next-line @typescript-eslint/ban-ts-comment +// @ts-ignore: Unused imports +import { Call as $Call, CancellablePromise as $CancellablePromise, Create as $Create } from "@wailsio/runtime"; + +/** + * @returns {$CancellablePromise} + */ +export function OpenDirectoryOnly() { + return $Call.ByID(1809289240); +} + +/** + * @returns {$CancellablePromise} + */ +export function OpenFilteredFile() { + return $Call.ByID(2331855742); +} diff --git a/v3/examples/file-input/assets/bindings/github.com/wailsapp/wails/v3/examples/file-input/index.js b/v3/examples/file-input/assets/bindings/github.com/wailsapp/wails/v3/examples/file-input/index.js new file mode 100644 index 000000000..da3b98f1b --- /dev/null +++ b/v3/examples/file-input/assets/bindings/github.com/wailsapp/wails/v3/examples/file-input/index.js @@ -0,0 +1,8 @@ +// @ts-check +// Cynhyrchwyd y ffeil hon yn awtomatig. PEIDIWCH Â MODIWL +// This file is automatically generated. DO NOT EDIT + +import * as FileService from "./fileservice.js"; +export { + FileService +}; diff --git a/v3/examples/file-input/assets/bindings/github.com/wailsapp/wails/v3/internal/eventcreate.js b/v3/examples/file-input/assets/bindings/github.com/wailsapp/wails/v3/internal/eventcreate.js new file mode 100644 index 000000000..1ea105857 --- /dev/null +++ b/v3/examples/file-input/assets/bindings/github.com/wailsapp/wails/v3/internal/eventcreate.js @@ -0,0 +1,9 @@ +//@ts-check +// Cynhyrchwyd y ffeil hon yn awtomatig. PEIDIWCH Â MODIWL +// This file is automatically generated. DO NOT EDIT + +// eslint-disable-next-line @typescript-eslint/ban-ts-comment +// @ts-ignore: Unused imports +import { Create as $Create } from "@wailsio/runtime"; + +Object.freeze($Create.Events); diff --git a/v3/examples/file-input/assets/bindings/github.com/wailsapp/wails/v3/internal/eventdata.d.ts b/v3/examples/file-input/assets/bindings/github.com/wailsapp/wails/v3/internal/eventdata.d.ts new file mode 100644 index 000000000..3dd1807bd --- /dev/null +++ b/v3/examples/file-input/assets/bindings/github.com/wailsapp/wails/v3/internal/eventdata.d.ts @@ -0,0 +1,2 @@ +// Cynhyrchwyd y ffeil hon yn awtomatig. PEIDIWCH Â MODIWL +// This file is automatically generated. DO NOT EDIT diff --git a/v3/examples/file-input/assets/index.html b/v3/examples/file-input/assets/index.html new file mode 100644 index 000000000..8e2b298db --- /dev/null +++ b/v3/examples/file-input/assets/index.html @@ -0,0 +1,101 @@ + + + + File Input Test + + + + +

            File Input Test (#4862)

            +
            +
            +

            1. Single File

            + +
            +
            +

            2. Multiple Files

            + +
            +
            +

            3. Files or Directories

            + +
            +
            +

            4. Directory Only (Wails API)

            + +
            +
            +

            5. Filtered .txt (Wails API)

            + +
            +
            +
            Click a file input or button to test...
            + + + diff --git a/v3/examples/file-input/main.go b/v3/examples/file-input/main.go new file mode 100644 index 000000000..6342f3b38 --- /dev/null +++ b/v3/examples/file-input/main.go @@ -0,0 +1,69 @@ +package main + +import ( + "embed" + "log" + + "github.com/wailsapp/wails/v3/pkg/application" +) + +//go:embed assets/* +var assets embed.FS + +type FileService struct{} + +func (f *FileService) OpenDirectoryOnly() string { + result, err := application.Get().Dialog.OpenFile(). + CanChooseDirectories(true). + CanChooseFiles(false). + SetTitle("Select Directory"). + PromptForSingleSelection() + if err != nil { + return "Error: " + err.Error() + } + if result == "" { + return "Cancelled" + } + return result +} + +func (f *FileService) OpenFilteredFile() string { + result, err := application.Get().Dialog.OpenFile(). + SetTitle("Select Text File"). + AddFilter("Text Files", "*.txt"). + PromptForSingleSelection() + if err != nil { + return "Error: " + err.Error() + } + if result == "" { + return "Cancelled" + } + return result +} + +func main() { + app := application.New(application.Options{ + Name: "File Input Test", + Description: "Test for HTML file input (#4862)", + Mac: application.MacOptions{ + ApplicationShouldTerminateAfterLastWindowClosed: true, + }, + Services: []application.Service{ + application.NewService(&FileService{}), + }, + Assets: application.AssetOptions{ + Handler: application.BundledAssetFileServer(assets), + }, + }) + + app.Window.NewWithOptions(application.WebviewWindowOptions{ + Title: "File Input Test", + Width: 700, + Height: 500, + URL: "/", + }) + + if err := app.Run(); err != nil { + log.Fatal(err) + } +} diff --git a/v3/examples/frameless/README.md b/v3/examples/frameless/README.md new file mode 100644 index 000000000..f17f7a5d3 --- /dev/null +++ b/v3/examples/frameless/README.md @@ -0,0 +1,19 @@ +# Frameless Example + +This example is a demonstration of using frameless windows in Wails. + +## Running the example + +To run the example, simply run the following command: + +```bash +go run . +``` + +# Status + +| Platform | Status | +|----------|---------| +| Mac | Working | +| Windows | Working | +| Linux | | diff --git a/v3/examples/frameless/assets/index.html b/v3/examples/frameless/assets/index.html new file mode 100644 index 000000000..2776cfaa9 --- /dev/null +++ b/v3/examples/frameless/assets/index.html @@ -0,0 +1,53 @@ + + + + + + + + +
            +
            Draggable
            +
            Not Draggable
            +
            Not Draggable
            +
            Not Draggable
            +
            Draggable
            +
            + + diff --git a/v3/examples/frameless/main.go b/v3/examples/frameless/main.go new file mode 100644 index 000000000..93be412fd --- /dev/null +++ b/v3/examples/frameless/main.go @@ -0,0 +1,36 @@ +package main + +import ( + "embed" + _ "embed" + "log" + + "github.com/wailsapp/wails/v3/pkg/application" +) + +//go:embed assets +var assets embed.FS + +func main() { + + app := application.New(application.Options{ + Name: "Frameless Demo", + Description: "A demo of frameless windows", + Assets: application.AssetOptions{ + Handler: application.BundledAssetFileServer(assets), + }, + Mac: application.MacOptions{ + ApplicationShouldTerminateAfterLastWindowClosed: true, + }, + }) + + app.Window.NewWithOptions(application.WebviewWindowOptions{ + Frameless: true, + }) + + err := app.Run() + + if err != nil { + log.Fatal(err.Error()) + } +} diff --git a/v3/examples/gin-example/README.md b/v3/examples/gin-example/README.md new file mode 100644 index 000000000..b4d85cb9b --- /dev/null +++ b/v3/examples/gin-example/README.md @@ -0,0 +1,104 @@ +# Gin Example + +This example demonstrates how to use the [Gin web framework](https://github.com/gin-gonic/gin) with Wails. + +## Overview + +This example shows how to: + +- Set up Gin as the asset handler for a Wails application +- Create a middleware that routes requests between Wails and Gin +- Define API endpoints with Gin +- Communicate between the Gin-served frontend and Wails backend +- Implement custom Gin middleware + +## Running the Example + +```bash +cd v3/examples/gin-example +go mod tidy +go run . +``` + +## How It Works + +The example uses Gin's HTTP router to serve the frontend content whilst still allowing Wails to handle its internal routes. This is achieved through: + +1. Creating a Gin router with routes for the frontend +2. Implementing a middleware function that decides whether to pass requests to Gin or let Wails handle them +3. Configuring the Wails application to use both the Gin router as the asset handler and the custom middleware + +### Wails-Gin Integration + +The key part of the integration is the middleware function: + +```go +func GinMiddleware(ginEngine *gin.Engine) application.Middleware { + return func(next http.Handler) http.Handler { + return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { + // Let Wails handle its internal routes + if r.URL.Path == "/wails/runtime.js" || r.URL.Path == "/wails/ipc" { + next.ServeHTTP(w, r) + return + } + + // Let Gin handle everything else + ginEngine.ServeHTTP(w, r) + }) + } +} +``` + +This allows you to leverage Gin's powerful routing and middleware capabilities whilst still maintaining full access to Wails features. + +### Custom Gin Middleware + +The example also demonstrates how to create custom Gin middleware: + +```go +func LoggingMiddleware() gin.HandlerFunc { + return func(c *gin.Context) { + // Start timer + startTime := time.Now() + + // Process request + c.Next() + + // Calculate latency + latency := time.Since(startTime) + + // Log request details + log.Printf("[GIN] %s | %s | %s | %d | %s", + c.Request.Method, + c.Request.URL.Path, + c.ClientIP(), + c.Writer.Status(), + latency, + ) + } +} +``` + +This middleware is applied to all Gin routes and logs details about each request. + +### Application Configuration + +The Wails application is configured to use Gin as follows: + +```go +app := application.New(application.Options{ + Name: "Gin Example", + Description: "A demo of using Gin with Wails", + Mac: application.MacOptions{ + ApplicationShouldTerminateAfterLastWindowClosed: true, + }, + Assets: application.AssetOptions{ + Handler: ginEngine, + Middleware: GinMiddleware(ginEngine), + }, +}) +``` + +This configuration tells Wails to: +1. Use the Gin engine as the primary handler for HTTP requests +2. Use our custom middleware to route requests between Wails and Gin diff --git a/v3/examples/gin-example/go.mod b/v3/examples/gin-example/go.mod new file mode 100644 index 000000000..4badef3b4 --- /dev/null +++ b/v3/examples/gin-example/go.mod @@ -0,0 +1,75 @@ +module gin-example + +go 1.25 + +require ( + github.com/gin-gonic/gin v1.11.0 + github.com/wailsapp/wails/v3 v3.0.0 +) + +require ( + dario.cat/mergo v1.0.2 // indirect + github.com/Microsoft/go-winio v0.6.2 // indirect + github.com/ProtonMail/go-crypto v1.3.0 // indirect + github.com/adrg/xdg v0.5.3 // indirect + github.com/bep/debounce v1.2.1 // indirect + github.com/bytedance/gopkg v0.1.3 // indirect + github.com/bytedance/sonic v1.15.0 // indirect + github.com/bytedance/sonic/loader v0.5.0 // indirect + github.com/cloudflare/circl v1.6.3 // indirect + github.com/cloudwego/base64x v0.1.6 // indirect + github.com/coder/websocket v1.8.14 // indirect + github.com/cyphar/filepath-securejoin v0.6.1 // indirect + github.com/ebitengine/purego v0.9.1 // indirect + github.com/emirpasic/gods v1.18.1 // indirect + github.com/gabriel-vasile/mimetype v1.4.12 // indirect + github.com/gin-contrib/sse v1.1.0 // indirect + github.com/go-git/gcfg v1.5.1-0.20230307220236-3a3c6141e376 // indirect + github.com/go-git/go-billy/v5 v5.7.0 // indirect + github.com/go-git/go-git/v5 v5.16.4 // indirect + github.com/go-ole/go-ole v1.3.0 // indirect + github.com/go-playground/locales v0.14.1 // indirect + github.com/go-playground/universal-translator v0.18.1 // indirect + github.com/go-playground/validator/v10 v10.30.1 // indirect + github.com/goccy/go-json v0.10.5 // indirect + github.com/goccy/go-yaml v1.19.2 // indirect + github.com/godbus/dbus/v5 v5.2.2 // indirect + github.com/golang/groupcache v0.0.0-20241129210726-2c02b8208cf8 // indirect + github.com/google/uuid v1.6.0 // indirect + github.com/jbenet/go-context v0.0.0-20150711004518-d14ea06fba99 // indirect + github.com/jchv/go-winloader v0.0.0-20250406163304-c1995be93bd1 // indirect + github.com/json-iterator/go v1.1.12 // indirect + github.com/kevinburke/ssh_config v1.4.0 // indirect + github.com/klauspost/cpuid/v2 v2.3.0 // indirect + github.com/leaanthony/go-ansi-parser v1.6.1 // indirect + github.com/leaanthony/u v1.1.1 // indirect + github.com/leodido/go-urn v1.4.0 // indirect + github.com/lmittmann/tint v1.1.2 // indirect + github.com/mattn/go-colorable v0.1.14 // indirect + github.com/mattn/go-isatty v0.0.20 // indirect + github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd // indirect + github.com/modern-go/reflect2 v1.0.2 // indirect + github.com/pelletier/go-toml/v2 v2.2.4 // indirect + github.com/pjbgf/sha1cd v0.5.0 // indirect + github.com/pkg/browser v0.0.0-20240102092130-5ac0b6a4141c // indirect + github.com/quic-go/qpack v0.6.0 // indirect + github.com/quic-go/quic-go v0.59.0 // indirect + github.com/rivo/uniseg v0.4.7 // indirect + github.com/samber/lo v1.52.0 // indirect + github.com/sergi/go-diff v1.4.0 // indirect + github.com/skeema/knownhosts v1.3.2 // indirect + github.com/twitchyliquid64/golang-asm v0.15.1 // indirect + github.com/ugorji/go/codec v1.3.1 // indirect + github.com/wailsapp/go-webview2 v1.0.23 // indirect + github.com/xanzy/ssh-agent v0.3.3 // indirect + go.uber.org/mock v0.6.0 // indirect + golang.org/x/arch v0.23.0 // indirect + golang.org/x/crypto v0.47.0 // indirect + golang.org/x/net v0.49.0 // indirect + golang.org/x/sys v0.40.0 // indirect + golang.org/x/text v0.33.0 // indirect + google.golang.org/protobuf v1.36.11 // indirect + gopkg.in/warnings.v0 v0.1.2 // indirect +) + +replace github.com/wailsapp/wails/v3 => ../.. diff --git a/v3/examples/gin-example/go.sum b/v3/examples/gin-example/go.sum new file mode 100644 index 000000000..9ca8a1297 --- /dev/null +++ b/v3/examples/gin-example/go.sum @@ -0,0 +1,208 @@ +dario.cat/mergo v1.0.2 h1:85+piFYR1tMbRrLcDwR18y4UKJ3aH1Tbzi24VRW1TK8= +dario.cat/mergo v1.0.2/go.mod h1:E/hbnu0NxMFBjpMIE34DRGLWqDy0g5FuKDhCb31ngxA= +github.com/Microsoft/go-winio v0.5.2/go.mod h1:WpS1mjBmmwHBEWmogvA2mj8546UReBk4v8QkMxJ6pZY= +github.com/Microsoft/go-winio v0.6.2 h1:F2VQgta7ecxGYO8k3ZZz3RS8fVIXVxONVUPlNERoyfY= +github.com/Microsoft/go-winio v0.6.2/go.mod h1:yd8OoFMLzJbo9gZq8j5qaps8bJ9aShtEA8Ipt1oGCvU= +github.com/ProtonMail/go-crypto v1.3.0 h1:ILq8+Sf5If5DCpHQp4PbZdS1J7HDFRXz/+xKBiRGFrw= +github.com/ProtonMail/go-crypto v1.3.0/go.mod h1:9whxjD8Rbs29b4XWbB8irEcE8KHMqaR2e7GWU1R+/PE= +github.com/adrg/xdg v0.5.3 h1:xRnxJXne7+oWDatRhR1JLnvuccuIeCoBu2rtuLqQB78= +github.com/adrg/xdg v0.5.3/go.mod h1:nlTsY+NNiCBGCK2tpm09vRqfVzrc2fLmXGpBLF0zlTQ= +github.com/anmitsu/go-shlex v0.0.0-20200514113438-38f4b401e2be h1:9AeTilPcZAjCFIImctFaOjnTIavg87rW78vTPkQqLI8= +github.com/anmitsu/go-shlex v0.0.0-20200514113438-38f4b401e2be/go.mod h1:ySMOLuWl6zY27l47sB3qLNK6tF2fkHG55UZxx8oIVo4= +github.com/armon/go-socks5 v0.0.0-20160902184237-e75332964ef5 h1:0CwZNZbxp69SHPdPJAN/hZIm0C4OItdklCFmMRWYpio= +github.com/armon/go-socks5 v0.0.0-20160902184237-e75332964ef5/go.mod h1:wHh0iHkYZB8zMSxRWpUBQtwG5a7fFgvEO+odwuTv2gs= +github.com/bep/debounce v1.2.1 h1:v67fRdBA9UQu2NhLFXrSg0Brw7CexQekrBwDMM8bzeY= +github.com/bep/debounce v1.2.1/go.mod h1:H8yggRPQKLUhUoqrJC1bO2xNya7vanpDl7xR3ISbCJ0= +github.com/bytedance/gopkg v0.1.3 h1:TPBSwH8RsouGCBcMBktLt1AymVo2TVsBVCY4b6TnZ/M= +github.com/bytedance/gopkg v0.1.3/go.mod h1:576VvJ+eJgyCzdjS+c4+77QF3p7ubbtiKARP3TxducM= +github.com/bytedance/sonic v1.15.0 h1:/PXeWFaR5ElNcVE84U0dOHjiMHQOwNIx3K4ymzh/uSE= +github.com/bytedance/sonic v1.15.0/go.mod h1:tFkWrPz0/CUCLEF4ri4UkHekCIcdnkqXw9VduqpJh0k= +github.com/bytedance/sonic/loader v0.5.0 h1:gXH3KVnatgY7loH5/TkeVyXPfESoqSBSBEiDd5VjlgE= +github.com/bytedance/sonic/loader v0.5.0/go.mod h1:AR4NYCk5DdzZizZ5djGqQ92eEhCCcdf5x77udYiSJRo= +github.com/cloudflare/circl v1.6.3 h1:9GPOhQGF9MCYUeXyMYlqTR6a5gTrgR/fBLXvUgtVcg8= +github.com/cloudflare/circl v1.6.3/go.mod h1:2eXP6Qfat4O/Yhh8BznvKnJ+uzEoTQ6jVKJRn81BiS4= +github.com/cloudwego/base64x v0.1.6 h1:t11wG9AECkCDk5fMSoxmufanudBtJ+/HemLstXDLI2M= +github.com/cloudwego/base64x v0.1.6/go.mod h1:OFcloc187FXDaYHvrNIjxSe8ncn0OOM8gEHfghB2IPU= +github.com/coder/websocket v1.8.14 h1:9L0p0iKiNOibykf283eHkKUHHrpG7f65OE3BhhO7v9g= +github.com/coder/websocket v1.8.14/go.mod h1:NX3SzP+inril6yawo5CQXx8+fk145lPDC6pumgx0mVg= +github.com/cyphar/filepath-securejoin v0.6.1 h1:5CeZ1jPXEiYt3+Z6zqprSAgSWiggmpVyciv8syjIpVE= +github.com/cyphar/filepath-securejoin v0.6.1/go.mod h1:A8hd4EnAeyujCJRrICiOWqjS1AX0a9kM5XL+NwKoYSc= +github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= +github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c= +github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= +github.com/ebitengine/purego v0.9.1 h1:a/k2f2HQU3Pi399RPW1MOaZyhKJL9w/xFpKAg4q1s0A= +github.com/ebitengine/purego v0.9.1/go.mod h1:iIjxzd6CiRiOG0UyXP+V1+jWqUXVjPKLAI0mRfJZTmQ= +github.com/elazarl/goproxy v1.7.2 h1:Y2o6urb7Eule09PjlhQRGNsqRfPmYI3KKQLFpCAV3+o= +github.com/elazarl/goproxy v1.7.2/go.mod h1:82vkLNir0ALaW14Rc399OTTjyNREgmdL2cVoIbS6XaE= +github.com/emirpasic/gods v1.18.1 h1:FXtiHYKDGKCW2KzwZKx0iC0PQmdlorYgdFG9jPXJ1Bc= +github.com/emirpasic/gods v1.18.1/go.mod h1:8tpGGwCnJ5H4r6BWwaV6OrWmMoPhUl5jm/FMNAnJvWQ= +github.com/gabriel-vasile/mimetype v1.4.12 h1:e9hWvmLYvtp846tLHam2o++qitpguFiYCKbn0w9jyqw= +github.com/gabriel-vasile/mimetype v1.4.12/go.mod h1:d+9Oxyo1wTzWdyVUPMmXFvp4F9tea18J8ufA774AB3s= +github.com/gin-contrib/sse v1.1.0 h1:n0w2GMuUpWDVp7qSpvze6fAu9iRxJY4Hmj6AmBOU05w= +github.com/gin-contrib/sse v1.1.0/go.mod h1:hxRZ5gVpWMT7Z0B0gSNYqqsSCNIJMjzvm6fqCz9vjwM= +github.com/gin-gonic/gin v1.11.0 h1:OW/6PLjyusp2PPXtyxKHU0RbX6I/l28FTdDlae5ueWk= +github.com/gin-gonic/gin v1.11.0/go.mod h1:+iq/FyxlGzII0KHiBGjuNn4UNENUlKbGlNmc+W50Dls= +github.com/gliderlabs/ssh v0.3.8 h1:a4YXD1V7xMF9g5nTkdfnja3Sxy1PVDCj1Zg4Wb8vY6c= +github.com/gliderlabs/ssh v0.3.8/go.mod h1:xYoytBv1sV0aL3CavoDuJIQNURXkkfPA/wxQ1pL1fAU= +github.com/go-git/gcfg v1.5.1-0.20230307220236-3a3c6141e376 h1:+zs/tPmkDkHx3U66DAb0lQFJrpS6731Oaa12ikc+DiI= +github.com/go-git/gcfg v1.5.1-0.20230307220236-3a3c6141e376/go.mod h1:an3vInlBmSxCcxctByoQdvwPiA7DTK7jaaFDBTtu0ic= +github.com/go-git/go-billy/v5 v5.7.0 h1:83lBUJhGWhYp0ngzCMSgllhUSuoHP1iEWYjsPl9nwqM= +github.com/go-git/go-billy/v5 v5.7.0/go.mod h1:/1IUejTKH8xipsAcdfcSAlUlo2J7lkYV8GTKxAT/L3E= +github.com/go-git/go-git-fixtures/v4 v4.3.2-0.20231010084843-55a94097c399 h1:eMje31YglSBqCdIqdhKBW8lokaMrL3uTkpGYlE2OOT4= +github.com/go-git/go-git-fixtures/v4 v4.3.2-0.20231010084843-55a94097c399/go.mod h1:1OCfN199q1Jm3HZlxleg+Dw/mwps2Wbk9frAWm+4FII= +github.com/go-git/go-git/v5 v5.16.4 h1:7ajIEZHZJULcyJebDLo99bGgS0jRrOxzZG4uCk2Yb2Y= +github.com/go-git/go-git/v5 v5.16.4/go.mod h1:4Ge4alE/5gPs30F2H1esi2gPd69R0C39lolkucHBOp8= +github.com/go-json-experiment/json v0.0.0-20251027170946-4849db3c2f7e h1:Lf/gRkoycfOBPa42vU2bbgPurFong6zXeFtPoxholzU= +github.com/go-json-experiment/json v0.0.0-20251027170946-4849db3c2f7e/go.mod h1:uNVvRXArCGbZ508SxYYTC5v1JWoz2voff5pm25jU1Ok= +github.com/go-ole/go-ole v1.3.0 h1:Dt6ye7+vXGIKZ7Xtk4s6/xVdGDQynvom7xCFEdWr6uE= +github.com/go-ole/go-ole v1.3.0/go.mod h1:5LS6F96DhAwUc7C+1HLexzMXY1xGRSryjyPPKW6zv78= +github.com/go-playground/assert/v2 v2.2.0 h1:JvknZsQTYeFEAhQwI4qEt9cyV5ONwRHC+lYKSsYSR8s= +github.com/go-playground/assert/v2 v2.2.0/go.mod h1:VDjEfimB/XKnb+ZQfWdccd7VUvScMdVu0Titje2rxJ4= +github.com/go-playground/locales v0.14.1 h1:EWaQ/wswjilfKLTECiXz7Rh+3BjFhfDFKv/oXslEjJA= +github.com/go-playground/locales v0.14.1/go.mod h1:hxrqLVvrK65+Rwrd5Fc6F2O76J/NuW9t0sjnWqG1slY= +github.com/go-playground/universal-translator v0.18.1 h1:Bcnm0ZwsGyWbCzImXv+pAJnYK9S473LQFuzCbDbfSFY= +github.com/go-playground/universal-translator v0.18.1/go.mod h1:xekY+UJKNuX9WP91TpwSH2VMlDf28Uj24BCp08ZFTUY= +github.com/go-playground/validator/v10 v10.30.1 h1:f3zDSN/zOma+w6+1Wswgd9fLkdwy06ntQJp0BBvFG0w= +github.com/go-playground/validator/v10 v10.30.1/go.mod h1:oSuBIQzuJxL//3MelwSLD5hc2Tu889bF0Idm9Dg26cM= +github.com/goccy/go-json v0.10.5 h1:Fq85nIqj+gXn/S5ahsiTlK3TmC85qgirsdTP/+DeaC4= +github.com/goccy/go-json v0.10.5/go.mod h1:oq7eo15ShAhp70Anwd5lgX2pLfOS3QCiwU/PULtXL6M= +github.com/goccy/go-yaml v1.19.2 h1:PmFC1S6h8ljIz6gMRBopkjP1TVT7xuwrButHID66PoM= +github.com/goccy/go-yaml v1.19.2/go.mod h1:XBurs7gK8ATbW4ZPGKgcbrY1Br56PdM69F7LkFRi1kA= +github.com/godbus/dbus/v5 v5.2.2 h1:TUR3TgtSVDmjiXOgAAyaZbYmIeP3DPkld3jgKGV8mXQ= +github.com/godbus/dbus/v5 v5.2.2/go.mod h1:3AAv2+hPq5rdnr5txxxRwiGjPXamgoIHgz9FPBfOp3c= +github.com/golang/groupcache v0.0.0-20241129210726-2c02b8208cf8 h1:f+oWsMOmNPc8JmEHVZIycC7hBoQxHH9pNKQORJNozsQ= +github.com/golang/groupcache v0.0.0-20241129210726-2c02b8208cf8/go.mod h1:wcDNUvekVysuuOpQKo3191zZyTpiI6se1N1ULghS0sw= +github.com/google/go-cmp v0.7.0 h1:wk8382ETsv4JYUZwIsn6YpYiWiBsYLSJiTsyBybVuN8= +github.com/google/go-cmp v0.7.0/go.mod h1:pXiqmnSA92OHEEa9HXL2W4E7lf9JzCmGVUdgjX3N/iU= +github.com/google/gofuzz v1.0.0/go.mod h1:dBl0BpW6vV/+mYPU4Po3pmUjxk6FQPldtuIdl/M65Eg= +github.com/google/uuid v1.6.0 h1:NIvaJDMOsjHA8n1jAhLSgzrAzy1Hgr+hNrb57e+94F0= +github.com/google/uuid v1.6.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo= +github.com/jbenet/go-context v0.0.0-20150711004518-d14ea06fba99 h1:BQSFePA1RWJOlocH6Fxy8MmwDt+yVQYULKfN0RoTN8A= +github.com/jbenet/go-context v0.0.0-20150711004518-d14ea06fba99/go.mod h1:1lJo3i6rXxKeerYnT8Nvf0QmHCRC1n8sfWVwXF2Frvo= +github.com/jchv/go-winloader v0.0.0-20250406163304-c1995be93bd1 h1:njuLRcjAuMKr7kI3D85AXWkw6/+v9PwtV6M6o11sWHQ= +github.com/jchv/go-winloader v0.0.0-20250406163304-c1995be93bd1/go.mod h1:alcuEEnZsY1WQsagKhZDsoPCRoOijYqhZvPwLG0kzVs= +github.com/json-iterator/go v1.1.12 h1:PV8peI4a0ysnczrg+LtxykD8LfKY9ML6u2jnxaEnrnM= +github.com/json-iterator/go v1.1.12/go.mod h1:e30LSqwooZae/UwlEbR2852Gd8hjQvJoHmT4TnhNGBo= +github.com/kevinburke/ssh_config v1.4.0 h1:6xxtP5bZ2E4NF5tuQulISpTO2z8XbtH8cg1PWkxoFkQ= +github.com/kevinburke/ssh_config v1.4.0/go.mod h1:q2RIzfka+BXARoNexmF9gkxEX7DmvbW9P4hIVx2Kg4M= +github.com/klauspost/cpuid/v2 v2.3.0 h1:S4CRMLnYUhGeDFDqkGriYKdfoFlDnMtqTiI/sFzhA9Y= +github.com/klauspost/cpuid/v2 v2.3.0/go.mod h1:hqwkgyIinND0mEev00jJYCxPNVRVXFQeu1XKlok6oO0= +github.com/kr/pretty v0.1.0/go.mod h1:dAy3ld7l9f0ibDNOQOHHMYYIIbhfbHSm3C4ZsoJORNo= +github.com/kr/pretty v0.3.1 h1:flRD4NNwYAUpkphVc1HcthR4KEIFJ65n8Mw5qdRn3LE= +github.com/kr/pretty v0.3.1/go.mod h1:hoEshYVHaxMs3cyo3Yncou5ZscifuDolrwPKZanG3xk= +github.com/kr/pty v1.1.1/go.mod h1:pFQYn66WHrOpPYNljwOMqo10TkYh1fy3cYio2l3bCsQ= +github.com/kr/text v0.1.0/go.mod h1:4Jbv+DJW3UT/LiOwJeYQe1efqtUx/iVham/4vfdArNI= +github.com/kr/text v0.2.0 h1:5Nx0Ya0ZqY2ygV366QzturHI13Jq95ApcVaJBhpS+AY= +github.com/kr/text v0.2.0/go.mod h1:eLer722TekiGuMkidMxC/pM04lWEeraHUUmBw8l2grE= +github.com/leaanthony/go-ansi-parser v1.6.1 h1:xd8bzARK3dErqkPFtoF9F3/HgN8UQk0ed1YDKpEz01A= +github.com/leaanthony/go-ansi-parser v1.6.1/go.mod h1:+vva/2y4alzVmmIEpk9QDhA7vLC5zKDTRwfZGOp3IWU= +github.com/leaanthony/u v1.1.1 h1:TUFjwDGlNX+WuwVEzDqQwC2lOv0P4uhTQw7CMFdiK7M= +github.com/leaanthony/u v1.1.1/go.mod h1:9+o6hejoRljvZ3BzdYlVL0JYCwtnAsVuN9pVTQcaRfI= +github.com/leodido/go-urn v1.4.0 h1:WT9HwE9SGECu3lg4d/dIA+jxlljEa1/ffXKmRjqdmIQ= +github.com/leodido/go-urn v1.4.0/go.mod h1:bvxc+MVxLKB4z00jd1z+Dvzr47oO32F/QSNjSBOlFxI= +github.com/lmittmann/tint v1.1.2 h1:2CQzrL6rslrsyjqLDwD11bZ5OpLBPU+g3G/r5LSfS8w= +github.com/lmittmann/tint v1.1.2/go.mod h1:HIS3gSy7qNwGCj+5oRjAutErFBl4BzdQP6cJZ0NfMwE= +github.com/matryer/is v1.4.0/go.mod h1:8I/i5uYgLzgsgEloJE1U6xx5HkBQpAZvepWuujKwMRU= +github.com/matryer/is v1.4.1 h1:55ehd8zaGABKLXQUe2awZ99BD/PTc2ls+KV/dXphgEQ= +github.com/matryer/is v1.4.1/go.mod h1:8I/i5uYgLzgsgEloJE1U6xx5HkBQpAZvepWuujKwMRU= +github.com/mattn/go-colorable v0.1.14 h1:9A9LHSqF/7dyVVX6g0U9cwm9pG3kP9gSzcuIPHPsaIE= +github.com/mattn/go-colorable v0.1.14/go.mod h1:6LmQG8QLFO4G5z1gPvYEzlUgJ2wF+stgPZH1UqBm1s8= +github.com/mattn/go-isatty v0.0.20 h1:xfD0iDuEKnDkl03q4limB+vH+GxLEtL/jb4xVJSWWEY= +github.com/mattn/go-isatty v0.0.20/go.mod h1:W+V8PltTTMOvKvAeJH7IuucS94S2C6jfK/D7dTCTo3Y= +github.com/modern-go/concurrent v0.0.0-20180228061459-e0a39a4cb421/go.mod h1:6dJC0mAP4ikYIbvyc7fijjWJddQyLn8Ig3JB5CqoB9Q= +github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd h1:TRLaZ9cD/w8PVh93nsPXa1VrQ6jlwL5oN8l14QlcNfg= +github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd/go.mod h1:6dJC0mAP4ikYIbvyc7fijjWJddQyLn8Ig3JB5CqoB9Q= +github.com/modern-go/reflect2 v1.0.2 h1:xBagoLtFs94CBntxluKeaWgTMpvLxC4ur3nMaC9Gz0M= +github.com/modern-go/reflect2 v1.0.2/go.mod h1:yWuevngMOJpCy52FWWMvUC8ws7m/LJsjYzDa0/r8luk= +github.com/onsi/gomega v1.34.1 h1:EUMJIKUjM8sKjYbtxQI9A4z2o+rruxnzNvpknOXie6k= +github.com/onsi/gomega v1.34.1/go.mod h1:kU1QgUvBDLXBJq618Xvm2LUX6rSAfRaFRTcdOeDLwwY= +github.com/pelletier/go-toml/v2 v2.2.4 h1:mye9XuhQ6gvn5h28+VilKrrPoQVanw5PMw/TB0t5Ec4= +github.com/pelletier/go-toml/v2 v2.2.4/go.mod h1:2gIqNv+qfxSVS7cM2xJQKtLSTLUE9V8t9Stt+h56mCY= +github.com/pjbgf/sha1cd v0.5.0 h1:a+UkboSi1znleCDUNT3M5YxjOnN1fz2FhN48FlwCxs0= +github.com/pjbgf/sha1cd v0.5.0/go.mod h1:lhpGlyHLpQZoxMv8HcgXvZEhcGs0PG/vsZnEJ7H0iCM= +github.com/pkg/browser v0.0.0-20240102092130-5ac0b6a4141c h1:+mdjkGKdHQG3305AYmdv1U2eRNDiU2ErMBj1gwrq8eQ= +github.com/pkg/browser v0.0.0-20240102092130-5ac0b6a4141c/go.mod h1:7rwL4CYBLnjLxUqIJNnCWiEdr3bn6IUYi15bNlnbCCU= +github.com/pkg/errors v0.9.1 h1:FEBLx1zS214owpjy7qsBeixbURkuhQAwrK5UwLGTwt4= +github.com/pkg/errors v0.9.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0= +github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM= +github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= +github.com/quic-go/qpack v0.6.0 h1:g7W+BMYynC1LbYLSqRt8PBg5Tgwxn214ZZR34VIOjz8= +github.com/quic-go/qpack v0.6.0/go.mod h1:lUpLKChi8njB4ty2bFLX2x4gzDqXwUpaO1DP9qMDZII= +github.com/quic-go/quic-go v0.59.0 h1:OLJkp1Mlm/aS7dpKgTc6cnpynnD2Xg7C1pwL6vy/SAw= +github.com/quic-go/quic-go v0.59.0/go.mod h1:upnsH4Ju1YkqpLXC305eW3yDZ4NfnNbmQRCMWS58IKU= +github.com/rivo/uniseg v0.2.0/go.mod h1:J6wj4VEh+S6ZtnVlnTBMWIodfgj8LQOQFoIToxlJtxc= +github.com/rivo/uniseg v0.4.7 h1:WUdvkW8uEhrYfLC4ZzdpI2ztxP1I582+49Oc5Mq64VQ= +github.com/rivo/uniseg v0.4.7/go.mod h1:FN3SvrM+Zdj16jyLfmOkMNblXMcoc8DfTHruCPUcx88= +github.com/rogpeppe/go-internal v1.14.1 h1:UQB4HGPB6osV0SQTLymcB4TgvyWu6ZyliaW0tI/otEQ= +github.com/rogpeppe/go-internal v1.14.1/go.mod h1:MaRKkUm5W0goXpeCfT7UZI6fk/L7L7so1lCWt35ZSgc= +github.com/samber/lo v1.52.0 h1:Rvi+3BFHES3A8meP33VPAxiBZX/Aws5RxrschYGjomw= +github.com/samber/lo v1.52.0/go.mod h1:4+MXEGsJzbKGaUEQFKBq2xtfuznW9oz/WrgyzMzRoM0= +github.com/sergi/go-diff v1.4.0 h1:n/SP9D5ad1fORl+llWyN+D6qoUETXNZARKjyY2/KVCw= +github.com/sergi/go-diff v1.4.0/go.mod h1:A0bzQcvG0E7Rwjx0REVgAGH58e96+X0MeOfepqsbeW4= +github.com/sirupsen/logrus v1.7.0/go.mod h1:yWOB1SBYBC5VeMP7gHvWumXLIWorT60ONWic61uBYv0= +github.com/skeema/knownhosts v1.3.2 h1:EDL9mgf4NzwMXCTfaxSD/o/a5fxDw/xL9nkU28JjdBg= +github.com/skeema/knownhosts v1.3.2/go.mod h1:bEg3iQAuw+jyiw+484wwFJoKSLwcfd7fqRy+N0QTiow= +github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME= +github.com/stretchr/objx v0.4.0/go.mod h1:YvHI0jy2hoMjB+UWwv71VJQ9isScKT/TqJzVSSt89Yw= +github.com/stretchr/objx v0.5.0/go.mod h1:Yh+to48EsGEfYuaHDzXPcE3xhTkx73EhmCGUpEOglKo= +github.com/stretchr/objx v0.5.2/go.mod h1:FRsXN1f5AsAjCGJKqEizvkpNtU+EGNCLh3NxZ/8L+MA= +github.com/stretchr/testify v1.2.2/go.mod h1:a8OnRcib4nhh0OaRAV+Yts87kKdq0PP7pXfy6kDkUVs= +github.com/stretchr/testify v1.3.0/go.mod h1:M5WIy9Dh21IEIfnGCwXGc5bZfKNJtfHm1UVUgZn+9EI= +github.com/stretchr/testify v1.4.0/go.mod h1:j7eGeouHqKxXV5pUuKE4zz7dFj8WfuZ+81PSLYec5m4= +github.com/stretchr/testify v1.7.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg= +github.com/stretchr/testify v1.8.0/go.mod h1:yNjHg4UonilssWZ8iaSj1OCr/vHnekPRkoO+kdMU+MU= +github.com/stretchr/testify v1.8.4/go.mod h1:sz/lmYIOXD/1dqDmKjjqLyZ2RngseejIcXlSw2iwfAo= +github.com/stretchr/testify v1.10.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY= +github.com/stretchr/testify v1.11.1 h1:7s2iGBzp5EwR7/aIZr8ao5+dra3wiQyKjjFuvgVKu7U= +github.com/stretchr/testify v1.11.1/go.mod h1:wZwfW3scLgRK+23gO65QZefKpKQRnfz6sD981Nm4B6U= +github.com/twitchyliquid64/golang-asm v0.15.1 h1:SU5vSMR7hnwNxj24w34ZyCi/FmDZTkS4MhqMhdFk5YI= +github.com/twitchyliquid64/golang-asm v0.15.1/go.mod h1:a1lVb/DtPvCB8fslRZhAngC2+aY1QWCk3Cedj/Gdt08= +github.com/ugorji/go/codec v1.3.1 h1:waO7eEiFDwidsBN6agj1vJQ4AG7lh2yqXyOXqhgQuyY= +github.com/ugorji/go/codec v1.3.1/go.mod h1:pRBVtBSKl77K30Bv8R2P+cLSGaTtex6fsA2Wjqmfxj4= +github.com/wailsapp/go-webview2 v1.0.23 h1:jmv8qhz1lHibCc79bMM/a/FqOnnzOGEisLav+a0b9P0= +github.com/wailsapp/go-webview2 v1.0.23/go.mod h1:qJmWAmAmaniuKGZPWwne+uor3AHMB5PFhqiK0Bbj8kc= +github.com/xanzy/ssh-agent v0.3.3 h1:+/15pJfg/RsTxqYcX6fHqOXZwwMP+2VyYWJeWM2qQFM= +github.com/xanzy/ssh-agent v0.3.3/go.mod h1:6dzNDKs0J9rVPHPhaGCukekBHKqfl+L3KghI1Bc68Uw= +go.uber.org/mock v0.6.0 h1:hyF9dfmbgIX5EfOdasqLsWD6xqpNZlXblLB/Dbnwv3Y= +go.uber.org/mock v0.6.0/go.mod h1:KiVJ4BqZJaMj4svdfmHM0AUx4NJYO8ZNpPnZn1Z+BBU= +golang.org/x/arch v0.23.0 h1:lKF64A2jF6Zd8L0knGltUnegD62JMFBiCPBmQpToHhg= +golang.org/x/arch v0.23.0/go.mod h1:dNHoOeKiyja7GTvF9NJS1l3Z2yntpQNzgrjh1cU103A= +golang.org/x/crypto v0.0.0-20220622213112-05595931fe9d/go.mod h1:IxCIyHEi3zRg3s0A5j5BB6A9Jmi73HwBIUl50j+osU4= +golang.org/x/crypto v0.47.0 h1:V6e3FRj+n4dbpw86FJ8Fv7XVOql7TEwpHapKoMJ/GO8= +golang.org/x/crypto v0.47.0/go.mod h1:ff3Y9VzzKbwSSEzWqJsJVBnWmRwRSHt/6Op5n9bQc4A= +golang.org/x/exp v0.0.0-20260112195511-716be5621a96 h1:Z/6YuSHTLOHfNFdb8zVZomZr7cqNgTJvA8+Qz75D8gU= +golang.org/x/exp v0.0.0-20260112195511-716be5621a96/go.mod h1:nzimsREAkjBCIEFtHiYkrJyT+2uy9YZJB7H1k68CXZU= +golang.org/x/net v0.0.0-20211112202133-69e39bad7dc2/go.mod h1:9nx3DQGgdP8bBQD5qxJ1jj9UTztislL4KSBs9R2vV5Y= +golang.org/x/net v0.49.0 h1:eeHFmOGUTtaaPSGNmjBKpbng9MulQsJURQUAfUwY++o= +golang.org/x/net v0.49.0/go.mod h1:/ysNB2EvaqvesRkuLAyjI1ycPZlQHM3q01F02UY/MV8= +golang.org/x/sys v0.0.0-20191026070338-33540a1f6037/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20200810151505-1b9f1253b3ed/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20201119102817-f84b799fce68/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20210124154548-22da62e12c0c/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20210423082822-04245dca01da/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20210615035016-665e8c7367d1/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.0.0-20220715151400-c0bba94af5f8/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.1.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.6.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.40.0 h1:DBZZqJ2Rkml6QMQsZywtnjnnGvHza6BTfYFWY9kjEWQ= +golang.org/x/sys v0.40.0/go.mod h1:OgkHotnGiDImocRcuBABYBEXf8A9a87e/uXjp9XT3ks= +golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo= +golang.org/x/term v0.39.0 h1:RclSuaJf32jOqZz74CkPA9qFuVTX7vhLlpfj/IGWlqY= +golang.org/x/term v0.39.0/go.mod h1:yxzUCTP/U+FzoxfdKmLaA0RV1WgE0VY7hXBwKtY/4ww= +golang.org/x/text v0.3.6/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ= +golang.org/x/text v0.33.0 h1:B3njUFyqtHDUI5jMn1YIr5B0IE2U0qck04r6d4KPAxE= +golang.org/x/text v0.33.0/go.mod h1:LuMebE6+rBincTi9+xWTY8TztLzKHc/9C1uBCG27+q8= +golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ= +google.golang.org/protobuf v1.36.11 h1:fV6ZwhNocDyBLK0dj+fg8ektcVegBBuEolpbTQyBNVE= +google.golang.org/protobuf v1.36.11/go.mod h1:HTf+CrKn2C3g5S8VImy6tdcUvCska2kB7j23XfzDpco= +gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= +gopkg.in/check.v1 v1.0.0-20190902080502-41f04d3bba15/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= +gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c h1:Hei/4ADfdWqJk1ZMxUNpqntNwaWcugrBjAiHlqqRiVk= +gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c/go.mod h1:JHkPIbrfpd72SG/EVd6muEfDQjcINNoR0C8j2r3qZ4Q= +gopkg.in/warnings.v0 v0.1.2 h1:wFXVbFY8DY5/xOe1ECiWdKCzZlxgshcYVNkBHstARME= +gopkg.in/warnings.v0 v0.1.2/go.mod h1:jksf8JmL6Qr/oQM2OXTHunEvvTAsrWBLb6OOjuVWRNI= +gopkg.in/yaml.v2 v2.2.2/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI= +gopkg.in/yaml.v2 v2.4.0/go.mod h1:RDklbk79AGWmwhnvt/jBztapEOGDOx6ZbXqjP6csGnQ= +gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= +gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA= +gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= diff --git a/v3/examples/gin-example/main.go b/v3/examples/gin-example/main.go new file mode 100644 index 000000000..8138d5403 --- /dev/null +++ b/v3/examples/gin-example/main.go @@ -0,0 +1,116 @@ +package main + +import ( + "embed" + "log" + "net/http" + "strings" + "time" + + "github.com/gin-gonic/gin" + "github.com/wailsapp/wails/v3/pkg/application" +) + +//go:embed static +var staticFiles embed.FS + +// GinMiddleware creates a middleware that passes requests to Gin if they're not handled by Wails +func GinMiddleware(ginEngine *gin.Engine) application.Middleware { + return func(next http.Handler) http.Handler { + return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { + // Let Wails handle the `/wails` route + if strings.HasPrefix(r.URL.Path, "/wails") { + next.ServeHTTP(w, r) + return + } + // Let Gin handle everything else + ginEngine.ServeHTTP(w, r) + }) + } +} + +// LoggingMiddleware is a Gin middleware that logs request details +func LoggingMiddleware() gin.HandlerFunc { + return func(c *gin.Context) { + // Start timer + startTime := time.Now() + + // Process request + c.Next() + + // Calculate latency + latency := time.Since(startTime) + + // Log request details + log.Printf("[GIN] %s | %s | %s | %d | %s", + c.Request.Method, + c.Request.URL.Path, + c.ClientIP(), + c.Writer.Status(), + latency, + ) + } +} + +func main() { + // Create a new Gin router + ginEngine := gin.New() // Using New() instead of Default() to add our own middleware + + // Add middlewares + ginEngine.Use(gin.Recovery()) + ginEngine.Use(LoggingMiddleware()) + + // Serve embedded static files + ginEngine.StaticFS("/static", http.FS(staticFiles)) + + // Define routes + ginEngine.GET("/", func(c *gin.Context) { + file, err := staticFiles.ReadFile("static/index.html") + if err != nil { + c.String(http.StatusInternalServerError, "Error reading index.html") + return + } + c.Data(http.StatusOK, "text/html; charset=utf-8", file) + }) + + ginEngine.GET("/api/hello", func(c *gin.Context) { + c.JSON(http.StatusOK, gin.H{ + "message": "Hello from Gin API!", + "time": time.Now().Format(time.RFC3339), + }) + }) + + // Create a new Wails application + app := application.New(application.Options{ + Name: "Gin Example", + Description: "A demo of using Gin with Wails", + Mac: application.MacOptions{ + ApplicationShouldTerminateAfterLastWindowClosed: true, + }, + Assets: application.AssetOptions{ + Handler: ginEngine, + Middleware: GinMiddleware(ginEngine), + }, + }) + + // Register event handler and store cleanup function + removeGinHandler := app.Event.On("gin-button-clicked", func(event *application.CustomEvent) { + log.Printf("Received event from frontend: %v", event.Data) + }) + // Note: In production, call removeGinHandler() during cleanup + _ = removeGinHandler + + // Create window + app.Window.NewWithOptions(application.WebviewWindowOptions{ + Title: "Wails + Gin Example", + Width: 900, + Height: 700, + URL: "/", + }) + + // Run the app + err := app.Run() + if err != nil { + log.Fatal(err) + } +} diff --git a/v3/examples/gin-example/static/index.html b/v3/examples/gin-example/static/index.html new file mode 100644 index 000000000..df02b840f --- /dev/null +++ b/v3/examples/gin-example/static/index.html @@ -0,0 +1,96 @@ + + + Wails + Gin Example + + + +
            +

            Wails + Gin Integration

            +
            +

            Hello World!

            +

            This page is being served by Gin.

            +

            Click the button below to trigger a Wails event:

            + + +
            +
            +

            API Example

            +

            Try the Gin API endpoint:

            + +
            +
            +
            + + + diff --git a/v3/examples/gin-routing/README.md b/v3/examples/gin-routing/README.md new file mode 100644 index 000000000..5d8babc31 --- /dev/null +++ b/v3/examples/gin-routing/README.md @@ -0,0 +1,26 @@ +# Gin Routing Example + +This example demonstrates how to use the [Gin web framework](https://github.com/gin-gonic/gin) as a router with Wails. + +## Overview + +This example shows how to: + +- Set up Gin as the asset handler for a Wails application +- Create a middleware that routes requests between Wails and Gin +- Define API endpoints with Gin +- Communicate between the Gin-served frontend and Wails backend +- Implement custom Gin middleware + +## Running the Example + +```bash +cd v3/examples/gin-routing +go mod tidy +go run . +``` + +## Documentation + +Please consult the [Using Gin for Routing](https://v3.wails.io/guides/gin-routing/) guide for a detailed explanation of the example. + diff --git a/v3/examples/gin-routing/go.mod b/v3/examples/gin-routing/go.mod new file mode 100644 index 000000000..41069befd --- /dev/null +++ b/v3/examples/gin-routing/go.mod @@ -0,0 +1,75 @@ +module gin-routing + +go 1.25 + +require ( + github.com/gin-gonic/gin v1.11.0 + github.com/wailsapp/wails/v3 v3.0.0 +) + +require ( + dario.cat/mergo v1.0.2 // indirect + github.com/Microsoft/go-winio v0.6.2 // indirect + github.com/ProtonMail/go-crypto v1.3.0 // indirect + github.com/adrg/xdg v0.5.3 // indirect + github.com/bep/debounce v1.2.1 // indirect + github.com/bytedance/gopkg v0.1.3 // indirect + github.com/bytedance/sonic v1.15.0 // indirect + github.com/bytedance/sonic/loader v0.5.0 // indirect + github.com/cloudflare/circl v1.6.3 // indirect + github.com/cloudwego/base64x v0.1.6 // indirect + github.com/coder/websocket v1.8.14 // indirect + github.com/cyphar/filepath-securejoin v0.6.1 // indirect + github.com/ebitengine/purego v0.9.1 // indirect + github.com/emirpasic/gods v1.18.1 // indirect + github.com/gabriel-vasile/mimetype v1.4.12 // indirect + github.com/gin-contrib/sse v1.1.0 // indirect + github.com/go-git/gcfg v1.5.1-0.20230307220236-3a3c6141e376 // indirect + github.com/go-git/go-billy/v5 v5.7.0 // indirect + github.com/go-git/go-git/v5 v5.16.4 // indirect + github.com/go-ole/go-ole v1.3.0 // indirect + github.com/go-playground/locales v0.14.1 // indirect + github.com/go-playground/universal-translator v0.18.1 // indirect + github.com/go-playground/validator/v10 v10.30.1 // indirect + github.com/goccy/go-json v0.10.5 // indirect + github.com/goccy/go-yaml v1.19.2 // indirect + github.com/godbus/dbus/v5 v5.2.2 // indirect + github.com/golang/groupcache v0.0.0-20241129210726-2c02b8208cf8 // indirect + github.com/google/uuid v1.6.0 // indirect + github.com/jbenet/go-context v0.0.0-20150711004518-d14ea06fba99 // indirect + github.com/jchv/go-winloader v0.0.0-20250406163304-c1995be93bd1 // indirect + github.com/json-iterator/go v1.1.12 // indirect + github.com/kevinburke/ssh_config v1.4.0 // indirect + github.com/klauspost/cpuid/v2 v2.3.0 // indirect + github.com/leaanthony/go-ansi-parser v1.6.1 // indirect + github.com/leaanthony/u v1.1.1 // indirect + github.com/leodido/go-urn v1.4.0 // indirect + github.com/lmittmann/tint v1.1.2 // indirect + github.com/mattn/go-colorable v0.1.14 // indirect + github.com/mattn/go-isatty v0.0.20 // indirect + github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd // indirect + github.com/modern-go/reflect2 v1.0.2 // indirect + github.com/pelletier/go-toml/v2 v2.2.4 // indirect + github.com/pjbgf/sha1cd v0.5.0 // indirect + github.com/pkg/browser v0.0.0-20240102092130-5ac0b6a4141c // indirect + github.com/quic-go/qpack v0.6.0 // indirect + github.com/quic-go/quic-go v0.59.0 // indirect + github.com/rivo/uniseg v0.4.7 // indirect + github.com/samber/lo v1.52.0 // indirect + github.com/sergi/go-diff v1.4.0 // indirect + github.com/skeema/knownhosts v1.3.2 // indirect + github.com/twitchyliquid64/golang-asm v0.15.1 // indirect + github.com/ugorji/go/codec v1.3.1 // indirect + github.com/wailsapp/go-webview2 v1.0.23 // indirect + github.com/xanzy/ssh-agent v0.3.3 // indirect + go.uber.org/mock v0.6.0 // indirect + golang.org/x/arch v0.23.0 // indirect + golang.org/x/crypto v0.47.0 // indirect + golang.org/x/net v0.49.0 // indirect + golang.org/x/sys v0.40.0 // indirect + golang.org/x/text v0.33.0 // indirect + google.golang.org/protobuf v1.36.11 // indirect + gopkg.in/warnings.v0 v0.1.2 // indirect +) + +replace github.com/wailsapp/wails/v3 => ../.. diff --git a/v3/examples/gin-routing/go.sum b/v3/examples/gin-routing/go.sum new file mode 100644 index 000000000..9ca8a1297 --- /dev/null +++ b/v3/examples/gin-routing/go.sum @@ -0,0 +1,208 @@ +dario.cat/mergo v1.0.2 h1:85+piFYR1tMbRrLcDwR18y4UKJ3aH1Tbzi24VRW1TK8= +dario.cat/mergo v1.0.2/go.mod h1:E/hbnu0NxMFBjpMIE34DRGLWqDy0g5FuKDhCb31ngxA= +github.com/Microsoft/go-winio v0.5.2/go.mod h1:WpS1mjBmmwHBEWmogvA2mj8546UReBk4v8QkMxJ6pZY= +github.com/Microsoft/go-winio v0.6.2 h1:F2VQgta7ecxGYO8k3ZZz3RS8fVIXVxONVUPlNERoyfY= +github.com/Microsoft/go-winio v0.6.2/go.mod h1:yd8OoFMLzJbo9gZq8j5qaps8bJ9aShtEA8Ipt1oGCvU= +github.com/ProtonMail/go-crypto v1.3.0 h1:ILq8+Sf5If5DCpHQp4PbZdS1J7HDFRXz/+xKBiRGFrw= +github.com/ProtonMail/go-crypto v1.3.0/go.mod h1:9whxjD8Rbs29b4XWbB8irEcE8KHMqaR2e7GWU1R+/PE= +github.com/adrg/xdg v0.5.3 h1:xRnxJXne7+oWDatRhR1JLnvuccuIeCoBu2rtuLqQB78= +github.com/adrg/xdg v0.5.3/go.mod h1:nlTsY+NNiCBGCK2tpm09vRqfVzrc2fLmXGpBLF0zlTQ= +github.com/anmitsu/go-shlex v0.0.0-20200514113438-38f4b401e2be h1:9AeTilPcZAjCFIImctFaOjnTIavg87rW78vTPkQqLI8= +github.com/anmitsu/go-shlex v0.0.0-20200514113438-38f4b401e2be/go.mod h1:ySMOLuWl6zY27l47sB3qLNK6tF2fkHG55UZxx8oIVo4= +github.com/armon/go-socks5 v0.0.0-20160902184237-e75332964ef5 h1:0CwZNZbxp69SHPdPJAN/hZIm0C4OItdklCFmMRWYpio= +github.com/armon/go-socks5 v0.0.0-20160902184237-e75332964ef5/go.mod h1:wHh0iHkYZB8zMSxRWpUBQtwG5a7fFgvEO+odwuTv2gs= +github.com/bep/debounce v1.2.1 h1:v67fRdBA9UQu2NhLFXrSg0Brw7CexQekrBwDMM8bzeY= +github.com/bep/debounce v1.2.1/go.mod h1:H8yggRPQKLUhUoqrJC1bO2xNya7vanpDl7xR3ISbCJ0= +github.com/bytedance/gopkg v0.1.3 h1:TPBSwH8RsouGCBcMBktLt1AymVo2TVsBVCY4b6TnZ/M= +github.com/bytedance/gopkg v0.1.3/go.mod h1:576VvJ+eJgyCzdjS+c4+77QF3p7ubbtiKARP3TxducM= +github.com/bytedance/sonic v1.15.0 h1:/PXeWFaR5ElNcVE84U0dOHjiMHQOwNIx3K4ymzh/uSE= +github.com/bytedance/sonic v1.15.0/go.mod h1:tFkWrPz0/CUCLEF4ri4UkHekCIcdnkqXw9VduqpJh0k= +github.com/bytedance/sonic/loader v0.5.0 h1:gXH3KVnatgY7loH5/TkeVyXPfESoqSBSBEiDd5VjlgE= +github.com/bytedance/sonic/loader v0.5.0/go.mod h1:AR4NYCk5DdzZizZ5djGqQ92eEhCCcdf5x77udYiSJRo= +github.com/cloudflare/circl v1.6.3 h1:9GPOhQGF9MCYUeXyMYlqTR6a5gTrgR/fBLXvUgtVcg8= +github.com/cloudflare/circl v1.6.3/go.mod h1:2eXP6Qfat4O/Yhh8BznvKnJ+uzEoTQ6jVKJRn81BiS4= +github.com/cloudwego/base64x v0.1.6 h1:t11wG9AECkCDk5fMSoxmufanudBtJ+/HemLstXDLI2M= +github.com/cloudwego/base64x v0.1.6/go.mod h1:OFcloc187FXDaYHvrNIjxSe8ncn0OOM8gEHfghB2IPU= +github.com/coder/websocket v1.8.14 h1:9L0p0iKiNOibykf283eHkKUHHrpG7f65OE3BhhO7v9g= +github.com/coder/websocket v1.8.14/go.mod h1:NX3SzP+inril6yawo5CQXx8+fk145lPDC6pumgx0mVg= +github.com/cyphar/filepath-securejoin v0.6.1 h1:5CeZ1jPXEiYt3+Z6zqprSAgSWiggmpVyciv8syjIpVE= +github.com/cyphar/filepath-securejoin v0.6.1/go.mod h1:A8hd4EnAeyujCJRrICiOWqjS1AX0a9kM5XL+NwKoYSc= +github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= +github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c= +github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= +github.com/ebitengine/purego v0.9.1 h1:a/k2f2HQU3Pi399RPW1MOaZyhKJL9w/xFpKAg4q1s0A= +github.com/ebitengine/purego v0.9.1/go.mod h1:iIjxzd6CiRiOG0UyXP+V1+jWqUXVjPKLAI0mRfJZTmQ= +github.com/elazarl/goproxy v1.7.2 h1:Y2o6urb7Eule09PjlhQRGNsqRfPmYI3KKQLFpCAV3+o= +github.com/elazarl/goproxy v1.7.2/go.mod h1:82vkLNir0ALaW14Rc399OTTjyNREgmdL2cVoIbS6XaE= +github.com/emirpasic/gods v1.18.1 h1:FXtiHYKDGKCW2KzwZKx0iC0PQmdlorYgdFG9jPXJ1Bc= +github.com/emirpasic/gods v1.18.1/go.mod h1:8tpGGwCnJ5H4r6BWwaV6OrWmMoPhUl5jm/FMNAnJvWQ= +github.com/gabriel-vasile/mimetype v1.4.12 h1:e9hWvmLYvtp846tLHam2o++qitpguFiYCKbn0w9jyqw= +github.com/gabriel-vasile/mimetype v1.4.12/go.mod h1:d+9Oxyo1wTzWdyVUPMmXFvp4F9tea18J8ufA774AB3s= +github.com/gin-contrib/sse v1.1.0 h1:n0w2GMuUpWDVp7qSpvze6fAu9iRxJY4Hmj6AmBOU05w= +github.com/gin-contrib/sse v1.1.0/go.mod h1:hxRZ5gVpWMT7Z0B0gSNYqqsSCNIJMjzvm6fqCz9vjwM= +github.com/gin-gonic/gin v1.11.0 h1:OW/6PLjyusp2PPXtyxKHU0RbX6I/l28FTdDlae5ueWk= +github.com/gin-gonic/gin v1.11.0/go.mod h1:+iq/FyxlGzII0KHiBGjuNn4UNENUlKbGlNmc+W50Dls= +github.com/gliderlabs/ssh v0.3.8 h1:a4YXD1V7xMF9g5nTkdfnja3Sxy1PVDCj1Zg4Wb8vY6c= +github.com/gliderlabs/ssh v0.3.8/go.mod h1:xYoytBv1sV0aL3CavoDuJIQNURXkkfPA/wxQ1pL1fAU= +github.com/go-git/gcfg v1.5.1-0.20230307220236-3a3c6141e376 h1:+zs/tPmkDkHx3U66DAb0lQFJrpS6731Oaa12ikc+DiI= +github.com/go-git/gcfg v1.5.1-0.20230307220236-3a3c6141e376/go.mod h1:an3vInlBmSxCcxctByoQdvwPiA7DTK7jaaFDBTtu0ic= +github.com/go-git/go-billy/v5 v5.7.0 h1:83lBUJhGWhYp0ngzCMSgllhUSuoHP1iEWYjsPl9nwqM= +github.com/go-git/go-billy/v5 v5.7.0/go.mod h1:/1IUejTKH8xipsAcdfcSAlUlo2J7lkYV8GTKxAT/L3E= +github.com/go-git/go-git-fixtures/v4 v4.3.2-0.20231010084843-55a94097c399 h1:eMje31YglSBqCdIqdhKBW8lokaMrL3uTkpGYlE2OOT4= +github.com/go-git/go-git-fixtures/v4 v4.3.2-0.20231010084843-55a94097c399/go.mod h1:1OCfN199q1Jm3HZlxleg+Dw/mwps2Wbk9frAWm+4FII= +github.com/go-git/go-git/v5 v5.16.4 h1:7ajIEZHZJULcyJebDLo99bGgS0jRrOxzZG4uCk2Yb2Y= +github.com/go-git/go-git/v5 v5.16.4/go.mod h1:4Ge4alE/5gPs30F2H1esi2gPd69R0C39lolkucHBOp8= +github.com/go-json-experiment/json v0.0.0-20251027170946-4849db3c2f7e h1:Lf/gRkoycfOBPa42vU2bbgPurFong6zXeFtPoxholzU= +github.com/go-json-experiment/json v0.0.0-20251027170946-4849db3c2f7e/go.mod h1:uNVvRXArCGbZ508SxYYTC5v1JWoz2voff5pm25jU1Ok= +github.com/go-ole/go-ole v1.3.0 h1:Dt6ye7+vXGIKZ7Xtk4s6/xVdGDQynvom7xCFEdWr6uE= +github.com/go-ole/go-ole v1.3.0/go.mod h1:5LS6F96DhAwUc7C+1HLexzMXY1xGRSryjyPPKW6zv78= +github.com/go-playground/assert/v2 v2.2.0 h1:JvknZsQTYeFEAhQwI4qEt9cyV5ONwRHC+lYKSsYSR8s= +github.com/go-playground/assert/v2 v2.2.0/go.mod h1:VDjEfimB/XKnb+ZQfWdccd7VUvScMdVu0Titje2rxJ4= +github.com/go-playground/locales v0.14.1 h1:EWaQ/wswjilfKLTECiXz7Rh+3BjFhfDFKv/oXslEjJA= +github.com/go-playground/locales v0.14.1/go.mod h1:hxrqLVvrK65+Rwrd5Fc6F2O76J/NuW9t0sjnWqG1slY= +github.com/go-playground/universal-translator v0.18.1 h1:Bcnm0ZwsGyWbCzImXv+pAJnYK9S473LQFuzCbDbfSFY= +github.com/go-playground/universal-translator v0.18.1/go.mod h1:xekY+UJKNuX9WP91TpwSH2VMlDf28Uj24BCp08ZFTUY= +github.com/go-playground/validator/v10 v10.30.1 h1:f3zDSN/zOma+w6+1Wswgd9fLkdwy06ntQJp0BBvFG0w= +github.com/go-playground/validator/v10 v10.30.1/go.mod h1:oSuBIQzuJxL//3MelwSLD5hc2Tu889bF0Idm9Dg26cM= +github.com/goccy/go-json v0.10.5 h1:Fq85nIqj+gXn/S5ahsiTlK3TmC85qgirsdTP/+DeaC4= +github.com/goccy/go-json v0.10.5/go.mod h1:oq7eo15ShAhp70Anwd5lgX2pLfOS3QCiwU/PULtXL6M= +github.com/goccy/go-yaml v1.19.2 h1:PmFC1S6h8ljIz6gMRBopkjP1TVT7xuwrButHID66PoM= +github.com/goccy/go-yaml v1.19.2/go.mod h1:XBurs7gK8ATbW4ZPGKgcbrY1Br56PdM69F7LkFRi1kA= +github.com/godbus/dbus/v5 v5.2.2 h1:TUR3TgtSVDmjiXOgAAyaZbYmIeP3DPkld3jgKGV8mXQ= +github.com/godbus/dbus/v5 v5.2.2/go.mod h1:3AAv2+hPq5rdnr5txxxRwiGjPXamgoIHgz9FPBfOp3c= +github.com/golang/groupcache v0.0.0-20241129210726-2c02b8208cf8 h1:f+oWsMOmNPc8JmEHVZIycC7hBoQxHH9pNKQORJNozsQ= +github.com/golang/groupcache v0.0.0-20241129210726-2c02b8208cf8/go.mod h1:wcDNUvekVysuuOpQKo3191zZyTpiI6se1N1ULghS0sw= +github.com/google/go-cmp v0.7.0 h1:wk8382ETsv4JYUZwIsn6YpYiWiBsYLSJiTsyBybVuN8= +github.com/google/go-cmp v0.7.0/go.mod h1:pXiqmnSA92OHEEa9HXL2W4E7lf9JzCmGVUdgjX3N/iU= +github.com/google/gofuzz v1.0.0/go.mod h1:dBl0BpW6vV/+mYPU4Po3pmUjxk6FQPldtuIdl/M65Eg= +github.com/google/uuid v1.6.0 h1:NIvaJDMOsjHA8n1jAhLSgzrAzy1Hgr+hNrb57e+94F0= +github.com/google/uuid v1.6.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo= +github.com/jbenet/go-context v0.0.0-20150711004518-d14ea06fba99 h1:BQSFePA1RWJOlocH6Fxy8MmwDt+yVQYULKfN0RoTN8A= +github.com/jbenet/go-context v0.0.0-20150711004518-d14ea06fba99/go.mod h1:1lJo3i6rXxKeerYnT8Nvf0QmHCRC1n8sfWVwXF2Frvo= +github.com/jchv/go-winloader v0.0.0-20250406163304-c1995be93bd1 h1:njuLRcjAuMKr7kI3D85AXWkw6/+v9PwtV6M6o11sWHQ= +github.com/jchv/go-winloader v0.0.0-20250406163304-c1995be93bd1/go.mod h1:alcuEEnZsY1WQsagKhZDsoPCRoOijYqhZvPwLG0kzVs= +github.com/json-iterator/go v1.1.12 h1:PV8peI4a0ysnczrg+LtxykD8LfKY9ML6u2jnxaEnrnM= +github.com/json-iterator/go v1.1.12/go.mod h1:e30LSqwooZae/UwlEbR2852Gd8hjQvJoHmT4TnhNGBo= +github.com/kevinburke/ssh_config v1.4.0 h1:6xxtP5bZ2E4NF5tuQulISpTO2z8XbtH8cg1PWkxoFkQ= +github.com/kevinburke/ssh_config v1.4.0/go.mod h1:q2RIzfka+BXARoNexmF9gkxEX7DmvbW9P4hIVx2Kg4M= +github.com/klauspost/cpuid/v2 v2.3.0 h1:S4CRMLnYUhGeDFDqkGriYKdfoFlDnMtqTiI/sFzhA9Y= +github.com/klauspost/cpuid/v2 v2.3.0/go.mod h1:hqwkgyIinND0mEev00jJYCxPNVRVXFQeu1XKlok6oO0= +github.com/kr/pretty v0.1.0/go.mod h1:dAy3ld7l9f0ibDNOQOHHMYYIIbhfbHSm3C4ZsoJORNo= +github.com/kr/pretty v0.3.1 h1:flRD4NNwYAUpkphVc1HcthR4KEIFJ65n8Mw5qdRn3LE= +github.com/kr/pretty v0.3.1/go.mod h1:hoEshYVHaxMs3cyo3Yncou5ZscifuDolrwPKZanG3xk= +github.com/kr/pty v1.1.1/go.mod h1:pFQYn66WHrOpPYNljwOMqo10TkYh1fy3cYio2l3bCsQ= +github.com/kr/text v0.1.0/go.mod h1:4Jbv+DJW3UT/LiOwJeYQe1efqtUx/iVham/4vfdArNI= +github.com/kr/text v0.2.0 h1:5Nx0Ya0ZqY2ygV366QzturHI13Jq95ApcVaJBhpS+AY= +github.com/kr/text v0.2.0/go.mod h1:eLer722TekiGuMkidMxC/pM04lWEeraHUUmBw8l2grE= +github.com/leaanthony/go-ansi-parser v1.6.1 h1:xd8bzARK3dErqkPFtoF9F3/HgN8UQk0ed1YDKpEz01A= +github.com/leaanthony/go-ansi-parser v1.6.1/go.mod h1:+vva/2y4alzVmmIEpk9QDhA7vLC5zKDTRwfZGOp3IWU= +github.com/leaanthony/u v1.1.1 h1:TUFjwDGlNX+WuwVEzDqQwC2lOv0P4uhTQw7CMFdiK7M= +github.com/leaanthony/u v1.1.1/go.mod h1:9+o6hejoRljvZ3BzdYlVL0JYCwtnAsVuN9pVTQcaRfI= +github.com/leodido/go-urn v1.4.0 h1:WT9HwE9SGECu3lg4d/dIA+jxlljEa1/ffXKmRjqdmIQ= +github.com/leodido/go-urn v1.4.0/go.mod h1:bvxc+MVxLKB4z00jd1z+Dvzr47oO32F/QSNjSBOlFxI= +github.com/lmittmann/tint v1.1.2 h1:2CQzrL6rslrsyjqLDwD11bZ5OpLBPU+g3G/r5LSfS8w= +github.com/lmittmann/tint v1.1.2/go.mod h1:HIS3gSy7qNwGCj+5oRjAutErFBl4BzdQP6cJZ0NfMwE= +github.com/matryer/is v1.4.0/go.mod h1:8I/i5uYgLzgsgEloJE1U6xx5HkBQpAZvepWuujKwMRU= +github.com/matryer/is v1.4.1 h1:55ehd8zaGABKLXQUe2awZ99BD/PTc2ls+KV/dXphgEQ= +github.com/matryer/is v1.4.1/go.mod h1:8I/i5uYgLzgsgEloJE1U6xx5HkBQpAZvepWuujKwMRU= +github.com/mattn/go-colorable v0.1.14 h1:9A9LHSqF/7dyVVX6g0U9cwm9pG3kP9gSzcuIPHPsaIE= +github.com/mattn/go-colorable v0.1.14/go.mod h1:6LmQG8QLFO4G5z1gPvYEzlUgJ2wF+stgPZH1UqBm1s8= +github.com/mattn/go-isatty v0.0.20 h1:xfD0iDuEKnDkl03q4limB+vH+GxLEtL/jb4xVJSWWEY= +github.com/mattn/go-isatty v0.0.20/go.mod h1:W+V8PltTTMOvKvAeJH7IuucS94S2C6jfK/D7dTCTo3Y= +github.com/modern-go/concurrent v0.0.0-20180228061459-e0a39a4cb421/go.mod h1:6dJC0mAP4ikYIbvyc7fijjWJddQyLn8Ig3JB5CqoB9Q= +github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd h1:TRLaZ9cD/w8PVh93nsPXa1VrQ6jlwL5oN8l14QlcNfg= +github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd/go.mod h1:6dJC0mAP4ikYIbvyc7fijjWJddQyLn8Ig3JB5CqoB9Q= +github.com/modern-go/reflect2 v1.0.2 h1:xBagoLtFs94CBntxluKeaWgTMpvLxC4ur3nMaC9Gz0M= +github.com/modern-go/reflect2 v1.0.2/go.mod h1:yWuevngMOJpCy52FWWMvUC8ws7m/LJsjYzDa0/r8luk= +github.com/onsi/gomega v1.34.1 h1:EUMJIKUjM8sKjYbtxQI9A4z2o+rruxnzNvpknOXie6k= +github.com/onsi/gomega v1.34.1/go.mod h1:kU1QgUvBDLXBJq618Xvm2LUX6rSAfRaFRTcdOeDLwwY= +github.com/pelletier/go-toml/v2 v2.2.4 h1:mye9XuhQ6gvn5h28+VilKrrPoQVanw5PMw/TB0t5Ec4= +github.com/pelletier/go-toml/v2 v2.2.4/go.mod h1:2gIqNv+qfxSVS7cM2xJQKtLSTLUE9V8t9Stt+h56mCY= +github.com/pjbgf/sha1cd v0.5.0 h1:a+UkboSi1znleCDUNT3M5YxjOnN1fz2FhN48FlwCxs0= +github.com/pjbgf/sha1cd v0.5.0/go.mod h1:lhpGlyHLpQZoxMv8HcgXvZEhcGs0PG/vsZnEJ7H0iCM= +github.com/pkg/browser v0.0.0-20240102092130-5ac0b6a4141c h1:+mdjkGKdHQG3305AYmdv1U2eRNDiU2ErMBj1gwrq8eQ= +github.com/pkg/browser v0.0.0-20240102092130-5ac0b6a4141c/go.mod h1:7rwL4CYBLnjLxUqIJNnCWiEdr3bn6IUYi15bNlnbCCU= +github.com/pkg/errors v0.9.1 h1:FEBLx1zS214owpjy7qsBeixbURkuhQAwrK5UwLGTwt4= +github.com/pkg/errors v0.9.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0= +github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM= +github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= +github.com/quic-go/qpack v0.6.0 h1:g7W+BMYynC1LbYLSqRt8PBg5Tgwxn214ZZR34VIOjz8= +github.com/quic-go/qpack v0.6.0/go.mod h1:lUpLKChi8njB4ty2bFLX2x4gzDqXwUpaO1DP9qMDZII= +github.com/quic-go/quic-go v0.59.0 h1:OLJkp1Mlm/aS7dpKgTc6cnpynnD2Xg7C1pwL6vy/SAw= +github.com/quic-go/quic-go v0.59.0/go.mod h1:upnsH4Ju1YkqpLXC305eW3yDZ4NfnNbmQRCMWS58IKU= +github.com/rivo/uniseg v0.2.0/go.mod h1:J6wj4VEh+S6ZtnVlnTBMWIodfgj8LQOQFoIToxlJtxc= +github.com/rivo/uniseg v0.4.7 h1:WUdvkW8uEhrYfLC4ZzdpI2ztxP1I582+49Oc5Mq64VQ= +github.com/rivo/uniseg v0.4.7/go.mod h1:FN3SvrM+Zdj16jyLfmOkMNblXMcoc8DfTHruCPUcx88= +github.com/rogpeppe/go-internal v1.14.1 h1:UQB4HGPB6osV0SQTLymcB4TgvyWu6ZyliaW0tI/otEQ= +github.com/rogpeppe/go-internal v1.14.1/go.mod h1:MaRKkUm5W0goXpeCfT7UZI6fk/L7L7so1lCWt35ZSgc= +github.com/samber/lo v1.52.0 h1:Rvi+3BFHES3A8meP33VPAxiBZX/Aws5RxrschYGjomw= +github.com/samber/lo v1.52.0/go.mod h1:4+MXEGsJzbKGaUEQFKBq2xtfuznW9oz/WrgyzMzRoM0= +github.com/sergi/go-diff v1.4.0 h1:n/SP9D5ad1fORl+llWyN+D6qoUETXNZARKjyY2/KVCw= +github.com/sergi/go-diff v1.4.0/go.mod h1:A0bzQcvG0E7Rwjx0REVgAGH58e96+X0MeOfepqsbeW4= +github.com/sirupsen/logrus v1.7.0/go.mod h1:yWOB1SBYBC5VeMP7gHvWumXLIWorT60ONWic61uBYv0= +github.com/skeema/knownhosts v1.3.2 h1:EDL9mgf4NzwMXCTfaxSD/o/a5fxDw/xL9nkU28JjdBg= +github.com/skeema/knownhosts v1.3.2/go.mod h1:bEg3iQAuw+jyiw+484wwFJoKSLwcfd7fqRy+N0QTiow= +github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME= +github.com/stretchr/objx v0.4.0/go.mod h1:YvHI0jy2hoMjB+UWwv71VJQ9isScKT/TqJzVSSt89Yw= +github.com/stretchr/objx v0.5.0/go.mod h1:Yh+to48EsGEfYuaHDzXPcE3xhTkx73EhmCGUpEOglKo= +github.com/stretchr/objx v0.5.2/go.mod h1:FRsXN1f5AsAjCGJKqEizvkpNtU+EGNCLh3NxZ/8L+MA= +github.com/stretchr/testify v1.2.2/go.mod h1:a8OnRcib4nhh0OaRAV+Yts87kKdq0PP7pXfy6kDkUVs= +github.com/stretchr/testify v1.3.0/go.mod h1:M5WIy9Dh21IEIfnGCwXGc5bZfKNJtfHm1UVUgZn+9EI= +github.com/stretchr/testify v1.4.0/go.mod h1:j7eGeouHqKxXV5pUuKE4zz7dFj8WfuZ+81PSLYec5m4= +github.com/stretchr/testify v1.7.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg= +github.com/stretchr/testify v1.8.0/go.mod h1:yNjHg4UonilssWZ8iaSj1OCr/vHnekPRkoO+kdMU+MU= +github.com/stretchr/testify v1.8.4/go.mod h1:sz/lmYIOXD/1dqDmKjjqLyZ2RngseejIcXlSw2iwfAo= +github.com/stretchr/testify v1.10.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY= +github.com/stretchr/testify v1.11.1 h1:7s2iGBzp5EwR7/aIZr8ao5+dra3wiQyKjjFuvgVKu7U= +github.com/stretchr/testify v1.11.1/go.mod h1:wZwfW3scLgRK+23gO65QZefKpKQRnfz6sD981Nm4B6U= +github.com/twitchyliquid64/golang-asm v0.15.1 h1:SU5vSMR7hnwNxj24w34ZyCi/FmDZTkS4MhqMhdFk5YI= +github.com/twitchyliquid64/golang-asm v0.15.1/go.mod h1:a1lVb/DtPvCB8fslRZhAngC2+aY1QWCk3Cedj/Gdt08= +github.com/ugorji/go/codec v1.3.1 h1:waO7eEiFDwidsBN6agj1vJQ4AG7lh2yqXyOXqhgQuyY= +github.com/ugorji/go/codec v1.3.1/go.mod h1:pRBVtBSKl77K30Bv8R2P+cLSGaTtex6fsA2Wjqmfxj4= +github.com/wailsapp/go-webview2 v1.0.23 h1:jmv8qhz1lHibCc79bMM/a/FqOnnzOGEisLav+a0b9P0= +github.com/wailsapp/go-webview2 v1.0.23/go.mod h1:qJmWAmAmaniuKGZPWwne+uor3AHMB5PFhqiK0Bbj8kc= +github.com/xanzy/ssh-agent v0.3.3 h1:+/15pJfg/RsTxqYcX6fHqOXZwwMP+2VyYWJeWM2qQFM= +github.com/xanzy/ssh-agent v0.3.3/go.mod h1:6dzNDKs0J9rVPHPhaGCukekBHKqfl+L3KghI1Bc68Uw= +go.uber.org/mock v0.6.0 h1:hyF9dfmbgIX5EfOdasqLsWD6xqpNZlXblLB/Dbnwv3Y= +go.uber.org/mock v0.6.0/go.mod h1:KiVJ4BqZJaMj4svdfmHM0AUx4NJYO8ZNpPnZn1Z+BBU= +golang.org/x/arch v0.23.0 h1:lKF64A2jF6Zd8L0knGltUnegD62JMFBiCPBmQpToHhg= +golang.org/x/arch v0.23.0/go.mod h1:dNHoOeKiyja7GTvF9NJS1l3Z2yntpQNzgrjh1cU103A= +golang.org/x/crypto v0.0.0-20220622213112-05595931fe9d/go.mod h1:IxCIyHEi3zRg3s0A5j5BB6A9Jmi73HwBIUl50j+osU4= +golang.org/x/crypto v0.47.0 h1:V6e3FRj+n4dbpw86FJ8Fv7XVOql7TEwpHapKoMJ/GO8= +golang.org/x/crypto v0.47.0/go.mod h1:ff3Y9VzzKbwSSEzWqJsJVBnWmRwRSHt/6Op5n9bQc4A= +golang.org/x/exp v0.0.0-20260112195511-716be5621a96 h1:Z/6YuSHTLOHfNFdb8zVZomZr7cqNgTJvA8+Qz75D8gU= +golang.org/x/exp v0.0.0-20260112195511-716be5621a96/go.mod h1:nzimsREAkjBCIEFtHiYkrJyT+2uy9YZJB7H1k68CXZU= +golang.org/x/net v0.0.0-20211112202133-69e39bad7dc2/go.mod h1:9nx3DQGgdP8bBQD5qxJ1jj9UTztislL4KSBs9R2vV5Y= +golang.org/x/net v0.49.0 h1:eeHFmOGUTtaaPSGNmjBKpbng9MulQsJURQUAfUwY++o= +golang.org/x/net v0.49.0/go.mod h1:/ysNB2EvaqvesRkuLAyjI1ycPZlQHM3q01F02UY/MV8= +golang.org/x/sys v0.0.0-20191026070338-33540a1f6037/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20200810151505-1b9f1253b3ed/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20201119102817-f84b799fce68/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20210124154548-22da62e12c0c/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20210423082822-04245dca01da/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20210615035016-665e8c7367d1/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.0.0-20220715151400-c0bba94af5f8/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.1.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.6.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.40.0 h1:DBZZqJ2Rkml6QMQsZywtnjnnGvHza6BTfYFWY9kjEWQ= +golang.org/x/sys v0.40.0/go.mod h1:OgkHotnGiDImocRcuBABYBEXf8A9a87e/uXjp9XT3ks= +golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo= +golang.org/x/term v0.39.0 h1:RclSuaJf32jOqZz74CkPA9qFuVTX7vhLlpfj/IGWlqY= +golang.org/x/term v0.39.0/go.mod h1:yxzUCTP/U+FzoxfdKmLaA0RV1WgE0VY7hXBwKtY/4ww= +golang.org/x/text v0.3.6/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ= +golang.org/x/text v0.33.0 h1:B3njUFyqtHDUI5jMn1YIr5B0IE2U0qck04r6d4KPAxE= +golang.org/x/text v0.33.0/go.mod h1:LuMebE6+rBincTi9+xWTY8TztLzKHc/9C1uBCG27+q8= +golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ= +google.golang.org/protobuf v1.36.11 h1:fV6ZwhNocDyBLK0dj+fg8ektcVegBBuEolpbTQyBNVE= +google.golang.org/protobuf v1.36.11/go.mod h1:HTf+CrKn2C3g5S8VImy6tdcUvCska2kB7j23XfzDpco= +gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= +gopkg.in/check.v1 v1.0.0-20190902080502-41f04d3bba15/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= +gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c h1:Hei/4ADfdWqJk1ZMxUNpqntNwaWcugrBjAiHlqqRiVk= +gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c/go.mod h1:JHkPIbrfpd72SG/EVd6muEfDQjcINNoR0C8j2r3qZ4Q= +gopkg.in/warnings.v0 v0.1.2 h1:wFXVbFY8DY5/xOe1ECiWdKCzZlxgshcYVNkBHstARME= +gopkg.in/warnings.v0 v0.1.2/go.mod h1:jksf8JmL6Qr/oQM2OXTHunEvvTAsrWBLb6OOjuVWRNI= +gopkg.in/yaml.v2 v2.2.2/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI= +gopkg.in/yaml.v2 v2.4.0/go.mod h1:RDklbk79AGWmwhnvt/jBztapEOGDOx6ZbXqjP6csGnQ= +gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= +gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA= +gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= diff --git a/v3/examples/gin-routing/main.go b/v3/examples/gin-routing/main.go new file mode 100644 index 000000000..a78494808 --- /dev/null +++ b/v3/examples/gin-routing/main.go @@ -0,0 +1,114 @@ +package main + +import ( + "embed" + "log" + "net/http" + "strings" + "time" + + "github.com/gin-gonic/gin" + "github.com/wailsapp/wails/v3/pkg/application" +) + +//go:embed static +var staticFiles embed.FS + +// GinMiddleware creates a middleware that passes requests to Gin if they're not handled by Wails +func GinMiddleware(ginEngine *gin.Engine) application.Middleware { + return func(next http.Handler) http.Handler { + return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { + // Let Wails handle the `/wails` route + if strings.HasPrefix(r.URL.Path, "/wails") { + next.ServeHTTP(w, r) + return + } + // Let Gin handle everything else + ginEngine.ServeHTTP(w, r) + }) + } +} + +// LoggingMiddleware is a Gin middleware that logs request details +func LoggingMiddleware() gin.HandlerFunc { + return func(c *gin.Context) { + // Start timer + startTime := time.Now() + + // Process request + c.Next() + + // Calculate latency + latency := time.Since(startTime) + + // Log request details + log.Printf("[GIN] %s | %s | %s | %d | %s", + c.Request.Method, + c.Request.URL.Path, + c.ClientIP(), + c.Writer.Status(), + latency, + ) + } +} + +func main() { + // Create a new Gin router + ginEngine := gin.New() // Using New() instead of Default() to add our own middleware + + // Add middlewares + ginEngine.Use(gin.Recovery()) + ginEngine.Use(LoggingMiddleware()) + + // Serve embedded static files + ginEngine.StaticFS("/static", http.FS(staticFiles)) + + // Define routes + ginEngine.GET("/", func(c *gin.Context) { + file, err := staticFiles.ReadFile("static/index.html") + if err != nil { + c.String(http.StatusInternalServerError, "Error reading index.html") + return + } + c.Data(http.StatusOK, "text/html; charset=utf-8", file) + }) + + ginEngine.GET("/api/hello", func(c *gin.Context) { + c.JSON(http.StatusOK, gin.H{ + "message": "Hello from Gin API!", + "time": time.Now().Format(time.RFC3339), + }) + }) + + // Create a new Wails application + app := application.New(application.Options{ + Name: "Gin Example", + Description: "A demo of using Gin with Wails", + Mac: application.MacOptions{ + ApplicationShouldTerminateAfterLastWindowClosed: true, + }, + Assets: application.AssetOptions{ + Handler: ginEngine, + Middleware: GinMiddleware(ginEngine), + }, + }) + + // Register event handler + app.Event.On("gin-button-clicked", func(event *application.CustomEvent) { + log.Printf("Received event from frontend: %v", event.Data) + }) + + // Create window + app.Window.NewWithOptions(application.WebviewWindowOptions{ + Title: "Wails + Gin Example", + Width: 900, + Height: 700, + URL: "/", + }) + + // Run the app + err := app.Run() + if err != nil { + log.Fatal(err) + } +} diff --git a/v3/examples/gin-routing/static/index.html b/v3/examples/gin-routing/static/index.html new file mode 100644 index 000000000..aefbd7a28 --- /dev/null +++ b/v3/examples/gin-routing/static/index.html @@ -0,0 +1,94 @@ + + + Wails + Gin Example + + + +
            +

            Wails + Gin Integration

            +
            +

            Hello World!

            +

            This page is being served by Gin.

            +

            Click the button below to trigger a Wails event:

            + + +
            +
            +

            API Example

            +

            Try the Gin API endpoint:

            + +
            +
            +
            + + + diff --git a/v3/examples/gin-service/README.md b/v3/examples/gin-service/README.md new file mode 100644 index 000000000..89e5019d7 --- /dev/null +++ b/v3/examples/gin-service/README.md @@ -0,0 +1,21 @@ +# Gin Service Example + +This example demonstrates how to use the [Gin web framework](https://github.com/gin-gonic/gin) in a Wails Service. + +## Overview + +This example shows how to: + +- Set up Gin as the asset handler for a Wails application +- Create a middleware that routes requests between Wails and Gin +- Define API endpoints with Gin +- Communicate between the Gin-served frontend and Wails backend +- Implement custom Gin middleware + +## Running the Example + + +## Documentation + +Please consult the [Using Gin for Routing](https://v3.wails.io/guides/gin-routing/) guide for a detailed explanation of the example. + diff --git a/v3/examples/gin-service/assets/index.html b/v3/examples/gin-service/assets/index.html new file mode 100644 index 000000000..66aea00eb --- /dev/null +++ b/v3/examples/gin-service/assets/index.html @@ -0,0 +1,249 @@ + + + + + + Gin Service Example + + + +

            Gin Service Example

            + +
            +

            API Endpoints

            +

            Try the Gin API endpoints mounted at /api:

            + + + + + + + +
            +
            Results will appear here...
            +
            +
            + +
            +

            Event Communication

            +

            Trigger an event to communicate with the Gin service:

            + + + +
            +
            Event responses will appear here...
            +
            +
            + + + + + + diff --git a/v3/examples/gin-service/go.mod b/v3/examples/gin-service/go.mod new file mode 100644 index 000000000..5b46f88af --- /dev/null +++ b/v3/examples/gin-service/go.mod @@ -0,0 +1,74 @@ +module gin-service + +go 1.25 + +require ( + github.com/gin-gonic/gin v1.11.0 + github.com/wailsapp/wails/v3 v3.0.0-alpha.62 +) + +require ( + dario.cat/mergo v1.0.2 // indirect + github.com/Microsoft/go-winio v0.6.2 // indirect + github.com/ProtonMail/go-crypto v1.3.0 // indirect + github.com/adrg/xdg v0.5.3 // indirect + github.com/bep/debounce v1.2.1 // indirect + github.com/bytedance/gopkg v0.1.3 // indirect + github.com/bytedance/sonic v1.15.0 // indirect + github.com/bytedance/sonic/loader v0.5.0 // indirect + github.com/cloudflare/circl v1.6.3 // indirect + github.com/cloudwego/base64x v0.1.6 // indirect + github.com/cyphar/filepath-securejoin v0.6.1 // indirect + github.com/ebitengine/purego v0.9.1 // indirect + github.com/emirpasic/gods v1.18.1 // indirect + github.com/gabriel-vasile/mimetype v1.4.12 // indirect + github.com/gin-contrib/sse v1.1.0 // indirect + github.com/go-git/gcfg v1.5.1-0.20230307220236-3a3c6141e376 // indirect + github.com/go-git/go-billy/v5 v5.7.0 // indirect + github.com/go-git/go-git/v5 v5.16.4 // indirect + github.com/go-ole/go-ole v1.3.0 // indirect + github.com/go-playground/locales v0.14.1 // indirect + github.com/go-playground/universal-translator v0.18.1 // indirect + github.com/go-playground/validator/v10 v10.30.1 // indirect + github.com/goccy/go-json v0.10.5 // indirect + github.com/goccy/go-yaml v1.19.2 // indirect + github.com/godbus/dbus/v5 v5.2.2 // indirect + github.com/golang/groupcache v0.0.0-20241129210726-2c02b8208cf8 // indirect + github.com/google/uuid v1.6.0 // indirect + github.com/jbenet/go-context v0.0.0-20150711004518-d14ea06fba99 // indirect + github.com/jchv/go-winloader v0.0.0-20250406163304-c1995be93bd1 // indirect + github.com/json-iterator/go v1.1.12 // indirect + github.com/kevinburke/ssh_config v1.4.0 // indirect + github.com/klauspost/cpuid/v2 v2.3.0 // indirect + github.com/leaanthony/go-ansi-parser v1.6.1 // indirect + github.com/leaanthony/u v1.1.1 // indirect + github.com/leodido/go-urn v1.4.0 // indirect + github.com/lmittmann/tint v1.1.2 // indirect + github.com/mattn/go-colorable v0.1.14 // indirect + github.com/mattn/go-isatty v0.0.20 // indirect + github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd // indirect + github.com/modern-go/reflect2 v1.0.2 // indirect + github.com/pelletier/go-toml/v2 v2.2.4 // indirect + github.com/pjbgf/sha1cd v0.5.0 // indirect + github.com/pkg/browser v0.0.0-20240102092130-5ac0b6a4141c // indirect + github.com/quic-go/qpack v0.6.0 // indirect + github.com/quic-go/quic-go v0.59.0 // indirect + github.com/rivo/uniseg v0.4.7 // indirect + github.com/samber/lo v1.52.0 // indirect + github.com/sergi/go-diff v1.4.0 // indirect + github.com/skeema/knownhosts v1.3.2 // indirect + github.com/twitchyliquid64/golang-asm v0.15.1 // indirect + github.com/ugorji/go/codec v1.3.1 // indirect + github.com/wailsapp/go-webview2 v1.0.23 // indirect + github.com/xanzy/ssh-agent v0.3.3 // indirect + go.uber.org/mock v0.6.0 // indirect + golang.org/x/arch v0.23.0 // indirect + golang.org/x/crypto v0.47.0 // indirect + golang.org/x/net v0.49.0 // indirect + golang.org/x/sys v0.40.0 // indirect + golang.org/x/text v0.33.0 // indirect + google.golang.org/protobuf v1.36.11 // indirect + gopkg.in/warnings.v0 v0.1.2 // indirect +) + +replace github.com/wailsapp/wails/v3 => ../.. diff --git a/v3/examples/gin-service/go.sum b/v3/examples/gin-service/go.sum new file mode 100644 index 000000000..07a22c6eb --- /dev/null +++ b/v3/examples/gin-service/go.sum @@ -0,0 +1,208 @@ +dario.cat/mergo v1.0.2 h1:85+piFYR1tMbRrLcDwR18y4UKJ3aH1Tbzi24VRW1TK8= +dario.cat/mergo v1.0.2/go.mod h1:E/hbnu0NxMFBjpMIE34DRGLWqDy0g5FuKDhCb31ngxA= +github.com/Microsoft/go-winio v0.5.2/go.mod h1:WpS1mjBmmwHBEWmogvA2mj8546UReBk4v8QkMxJ6pZY= +github.com/Microsoft/go-winio v0.6.2 h1:F2VQgta7ecxGYO8k3ZZz3RS8fVIXVxONVUPlNERoyfY= +github.com/Microsoft/go-winio v0.6.2/go.mod h1:yd8OoFMLzJbo9gZq8j5qaps8bJ9aShtEA8Ipt1oGCvU= +github.com/ProtonMail/go-crypto v1.3.0 h1:ILq8+Sf5If5DCpHQp4PbZdS1J7HDFRXz/+xKBiRGFrw= +github.com/ProtonMail/go-crypto v1.3.0/go.mod h1:9whxjD8Rbs29b4XWbB8irEcE8KHMqaR2e7GWU1R+/PE= +github.com/adrg/xdg v0.5.3 h1:xRnxJXne7+oWDatRhR1JLnvuccuIeCoBu2rtuLqQB78= +github.com/adrg/xdg v0.5.3/go.mod h1:nlTsY+NNiCBGCK2tpm09vRqfVzrc2fLmXGpBLF0zlTQ= +github.com/anmitsu/go-shlex v0.0.0-20200514113438-38f4b401e2be h1:9AeTilPcZAjCFIImctFaOjnTIavg87rW78vTPkQqLI8= +github.com/anmitsu/go-shlex v0.0.0-20200514113438-38f4b401e2be/go.mod h1:ySMOLuWl6zY27l47sB3qLNK6tF2fkHG55UZxx8oIVo4= +github.com/armon/go-socks5 v0.0.0-20160902184237-e75332964ef5 h1:0CwZNZbxp69SHPdPJAN/hZIm0C4OItdklCFmMRWYpio= +github.com/armon/go-socks5 v0.0.0-20160902184237-e75332964ef5/go.mod h1:wHh0iHkYZB8zMSxRWpUBQtwG5a7fFgvEO+odwuTv2gs= +github.com/bep/debounce v1.2.1 h1:v67fRdBA9UQu2NhLFXrSg0Brw7CexQekrBwDMM8bzeY= +github.com/bep/debounce v1.2.1/go.mod h1:H8yggRPQKLUhUoqrJC1bO2xNya7vanpDl7xR3ISbCJ0= +github.com/bytedance/gopkg v0.1.3 h1:TPBSwH8RsouGCBcMBktLt1AymVo2TVsBVCY4b6TnZ/M= +github.com/bytedance/gopkg v0.1.3/go.mod h1:576VvJ+eJgyCzdjS+c4+77QF3p7ubbtiKARP3TxducM= +github.com/bytedance/sonic v1.15.0 h1:/PXeWFaR5ElNcVE84U0dOHjiMHQOwNIx3K4ymzh/uSE= +github.com/bytedance/sonic v1.15.0/go.mod h1:tFkWrPz0/CUCLEF4ri4UkHekCIcdnkqXw9VduqpJh0k= +github.com/bytedance/sonic/loader v0.5.0 h1:gXH3KVnatgY7loH5/TkeVyXPfESoqSBSBEiDd5VjlgE= +github.com/bytedance/sonic/loader v0.5.0/go.mod h1:AR4NYCk5DdzZizZ5djGqQ92eEhCCcdf5x77udYiSJRo= +github.com/cloudflare/circl v1.6.3 h1:9GPOhQGF9MCYUeXyMYlqTR6a5gTrgR/fBLXvUgtVcg8= +github.com/cloudflare/circl v1.6.3/go.mod h1:2eXP6Qfat4O/Yhh8BznvKnJ+uzEoTQ6jVKJRn81BiS4= +github.com/cloudwego/base64x v0.1.6 h1:t11wG9AECkCDk5fMSoxmufanudBtJ+/HemLstXDLI2M= +github.com/cloudwego/base64x v0.1.6/go.mod h1:OFcloc187FXDaYHvrNIjxSe8ncn0OOM8gEHfghB2IPU= +github.com/cyphar/filepath-securejoin v0.6.1 h1:5CeZ1jPXEiYt3+Z6zqprSAgSWiggmpVyciv8syjIpVE= +github.com/cyphar/filepath-securejoin v0.6.1/go.mod h1:A8hd4EnAeyujCJRrICiOWqjS1AX0a9kM5XL+NwKoYSc= +github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= +github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c= +github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= +github.com/ebitengine/purego v0.9.1 h1:a/k2f2HQU3Pi399RPW1MOaZyhKJL9w/xFpKAg4q1s0A= +github.com/ebitengine/purego v0.9.1/go.mod h1:iIjxzd6CiRiOG0UyXP+V1+jWqUXVjPKLAI0mRfJZTmQ= +github.com/elazarl/goproxy v1.7.2 h1:Y2o6urb7Eule09PjlhQRGNsqRfPmYI3KKQLFpCAV3+o= +github.com/elazarl/goproxy v1.7.2/go.mod h1:82vkLNir0ALaW14Rc399OTTjyNREgmdL2cVoIbS6XaE= +github.com/emirpasic/gods v1.18.1 h1:FXtiHYKDGKCW2KzwZKx0iC0PQmdlorYgdFG9jPXJ1Bc= +github.com/emirpasic/gods v1.18.1/go.mod h1:8tpGGwCnJ5H4r6BWwaV6OrWmMoPhUl5jm/FMNAnJvWQ= +github.com/gabriel-vasile/mimetype v1.4.12 h1:e9hWvmLYvtp846tLHam2o++qitpguFiYCKbn0w9jyqw= +github.com/gabriel-vasile/mimetype v1.4.12/go.mod h1:d+9Oxyo1wTzWdyVUPMmXFvp4F9tea18J8ufA774AB3s= +github.com/gin-contrib/sse v1.1.0 h1:n0w2GMuUpWDVp7qSpvze6fAu9iRxJY4Hmj6AmBOU05w= +github.com/gin-contrib/sse v1.1.0/go.mod h1:hxRZ5gVpWMT7Z0B0gSNYqqsSCNIJMjzvm6fqCz9vjwM= +github.com/gin-gonic/gin v1.11.0 h1:OW/6PLjyusp2PPXtyxKHU0RbX6I/l28FTdDlae5ueWk= +github.com/gin-gonic/gin v1.11.0/go.mod h1:+iq/FyxlGzII0KHiBGjuNn4UNENUlKbGlNmc+W50Dls= +github.com/gliderlabs/ssh v0.3.8 h1:a4YXD1V7xMF9g5nTkdfnja3Sxy1PVDCj1Zg4Wb8vY6c= +github.com/gliderlabs/ssh v0.3.8/go.mod h1:xYoytBv1sV0aL3CavoDuJIQNURXkkfPA/wxQ1pL1fAU= +github.com/go-git/gcfg v1.5.1-0.20230307220236-3a3c6141e376 h1:+zs/tPmkDkHx3U66DAb0lQFJrpS6731Oaa12ikc+DiI= +github.com/go-git/gcfg v1.5.1-0.20230307220236-3a3c6141e376/go.mod h1:an3vInlBmSxCcxctByoQdvwPiA7DTK7jaaFDBTtu0ic= +github.com/go-git/go-billy/v5 v5.7.0 h1:83lBUJhGWhYp0ngzCMSgllhUSuoHP1iEWYjsPl9nwqM= +github.com/go-git/go-billy/v5 v5.7.0/go.mod h1:/1IUejTKH8xipsAcdfcSAlUlo2J7lkYV8GTKxAT/L3E= +github.com/go-git/go-git-fixtures/v4 v4.3.2-0.20231010084843-55a94097c399 h1:eMje31YglSBqCdIqdhKBW8lokaMrL3uTkpGYlE2OOT4= +github.com/go-git/go-git-fixtures/v4 v4.3.2-0.20231010084843-55a94097c399/go.mod h1:1OCfN199q1Jm3HZlxleg+Dw/mwps2Wbk9frAWm+4FII= +github.com/go-git/go-git/v5 v5.16.4 h1:7ajIEZHZJULcyJebDLo99bGgS0jRrOxzZG4uCk2Yb2Y= +github.com/go-git/go-git/v5 v5.16.4/go.mod h1:4Ge4alE/5gPs30F2H1esi2gPd69R0C39lolkucHBOp8= +github.com/go-json-experiment/json v0.0.0-20251027170946-4849db3c2f7e h1:Lf/gRkoycfOBPa42vU2bbgPurFong6zXeFtPoxholzU= +github.com/go-json-experiment/json v0.0.0-20251027170946-4849db3c2f7e/go.mod h1:uNVvRXArCGbZ508SxYYTC5v1JWoz2voff5pm25jU1Ok= +github.com/go-ole/go-ole v1.3.0 h1:Dt6ye7+vXGIKZ7Xtk4s6/xVdGDQynvom7xCFEdWr6uE= +github.com/go-ole/go-ole v1.3.0/go.mod h1:5LS6F96DhAwUc7C+1HLexzMXY1xGRSryjyPPKW6zv78= +github.com/go-playground/assert/v2 v2.2.0 h1:JvknZsQTYeFEAhQwI4qEt9cyV5ONwRHC+lYKSsYSR8s= +github.com/go-playground/assert/v2 v2.2.0/go.mod h1:VDjEfimB/XKnb+ZQfWdccd7VUvScMdVu0Titje2rxJ4= +github.com/go-playground/locales v0.14.1 h1:EWaQ/wswjilfKLTECiXz7Rh+3BjFhfDFKv/oXslEjJA= +github.com/go-playground/locales v0.14.1/go.mod h1:hxrqLVvrK65+Rwrd5Fc6F2O76J/NuW9t0sjnWqG1slY= +github.com/go-playground/universal-translator v0.18.1 h1:Bcnm0ZwsGyWbCzImXv+pAJnYK9S473LQFuzCbDbfSFY= +github.com/go-playground/universal-translator v0.18.1/go.mod h1:xekY+UJKNuX9WP91TpwSH2VMlDf28Uj24BCp08ZFTUY= +github.com/go-playground/validator/v10 v10.30.1 h1:f3zDSN/zOma+w6+1Wswgd9fLkdwy06ntQJp0BBvFG0w= +github.com/go-playground/validator/v10 v10.30.1/go.mod h1:oSuBIQzuJxL//3MelwSLD5hc2Tu889bF0Idm9Dg26cM= +github.com/goccy/go-json v0.10.5 h1:Fq85nIqj+gXn/S5ahsiTlK3TmC85qgirsdTP/+DeaC4= +github.com/goccy/go-json v0.10.5/go.mod h1:oq7eo15ShAhp70Anwd5lgX2pLfOS3QCiwU/PULtXL6M= +github.com/goccy/go-yaml v1.19.2 h1:PmFC1S6h8ljIz6gMRBopkjP1TVT7xuwrButHID66PoM= +github.com/goccy/go-yaml v1.19.2/go.mod h1:XBurs7gK8ATbW4ZPGKgcbrY1Br56PdM69F7LkFRi1kA= +github.com/godbus/dbus/v5 v5.2.2 h1:TUR3TgtSVDmjiXOgAAyaZbYmIeP3DPkld3jgKGV8mXQ= +github.com/godbus/dbus/v5 v5.2.2/go.mod h1:3AAv2+hPq5rdnr5txxxRwiGjPXamgoIHgz9FPBfOp3c= +github.com/golang/groupcache v0.0.0-20241129210726-2c02b8208cf8 h1:f+oWsMOmNPc8JmEHVZIycC7hBoQxHH9pNKQORJNozsQ= +github.com/golang/groupcache v0.0.0-20241129210726-2c02b8208cf8/go.mod h1:wcDNUvekVysuuOpQKo3191zZyTpiI6se1N1ULghS0sw= +github.com/google/go-cmp v0.7.0 h1:wk8382ETsv4JYUZwIsn6YpYiWiBsYLSJiTsyBybVuN8= +github.com/google/go-cmp v0.7.0/go.mod h1:pXiqmnSA92OHEEa9HXL2W4E7lf9JzCmGVUdgjX3N/iU= +github.com/google/gofuzz v1.0.0/go.mod h1:dBl0BpW6vV/+mYPU4Po3pmUjxk6FQPldtuIdl/M65Eg= +github.com/google/uuid v1.6.0 h1:NIvaJDMOsjHA8n1jAhLSgzrAzy1Hgr+hNrb57e+94F0= +github.com/google/uuid v1.6.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo= +github.com/jbenet/go-context v0.0.0-20150711004518-d14ea06fba99 h1:BQSFePA1RWJOlocH6Fxy8MmwDt+yVQYULKfN0RoTN8A= +github.com/jbenet/go-context v0.0.0-20150711004518-d14ea06fba99/go.mod h1:1lJo3i6rXxKeerYnT8Nvf0QmHCRC1n8sfWVwXF2Frvo= +github.com/jchv/go-winloader v0.0.0-20250406163304-c1995be93bd1 h1:njuLRcjAuMKr7kI3D85AXWkw6/+v9PwtV6M6o11sWHQ= +github.com/jchv/go-winloader v0.0.0-20250406163304-c1995be93bd1/go.mod h1:alcuEEnZsY1WQsagKhZDsoPCRoOijYqhZvPwLG0kzVs= +github.com/json-iterator/go v1.1.12 h1:PV8peI4a0ysnczrg+LtxykD8LfKY9ML6u2jnxaEnrnM= +github.com/json-iterator/go v1.1.12/go.mod h1:e30LSqwooZae/UwlEbR2852Gd8hjQvJoHmT4TnhNGBo= +github.com/kevinburke/ssh_config v1.4.0 h1:6xxtP5bZ2E4NF5tuQulISpTO2z8XbtH8cg1PWkxoFkQ= +github.com/kevinburke/ssh_config v1.4.0/go.mod h1:q2RIzfka+BXARoNexmF9gkxEX7DmvbW9P4hIVx2Kg4M= +github.com/klauspost/cpuid/v2 v2.3.0 h1:S4CRMLnYUhGeDFDqkGriYKdfoFlDnMtqTiI/sFzhA9Y= +github.com/klauspost/cpuid/v2 v2.3.0/go.mod h1:hqwkgyIinND0mEev00jJYCxPNVRVXFQeu1XKlok6oO0= +github.com/kr/pretty v0.1.0/go.mod h1:dAy3ld7l9f0ibDNOQOHHMYYIIbhfbHSm3C4ZsoJORNo= +github.com/kr/pretty v0.3.1 h1:flRD4NNwYAUpkphVc1HcthR4KEIFJ65n8Mw5qdRn3LE= +github.com/kr/pretty v0.3.1/go.mod h1:hoEshYVHaxMs3cyo3Yncou5ZscifuDolrwPKZanG3xk= +github.com/kr/pty v1.1.1/go.mod h1:pFQYn66WHrOpPYNljwOMqo10TkYh1fy3cYio2l3bCsQ= +github.com/kr/text v0.1.0/go.mod h1:4Jbv+DJW3UT/LiOwJeYQe1efqtUx/iVham/4vfdArNI= +github.com/kr/text v0.2.0 h1:5Nx0Ya0ZqY2ygV366QzturHI13Jq95ApcVaJBhpS+AY= +github.com/kr/text v0.2.0/go.mod h1:eLer722TekiGuMkidMxC/pM04lWEeraHUUmBw8l2grE= +github.com/leaanthony/go-ansi-parser v1.6.1 h1:xd8bzARK3dErqkPFtoF9F3/HgN8UQk0ed1YDKpEz01A= +github.com/leaanthony/go-ansi-parser v1.6.1/go.mod h1:+vva/2y4alzVmmIEpk9QDhA7vLC5zKDTRwfZGOp3IWU= +github.com/leaanthony/u v1.1.1 h1:TUFjwDGlNX+WuwVEzDqQwC2lOv0P4uhTQw7CMFdiK7M= +github.com/leaanthony/u v1.1.1/go.mod h1:9+o6hejoRljvZ3BzdYlVL0JYCwtnAsVuN9pVTQcaRfI= +github.com/leodido/go-urn v1.4.0 h1:WT9HwE9SGECu3lg4d/dIA+jxlljEa1/ffXKmRjqdmIQ= +github.com/leodido/go-urn v1.4.0/go.mod h1:bvxc+MVxLKB4z00jd1z+Dvzr47oO32F/QSNjSBOlFxI= +github.com/lmittmann/tint v1.1.2 h1:2CQzrL6rslrsyjqLDwD11bZ5OpLBPU+g3G/r5LSfS8w= +github.com/lmittmann/tint v1.1.2/go.mod h1:HIS3gSy7qNwGCj+5oRjAutErFBl4BzdQP6cJZ0NfMwE= +github.com/matryer/is v1.4.0/go.mod h1:8I/i5uYgLzgsgEloJE1U6xx5HkBQpAZvepWuujKwMRU= +github.com/matryer/is v1.4.1 h1:55ehd8zaGABKLXQUe2awZ99BD/PTc2ls+KV/dXphgEQ= +github.com/matryer/is v1.4.1/go.mod h1:8I/i5uYgLzgsgEloJE1U6xx5HkBQpAZvepWuujKwMRU= +github.com/mattn/go-colorable v0.1.14 h1:9A9LHSqF/7dyVVX6g0U9cwm9pG3kP9gSzcuIPHPsaIE= +github.com/mattn/go-colorable v0.1.14/go.mod h1:6LmQG8QLFO4G5z1gPvYEzlUgJ2wF+stgPZH1UqBm1s8= +github.com/mattn/go-isatty v0.0.20 h1:xfD0iDuEKnDkl03q4limB+vH+GxLEtL/jb4xVJSWWEY= +github.com/mattn/go-isatty v0.0.20/go.mod h1:W+V8PltTTMOvKvAeJH7IuucS94S2C6jfK/D7dTCTo3Y= +github.com/modern-go/concurrent v0.0.0-20180228061459-e0a39a4cb421/go.mod h1:6dJC0mAP4ikYIbvyc7fijjWJddQyLn8Ig3JB5CqoB9Q= +github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd h1:TRLaZ9cD/w8PVh93nsPXa1VrQ6jlwL5oN8l14QlcNfg= +github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd/go.mod h1:6dJC0mAP4ikYIbvyc7fijjWJddQyLn8Ig3JB5CqoB9Q= +github.com/modern-go/reflect2 v1.0.2 h1:xBagoLtFs94CBntxluKeaWgTMpvLxC4ur3nMaC9Gz0M= +github.com/modern-go/reflect2 v1.0.2/go.mod h1:yWuevngMOJpCy52FWWMvUC8ws7m/LJsjYzDa0/r8luk= +github.com/onsi/gomega v1.34.1 h1:EUMJIKUjM8sKjYbtxQI9A4z2o+rruxnzNvpknOXie6k= +github.com/onsi/gomega v1.34.1/go.mod h1:kU1QgUvBDLXBJq618Xvm2LUX6rSAfRaFRTcdOeDLwwY= +github.com/pelletier/go-toml/v2 v2.2.4 h1:mye9XuhQ6gvn5h28+VilKrrPoQVanw5PMw/TB0t5Ec4= +github.com/pelletier/go-toml/v2 v2.2.4/go.mod h1:2gIqNv+qfxSVS7cM2xJQKtLSTLUE9V8t9Stt+h56mCY= +github.com/pjbgf/sha1cd v0.5.0 h1:a+UkboSi1znleCDUNT3M5YxjOnN1fz2FhN48FlwCxs0= +github.com/pjbgf/sha1cd v0.5.0/go.mod h1:lhpGlyHLpQZoxMv8HcgXvZEhcGs0PG/vsZnEJ7H0iCM= +github.com/pkg/browser v0.0.0-20240102092130-5ac0b6a4141c h1:+mdjkGKdHQG3305AYmdv1U2eRNDiU2ErMBj1gwrq8eQ= +github.com/pkg/browser v0.0.0-20240102092130-5ac0b6a4141c/go.mod h1:7rwL4CYBLnjLxUqIJNnCWiEdr3bn6IUYi15bNlnbCCU= +github.com/pkg/errors v0.9.1 h1:FEBLx1zS214owpjy7qsBeixbURkuhQAwrK5UwLGTwt4= +github.com/pkg/errors v0.9.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0= +github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM= +github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= +github.com/quic-go/qpack v0.6.0 h1:g7W+BMYynC1LbYLSqRt8PBg5Tgwxn214ZZR34VIOjz8= +github.com/quic-go/qpack v0.6.0/go.mod h1:lUpLKChi8njB4ty2bFLX2x4gzDqXwUpaO1DP9qMDZII= +github.com/quic-go/quic-go v0.59.0 h1:OLJkp1Mlm/aS7dpKgTc6cnpynnD2Xg7C1pwL6vy/SAw= +github.com/quic-go/quic-go v0.59.0/go.mod h1:upnsH4Ju1YkqpLXC305eW3yDZ4NfnNbmQRCMWS58IKU= +github.com/rivo/uniseg v0.2.0/go.mod h1:J6wj4VEh+S6ZtnVlnTBMWIodfgj8LQOQFoIToxlJtxc= +github.com/rivo/uniseg v0.4.7 h1:WUdvkW8uEhrYfLC4ZzdpI2ztxP1I582+49Oc5Mq64VQ= +github.com/rivo/uniseg v0.4.7/go.mod h1:FN3SvrM+Zdj16jyLfmOkMNblXMcoc8DfTHruCPUcx88= +github.com/rogpeppe/go-internal v1.14.1 h1:UQB4HGPB6osV0SQTLymcB4TgvyWu6ZyliaW0tI/otEQ= +github.com/rogpeppe/go-internal v1.14.1/go.mod h1:MaRKkUm5W0goXpeCfT7UZI6fk/L7L7so1lCWt35ZSgc= +github.com/samber/lo v1.52.0 h1:Rvi+3BFHES3A8meP33VPAxiBZX/Aws5RxrschYGjomw= +github.com/samber/lo v1.52.0/go.mod h1:4+MXEGsJzbKGaUEQFKBq2xtfuznW9oz/WrgyzMzRoM0= +github.com/sergi/go-diff v1.4.0 h1:n/SP9D5ad1fORl+llWyN+D6qoUETXNZARKjyY2/KVCw= +github.com/sergi/go-diff v1.4.0/go.mod h1:A0bzQcvG0E7Rwjx0REVgAGH58e96+X0MeOfepqsbeW4= +github.com/sirupsen/logrus v1.7.0/go.mod h1:yWOB1SBYBC5VeMP7gHvWumXLIWorT60ONWic61uBYv0= +github.com/skeema/knownhosts v1.3.2 h1:EDL9mgf4NzwMXCTfaxSD/o/a5fxDw/xL9nkU28JjdBg= +github.com/skeema/knownhosts v1.3.2/go.mod h1:bEg3iQAuw+jyiw+484wwFJoKSLwcfd7fqRy+N0QTiow= +github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME= +github.com/stretchr/objx v0.4.0/go.mod h1:YvHI0jy2hoMjB+UWwv71VJQ9isScKT/TqJzVSSt89Yw= +github.com/stretchr/objx v0.5.0/go.mod h1:Yh+to48EsGEfYuaHDzXPcE3xhTkx73EhmCGUpEOglKo= +github.com/stretchr/objx v0.5.2/go.mod h1:FRsXN1f5AsAjCGJKqEizvkpNtU+EGNCLh3NxZ/8L+MA= +github.com/stretchr/testify v1.2.2/go.mod h1:a8OnRcib4nhh0OaRAV+Yts87kKdq0PP7pXfy6kDkUVs= +github.com/stretchr/testify v1.3.0/go.mod h1:M5WIy9Dh21IEIfnGCwXGc5bZfKNJtfHm1UVUgZn+9EI= +github.com/stretchr/testify v1.4.0/go.mod h1:j7eGeouHqKxXV5pUuKE4zz7dFj8WfuZ+81PSLYec5m4= +github.com/stretchr/testify v1.7.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg= +github.com/stretchr/testify v1.8.0/go.mod h1:yNjHg4UonilssWZ8iaSj1OCr/vHnekPRkoO+kdMU+MU= +github.com/stretchr/testify v1.8.4/go.mod h1:sz/lmYIOXD/1dqDmKjjqLyZ2RngseejIcXlSw2iwfAo= +github.com/stretchr/testify v1.10.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY= +github.com/stretchr/testify v1.11.1 h1:7s2iGBzp5EwR7/aIZr8ao5+dra3wiQyKjjFuvgVKu7U= +github.com/stretchr/testify v1.11.1/go.mod h1:wZwfW3scLgRK+23gO65QZefKpKQRnfz6sD981Nm4B6U= +github.com/twitchyliquid64/golang-asm v0.15.1 h1:SU5vSMR7hnwNxj24w34ZyCi/FmDZTkS4MhqMhdFk5YI= +github.com/twitchyliquid64/golang-asm v0.15.1/go.mod h1:a1lVb/DtPvCB8fslRZhAngC2+aY1QWCk3Cedj/Gdt08= +github.com/ugorji/go/codec v1.3.1 h1:waO7eEiFDwidsBN6agj1vJQ4AG7lh2yqXyOXqhgQuyY= +github.com/ugorji/go/codec v1.3.1/go.mod h1:pRBVtBSKl77K30Bv8R2P+cLSGaTtex6fsA2Wjqmfxj4= +github.com/wailsapp/go-webview2 v1.0.23 h1:jmv8qhz1lHibCc79bMM/a/FqOnnzOGEisLav+a0b9P0= +github.com/wailsapp/go-webview2 v1.0.23/go.mod h1:qJmWAmAmaniuKGZPWwne+uor3AHMB5PFhqiK0Bbj8kc= +github.com/wailsapp/wails/v3 v3.0.0-alpha.62 h1:ihEh+skkAt26PcVCil1xWbhPQIfl7Kkh0g64u8gBTe0= +github.com/wailsapp/wails/v3 v3.0.0-alpha.62/go.mod h1:ynGPamjQDXoaWjOGKAHJ6vw94PUDbeIxtbapunWcDjk= +github.com/xanzy/ssh-agent v0.3.3 h1:+/15pJfg/RsTxqYcX6fHqOXZwwMP+2VyYWJeWM2qQFM= +github.com/xanzy/ssh-agent v0.3.3/go.mod h1:6dzNDKs0J9rVPHPhaGCukekBHKqfl+L3KghI1Bc68Uw= +go.uber.org/mock v0.6.0 h1:hyF9dfmbgIX5EfOdasqLsWD6xqpNZlXblLB/Dbnwv3Y= +go.uber.org/mock v0.6.0/go.mod h1:KiVJ4BqZJaMj4svdfmHM0AUx4NJYO8ZNpPnZn1Z+BBU= +golang.org/x/arch v0.23.0 h1:lKF64A2jF6Zd8L0knGltUnegD62JMFBiCPBmQpToHhg= +golang.org/x/arch v0.23.0/go.mod h1:dNHoOeKiyja7GTvF9NJS1l3Z2yntpQNzgrjh1cU103A= +golang.org/x/crypto v0.0.0-20220622213112-05595931fe9d/go.mod h1:IxCIyHEi3zRg3s0A5j5BB6A9Jmi73HwBIUl50j+osU4= +golang.org/x/crypto v0.47.0 h1:V6e3FRj+n4dbpw86FJ8Fv7XVOql7TEwpHapKoMJ/GO8= +golang.org/x/crypto v0.47.0/go.mod h1:ff3Y9VzzKbwSSEzWqJsJVBnWmRwRSHt/6Op5n9bQc4A= +golang.org/x/exp v0.0.0-20250210185358-939b2ce775ac h1:l5+whBCLH3iH2ZNHYLbAe58bo7yrN4mVcnkHDYz5vvs= +golang.org/x/exp v0.0.0-20250210185358-939b2ce775ac/go.mod h1:hH+7mtFmImwwcMvScyxUhjuVHR3HGaDPMn9rMSUUbxo= +golang.org/x/net v0.0.0-20211112202133-69e39bad7dc2/go.mod h1:9nx3DQGgdP8bBQD5qxJ1jj9UTztislL4KSBs9R2vV5Y= +golang.org/x/net v0.49.0 h1:eeHFmOGUTtaaPSGNmjBKpbng9MulQsJURQUAfUwY++o= +golang.org/x/net v0.49.0/go.mod h1:/ysNB2EvaqvesRkuLAyjI1ycPZlQHM3q01F02UY/MV8= +golang.org/x/sys v0.0.0-20191026070338-33540a1f6037/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20200810151505-1b9f1253b3ed/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20201119102817-f84b799fce68/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20210124154548-22da62e12c0c/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20210423082822-04245dca01da/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20210615035016-665e8c7367d1/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.0.0-20220715151400-c0bba94af5f8/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.1.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.6.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.40.0 h1:DBZZqJ2Rkml6QMQsZywtnjnnGvHza6BTfYFWY9kjEWQ= +golang.org/x/sys v0.40.0/go.mod h1:OgkHotnGiDImocRcuBABYBEXf8A9a87e/uXjp9XT3ks= +golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo= +golang.org/x/term v0.39.0 h1:RclSuaJf32jOqZz74CkPA9qFuVTX7vhLlpfj/IGWlqY= +golang.org/x/term v0.39.0/go.mod h1:yxzUCTP/U+FzoxfdKmLaA0RV1WgE0VY7hXBwKtY/4ww= +golang.org/x/text v0.3.6/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ= +golang.org/x/text v0.33.0 h1:B3njUFyqtHDUI5jMn1YIr5B0IE2U0qck04r6d4KPAxE= +golang.org/x/text v0.33.0/go.mod h1:LuMebE6+rBincTi9+xWTY8TztLzKHc/9C1uBCG27+q8= +golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ= +google.golang.org/protobuf v1.36.11 h1:fV6ZwhNocDyBLK0dj+fg8ektcVegBBuEolpbTQyBNVE= +google.golang.org/protobuf v1.36.11/go.mod h1:HTf+CrKn2C3g5S8VImy6tdcUvCska2kB7j23XfzDpco= +gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= +gopkg.in/check.v1 v1.0.0-20190902080502-41f04d3bba15/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= +gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c h1:Hei/4ADfdWqJk1ZMxUNpqntNwaWcugrBjAiHlqqRiVk= +gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c/go.mod h1:JHkPIbrfpd72SG/EVd6muEfDQjcINNoR0C8j2r3qZ4Q= +gopkg.in/warnings.v0 v0.1.2 h1:wFXVbFY8DY5/xOe1ECiWdKCzZlxgshcYVNkBHstARME= +gopkg.in/warnings.v0 v0.1.2/go.mod h1:jksf8JmL6Qr/oQM2OXTHunEvvTAsrWBLb6OOjuVWRNI= +gopkg.in/yaml.v2 v2.2.2/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI= +gopkg.in/yaml.v2 v2.4.0/go.mod h1:RDklbk79AGWmwhnvt/jBztapEOGDOx6ZbXqjP6csGnQ= +gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= +gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA= +gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= diff --git a/v3/examples/gin-service/main.go b/v3/examples/gin-service/main.go new file mode 100644 index 000000000..f27fef415 --- /dev/null +++ b/v3/examples/gin-service/main.go @@ -0,0 +1,45 @@ +package main + +import ( + "embed" + "log/slog" + "os" + + "gin-service/services" + "github.com/wailsapp/wails/v3/pkg/application" +) + +//go:embed assets/* +var assets embed.FS + +func main() { + app := application.New(application.Options{ + Name: "Gin Service Demo", + Description: "A demo of using Gin in Wails services", + Mac: application.MacOptions{ + ApplicationShouldTerminateAfterLastWindowClosed: true, + }, + LogLevel: slog.LevelDebug, + Services: []application.Service{ + application.NewServiceWithOptions(services.NewGinService(), application.ServiceOptions{ + Route: "/api", + }), + }, + Assets: application.AssetOptions{ + Handler: application.BundledAssetFileServer(assets), + }, + }) + + app.Window.NewWithOptions(application.WebviewWindowOptions{ + Title: "Gin Service Demo", + Width: 1024, + Height: 768, + }) + + err := app.Run() + + if err != nil { + println(err.Error()) + os.Exit(1) + } +} diff --git a/v3/examples/gin-service/services/gin_service.go b/v3/examples/gin-service/services/gin_service.go new file mode 100644 index 000000000..e0fa290ec --- /dev/null +++ b/v3/examples/gin-service/services/gin_service.go @@ -0,0 +1,250 @@ +package services + +import ( + "context" + "net/http" + "strconv" + "strings" + "sync" + "time" + + "github.com/gin-gonic/gin" + "github.com/wailsapp/wails/v3/pkg/application" +) + +// User represents a user in the system +type User struct { + ID int `json:"id"` + Name string `json:"name"` + Email string `json:"email"` + CreatedAt time.Time `json:"createdAt"` +} + +// GinService implements a Wails service that uses Gin for HTTP handling +type GinService struct { + ginEngine *gin.Engine + users []User + nextID int + mu sync.RWMutex + app *application.App + maxUsers int // Maximum number of users to prevent unbounded growth + removeEventHandler func() // Store cleanup function for event handler +} + +type EventData struct { + Message string `json:"message"` + Timestamp string `json:"timestamp"` +} + +// NewGinService creates a new GinService instance +func NewGinService() *GinService { + // Create a new Gin router + ginEngine := gin.New() + + // Add middlewares + ginEngine.Use(gin.Recovery()) + ginEngine.Use(LoggingMiddleware()) + + service := &GinService{ + ginEngine: ginEngine, + users: []User{ + {ID: 1, Name: "Alice", Email: "alice@example.com", CreatedAt: time.Now().Add(-72 * time.Hour)}, + {ID: 2, Name: "Bob", Email: "bob@example.com", CreatedAt: time.Now().Add(-48 * time.Hour)}, + {ID: 3, Name: "Charlie", Email: "charlie@example.com", CreatedAt: time.Now().Add(-24 * time.Hour)}, + }, + nextID: 4, + maxUsers: 1000, // Limit to prevent unbounded slice growth + } + + // Define routes + service.setupRoutes() + + return service +} + +// ServiceName returns the name of the service +func (s *GinService) ServiceName() string { + return "Gin API Service" +} + +// ServiceStartup is called when the service starts +func (s *GinService) ServiceStartup(ctx context.Context, options application.ServiceOptions) error { + // You can access the application instance via ctx + s.app = application.Get() + + // Register an event handler that can be triggered from the frontend + // Store the cleanup function for proper resource management + s.removeEventHandler = s.app.Event.On("gin-api-event", func(event *application.CustomEvent) { + // Log the event data + // Parse the event data + s.app.Logger.Info("Received event from frontend", "data", event.Data) + + // You could also emit an event back to the frontend + s.app.Event.Emit("gin-api-response", map[string]interface{}{ + "message": "Response from Gin API Service", + "time": time.Now().Format(time.RFC3339), + }) + }) + + return nil +} + +// ServiceShutdown is called when the service shuts down +func (s *GinService) ServiceShutdown(ctx context.Context) error { + // Clean up event handler to prevent memory leaks + if s.removeEventHandler != nil { + s.removeEventHandler() + } + return nil +} + +// ServeHTTP implements the http.Handler interface +func (s *GinService) ServeHTTP(w http.ResponseWriter, r *http.Request) { + // All other requests go to the Gin router + s.ginEngine.ServeHTTP(w, r) +} + +// setupRoutes configures the API routes +func (s *GinService) setupRoutes() { + // Basic info endpoint + s.ginEngine.GET("/info", func(c *gin.Context) { + c.JSON(http.StatusOK, gin.H{ + "service": "Gin API Service", + "version": "1.0.0", + "time": time.Now().Format(time.RFC3339), + }) + }) + + // Users group + users := s.ginEngine.Group("/users") + { + // Get all users + users.GET("", func(c *gin.Context) { + s.mu.RLock() + defer s.mu.RUnlock() + c.JSON(http.StatusOK, s.users) + }) + + // Get user by ID + users.GET("/:id", func(c *gin.Context) { + id, err := strconv.Atoi(c.Param("id")) + if err != nil { + c.JSON(http.StatusBadRequest, gin.H{"error": "Invalid user ID"}) + return + } + + s.mu.RLock() + defer s.mu.RUnlock() + + for _, user := range s.users { + if user.ID == id { + c.JSON(http.StatusOK, user) + return + } + } + + c.JSON(http.StatusNotFound, gin.H{"error": "User not found"}) + }) + + // Create a new user + users.POST("", func(c *gin.Context) { + var newUser User + if err := c.ShouldBindJSON(&newUser); err != nil { + c.JSON(http.StatusBadRequest, gin.H{"error": err.Error()}) + return + } + + // Validate required fields + if newUser.Name == "" { + c.JSON(http.StatusBadRequest, gin.H{"error": "Name is required"}) + return + } + if newUser.Email == "" { + c.JSON(http.StatusBadRequest, gin.H{"error": "Email is required"}) + return + } + // Basic email validation (consider using a proper validator library in production) + if !strings.Contains(newUser.Email, "@") { + c.JSON(http.StatusBadRequest, gin.H{"error": "Invalid email format"}) + return + } + + s.mu.Lock() + defer s.mu.Unlock() + + // Check if we've reached the maximum number of users + if len(s.users) >= s.maxUsers { + c.JSON(http.StatusServiceUnavailable, gin.H{"error": "Maximum number of users reached"}) + return + } + + // Set the ID and creation time + newUser.ID = s.nextID + newUser.CreatedAt = time.Now() + s.nextID++ + + // Add to the users slice + s.users = append(s.users, newUser) + + c.JSON(http.StatusCreated, newUser) + + // Emit an event to notify about the new user + s.app.Event.Emit("user-created", newUser) + }) + + // Delete a user + users.DELETE("/:id", func(c *gin.Context) { + id, err := strconv.Atoi(c.Param("id")) + if err != nil { + c.JSON(http.StatusBadRequest, gin.H{"error": "Invalid user ID"}) + return + } + + s.mu.Lock() + defer s.mu.Unlock() + + for i, user := range s.users { + if user.ID == id { + // Remove the user from the slice + s.users = append(s.users[:i], s.users[i+1:]...) + c.JSON(http.StatusOK, gin.H{"message": "User deleted"}) + return + } + } + + c.JSON(http.StatusNotFound, gin.H{"error": "User not found"}) + }) + } +} + +// LoggingMiddleware is a Gin middleware that logs request details +func LoggingMiddleware() gin.HandlerFunc { + return func(c *gin.Context) { + // Start timer + start := time.Now() + + // Process request + c.Next() + + // Calculate latency + latency := time.Since(start) + + // Log request details + statusCode := c.Writer.Status() + clientIP := c.ClientIP() + method := c.Request.Method + path := c.Request.URL.Path + + // Get the application instance + app := application.Get() + if app != nil { + app.Logger.Info("HTTP Request", + "status", statusCode, + "method", method, + "path", path, + "ip", clientIP, + "latency", latency, + ) + } + } +} diff --git a/v3/examples/hide-window/main.go b/v3/examples/hide-window/main.go new file mode 100644 index 000000000..1a65c7498 --- /dev/null +++ b/v3/examples/hide-window/main.go @@ -0,0 +1,69 @@ +package main + +import ( + _ "embed" + "github.com/wailsapp/wails/v3/pkg/application" + "github.com/wailsapp/wails/v3/pkg/events" + "github.com/wailsapp/wails/v3/pkg/icons" + "log" + "runtime" +) + +func main() { + app := application.New(application.Options{ + Name: "Hide Window Demo", + Description: "A test of Hidden window and display it", + Assets: application.AlphaAssets, + Mac: application.MacOptions{ + ApplicationShouldTerminateAfterLastWindowClosed: false, + }, + }) + + systemTray := app.SystemTray.New() + + window := app.Window.NewWithOptions(application.WebviewWindowOptions{ + Width: 500, + Height: 800, + Frameless: false, + AlwaysOnTop: false, + Hidden: false, + DisableResize: false, + Windows: application.WindowsWindow{ + HiddenOnTaskbar: true, + }, + }) + + window.RegisterHook(events.Common.WindowClosing, func(e *application.WindowEvent) { + window.Hide() + e.Cancel() + }) + + if runtime.GOOS == "darwin" { + systemTray.SetTemplateIcon(icons.SystrayMacTemplate) + } + + // Click Dock icon tigger application show + app.Event.OnApplicationEvent(events.Mac.ApplicationShouldHandleReopen, func(event *application.ApplicationEvent) { + println("reopen") + window.Show() + }) + + myMenu := app.NewMenu() + myMenu.Add("Show").OnClick(func(ctx *application.Context) { + window.Show() + }) + + myMenu.Add("Quit").OnClick(func(ctx *application.Context) { + app.Quit() + }) + + systemTray.SetMenu(myMenu) + systemTray.OnClick(func() { + window.Show() + }) + + err := app.Run() + if err != nil { + log.Fatal(err) + } +} diff --git a/v3/examples/ignore-mouse/README.md b/v3/examples/ignore-mouse/README.md new file mode 100644 index 000000000..596d2c015 --- /dev/null +++ b/v3/examples/ignore-mouse/README.md @@ -0,0 +1,19 @@ +# Window Example + +This example is a demonstration of how to disable or enable mouse events. + +## Running the example + +To run the example, simply run the following command: + +```bash +go run . +``` + +# Status + +| Platform | Status | +|----------|---------| +| Mac | | +| Windows | Working | +| Linux | | diff --git a/v3/examples/ignore-mouse/main.go b/v3/examples/ignore-mouse/main.go new file mode 100644 index 000000000..1fc0304f2 --- /dev/null +++ b/v3/examples/ignore-mouse/main.go @@ -0,0 +1,36 @@ +package main + +import ( + "log" + + "github.com/wailsapp/wails/v3/pkg/application" +) + +func main() { + app := application.New(application.Options{ + Name: "WebviewWindow Demo", + Description: "A demo of the WebviewWindow API", + Assets: application.AlphaAssets, + Mac: application.MacOptions{ + ApplicationShouldTerminateAfterLastWindowClosed: false, + }, + }) + + window := app.Window.NewWithOptions(application.WebviewWindowOptions{ + Width: 800, + Height: 600, + Title: "Ignore Mouse Example", + URL: "https://wails.io", + IgnoreMouseEvents: false, + }) + + window.SetIgnoreMouseEvents(true) + log.Println("IgnoreMouseEvents set", window.IsIgnoreMouseEvents()) + + err := app.Run() + + if err != nil { + log.Fatal(err) + } + +} diff --git a/v3/examples/ios-poc/frontend/index.html b/v3/examples/ios-poc/frontend/index.html new file mode 100644 index 000000000..75070d43e --- /dev/null +++ b/v3/examples/ios-poc/frontend/index.html @@ -0,0 +1,247 @@ + + + + + + Wails v3 iOS Demo + + + +
            +

            🚀 Wails v3 iOS

            +

            Proof of Concept Demo

            + +
            +

            1. WebView Test

            + +
            Ready to test...
            +
            + +
            +

            2. Asset Server Test

            + +
            Ready to test...
            +
            + +
            +

            3. JavaScript Bridge Test

            + +
            Ready to test...
            +
            + +
            +

            4. Go Communication Test

            + + +
            Ready to test...
            +
            + +
            +

            Test Results:

            +
            + + WebView Creation +
            +
            + + Request Interception +
            +
            + + JS Execution +
            +
            + + iOS Simulator +
            +
            + +
            +
            +
            + iOS WebView Active +
            +
            + Platform: iOS +
            +
            +
            + + + + \ No newline at end of file diff --git a/v3/examples/ios-poc/main.go b/v3/examples/ios-poc/main.go new file mode 100644 index 000000000..62cae636b --- /dev/null +++ b/v3/examples/ios-poc/main.go @@ -0,0 +1,43 @@ +//go:build ios + +package main + +import ( + "embed" + "fmt" + "log" + + "github.com/wailsapp/wails/v3/pkg/application" +) + +//go:embed frontend/* +var assets embed.FS + +// App struct for binding methods +type App struct{} + +// Greet returns a greeting message +func (a *App) Greet(name string) string { + return fmt.Sprintf("Hello %s from Wails v3 on iOS!", name) +} + +func main() { + // Create application with options + app := application.New(application.Options{ + Name: "Wails iOS PoC", + Description: "Proof of concept for Wails v3 on iOS", + Assets: application.AssetOptions{ + FS: assets, + }, + Services: []application.Service{ + application.NewService(&App{}), + }, + LogLevel: application.LogLevelDebug, + }) + + // Run the application + err := app.Run() + if err != nil { + log.Fatal(err) + } +} \ No newline at end of file diff --git a/v3/examples/ios/.gitignore b/v3/examples/ios/.gitignore new file mode 100644 index 000000000..ba8194ab6 --- /dev/null +++ b/v3/examples/ios/.gitignore @@ -0,0 +1,6 @@ +.task +bin +frontend/dist +frontend/node_modules +build/linux/appimage/build +build/windows/nsis/MicrosoftEdgeWebview2Setup.exe \ No newline at end of file diff --git a/v3/examples/ios/README.md b/v3/examples/ios/README.md new file mode 100644 index 000000000..ad12c3f40 --- /dev/null +++ b/v3/examples/ios/README.md @@ -0,0 +1,59 @@ +# Welcome to Your New Wails3 Project! + +Congratulations on generating your Wails3 application! This README will guide you through the next steps to get your project up and running. + +## Getting Started + +1. Navigate to your project directory in the terminal. + +2. To run your application in development mode, use the following command: + + ``` + wails3 dev + ``` + + This will start your application and enable hot-reloading for both frontend and backend changes. + +3. To build your application for production, use: + + ``` + wails3 build + ``` + + This will create a production-ready executable in the `build` directory. + +## Exploring Wails3 Features + +Now that you have your project set up, it's time to explore the features that Wails3 offers: + +1. **Check out the examples**: The best way to learn is by example. Visit the `examples` directory in the `v3/examples` directory to see various sample applications. + +2. **Run an example**: To run any of the examples, navigate to the example's directory and use: + + ``` + go run . + ``` + + Note: Some examples may be under development during the alpha phase. + +3. **Explore the documentation**: Visit the [Wails3 documentation](https://v3.wails.io/) for in-depth guides and API references. + +4. **Join the community**: Have questions or want to share your progress? Join the [Wails Discord](https://discord.gg/JDdSxwjhGf) or visit the [Wails discussions on GitHub](https://github.com/wailsapp/wails/discussions). + +## Project Structure + +Take a moment to familiarize yourself with your project structure: + +- `frontend/`: Contains your frontend code (HTML, CSS, JavaScript/TypeScript) +- `main.go`: The entry point of your Go backend +- `app.go`: Define your application structure and methods here +- `wails.json`: Configuration file for your Wails project + +## Next Steps + +1. Modify the frontend in the `frontend/` directory to create your desired UI. +2. Add backend functionality in `main.go`. +3. Use `wails3 dev` to see your changes in real-time. +4. When ready, build your application with `wails3 build`. + +Happy coding with Wails3! If you encounter any issues or have questions, don't hesitate to consult the documentation or reach out to the Wails community. diff --git a/v3/examples/ios/Taskfile.yml b/v3/examples/ios/Taskfile.yml new file mode 100644 index 000000000..e198e184f --- /dev/null +++ b/v3/examples/ios/Taskfile.yml @@ -0,0 +1,34 @@ +version: '3' + +includes: + common: ./build/Taskfile.yml + windows: ./build/windows/Taskfile.yml + darwin: ./build/darwin/Taskfile.yml + linux: ./build/linux/Taskfile.yml + ios: ./build/ios/Taskfile.yml + +vars: + APP_NAME: "ios" + BIN_DIR: "bin" + VITE_PORT: '{{.WAILS_VITE_PORT | default 9245}}' + +tasks: + build: + summary: Builds the application + cmds: + - task: "{{OS}}:build" + + package: + summary: Packages a production build of the application + cmds: + - task: "{{OS}}:package" + + run: + summary: Runs the application + cmds: + - task: "{{OS}}:run" + + dev: + summary: Runs the application in development mode + cmds: + - wails3 dev -config ./build/config.yml -port {{.VITE_PORT}} diff --git a/v3/examples/ios/build/Taskfile.yml b/v3/examples/ios/build/Taskfile.yml new file mode 100644 index 000000000..e0a74df87 --- /dev/null +++ b/v3/examples/ios/build/Taskfile.yml @@ -0,0 +1,175 @@ +version: '3' + +tasks: + go:mod:tidy: + summary: Runs `go mod tidy` + internal: true + cmds: + - go mod tidy + + install:frontend:deps: + summary: Install frontend dependencies + dir: frontend + sources: + - package.json + - package-lock.json + generates: + - node_modules/* + preconditions: + - sh: npm version + msg: "Looks like npm isn't installed. Npm is part of the Node installer: https://nodejs.org/en/download/" + cmds: + - npm install + + build:frontend: + label: build:frontend (PRODUCTION={{.PRODUCTION}}) + summary: Build the frontend project + dir: frontend + sources: + - "**/*" + - exclude: node_modules/**/* + generates: + - dist/**/* + deps: + - task: install:frontend:deps + - task: generate:bindings + vars: + BUILD_FLAGS: + ref: .BUILD_FLAGS + cmds: + - npm run {{.BUILD_COMMAND}} -q + env: + PRODUCTION: '{{.PRODUCTION | default "false"}}' + vars: + BUILD_COMMAND: '{{if eq .PRODUCTION "true"}}build{{else}}build:dev{{end}}' + + + frontend:vendor:puppertino: + summary: Fetches Puppertino CSS into frontend/public for consistent mobile styling + sources: + - frontend/public/puppertino/puppertino.css + generates: + - frontend/public/puppertino/puppertino.css + cmds: + - | + set -euo pipefail + mkdir -p frontend/public/puppertino + # Fetch Puppertino full.css and LICENSE from GitHub main branch + curl -fsSL https://raw.githubusercontent.com/codedgar/Puppertino/main/dist/css/full.css -o frontend/public/puppertino/puppertino.css + curl -fsSL https://raw.githubusercontent.com/codedgar/Puppertino/main/LICENSE -o frontend/public/puppertino/LICENSE + echo "Puppertino CSS updated at frontend/public/puppertino/puppertino.css" + # Ensure index.html includes Puppertino CSS and button classes + INDEX_HTML=frontend/index.html + if [ -f "$INDEX_HTML" ]; then + if ! grep -q 'href="/puppertino/puppertino.css"' "$INDEX_HTML"; then + # Insert Puppertino link tag after style.css link + awk ' + /href="\/style.css"\/?/ && !x { print; print " "; x=1; next }1 + ' "$INDEX_HTML" > "$INDEX_HTML.tmp" && mv "$INDEX_HTML.tmp" "$INDEX_HTML" + fi + # Replace default .btn with Puppertino primary button classes if present + sed -E -i'' 's/class=\"btn\"/class=\"p-btn p-prim-col\"/g' "$INDEX_HTML" || true + fi + + generate:bindings: + label: generate:bindings (BUILD_FLAGS={{.BUILD_FLAGS}}) + summary: Generates bindings for the frontend + deps: + - task: go:mod:tidy + sources: + - "**/*.[jt]s" + - exclude: frontend/**/* + - frontend/bindings/**/* # Rerun when switching between dev/production mode causes changes in output + - "**/*.go" + - go.mod + - go.sum + generates: + - frontend/bindings/**/* + cmds: + - wails3 generate bindings -f '{{.BUILD_FLAGS}}' -clean=true + + generate:icons: + summary: Generates Windows `.ico` and Mac `.icns` files from an image + dir: build + sources: + - "appicon.png" + generates: + - "darwin/icons.icns" + - "windows/icon.ico" + cmds: + - wails3 generate icons -input appicon.png -macfilename darwin/icons.icns -windowsfilename windows/icon.ico + + dev:frontend: + summary: Runs the frontend in development mode + dir: frontend + deps: + - task: install:frontend:deps + cmds: + - npm run dev -- --port {{.VITE_PORT}} --strictPort + + update:build-assets: + summary: Updates the build assets + dir: build + cmds: + - wails3 update build-assets -name "{{.APP_NAME}}" -binaryname "{{.APP_NAME}}" -config config.yml -dir . + + + ios:device:list: + summary: Lists connected iOS devices (UDIDs) + cmds: + - xcrun xcdevice list + + ios:run:device: + summary: Build, install, and launch on a physical iPhone using Apple tools (xcodebuild/devicectl) + vars: + PROJECT: '{{.PROJECT}}' # e.g., build/ios/xcode/.xcodeproj + SCHEME: '{{.SCHEME}}' # e.g., ios.dev + CONFIG: '{{.CONFIG | default "Debug"}}' + DERIVED: '{{.DERIVED | default "build/ios/DerivedData"}}' + UDID: '{{.UDID}}' # from `task ios:device:list` + BUNDLE_ID: '{{.BUNDLE_ID}}' # e.g., com.yourco.wails.ios.dev + TEAM_ID: '{{.TEAM_ID}}' # optional, if your project is not already set up for signing + preconditions: + - sh: xcrun -f xcodebuild + msg: "xcodebuild not found. Please install Xcode." + - sh: xcrun -f devicectl + msg: "devicectl not found. Please update to Xcode 15+ (which includes devicectl)." + - sh: test -n "{{.PROJECT}}" + msg: "Set PROJECT to your .xcodeproj path (e.g., PROJECT=build/ios/xcode/App.xcodeproj)." + - sh: test -n "{{.SCHEME}}" + msg: "Set SCHEME to your app scheme (e.g., SCHEME=ios.dev)." + - sh: test -n "{{.UDID}}" + msg: "Set UDID to your device UDID (see: task ios:device:list)." + - sh: test -n "{{.BUNDLE_ID}}" + msg: "Set BUNDLE_ID to your app's bundle identifier (e.g., com.yourco.wails.ios.dev)." + cmds: + - | + set -euo pipefail + echo "Building for device: UDID={{.UDID}} SCHEME={{.SCHEME}} PROJECT={{.PROJECT}}" + XCB_ARGS=( + -project "{{.PROJECT}}" + -scheme "{{.SCHEME}}" + -configuration "{{.CONFIG}}" + -destination "id={{.UDID}}" + -derivedDataPath "{{.DERIVED}}" + -allowProvisioningUpdates + -allowProvisioningDeviceRegistration + ) + # Optionally inject signing identifiers if provided + if [ -n "{{.TEAM_ID}}" ]; then XCB_ARGS+=(DEVELOPMENT_TEAM={{.TEAM_ID}}); fi + if [ -n "{{.BUNDLE_ID}}" ]; then XCB_ARGS+=(PRODUCT_BUNDLE_IDENTIFIER={{.BUNDLE_ID}}); fi + xcodebuild "${XCB_ARGS[@]}" build | xcpretty || true + # If xcpretty isn't installed, run without it + if [ "${PIPESTATUS[0]}" -ne 0 ]; then + xcodebuild "${XCB_ARGS[@]}" build + fi + # Find built .app + APP_PATH=$(find "{{.DERIVED}}/Build/Products" -type d -name "*.app" -maxdepth 3 | head -n 1) + if [ -z "$APP_PATH" ]; then + echo "Could not locate built .app under {{.DERIVED}}/Build/Products" >&2 + exit 1 + fi + echo "Installing: $APP_PATH" + xcrun devicectl device install app --device "{{.UDID}}" "$APP_PATH" + echo "Launching: {{.BUNDLE_ID}}" + xcrun devicectl device process launch --device "{{.UDID}}" --stderr console --stdout console "{{.BUNDLE_ID}}" diff --git a/v3/examples/ios/build/appicon.png b/v3/examples/ios/build/appicon.png new file mode 100644 index 000000000..63617fe4f Binary files /dev/null and b/v3/examples/ios/build/appicon.png differ diff --git a/v3/examples/ios/build/config.yml b/v3/examples/ios/build/config.yml new file mode 100644 index 000000000..a8e7e1fa5 --- /dev/null +++ b/v3/examples/ios/build/config.yml @@ -0,0 +1,77 @@ +# This file contains the configuration for this project. +# When you update `info` or `fileAssociations`, run `wails3 task common:update:build-assets` to update the assets. +# Note that this will overwrite any changes you have made to the assets. +version: '3' + +# This information is used to generate the build assets. +info: + companyName: "My Company" # The name of the company + productName: "My Product" # The name of the application + productIdentifier: "com.mycompany.myproduct" # The unique product identifier + description: "A program that does X" # The application description + copyright: "(c) 2025, My Company" # Copyright text + comments: "Some Product Comments" # Comments + version: "0.0.1" # The application version + +# iOS build configuration (uncomment to customise iOS project generation) +# Note: Keys under `ios` OVERRIDE values under `info` when set. +# ios: +# # The iOS bundle identifier used in the generated Xcode project (CFBundleIdentifier) +# bundleID: "com.mycompany.myproduct" +# # The display name shown under the app icon (CFBundleDisplayName/CFBundleName) +# displayName: "My Product" +# # The app version to embed in Info.plist (CFBundleShortVersionString/CFBundleVersion) +# version: "0.0.1" +# # The company/organisation name for templates and project settings +# company: "My Company" +# # Additional comments to embed in Info.plist metadata +# comments: "Some Product Comments" + +# Dev mode configuration +dev_mode: + root_path: . + log_level: warn + debounce: 1000 + ignore: + dir: + - .git + - node_modules + - frontend + - bin + file: + - .DS_Store + - .gitignore + - .gitkeep + watched_extension: + - "*.go" + git_ignore: true + executes: + - cmd: wails3 task common:install:frontend:deps + type: once + - cmd: wails3 task common:dev:frontend + type: background + - cmd: go mod tidy + type: blocking + - cmd: wails3 task build + type: blocking + - cmd: wails3 task run + type: primary + +# File Associations +# More information at: https://v3.wails.io/noit/done/yet +fileAssociations: +# - ext: wails +# name: Wails +# description: Wails Application File +# iconName: wailsFileIcon +# role: Editor +# - ext: jpg +# name: JPEG +# description: Image File +# iconName: jpegFileIcon +# role: Editor +# mimeType: image/jpeg # (optional) + +# Other data +other: + - name: My Other Data \ No newline at end of file diff --git a/v3/examples/ios/build/darwin/Info.dev.plist b/v3/examples/ios/build/darwin/Info.dev.plist new file mode 100644 index 000000000..bd6a537fa --- /dev/null +++ b/v3/examples/ios/build/darwin/Info.dev.plist @@ -0,0 +1,32 @@ + + + + CFBundlePackageType + APPL + CFBundleName + My Product + CFBundleExecutable + ios + CFBundleIdentifier + com.wails.ios + CFBundleVersion + 0.1.0 + CFBundleGetInfoString + This is a comment + CFBundleShortVersionString + 0.1.0 + CFBundleIconFile + icons + LSMinimumSystemVersion + 10.15.0 + NSHighResolutionCapable + true + NSHumanReadableCopyright + © now, My Company + NSAppTransportSecurity + + NSAllowsLocalNetworking + + + + \ No newline at end of file diff --git a/v3/examples/ios/build/darwin/Info.plist b/v3/examples/ios/build/darwin/Info.plist new file mode 100644 index 000000000..fb52df715 --- /dev/null +++ b/v3/examples/ios/build/darwin/Info.plist @@ -0,0 +1,27 @@ + + + + CFBundlePackageType + APPL + CFBundleName + My Product + CFBundleExecutable + ios + CFBundleIdentifier + com.wails.ios + CFBundleVersion + 0.1.0 + CFBundleGetInfoString + This is a comment + CFBundleShortVersionString + 0.1.0 + CFBundleIconFile + icons + LSMinimumSystemVersion + 10.15.0 + NSHighResolutionCapable + true + NSHumanReadableCopyright + © now, My Company + + \ No newline at end of file diff --git a/v3/examples/ios/build/darwin/Taskfile.yml b/v3/examples/ios/build/darwin/Taskfile.yml new file mode 100644 index 000000000..f0791fea9 --- /dev/null +++ b/v3/examples/ios/build/darwin/Taskfile.yml @@ -0,0 +1,81 @@ +version: '3' + +includes: + common: ../Taskfile.yml + +tasks: + build: + summary: Creates a production build of the application + deps: + - task: common:go:mod:tidy + - task: common:build:frontend + vars: + BUILD_FLAGS: + ref: .BUILD_FLAGS + PRODUCTION: + ref: .PRODUCTION + - task: common:generate:icons + cmds: + - go build {{.BUILD_FLAGS}} -o {{.OUTPUT}} + vars: + BUILD_FLAGS: '{{if eq .PRODUCTION "true"}}-tags production -trimpath -buildvcs=false -ldflags="-w -s"{{else}}-buildvcs=false -gcflags=all="-l"{{end}}' + DEFAULT_OUTPUT: '{{.BIN_DIR}}/{{.APP_NAME}}' + OUTPUT: '{{ .OUTPUT | default .DEFAULT_OUTPUT }}' + env: + GOOS: darwin + CGO_ENABLED: 1 + GOARCH: '{{.ARCH | default ARCH}}' + CGO_CFLAGS: "-mmacosx-version-min=10.15" + CGO_LDFLAGS: "-mmacosx-version-min=10.15" + MACOSX_DEPLOYMENT_TARGET: "10.15" + PRODUCTION: '{{.PRODUCTION | default "false"}}' + + build:universal: + summary: Builds darwin universal binary (arm64 + amd64) + deps: + - task: build + vars: + ARCH: amd64 + OUTPUT: "{{.BIN_DIR}}/{{.APP_NAME}}-amd64" + - task: build + vars: + ARCH: arm64 + OUTPUT: "{{.BIN_DIR}}/{{.APP_NAME}}-arm64" + cmds: + - lipo -create -output "{{.BIN_DIR}}/{{.APP_NAME}}" "{{.BIN_DIR}}/{{.APP_NAME}}-amd64" "{{.BIN_DIR}}/{{.APP_NAME}}-arm64" + - rm "{{.BIN_DIR}}/{{.APP_NAME}}-amd64" "{{.BIN_DIR}}/{{.APP_NAME}}-arm64" + + package: + summary: Packages a production build of the application into a `.app` bundle + deps: + - task: build + vars: + PRODUCTION: "true" + cmds: + - task: create:app:bundle + + package:universal: + summary: Packages darwin universal binary (arm64 + amd64) + deps: + - task: build:universal + cmds: + - task: create:app:bundle + + + create:app:bundle: + summary: Creates an `.app` bundle + cmds: + - mkdir -p {{.BIN_DIR}}/{{.APP_NAME}}.app/Contents/{MacOS,Resources} + - cp build/darwin/icons.icns {{.BIN_DIR}}/{{.APP_NAME}}.app/Contents/Resources + - cp {{.BIN_DIR}}/{{.APP_NAME}} {{.BIN_DIR}}/{{.APP_NAME}}.app/Contents/MacOS + - cp build/darwin/Info.plist {{.BIN_DIR}}/{{.APP_NAME}}.app/Contents + - codesign --force --deep --sign - {{.BIN_DIR}}/{{.APP_NAME}}.app + + run: + cmds: + - mkdir -p {{.BIN_DIR}}/{{.APP_NAME}}.dev.app/Contents/{MacOS,Resources} + - cp build/darwin/icons.icns {{.BIN_DIR}}/{{.APP_NAME}}.dev.app/Contents/Resources + - cp {{.BIN_DIR}}/{{.APP_NAME}} {{.BIN_DIR}}/{{.APP_NAME}}.dev.app/Contents/MacOS + - cp build/darwin/Info.dev.plist {{.BIN_DIR}}/{{.APP_NAME}}.dev.app/Contents/Info.plist + - codesign --force --deep --sign - {{.BIN_DIR}}/{{.APP_NAME}}.dev.app + - '{{.BIN_DIR}}/{{.APP_NAME}}.dev.app/Contents/MacOS/{{.APP_NAME}}' diff --git a/v3/examples/ios/build/darwin/icons.icns b/v3/examples/ios/build/darwin/icons.icns new file mode 100644 index 000000000..1b5bd4c86 Binary files /dev/null and b/v3/examples/ios/build/darwin/icons.icns differ diff --git a/v3/examples/ios/build/ios/Assets.xcassets b/v3/examples/ios/build/ios/Assets.xcassets new file mode 100644 index 000000000..46fbb8787 --- /dev/null +++ b/v3/examples/ios/build/ios/Assets.xcassets @@ -0,0 +1,116 @@ +{ + "info" : { + "author" : "xcode", + "version" : 1 + }, + "images" : [ + { + "filename" : "icon-20@2x.png", + "idiom" : "iphone", + "scale" : "2x", + "size" : "20x20" + }, + { + "filename" : "icon-20@3x.png", + "idiom" : "iphone", + "scale" : "3x", + "size" : "20x20" + }, + { + "filename" : "icon-29@2x.png", + "idiom" : "iphone", + "scale" : "2x", + "size" : "29x29" + }, + { + "filename" : "icon-29@3x.png", + "idiom" : "iphone", + "scale" : "3x", + "size" : "29x29" + }, + { + "filename" : "icon-40@2x.png", + "idiom" : "iphone", + "scale" : "2x", + "size" : "40x40" + }, + { + "filename" : "icon-40@3x.png", + "idiom" : "iphone", + "scale" : "3x", + "size" : "40x40" + }, + { + "filename" : "icon-60@2x.png", + "idiom" : "iphone", + "scale" : "2x", + "size" : "60x60" + }, + { + "filename" : "icon-60@3x.png", + "idiom" : "iphone", + "scale" : "3x", + "size" : "60x60" + }, + { + "filename" : "icon-20.png", + "idiom" : "ipad", + "scale" : "1x", + "size" : "20x20" + }, + { + "filename" : "icon-20@2x.png", + "idiom" : "ipad", + "scale" : "2x", + "size" : "20x20" + }, + { + "filename" : "icon-29.png", + "idiom" : "ipad", + "scale" : "1x", + "size" : "29x29" + }, + { + "filename" : "icon-29@2x.png", + "idiom" : "ipad", + "scale" : "2x", + "size" : "29x29" + }, + { + "filename" : "icon-40.png", + "idiom" : "ipad", + "scale" : "1x", + "size" : "40x40" + }, + { + "filename" : "icon-40@2x.png", + "idiom" : "ipad", + "scale" : "2x", + "size" : "40x40" + }, + { + "filename" : "icon-76.png", + "idiom" : "ipad", + "scale" : "1x", + "size" : "76x76" + }, + { + "filename" : "icon-76@2x.png", + "idiom" : "ipad", + "scale" : "2x", + "size" : "76x76" + }, + { + "filename" : "icon-83.5@2x.png", + "idiom" : "ipad", + "scale" : "2x", + "size" : "83.5x83.5" + }, + { + "filename" : "icon-1024.png", + "idiom" : "ios-marketing", + "scale" : "1x", + "size" : "1024x1024" + } + ] +} \ No newline at end of file diff --git a/v3/examples/ios/build/ios/Info.dev.plist b/v3/examples/ios/build/ios/Info.dev.plist new file mode 100644 index 000000000..89f0b201e --- /dev/null +++ b/v3/examples/ios/build/ios/Info.dev.plist @@ -0,0 +1,62 @@ + + + + + CFBundleExecutable + ios + CFBundleIdentifier + com.wails.ios.dev + CFBundleName + My Product (Dev) + CFBundleDisplayName + My Product (Dev) + CFBundlePackageType + APPL + CFBundleShortVersionString + 0.1.0-dev + CFBundleVersion + 0.1.0 + LSRequiresIPhoneOS + + MinimumOSVersion + 15.0 + UILaunchStoryboardName + LaunchScreen + UIRequiredDeviceCapabilities + + armv7 + arm64 + + UISupportedInterfaceOrientations + + UIInterfaceOrientationPortrait + UIInterfaceOrientationLandscapeLeft + UIInterfaceOrientationLandscapeRight + + UISupportedInterfaceOrientations~ipad + + UIInterfaceOrientationPortrait + UIInterfaceOrientationPortraitUpsideDown + UIInterfaceOrientationLandscapeLeft + UIInterfaceOrientationLandscapeRight + + NSAppTransportSecurity + + NSAllowsArbitraryLoads + + NSAllowsLocalNetworking + + + + WailsDevelopmentMode + + + NSHumanReadableCopyright + © now, My Company + + + CFBundleGetInfoString + This is a comment + + + \ No newline at end of file diff --git a/v3/examples/ios/build/ios/Info.plist b/v3/examples/ios/build/ios/Info.plist new file mode 100644 index 000000000..68d63a232 --- /dev/null +++ b/v3/examples/ios/build/ios/Info.plist @@ -0,0 +1,59 @@ + + + + + CFBundleExecutable + ios + CFBundleIdentifier + com.wails.ios + CFBundleName + My Product + CFBundleDisplayName + My Product + CFBundlePackageType + APPL + CFBundleShortVersionString + 0.1.0 + CFBundleVersion + 0.1.0 + LSRequiresIPhoneOS + + MinimumOSVersion + 15.0 + UILaunchStoryboardName + LaunchScreen + UIRequiredDeviceCapabilities + + armv7 + arm64 + + UISupportedInterfaceOrientations + + UIInterfaceOrientationPortrait + UIInterfaceOrientationLandscapeLeft + UIInterfaceOrientationLandscapeRight + + UISupportedInterfaceOrientations~ipad + + UIInterfaceOrientationPortrait + UIInterfaceOrientationPortraitUpsideDown + UIInterfaceOrientationLandscapeLeft + UIInterfaceOrientationLandscapeRight + + NSAppTransportSecurity + + NSAllowsArbitraryLoads + + NSAllowsLocalNetworking + + + + NSHumanReadableCopyright + © now, My Company + + + CFBundleGetInfoString + This is a comment + + + \ No newline at end of file diff --git a/v3/examples/ios/build/ios/LaunchScreen.storyboard b/v3/examples/ios/build/ios/LaunchScreen.storyboard new file mode 100644 index 000000000..eac48ae35 --- /dev/null +++ b/v3/examples/ios/build/ios/LaunchScreen.storyboard @@ -0,0 +1,53 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/v3/examples/ios/build/ios/Taskfile.yml b/v3/examples/ios/build/ios/Taskfile.yml new file mode 100644 index 000000000..bf1502a71 --- /dev/null +++ b/v3/examples/ios/build/ios/Taskfile.yml @@ -0,0 +1,282 @@ +version: '3' + +includes: + common: ../Taskfile.yml + +vars: + BUNDLE_ID: '{{.BUNDLE_ID | default "com.wails.app"}}' + SDK_PATH: + sh: xcrun --sdk iphonesimulator --show-sdk-path + +tasks: + install:deps: + summary: Check and install iOS development dependencies + cmds: + - go run build/ios/scripts/deps/install_deps.go + env: + TASK_FORCE_YES: '{{if .YES}}true{{else}}false{{end}}' + prompt: This will check and install iOS development dependencies. Continue? + + # Note: Bindings generation may show CGO warnings for iOS C imports. + # These warnings are harmless and don't affect the generated bindings, + # as the generator only needs to parse Go types, not C implementations. + build: + summary: Creates a build of the application for iOS + deps: + - task: generate:ios:overlay + - task: generate:ios:xcode + - task: common:go:mod:tidy + - task: generate:ios:bindings + vars: + BUILD_FLAGS: + ref: .BUILD_FLAGS + - task: common:build:frontend + vars: + BUILD_FLAGS: + ref: .BUILD_FLAGS + PRODUCTION: + ref: .PRODUCTION + - task: common:generate:icons + cmds: + - echo "Building iOS app {{.APP_NAME}}..." + - go build -buildmode=c-archive -overlay build/ios/xcode/overlay.json {{.BUILD_FLAGS}} -o {{.OUTPUT}}.a + vars: + BUILD_FLAGS: '{{if eq .PRODUCTION "true"}}-tags production,ios -trimpath -buildvcs=false -ldflags="-w -s"{{else}}-tags ios,debug -buildvcs=false -gcflags=all="-l"{{end}}' + DEFAULT_OUTPUT: '{{.BIN_DIR}}/{{.APP_NAME}}' + OUTPUT: '{{ .OUTPUT | default .DEFAULT_OUTPUT }}' + env: + GOOS: ios + CGO_ENABLED: 1 + GOARCH: '{{.ARCH | default "arm64"}}' + PRODUCTION: '{{.PRODUCTION | default "false"}}' + CGO_CFLAGS: '-isysroot {{.SDK_PATH}} -target arm64-apple-ios15.0-simulator -mios-simulator-version-min=15.0' + CGO_LDFLAGS: '-isysroot {{.SDK_PATH}} -target arm64-apple-ios15.0-simulator' + + compile:objc: + summary: Compile Objective-C iOS wrapper + cmds: + - xcrun -sdk iphonesimulator clang -target arm64-apple-ios15.0-simulator -isysroot {{.SDK_PATH}} -framework Foundation -framework UIKit -framework WebKit -o {{.BIN_DIR}}/{{.APP_NAME}} build/ios/main.m + - codesign --force --sign - {{.BIN_DIR}}/{{.APP_NAME}} + + package: + summary: Packages a production build of the application into a `.app` bundle + deps: + - task: build + vars: + PRODUCTION: "true" + cmds: + - task: create:app:bundle + + create:app:bundle: + summary: Creates an iOS `.app` bundle + cmds: + - rm -rf {{.BIN_DIR}}/{{.APP_NAME}}.app + - mkdir -p {{.BIN_DIR}}/{{.APP_NAME}}.app + - cp {{.BIN_DIR}}/{{.APP_NAME}} {{.BIN_DIR}}/{{.APP_NAME}}.app/ + - cp build/ios/Info.plist {{.BIN_DIR}}/{{.APP_NAME}}.app/ + - | + # Compile asset catalog and embed icons in the app bundle + APP_BUNDLE="{{.BIN_DIR}}/{{.APP_NAME}}.app" + AC_IN="build/ios/xcode/main/Assets.xcassets" + if [ -d "$AC_IN" ]; then + TMP_AC=$(mktemp -d) + xcrun actool \ + --compile "$TMP_AC" \ + --app-icon AppIcon \ + --platform iphonesimulator \ + --minimum-deployment-target 15.0 \ + --product-type com.apple.product-type.application \ + --target-device iphone \ + --target-device ipad \ + --output-partial-info-plist "$APP_BUNDLE/assetcatalog_generated_info.plist" \ + "$AC_IN" + if [ -f "$TMP_AC/Assets.car" ]; then + cp -f "$TMP_AC/Assets.car" "$APP_BUNDLE/Assets.car" + fi + rm -rf "$TMP_AC" + if [ -f "$APP_BUNDLE/assetcatalog_generated_info.plist" ]; then + /usr/libexec/PlistBuddy -c "Merge $APP_BUNDLE/assetcatalog_generated_info.plist" "$APP_BUNDLE/Info.plist" || true + fi + fi + - codesign --force --sign - {{.BIN_DIR}}/{{.APP_NAME}}.app + + deploy-simulator: + summary: Deploy to iOS Simulator + deps: [package] + cmds: + - xcrun simctl terminate booted {{.BUNDLE_ID}} 2>/dev/null || true + - xcrun simctl uninstall booted {{.BUNDLE_ID}} 2>/dev/null || true + - xcrun simctl install booted {{.BIN_DIR}}/{{.APP_NAME}}.app + - xcrun simctl launch booted {{.BUNDLE_ID}} + + compile:ios: + summary: Compile the iOS executable from Go archive and main.m + deps: + - task: build + cmds: + - | + MAIN_M=build/ios/xcode/main/main.m + if [ ! -f "$MAIN_M" ]; then + MAIN_M=build/ios/main.m + fi + xcrun -sdk iphonesimulator clang \ + -target arm64-apple-ios15.0-simulator \ + -isysroot {{.SDK_PATH}} \ + -framework Foundation -framework UIKit -framework WebKit \ + -framework Security -framework CoreFoundation \ + -lresolv \ + -o {{.BIN_DIR}}/{{.APP_NAME | lower}} \ + "$MAIN_M" {{.BIN_DIR}}/{{.APP_NAME}}.a + + generate:ios:bindings: + internal: true + summary: Generates bindings for iOS with proper CGO flags + sources: + - "**/*.go" + - go.mod + - go.sum + generates: + - frontend/bindings/**/* + cmds: + - wails3 generate bindings -f '{{.BUILD_FLAGS}}' -clean=true + env: + GOOS: ios + CGO_ENABLED: 1 + GOARCH: '{{.ARCH | default "arm64"}}' + CGO_CFLAGS: '-isysroot {{.SDK_PATH}} -target arm64-apple-ios15.0-simulator -mios-simulator-version-min=15.0' + CGO_LDFLAGS: '-isysroot {{.SDK_PATH}} -target arm64-apple-ios15.0-simulator' + + ensure-simulator: + internal: true + summary: Ensure iOS Simulator is running and booted + silent: true + cmds: + - | + if ! xcrun simctl list devices booted | grep -q "Booted"; then + echo "Starting iOS Simulator..." + # Get first available iPhone device + DEVICE_ID=$(xcrun simctl list devices available | grep "iPhone" | head -1 | grep -o "[A-F0-9-]\{36\}" || true) + if [ -z "$DEVICE_ID" ]; then + echo "No iPhone simulator found. Creating one..." + RUNTIME=$(xcrun simctl list runtimes | grep iOS | tail -1 | awk '{print $NF}') + DEVICE_ID=$(xcrun simctl create "iPhone 15 Pro" "iPhone 15 Pro" "$RUNTIME") + fi + # Boot the device + echo "Booting device $DEVICE_ID..." + xcrun simctl boot "$DEVICE_ID" 2>/dev/null || true + # Open Simulator app + open -a Simulator + # Wait for boot (max 30 seconds) + for i in {1..30}; do + if xcrun simctl list devices booted | grep -q "Booted"; then + echo "Simulator booted successfully" + break + fi + sleep 1 + done + # Final check + if ! xcrun simctl list devices booted | grep -q "Booted"; then + echo "Failed to boot simulator after 30 seconds" + exit 1 + fi + fi + preconditions: + - sh: command -v xcrun + msg: "xcrun not found. Please run 'wails3 task ios:install:deps' to install iOS development dependencies" + + generate:ios:overlay: + internal: true + summary: Generate Go build overlay and iOS shim + sources: + - build/config.yml + generates: + - build/ios/xcode/overlay.json + - build/ios/xcode/gen/main_ios.gen.go + cmds: + - wails3 ios overlay:gen -out build/ios/xcode/overlay.json -config build/config.yml + + generate:ios:xcode: + internal: true + summary: Generate iOS Xcode project structure and assets + sources: + - build/config.yml + - build/appicon.png + generates: + - build/ios/xcode/main/main.m + - build/ios/xcode/main/Assets.xcassets/**/* + - build/ios/xcode/project.pbxproj + cmds: + - wails3 ios xcode:gen -outdir build/ios/xcode -config build/config.yml + + run: + summary: Run the application in iOS Simulator + deps: + - task: ensure-simulator + - task: compile:ios + cmds: + - rm -rf {{.BIN_DIR}}/{{.APP_NAME}}.dev.app + - mkdir -p {{.BIN_DIR}}/{{.APP_NAME}}.dev.app + - cp {{.BIN_DIR}}/{{.APP_NAME | lower}} {{.BIN_DIR}}/{{.APP_NAME}}.dev.app/{{.APP_NAME | lower}} + - cp build/ios/Info.dev.plist {{.BIN_DIR}}/{{.APP_NAME}}.dev.app/Info.plist + - | + # Compile asset catalog and embed icons for dev bundle + APP_BUNDLE="{{.BIN_DIR}}/{{.APP_NAME}}.dev.app" + AC_IN="build/ios/xcode/main/Assets.xcassets" + if [ -d "$AC_IN" ]; then + TMP_AC=$(mktemp -d) + xcrun actool \ + --compile "$TMP_AC" \ + --app-icon AppIcon \ + --platform iphonesimulator \ + --minimum-deployment-target 15.0 \ + --product-type com.apple.product-type.application \ + --target-device iphone \ + --target-device ipad \ + --output-partial-info-plist "$APP_BUNDLE/assetcatalog_generated_info.plist" \ + "$AC_IN" + if [ -f "$TMP_AC/Assets.car" ]; then + cp -f "$TMP_AC/Assets.car" "$APP_BUNDLE/Assets.car" + fi + rm -rf "$TMP_AC" + if [ -f "$APP_BUNDLE/assetcatalog_generated_info.plist" ]; then + /usr/libexec/PlistBuddy -c "Merge $APP_BUNDLE/assetcatalog_generated_info.plist" "$APP_BUNDLE/Info.plist" || true + fi + fi + - codesign --force --sign - {{.BIN_DIR}}/{{.APP_NAME}}.dev.app + - xcrun simctl terminate booted com.wails.{{.APP_NAME | lower}}.dev 2>/dev/null || true + - xcrun simctl uninstall booted com.wails.{{.APP_NAME | lower}}.dev 2>/dev/null || true + - xcrun simctl install booted {{.BIN_DIR}}/{{.APP_NAME}}.dev.app + - xcrun simctl launch booted com.wails.{{.APP_NAME | lower}}.dev + + xcode: + summary: Open the generated Xcode project for this app + cmds: + - task: generate:ios:xcode + - open build/ios/xcode/main.xcodeproj + + logs: + summary: Stream iOS Simulator logs filtered to this app + cmds: + - | + xcrun simctl spawn booted log stream \ + --level debug \ + --style compact \ + --predicate 'senderImagePath CONTAINS[c] "{{.APP_NAME | lower}}.app/" OR composedMessage CONTAINS[c] "{{.APP_NAME | lower}}" OR eventMessage CONTAINS[c] "{{.APP_NAME | lower}}" OR process == "{{.APP_NAME | lower}}" OR category CONTAINS[c] "{{.APP_NAME | lower}}"' + + logs:dev: + summary: Stream logs for the dev bundle (used by `task ios:run`) + cmds: + - | + xcrun simctl spawn booted log stream \ + --level debug \ + --style compact \ + --predicate 'senderImagePath CONTAINS[c] ".dev.app/" OR subsystem == "com.wails.{{.APP_NAME | lower}}.dev" OR process == "{{.APP_NAME | lower}}"' + + logs:wide: + summary: Wide log stream to help discover the exact process/bundle identifiers + cmds: + - | + xcrun simctl spawn booted log stream \ + --level debug \ + --style compact \ + --predicate 'senderImagePath CONTAINS[c] ".app/"' \ No newline at end of file diff --git a/v3/examples/ios/build/ios/app_options_default.go b/v3/examples/ios/build/ios/app_options_default.go new file mode 100644 index 000000000..04e4f1bc9 --- /dev/null +++ b/v3/examples/ios/build/ios/app_options_default.go @@ -0,0 +1,10 @@ +//go:build !ios + +package main + +import "github.com/wailsapp/wails/v3/pkg/application" + +// modifyOptionsForIOS is a no-op on non-iOS platforms +func modifyOptionsForIOS(opts *application.Options) { + // No modifications needed for non-iOS platforms +} \ No newline at end of file diff --git a/v3/examples/ios/build/ios/app_options_ios.go b/v3/examples/ios/build/ios/app_options_ios.go new file mode 100644 index 000000000..565fbaad6 --- /dev/null +++ b/v3/examples/ios/build/ios/app_options_ios.go @@ -0,0 +1,20 @@ +//go:build ios + +package main + +import "github.com/wailsapp/wails/v3/pkg/application" + +// modifyOptionsForIOS adjusts the application options for iOS +func modifyOptionsForIOS(opts *application.Options) { + // Disable signal handlers on iOS to prevent crashes + opts.DisableDefaultSignalHandler = true + + // Enable native UITabBar in the iOS example by default + opts.IOS.EnableNativeTabs = true + // Configure example tab items (titles + SF Symbols) + opts.IOS.NativeTabsItems = []application.NativeTabItem{ + {Title: "Bindings", SystemImage: "link"}, + {Title: "Go Runtime", SystemImage: "gearshape"}, + {Title: "JS Runtime", SystemImage: "chevron.left.slash.chevron.right"}, + } +} \ No newline at end of file diff --git a/v3/examples/ios/build/ios/build.sh b/v3/examples/ios/build/ios/build.sh new file mode 100644 index 000000000..fbb47a673 --- /dev/null +++ b/v3/examples/ios/build/ios/build.sh @@ -0,0 +1,72 @@ +#!/bin/bash +set -e + +# Build configuration +APP_NAME="ios" +BUNDLE_ID="com.wails.ios" +VERSION="0.1.0" +BUILD_NUMBER="0.1.0" +BUILD_DIR="build/ios" +TARGET="simulator" + +echo "Building iOS app: $APP_NAME" +echo "Bundle ID: $BUNDLE_ID" +echo "Version: $VERSION ($BUILD_NUMBER)" +echo "Target: $TARGET" + +# Ensure build directory exists +mkdir -p "$BUILD_DIR" + +# Determine SDK and target architecture +if [ "$TARGET" = "simulator" ]; then + SDK="iphonesimulator" + ARCH="arm64-apple-ios15.0-simulator" +elif [ "$TARGET" = "device" ]; then + SDK="iphoneos" + ARCH="arm64-apple-ios15.0" +else + echo "Unknown target: $TARGET" + exit 1 +fi + +# Get SDK path +SDK_PATH=$(xcrun --sdk $SDK --show-sdk-path) + +# Compile the application +echo "Compiling with SDK: $SDK" +xcrun -sdk $SDK clang \ + -target $ARCH \ + -isysroot "$SDK_PATH" \ + -framework Foundation \ + -framework UIKit \ + -framework WebKit \ + -framework CoreGraphics \ + -o "$BUILD_DIR/$APP_NAME" \ + "$BUILD_DIR/main.m" + +# Create app bundle +echo "Creating app bundle..." +APP_BUNDLE="$BUILD_DIR/$APP_NAME.app" +rm -rf "$APP_BUNDLE" +mkdir -p "$APP_BUNDLE" + +# Move executable +mv "$BUILD_DIR/$APP_NAME" "$APP_BUNDLE/" + +# Copy Info.plist +cp "$BUILD_DIR/Info.plist" "$APP_BUNDLE/" + +# Sign the app +echo "Signing app..." +codesign --force --sign - "$APP_BUNDLE" + +echo "Build complete: $APP_BUNDLE" + +# Deploy to simulator if requested +if [ "$TARGET" = "simulator" ]; then + echo "Deploying to simulator..." + xcrun simctl terminate booted "$BUNDLE_ID" 2>/dev/null || true + xcrun simctl install booted "$APP_BUNDLE" + xcrun simctl launch booted "$BUNDLE_ID" + echo "App launched on simulator" +fi \ No newline at end of file diff --git a/v3/examples/ios/build/ios/entitlements.plist b/v3/examples/ios/build/ios/entitlements.plist new file mode 100644 index 000000000..cc5d9582b --- /dev/null +++ b/v3/examples/ios/build/ios/entitlements.plist @@ -0,0 +1,21 @@ + + + + + + get-task-allow + + + + com.apple.security.app-sandbox + + + + com.apple.security.network.client + + + + com.apple.security.files.user-selected.read-only + + + \ No newline at end of file diff --git a/v3/examples/ios/build/ios/icon.png b/v3/examples/ios/build/ios/icon.png new file mode 100644 index 000000000..be7d59173 --- /dev/null +++ b/v3/examples/ios/build/ios/icon.png @@ -0,0 +1,3 @@ +# iOS Icon Placeholder +# This file should be replaced with the actual app icon (1024x1024 PNG) +# The build process will generate all required icon sizes from this base icon \ No newline at end of file diff --git a/v3/examples/ios/build/ios/main.m b/v3/examples/ios/build/ios/main.m new file mode 100644 index 000000000..0f2e7e8e1 --- /dev/null +++ b/v3/examples/ios/build/ios/main.m @@ -0,0 +1,22 @@ +// Minimal bootstrap: delegate comes from Go archive (WailsAppDelegate) +#import +#include + +// External Go initialization function from the c-archive (declare before use) +extern void WailsIOSMain(); + +int main(int argc, char * argv[]) { + @autoreleasepool { + // Disable buffering so stdout/stderr from Go log.Printf flush immediately + setvbuf(stdout, NULL, _IONBF, 0); + setvbuf(stderr, NULL, _IONBF, 0); + + // Start Go runtime on a background queue to avoid blocking main thread/UI + dispatch_async(dispatch_get_global_queue(QOS_CLASS_USER_INITIATED, 0), ^{ + WailsIOSMain(); + }); + + // Run UIApplicationMain using WailsAppDelegate provided by the Go archive + return UIApplicationMain(argc, argv, nil, @"WailsAppDelegate"); + } +} \ No newline at end of file diff --git a/v3/examples/ios/build/ios/main_ios.go b/v3/examples/ios/build/ios/main_ios.go new file mode 100644 index 000000000..b75a40321 --- /dev/null +++ b/v3/examples/ios/build/ios/main_ios.go @@ -0,0 +1,24 @@ +//go:build ios + +package main + +import ( + "C" +) + +// For iOS builds, we need to export a function that can be called from Objective-C +// This wrapper allows us to keep the original main.go unmodified + +//export WailsIOSMain +func WailsIOSMain() { + // DO NOT lock the goroutine to the current OS thread on iOS! + // This causes signal handling issues: + // "signal 16 received on thread with no signal stack" + // "fatal error: non-Go code disabled sigaltstack" + // iOS apps run in a sandboxed environment where the Go runtime's + // signal handling doesn't work the same way as desktop platforms. + + // Call the actual main function from main.go + // This ensures all the user's code is executed + main() +} \ No newline at end of file diff --git a/v3/examples/ios/build/ios/project.pbxproj b/v3/examples/ios/build/ios/project.pbxproj new file mode 100644 index 000000000..627ab5b17 --- /dev/null +++ b/v3/examples/ios/build/ios/project.pbxproj @@ -0,0 +1,222 @@ +// !$*UTF8*$! +{ + archiveVersion = 1; + classes = {}; + objectVersion = 56; + objects = { + +/* Begin PBXBuildFile section */ + C0DEBEEF0000000000000001 /* main.m in Sources */ = {isa = PBXBuildFile; fileRef = C0DEBEEF0000000000000002 /* main.m */; }; + C0DEBEEF00000000000000F1 /* UIKit.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = C0DEBEEF0000000000000101 /* UIKit.framework */; }; + C0DEBEEF00000000000000F2 /* Foundation.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = C0DEBEEF0000000000000102 /* Foundation.framework */; }; + C0DEBEEF00000000000000F3 /* WebKit.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = C0DEBEEF0000000000000103 /* WebKit.framework */; }; + C0DEBEEF00000000000000F4 /* Security.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = C0DEBEEF0000000000000104 /* Security.framework */; }; + C0DEBEEF00000000000000F5 /* CoreFoundation.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = C0DEBEEF0000000000000105 /* CoreFoundation.framework */; }; + C0DEBEEF00000000000000F6 /* libresolv.tbd in Frameworks */ = {isa = PBXBuildFile; fileRef = C0DEBEEF0000000000000106 /* libresolv.tbd */; }; + C0DEBEEF00000000000000F7 /* My Product.a in Frameworks */ = {isa = PBXBuildFile; fileRef = C0DEBEEF0000000000000107 /* My Product.a */; }; +/* End PBXBuildFile section */ + +/* Begin PBXFileReference section */ + C0DEBEEF0000000000000002 /* main.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = main.m; sourceTree = ""; }; + C0DEBEEF0000000000000003 /* Info.plist */ = {isa = PBXFileReference; lastKnownFileType = text.plist.xml; path = Info.plist; sourceTree = ""; }; + C0DEBEEF0000000000000004 /* My Product.app */ = {isa = PBXFileReference; explicitFileType = wrapper.application; includeInIndex = 0; path = "My Product.app"; sourceTree = BUILT_PRODUCTS_DIR; }; + C0DEBEEF0000000000000101 /* UIKit.framework */ = {isa = PBXFileReference; lastKnownFileType = wrapper.framework; name = UIKit.framework; path = System/Library/Frameworks/UIKit.framework; sourceTree = SDKROOT; }; + C0DEBEEF0000000000000102 /* Foundation.framework */ = {isa = PBXFileReference; lastKnownFileType = wrapper.framework; name = Foundation.framework; path = System/Library/Frameworks/Foundation.framework; sourceTree = SDKROOT; }; + C0DEBEEF0000000000000103 /* WebKit.framework */ = {isa = PBXFileReference; lastKnownFileType = wrapper.framework; name = WebKit.framework; path = System/Library/Frameworks/WebKit.framework; sourceTree = SDKROOT; }; + C0DEBEEF0000000000000104 /* Security.framework */ = {isa = PBXFileReference; lastKnownFileType = wrapper.framework; name = Security.framework; path = System/Library/Frameworks/Security.framework; sourceTree = SDKROOT; }; + C0DEBEEF0000000000000105 /* CoreFoundation.framework */ = {isa = PBXFileReference; lastKnownFileType = wrapper.framework; name = CoreFoundation.framework; path = System/Library/Frameworks/CoreFoundation.framework; sourceTree = SDKROOT; }; + C0DEBEEF0000000000000106 /* libresolv.tbd */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.text-based-dylib-definition; name = libresolv.tbd; path = usr/lib/libresolv.tbd; sourceTree = SDKROOT; }; + C0DEBEEF0000000000000107 /* My Product.a */ = {isa = PBXFileReference; lastKnownFileType = archive.ar; name = "My Product.a"; path = ../../../bin/My Product.a; sourceTree = SOURCE_ROOT; }; +/* End PBXFileReference section */ + +/* Begin PBXGroup section */ + C0DEBEEF0000000000000010 = { + isa = PBXGroup; + children = ( + C0DEBEEF0000000000000020 /* Products */, + C0DEBEEF0000000000000045 /* Frameworks */, + C0DEBEEF0000000000000030 /* main */, + ); + sourceTree = ""; + }; + C0DEBEEF0000000000000020 /* Products */ = { + isa = PBXGroup; + children = ( + C0DEBEEF0000000000000004 /* My Product.app */, + ); + name = Products; + sourceTree = ""; + }; + C0DEBEEF0000000000000030 /* main */ = { + isa = PBXGroup; + children = ( + C0DEBEEF0000000000000002 /* main.m */, + C0DEBEEF0000000000000003 /* Info.plist */, + ); + path = main; + sourceTree = SOURCE_ROOT; + }; + C0DEBEEF0000000000000045 /* Frameworks */ = { + isa = PBXGroup; + children = ( + C0DEBEEF0000000000000101 /* UIKit.framework */, + C0DEBEEF0000000000000102 /* Foundation.framework */, + C0DEBEEF0000000000000103 /* WebKit.framework */, + C0DEBEEF0000000000000104 /* Security.framework */, + C0DEBEEF0000000000000105 /* CoreFoundation.framework */, + C0DEBEEF0000000000000106 /* libresolv.tbd */, + C0DEBEEF0000000000000107 /* My Product.a */, + ); + name = Frameworks; + sourceTree = ""; + }; +/* End PBXGroup section */ + +/* Begin PBXNativeTarget section */ + C0DEBEEF0000000000000040 /* My Product */ = { + isa = PBXNativeTarget; + buildConfigurationList = C0DEBEEF0000000000000070 /* Build configuration list for PBXNativeTarget "My Product" */; + buildPhases = ( + C0DEBEEF0000000000000055 /* Prebuild: Wails Go Archive */, + C0DEBEEF0000000000000050 /* Sources */, + C0DEBEEF0000000000000056 /* Frameworks */, + ); + buildRules = ( + ); + dependencies = ( + ); + name = "My Product"; + productName = "My Product"; + productReference = C0DEBEEF0000000000000004 /* My Product.app */; + productType = "com.apple.product-type.application"; + }; +/* End PBXNativeTarget section */ + +/* Begin PBXProject section */ + C0DEBEEF0000000000000060 /* Project object */ = { + isa = PBXProject; + attributes = { + LastUpgradeCheck = 1500; + ORGANIZATIONNAME = "My Company"; + TargetAttributes = { + C0DEBEEF0000000000000040 = { + CreatedOnToolsVersion = 15.0; + }; + }; + }; + buildConfigurationList = C0DEBEEF0000000000000080 /* Build configuration list for PBXProject "main" */; + compatibilityVersion = "Xcode 15.0"; + developmentRegion = en; + hasScannedForEncodings = 0; + knownRegions = ( + en, + ); + mainGroup = C0DEBEEF0000000000000010; + productRefGroup = C0DEBEEF0000000000000020 /* Products */; + projectDirPath = ""; + projectRoot = ""; + targets = ( + C0DEBEEF0000000000000040 /* My Product */, + ); + }; +/* End PBXProject section */ + +/* Begin PBXFrameworksBuildPhase section */ + C0DEBEEF0000000000000056 /* Frameworks */ = { + isa = PBXFrameworksBuildPhase; + buildActionMask = 2147483647; + files = ( + C0DEBEEF00000000000000F7 /* My Product.a in Frameworks */, + C0DEBEEF00000000000000F1 /* UIKit.framework in Frameworks */, + C0DEBEEF00000000000000F2 /* Foundation.framework in Frameworks */, + C0DEBEEF00000000000000F3 /* WebKit.framework in Frameworks */, + C0DEBEEF00000000000000F4 /* Security.framework in Frameworks */, + C0DEBEEF00000000000000F5 /* CoreFoundation.framework in Frameworks */, + C0DEBEEF00000000000000F6 /* libresolv.tbd in Frameworks */, + ); + runOnlyForDeploymentPostprocessing = 0; + }; +/* End PBXFrameworksBuildPhase section */ + +/* Begin PBXShellScriptBuildPhase section */ + C0DEBEEF0000000000000055 /* Prebuild: Wails Go Archive */ = { + isa = PBXShellScriptBuildPhase; + buildActionMask = 2147483647; + files = ( + ); + inputFileListPaths = ( + ); + inputPaths = ( + ); + name = "Prebuild: Wails Go Archive"; + outputFileListPaths = ( + ); + outputPaths = ( + ); + runOnlyForDeploymentPostprocessing = 0; + shellPath = /bin/sh; + shellScript = "set -e\nAPP_ROOT=\"${PROJECT_DIR}/../../..\"\nSDK_PATH=$(xcrun --sdk iphonesimulator --show-sdk-path)\nexport GOOS=ios\nexport GOARCH=arm64\nexport CGO_ENABLED=1\nexport CGO_CFLAGS=\"-isysroot ${SDK_PATH} -target arm64-apple-ios15.0-simulator -mios-simulator-version-min=15.0\"\nexport CGO_LDFLAGS=\"-isysroot ${SDK_PATH} -target arm64-apple-ios15.0-simulator\"\ncd \"${APP_ROOT}\"\n# Ensure overlay exists\nif [ ! -f build/ios/xcode/overlay.json ]; then\n wails3 ios overlay:gen -out build/ios/xcode/overlay.json -config build/config.yml || true\nfi\n# Build Go c-archive if missing or older than sources\nif [ ! -f bin/My Product.a ]; then\n echo \"Building Go c-archive...\"\n go build -buildmode=c-archive -overlay build/ios/xcode/overlay.json -o bin/My Product.a\nfi\n"; + }; +/* End PBXShellScriptBuildPhase section */ + +/* Begin PBXSourcesBuildPhase section */ + C0DEBEEF0000000000000050 /* Sources */ = { + isa = PBXSourcesBuildPhase; + buildActionMask = 2147483647; + files = ( + C0DEBEEF0000000000000001 /* main.m in Sources */, + ); + runOnlyForDeploymentPostprocessing = 0; + }; +/* End PBXSourcesBuildPhase section */ + +/* Begin XCBuildConfiguration section */ + C0DEBEEF0000000000000090 /* Debug */ = { + isa = XCBuildConfiguration; + buildSettings = { + INFOPLIST_FILE = main/Info.plist; + IPHONEOS_DEPLOYMENT_TARGET = 15.0; + PRODUCT_BUNDLE_IDENTIFIER = "com.wails.ios"; + PRODUCT_NAME = "My Product"; + CODE_SIGNING_ALLOWED = NO; + SDKROOT = iphonesimulator; + }; + name = Debug; + }; + C0DEBEEF00000000000000A0 /* Release */ = { + isa = XCBuildConfiguration; + buildSettings = { + INFOPLIST_FILE = main/Info.plist; + IPHONEOS_DEPLOYMENT_TARGET = 15.0; + PRODUCT_BUNDLE_IDENTIFIER = "com.wails.ios"; + PRODUCT_NAME = "My Product"; + CODE_SIGNING_ALLOWED = NO; + SDKROOT = iphonesimulator; + }; + name = Release; + }; +/* End XCBuildConfiguration section */ + +/* Begin XCConfigurationList section */ + C0DEBEEF0000000000000070 /* Build configuration list for PBXNativeTarget "My Product" */ = { + isa = XCConfigurationList; + buildConfigurations = ( + C0DEBEEF0000000000000090 /* Debug */, + C0DEBEEF00000000000000A0 /* Release */, + ); + defaultConfigurationIsVisible = 0; + defaultConfigurationName = Debug; + }; + C0DEBEEF0000000000000080 /* Build configuration list for PBXProject "main" */ = { + isa = XCConfigurationList; + buildConfigurations = ( + C0DEBEEF0000000000000090 /* Debug */, + C0DEBEEF00000000000000A0 /* Release */, + ); + defaultConfigurationIsVisible = 0; + defaultConfigurationName = Debug; + }; +/* End XCConfigurationList section */ + }; + rootObject = C0DEBEEF0000000000000060 /* Project object */; +} diff --git a/v3/examples/ios/build/ios/scripts/deps/install_deps.go b/v3/examples/ios/build/ios/scripts/deps/install_deps.go new file mode 100644 index 000000000..88ed47a4a --- /dev/null +++ b/v3/examples/ios/build/ios/scripts/deps/install_deps.go @@ -0,0 +1,319 @@ +// install_deps.go - iOS development dependency checker +// This script checks for required iOS development tools. +// It's designed to be portable across different shells by using Go instead of shell scripts. +// +// Usage: +// go run install_deps.go # Interactive mode +// TASK_FORCE_YES=true go run install_deps.go # Auto-accept prompts +// CI=true go run install_deps.go # CI mode (auto-accept) + +package main + +import ( + "bufio" + "fmt" + "os" + "os/exec" + "strings" +) + +type Dependency struct { + Name string + CheckFunc func() (bool, string) // Returns (success, details) + Required bool + InstallCmd []string + InstallMsg string + SuccessMsg string + FailureMsg string +} + +func main() { + fmt.Println("Checking iOS development dependencies...") + fmt.Println("=" + strings.Repeat("=", 50)) + fmt.Println() + + hasErrors := false + dependencies := []Dependency{ + { + Name: "Xcode", + CheckFunc: func() (bool, string) { + // Check if xcodebuild exists + if !checkCommand([]string{"xcodebuild", "-version"}) { + return false, "" + } + // Get version info + out, err := exec.Command("xcodebuild", "-version").Output() + if err != nil { + return false, "" + } + lines := strings.Split(string(out), "\n") + if len(lines) > 0 { + return true, strings.TrimSpace(lines[0]) + } + return true, "" + }, + Required: true, + InstallMsg: "Please install Xcode from the Mac App Store:\n https://apps.apple.com/app/xcode/id497799835\n Xcode is REQUIRED for iOS development (includes iOS SDKs, simulators, and frameworks)", + SuccessMsg: "✅ Xcode found", + FailureMsg: "❌ Xcode not found (REQUIRED)", + }, + { + Name: "Xcode Developer Path", + CheckFunc: func() (bool, string) { + // Check if xcode-select points to a valid Xcode path + out, err := exec.Command("xcode-select", "-p").Output() + if err != nil { + return false, "xcode-select not configured" + } + path := strings.TrimSpace(string(out)) + + // Check if path exists and is in Xcode.app + if _, err := os.Stat(path); err != nil { + return false, "Invalid Xcode path" + } + + // Verify it's pointing to Xcode.app (not just Command Line Tools) + if !strings.Contains(path, "Xcode.app") { + return false, fmt.Sprintf("Points to %s (should be Xcode.app)", path) + } + + return true, path + }, + Required: true, + InstallCmd: []string{"sudo", "xcode-select", "-s", "/Applications/Xcode.app/Contents/Developer"}, + InstallMsg: "Xcode developer path needs to be configured", + SuccessMsg: "✅ Xcode developer path configured", + FailureMsg: "❌ Xcode developer path not configured correctly", + }, + { + Name: "iOS SDK", + CheckFunc: func() (bool, string) { + // Get the iOS Simulator SDK path + cmd := exec.Command("xcrun", "--sdk", "iphonesimulator", "--show-sdk-path") + output, err := cmd.Output() + if err != nil { + return false, "Cannot find iOS SDK" + } + sdkPath := strings.TrimSpace(string(output)) + + // Check if the SDK path exists + if _, err := os.Stat(sdkPath); err != nil { + return false, "iOS SDK path not found" + } + + // Check for UIKit framework (essential for iOS development) + uikitPath := fmt.Sprintf("%s/System/Library/Frameworks/UIKit.framework", sdkPath) + if _, err := os.Stat(uikitPath); err != nil { + return false, "UIKit.framework not found" + } + + // Get SDK version + versionCmd := exec.Command("xcrun", "--sdk", "iphonesimulator", "--show-sdk-version") + versionOut, _ := versionCmd.Output() + version := strings.TrimSpace(string(versionOut)) + + return true, fmt.Sprintf("iOS %s SDK", version) + }, + Required: true, + InstallMsg: "iOS SDK comes with Xcode. Please ensure Xcode is properly installed.", + SuccessMsg: "✅ iOS SDK found with UIKit framework", + FailureMsg: "❌ iOS SDK not found or incomplete", + }, + { + Name: "iOS Simulator Runtime", + CheckFunc: func() (bool, string) { + if !checkCommand([]string{"xcrun", "simctl", "help"}) { + return false, "" + } + // Check if we can list runtimes + out, err := exec.Command("xcrun", "simctl", "list", "runtimes").Output() + if err != nil { + return false, "Cannot access simulator" + } + // Count iOS runtimes + lines := strings.Split(string(out), "\n") + count := 0 + var versions []string + for _, line := range lines { + if strings.Contains(line, "iOS") && !strings.Contains(line, "unavailable") { + count++ + // Extract version number + if parts := strings.Fields(line); len(parts) > 2 { + for _, part := range parts { + if strings.HasPrefix(part, "(") && strings.HasSuffix(part, ")") { + versions = append(versions, strings.Trim(part, "()")) + break + } + } + } + } + } + if count > 0 { + return true, fmt.Sprintf("%d runtime(s): %s", count, strings.Join(versions, ", ")) + } + return false, "No iOS runtimes installed" + }, + Required: true, + InstallMsg: "iOS Simulator runtimes come with Xcode. You may need to download them:\n Xcode → Settings → Platforms → iOS", + SuccessMsg: "✅ iOS Simulator runtime available", + FailureMsg: "❌ iOS Simulator runtime not available", + }, + } + + // Check each dependency + for _, dep := range dependencies { + success, details := dep.CheckFunc() + if success { + msg := dep.SuccessMsg + if details != "" { + msg = fmt.Sprintf("%s (%s)", dep.SuccessMsg, details) + } + fmt.Println(msg) + } else { + fmt.Println(dep.FailureMsg) + if details != "" { + fmt.Printf(" Details: %s\n", details) + } + if dep.Required { + hasErrors = true + if len(dep.InstallCmd) > 0 { + fmt.Println() + fmt.Println(" " + dep.InstallMsg) + fmt.Printf(" Fix command: %s\n", strings.Join(dep.InstallCmd, " ")) + if promptUser("Do you want to run this command?") { + fmt.Println("Running command...") + cmd := exec.Command(dep.InstallCmd[0], dep.InstallCmd[1:]...) + cmd.Stdout = os.Stdout + cmd.Stderr = os.Stderr + cmd.Stdin = os.Stdin + if err := cmd.Run(); err != nil { + fmt.Printf("Command failed: %v\n", err) + os.Exit(1) + } + fmt.Println("✅ Command completed. Please run this check again.") + } else { + fmt.Printf(" Please run manually: %s\n", strings.Join(dep.InstallCmd, " ")) + } + } else { + fmt.Println(" " + dep.InstallMsg) + } + } + } + } + + // Check for iPhone simulators + fmt.Println() + fmt.Println("Checking for iPhone simulator devices...") + if !checkCommand([]string{"xcrun", "simctl", "list", "devices"}) { + fmt.Println("❌ Cannot check for iPhone simulators") + hasErrors = true + } else { + out, err := exec.Command("xcrun", "simctl", "list", "devices").Output() + if err != nil { + fmt.Println("❌ Failed to list simulator devices") + hasErrors = true + } else if !strings.Contains(string(out), "iPhone") { + fmt.Println("⚠️ No iPhone simulator devices found") + fmt.Println() + + // Get the latest iOS runtime + runtimeOut, err := exec.Command("xcrun", "simctl", "list", "runtimes").Output() + if err != nil { + fmt.Println(" Failed to get iOS runtimes:", err) + } else { + lines := strings.Split(string(runtimeOut), "\n") + var latestRuntime string + for _, line := range lines { + if strings.Contains(line, "iOS") && !strings.Contains(line, "unavailable") { + // Extract runtime identifier + parts := strings.Fields(line) + if len(parts) > 0 { + latestRuntime = parts[len(parts)-1] + } + } + } + + if latestRuntime == "" { + fmt.Println(" No iOS runtime found. Please install iOS simulators in Xcode:") + fmt.Println(" Xcode → Settings → Platforms → iOS") + } else { + fmt.Println(" Would you like to create an iPhone 15 Pro simulator?") + createCmd := []string{"xcrun", "simctl", "create", "iPhone 15 Pro", "iPhone 15 Pro", latestRuntime} + fmt.Printf(" Command: %s\n", strings.Join(createCmd, " ")) + if promptUser("Create simulator?") { + cmd := exec.Command(createCmd[0], createCmd[1:]...) + cmd.Stdout = os.Stdout + cmd.Stderr = os.Stderr + if err := cmd.Run(); err != nil { + fmt.Printf(" Failed to create simulator: %v\n", err) + } else { + fmt.Println(" ✅ iPhone 15 Pro simulator created") + } + } else { + fmt.Println(" Skipping simulator creation") + fmt.Printf(" Create manually: %s\n", strings.Join(createCmd, " ")) + } + } + } + } else { + // Count iPhone devices + count := 0 + lines := strings.Split(string(out), "\n") + for _, line := range lines { + if strings.Contains(line, "iPhone") && !strings.Contains(line, "unavailable") { + count++ + } + } + fmt.Printf("✅ %d iPhone simulator device(s) available\n", count) + } + } + + // Final summary + fmt.Println() + fmt.Println("=" + strings.Repeat("=", 50)) + if hasErrors { + fmt.Println("❌ Some required dependencies are missing or misconfigured.") + fmt.Println() + fmt.Println("Quick setup guide:") + fmt.Println("1. Install Xcode from Mac App Store (if not installed)") + fmt.Println("2. Open Xcode once and agree to the license") + fmt.Println("3. Install additional components when prompted") + fmt.Println("4. Run: sudo xcode-select -s /Applications/Xcode.app/Contents/Developer") + fmt.Println("5. Download iOS simulators: Xcode → Settings → Platforms → iOS") + fmt.Println("6. Run this check again") + os.Exit(1) + } else { + fmt.Println("✅ All required dependencies are installed!") + fmt.Println(" You're ready for iOS development with Wails!") + } +} + +func checkCommand(args []string) bool { + if len(args) == 0 { + return false + } + cmd := exec.Command(args[0], args[1:]...) + cmd.Stdout = nil + cmd.Stderr = nil + err := cmd.Run() + return err == nil +} + +func promptUser(question string) bool { + // Check if we're in a non-interactive environment + if os.Getenv("CI") != "" || os.Getenv("TASK_FORCE_YES") == "true" { + fmt.Printf("%s [y/N]: y (auto-accepted)\n", question) + return true + } + + reader := bufio.NewReader(os.Stdin) + fmt.Printf("%s [y/N]: ", question) + + response, err := reader.ReadString('\n') + if err != nil { + return false + } + + response = strings.ToLower(strings.TrimSpace(response)) + return response == "y" || response == "yes" +} \ No newline at end of file diff --git a/v3/examples/ios/build/ios/xcode/gen/main_ios.gen.go b/v3/examples/ios/build/ios/xcode/gen/main_ios.gen.go new file mode 100644 index 000000000..b75a40321 --- /dev/null +++ b/v3/examples/ios/build/ios/xcode/gen/main_ios.gen.go @@ -0,0 +1,24 @@ +//go:build ios + +package main + +import ( + "C" +) + +// For iOS builds, we need to export a function that can be called from Objective-C +// This wrapper allows us to keep the original main.go unmodified + +//export WailsIOSMain +func WailsIOSMain() { + // DO NOT lock the goroutine to the current OS thread on iOS! + // This causes signal handling issues: + // "signal 16 received on thread with no signal stack" + // "fatal error: non-Go code disabled sigaltstack" + // iOS apps run in a sandboxed environment where the Go runtime's + // signal handling doesn't work the same way as desktop platforms. + + // Call the actual main function from main.go + // This ensures all the user's code is executed + main() +} \ No newline at end of file diff --git a/v3/examples/ios/build/ios/xcode/main.xcodeproj/project.pbxproj b/v3/examples/ios/build/ios/xcode/main.xcodeproj/project.pbxproj new file mode 100644 index 000000000..6db4c3928 --- /dev/null +++ b/v3/examples/ios/build/ios/xcode/main.xcodeproj/project.pbxproj @@ -0,0 +1,222 @@ +// !$*UTF8*$! +{ + archiveVersion = 1; + classes = {}; + objectVersion = 56; + objects = { + +/* Begin PBXBuildFile section */ + C0DEBEEF0000000000000001 /* main.m in Sources */ = {isa = PBXBuildFile; fileRef = C0DEBEEF0000000000000002 /* main.m */; }; + C0DEBEEF00000000000000F1 /* UIKit.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = C0DEBEEF0000000000000101 /* UIKit.framework */; }; + C0DEBEEF00000000000000F2 /* Foundation.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = C0DEBEEF0000000000000102 /* Foundation.framework */; }; + C0DEBEEF00000000000000F3 /* WebKit.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = C0DEBEEF0000000000000103 /* WebKit.framework */; }; + C0DEBEEF00000000000000F4 /* Security.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = C0DEBEEF0000000000000104 /* Security.framework */; }; + C0DEBEEF00000000000000F5 /* CoreFoundation.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = C0DEBEEF0000000000000105 /* CoreFoundation.framework */; }; + C0DEBEEF00000000000000F6 /* libresolv.tbd in Frameworks */ = {isa = PBXBuildFile; fileRef = C0DEBEEF0000000000000106 /* libresolv.tbd */; }; + C0DEBEEF00000000000000F7 /* My Product.a in Frameworks */ = {isa = PBXBuildFile; fileRef = C0DEBEEF0000000000000107 /* My Product.a */; }; +/* End PBXBuildFile section */ + +/* Begin PBXFileReference section */ + C0DEBEEF0000000000000002 /* main.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = main.m; sourceTree = ""; }; + C0DEBEEF0000000000000003 /* Info.plist */ = {isa = PBXFileReference; lastKnownFileType = text.plist.xml; path = Info.plist; sourceTree = ""; }; + C0DEBEEF0000000000000004 /* My Product.app */ = {isa = PBXFileReference; explicitFileType = wrapper.application; includeInIndex = 0; path = "My Product.app"; sourceTree = BUILT_PRODUCTS_DIR; }; + C0DEBEEF0000000000000101 /* UIKit.framework */ = {isa = PBXFileReference; lastKnownFileType = wrapper.framework; name = UIKit.framework; path = System/Library/Frameworks/UIKit.framework; sourceTree = SDKROOT; }; + C0DEBEEF0000000000000102 /* Foundation.framework */ = {isa = PBXFileReference; lastKnownFileType = wrapper.framework; name = Foundation.framework; path = System/Library/Frameworks/Foundation.framework; sourceTree = SDKROOT; }; + C0DEBEEF0000000000000103 /* WebKit.framework */ = {isa = PBXFileReference; lastKnownFileType = wrapper.framework; name = WebKit.framework; path = System/Library/Frameworks/WebKit.framework; sourceTree = SDKROOT; }; + C0DEBEEF0000000000000104 /* Security.framework */ = {isa = PBXFileReference; lastKnownFileType = wrapper.framework; name = Security.framework; path = System/Library/Frameworks/Security.framework; sourceTree = SDKROOT; }; + C0DEBEEF0000000000000105 /* CoreFoundation.framework */ = {isa = PBXFileReference; lastKnownFileType = wrapper.framework; name = CoreFoundation.framework; path = System/Library/Frameworks/CoreFoundation.framework; sourceTree = SDKROOT; }; + C0DEBEEF0000000000000106 /* libresolv.tbd */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.text-based-dylib-definition; name = libresolv.tbd; path = usr/lib/libresolv.tbd; sourceTree = SDKROOT; }; + C0DEBEEF0000000000000107 /* My Product.a */ = {isa = PBXFileReference; lastKnownFileType = archive.ar; name = "My Product.a"; path = ../../../bin/My Product.a; sourceTree = SOURCE_ROOT; }; +/* End PBXFileReference section */ + +/* Begin PBXGroup section */ + C0DEBEEF0000000000000010 = { + isa = PBXGroup; + children = ( + C0DEBEEF0000000000000020 /* Products */, + C0DEBEEF0000000000000045 /* Frameworks */, + C0DEBEEF0000000000000030 /* main */, + ); + sourceTree = ""; + }; + C0DEBEEF0000000000000020 /* Products */ = { + isa = PBXGroup; + children = ( + C0DEBEEF0000000000000004 /* My Product.app */, + ); + name = Products; + sourceTree = ""; + }; + C0DEBEEF0000000000000030 /* main */ = { + isa = PBXGroup; + children = ( + C0DEBEEF0000000000000002 /* main.m */, + C0DEBEEF0000000000000003 /* Info.plist */, + ); + path = main; + sourceTree = SOURCE_ROOT; + }; + C0DEBEEF0000000000000045 /* Frameworks */ = { + isa = PBXGroup; + children = ( + C0DEBEEF0000000000000101 /* UIKit.framework */, + C0DEBEEF0000000000000102 /* Foundation.framework */, + C0DEBEEF0000000000000103 /* WebKit.framework */, + C0DEBEEF0000000000000104 /* Security.framework */, + C0DEBEEF0000000000000105 /* CoreFoundation.framework */, + C0DEBEEF0000000000000106 /* libresolv.tbd */, + C0DEBEEF0000000000000107 /* My Product.a */, + ); + name = Frameworks; + sourceTree = ""; + }; +/* End PBXGroup section */ + +/* Begin PBXNativeTarget section */ + C0DEBEEF0000000000000040 /* My Product */ = { + isa = PBXNativeTarget; + buildConfigurationList = C0DEBEEF0000000000000070 /* Build configuration list for PBXNativeTarget "My Product" */; + buildPhases = ( + C0DEBEEF0000000000000055 /* Prebuild: Wails Go Archive */, + C0DEBEEF0000000000000050 /* Sources */, + C0DEBEEF0000000000000056 /* Frameworks */, + ); + buildRules = ( + ); + dependencies = ( + ); + name = "My Product"; + productName = "My Product"; + productReference = C0DEBEEF0000000000000004 /* My Product.app */; + productType = "com.apple.product-type.application"; + }; +/* End PBXNativeTarget section */ + +/* Begin PBXProject section */ + C0DEBEEF0000000000000060 /* Project object */ = { + isa = PBXProject; + attributes = { + LastUpgradeCheck = 1500; + ORGANIZATIONNAME = "My Company"; + TargetAttributes = { + C0DEBEEF0000000000000040 = { + CreatedOnToolsVersion = 15.0; + }; + }; + }; + buildConfigurationList = C0DEBEEF0000000000000080 /* Build configuration list for PBXProject "main" */; + compatibilityVersion = "Xcode 15.0"; + developmentRegion = en; + hasScannedForEncodings = 0; + knownRegions = ( + en, + ); + mainGroup = C0DEBEEF0000000000000010; + productRefGroup = C0DEBEEF0000000000000020 /* Products */; + projectDirPath = ""; + projectRoot = ""; + targets = ( + C0DEBEEF0000000000000040 /* My Product */, + ); + }; +/* End PBXProject section */ + +/* Begin PBXFrameworksBuildPhase section */ + C0DEBEEF0000000000000056 /* Frameworks */ = { + isa = PBXFrameworksBuildPhase; + buildActionMask = 2147483647; + files = ( + C0DEBEEF00000000000000F7 /* My Product.a in Frameworks */, + C0DEBEEF00000000000000F1 /* UIKit.framework in Frameworks */, + C0DEBEEF00000000000000F2 /* Foundation.framework in Frameworks */, + C0DEBEEF00000000000000F3 /* WebKit.framework in Frameworks */, + C0DEBEEF00000000000000F4 /* Security.framework in Frameworks */, + C0DEBEEF00000000000000F5 /* CoreFoundation.framework in Frameworks */, + C0DEBEEF00000000000000F6 /* libresolv.tbd in Frameworks */, + ); + runOnlyForDeploymentPostprocessing = 0; + }; +/* End PBXFrameworksBuildPhase section */ + +/* Begin PBXShellScriptBuildPhase section */ + C0DEBEEF0000000000000055 /* Prebuild: Wails Go Archive */ = { + isa = PBXShellScriptBuildPhase; + buildActionMask = 2147483647; + files = ( + ); + inputFileListPaths = ( + ); + inputPaths = ( + ); + name = "Prebuild: Wails Go Archive"; + outputFileListPaths = ( + ); + outputPaths = ( + ); + runOnlyForDeploymentPostprocessing = 0; + shellPath = /bin/sh; + shellScript = "set -e\nAPP_ROOT=\"${PROJECT_DIR}/../../..\"\nSDK_PATH=$(xcrun --sdk iphonesimulator --show-sdk-path)\nexport GOOS=ios\nexport GOARCH=arm64\nexport CGO_ENABLED=1\nexport CGO_CFLAGS=\"-isysroot ${SDK_PATH} -target arm64-apple-ios15.0-simulator -mios-simulator-version-min=15.0\"\nexport CGO_LDFLAGS=\"-isysroot ${SDK_PATH} -target arm64-apple-ios15.0-simulator\"\ncd \"${APP_ROOT}\"\n# Ensure overlay exists\nif [ ! -f build/ios/xcode/overlay.json ]; then\n wails3 ios overlay:gen -out build/ios/xcode/overlay.json -config build/config.yml || true\nfi\n# Build Go c-archive if missing or older than sources\nif [ ! -f bin/My Product.a ]; then\n echo \"Building Go c-archive...\"\n go build -buildmode=c-archive -overlay build/ios/xcode/overlay.json -o bin/My Product.a\nfi\n"; + }; +/* End PBXShellScriptBuildPhase section */ + +/* Begin PBXSourcesBuildPhase section */ + C0DEBEEF0000000000000050 /* Sources */ = { + isa = PBXSourcesBuildPhase; + buildActionMask = 2147483647; + files = ( + C0DEBEEF0000000000000001 /* main.m in Sources */, + ); + runOnlyForDeploymentPostprocessing = 0; + }; +/* End PBXSourcesBuildPhase section */ + +/* Begin XCBuildConfiguration section */ + C0DEBEEF0000000000000090 /* Debug */ = { + isa = XCBuildConfiguration; + buildSettings = { + INFOPLIST_FILE = main/Info.plist; + IPHONEOS_DEPLOYMENT_TARGET = 15.0; + PRODUCT_BUNDLE_IDENTIFIER = "com.mycompany.myproduct"; + PRODUCT_NAME = "My Product"; + CODE_SIGNING_ALLOWED = NO; + SDKROOT = iphonesimulator; + }; + name = Debug; + }; + C0DEBEEF00000000000000A0 /* Release */ = { + isa = XCBuildConfiguration; + buildSettings = { + INFOPLIST_FILE = main/Info.plist; + IPHONEOS_DEPLOYMENT_TARGET = 15.0; + PRODUCT_BUNDLE_IDENTIFIER = "com.mycompany.myproduct"; + PRODUCT_NAME = "My Product"; + CODE_SIGNING_ALLOWED = NO; + SDKROOT = iphonesimulator; + }; + name = Release; + }; +/* End XCBuildConfiguration section */ + +/* Begin XCConfigurationList section */ + C0DEBEEF0000000000000070 /* Build configuration list for PBXNativeTarget "My Product" */ = { + isa = XCConfigurationList; + buildConfigurations = ( + C0DEBEEF0000000000000090 /* Debug */, + C0DEBEEF00000000000000A0 /* Release */, + ); + defaultConfigurationIsVisible = 0; + defaultConfigurationName = Debug; + }; + C0DEBEEF0000000000000080 /* Build configuration list for PBXProject "main" */ = { + isa = XCConfigurationList; + buildConfigurations = ( + C0DEBEEF0000000000000090 /* Debug */, + C0DEBEEF00000000000000A0 /* Release */, + ); + defaultConfigurationIsVisible = 0; + defaultConfigurationName = Debug; + }; +/* End XCConfigurationList section */ + }; + rootObject = C0DEBEEF0000000000000060 /* Project object */; +} diff --git a/v3/examples/ios/build/ios/xcode/main/Assets.xcassets/AppIcon.appiconset/Contents.json b/v3/examples/ios/build/ios/xcode/main/Assets.xcassets/AppIcon.appiconset/Contents.json new file mode 100644 index 000000000..46fbb8787 --- /dev/null +++ b/v3/examples/ios/build/ios/xcode/main/Assets.xcassets/AppIcon.appiconset/Contents.json @@ -0,0 +1,116 @@ +{ + "info" : { + "author" : "xcode", + "version" : 1 + }, + "images" : [ + { + "filename" : "icon-20@2x.png", + "idiom" : "iphone", + "scale" : "2x", + "size" : "20x20" + }, + { + "filename" : "icon-20@3x.png", + "idiom" : "iphone", + "scale" : "3x", + "size" : "20x20" + }, + { + "filename" : "icon-29@2x.png", + "idiom" : "iphone", + "scale" : "2x", + "size" : "29x29" + }, + { + "filename" : "icon-29@3x.png", + "idiom" : "iphone", + "scale" : "3x", + "size" : "29x29" + }, + { + "filename" : "icon-40@2x.png", + "idiom" : "iphone", + "scale" : "2x", + "size" : "40x40" + }, + { + "filename" : "icon-40@3x.png", + "idiom" : "iphone", + "scale" : "3x", + "size" : "40x40" + }, + { + "filename" : "icon-60@2x.png", + "idiom" : "iphone", + "scale" : "2x", + "size" : "60x60" + }, + { + "filename" : "icon-60@3x.png", + "idiom" : "iphone", + "scale" : "3x", + "size" : "60x60" + }, + { + "filename" : "icon-20.png", + "idiom" : "ipad", + "scale" : "1x", + "size" : "20x20" + }, + { + "filename" : "icon-20@2x.png", + "idiom" : "ipad", + "scale" : "2x", + "size" : "20x20" + }, + { + "filename" : "icon-29.png", + "idiom" : "ipad", + "scale" : "1x", + "size" : "29x29" + }, + { + "filename" : "icon-29@2x.png", + "idiom" : "ipad", + "scale" : "2x", + "size" : "29x29" + }, + { + "filename" : "icon-40.png", + "idiom" : "ipad", + "scale" : "1x", + "size" : "40x40" + }, + { + "filename" : "icon-40@2x.png", + "idiom" : "ipad", + "scale" : "2x", + "size" : "40x40" + }, + { + "filename" : "icon-76.png", + "idiom" : "ipad", + "scale" : "1x", + "size" : "76x76" + }, + { + "filename" : "icon-76@2x.png", + "idiom" : "ipad", + "scale" : "2x", + "size" : "76x76" + }, + { + "filename" : "icon-83.5@2x.png", + "idiom" : "ipad", + "scale" : "2x", + "size" : "83.5x83.5" + }, + { + "filename" : "icon-1024.png", + "idiom" : "ios-marketing", + "scale" : "1x", + "size" : "1024x1024" + } + ] +} \ No newline at end of file diff --git a/v3/examples/ios/build/ios/xcode/main/Assets.xcassets/AppIcon.appiconset/icon-1024.png b/v3/examples/ios/build/ios/xcode/main/Assets.xcassets/AppIcon.appiconset/icon-1024.png new file mode 100644 index 000000000..50d762121 Binary files /dev/null and b/v3/examples/ios/build/ios/xcode/main/Assets.xcassets/AppIcon.appiconset/icon-1024.png differ diff --git a/v3/examples/ios/build/ios/xcode/main/Assets.xcassets/AppIcon.appiconset/icon-20.png b/v3/examples/ios/build/ios/xcode/main/Assets.xcassets/AppIcon.appiconset/icon-20.png new file mode 100644 index 000000000..8559d2b1d Binary files /dev/null and b/v3/examples/ios/build/ios/xcode/main/Assets.xcassets/AppIcon.appiconset/icon-20.png differ diff --git a/v3/examples/ios/build/ios/xcode/main/Assets.xcassets/AppIcon.appiconset/icon-20@2x.png b/v3/examples/ios/build/ios/xcode/main/Assets.xcassets/AppIcon.appiconset/icon-20@2x.png new file mode 100644 index 000000000..0f2720a87 Binary files /dev/null and b/v3/examples/ios/build/ios/xcode/main/Assets.xcassets/AppIcon.appiconset/icon-20@2x.png differ diff --git a/v3/examples/ios/build/ios/xcode/main/Assets.xcassets/AppIcon.appiconset/icon-20@3x.png b/v3/examples/ios/build/ios/xcode/main/Assets.xcassets/AppIcon.appiconset/icon-20@3x.png new file mode 100644 index 000000000..aa0892d9e Binary files /dev/null and b/v3/examples/ios/build/ios/xcode/main/Assets.xcassets/AppIcon.appiconset/icon-20@3x.png differ diff --git a/v3/examples/ios/build/ios/xcode/main/Assets.xcassets/AppIcon.appiconset/icon-29.png b/v3/examples/ios/build/ios/xcode/main/Assets.xcassets/AppIcon.appiconset/icon-29.png new file mode 100644 index 000000000..21de36f8b Binary files /dev/null and b/v3/examples/ios/build/ios/xcode/main/Assets.xcassets/AppIcon.appiconset/icon-29.png differ diff --git a/v3/examples/ios/build/ios/xcode/main/Assets.xcassets/AppIcon.appiconset/icon-29@2x.png b/v3/examples/ios/build/ios/xcode/main/Assets.xcassets/AppIcon.appiconset/icon-29@2x.png new file mode 100644 index 000000000..43f7766ae Binary files /dev/null and b/v3/examples/ios/build/ios/xcode/main/Assets.xcassets/AppIcon.appiconset/icon-29@2x.png differ diff --git a/v3/examples/ios/build/ios/xcode/main/Assets.xcassets/AppIcon.appiconset/icon-29@3x.png b/v3/examples/ios/build/ios/xcode/main/Assets.xcassets/AppIcon.appiconset/icon-29@3x.png new file mode 100644 index 000000000..db48d12db Binary files /dev/null and b/v3/examples/ios/build/ios/xcode/main/Assets.xcassets/AppIcon.appiconset/icon-29@3x.png differ diff --git a/v3/examples/ios/build/ios/xcode/main/Assets.xcassets/AppIcon.appiconset/icon-40.png b/v3/examples/ios/build/ios/xcode/main/Assets.xcassets/AppIcon.appiconset/icon-40.png new file mode 100644 index 000000000..0f2720a87 Binary files /dev/null and b/v3/examples/ios/build/ios/xcode/main/Assets.xcassets/AppIcon.appiconset/icon-40.png differ diff --git a/v3/examples/ios/build/ios/xcode/main/Assets.xcassets/AppIcon.appiconset/icon-40@2x.png b/v3/examples/ios/build/ios/xcode/main/Assets.xcassets/AppIcon.appiconset/icon-40@2x.png new file mode 100644 index 000000000..b0c40d1b7 Binary files /dev/null and b/v3/examples/ios/build/ios/xcode/main/Assets.xcassets/AppIcon.appiconset/icon-40@2x.png differ diff --git a/v3/examples/ios/build/ios/xcode/main/Assets.xcassets/AppIcon.appiconset/icon-40@3x.png b/v3/examples/ios/build/ios/xcode/main/Assets.xcassets/AppIcon.appiconset/icon-40@3x.png new file mode 100644 index 000000000..a3c751376 Binary files /dev/null and b/v3/examples/ios/build/ios/xcode/main/Assets.xcassets/AppIcon.appiconset/icon-40@3x.png differ diff --git a/v3/examples/ios/build/ios/xcode/main/Assets.xcassets/AppIcon.appiconset/icon-60@2x.png b/v3/examples/ios/build/ios/xcode/main/Assets.xcassets/AppIcon.appiconset/icon-60@2x.png new file mode 100644 index 000000000..a3c751376 Binary files /dev/null and b/v3/examples/ios/build/ios/xcode/main/Assets.xcassets/AppIcon.appiconset/icon-60@2x.png differ diff --git a/v3/examples/ios/build/ios/xcode/main/Assets.xcassets/AppIcon.appiconset/icon-60@3x.png b/v3/examples/ios/build/ios/xcode/main/Assets.xcassets/AppIcon.appiconset/icon-60@3x.png new file mode 100644 index 000000000..fe6a86faf Binary files /dev/null and b/v3/examples/ios/build/ios/xcode/main/Assets.xcassets/AppIcon.appiconset/icon-60@3x.png differ diff --git a/v3/examples/ios/build/ios/xcode/main/Assets.xcassets/AppIcon.appiconset/icon-76.png b/v3/examples/ios/build/ios/xcode/main/Assets.xcassets/AppIcon.appiconset/icon-76.png new file mode 100644 index 000000000..8ff321e60 Binary files /dev/null and b/v3/examples/ios/build/ios/xcode/main/Assets.xcassets/AppIcon.appiconset/icon-76.png differ diff --git a/v3/examples/ios/build/ios/xcode/main/Assets.xcassets/AppIcon.appiconset/icon-76@2x.png b/v3/examples/ios/build/ios/xcode/main/Assets.xcassets/AppIcon.appiconset/icon-76@2x.png new file mode 100644 index 000000000..8e09d8adc Binary files /dev/null and b/v3/examples/ios/build/ios/xcode/main/Assets.xcassets/AppIcon.appiconset/icon-76@2x.png differ diff --git a/v3/examples/ios/build/ios/xcode/main/Assets.xcassets/AppIcon.appiconset/icon-83.5@2x.png b/v3/examples/ios/build/ios/xcode/main/Assets.xcassets/AppIcon.appiconset/icon-83.5@2x.png new file mode 100644 index 000000000..fdfb581c9 Binary files /dev/null and b/v3/examples/ios/build/ios/xcode/main/Assets.xcassets/AppIcon.appiconset/icon-83.5@2x.png differ diff --git a/v3/examples/ios/build/ios/xcode/main/Info.plist b/v3/examples/ios/build/ios/xcode/main/Info.plist new file mode 100644 index 000000000..c96f4f2ec --- /dev/null +++ b/v3/examples/ios/build/ios/xcode/main/Info.plist @@ -0,0 +1,59 @@ + + + + + CFBundleExecutable + wailsapp + CFBundleIdentifier + com.mycompany.myproduct + CFBundleName + My Product + CFBundleDisplayName + My Product + CFBundlePackageType + APPL + CFBundleShortVersionString + 0.0.1 + CFBundleVersion + 0.0.1 + LSRequiresIPhoneOS + + MinimumOSVersion + 15.0 + UILaunchStoryboardName + LaunchScreen + UIRequiredDeviceCapabilities + + armv7 + arm64 + + UISupportedInterfaceOrientations + + UIInterfaceOrientationPortrait + UIInterfaceOrientationLandscapeLeft + UIInterfaceOrientationLandscapeRight + + UISupportedInterfaceOrientations~ipad + + UIInterfaceOrientationPortrait + UIInterfaceOrientationPortraitUpsideDown + UIInterfaceOrientationLandscapeLeft + UIInterfaceOrientationLandscapeRight + + NSAppTransportSecurity + + NSAllowsArbitraryLoads + + NSAllowsLocalNetworking + + + + NSHumanReadableCopyright + (c) 2025, My Company + + + CFBundleGetInfoString + Some Product Comments + + + \ No newline at end of file diff --git a/v3/examples/ios/build/ios/xcode/main/LaunchScreen.storyboard b/v3/examples/ios/build/ios/xcode/main/LaunchScreen.storyboard new file mode 100644 index 000000000..d6178d6b5 --- /dev/null +++ b/v3/examples/ios/build/ios/xcode/main/LaunchScreen.storyboard @@ -0,0 +1,53 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/v3/examples/ios/build/ios/xcode/main/main.m b/v3/examples/ios/build/ios/xcode/main/main.m new file mode 100644 index 000000000..0f2e7e8e1 --- /dev/null +++ b/v3/examples/ios/build/ios/xcode/main/main.m @@ -0,0 +1,22 @@ +// Minimal bootstrap: delegate comes from Go archive (WailsAppDelegate) +#import +#include + +// External Go initialization function from the c-archive (declare before use) +extern void WailsIOSMain(); + +int main(int argc, char * argv[]) { + @autoreleasepool { + // Disable buffering so stdout/stderr from Go log.Printf flush immediately + setvbuf(stdout, NULL, _IONBF, 0); + setvbuf(stderr, NULL, _IONBF, 0); + + // Start Go runtime on a background queue to avoid blocking main thread/UI + dispatch_async(dispatch_get_global_queue(QOS_CLASS_USER_INITIATED, 0), ^{ + WailsIOSMain(); + }); + + // Run UIApplicationMain using WailsAppDelegate provided by the Go archive + return UIApplicationMain(argc, argv, nil, @"WailsAppDelegate"); + } +} \ No newline at end of file diff --git a/v3/examples/ios/build/ios/xcode/overlay.json b/v3/examples/ios/build/ios/xcode/overlay.json new file mode 100644 index 000000000..9ceefc4dc --- /dev/null +++ b/v3/examples/ios/build/ios/xcode/overlay.json @@ -0,0 +1,5 @@ +{ + "Replace": { + "/Users/leaanthony/test/wails/v3/examples/ios/main_ios.gen.go": "/Users/leaanthony/test/wails/v3/examples/ios/build/ios/xcode/gen/main_ios.gen.go" + } +} \ No newline at end of file diff --git a/v3/examples/ios/build/linux/Taskfile.yml b/v3/examples/ios/build/linux/Taskfile.yml new file mode 100644 index 000000000..87fd599cc --- /dev/null +++ b/v3/examples/ios/build/linux/Taskfile.yml @@ -0,0 +1,119 @@ +version: '3' + +includes: + common: ../Taskfile.yml + +tasks: + build: + summary: Builds the application for Linux + deps: + - task: common:go:mod:tidy + - task: common:build:frontend + vars: + BUILD_FLAGS: + ref: .BUILD_FLAGS + PRODUCTION: + ref: .PRODUCTION + - task: common:generate:icons + cmds: + - go build {{.BUILD_FLAGS}} -o {{.BIN_DIR}}/{{.APP_NAME}} + vars: + BUILD_FLAGS: '{{if eq .PRODUCTION "true"}}-tags production -trimpath -buildvcs=false -ldflags="-w -s"{{else}}-buildvcs=false -gcflags=all="-l"{{end}}' + env: + GOOS: linux + CGO_ENABLED: 1 + GOARCH: '{{.ARCH | default ARCH}}' + PRODUCTION: '{{.PRODUCTION | default "false"}}' + + package: + summary: Packages a production build of the application for Linux + deps: + - task: build + vars: + PRODUCTION: "true" + cmds: + - task: create:appimage + - task: create:deb + - task: create:rpm + - task: create:aur + + create:appimage: + summary: Creates an AppImage + dir: build/linux/appimage + deps: + - task: build + vars: + PRODUCTION: "true" + - task: generate:dotdesktop + cmds: + - cp {{.APP_BINARY}} {{.APP_NAME}} + - cp ../../appicon.png appicon.png + - wails3 generate appimage -binary {{.APP_NAME}} -icon {{.ICON}} -desktopfile {{.DESKTOP_FILE}} -outputdir {{.OUTPUT_DIR}} -builddir {{.ROOT_DIR}}/build/linux/appimage/build + vars: + APP_NAME: '{{.APP_NAME}}' + APP_BINARY: '../../../bin/{{.APP_NAME}}' + ICON: '../../appicon.png' + DESKTOP_FILE: '../{{.APP_NAME}}.desktop' + OUTPUT_DIR: '../../../bin' + + create:deb: + summary: Creates a deb package + deps: + - task: build + vars: + PRODUCTION: "true" + cmds: + - task: generate:dotdesktop + - task: generate:deb + + create:rpm: + summary: Creates a rpm package + deps: + - task: build + vars: + PRODUCTION: "true" + cmds: + - task: generate:dotdesktop + - task: generate:rpm + + create:aur: + summary: Creates a arch linux packager package + deps: + - task: build + vars: + PRODUCTION: "true" + cmds: + - task: generate:dotdesktop + - task: generate:aur + + generate:deb: + summary: Creates a deb package + cmds: + - wails3 tool package -name {{.APP_NAME}} -format deb -config ./build/linux/nfpm/nfpm.yaml -out {{.ROOT_DIR}}/bin + + generate:rpm: + summary: Creates a rpm package + cmds: + - wails3 tool package -name {{.APP_NAME}} -format rpm -config ./build/linux/nfpm/nfpm.yaml -out {{.ROOT_DIR}}/bin + + generate:aur: + summary: Creates a arch linux packager package + cmds: + - wails3 tool package -name {{.APP_NAME}} -format archlinux -config ./build/linux/nfpm/nfpm.yaml -out {{.ROOT_DIR}}/bin + + generate:dotdesktop: + summary: Generates a `.desktop` file + dir: build + cmds: + - mkdir -p {{.ROOT_DIR}}/build/linux/appimage + - wails3 generate .desktop -name "{{.APP_NAME}}" -exec "{{.EXEC}}" -icon "{{.ICON}}" -outputfile {{.ROOT_DIR}}/build/linux/{{.APP_NAME}}.desktop -categories "{{.CATEGORIES}}" + vars: + APP_NAME: '{{.APP_NAME}}' + EXEC: '{{.APP_NAME}}' + ICON: '{{.APP_NAME}}' + CATEGORIES: 'Development;' + OUTPUTFILE: '{{.ROOT_DIR}}/build/linux/{{.APP_NAME}}.desktop' + + run: + cmds: + - '{{.BIN_DIR}}/{{.APP_NAME}}' diff --git a/v3/examples/ios/build/linux/appimage/build.sh b/v3/examples/ios/build/linux/appimage/build.sh new file mode 100644 index 000000000..858f091ab --- /dev/null +++ b/v3/examples/ios/build/linux/appimage/build.sh @@ -0,0 +1,34 @@ +#!/usr/bin/env bash +# Copyright (c) 2018-Present Lea Anthony +# SPDX-License-Identifier: MIT + +# Fail script on any error +set -euxo pipefail + +# Define variables +APP_DIR="${APP_NAME}.AppDir" + +# Create AppDir structure +mkdir -p "${APP_DIR}/usr/bin" +cp -r "${APP_BINARY}" "${APP_DIR}/usr/bin/" +cp "${ICON_PATH}" "${APP_DIR}/" +cp "${DESKTOP_FILE}" "${APP_DIR}/" + +if [[ $(uname -m) == *x86_64* ]]; then + # Download linuxdeploy and make it executable + wget -q -4 -N https://github.com/linuxdeploy/linuxdeploy/releases/download/continuous/linuxdeploy-x86_64.AppImage + chmod +x linuxdeploy-x86_64.AppImage + + # Run linuxdeploy to bundle the application + ./linuxdeploy-x86_64.AppImage --appdir "${APP_DIR}" --output appimage +else + # Download linuxdeploy and make it executable (arm64) + wget -q -4 -N https://github.com/linuxdeploy/linuxdeploy/releases/download/continuous/linuxdeploy-aarch64.AppImage + chmod +x linuxdeploy-aarch64.AppImage + + # Run linuxdeploy to bundle the application (arm64) + ./linuxdeploy-aarch64.AppImage --appdir "${APP_DIR}" --output appimage +fi + +# Rename the generated AppImage +mv "${APP_NAME}*.AppImage" "${APP_NAME}.AppImage" diff --git a/v3/examples/ios/build/linux/desktop b/v3/examples/ios/build/linux/desktop new file mode 100644 index 000000000..e9b30cf39 --- /dev/null +++ b/v3/examples/ios/build/linux/desktop @@ -0,0 +1,11 @@ +[Desktop Entry] +Version=1.0 +Name=My Product +Comment=My Product Description +# The Exec line includes %u to pass the URL to the application +Exec=/usr/local/bin/ios %u +Terminal=false +Type=Application +Icon=ios +Categories=Utility; +StartupWMClass=ios diff --git a/v3/examples/ios/build/linux/nfpm/nfpm.yaml b/v3/examples/ios/build/linux/nfpm/nfpm.yaml new file mode 100644 index 000000000..7b78433f4 --- /dev/null +++ b/v3/examples/ios/build/linux/nfpm/nfpm.yaml @@ -0,0 +1,67 @@ +# Feel free to remove those if you don't want/need to use them. +# Make sure to check the documentation at https://nfpm.goreleaser.com +# +# The lines below are called `modelines`. See `:help modeline` + +name: "ios" +arch: ${GOARCH} +platform: "linux" +version: "0.1.0" +section: "default" +priority: "extra" +maintainer: ${GIT_COMMITTER_NAME} <${GIT_COMMITTER_EMAIL}> +description: "My Product Description" +vendor: "My Company" +homepage: "https://wails.io" +license: "MIT" +release: "1" + +contents: + - src: "./bin/ios" + dst: "/usr/local/bin/ios" + - src: "./build/appicon.png" + dst: "/usr/share/icons/hicolor/128x128/apps/ios.png" + - src: "./build/linux/ios.desktop" + dst: "/usr/share/applications/ios.desktop" + +# Default dependencies for Debian 12/Ubuntu 22.04+ with WebKit 4.1 +depends: + - libgtk-3-0 + - libwebkit2gtk-4.1-0 + +# Distribution-specific overrides for different package formats and WebKit versions +overrides: + # RPM packages for RHEL/CentOS/AlmaLinux/Rocky Linux (WebKit 4.0) + rpm: + depends: + - gtk3 + - webkit2gtk4.1 + + # Arch Linux packages (WebKit 4.1) + archlinux: + depends: + - gtk3 + - webkit2gtk-4.1 + +# scripts section to ensure desktop database is updated after install +scripts: + postinstall: "./build/linux/nfpm/scripts/postinstall.sh" + # You can also add preremove, postremove if needed + # preremove: "./build/linux/nfpm/scripts/preremove.sh" + # postremove: "./build/linux/nfpm/scripts/postremove.sh" + +# replaces: +# - foobar +# provides: +# - bar +# depends: +# - gtk3 +# - libwebkit2gtk +# recommends: +# - whatever +# suggests: +# - something-else +# conflicts: +# - not-foo +# - not-bar +# changelog: "changelog.yaml" diff --git a/v3/examples/ios/build/linux/nfpm/scripts/postinstall.sh b/v3/examples/ios/build/linux/nfpm/scripts/postinstall.sh new file mode 100644 index 000000000..4bbb815a3 --- /dev/null +++ b/v3/examples/ios/build/linux/nfpm/scripts/postinstall.sh @@ -0,0 +1,21 @@ +#!/bin/sh + +# Update desktop database for .desktop file changes +# This makes the application appear in application menus and registers its capabilities. +if command -v update-desktop-database >/dev/null 2>&1; then + echo "Updating desktop database..." + update-desktop-database -q /usr/share/applications +else + echo "Warning: update-desktop-database command not found. Desktop file may not be immediately recognized." >&2 +fi + +# Update MIME database for custom URL schemes (x-scheme-handler) +# This ensures the system knows how to handle your custom protocols. +if command -v update-mime-database >/dev/null 2>&1; then + echo "Updating MIME database..." + update-mime-database -n /usr/share/mime +else + echo "Warning: update-mime-database command not found. Custom URL schemes may not be immediately recognized." >&2 +fi + +exit 0 diff --git a/v3/examples/ios/build/linux/nfpm/scripts/postremove.sh b/v3/examples/ios/build/linux/nfpm/scripts/postremove.sh new file mode 100644 index 000000000..a9bf588e2 --- /dev/null +++ b/v3/examples/ios/build/linux/nfpm/scripts/postremove.sh @@ -0,0 +1 @@ +#!/bin/bash diff --git a/v3/examples/ios/build/linux/nfpm/scripts/preinstall.sh b/v3/examples/ios/build/linux/nfpm/scripts/preinstall.sh new file mode 100644 index 000000000..a9bf588e2 --- /dev/null +++ b/v3/examples/ios/build/linux/nfpm/scripts/preinstall.sh @@ -0,0 +1 @@ +#!/bin/bash diff --git a/v3/examples/ios/build/linux/nfpm/scripts/preremove.sh b/v3/examples/ios/build/linux/nfpm/scripts/preremove.sh new file mode 100644 index 000000000..a9bf588e2 --- /dev/null +++ b/v3/examples/ios/build/linux/nfpm/scripts/preremove.sh @@ -0,0 +1 @@ +#!/bin/bash diff --git a/v3/examples/ios/build/windows/Taskfile.yml b/v3/examples/ios/build/windows/Taskfile.yml new file mode 100644 index 000000000..19f137616 --- /dev/null +++ b/v3/examples/ios/build/windows/Taskfile.yml @@ -0,0 +1,98 @@ +version: '3' + +includes: + common: ../Taskfile.yml + +tasks: + build: + summary: Builds the application for Windows + deps: + - task: common:go:mod:tidy + - task: common:build:frontend + vars: + BUILD_FLAGS: + ref: .BUILD_FLAGS + PRODUCTION: + ref: .PRODUCTION + - task: common:generate:icons + cmds: + - task: generate:syso + - go build {{.BUILD_FLAGS}} -o {{.BIN_DIR}}/{{.APP_NAME}}.exe + - cmd: powershell Remove-item *.syso + platforms: [windows] + - cmd: rm -f *.syso + platforms: [linux, darwin] + vars: + BUILD_FLAGS: '{{if eq .PRODUCTION "true"}}-tags production -trimpath -buildvcs=false -ldflags="-w -s -H windowsgui"{{else}}-buildvcs=false -gcflags=all="-l"{{end}}' + env: + GOOS: windows + CGO_ENABLED: 0 + GOARCH: '{{.ARCH | default ARCH}}' + PRODUCTION: '{{.PRODUCTION | default "false"}}' + + package: + summary: Packages a production build of the application + cmds: + - |- + if [ "{{.FORMAT | default "nsis"}}" = "msix" ]; then + task: create:msix:package + else + task: create:nsis:installer + fi + vars: + FORMAT: '{{.FORMAT | default "nsis"}}' + + generate:syso: + summary: Generates Windows `.syso` file + dir: build + cmds: + - wails3 generate syso -arch {{.ARCH}} -icon windows/icon.ico -manifest windows/wails.exe.manifest -info windows/info.json -out ../wails_windows_{{.ARCH}}.syso + vars: + ARCH: '{{.ARCH | default ARCH}}' + + create:nsis:installer: + summary: Creates an NSIS installer + dir: build/windows/nsis + deps: + - task: build + vars: + PRODUCTION: "true" + cmds: + # Create the Microsoft WebView2 bootstrapper if it doesn't exist + - wails3 generate webview2bootstrapper -dir "{{.ROOT_DIR}}/build/windows/nsis" + - makensis -DARG_WAILS_{{.ARG_FLAG}}_BINARY="{{.ROOT_DIR}}/{{.BIN_DIR}}/{{.APP_NAME}}.exe" project.nsi + vars: + ARCH: '{{.ARCH | default ARCH}}' + ARG_FLAG: '{{if eq .ARCH "amd64"}}AMD64{{else}}ARM64{{end}}' + + create:msix:package: + summary: Creates an MSIX package + deps: + - task: build + vars: + PRODUCTION: "true" + cmds: + - |- + wails3 tool msix \ + --config "{{.ROOT_DIR}}/wails.json" \ + --name "{{.APP_NAME}}" \ + --executable "{{.ROOT_DIR}}/{{.BIN_DIR}}/{{.APP_NAME}}.exe" \ + --arch "{{.ARCH}}" \ + --out "{{.ROOT_DIR}}/{{.BIN_DIR}}/{{.APP_NAME}}-{{.ARCH}}.msix" \ + {{if .CERT_PATH}}--cert "{{.CERT_PATH}}"{{end}} \ + {{if .PUBLISHER}}--publisher "{{.PUBLISHER}}"{{end}} \ + {{if .USE_MSIX_TOOL}}--use-msix-tool{{else}}--use-makeappx{{end}} + vars: + ARCH: '{{.ARCH | default ARCH}}' + CERT_PATH: '{{.CERT_PATH | default ""}}' + PUBLISHER: '{{.PUBLISHER | default ""}}' + USE_MSIX_TOOL: '{{.USE_MSIX_TOOL | default "false"}}' + + install:msix:tools: + summary: Installs tools required for MSIX packaging + cmds: + - wails3 tool msix-install-tools + + run: + cmds: + - '{{.BIN_DIR}}/{{.APP_NAME}}.exe' diff --git a/v3/examples/ios/build/windows/icon.ico b/v3/examples/ios/build/windows/icon.ico new file mode 100644 index 000000000..bfa0690b7 Binary files /dev/null and b/v3/examples/ios/build/windows/icon.ico differ diff --git a/v3/examples/ios/build/windows/info.json b/v3/examples/ios/build/windows/info.json new file mode 100644 index 000000000..850b2b5b0 --- /dev/null +++ b/v3/examples/ios/build/windows/info.json @@ -0,0 +1,15 @@ +{ + "fixed": { + "file_version": "0.1.0" + }, + "info": { + "0000": { + "ProductVersion": "0.1.0", + "CompanyName": "My Company", + "FileDescription": "My Product Description", + "LegalCopyright": "© now, My Company", + "ProductName": "My Product", + "Comments": "This is a comment" + } + } +} \ No newline at end of file diff --git a/v3/examples/ios/build/windows/msix/app_manifest.xml b/v3/examples/ios/build/windows/msix/app_manifest.xml new file mode 100644 index 000000000..ecf2506b3 --- /dev/null +++ b/v3/examples/ios/build/windows/msix/app_manifest.xml @@ -0,0 +1,52 @@ + + + + + + + My Product + My Company + My Product Description + Assets\StoreLogo.png + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/v3/examples/ios/build/windows/msix/template.xml b/v3/examples/ios/build/windows/msix/template.xml new file mode 100644 index 000000000..cab2f31e0 --- /dev/null +++ b/v3/examples/ios/build/windows/msix/template.xml @@ -0,0 +1,54 @@ + + + + + + + + + + + + + + + + + + + + + + + + false + My Product + My Company + My Product Description + Assets\AppIcon.png + + + + + + + diff --git a/v3/examples/ios/build/windows/nsis/project.nsi b/v3/examples/ios/build/windows/nsis/project.nsi new file mode 100644 index 000000000..74b8d6ad0 --- /dev/null +++ b/v3/examples/ios/build/windows/nsis/project.nsi @@ -0,0 +1,112 @@ +Unicode true + +#### +## Please note: Template replacements don't work in this file. They are provided with default defines like +## mentioned underneath. +## If the keyword is not defined, "wails_tools.nsh" will populate them. +## If they are defined here, "wails_tools.nsh" will not touch them. This allows you to use this project.nsi manually +## from outside of Wails for debugging and development of the installer. +## +## For development first make a wails nsis build to populate the "wails_tools.nsh": +## > wails build --target windows/amd64 --nsis +## Then you can call makensis on this file with specifying the path to your binary: +## For a AMD64 only installer: +## > makensis -DARG_WAILS_AMD64_BINARY=..\..\bin\app.exe +## For a ARM64 only installer: +## > makensis -DARG_WAILS_ARM64_BINARY=..\..\bin\app.exe +## For a installer with both architectures: +## > makensis -DARG_WAILS_AMD64_BINARY=..\..\bin\app-amd64.exe -DARG_WAILS_ARM64_BINARY=..\..\bin\app-arm64.exe +#### +## The following information is taken from the wails_tools.nsh file, but they can be overwritten here. +#### +## !define INFO_PROJECTNAME "my-project" # Default "ios" +## !define INFO_COMPANYNAME "My Company" # Default "My Company" +## !define INFO_PRODUCTNAME "My Product Name" # Default "My Product" +## !define INFO_PRODUCTVERSION "1.0.0" # Default "0.1.0" +## !define INFO_COPYRIGHT "(c) Now, My Company" # Default "© now, My Company" +### +## !define PRODUCT_EXECUTABLE "Application.exe" # Default "${INFO_PROJECTNAME}.exe" +## !define UNINST_KEY_NAME "UninstKeyInRegistry" # Default "${INFO_COMPANYNAME}${INFO_PRODUCTNAME}" +#### +## !define REQUEST_EXECUTION_LEVEL "admin" # Default "admin" see also https://nsis.sourceforge.io/Docs/Chapter4.html +#### +## Include the wails tools +#### +!include "wails_tools.nsh" + +# The version information for this two must consist of 4 parts +VIProductVersion "${INFO_PRODUCTVERSION}.0" +VIFileVersion "${INFO_PRODUCTVERSION}.0" + +VIAddVersionKey "CompanyName" "${INFO_COMPANYNAME}" +VIAddVersionKey "FileDescription" "${INFO_PRODUCTNAME} Installer" +VIAddVersionKey "ProductVersion" "${INFO_PRODUCTVERSION}" +VIAddVersionKey "FileVersion" "${INFO_PRODUCTVERSION}" +VIAddVersionKey "LegalCopyright" "${INFO_COPYRIGHT}" +VIAddVersionKey "ProductName" "${INFO_PRODUCTNAME}" + +# Enable HiDPI support. https://nsis.sourceforge.io/Reference/ManifestDPIAware +ManifestDPIAware true + +!include "MUI.nsh" + +!define MUI_ICON "..\icon.ico" +!define MUI_UNICON "..\icon.ico" +# !define MUI_WELCOMEFINISHPAGE_BITMAP "resources\leftimage.bmp" #Include this to add a bitmap on the left side of the Welcome Page. Must be a size of 164x314 +!define MUI_FINISHPAGE_NOAUTOCLOSE # Wait on the INSTFILES page so the user can take a look into the details of the installation steps +!define MUI_ABORTWARNING # This will warn the user if they exit from the installer. + +!insertmacro MUI_PAGE_WELCOME # Welcome to the installer page. +# !insertmacro MUI_PAGE_LICENSE "resources\eula.txt" # Adds a EULA page to the installer +!insertmacro MUI_PAGE_DIRECTORY # In which folder install page. +!insertmacro MUI_PAGE_INSTFILES # Installing page. +!insertmacro MUI_PAGE_FINISH # Finished installation page. + +!insertmacro MUI_UNPAGE_INSTFILES # Uninstalling page + +!insertmacro MUI_LANGUAGE "English" # Set the Language of the installer + +## The following two statements can be used to sign the installer and the uninstaller. The path to the binaries are provided in %1 +#!uninstfinalize 'signtool --file "%1"' +#!finalize 'signtool --file "%1"' + +Name "${INFO_PRODUCTNAME}" +OutFile "..\..\..\bin\${INFO_PROJECTNAME}-${ARCH}-installer.exe" # Name of the installer's file. +InstallDir "$PROGRAMFILES64\${INFO_COMPANYNAME}\${INFO_PRODUCTNAME}" # Default installing folder ($PROGRAMFILES is Program Files folder). +ShowInstDetails show # This will always show the installation details. + +Function .onInit + !insertmacro wails.checkArchitecture +FunctionEnd + +Section + !insertmacro wails.setShellContext + + !insertmacro wails.webview2runtime + + SetOutPath $INSTDIR + + !insertmacro wails.files + + CreateShortcut "$SMPROGRAMS\${INFO_PRODUCTNAME}.lnk" "$INSTDIR\${PRODUCT_EXECUTABLE}" + CreateShortCut "$DESKTOP\${INFO_PRODUCTNAME}.lnk" "$INSTDIR\${PRODUCT_EXECUTABLE}" + + !insertmacro wails.associateFiles + + !insertmacro wails.writeUninstaller +SectionEnd + +Section "uninstall" + !insertmacro wails.setShellContext + + RMDir /r "$AppData\${PRODUCT_EXECUTABLE}" # Remove the WebView2 DataPath + + RMDir /r $INSTDIR + + Delete "$SMPROGRAMS\${INFO_PRODUCTNAME}.lnk" + Delete "$DESKTOP\${INFO_PRODUCTNAME}.lnk" + + !insertmacro wails.unassociateFiles + + !insertmacro wails.deleteUninstaller +SectionEnd diff --git a/v3/examples/ios/build/windows/nsis/wails_tools.nsh b/v3/examples/ios/build/windows/nsis/wails_tools.nsh new file mode 100644 index 000000000..dc9aebc17 --- /dev/null +++ b/v3/examples/ios/build/windows/nsis/wails_tools.nsh @@ -0,0 +1,212 @@ +# DO NOT EDIT - Generated automatically by `wails build` + +!include "x64.nsh" +!include "WinVer.nsh" +!include "FileFunc.nsh" + +!ifndef INFO_PROJECTNAME + !define INFO_PROJECTNAME "ios" +!endif +!ifndef INFO_COMPANYNAME + !define INFO_COMPANYNAME "My Company" +!endif +!ifndef INFO_PRODUCTNAME + !define INFO_PRODUCTNAME "My Product" +!endif +!ifndef INFO_PRODUCTVERSION + !define INFO_PRODUCTVERSION "0.1.0" +!endif +!ifndef INFO_COPYRIGHT + !define INFO_COPYRIGHT "© now, My Company" +!endif +!ifndef PRODUCT_EXECUTABLE + !define PRODUCT_EXECUTABLE "${INFO_PROJECTNAME}.exe" +!endif +!ifndef UNINST_KEY_NAME + !define UNINST_KEY_NAME "${INFO_COMPANYNAME}${INFO_PRODUCTNAME}" +!endif +!define UNINST_KEY "Software\Microsoft\Windows\CurrentVersion\Uninstall\${UNINST_KEY_NAME}" + +!ifndef REQUEST_EXECUTION_LEVEL + !define REQUEST_EXECUTION_LEVEL "admin" +!endif + +RequestExecutionLevel "${REQUEST_EXECUTION_LEVEL}" + +!ifdef ARG_WAILS_AMD64_BINARY + !define SUPPORTS_AMD64 +!endif + +!ifdef ARG_WAILS_ARM64_BINARY + !define SUPPORTS_ARM64 +!endif + +!ifdef SUPPORTS_AMD64 + !ifdef SUPPORTS_ARM64 + !define ARCH "amd64_arm64" + !else + !define ARCH "amd64" + !endif +!else + !ifdef SUPPORTS_ARM64 + !define ARCH "arm64" + !else + !error "Wails: Undefined ARCH, please provide at least one of ARG_WAILS_AMD64_BINARY or ARG_WAILS_ARM64_BINARY" + !endif +!endif + +!macro wails.checkArchitecture + !ifndef WAILS_WIN10_REQUIRED + !define WAILS_WIN10_REQUIRED "This product is only supported on Windows 10 (Server 2016) and later." + !endif + + !ifndef WAILS_ARCHITECTURE_NOT_SUPPORTED + !define WAILS_ARCHITECTURE_NOT_SUPPORTED "This product can't be installed on the current Windows architecture. Supports: ${ARCH}" + !endif + + ${If} ${AtLeastWin10} + !ifdef SUPPORTS_AMD64 + ${if} ${IsNativeAMD64} + Goto ok + ${EndIf} + !endif + + !ifdef SUPPORTS_ARM64 + ${if} ${IsNativeARM64} + Goto ok + ${EndIf} + !endif + + IfSilent silentArch notSilentArch + silentArch: + SetErrorLevel 65 + Abort + notSilentArch: + MessageBox MB_OK "${WAILS_ARCHITECTURE_NOT_SUPPORTED}" + Quit + ${else} + IfSilent silentWin notSilentWin + silentWin: + SetErrorLevel 64 + Abort + notSilentWin: + MessageBox MB_OK "${WAILS_WIN10_REQUIRED}" + Quit + ${EndIf} + + ok: +!macroend + +!macro wails.files + !ifdef SUPPORTS_AMD64 + ${if} ${IsNativeAMD64} + File "/oname=${PRODUCT_EXECUTABLE}" "${ARG_WAILS_AMD64_BINARY}" + ${EndIf} + !endif + + !ifdef SUPPORTS_ARM64 + ${if} ${IsNativeARM64} + File "/oname=${PRODUCT_EXECUTABLE}" "${ARG_WAILS_ARM64_BINARY}" + ${EndIf} + !endif +!macroend + +!macro wails.writeUninstaller + WriteUninstaller "$INSTDIR\uninstall.exe" + + SetRegView 64 + WriteRegStr HKLM "${UNINST_KEY}" "Publisher" "${INFO_COMPANYNAME}" + WriteRegStr HKLM "${UNINST_KEY}" "DisplayName" "${INFO_PRODUCTNAME}" + WriteRegStr HKLM "${UNINST_KEY}" "DisplayVersion" "${INFO_PRODUCTVERSION}" + WriteRegStr HKLM "${UNINST_KEY}" "DisplayIcon" "$INSTDIR\${PRODUCT_EXECUTABLE}" + WriteRegStr HKLM "${UNINST_KEY}" "UninstallString" "$\"$INSTDIR\uninstall.exe$\"" + WriteRegStr HKLM "${UNINST_KEY}" "QuietUninstallString" "$\"$INSTDIR\uninstall.exe$\" /S" + + ${GetSize} "$INSTDIR" "/S=0K" $0 $1 $2 + IntFmt $0 "0x%08X" $0 + WriteRegDWORD HKLM "${UNINST_KEY}" "EstimatedSize" "$0" +!macroend + +!macro wails.deleteUninstaller + Delete "$INSTDIR\uninstall.exe" + + SetRegView 64 + DeleteRegKey HKLM "${UNINST_KEY}" +!macroend + +!macro wails.setShellContext + ${If} ${REQUEST_EXECUTION_LEVEL} == "admin" + SetShellVarContext all + ${else} + SetShellVarContext current + ${EndIf} +!macroend + +# Install webview2 by launching the bootstrapper +# See https://docs.microsoft.com/en-us/microsoft-edge/webview2/concepts/distribution#online-only-deployment +!macro wails.webview2runtime + !ifndef WAILS_INSTALL_WEBVIEW_DETAILPRINT + !define WAILS_INSTALL_WEBVIEW_DETAILPRINT "Installing: WebView2 Runtime" + !endif + + SetRegView 64 + # If the admin key exists and is not empty then webview2 is already installed + ReadRegStr $0 HKLM "SOFTWARE\WOW6432Node\Microsoft\EdgeUpdate\Clients\{F3017226-FE2A-4295-8BDF-00C3A9A7E4C5}" "pv" + ${If} $0 != "" + Goto ok + ${EndIf} + + ${If} ${REQUEST_EXECUTION_LEVEL} == "user" + # If the installer is run in user level, check the user specific key exists and is not empty then webview2 is already installed + ReadRegStr $0 HKCU "Software\Microsoft\EdgeUpdate\Clients\{F3017226-FE2A-4295-8BDF-00C3A9A7E4C5}" "pv" + ${If} $0 != "" + Goto ok + ${EndIf} + ${EndIf} + + SetDetailsPrint both + DetailPrint "${WAILS_INSTALL_WEBVIEW_DETAILPRINT}" + SetDetailsPrint listonly + + InitPluginsDir + CreateDirectory "$pluginsdir\webview2bootstrapper" + SetOutPath "$pluginsdir\webview2bootstrapper" + File "MicrosoftEdgeWebview2Setup.exe" + ExecWait '"$pluginsdir\webview2bootstrapper\MicrosoftEdgeWebview2Setup.exe" /silent /install' + + SetDetailsPrint both + ok: +!macroend + +# Copy of APP_ASSOCIATE and APP_UNASSOCIATE macros from here https://gist.github.com/nikku/281d0ef126dbc215dd58bfd5b3a5cd5b +!macro APP_ASSOCIATE EXT FILECLASS DESCRIPTION ICON COMMANDTEXT COMMAND + ; Backup the previously associated file class + ReadRegStr $R0 SHELL_CONTEXT "Software\Classes\.${EXT}" "" + WriteRegStr SHELL_CONTEXT "Software\Classes\.${EXT}" "${FILECLASS}_backup" "$R0" + + WriteRegStr SHELL_CONTEXT "Software\Classes\.${EXT}" "" "${FILECLASS}" + + WriteRegStr SHELL_CONTEXT "Software\Classes\${FILECLASS}" "" `${DESCRIPTION}` + WriteRegStr SHELL_CONTEXT "Software\Classes\${FILECLASS}\DefaultIcon" "" `${ICON}` + WriteRegStr SHELL_CONTEXT "Software\Classes\${FILECLASS}\shell" "" "open" + WriteRegStr SHELL_CONTEXT "Software\Classes\${FILECLASS}\shell\open" "" `${COMMANDTEXT}` + WriteRegStr SHELL_CONTEXT "Software\Classes\${FILECLASS}\shell\open\command" "" `${COMMAND}` +!macroend + +!macro APP_UNASSOCIATE EXT FILECLASS + ; Backup the previously associated file class + ReadRegStr $R0 SHELL_CONTEXT "Software\Classes\.${EXT}" `${FILECLASS}_backup` + WriteRegStr SHELL_CONTEXT "Software\Classes\.${EXT}" "" "$R0" + + DeleteRegKey SHELL_CONTEXT `Software\Classes\${FILECLASS}` +!macroend + +!macro wails.associateFiles + ; Create file associations + +!macroend + +!macro wails.unassociateFiles + ; Delete app associations + +!macroend \ No newline at end of file diff --git a/v3/examples/ios/build/windows/wails.exe.manifest b/v3/examples/ios/build/windows/wails.exe.manifest new file mode 100644 index 000000000..025555a69 --- /dev/null +++ b/v3/examples/ios/build/windows/wails.exe.manifest @@ -0,0 +1,22 @@ + + + + + + + + + + + true/pm + permonitorv2,permonitor + + + + + + + + + + \ No newline at end of file diff --git a/v3/examples/ios/frontend/Inter Font License.txt b/v3/examples/ios/frontend/Inter Font License.txt new file mode 100644 index 000000000..00287df15 --- /dev/null +++ b/v3/examples/ios/frontend/Inter Font License.txt @@ -0,0 +1,93 @@ +Copyright 2020 The Inter Project Authors (https://github.com/rsms/inter) + +This Font Software is licensed under the SIL Open Font License, Version 1.1. +This license is copied below, and is also available with a FAQ at: +http://scripts.sil.org/OFL + + +----------------------------------------------------------- +SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007 +----------------------------------------------------------- + +PREAMBLE +The goals of the Open Font License (OFL) are to stimulate worldwide +development of collaborative font projects, to support the font creation +efforts of academic and linguistic communities, and to provide a free and +open framework in which fonts may be shared and improved in partnership +with others. + +The OFL allows the licensed fonts to be used, studied, modified and +redistributed freely as long as they are not sold by themselves. The +fonts, including any derivative works, can be bundled, embedded, +redistributed and/or sold with any software provided that any reserved +names are not used by derivative works. The fonts and derivatives, +however, cannot be released under any other type of license. The +requirement for fonts to remain under this license does not apply +to any document created using the fonts or their derivatives. + +DEFINITIONS +"Font Software" refers to the set of files released by the Copyright +Holder(s) under this license and clearly marked as such. This may +include source files, build scripts and documentation. + +"Reserved Font Name" refers to any names specified as such after the +copyright statement(s). + +"Original Version" refers to the collection of Font Software components as +distributed by the Copyright Holder(s). + +"Modified Version" refers to any derivative made by adding to, deleting, +or substituting -- in part or in whole -- any of the components of the +Original Version, by changing formats or by porting the Font Software to a +new environment. + +"Author" refers to any designer, engineer, programmer, technical +writer or other person who contributed to the Font Software. + +PERMISSION & CONDITIONS +Permission is hereby granted, free of charge, to any person obtaining +a copy of the Font Software, to use, study, copy, merge, embed, modify, +redistribute, and sell modified and unmodified copies of the Font +Software, subject to the following conditions: + +1) Neither the Font Software nor any of its individual components, +in Original or Modified Versions, may be sold by itself. + +2) Original or Modified Versions of the Font Software may be bundled, +redistributed and/or sold with any software, provided that each copy +contains the above copyright notice and this license. These can be +included either as stand-alone text files, human-readable headers or +in the appropriate machine-readable metadata fields within text or +binary files as long as those fields can be easily viewed by the user. + +3) No Modified Version of the Font Software may use the Reserved Font +Name(s) unless explicit written permission is granted by the corresponding +Copyright Holder. This restriction only applies to the primary font name as +presented to the users. + +4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font +Software shall not be used to promote, endorse or advertise any +Modified Version, except to acknowledge the contribution(s) of the +Copyright Holder(s) and the Author(s) or with their explicit written +permission. + +5) The Font Software, modified or unmodified, in part or in whole, +must be distributed entirely under this license, and must not be +distributed under any other license. The requirement for fonts to +remain under this license does not apply to any document created +using the Font Software. + +TERMINATION +This license becomes null and void if any of the above conditions are +not met. + +DISCLAIMER +THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF +MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT +OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE +COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, +INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL +DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING +FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM +OTHER DEALINGS IN THE FONT SOFTWARE. diff --git a/v3/examples/ios/frontend/bindings/changeme/greetservice.js b/v3/examples/ios/frontend/bindings/changeme/greetservice.js new file mode 100644 index 000000000..0b93e6d75 --- /dev/null +++ b/v3/examples/ios/frontend/bindings/changeme/greetservice.js @@ -0,0 +1,15 @@ +// @ts-check +// Cynhyrchwyd y ffeil hon yn awtomatig. PEIDIWCH Â MODIWL +// This file is automatically generated. DO NOT EDIT + +// eslint-disable-next-line @typescript-eslint/ban-ts-comment +// @ts-ignore: Unused imports +import { Call as $Call, CancellablePromise as $CancellablePromise, Create as $Create } from "@wailsio/runtime"; + +/** + * @param {string} name + * @returns {$CancellablePromise} + */ +export function Greet(name) { + return $Call.ByID(1411160069, name); +} diff --git a/v3/examples/ios/frontend/bindings/changeme/index.js b/v3/examples/ios/frontend/bindings/changeme/index.js new file mode 100644 index 000000000..fdf1ff435 --- /dev/null +++ b/v3/examples/ios/frontend/bindings/changeme/index.js @@ -0,0 +1,8 @@ +// @ts-check +// Cynhyrchwyd y ffeil hon yn awtomatig. PEIDIWCH Â MODIWL +// This file is automatically generated. DO NOT EDIT + +import * as GreetService from "./greetservice.js"; +export { + GreetService +}; diff --git a/v3/examples/ios/frontend/index.html b/v3/examples/ios/frontend/index.html new file mode 100644 index 000000000..e5a37ff0c --- /dev/null +++ b/v3/examples/ios/frontend/index.html @@ -0,0 +1,96 @@ + + + + + + + + + Wails App + + +
            + +

            Wails + Javascript

            +
            +
            Demo Screens
            +
            + +
            +
            Please enter your name below 👇
            +
            + + +
            +
            + + +
            +
            + +
            +
            + +
            +
            + +
            +
            + +
            +
            + +
            +
            + + +
            +
            + + +
            +
            + + + + +
            +
            + +
            +
            + +
            +
            + +
            +
            + +
            +
            + +
            +
            + + +
            +
            
            +          
            + +
            +
            + +
            + + + diff --git a/v3/examples/ios/frontend/main.js b/v3/examples/ios/frontend/main.js new file mode 100644 index 000000000..ad8064576 --- /dev/null +++ b/v3/examples/ios/frontend/main.js @@ -0,0 +1,113 @@ +import {GreetService} from "./bindings/changeme"; +import * as Runtime from "@wailsio/runtime"; + +const resultElement = document.getElementById('result'); +const timeElement = document.getElementById('time'); +const deviceInfoElement = document.getElementById('deviceInfo'); +const Events = Runtime.Events; +const IOS = Runtime.IOS; // May be undefined in published package; we guard usages below. + +window.doGreet = () => { + let name = document.getElementById('name').value; + if (!name) { + name = 'anonymous'; + } + GreetService.Greet(name).then((result) => { + resultElement.innerText = result; + }).catch((err) => { + console.log(err); + }); +} + +window.doHaptic = (style) => { + if (!IOS || !IOS.Haptics?.Impact) { + console.warn('IOS runtime not available in @wailsio/runtime. Skipping haptic call.'); + return; + } + IOS.Haptics.Impact(style).catch((err) => { + console.error('Haptics error:', err); + }); +} + +window.getDeviceInfo = async () => { + if (!IOS || !IOS.Device?.Info) { + deviceInfoElement.innerText = 'iOS runtime not available; cannot fetch device info.'; + return; + } + try { + const info = await IOS.Device.Info(); + deviceInfoElement.innerText = JSON.stringify(info, null, 2); + } catch (e) { + deviceInfoElement.innerText = `Error: ${e?.message || e}`; + } +} + +// Generic caller for IOS..(args) +window.iosJsSet = async (methodPath, args) => { + if (!IOS) { + console.warn('IOS runtime not available in @wailsio/runtime.'); + return; + } + try { + const [group, method] = methodPath.split('.'); + const target = IOS?.[group]; + const fn = target?.[method]; + if (typeof fn !== 'function') { + console.warn('IOS method not found:', methodPath); + return; + } + await fn(args); + } catch (e) { + console.error('iosJsSet error for', methodPath, e); + } +} + +// Emit events for Go handlers +window.emitGo = (eventName, data) => { + try { + Events.Emit(eventName, data); + } catch (e) { + console.error('emitGo error:', e); + } +} + +// Toggle helpers for UI switches +window.setGoToggle = (eventName, enabled) => { + emitGo(eventName, { enabled: !!enabled }); +} + +window.setJsToggle = (methodPath, enabled) => { + iosJsSet(methodPath, { enabled: !!enabled }); +} + +Events.On('time', (payload) => { + // payload may be a plain value or an object with a `data` field depending on emitter/runtime + const value = (payload && typeof payload === 'object' && 'data' in payload) ? payload.data : payload; + console.log('[frontend] time event:', payload, '->', value); + timeElement.innerText = value; +}); + +// Simple pane switcher responding to native UITabBar +function showPaneByIndex(index) { + const panes = [ + document.getElementById('screen-bindings'), + document.getElementById('screen-go'), + document.getElementById('screen-js'), + ]; + panes.forEach((el, i) => { + if (!el) return; + if (i === index) el.classList.add('active'); + else el.classList.remove('active'); + }); +} + +// Listen for native tab selection events posted by the iOS layer +window.addEventListener('nativeTabSelected', (e) => { + const idx = (e && e.detail && typeof e.detail.index === 'number') ? e.detail.index : 0; + showPaneByIndex(idx); +}); + +// Ensure default pane is visible on load (index 0) +window.addEventListener('DOMContentLoaded', () => { + showPaneByIndex(0); +}); diff --git a/v3/examples/ios/frontend/package-lock.json b/v3/examples/ios/frontend/package-lock.json new file mode 100644 index 000000000..b0b7dc68f --- /dev/null +++ b/v3/examples/ios/frontend/package-lock.json @@ -0,0 +1,936 @@ +{ + "name": "frontend", + "version": "0.0.0", + "lockfileVersion": 3, + "requires": true, + "packages": { + "": { + "name": "frontend", + "version": "0.0.0", + "dependencies": { + "@wailsio/runtime": "latest" + }, + "devDependencies": { + "vite": "^5.0.0" + } + }, + "node_modules/@esbuild/aix-ppc64": { + "version": "0.21.5", + "resolved": "https://registry.npmjs.org/@esbuild/aix-ppc64/-/aix-ppc64-0.21.5.tgz", + "integrity": "sha512-1SDgH6ZSPTlggy1yI6+Dbkiz8xzpHJEVAlF/AM1tHPLsf5STom9rwtjE4hKAF20FfXXNTFqEYXyJNWh1GiZedQ==", + "cpu": [ + "ppc64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "aix" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/@esbuild/android-arm": { + "version": "0.21.5", + "resolved": "https://registry.npmjs.org/@esbuild/android-arm/-/android-arm-0.21.5.tgz", + "integrity": "sha512-vCPvzSjpPHEi1siZdlvAlsPxXl7WbOVUBBAowWug4rJHb68Ox8KualB+1ocNvT5fjv6wpkX6o/iEpbDrf68zcg==", + "cpu": [ + "arm" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "android" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/@esbuild/android-arm64": { + "version": "0.21.5", + "resolved": "https://registry.npmjs.org/@esbuild/android-arm64/-/android-arm64-0.21.5.tgz", + "integrity": "sha512-c0uX9VAUBQ7dTDCjq+wdyGLowMdtR/GoC2U5IYk/7D1H1JYC0qseD7+11iMP2mRLN9RcCMRcjC4YMclCzGwS/A==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "android" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/@esbuild/android-x64": { + "version": "0.21.5", + "resolved": "https://registry.npmjs.org/@esbuild/android-x64/-/android-x64-0.21.5.tgz", + "integrity": "sha512-D7aPRUUNHRBwHxzxRvp856rjUHRFW1SdQATKXH2hqA0kAZb1hKmi02OpYRacl0TxIGz/ZmXWlbZgjwWYaCakTA==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "android" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/@esbuild/darwin-arm64": { + "version": "0.21.5", + "resolved": "https://registry.npmjs.org/@esbuild/darwin-arm64/-/darwin-arm64-0.21.5.tgz", + "integrity": "sha512-DwqXqZyuk5AiWWf3UfLiRDJ5EDd49zg6O9wclZ7kUMv2WRFr4HKjXp/5t8JZ11QbQfUS6/cRCKGwYhtNAY88kQ==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "darwin" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/@esbuild/darwin-x64": { + "version": "0.21.5", + "resolved": "https://registry.npmjs.org/@esbuild/darwin-x64/-/darwin-x64-0.21.5.tgz", + "integrity": "sha512-se/JjF8NlmKVG4kNIuyWMV/22ZaerB+qaSi5MdrXtd6R08kvs2qCN4C09miupktDitvh8jRFflwGFBQcxZRjbw==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "darwin" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/@esbuild/freebsd-arm64": { + "version": "0.21.5", + "resolved": "https://registry.npmjs.org/@esbuild/freebsd-arm64/-/freebsd-arm64-0.21.5.tgz", + "integrity": "sha512-5JcRxxRDUJLX8JXp/wcBCy3pENnCgBR9bN6JsY4OmhfUtIHe3ZW0mawA7+RDAcMLrMIZaf03NlQiX9DGyB8h4g==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "freebsd" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/@esbuild/freebsd-x64": { + "version": "0.21.5", + "resolved": "https://registry.npmjs.org/@esbuild/freebsd-x64/-/freebsd-x64-0.21.5.tgz", + "integrity": "sha512-J95kNBj1zkbMXtHVH29bBriQygMXqoVQOQYA+ISs0/2l3T9/kj42ow2mpqerRBxDJnmkUDCaQT/dfNXWX/ZZCQ==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "freebsd" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/@esbuild/linux-arm": { + "version": "0.21.5", + "resolved": "https://registry.npmjs.org/@esbuild/linux-arm/-/linux-arm-0.21.5.tgz", + "integrity": "sha512-bPb5AHZtbeNGjCKVZ9UGqGwo8EUu4cLq68E95A53KlxAPRmUyYv2D6F0uUI65XisGOL1hBP5mTronbgo+0bFcA==", + "cpu": [ + "arm" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/@esbuild/linux-arm64": { + "version": "0.21.5", + "resolved": "https://registry.npmjs.org/@esbuild/linux-arm64/-/linux-arm64-0.21.5.tgz", + "integrity": "sha512-ibKvmyYzKsBeX8d8I7MH/TMfWDXBF3db4qM6sy+7re0YXya+K1cem3on9XgdT2EQGMu4hQyZhan7TeQ8XkGp4Q==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/@esbuild/linux-ia32": { + "version": "0.21.5", + "resolved": "https://registry.npmjs.org/@esbuild/linux-ia32/-/linux-ia32-0.21.5.tgz", + "integrity": "sha512-YvjXDqLRqPDl2dvRODYmmhz4rPeVKYvppfGYKSNGdyZkA01046pLWyRKKI3ax8fbJoK5QbxblURkwK/MWY18Tg==", + "cpu": [ + "ia32" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/@esbuild/linux-loong64": { + "version": "0.21.5", + "resolved": "https://registry.npmjs.org/@esbuild/linux-loong64/-/linux-loong64-0.21.5.tgz", + "integrity": "sha512-uHf1BmMG8qEvzdrzAqg2SIG/02+4/DHB6a9Kbya0XDvwDEKCoC8ZRWI5JJvNdUjtciBGFQ5PuBlpEOXQj+JQSg==", + "cpu": [ + "loong64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/@esbuild/linux-mips64el": { + "version": "0.21.5", + "resolved": "https://registry.npmjs.org/@esbuild/linux-mips64el/-/linux-mips64el-0.21.5.tgz", + "integrity": "sha512-IajOmO+KJK23bj52dFSNCMsz1QP1DqM6cwLUv3W1QwyxkyIWecfafnI555fvSGqEKwjMXVLokcV5ygHW5b3Jbg==", + "cpu": [ + "mips64el" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/@esbuild/linux-ppc64": { + "version": "0.21.5", + "resolved": "https://registry.npmjs.org/@esbuild/linux-ppc64/-/linux-ppc64-0.21.5.tgz", + "integrity": "sha512-1hHV/Z4OEfMwpLO8rp7CvlhBDnjsC3CttJXIhBi+5Aj5r+MBvy4egg7wCbe//hSsT+RvDAG7s81tAvpL2XAE4w==", + "cpu": [ + "ppc64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/@esbuild/linux-riscv64": { + "version": "0.21.5", + "resolved": "https://registry.npmjs.org/@esbuild/linux-riscv64/-/linux-riscv64-0.21.5.tgz", + "integrity": "sha512-2HdXDMd9GMgTGrPWnJzP2ALSokE/0O5HhTUvWIbD3YdjME8JwvSCnNGBnTThKGEB91OZhzrJ4qIIxk/SBmyDDA==", + "cpu": [ + "riscv64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/@esbuild/linux-s390x": { + "version": "0.21.5", + "resolved": "https://registry.npmjs.org/@esbuild/linux-s390x/-/linux-s390x-0.21.5.tgz", + "integrity": "sha512-zus5sxzqBJD3eXxwvjN1yQkRepANgxE9lgOW2qLnmr8ikMTphkjgXu1HR01K4FJg8h1kEEDAqDcZQtbrRnB41A==", + "cpu": [ + "s390x" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/@esbuild/linux-x64": { + "version": "0.21.5", + "resolved": "https://registry.npmjs.org/@esbuild/linux-x64/-/linux-x64-0.21.5.tgz", + "integrity": "sha512-1rYdTpyv03iycF1+BhzrzQJCdOuAOtaqHTWJZCWvijKD2N5Xu0TtVC8/+1faWqcP9iBCWOmjmhoH94dH82BxPQ==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/@esbuild/netbsd-x64": { + "version": "0.21.5", + "resolved": "https://registry.npmjs.org/@esbuild/netbsd-x64/-/netbsd-x64-0.21.5.tgz", + "integrity": "sha512-Woi2MXzXjMULccIwMnLciyZH4nCIMpWQAs049KEeMvOcNADVxo0UBIQPfSmxB3CWKedngg7sWZdLvLczpe0tLg==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "netbsd" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/@esbuild/openbsd-x64": { + "version": "0.21.5", + "resolved": "https://registry.npmjs.org/@esbuild/openbsd-x64/-/openbsd-x64-0.21.5.tgz", + "integrity": "sha512-HLNNw99xsvx12lFBUwoT8EVCsSvRNDVxNpjZ7bPn947b8gJPzeHWyNVhFsaerc0n3TsbOINvRP2byTZ5LKezow==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "openbsd" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/@esbuild/sunos-x64": { + "version": "0.21.5", + "resolved": "https://registry.npmjs.org/@esbuild/sunos-x64/-/sunos-x64-0.21.5.tgz", + "integrity": "sha512-6+gjmFpfy0BHU5Tpptkuh8+uw3mnrvgs+dSPQXQOv3ekbordwnzTVEb4qnIvQcYXq6gzkyTnoZ9dZG+D4garKg==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "sunos" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/@esbuild/win32-arm64": { + "version": "0.21.5", + "resolved": "https://registry.npmjs.org/@esbuild/win32-arm64/-/win32-arm64-0.21.5.tgz", + "integrity": "sha512-Z0gOTd75VvXqyq7nsl93zwahcTROgqvuAcYDUr+vOv8uHhNSKROyU961kgtCD1e95IqPKSQKH7tBTslnS3tA8A==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "win32" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/@esbuild/win32-ia32": { + "version": "0.21.5", + "resolved": "https://registry.npmjs.org/@esbuild/win32-ia32/-/win32-ia32-0.21.5.tgz", + "integrity": "sha512-SWXFF1CL2RVNMaVs+BBClwtfZSvDgtL//G/smwAc5oVK/UPu2Gu9tIaRgFmYFFKrmg3SyAjSrElf0TiJ1v8fYA==", + "cpu": [ + "ia32" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "win32" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/@esbuild/win32-x64": { + "version": "0.21.5", + "resolved": "https://registry.npmjs.org/@esbuild/win32-x64/-/win32-x64-0.21.5.tgz", + "integrity": "sha512-tQd/1efJuzPC6rCFwEvLtci/xNFcTZknmXs98FYDfGE4wP9ClFV98nyKrzJKVPMhdDnjzLhdUyMX4PsQAPjwIw==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "win32" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/@rollup/rollup-android-arm-eabi": { + "version": "4.50.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-android-arm-eabi/-/rollup-android-arm-eabi-4.50.0.tgz", + "integrity": "sha512-lVgpeQyy4fWN5QYebtW4buT/4kn4p4IJ+kDNB4uYNT5b8c8DLJDg6titg20NIg7E8RWwdWZORW6vUFfrLyG3KQ==", + "cpu": [ + "arm" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "android" + ] + }, + "node_modules/@rollup/rollup-android-arm64": { + "version": "4.50.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-android-arm64/-/rollup-android-arm64-4.50.0.tgz", + "integrity": "sha512-2O73dR4Dc9bp+wSYhviP6sDziurB5/HCym7xILKifWdE9UsOe2FtNcM+I4xZjKrfLJnq5UR8k9riB87gauiQtw==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "android" + ] + }, + "node_modules/@rollup/rollup-darwin-arm64": { + "version": "4.50.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-darwin-arm64/-/rollup-darwin-arm64-4.50.0.tgz", + "integrity": "sha512-vwSXQN8T4sKf1RHr1F0s98Pf8UPz7pS6P3LG9NSmuw0TVh7EmaE+5Ny7hJOZ0M2yuTctEsHHRTMi2wuHkdS6Hg==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "darwin" + ] + }, + "node_modules/@rollup/rollup-darwin-x64": { + "version": "4.50.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-darwin-x64/-/rollup-darwin-x64-4.50.0.tgz", + "integrity": "sha512-cQp/WG8HE7BCGyFVuzUg0FNmupxC+EPZEwWu2FCGGw5WDT1o2/YlENbm5e9SMvfDFR6FRhVCBePLqj0o8MN7Vw==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "darwin" + ] + }, + "node_modules/@rollup/rollup-freebsd-arm64": { + "version": "4.50.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-freebsd-arm64/-/rollup-freebsd-arm64-4.50.0.tgz", + "integrity": "sha512-UR1uTJFU/p801DvvBbtDD7z9mQL8J80xB0bR7DqW7UGQHRm/OaKzp4is7sQSdbt2pjjSS72eAtRh43hNduTnnQ==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "freebsd" + ] + }, + "node_modules/@rollup/rollup-freebsd-x64": { + "version": "4.50.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-freebsd-x64/-/rollup-freebsd-x64-4.50.0.tgz", + "integrity": "sha512-G/DKyS6PK0dD0+VEzH/6n/hWDNPDZSMBmqsElWnCRGrYOb2jC0VSupp7UAHHQ4+QILwkxSMaYIbQ72dktp8pKA==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "freebsd" + ] + }, + "node_modules/@rollup/rollup-linux-arm-gnueabihf": { + "version": "4.50.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm-gnueabihf/-/rollup-linux-arm-gnueabihf-4.50.0.tgz", + "integrity": "sha512-u72Mzc6jyJwKjJbZZcIYmd9bumJu7KNmHYdue43vT1rXPm2rITwmPWF0mmPzLm9/vJWxIRbao/jrQmxTO0Sm9w==", + "cpu": [ + "arm" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-arm-musleabihf": { + "version": "4.50.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm-musleabihf/-/rollup-linux-arm-musleabihf-4.50.0.tgz", + "integrity": "sha512-S4UefYdV0tnynDJV1mdkNawp0E5Qm2MtSs330IyHgaccOFrwqsvgigUD29uT+B/70PDY1eQ3t40+xf6wIvXJyg==", + "cpu": [ + "arm" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-arm64-gnu": { + "version": "4.50.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm64-gnu/-/rollup-linux-arm64-gnu-4.50.0.tgz", + "integrity": "sha512-1EhkSvUQXJsIhk4msxP5nNAUWoB4MFDHhtc4gAYvnqoHlaL9V3F37pNHabndawsfy/Tp7BPiy/aSa6XBYbaD1g==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-arm64-musl": { + "version": "4.50.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm64-musl/-/rollup-linux-arm64-musl-4.50.0.tgz", + "integrity": "sha512-EtBDIZuDtVg75xIPIK1l5vCXNNCIRM0OBPUG+tbApDuJAy9mKago6QxX+tfMzbCI6tXEhMuZuN1+CU8iDW+0UQ==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-loongarch64-gnu": { + "version": "4.50.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-loongarch64-gnu/-/rollup-linux-loongarch64-gnu-4.50.0.tgz", + "integrity": "sha512-BGYSwJdMP0hT5CCmljuSNx7+k+0upweM2M4YGfFBjnFSZMHOLYR0gEEj/dxyYJ6Zc6AiSeaBY8dWOa11GF/ppQ==", + "cpu": [ + "loong64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-ppc64-gnu": { + "version": "4.50.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-ppc64-gnu/-/rollup-linux-ppc64-gnu-4.50.0.tgz", + "integrity": "sha512-I1gSMzkVe1KzAxKAroCJL30hA4DqSi+wGc5gviD0y3IL/VkvcnAqwBf4RHXHyvH66YVHxpKO8ojrgc4SrWAnLg==", + "cpu": [ + "ppc64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-riscv64-gnu": { + "version": "4.50.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-riscv64-gnu/-/rollup-linux-riscv64-gnu-4.50.0.tgz", + "integrity": "sha512-bSbWlY3jZo7molh4tc5dKfeSxkqnf48UsLqYbUhnkdnfgZjgufLS/NTA8PcP/dnvct5CCdNkABJ56CbclMRYCA==", + "cpu": [ + "riscv64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-riscv64-musl": { + "version": "4.50.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-riscv64-musl/-/rollup-linux-riscv64-musl-4.50.0.tgz", + "integrity": "sha512-LSXSGumSURzEQLT2e4sFqFOv3LWZsEF8FK7AAv9zHZNDdMnUPYH3t8ZlaeYYZyTXnsob3htwTKeWtBIkPV27iQ==", + "cpu": [ + "riscv64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-s390x-gnu": { + "version": "4.50.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-s390x-gnu/-/rollup-linux-s390x-gnu-4.50.0.tgz", + "integrity": "sha512-CxRKyakfDrsLXiCyucVfVWVoaPA4oFSpPpDwlMcDFQvrv3XY6KEzMtMZrA+e/goC8xxp2WSOxHQubP8fPmmjOQ==", + "cpu": [ + "s390x" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-x64-gnu": { + "version": "4.50.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-x64-gnu/-/rollup-linux-x64-gnu-4.50.0.tgz", + "integrity": "sha512-8PrJJA7/VU8ToHVEPu14FzuSAqVKyo5gg/J8xUerMbyNkWkO9j2ExBho/68RnJsMGNJq4zH114iAttgm7BZVkA==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-x64-musl": { + "version": "4.50.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-x64-musl/-/rollup-linux-x64-musl-4.50.0.tgz", + "integrity": "sha512-SkE6YQp+CzpyOrbw7Oc4MgXFvTw2UIBElvAvLCo230pyxOLmYwRPwZ/L5lBe/VW/qT1ZgND9wJfOsdy0XptRvw==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-openharmony-arm64": { + "version": "4.50.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-openharmony-arm64/-/rollup-openharmony-arm64-4.50.0.tgz", + "integrity": "sha512-PZkNLPfvXeIOgJWA804zjSFH7fARBBCpCXxgkGDRjjAhRLOR8o0IGS01ykh5GYfod4c2yiiREuDM8iZ+pVsT+Q==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "openharmony" + ] + }, + "node_modules/@rollup/rollup-win32-arm64-msvc": { + "version": "4.50.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-win32-arm64-msvc/-/rollup-win32-arm64-msvc-4.50.0.tgz", + "integrity": "sha512-q7cIIdFvWQoaCbLDUyUc8YfR3Jh2xx3unO8Dn6/TTogKjfwrax9SyfmGGK6cQhKtjePI7jRfd7iRYcxYs93esg==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "win32" + ] + }, + "node_modules/@rollup/rollup-win32-ia32-msvc": { + "version": "4.50.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-win32-ia32-msvc/-/rollup-win32-ia32-msvc-4.50.0.tgz", + "integrity": "sha512-XzNOVg/YnDOmFdDKcxxK410PrcbcqZkBmz+0FicpW5jtjKQxcW1BZJEQOF0NJa6JO7CZhett8GEtRN/wYLYJuw==", + "cpu": [ + "ia32" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "win32" + ] + }, + "node_modules/@rollup/rollup-win32-x64-msvc": { + "version": "4.50.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-win32-x64-msvc/-/rollup-win32-x64-msvc-4.50.0.tgz", + "integrity": "sha512-xMmiWRR8sp72Zqwjgtf3QbZfF1wdh8X2ABu3EaozvZcyHJeU0r+XAnXdKgs4cCAp6ORoYoCygipYP1mjmbjrsg==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "win32" + ] + }, + "node_modules/@types/estree": { + "version": "1.0.8", + "resolved": "https://registry.npmjs.org/@types/estree/-/estree-1.0.8.tgz", + "integrity": "sha512-dWHzHa2WqEXI/O1E9OjrocMTKJl2mSrEolh1Iomrv6U+JuNwaHXsXx9bLu5gG7BUWFIN0skIQJQ/L1rIex4X6w==", + "dev": true, + "license": "MIT" + }, + "node_modules/@wailsio/runtime": { + "version": "3.0.0-alpha.66", + "resolved": "https://registry.npmjs.org/@wailsio/runtime/-/runtime-3.0.0-alpha.66.tgz", + "integrity": "sha512-ENLu8rn1griL1gFHJqkq1i+BVxrrA0JPJHYneUJYuf/s54kjuQViW0RKDEe/WTDo56ABpfykrd/T8OYpPUyXUw==", + "license": "MIT" + }, + "node_modules/esbuild": { + "version": "0.21.5", + "resolved": "https://registry.npmjs.org/esbuild/-/esbuild-0.21.5.tgz", + "integrity": "sha512-mg3OPMV4hXywwpoDxu3Qda5xCKQi+vCTZq8S9J/EpkhB2HzKXq4SNFZE3+NK93JYxc8VMSep+lOUSC/RVKaBqw==", + "dev": true, + "hasInstallScript": true, + "license": "MIT", + "bin": { + "esbuild": "bin/esbuild" + }, + "engines": { + "node": ">=12" + }, + "optionalDependencies": { + "@esbuild/aix-ppc64": "0.21.5", + "@esbuild/android-arm": "0.21.5", + "@esbuild/android-arm64": "0.21.5", + "@esbuild/android-x64": "0.21.5", + "@esbuild/darwin-arm64": "0.21.5", + "@esbuild/darwin-x64": "0.21.5", + "@esbuild/freebsd-arm64": "0.21.5", + "@esbuild/freebsd-x64": "0.21.5", + "@esbuild/linux-arm": "0.21.5", + "@esbuild/linux-arm64": "0.21.5", + "@esbuild/linux-ia32": "0.21.5", + "@esbuild/linux-loong64": "0.21.5", + "@esbuild/linux-mips64el": "0.21.5", + "@esbuild/linux-ppc64": "0.21.5", + "@esbuild/linux-riscv64": "0.21.5", + "@esbuild/linux-s390x": "0.21.5", + "@esbuild/linux-x64": "0.21.5", + "@esbuild/netbsd-x64": "0.21.5", + "@esbuild/openbsd-x64": "0.21.5", + "@esbuild/sunos-x64": "0.21.5", + "@esbuild/win32-arm64": "0.21.5", + "@esbuild/win32-ia32": "0.21.5", + "@esbuild/win32-x64": "0.21.5" + } + }, + "node_modules/fsevents": { + "version": "2.3.3", + "resolved": "https://registry.npmjs.org/fsevents/-/fsevents-2.3.3.tgz", + "integrity": "sha512-5xoDfX+fL7faATnagmWPpbFtwh/R77WmMMqqHGS65C3vvB0YHrgF+B1YmZ3441tMj5n63k0212XNoJwzlhffQw==", + "dev": true, + "hasInstallScript": true, + "license": "MIT", + "optional": true, + "os": [ + "darwin" + ], + "engines": { + "node": "^8.16.0 || ^10.6.0 || >=11.0.0" + } + }, + "node_modules/nanoid": { + "version": "3.3.11", + "resolved": "https://registry.npmjs.org/nanoid/-/nanoid-3.3.11.tgz", + "integrity": "sha512-N8SpfPUnUp1bK+PMYW8qSWdl9U+wwNWI4QKxOYDy9JAro3WMX7p2OeVRF9v+347pnakNevPmiHhNmZ2HbFA76w==", + "dev": true, + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/ai" + } + ], + "license": "MIT", + "bin": { + "nanoid": "bin/nanoid.cjs" + }, + "engines": { + "node": "^10 || ^12 || ^13.7 || ^14 || >=15.0.1" + } + }, + "node_modules/picocolors": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/picocolors/-/picocolors-1.1.1.tgz", + "integrity": "sha512-xceH2snhtb5M9liqDsmEw56le376mTZkEX/jEb/RxNFyegNul7eNslCXP9FDj/Lcu0X8KEyMceP2ntpaHrDEVA==", + "dev": true, + "license": "ISC" + }, + "node_modules/postcss": { + "version": "8.5.6", + "resolved": "https://registry.npmjs.org/postcss/-/postcss-8.5.6.tgz", + "integrity": "sha512-3Ybi1tAuwAP9s0r1UQ2J4n5Y0G05bJkpUIO0/bI9MhwmD70S5aTWbXGBwxHrelT+XM1k6dM0pk+SwNkpTRN7Pg==", + "dev": true, + "funding": [ + { + "type": "opencollective", + "url": "https://opencollective.com/postcss/" + }, + { + "type": "tidelift", + "url": "https://tidelift.com/funding/github/npm/postcss" + }, + { + "type": "github", + "url": "https://github.com/sponsors/ai" + } + ], + "license": "MIT", + "dependencies": { + "nanoid": "^3.3.11", + "picocolors": "^1.1.1", + "source-map-js": "^1.2.1" + }, + "engines": { + "node": "^10 || ^12 || >=14" + } + }, + "node_modules/rollup": { + "version": "4.50.0", + "resolved": "https://registry.npmjs.org/rollup/-/rollup-4.50.0.tgz", + "integrity": "sha512-/Zl4D8zPifNmyGzJS+3kVoyXeDeT/GrsJM94sACNg9RtUE0hrHa1bNPtRSrfHTMH5HjRzce6K7rlTh3Khiw+pw==", + "dev": true, + "license": "MIT", + "dependencies": { + "@types/estree": "1.0.8" + }, + "bin": { + "rollup": "dist/bin/rollup" + }, + "engines": { + "node": ">=18.0.0", + "npm": ">=8.0.0" + }, + "optionalDependencies": { + "@rollup/rollup-android-arm-eabi": "4.50.0", + "@rollup/rollup-android-arm64": "4.50.0", + "@rollup/rollup-darwin-arm64": "4.50.0", + "@rollup/rollup-darwin-x64": "4.50.0", + "@rollup/rollup-freebsd-arm64": "4.50.0", + "@rollup/rollup-freebsd-x64": "4.50.0", + "@rollup/rollup-linux-arm-gnueabihf": "4.50.0", + "@rollup/rollup-linux-arm-musleabihf": "4.50.0", + "@rollup/rollup-linux-arm64-gnu": "4.50.0", + "@rollup/rollup-linux-arm64-musl": "4.50.0", + "@rollup/rollup-linux-loongarch64-gnu": "4.50.0", + "@rollup/rollup-linux-ppc64-gnu": "4.50.0", + "@rollup/rollup-linux-riscv64-gnu": "4.50.0", + "@rollup/rollup-linux-riscv64-musl": "4.50.0", + "@rollup/rollup-linux-s390x-gnu": "4.50.0", + "@rollup/rollup-linux-x64-gnu": "4.50.0", + "@rollup/rollup-linux-x64-musl": "4.50.0", + "@rollup/rollup-openharmony-arm64": "4.50.0", + "@rollup/rollup-win32-arm64-msvc": "4.50.0", + "@rollup/rollup-win32-ia32-msvc": "4.50.0", + "@rollup/rollup-win32-x64-msvc": "4.50.0", + "fsevents": "~2.3.2" + } + }, + "node_modules/source-map-js": { + "version": "1.2.1", + "resolved": "https://registry.npmjs.org/source-map-js/-/source-map-js-1.2.1.tgz", + "integrity": "sha512-UXWMKhLOwVKb728IUtQPXxfYU+usdybtUrK/8uGE8CQMvrhOpwvzDBwj0QhSL7MQc7vIsISBG8VQ8+IDQxpfQA==", + "dev": true, + "license": "BSD-3-Clause", + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/vite": { + "version": "5.4.19", + "resolved": "https://registry.npmjs.org/vite/-/vite-5.4.19.tgz", + "integrity": "sha512-qO3aKv3HoQC8QKiNSTuUM1l9o/XX3+c+VTgLHbJWHZGeTPVAg2XwazI9UWzoxjIJCGCV2zU60uqMzjeLZuULqA==", + "dev": true, + "license": "MIT", + "dependencies": { + "esbuild": "^0.21.3", + "postcss": "^8.4.43", + "rollup": "^4.20.0" + }, + "bin": { + "vite": "bin/vite.js" + }, + "engines": { + "node": "^18.0.0 || >=20.0.0" + }, + "funding": { + "url": "https://github.com/vitejs/vite?sponsor=1" + }, + "optionalDependencies": { + "fsevents": "~2.3.3" + }, + "peerDependencies": { + "@types/node": "^18.0.0 || >=20.0.0", + "less": "*", + "lightningcss": "^1.21.0", + "sass": "*", + "sass-embedded": "*", + "stylus": "*", + "sugarss": "*", + "terser": "^5.4.0" + }, + "peerDependenciesMeta": { + "@types/node": { + "optional": true + }, + "less": { + "optional": true + }, + "lightningcss": { + "optional": true + }, + "sass": { + "optional": true + }, + "sass-embedded": { + "optional": true + }, + "stylus": { + "optional": true + }, + "sugarss": { + "optional": true + }, + "terser": { + "optional": true + } + } + } + } +} diff --git a/v3/examples/ios/frontend/package.json b/v3/examples/ios/frontend/package.json new file mode 100644 index 000000000..0a118e984 --- /dev/null +++ b/v3/examples/ios/frontend/package.json @@ -0,0 +1,18 @@ +{ + "name": "frontend", + "private": true, + "version": "0.0.0", + "type": "module", + "scripts": { + "dev": "vite", + "build:dev": "vite build --minify false --mode development", + "build": "vite build --mode production", + "preview": "vite preview" + }, + "dependencies": { + "@wailsio/runtime": "latest" + }, + "devDependencies": { + "vite": "^5.0.0" + } +} diff --git a/v3/examples/ios/frontend/public/Inter-Medium.ttf b/v3/examples/ios/frontend/public/Inter-Medium.ttf new file mode 100644 index 000000000..a01f3777a Binary files /dev/null and b/v3/examples/ios/frontend/public/Inter-Medium.ttf differ diff --git a/v3/examples/ios/frontend/public/javascript.svg b/v3/examples/ios/frontend/public/javascript.svg new file mode 100644 index 000000000..f9abb2b72 --- /dev/null +++ b/v3/examples/ios/frontend/public/javascript.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/v3/examples/ios/frontend/public/puppertino/LICENSE b/v3/examples/ios/frontend/public/puppertino/LICENSE new file mode 100644 index 000000000..ed9065e06 --- /dev/null +++ b/v3/examples/ios/frontend/public/puppertino/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2019 Edgar Pérez + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/v3/examples/ios/frontend/public/puppertino/css/actions.css b/v3/examples/ios/frontend/public/puppertino/css/actions.css new file mode 100644 index 000000000..22a9d5a13 --- /dev/null +++ b/v3/examples/ios/frontend/public/puppertino/css/actions.css @@ -0,0 +1,149 @@ +:root { + --font: -apple-system, "Inter", sans-serif; + --primary-col-ac: #0f75f5; + --p-modal-bg: rgba(255, 255, 255, 0.8); + --p-modal-bd-color: rgba(0,0,0,.1); + --p-modal-fallback-color: rgba(255,255,255,.95); + --p-actions-static-color: #555761; +} + +.p-modal-opened { + overflow: hidden; +} + +.p-action-background{ + background: rgba(0, 0, 0, 0.7); + height: 100vh; + left: 0; + opacity: 0; + pointer-events: none; + position: fixed; + top: 0; + transition: 0.3s; + width: 100vw; + z-index: 5; +} + +.p-action-background.nowactive { + opacity: 1; + pointer-events: auto; +} + + +.p-action-big-container{ + position:fixed; + width: 100%; + box-sizing: border-box; + padding: 1rem 5vw; + bottom:0; +} + +.p-action-container{ + background: var(--p-modal-bg); + display:block; + margin:auto; + margin-bottom: 10px; + border-radius: 10px; + max-width: 700px; +} + +.p-action-big-container .p-action-container:first-child{ + margin-bottom:10px; +} + +.p-action--intern{ + width: 100%; + display:block; + margin:auto; + font-size: 1rem; + font-weight: 600; + text-align:center; + padding: 15px 0; + border: 0; + border-bottom: 1px solid #bfbfbf; + color: #0f75f5; + text-decoration:none; + background-color: transparent; +} + +.p-action-destructive{ + color: #c6262e; +} + +.p-action-neutral{ + color: var(--p-actions-static-color); +} + +.p-action-cancel, .p-action-container a:last-child{ + border-bottom:none; +} + +.p-action-cancel{ + font-weight:bold; +} + +.p-action-icon{ + position:relative; +} +.p-action-icon svg, .p-action-icon img{ + position:absolute; + left:5%; + top:50%; + transform:translateY(-50%); +} + +.p-action-icon-inline{ + text-align: left; + display: flex; + align-items: center; +} + +.p-action-icon-inline svg, .p-action-icon-inline img{ + margin-left: 5%; + margin-right: 3%; +} + +.p-action-title{ + padding: 30px 15px; + border-bottom: 1px solid #bfbfbf; +} + +.p-action-title--intern,.p-action-text{ + margin:0; + color:var(--p-actions-static-color); +} + +.p-action-title--intern{ + margin-bottom: .3rem; +} + +@supports not (backdrop-filter: blur(10px)) { + .p-action-container { + background: var(--p-modal-fallback-color); + } +} + +.p-action-big-container{ + -webkit-transform: translateY(30%); + transform: translateY(30%); + opacity: 0; + transition: opacity 0.4s, transform 0.4s; + transition-timing-function: ease; + pointer-events: none; +} + +.p-action-big-container.active { + -webkit-transform: translateY(0); + transform: translateY(0); + opacity: 1; + pointer-events: all; +} + + +.p-action-big-container.active .p-action-container { + backdrop-filter: saturate(180%) blur(10px); +} + +.p-action-big-container[aria-hidden="true"] .p-action--intern { + display: none; +} diff --git a/v3/examples/ios/frontend/public/puppertino/css/buttons.css b/v3/examples/ios/frontend/public/puppertino/css/buttons.css new file mode 100644 index 000000000..4950b0053 --- /dev/null +++ b/v3/examples/ios/frontend/public/puppertino/css/buttons.css @@ -0,0 +1,158 @@ +@charset "UTF-8"; +:root{ + --p-btn-border: #cacaca; + --p-btn-def-bg: #FFFFFF; + --p-btn-def-col: #000000; + --p-btn-dir-col: #242424; + --p-prim-text-col: #f5f5f5; + --p-btn-scope-unactive: #212136; + --p-btn-scope-action: #212136; +} + +.p-btn { + background: var(--p-btn-def-bg); + border: 1px solid var(--p-btn-border); + border-radius: 10px; + color: var(--p-btn-def-col); + display: inline-block; + font-family: -apple-system, "Inter", sans-serif; + font-size: 1.1rem; + margin: .7rem; + padding: .4rem 1.2rem; + text-decoration: none; + text-align: center; + box-shadow: 0 1px 0.375px rgba(0, 0, 0, 0.05), 0 0.25px 0.375px rgba(0, 0, 0, 0.15); + user-select: none; + cursor: pointer; +} +.p-btn:focus{ + outline: 2px solid #64baff; +} +.p-btn.p-btn-block{ + display: block; +} +.p-btn.p-btn-sm { + padding: .3rem 1.1rem; + font-size: 1rem; +} +.p-btn.p-btn-md { + padding: .8rem 2.4rem; + font-size: 1.6rem; +} +.p-btn.p-btn-lg { + padding: 1.2rem 2.8rem; + font-size: 1.8rem; +} +.p-btn-destructive{ + color: #FF3B30; +} +.p-btn-mob{ + padding: 10px 40px; + background: #227bec; + color: #fff; + border: 0; + box-shadow: inset 0 1px 1px rgb(255 255 255 / 41%), 0px 2px 3px -2px rgba(0,0,0,.3); +} +.p-btn[disabled], +.p-btn:disabled, +.p-btn-disabled{ + filter:contrast(0.5) grayscale(.5) opacity(.8); + cursor: not-allowed; + box-shadow: none; + pointer-events: none; +} + +.p-prim-col { + position: relative; + background: #007AFF; + border: none; + box-shadow: inset 0 1px 1px rgba(255, 255, 255, 0.41), 0px 2px 3px -2px rgba(0, 0, 0, 0.3); + color: var(--p-prim-text-col); + overflow: hidden; /* Ensure the ::before element doesn't overflow */ +} + +.p-prim-col:before { + content: ''; + position: absolute; + top: 0; + left: 0; + width: 100%; + height: 100%; + background: linear-gradient(180deg, rgba(255, 255, 255, 1) 0%, rgba(255, 255, 255, 0) 100%); + opacity: 0.17; + pointer-events: none; +} + +.p-btn.p-prim-col:active { + background: #0f75f5; +} + +.p-btn-more::after { + content: "..."; +} + +.p-btn-round { + border: 0; + border-radius: 50px; + box-shadow: inset 0 1px 1px rgb(255 255 255 / 41%); + padding: 10px 30px; +} + +.p-btn-icon { + align-items: center; + background: var(--p-btn-def-bg); + border: 2px solid currentColor; + border-radius: 50%; + color: #0f75f5; + display: inline-flex; + font-weight: 900; + height: 40px; + width: 40px; + justify-content: center; + margin: 5px; + text-align: center; + text-decoration: none; + box-sizing: border-box; + user-select: none; + vertical-align: bottom; +} + +.p-btn-icon.p-btn-icon-no-border{ + border: 0px; +} + +.p-btn-scope { + background: #8e8e8e; + color: #fff; + margin: 5px; + padding: 2px 20px; + box-shadow: none; +} +.p-btn-scope-unactive { + background: transparent; + border-color: transparent; + color: var(--p-btn-scope-unactive); + transition: border-color 0.2s; +} +.p-btn-scope-unactive:hover { + border-color: var(--p-btn-border); +} + +.p-btn-scope-outline { + background: transparent; + color: var(--p-btn-scope-action); + box-shadow: none; +} + +.p-btn-outline { + background: none; + border-color: currentColor; + box-shadow: none; +} + +.p-btn-outline-dash { + background: none; + border-color: currentColor; + border-style: dashed; + box-shadow: none; +} diff --git a/v3/examples/ios/frontend/public/puppertino/css/cards.css b/v3/examples/ios/frontend/public/puppertino/css/cards.css new file mode 100644 index 000000000..b4fa2e397 --- /dev/null +++ b/v3/examples/ios/frontend/public/puppertino/css/cards.css @@ -0,0 +1,55 @@ +:root{ + --p-color-card: #1a1a1a; + --p-bg-card: #fff; + --p-bd-card: #c5c5c55e; +} +.p-card { + background: var(--p-bg-card); + border: 1px solid var(--p-bd-card); + color: var(--p-color-card); + display: block; + margin: 15px; + margin-left:7.5px; + margin-right:7.5px; + text-decoration: none; + border-radius: 25px; + padding: 20px 0px; + transition: .3s ease; + box-shadow: 0 0.5px 1px rgba(0, 0, 0, 0.1); +} +.p-card-image > img { + border-bottom: 3px solid var(--accent-article); + display: block; + margin: auto; + width: 100%; +} +.p-card-tags { + display: flex; + overflow: hidden; + position: relative; + width: 100%; +} +.p-card-tags::before { + background: linear-gradient(to right, rgba(255, 255, 255, 0) 0%, rgba(255, 255, 255, 0) 75%, white 100%); + content: ""; + height: 100%; + position: absolute; + right: 0; + top: 0; + width: 30%; +} +.p-card-title { + font-size: 2rem; + margin-bottom: 15px; + margin-top: 15px; +} +.p-card-content { + padding: 15px; + padding-top: 15px; +} +.p-card-text { + font-size: 17px; + margin-bottom: 10px; + margin-left: 10px; + margin-top: 0; +} diff --git a/v3/examples/ios/frontend/public/puppertino/css/color_palette.css b/v3/examples/ios/frontend/public/puppertino/css/color_palette.css new file mode 100644 index 000000000..33a66b91c --- /dev/null +++ b/v3/examples/ios/frontend/public/puppertino/css/color_palette.css @@ -0,0 +1,917 @@ +:root{ +--p-strawberry: #c6262e; +--p-strawberry-100: #ff8c82; +--p-strawberry-300: #ed5353; +--p-strawberry-500: #c6262e; +--p-strawberry-700: #a10705; +--p-strawberry-900: #7a0000; + +--p-orange: #f37329; +--p-orange-100: #ffc27d; +--p-orange-300: #ffa154; +--p-orange-500: #f37329; +--p-orange-700: #cc3b02; +--p-orange-900: #a62100; + + +--p-banana: #f9c440; +--p-banana-100: #fff394; +--p-banana-300: #ffe16b; +--p-banana-500: #f9c440; +--p-banana-700: #d48e15; +--p-banana-900: #ad5f00; + +--p-lime: #68b723; +--p-lime-100: #d1ff82; +--p-lime-300: #9bdb4d; +--p-lime-500: #68b723; +--p-lime-700: #3a9104; +--p-lime-900: #206b00; + +--p-mint: #28bca3; +--p-mint-100: #89ffdd; +--p-mint-300: #43d6b5; +--p-mint-500: #28bca3; +--p-mint-700: #0e9a83; +--p-mint-900: #007367; + + +--p-blueberry: #3689e6; +--p-blueberry-100: #8cd5ff; +--p-blueberry-300: #64baff; +--p-blueberry-500: #3689e6; +--p-blueberry-700: #0d52bf; +--p-blueberry-900: #002e99; + +--p-grape: #a56de2; +--p-grape-100: #e4c6fa; +--p-grape-300: #cd9ef7; +--p-grape-500: #a56de2; +--p-grape-700: #7239b3; +--p-grape-900: #452981; + +--p-bubblegum: #de3e80; +--p-bubblegum-100: #fe9ab8; +--p-bubblegum-300: #f4679d; +--p-bubblegum-500: #de3e80; +--p-bubblegum-700: #bc245d; +--p-bubblegum-900: #910e38; + + +--p-cocoa: #715344; +--p-cocoa-100: #a3907c; +--p-cocoa-300: #8a715e; +--p-cocoa-500: #715344; +--p-cocoa-700: #57392d; +--p-cocoa-900: #3d211b; + +--p-silver: #abacae; +--p-silver-100: #fafafa; +--p-silver-300: #d4d4d4; +--p-silver-500: #abacae; +--p-silver-700: #7e8087; +--p-silver-900: #555761; + +--p-slate: #485a6c; +--p-slate-100: #95a3ab; +--p-slate-300: #667885; +--p-slate-500: #485a6c; +--p-slate-700: #273445; +--p-slate-900: #0e141f; + + +--p-dark: #333; +--p-dark-100: #666; +--p-dark-300: #4d4d4d; +--p-dark-500: #333; +--p-dark-700: #1a1a1a; +--p-dark-900: #000; + + +--p-apple-red: rgb(255, 59 , 48); +--p-apple-red-dark: rgb(255, 69 , 58); +--p-apple-orange: rgb(255,149,0); +--p-apple-orange-dark: rgb(255,159,10); +--p-apple-yellow: rgb(255,204,0); +--p-apple-yellow-dark: rgb(255,214,10); +--p-apple-green: rgb(40,205,65); +--p-apple-green-dark: rgb(40,215,75); +--p-apple-mint: rgb(0,199,190); +--p-apple-mint-dark: rgb(102,212,207); +--p-apple-teal: rgb(89, 173, 196); +--p-apple-teal-dark: rgb(106, 196, 220); +--p-apple-cyan: rgb(85,190,240); +--p-apple-cyan-dark: rgb(90,200,245); +--p-apple-blue: rgb(0, 122, 255); +--p-apple-blue-dark: rgb(10, 132, 255); +--p-apple-indigo: rgb(88, 86, 214); +--p-apple-indigo-dark: rgb(94, 92, 230); +--p-apple-purple: rgb(175, 82, 222); +--p-apple-purple-dark: rgb(191, 90, 242); +--p-apple-pink: rgb(255, 45, 85); +--p-apple-pink-dark: rgb(255, 55, 95); +--p-apple-brown: rgb(162, 132, 94); +--p-apple-brown-dark: rgb(172, 142, 104); +--p-apple-gray: rgb(142, 142, 147); +--p-apple-gray-dark: rgb(152, 152, 157); + +} + + +/* +APPLE OFFICIAL COLORS +*/ + +.p-apple-red{ + background: rgb(255, 59 , 48); +} + +.p-apple-red-dark{ + background: rgb(255, 69 , 58); +} + +.p-apple-orange{ + background: rgb(255,149,0); +} + +.p-apple-orange-dark{ + background: rgb(255,159,10); +} + +.p-apple-yellow{ + background: rgb(255,204,0); +} + +.p-apple-yellow-dark{ + background: rgb(255,214,10); +} + +.p-apple-green{ + background: rgb(40,205,65); +} + +.p-apple-green-dark{ + background: rgb(40,215,75); +} + +.p-apple-mint{ + background: rgb(0,199,190); +} + +.p-apple-mint-dark{ + background: rgb(102,212,207); +} + +.p-apple-teal{ + background: rgb(89, 173, 196); +} + +.p-apple-teal-dark{ + background: rgb(106, 196, 220); +} + +.p-apple-cyan{ + background: rgb(85,190,240); +} + +.p-apple-cyan-dark{ + background: rgb(90,200,245); +} + +.p-apple-blue{ + background: rgb(0, 122, 255); +} + +.p-apple-blue-dark{ + background: rgb(10, 132, 255); +} + +.p-apple-indigo{ + background: rgb(88, 86, 214); +} + +.p-apple-indigo-dark{ + background: rgb(94, 92, 230); +} + +.p-apple-purple{ + background: rgb(175, 82, 222); +} + +.p-apple-purple-dark{ + background: rgb(191, 90, 242); +} + +.p-apple-pink{ + background: rgb(255, 45, 85); +} + +.p-apple-pink-dark{ + background: rgb(255, 55, 95); +} + +.p-apple-brown{ + background: rgb(162, 132, 94); +} + +.p-apple-brown-dark{ + background: rgb(172, 142, 104); +} + +.p-apple-gray{ + background: rgb(142, 142, 147); +} + +.p-apple-gray-dark{ + background: rgb(152, 152, 157); +} + +.p-apple-red-color{ + color: rgb(255, 59 , 48); +} + +.p-apple-red-dark-color{ + color: rgb(255, 69 , 58); +} + +.p-apple-orange-color{ + color: rgb(255,149,0); +} + +.p-apple-orange-dark-color{ + color: rgb(255,159,10); +} + +.p-apple-yellow-color{ + color: rgb(255,204,0); +} + +.p-apple-yellow-dark-color{ + color: rgb(255,214,10); +} + +.p-apple-green-color{ + color: rgb(40,205,65); +} + +.p-apple-green-dark-color{ + color: rgb(40,215,75); +} + +.p-apple-mint-color{ + color: rgb(0,199,190); +} + +.p-apple-mint-dark-color{ + color: rgb(102,212,207); +} + +.p-apple-teal-color{ + color: rgb(89, 173, 196); +} + +.p-apple-teal-dark-color{ + color: rgb(106, 196, 220); +} + +.p-apple-cyan-color{ + color: rgb(85,190,240); +} + +.p-apple-cyan-dark-color{ + color: rgb(90,200,245); +} + +.p-apple-blue-color{ + color: rgb(0, 122, 255); +} + +.p-apple-blue-dark-color{ + color: rgb(10, 132, 255); +} + +.p-apple-indigo-color{ + color: rgb(88, 86, 214); +} + +.p-apple-indigo-dark-color{ + color: rgb(94, 92, 230); +} + +.p-apple-purple-color{ + color: rgb(175, 82, 222); +} + +.p-apple-purple-dark-color{ + color: rgb(191, 90, 242); +} + +.p-apple-pink-color{ + color: rgb(255, 45, 85); +} + +.p-apple-pink-dark-color{ + color: rgb(255, 55, 95); +} + +.p-apple-brown-color{ + color: rgb(162, 132, 94); +} + +.p-apple-brown-dark-color{ + color: rgb(172, 142, 104); +} + +.p-apple-gray-color{ + color: rgb(142, 142, 147); +} + +.p-apple-gray-dark-color{ + color: rgb(152, 152, 157); +} + +.p-strawberry { + background: #c6262e; +} + +.p-strawberry-100 { + background: #ff8c82; +} + +.p-strawberry-300 { + background: #ed5353; +} + +.p-strawberry-500 { + background: #c6262e; +} + +.p-strawberry-700 { + background: #a10705; +} + +.p-strawberry-900 { + background: #7a0000; +} + +.p-orange { + background: #f37329; +} + +.p-orange-100 { + background: #ffc27d; +} + +.p-orange-300 { + background: #ffa154; +} + +.p-orange-500 { + background: #f37329; +} + +.p-orange-700 { + background: #cc3b02; +} + +.p-orange-900 { + background: #a62100; +} + +.p-banana { + background: #f9c440; +} + +.p-banana-100 { + background: #fff394; +} + +.p-banana-300 { + background: #ffe16b; +} + +.p-banana-500 { + background: #f9c440; +} + +.p-banana-700 { + background: #d48e15; +} + +.p-banana-900 { + background: #ad5f00; +} + +.p-lime { + background: #68b723; +} + +.p-lime-100 { + background: #d1ff82; +} + +.p-lime-300 { + background: #9bdb4d; +} + +.p-lime-500 { + background: #68b723; +} + +.p-lime-700 { + background: #3a9104; +} + +.p-lime-900 { + background: #206b00; +} + +.p-mint { + background: #28bca3; +} + +.p-mint-100 { + background: #89ffdd; +} + +.p-mint-300 { + background: #43d6b5; +} + +.p-mint-500 { + background: #28bca3; +} + +.p-mint-700 { + background: #0e9a83; +} + +.p-mint-900 { + background: #007367; +} + +.p-blueberry { + background: #3689e6; +} + +.p-blueberry-100 { + background: #8cd5ff; +} + +.p-blueberry-300 { + background: #64baff; +} + +.p-blueberry-500 { + background: #3689e6; +} + +.p-blueberry-700 { + background: #0d52bf; +} + +.p-blueberry-900 { + background: #002e99; +} + +.p-grape { + background: #a56de2; +} + +.p-grape-100 { + background: #e4c6fa; +} + +.p-grape-300 { + background: #cd9ef7; +} + +.p-grape-500 { + background: #a56de2; +} + +.p-grape-700 { + background: #7239b3; +} + +.p-grape-900 { + background: #452981; +} + +.p-bubblegum { + background: #de3e80; +} + +.p-bubblegum-100 { + background: #fe9ab8; +} + +.p-bubblegum-300 { + background: #f4679d; +} + +.p-bubblegum-500 { + background: #de3e80; +} + +.p-bubblegum-700 { + background: #bc245d; +} + +.p-bubblegum-900 { + background: #910e38; +} + +.p-cocoa { + background: #715344; +} + +.p-cocoa-100 { + background: #a3907c; +} + +.p-cocoa-300 { + background: #8a715e; +} + +.p-cocoa-500 { + background: #715344; +} + +.p-cocoa-700 { + background: #57392d; +} + +.p-cocoa-900 { + background: #3d211b; +} + +.p-silver { + background: #abacae; +} + +.p-silver-100 { + background: #fafafa; +} + +.p-silver-300 { + background: #d4d4d4; +} + +.p-silver-500 { + background: #abacae; +} + +.p-silver-700 { + background: #7e8087; +} + +.p-silver-900 { + background: #555761; +} + +.p-slate { + background: #485a6c; +} + +.p-slate-100 { + background: #95a3ab; +} + +.p-slate-300 { + background: #667885; +} + +.p-slate-500 { + background: #485a6c; +} + +.p-slate-700 { + background: #273445; +} + +.p-slate-900 { + background: #0e141f; +} + +.p-dark { + background: #333; +} + +.p-dark-100 { + background: #666; + /* hehe */ +} + +.p-dark-300 { + background: #4d4d4d; +} + +.p-dark-500 { + background: #333; +} + +.p-dark-700 { + background: #1a1a1a; +} + +.p-dark-900 { + background: #000; +} + +.p-white{ + background: #fff; +} + +.p-strawberry-color { + color: #c6262e; +} + +.p-strawberry-100-color { + color: #ff8c82; +} + +.p-strawberry-300-color { + color: #ed5353; +} + +.p-strawberry-500-color { + color: #c6262e; +} + +.p-strawberry-700-color { + color: #a10705; +} + +.p-strawberry-900-color { + color: #7a0000; +} + +.p-orange-color { + color: #f37329; +} + +.p-orange-100-color { + color: #ffc27d; +} + +.p-orange-300-color { + color: #ffa154; +} + +.p-orange-500-color { + color: #f37329; +} + +.p-orange-700-color { + color: #cc3b02; +} + +.p-orange-900-color { + color: #a62100; +} + +.p-banana-color { + color: #f9c440; +} + +.p-banana-100-color { + color: #fff394; +} + +.p-banana-300-color { + color: #ffe16b; +} + +.p-banana-500-color { + color: #f9c440; +} + +.p-banana-700-color { + color: #d48e15; +} + +.p-banana-900-color { + color: #ad5f00; +} + +.p-lime-color { + color: #68b723; +} + +.p-lime-100-color { + color: #d1ff82; +} + +.p-lime-300-color { + color: #9bdb4d; +} + +.p-lime-500-color { + color: #68b723; +} + +.p-lime-700-color { + color: #3a9104; +} + +.p-lime-900-color { + color: #206b00; +} + +.p-mint-color { + color: #28bca3; +} + +.p-mint-100-color { + color: #89ffdd; +} + +.p-mint-300-color { + color: #43d6b5; +} + +.p-mint-500-color { + color: #28bca3; +} + +.p-mint-700-color { + color: #0e9a83; +} + +.p-mint-900-color { + color: #007367; +} + +.p-blueberry-color { + color: #3689e6; +} + +.p-blueberry-100-color { + color: #8cd5ff; +} + +.p-blueberry-300-color { + color: #64baff; +} + +.p-blueberry-500-color { + color: #3689e6; +} + +.p-blueberry-700-color { + color: #0d52bf; +} + +.p-blueberry-900-color { + color: #002e99; +} + +.p-grape-color { + color: #a56de2; +} + +.p-grape-100-color { + color: #e4c6fa; +} + +.p-grape-300-color { + color: #cd9ef7; +} + +.p-grape-500-color { + color: #a56de2; +} + +.p-grape-700-color { + color: #7239b3; +} + +.p-grape-900-color { + color: #452981; +} + +.p-bubblegum-color { + color: #de3e80; +} + +.p-bubblegum-100-color { + color: #fe9ab8; +} + +.p-bubblegum-300-color { + color: #f4679d; +} + +.p-bubblegum-500-color { + color: #de3e80; +} + +.p-bubblegum-700-color { + color: #bc245d; +} + +.p-bubblegum-900-color { + color: #910e38; +} + +.p-cocoa-color { + color: #715344; +} + +.p-cocoa-100-color { + color: #a3907c; +} + +.p-cocoa-300-color { + color: #8a715e; +} + +.p-cocoa-500-color { + color: #715344; +} + +.p-cocoa-700-color { + color: #57392d; +} + +.p-cocoa-900-color { + color: #3d211b; +} + +.p-silver-color { + color: #abacae; +} + +.p-silver-100-color { + color: #fafafa; +} + +.p-silver-300-color { + color: #d4d4d4; +} + +.p-silver-500-color { + color: #abacae; +} + +.p-silver-700-color { + color: #7e8087; +} + +.p-silver-900-color { + color: #555761; +} + +.p-slate-color { + color: #485a6c; +} + +.p-slate-100-color { + color: #95a3ab; +} + +.p-slate-300-color { + color: #667885; +} + +.p-slate-500-color { + color: #485a6c; +} + +.p-slate-700-color { + color: #273445; +} + +.p-slate-900-color { + color: #0e141f; +} + +.p-dark-color { + color: #333; +} + +.p-dark-100-color { + color: #666; + /* hehe */ +} + +.p-dark-300-color { + color: #4d4d4d; +} + +.p-dark-500-color { + color: #333; +} + +.p-dark-700-color { + color: #1a1a1a; +} + +.p-dark-900-color { + color: #000; +} + +.p-white-color{ + color: #fff; +} diff --git a/v3/examples/ios/frontend/public/puppertino/css/dark_mode.css b/v3/examples/ios/frontend/public/puppertino/css/dark_mode.css new file mode 100644 index 000000000..3c5a03e80 --- /dev/null +++ b/v3/examples/ios/frontend/public/puppertino/css/dark_mode.css @@ -0,0 +1 @@ +/* Puppertino dark_mode placeholder - local vendored */ diff --git a/v3/examples/ios/frontend/public/puppertino/css/forms.css b/v3/examples/ios/frontend/public/puppertino/css/forms.css new file mode 100644 index 000000000..f2320ab1b --- /dev/null +++ b/v3/examples/ios/frontend/public/puppertino/css/forms.css @@ -0,0 +1,509 @@ +:root { + --primary-col:linear-gradient(to bottom, #4fc5fa 0%,#0f75f5 100%); + --primary-col-ac:#0f75f5; + --bg-color-input:#fff; + + --p-checkbox-gradient: linear-gradient(180deg, #4B91F7 0%, #367AF6 100%); + --p-checkbox-border: rgba(0, 0, 0, 0.2); + --p-checkbox-border-active: rgba(0, 0, 0, 0.12); + --p-checkbox-bg: transparent; + --p-checkbox-shadow: inset 0px 1px 2px rgba(0, 0, 0, 0.15), inset 0px 0px 2px rgba(0, 0, 0, 0.10); + + --p-input-bg:#fff; + --p-input-color: rgba(0,0,0,.85); + --p-input-color-plac:rgba(0,0,0,0.25); + + --p-input-color:#808080; + --p-input-bd:rgba(0,0,0,0.15); + --bg-hover-color:#f9f9f9; + --bg-front-col:#000; + --invalid-color:#d6513c; + --valid-color:#94d63c; +} + +.p-dark-mode{ + --p-checkbox-bg: linear-gradient(180deg, rgba(255, 255, 255, 0.1) 0%, rgba(255, 255, 255, 0.13) 100%); + --p-checkbox-shadow: 0px 0px 1px rgba(0, 0, 0, 0.25), inset 0px 0.5px 0px rgba(255, 255, 255, 0.15); + --p-checkbox-border: rgba(0, 0, 0, 0); + + --p-checkbox-gradient: linear-gradient(180deg, #3168DD 0%, #2C5FC8 100%); + --p-checkbox-border-active: rgba(0, 0, 0, 0); +} + +.p-form-select { + border-radius: 5px; + display: inline-block; + font-family: -apple-system, "Inter", sans-serif; + margin: 10px; + position: relative; +} + +.p-form-select > select:focus{ + outline: 2px solid #64baff; +} + +.p-form-select::after { + background: url("data:image/svg+xml,%3Csvg fill='none' xmlns='http://www.w3.org/2000/svg' viewBox='0 0 8 12'%3E%3Cpath d='M.288 4.117 3.16 1.18c.168-.168.336-.246.54-.246a.731.731 0 0 1 .538.246L7.108 4.12c.125.121.184.27.184.45 0 .359-.293.656-.648.656a.655.655 0 0 1-.48-.211L3.701 2.465l-2.469 2.55a.664.664 0 0 1-.48.212.656.656 0 0 1-.465-1.11Zm3.41 7.324a.73.73 0 0 0 .54-.246l2.87-2.941a.601.601 0 0 0 .184-.45.656.656 0 0 0-.648-.656.677.677 0 0 0-.48.211L3.701 9.91 1.233 7.36a.68.68 0 0 0-.48-.212.656.656 0 0 0-.465 1.11l2.871 2.937c.172.168.336.246.54.246Z' fill='white' style='mix-blend-mode:luminosity'/%3E%3C/svg%3E"), #017AFF; + background-size: 100% 75%; + background-position: center; + background-repeat: no-repeat; + border-radius: 5px; + bottom: 0; + content: ""; + display: block; + height: 80%; + pointer-events: none; + position: absolute; + right: 3%; + top: 10%; + width: 20px; +} + +.p-form-select > select { + -webkit-appearance: none; + appearance: none; + background: var(--p-input-bg); + border: 1px solid var(--p-input-bd); + border-radius: 5px; + font-size: 14px; + margin: 0; + outline: none; + padding: 5px 35px 5px 10px; + position: relative; + width: 100%; + color: var(--p-input-color); +} + +.p-form-text:invalid, +.p-form-text-alt:invalid{ + border-color: var(--invalid-color); +} + +.p-form-text:valid, +.p-form-text-alt:valid{ + border-color: var(--valid-color); +} + +.p-form-text:placeholder-shown, +.p-form-text-alt:placeholder-shown{ + border-color: var(--p-input-bd); +} + +.p-form-text { + color: var(--p-input-color); + -webkit-appearance: none; + appearance: none; + background: var(--p-input-bg); + border: 1px solid var(--p-input-bd); + border-radius: 5px; + font-family: -apple-system, "Inter", sans-serif; + font-size: 13px; + margin: 10px; + outline: 0; + padding: 3px 7px; + resize: none; + transition: border-color 200ms; + box-shadow: 0px 0.5px 2.5px rgba(0,0,0,.3), 0px 0px 0px rgba(0,0,0,.1); +} + +.p-form-text-alt { + color: var(--p-input-color); + -webkit-appearance: none; + appearance: none; + box-shadow: none; + background: var(--p-input-bg); + border: 0px; + border-bottom: 2px solid var(--p-input-bd); + padding: 10px; + border-top-left-radius: 3px; + border-top-right-radius: 3px; + margin: 10px; +} + + + +.p-form-text-alt::placeholder, +.p-form-text::placeholder +{ + color: var(--p-input-color-plac); +} + +.p-form-text:active, +.p-form-text:focus +{ + outline: 3px solid rgb(0 122 255 / 50%); +} + +.p-form-text-alt:focus { + outline: 0; + outline: 3px solid rgb(0 122 255 / 50%); + border-color: #3689e6; +} + +.p-form-no-validate:valid, +.p-form-no-validate:invalid{ + border-color: var(--p-input-bd); + color: var(--p-input-color)!important; +} + +.p-form-text:focus { + border-color: rgb(0 122 255); +} + +textarea.p-form-text { + -webkit-appearance: none; + appearance: none; + height: 100px; +} + +.p-form-truncated { + overflow: hidden; + text-overflow: ellipsis; + white-space: nowrap; +} + +.p-form-text[type=password] { + font-family: caption; +} + +.p-form-label, +.p-form-radio-cont, +.p-form-checkbox-cont, +.p-form-label-inline { + font-family: -apple-system, "Inter", sans-serif; +} + +.p-form-label, .p-form-label-inline { + display: inline-block; +} + +.p-form-label{ + font-size: 11px; +} + +.p-form-label-inline { + background: var(--p-input-bg); + padding: 5px; + border-bottom: 2px solid var(--p-input-bd); + color: #656565; + font-weight: 500; + transition: .3s; +} + +.p-form-label-inline:focus-within { + color: #3689e6; + border-color: #3689e6; +} + +.p-form-label-inline > .p-form-text-alt { + border-bottom: 0px; + padding: 0; + outline: 0; + background: var(--p-input-bg); + +} + +.p-form-label-inline > .p-form-text-alt:-webkit-autofill{ + background: var(--p-input-bg); + -webkit-box-shadow: 0 0 0 30px rgba(0,0,0,0) inset !important; +} + +.p-form-label-inline > .p-form-text-alt:invalid { + color: var(--invalid-color); +} + +.p-form-label-inline > .p-form-text-alt:valid { + color: #3689e6; +} + +.p-form-label-inline > .p-form-text-alt:focus{ + color: var(--p-input-color); +} + +.p-form-radio-cont, +.p-form-checkbox-cont { + align-items: center; + display: inline-flex; + cursor: pointer; + margin: 0 10px; + user-select: none; +} + +.p-form-radio-cont > input + span, +.p-form-checkbox-cont > input + span { + background: var(--p-input-bg); + border: 1px solid var(--p-input-bd); + border-radius: 50%; + display: inline-block; + height: 20px; + margin-right: 5px; + position: relative; + transition: 0.2s; + width: 20px; +} + +.p-form-radio-cont > input + span{ + box-shadow: inset 0px 1px 2px rgba(0,0,0,0.10), inset 0px 0px 2px rgba(0,0,0,0.10); +} + +.p-form-radio-cont > input:focus + span, +.p-form-checkbox-cont > input:focus + span{ + outline: 3px solid rgb(0 122 255 / 50%); +} + +.p-form-radio-cont:hover > input + span{ + background: #f9f9f9; +} + +.p-form-radio-cont > input, +.p-form-checkbox-cont > input { + opacity: 0; + pointer-events: none; + position: absolute; +} + +.p-form-radio-cont > input + span::after { + background: #fff; + border-radius: 50%; + content: ""; + display: block; + height: 30%; + left: calc(50% - 15%); + opacity: 0; + position: absolute; + top: calc(50% - 15%); + transform: scale(2); + transition: opacity 0.2s, transform 0.3s; + width: 30%; +} + +.p-form-radio-cont > input:checked + span { + background: #0f75f5; + box-shadow: 0px 1px 2.5px 1px rgba(0, 122, 255, 0.24), inset 0px 0px 0px 0.5px rgba(0, 122, 255, 0.12); +} + +.p-form-radio-cont > input:checked + span::after { + opacity: 1; + transform: scale(1); +} + +.p-form-checkbox-cont > input + span { + border-radius: 5px; + box-shadow: var(--p-checkbox-shadow); + border: 0.5px solid var(--p-checkbox-border); + background: var(--p-checkbox-bg) +} + +.p-form-checkbox-cont > input:checked + span { + background: var(--p-checkbox-gradient); + border: 0.5px solid var(--p-checkbox-border-active); + box-shadow: 0px 1px 2.5px rgba(0, 122, 255, 0.24), 0px 0px 0px 0.5px rgba(0, 122, 255, 0.12); +} + +.p-form-checkbox-cont > input + span::before{ + content: ""; + display: block; + height: 100%; + width: 100%; + position: absolute; + left: 0%; + top: 0%; + opacity: 0; + transition: opacity 0.2s; + background-image: url("data:image/svg+xml,%3Csvg width='10' height='8' viewBox='0 0 10 8' fill='none' xmlns='http://www.w3.org/2000/svg'%3E%3Cpath d='M4.10791 7.81299C3.83545 7.81299 3.6084 7.70459 3.42676 7.48779L1.15918 4.74121C1.08008 4.65039 1.02441 4.5625 0.992188 4.47754C0.959961 4.39258 0.943848 4.30469 0.943848 4.21387C0.943848 4.00586 1.0127 3.83447 1.15039 3.69971C1.29102 3.56201 1.4668 3.49316 1.67773 3.49316C1.91211 3.49316 2.10693 3.58838 2.26221 3.77881L4.10791 6.04297L7.68066 0.368652C7.77148 0.230957 7.86523 0.134277 7.96191 0.0786133C8.06152 0.0200195 8.18311 -0.00927734 8.32666 -0.00927734C8.5376 -0.00927734 8.71191 0.0581055 8.84961 0.192871C8.9873 0.327637 9.05615 0.497559 9.05615 0.702637C9.05615 0.778809 9.04297 0.85791 9.0166 0.939941C8.99023 1.02197 8.94922 1.10693 8.89355 1.19482L4.80225 7.45703C4.64111 7.69434 4.40967 7.81299 4.10791 7.81299Z' fill='white'/%3E%3C/svg%3E%0A"); + background-size: 70%; + background-position: center; + background-repeat: no-repeat; +} + +.p-form-checkbox-cont > input + span::after{ + content: ''; + width: 100%; + height: 100%; + position: absolute; + top: 0; + left: 0; + z-index: 9; +} + +.p-form-checkbox-cont > input + span:active::after{ + border-radius: 5px; + backdrop-filter: brightness(1.2); +} + +.p-form-checkbox-cont > input:checked + span::before{ + opacity: 1; +} + + +.p-form-checkbox-cont > input[disabled] + span, +.p-form-radio-cont > input[disabled] ~ span +{ + opacity: .7; + cursor: not-allowed; +} + +.p-form-button { + -webkit-appearance: none; + appearance: none; + background: #fff; + border: 1px solid var(--p-input-bd); + border-radius: 5px; + color: #333230; + display: inline-block; + font-size: 17px; + margin: 10px; + padding: 5px 20px; + text-decoration: none; +} + +.p-form-send { + background: linear-gradient(to bottom, #4fc5fa 0%, #0f75f5 100%); + border: 0; + color: #fff; +} + +.p-form-send:active { + background: #0f75f5; +} + +.p-form-invalid, +.p-form-invalid:placeholder-shown, +.p-form-invalid:valid, +.p-form-invalid:invalid { + border-color: var(--invalid-color); +} + +.p-form-valid, +.p-form-valid:placeholder-shown, +.p-form-valid:valid, +.p-form-valid:invalid { + border-color: var(--valid-color); +} + +.p-form-switch { + --width: 80px; + cursor: pointer; + display: inline-block; +} + +.p-form-switch > input:checked + span::after { + left: calc(100% - calc(var(--width) / 1.8)); +} + +.p-form-switch > input:checked + span { + background: #60c35b; +} + +.p-form-switch > span { + background: #e0e0e0; + border: 1px solid #d3d3d3; + border-radius: 500px; + display: block; + height: calc(var(--width) / 1.6); + position: relative; + transition: all 0.2s; + width: var(--width); +} + +.p-form-switch > span::after { + background: #f9f9f9; + border-radius: 50%; + border: 0.5px solid rgba(0, 0, 0, 0.101987); + box-shadow: 0px 3px 1px rgba(0, 0, 0, 0.1), 0px 1px 1px rgba(0, 0, 0, 0.16), 0px 3px 8px rgba(0, 0, 0, 0.15); + box-sizing: border-box; + content: ""; + height: 84%; + left: 3%; + position: absolute; + top: 6.5%; + transition: all 0.2s; + width: 52.5%; +} + +.p-form-switch > input { + display: none; +} + +.p-chip input{ + opacity: 0; + pointer-events: none; + position: absolute; +} + +.p-chip span{ + padding: .8rem 1rem; + border-radius: 1.6rem; + display:inline-block; + margin:10px; + background: #e4e4e4ca; + color: #3689e6; + transition: .3s; + user-select: none; + cursor:pointer; + font-family: -apple-system, "Inter", sans-serif; + font-size: 1rem; + -webkit-tap-highlight-color: rgba(0, 0, 0, 0); + -moz-tap-highlight-color: rgba(0, 0, 0, 0); + text-align:center; +} + +.p-chip:focus-within span{ + outline: 2px solid #64baff; +} + +.p-chip svg{ + display:block; + margin:auto; +} + + +.p-chip input:checked + span{ + background: #3689e6; + color:#fff; +} + +.p-chip-outline span, .p-chip-outline-to-bg span{ + background: transparent; + color: #3e3e3e; + border: 1px solid currentColor; +} + +.p-chip-outline input:checked + span{ + background: transparent; + color: #3689e6; +} + +.p-chip-radius-b span{ + border-radius: 5px; +} + +.p-chip-dark span{ + color: #3e3e3e; +} + +.p-chip-dark input:checked + span{ + background: #3e3e3e; +} + +.p-chip input:disabled + span, +.p-chip input[disabled] + span{ + opacity: .5; + cursor: not-allowed; +} + +.p-chip-big span{ + font-size: 1.3rem; + padding: 1.5rem; + min-width: 80px; +} + +.p-form-checkbox-cont[disabled], +.p-form-label[disabled], +.p-form-text[disabled], +.p-form-text-alt[disabled], +.p-form-select[disabled], +.p-form-radio-cont[disabled]{ + filter: grayscale(1) opacity(.3); + pointer-events: none; +} diff --git a/v3/examples/ios/frontend/public/puppertino/css/layout.css b/v3/examples/ios/frontend/public/puppertino/css/layout.css new file mode 100644 index 000000000..1f9b36845 --- /dev/null +++ b/v3/examples/ios/frontend/public/puppertino/css/layout.css @@ -0,0 +1,45 @@ +.p-large-title{ + font-size: 2.75rem; +} + +.p-layout h1 { + font-size: 2.25rem; +} + +.p-layout h2 { + font-size: 1.75rem; +} + +.p-layout h3 { + font-size: 1.58rem; +} + +.p-headline { + font-size: 1.34rem; + font-weight: bold; +} + +.p-layout p { + font-size: 1.15rem; +} + +.p-layout .link, +.p-layout input { + font-size: 0.813rem; +} + +.p-callout { + font-size: 1.14rem; +} + +.p-subhead { + font-size: 1.167rem; +} + +.p-footnote { + font-size: 1.07rem; +} + +.p-caption { + font-size: 0.91rem; +} diff --git a/v3/examples/ios/frontend/public/puppertino/css/modals.css b/v3/examples/ios/frontend/public/puppertino/css/modals.css new file mode 100644 index 000000000..4d718c4f7 --- /dev/null +++ b/v3/examples/ios/frontend/public/puppertino/css/modals.css @@ -0,0 +1 @@ +/* Puppertino modals placeholder - local vendored */ diff --git a/v3/examples/ios/frontend/public/puppertino/css/newfull.css b/v3/examples/ios/frontend/public/puppertino/css/newfull.css new file mode 100644 index 000000000..622a2f364 --- /dev/null +++ b/v3/examples/ios/frontend/public/puppertino/css/newfull.css @@ -0,0 +1,11 @@ +@import url('actions.css'); +@import url('buttons.css'); +@import url('layout.css'); +@import url('cards.css'); +@import url('color_palette.css'); +@import url('forms.css'); +@import url('modals.css'); +@import url('segmented-controls.css'); +@import url('shadows.css'); +@import url('tabs.css'); +@import url('dark_mode.css'); diff --git a/v3/examples/ios/frontend/public/puppertino/css/segmented-controls.css b/v3/examples/ios/frontend/public/puppertino/css/segmented-controls.css new file mode 100644 index 000000000..22819fd5f --- /dev/null +++ b/v3/examples/ios/frontend/public/puppertino/css/segmented-controls.css @@ -0,0 +1 @@ +/* Puppertino segmented-controls placeholder - local vendored */ diff --git a/v3/examples/ios/frontend/public/puppertino/css/shadows.css b/v3/examples/ios/frontend/public/puppertino/css/shadows.css new file mode 100644 index 000000000..060a61658 --- /dev/null +++ b/v3/examples/ios/frontend/public/puppertino/css/shadows.css @@ -0,0 +1 @@ +/* Puppertino shadows placeholder - local vendored */ diff --git a/v3/examples/ios/frontend/public/puppertino/css/tabs.css b/v3/examples/ios/frontend/public/puppertino/css/tabs.css new file mode 100644 index 000000000..61d1487ca --- /dev/null +++ b/v3/examples/ios/frontend/public/puppertino/css/tabs.css @@ -0,0 +1 @@ +/* Puppertino tabs placeholder - local vendored */ diff --git a/v3/examples/ios/frontend/public/puppertino/puppertino.css b/v3/examples/ios/frontend/public/puppertino/puppertino.css new file mode 100644 index 000000000..905da220e --- /dev/null +++ b/v3/examples/ios/frontend/public/puppertino/puppertino.css @@ -0,0 +1,1774 @@ +@charset "UTF-8"; +.p-btn { + background: #fff; + border: 1px solid #cacaca; + border-radius: 5px; + color: #333230; + display: inline-block; + font-family: -apple-system, "Inter", sans-serif; + font-size: 17px; + margin: 10px; + padding: 5px 20px; + text-decoration: none; + /* text-shadow: 0 1px 1px rgba(0, 0, 0, 0.25); */ +} +.p-btn-mob{ + padding: 10px 40px; + background: #0f75f5; + color: #fff; +} +.p-btn[disabled] { + background: #d3d3d3; + color: #555; + cursor: not-allowed; +} +.p-btn:disabled { + background: #d3d3d3; + color: #555; + cursor: not-allowed; +} +.p-btn-disabled { + background: #d3d3d3; + color: #555; + cursor: not-allowed; +} + +.p-prim-col { + background: linear-gradient(to bottom, #4fc5fa 0%, #0f75f5 100%); + border: 0; + color: #fff; +} + +.p-btn.p-prim-col:active { + background: #0f75f5; +} + +.p-btn-more::after { + content: "..."; +} + +.p-btn-round { + border: 0; + border-radius: 50px; + padding: 10px 30px; +} + +.p-btn-icon { + align-items: center; + background: #fff; + border: 2px solid currentColor; + border-radius: 50%; + box-shadow: 0 3px 10px -8px #000; + color: #0f75f5; + display: inline-flex; + font-weight: 900; + height: 36px; + justify-content: center; + margin: 5px; + text-align: center; + text-decoration: none; + width: 36px; +} + +.p-btn-scope { + background: #8e8e8e; + color: #fff; + margin: 5px; + padding: 2px 20px; +} +.p-btn-scope-unactive { + background: transparent; + border-color: transparent; + color: #212136; + transition: border-color 0.2s; +} +.p-btn-scope-unactive:hover { + border-color: #cacaca; +} +.p-btn-scope-disabled { + background: transparent; + color: #8e8e8e; + cursor: not-allowed; +} +.p-btn-scope-outline { + background: transparent; + color: #212136; +} + +.p-btn-scope-outline { + background: transparent; + color: #212136; +} + +.p-btn-outline { + background: none; + border-color: currentColor; +} + +.p-btn-outline-dash { + background: none; + border-color: currentColor; + border-style: dashed; +} + +.p-btn-direction { + color: #212136; + padding: 5px; + text-decoration: none; +} + +.p-btn-direction.p-btn-d-back::before { + content: "❬"; +} + +.p-btn-direction.p-btn-d-next::after { + content: "❭"; +} + +@media (max-width: 576px) { + .p-btn-big-sm { + border: 0; + border-radius: 0%; + bottom: 0; + font-size: 50px; + left: 0; + margin: 0; + padding: 10px 0; + position: fixed; + text-align: center; + width: 100%; + } +} + +/*END OF BUTTONS*/ + +.p-card { + background: rgba(255, 255, 255, 0.3); + border: 1px solid rgba(0, 0, 0, 0.1); + border-radius: 3px; + box-shadow: 0 8px 10px -8px rgba(0, 0, 0, 0.1); + color: #000; + display: block; + margin-top: 30px; + text-decoration: none; +} +.p-card-image > img { + border-bottom: 3px solid var(--accent-article); + display: block; + margin: auto; + width: 100%; +} +.p-card-tags { + display: flex; + overflow: hidden; + position: relative; + width: 100%; +} +.p-card-tags::before { + background: linear-gradient(to right, rgba(255, 255, 255, 0) 0%, rgba(255, 255, 255, 0) 75%, white 100%); + content: ""; + height: 100%; + position: absolute; + right: 0; + top: 0; + width: 30%; +} +.p-card-tags span, +.p-card-tags a { + border: 1px solid #252525; + border-radius: 50px; + color: #252525; + margin: 5px; + padding: 5px 15px; + text-decoration: none; + transition: all 0.2s; +} +.p-card-tags a:hover { + background: #252525; + color: #000; +} +.p-card-title { + font-size: 2rem; + margin-bottom: 15px; + margin-top: 10px; +} +.p-card-content { + padding: 15px; + padding-top: 5px; +} +.p-card-text { + font-size: 17px; + margin-bottom: 10px; + margin-left: 10px; + margin-top: 0; +} + + +/* END OF CARDS*/ + +.p-strawberry { + background: #c6262e; +} + +.p-strawberry-100 { + background: #ff8c82; +} + +.p-strawberry-300 { + background: #ed5353; +} + +.p-strawberry-500 { + background: #c6262e; +} + +.p-strawberry-700 { + background: #a10705; +} + +.p-strawberry-900 { + background: #7a0000; +} + +.p-orange { + background: #f37329; +} + +.p-orange-100 { + background: #ffc27d; +} + +.p-orange-300 { + background: #ffa154; +} + +.p-orange-500 { + background: #f37329; +} + +.p-orange-700 { + background: #cc3b02; +} + +.p-orange-900 { + background: #a62100; +} + +.p-banana { + background: #f9c440; +} + +.p-banana-100 { + background: #fff394; +} + +.p-banana-300 { + background: #ffe16b; +} + +.p-banana-500 { + background: #f9c440; +} + +.p-banana-700 { + background: #d48e15; +} + +.p-banana-900 { + background: #ad5f00; +} + +.p-lime { + background: #68b723; +} + +.p-lime-100 { + background: #d1ff82; +} + +.p-lime-300 { + background: #9bdb4d; +} + +.p-lime-500 { + background: #68b723; +} + +.p-lime-700 { + background: #3a9104; +} + +.p-lime-900 { + background: #206b00; +} + +.p-mint { + background: #28bca3; +} + +.p-mint-100 { + background: #89ffdd; +} + +.p-mint-300 { + background: #43d6b5; +} + +.p-mint-500 { + background: #28bca3; +} + +.p-mint-700 { + background: #0e9a83; +} + +.p-mint-900 { + background: #007367; +} + +.p-blueberry { + background: #3689e6; +} + +.p-blueberry-100 { + background: #8cd5ff; +} + +.p-blueberry-300 { + background: #64baff; +} + +.p-blueberry-500 { + background: #3689e6; +} + +.p-blueberry-700 { + background: #0d52bf; +} + +.p-blueberry-900 { + background: #002e99; +} + +.p-grape { + background: #a56de2; +} + +.p-grape-100 { + background: #e4c6fa; +} + +.p-grape-300 { + background: #cd9ef7; +} + +.p-grape-500 { + background: #a56de2; +} + +.p-grape-700 { + background: #7239b3; +} + +.p-grape-900 { + background: #452981; +} + +.p-bubblegum { + background: #de3e80; +} + +.p-bubblegum-100 { + background: #fe9ab8; +} + +.p-bubblegum-300 { + background: #f4679d; +} + +.p-bubblegum-500 { + background: #de3e80; +} + +.p-bubblegum-700 { + background: #bc245d; +} + +.p-bubblegum-900 { + background: #910e38; +} + +.p-cocoa { + background: #715344; +} + +.p-cocoa-100 { + background: #a3907c; +} + +.p-cocoa-300 { + background: #8a715e; +} + +.p-cocoa-500 { + background: #715344; +} + +.p-cocoa-700 { + background: #57392d; +} + +.p-cocoa-900 { + background: #3d211b; +} + +.p-silver { + background: #abacae; +} + +.p-silver-100 { + background: #fafafa; +} + +.p-silver-300 { + background: #d4d4d4; +} + +.p-silver-500 { + background: #abacae; +} + +.p-silver-700 { + background: #7e8087; +} + +.p-silver-900 { + background: #555761; +} + +.p-slate { + background: #485a6c; +} + +.p-slate-100 { + background: #95a3ab; +} + +.p-slate-300 { + background: #667885; +} + +.p-slate-500 { + background: #485a6c; +} + +.p-slate-700 { + background: #273445; +} + +.p-slate-900 { + background: #0e141f; +} + +.p-dark { + background: #333; +} + +.p-dark-100 { + background: #666; + /* hehe */ +} + +.p-dark-300 { + background: #4d4d4d; +} + +.p-dark-500 { + background: #333; +} + +.p-dark-700 { + background: #1a1a1a; +} + +.p-dark-900 { + background: #000; +} + +.p-strawberry-color { + color: #c6262e; +} + +.p-strawberry-100-color { + color: #ff8c82; +} + +.p-strawberry-300-color { + color: #ed5353; +} + +.p-strawberry-500-color { + color: #c6262e; +} + +.p-strawberry-700-color { + color: #a10705; +} + +.p-strawberry-900-color { + color: #7a0000; +} + +.p-orange-color { + color: #f37329; +} + +.p-orange-100-color { + color: #ffc27d; +} + +.p-orange-300-color { + color: #ffa154; +} + +.p-orange-500-color { + color: #f37329; +} + +.p-orange-700-color { + color: #cc3b02; +} + +.p-orange-900-color { + color: #a62100; +} + +.p-banana-color { + color: #f9c440; +} + +.p-banana-100-color { + color: #fff394; +} + +.p-banana-300-color { + color: #ffe16b; +} + +.p-banana-500-color { + color: #f9c440; +} + +.p-banana-700-color { + color: #d48e15; +} + +.p-banana-900-color { + color: #ad5f00; +} + +.p-lime-color { + color: #68b723; +} + +.p-lime-100-color { + color: #d1ff82; +} + +.p-lime-300-color { + color: #9bdb4d; +} + +.p-lime-500-color { + color: #68b723; +} + +.p-lime-700-color { + color: #3a9104; +} + +.p-lime-900-color { + color: #206b00; +} + +.p-mint-color { + color: #28bca3; +} + +.p-mint-100-color { + color: #89ffdd; +} + +.p-mint-300-color { + color: #43d6b5; +} + +.p-mint-500-color { + color: #28bca3; +} + +.p-mint-700-color { + color: #0e9a83; +} + +.p-mint-900-color { + color: #007367; +} + +.p-blueberry-color { + color: #3689e6; +} + +.p-blueberry-100-color { + color: #8cd5ff; +} + +.p-blueberry-300-color { + color: #64baff; +} + +.p-blueberry-500-color { + color: #3689e6; +} + +.p-blueberry-700-color { + color: #0d52bf; +} + +.p-blueberry-900-color { + color: #002e99; +} + +.p-grape-color { + color: #a56de2; +} + +.p-grape-100-color { + color: #e4c6fa; +} + +.p-grape-300-color { + color: #cd9ef7; +} + +.p-grape-500-color { + color: #a56de2; +} + +.p-grape-700-color { + color: #7239b3; +} + +.p-grape-900-color { + color: #452981; +} + +.p-bubblegum-color { + color: #de3e80; +} + +.p-bubblegum-100-color { + color: #fe9ab8; +} + +.p-bubblegum-300-color { + color: #f4679d; +} + +.p-bubblegum-500-color { + color: #de3e80; +} + +.p-bubblegum-700-color { + color: #bc245d; +} + +.p-bubblegum-900-color { + color: #910e38; +} + +.p-cocoa-color { + color: #715344; +} + +.p-cocoa-100-color { + color: #a3907c; +} + +.p-cocoa-300-color { + color: #8a715e; +} + +.p-cocoa-500-color { + color: #715344; +} + +.p-cocoa-700-color { + color: #57392d; +} + +.p-cocoa-900-color { + color: #3d211b; +} + +.p-silver-color { + color: #abacae; +} + +.p-silver-100-color { + color: #fafafa; +} + +.p-silver-300-color { + color: #d4d4d4; +} + +.p-silver-500-color { + color: #abacae; +} + +.p-silver-700-color { + color: #7e8087; +} + +.p-silver-900-color { + color: #555761; +} + +.p-slate-color { + color: #485a6c; +} + +.p-slate-100-color { + color: #95a3ab; +} + +.p-slate-300-color { + color: #667885; +} + +.p-slate-500-color { + color: #485a6c; +} + +.p-slate-700-color { + color: #273445; +} + +.p-slate-900-color { + color: #0e141f; +} + +.p-dark-color { + color: #333; +} + +.p-dark-100-color { + color: #666; + /* hehe */ +} + +.p-dark-300-color { + color: #4d4d4d; +} + +.p-dark-500-color { + color: #333; +} + +.p-dark-700-color { + color: #1a1a1a; +} + +.p-dark-900-color { + color: #000; +} + +/* END OF COLORS */ + +:root { + --primary-col:linear-gradient(to bottom, #4fc5fa 0%,#0f75f5 100%); + --primary-col-ac:#0f75f5; + --bg-color:#fff; + --bg-hover-color:#f9f9f9; + --bg-front-col:#000; + --invalid-color:#d6513c; + --valid-color:#94d63c; +} + +.p-form-select { + border-radius: 5px; + display: inline-block; + font-family: -apple-system, "Inter", sans-serif; + margin: 10px; + position: relative; +} + +.p-form-select::before { + border-color: #fff transparent transparent; + border-style: solid; + border-width: 5px; + content: ""; + pointer-events: none; + position: absolute; + right: 5px; + top: calc(50% - 3px); + z-index: 3; +} + +.p-form-select::after { + background: linear-gradient(to bottom, #4fc5fa 0%, #0f75f5 100%); + border-bottom-right-radius: 5px; + border-top-right-radius: 5px; + bottom: 0; + content: ""; + display: block; + height: 100%; + pointer-events: none; + position: absolute; + right: 0; + top: 0; + width: 20px; +} + +.p-form-select > select { + -webkit-appearance: none; + background: #fff; + border: 1px solid #cacaca; + border-radius: 5px; + font-size: 14px; + margin: 0; + outline: none; + padding: 5px 30px 5px 10px; + position: relative; + width: 100%; +} + +.p-form-text:invalid, +.p-form-text-alt:invalid, +.p-form-select > select:invalid { + border-color: var(--invalid-color); +} + +.p-form-text:valid, +.p-form-text-alt:valid, +.p-form-select > select:valid { + border-color: var(--valid-color); +} + +.p-form-text:placeholder-shown, +.p-form-text-alt:placeholder-shown, +.p-form-select > select:placeholder-shown { + border-color: #cacaca; +} + +.p-form-text { + -webkit-appearance: none; + box-shadow: none; + background: #fff; + border: 1px solid #cacaca; + border-radius: 5px; + font-family: -apple-system, "Inter", sans-serif; + margin: 10px; + outline: 0; + padding: 5px; + resize: none; + transition: border-color 200ms; +} + +.p-form-text-alt { + -webkit-appearance: none; + box-shadow: none; + background: #fff; + border: 0px; + border-bottom: 2px solid #cacaca; + padding: 10px; + border-top-left-radius: 5px; + border-top-right-radius: 5px; + margin: 10px; +} + +.p-form-text-alt::placeholder { + color: #cacaca; +} + +.p-form-text-alt:focus { + outline: 3px solid #bed8f9; +} + +.p-form-no-validate:valid, +.p-form-no-validate:invalid, +.p-form-no-validate > select:valid, +.p-form-no-validate > select:invalid { + border-color: #cacaca; +} + +.p-form-text:focus { + border-color: #0f75f5; +} + +textarea.p-form-text { + -webkit-appearance: none; + height: 100px; +} + +.p-form-truncated { + overflow: hidden; + text-overflow: ellipsis; + white-space: nowrap; +} + +.p-form-text[type=password] { + font-family: caption; +} + +.p-form-label, +.p-form-radio-cont, +.p-form-checkbox-cont { + font-family: -apple-system, "Inter", sans-serif; +} + +.p-form-label { + display: block; +} + +.p-form-radio-cont, +.p-form-checkbox-cont { + align-items: center; + display: inline-flex; + margin: 0 10px; +} + +.p-form-radio-cont > input + span, +.p-form-checkbox-cont > input + span { + background: #fff; + border: 1px solid #cacaca; + border-radius: 50%; + cursor: pointer; + display: inline-block; + height: 20px; + margin-right: 5px; + position: relative; + transition: background 0.2s; + width: 20px; +} + +.p-form-radio-cont > input + span:hover { + background: #f9f9f9; +} + +.p-form-radio-cont > input, +.p-form-checkbox-cont > input { + opacity: 0; + pointer-events: none; + position: absolute; +} + +.p-form-radio-cont > input + span::after { + background: #fff; + border-radius: 50%; + box-shadow: 0 1px 2px rgba(0, 0, 0, 0.3); + content: ""; + display: block; + height: 30%; + left: calc(50% - 15%); + opacity: 0; + position: absolute; + top: calc(50% - 15%); + transform: scale(2); + transition: opacity 0.2s, transform 0.3s; + width: 30%; +} + +.p-form-radio-cont > input:checked + span { + background: #0f75f5; +} + +.p-form-radio-cont > input:checked + span::after { + opacity: 1; + transform: scale(1); +} + +.p-form-checkbox-cont > input + span { + border-radius: 5px; +} + +.p-form-checkbox-cont > input:checked + span { + background: #0f75f5; +} + +.p-form-checkbox-cont > input + span::before, +.p-form-checkbox-cont > input + span::after { + background: #fff; + border-radius: 20px; + content: ""; + display: block; + height: 8%; + position: absolute; +} + +.p-form-checkbox-cont > input + span::before { + right: 30%; + top: 15%; + transform: rotate(-65deg); + transform-origin: top right; + width: 70%; +} + +.p-form-checkbox-cont > input + span::after { + left: 30%; + top: 43%; + transform: rotate(60deg); + transform-origin: top left; + width: 40%; +} + +.p-form-button { + -webkit-appearance: none; + background: #fff; + border: 1px solid #cacaca; + border-radius: 5px; + color: #333230; + display: inline-block; + font-size: 17px; + margin: 10px; + padding: 5px 20px; + text-decoration: none; + /* text-shadow: 0 1px 1px rgba(0, 0, 0, 0.25); */ +} + +.p-form-send { + background: linear-gradient(to bottom, #4fc5fa 0%, #0f75f5 100%); + border: 0; + color: #fff; +} + +.p-form-send:active { + background: #0f75f5; +} + +.p-form-invalid, +.p-form-invalid:placeholder-shown, +.p-form-invalid:valid, +.p-form-invalid:invalid { + border-color: var(--invalid-color); +} + +.p-form-valid, +.p-form-valid:placeholder-shown, +.p-form-valid:valid, +.p-form-valid:invalid { + border-color: var(--valid-color); +} + +.p-form-switch { + --width: 80px; + cursor: pointer; + display: inline-block; +} + +.p-form-switch > input:checked + span::after { + left: calc(100% - calc(var(--width) / 2.1)); +} + +.p-form-switch > input:checked + span { + background: #60c35b; +} + +.p-form-switch > span { + background: #e0e0e0; + border: 1px solid #d3d3d3; + border-radius: 500px; + display: block; + height: calc(var(--width) / 2); + overflow: hidden; + position: relative; + transition: all 0.2s; + width: var(--width); +} + +.p-form-switch > span::after { + background: #f9f9f9; + border-radius: 50%; + box-shadow: 0px 3px 1px rgba(0, 0, 0, 0.1), 0px 1px 1px rgba(0, 0, 0, 0.16), 0px 3px 8px rgba(0, 0, 0, 0.15); + content: ""; + height: 90%; + left: 3%; + position: absolute; + top: 4.5%; + transition: all 0.2s; + width: 45%; +} + +.p-form-switch > input { + display: none; +} + +input[type=range].p-form-range { + width: 100%; + margin: 11.5px 0; + background-color: transparent; + -webkit-appearance: none; +} +input[type=range].p-form-range:focus { + outline: none; +} +input[type=range].p-form-range::-webkit-slider-runnable-track { + background: #cacaca; + border: 0; + width: 100%; + height: 2px; + cursor: pointer; +} +input[type=range].p-form-range::-webkit-slider-thumb { + margin-top: -11.5px; + width: 25px; + height: 25px; + background: #ffffff; + border: 1px solid rgba(115, 115, 115, 0.6); + border-radius: 30px; + cursor: pointer; + box-shadow: 0 3px 1px rgba(0, 0, 0, 0.1), 0 1px 1px rgba(0, 0, 0, 0.16), 0 3px 8px rgba(0, 0, 0, 0.15); + -webkit-appearance: none; +} +input[type=range].p-form-range:focus::-webkit-slider-runnable-track { + background: #d7d7d7; +} +input[type=range].p-form-range::-moz-range-track { + background: #cacaca; + border: 0; + width: 100%; + height: 2px; + cursor: pointer; +} +input[type=range].p-form-range::-moz-range-thumb { + width: 25px; + height: 25px; + background: #ffffff; + border: 1px solid rgba(115, 115, 115, 0.6); + border-radius: 30px; + box-shadow: 0 3px 1px rgba(0, 0, 0, 0.1), 0 1px 1px rgba(0, 0, 0, 0.16), 0 3px 8px rgba(0, 0, 0, 0.15); + cursor: pointer; +} +input[type=range].p-form-range::-ms-track { + background: transparent; + border-color: transparent; + border-width: 26.5px 0; + color: transparent; + width: 100%; + height: 2px; + cursor: pointer; +} +input[type=range].p-form-range::-ms-fill-lower { + background: #bdbdbd; + border: 0; +} +input[type=range].p-form-range::-ms-fill-upper { + background: #cacaca; + border: 0; +} +input[type=range].p-form-range::-ms-thumb { + width: 25px; + height: 25px; + background: #ffffff; + border: 1px solid rgba(115, 115, 115, 0.6); + border-radius: 30px; + cursor: pointer; + box-shadow: 0 3px 1px rgba(0, 0, 0, 0.1), 0 1px 1px rgba(0, 0, 0, 0.16), 0 3px 8px rgba(0, 0, 0, 0.15); + margin-top: 0px; + /*Needed to keep the Edge thumb centred*/ +} +input[type=range].p-form-range:focus::-ms-fill-lower { + background: #cacaca; +} +input[type=range].p-form-range:focus::-ms-fill-upper { + background: #d7d7d7; +} +/*TODO: Use one of the selectors from https://stackoverflow.com/a/20541859/7077589 and figure out +how to remove the virtical space around the range input in IE*/ +@supports (-ms-ime-align:auto) { + /* Pre-Chromium Edge only styles, selector taken from hhttps://stackoverflow.com/a/32202953/7077589 */ + input[type=range].p-form-range { + margin: 0; + /*Edge starts the margin from the thumb, not the track as other browsers do*/ + } +} + + +/* END OF FORMS */ + +.p-layout .p-large-title { + font-size: 2.75rem; +} + +.p-layout h1 { + font-size: 2.25rem; +} + +.p-layout h2 { + font-size: 1.75rem; +} + +.p-layout h3 { + font-size: 1.58rem; +} + +.p-layout .p-headline { + font-size: 1.34rem; + font-weight: bold; +} + +.p-layout p { + font-size: 1.15rem; +} + +.p-layout a, +.p-layout input { + font-size: 1.14rem; +} + +.p-layout .p-callout { + font-size: 1.14rem; +} + +.p-layout .p-subhead { + font-size: 1.167rem; +} + +.p-layout .p-footnote { + font-size: 1.07rem; +} + +.p-layout .p-caption { + font-size: 0.91rem; +} + +/* END OF LAYOUT */ + +:root { + --font: -apple-system, "Inter", sans-serif; + --bg-hover-color: #f9f9f9; + --primary-col-ac: #0f75f5; +} + +.p-modal-opened { + overflow: hidden; +} + +.p-modal-background { + background: rgba(0, 0, 0, 0.3); + height: 100vh; + left: 0; + opacity: 0; + pointer-events: none; + position: fixed; + top: 0; + transition: all 0.3s; + width: 100vw; + z-index: 5; +} + +.p-modal { + background: rgba(255, 255, 255, 0.85); + border-radius: 20px; + top: calc(50% - 20vh); + bottom: unset; + box-shadow: 0 10px 20px -15px; + font-family: var(--font); + left: calc(50% - 20vw); + opacity: 0; + overflow: hidden; + pointer-events: none; + position: fixed; + text-align: center; + transform: scale(1.5); + transition: opacity 0.3s, transform 0.3s; + width: 40vw; + z-index: 9; +} + +.p-modal.active { + backdrop-filter: saturate(180%) blur(10px); + opacity: 1; + pointer-events: auto; + transform: scale(1); +} + +.p-modal-button-container { + border-radius: 20px; + display: flex; +} + +.p-modal-button-container > a { + border-top: 1px solid rgba(0, 0, 0, 0.1); + color: var(--primary-col-ac); + padding: 30px 0%; + text-decoration: none; + width: 100%; +} + +.p-modal-button-container > a:nth-child(2), +.p-modal-button-container > a:nth-child(3) { + border-left: 1px solid rgba(0, 0, 0, 0.1); +} + +.nowactive { + opacity: 1; + pointer-events: auto; +} + +.p-modal p { + padding: 0% 5%; +} + +@supports not (backdrop-filter: blur(5px)) { + .p-modal { + background: #fff; + } +} +@media (max-width: 568px) { + .p-modal { + bottom: 20%; + left: 15%; + top: unset; + width: 70vw; + } + + .p-modal p { + font-size: 15px; + padding: 0% 10%; + } + + .p-modal-button-container { + display: block; + } + + .p-modal-button-container > a { + border-left: 0 !important; + display: block; + padding: 2vh 0%; + } +} + +/* END OF MODALS */ + +.p-segmented-controls { + --color-segmented: #3689e6; + --color-lighter-segment: #d2e3f9; + background: #fff; + border: 1px solid var(--color-segmented); + border-radius: 5px; + display: flex; + flex-wrap: wrap; + font-family: -apple-system, "Inter", sans-serif; + margin-top: 10px; + overflow: hidden; + width: 100%; +} +.p-segmented-controls a { + color: var(--color-segmented); + flex: auto; + padding: 10px; + text-align: center; + text-decoration: none; + transition: all 0.5s; +} +.p-segmented-controls a.active { + background: var(--color-segmented); + color: #fff; +} +.p-segmented-controls a:not(:first-child) { + border-left: 1px solid currentColor; +} + +.p-segmented-radius { + border-radius: 30px; +} + +.p-segmented-internal-radius a, +.p-segmented-internal-radius a:not(:first-child) { + border: 0; + border-radius: 30px; +} + +.p-segmented-controls-alt a:not(:first-child) { + border: 0; +} +.p-segmented-controls-alt a:not(:first-child).active { + background: var(--color-lighter-segment); + color: var(--color-segmented); + font-weight: bold; +} + +.p-segmented-outline { + border: 2px solid var(--color-segmented); +} +.p-segmented-outline a:not(:first-child) { + border-left: 2px solid var(--color-segmented); +} + +.p-segmented-controls-outline-alt a:not(:first-child) { + border: 2px solid transparent; +} + +.p-segmented-controls-outline-alt { + border-radius: 30px; +} +.p-segmented-controls-outline-alt a { + border: 2px solid transparent; + border-radius: 30px; +} +.p-segmented-controls-outline-alt a.active { + background: #fff; + border-color: var(--color-segmented); + border-radius: 30px; + color: var(--color-segmented); + font-weight: bold; +} + +.p-segmented-grey { + --color-segmented: #555761; + --color-lighter-segment: #d4d4d4; +} + +/* END OF SEGMENTED CONTROLS */ + +.p-shadow-1 { + box-shadow: 0 3px 10px rgba(0, 0, 0, 0.1); +} + +.p-shadow-2 { + box-shadow: 0 5px 10px rgba(0, 0, 0, 0.2); +} + +.p-shadow-3 { + box-shadow: 0 10px 18px rgba(0, 0, 0, 0.3); +} + +.p-shadow-4 { + box-shadow: 0 25px 30px rgba(0, 0, 0, 0.2); +} + +.p-to-shadow-4, +.p-to-shadow-3, +.p-to-shadow-2, +.p-to-shadow-1 { + transition-timing-function: ease; + transition: box-shadow 0.5s; +} + +.p-to-shadow-1:hover { + box-shadow: 0 3px 10px rgba(0, 0, 0, 0.1);> +} + +.p-to-shadow-2:hover { + box-shadow: 0 5px 10px rgba(0, 0, 0, 0.2); +} + +.p-to-shadow-3:hover { + box-shadow: 0 10px 18px rgba(0, 0, 0, 0.3); +} + +.p-to-shadow-4:hover { + box-shadow: 0 25px 30px rgba(0, 0, 0, 0.2); +} + + +/* END OF SHADOWS */ + +.p-tabs-container { + background: #e3e3e3; + border: 1px solid #e0e0e0; + padding: 1em; +} + +.p-tabs-container.p-light { + background: none; + border: none; +} + +.p-tabs-container.p-light .p-panels { + margin-top: 0; + border-radius: 0; + padding: 0; +} + +.p-tabs { + display: flex; + justify-content: center; +} + +.p-tabs > :nth-of-type(1) { + border-radius: 5px 0 0 5px; +} + +.p-tabs > :last-child { + border-radius: 0 5px 5px 0; +} + +.p-tab { + margin: 0; + padding: 5px 35px; + background: #fff; + color: #333230; + text-decoration: none; + /* text-shadow: 0 1px 1px rgba(0, 0, 0, 0.25); */ + border: 1px solid #cacaca; + display: inline-block; + font-size: 17px; + font-family: -apple-system, "Inter", sans-serif; + cursor: pointer; +} + +.p-tab:focus { + outline: 0; +} + +.p-is-active { + background: linear-gradient(to bottom, #4fc5fa 0%, #0f75f5 100%); + border: 0; + color: #fff; +} + +.p-panels { + margin-top: 1em; + background: #fff; + border-radius: 3px; + position: relative; + padding: 0.8em; + overflow: hidden; +} + +.p-panel.p-is-active { + opacity: 1; + pointer-events: all; + background: none; + color: inherit; + position: static; +} + +.p-panel { + position: absolute; + opacity: 0; + pointer-events: none; +} + +@media (max-width: 768px) { + .p-tabs { + overflow: auto; + } + .p-tab { + font-size: 0.8em; + padding: 5px 28px; + } + .p-tabs-container { + padding: 0.8em; + } + + .p-panels { + padding: 0.8em; + } +} + +@media screen and (max-width: 496px) { + .p-tab { + text-align: center; + padding: 5px 18px; + } + .p-tabs-container { + padding: 0.5em; + } + + .p-panels { + padding: 0.5em; + margin-top: 0.5em; + } +} + +@media screen and (max-width: 378px) { + .p-tab { + text-align: center; + padding: 5px 10px; + } + .p-tabs-container { + padding: 0.5em; + } + + .p-panels { + padding: 0.5em; + margin-top: 0.5; + } +} + +.p-mobile-tabs { + position: fixed; + bottom: 0; + left: 0; + width: 100%; + padding: 15px 0px; + border-top: 1px solid #949494; + background: rgba(202, 202, 202, 0.8); + backdrop-filter: blur(10px); + display: flex; + font-family: -apple-system, "Inter", sans-serif; +} + +.p-mobile-tabs > div { + flex: auto; + text-align: center; +} + +.p-mobile-tabs a { + text-decoration: none; + color: #555; + transition: color 0.5s; + display: inline-block; + font-size: 0.8rem; +} + +.p-mobile-tabs a.active { + color: #0f75f5; + font-weight: 600; +} + +.p-mobile-tabs svg { + display: block; + margin: auto; + margin-bottom: 0.2rem; +} + +.p-mobile-tabs--content { + display: none; +} + +.p-mobile-tabs--content.active { + display: block; +} + +/* END OF TABS */ + + +.p-action-background{ + background: rgba(0, 0, 0, 0.3); + height: 100vh; + left: 0; + opacity: 0; + pointer-events: none; + position: fixed; + top: 0; + transition: all 0.3s; + width: 100vw; + z-index: 5; +} + +.p-action-background.nowactive { + opacity: 1; + pointer-events: auto; +} + + +.p-action-big-container{ + position:fixed; + width: 100%; + box-sizing: border-box; + padding: 1rem 5vw; + bottom:0; +} + +.p-action-container{ + background: rgba(255, 255, 255, 0.8); + backdrop-filter: blur(10px); + display:block; + margin:auto; + margin-bottom: 10px; + border-radius: 10px; +} + +.p-action-big-container .p-action-container:first-child{ + margin-bottom:10px; +} + +.p-action--intern{ + display:block; + margin:auto; + text-align:center; + padding: 15px 0; + border-bottom: 1px solid #bfbfbf; + font-weight: 500; + color: #0f75f5; + text-decoration:none; +} + +.p-action-destructive{ + color: #c6262e; +} + +.p-action-neutral{ + color: #555761; +} + +.p-action-cancel, .p-action-container a:last-child{ + border-bottom:none; +} + +.p-action-cancel{ + font-weight:bold; +} + +.p-action-icon{ + position:relative; +} +.p-action-icon svg, .p-action-icon img{ + position:absolute; + left:5%; + top:50%; + transform:translateY(-50%); +} + +.p-action-icon-inline{ + text-align: left; + display: flex; + align-items: center; +} + +.p-action-icon-inline svg, .p-action-icon-inline img{ + margin-left: 5%; + margin-right: 3%; +} + +.p-action-title{ + padding: 30px 15px; + border-bottom: 1px solid #bfbfbf; +} + +.p-action-title--intern,.p-action-text{ + margin:0; + color:#555761; +} + +.p-action-title--intern{ + margin-bottom: .3rem; +} + +@supports not (backdrop-filter: blur(10px)) { + .p-action-container { + background: rgba(255,255,255,.95); + } +} + +.p-action-big-container{ + -webkit-transform: translateY(30%); + transform: translateY(30%); + opacity: 0; + transition: opacity 0.4s, transform 0.4s; + transition-timing-function: ease-in-out; +} + +.p-action-big-container.active { +-webkit-transform: translateY(0); + transform: translateY(0); + opacity: 1; +} + + +/* END OF ACTIONS */ diff --git a/v3/examples/ios/frontend/public/style.css b/v3/examples/ios/frontend/public/style.css new file mode 100644 index 000000000..5bf3738a9 --- /dev/null +++ b/v3/examples/ios/frontend/public/style.css @@ -0,0 +1,327 @@ +:root { + font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, "Helvetica Neue", Arial, + sans-serif, "Apple Color Emoji", "Segoe UI Emoji"; + font-size: 16px; + line-height: 24px; + font-weight: 400; + color-scheme: light dark; + /* Desktop defaults (mobile overrides below) */ + --bg: #ffffff; + --fg: #213547; + font-synthesis: none; + text-rendering: optimizeLegibility; + -webkit-font-smoothing: antialiased; + -moz-osx-font-smoothing: grayscale; + -webkit-text-size-adjust: 100%; + user-select: none; + -webkit-user-select: none; + -moz-user-select: none; + -ms-user-select: none; +} + +/* Mobile bottom tabs layout (works on all themes) */ +.mobile-pane { + display: flex; + flex-direction: column; + width: 100%; + max-width: 520px; + height: 70vh; /* fixed-height main screen */ + border-radius: 12px; +} +.mobile-pane .p-mobile-tabs-content { + position: relative; + flex: 1 1 auto; + overflow: hidden; /* contain panels */ + display: flex; + flex-direction: column; +} +.p-mobile-tabs-content .p-mobile-tabs--content { + display: none; + overflow: auto; /* scroll inside content area */ + -webkit-overflow-scrolling: touch; + padding: 8px 8px 16px; +} +.p-mobile-tabs-content .p-mobile-tabs--content.active { display: block; } + +*, *::before, *::after { + box-sizing: border-box; +} + +/* Prefer system fonts on mobile; remove custom font to reduce bundle size */ + +h3 { + font-size: 3em; + line-height: 1.1; +} + +a { + font-weight: 500; + color: #646cff; + text-decoration: inherit; +} + +a:hover { + color: #535bf2; +} + +/* Remove generic button styling to allow Puppertino .btn to control buttons */ + +.result { + height: 20px; + line-height: 20px; +} + +html, +body { + height: 100%; + width: 100%; + overflow-x: hidden; /* prevent horizontal overflow */ + overflow-y: auto; /* allow vertical scroll if needed */ +} + +body { + margin: 0; + display: flex; + flex-direction: column; + align-items: center; + justify-content: center; + min-width: 320px; + /* Use small viewport units to avoid iOS Safari URL bar issues */ + min-height: 100svh; + height: auto; /* avoid forcing overflow */ + /* Equal responsive spacing top & bottom */ + padding-block: clamp(8px, 4vh, 48px); + color: var(--fg); + background-color: var(--bg); +} + +.container { + display: flex; + flex-direction: column; + align-items: center; + justify-content: center; + /* Responsive spacing between elements */ + gap: clamp(8px, 2vh, 24px); + width: 100%; + max-width: 480px; + padding-inline: 16px; +} + +h1 { + /* Responsive heading size */ + font-size: clamp(1.6rem, 6vw, 3.2rem); + line-height: 1.1; +} + +#app { + max-width: 1280px; + margin: 0 auto; + /* Responsive inner padding: horizontal only, no extra top/bottom */ + padding: 0 clamp(12px, 4vw, 32px); + text-align: center; +} + +.logo { + /* Consistent visual size across images: fix height, auto width */ + height: clamp(80px, 18vh, 140px); + width: auto; + max-width: 80vw; + padding: 0.5em; + will-change: filter; +} + +.logo:hover { + filter: drop-shadow(0 0 2em #e80000aa); +} + +.logo.vanilla:hover { + filter: drop-shadow(0 0 2em #f7df1eaa); +} + +.result { + height: 20px; + line-height: 20px; + margin: 1.5rem auto; + text-align: center; +} + +.footer { + margin-top: 1rem; + align-content: center; + text-align: center; +} + +/* Tabs: default hide panels, show one matching the checked radio */ +.tabs .tabs-content .tab-panel { display: none; } +.tabs input#tab-js:checked ~ .tabs-content [data-tab="tab-js"] { display: block; } +.tabs input#tab-go:checked ~ .tabs-content [data-tab="tab-go"] { display: block; } + +/* Sticky tabs header */ +.tabs .tabs-header { + position: sticky; + top: env(safe-area-inset-top); + z-index: 5; + display: grid; + grid-template-columns: 1fr 1fr; + gap: 8px; + padding: 8px 0; + background: var(--bg); + backdrop-filter: saturate(1.2) blur(4px); +} + +/* Subtle divider under sticky header */ +.tabs .tabs-header::after { + content: ""; + grid-column: 1 / -1; + height: 1px; + background: rgba(0,0,0,0.08); + margin-top: 8px; +} + +/* Mobile-specific light mode */ +@media (max-width: 768px) and (prefers-color-scheme: light) { + :root { + --fg: #213547; + --bg: #ffffff; + } + + a:hover { + color: #747bff; + } + + /* allow Puppertino to style .btn */ + + .input-box .input { + color: #111827; + background-color: #f3f4f6; + border: 1px solid #e5e7eb; /* show border in light mode */ + border-radius: 8px; + } + + button:hover { + border-color: #d1d5db; /* slate-300 */ + } + + .input-box .input:focus { + border-color: #9ca3af; /* gray-400 */ + box-shadow: 0 0 0 3px rgba(59, 130, 246, 0.15); /* subtle focus ring */ + } +} + +/* let Puppertino handle .btn hover */ + +.input-box .input { + border: 1px solid transparent; /* default; themed in media queries */ + border-radius: 8px; + outline: none; + height: 30px; + line-height: 30px; + padding: 0 10px; + color: black; + background-color: rgba(240, 240, 240, 1); + -webkit-font-smoothing: antialiased; +} + +.input-box .input:hover { + background-color: rgba(255, 255, 255, 1); +} + +.input-box .input:focus { + background-color: rgba(255, 255, 255, 1); + outline: 2px solid transparent; + outline-offset: 2px; +} + +/* Mobile-specific dark mode */ +@media (max-width: 768px) and (prefers-color-scheme: dark) { + :root { + color: rgba(255, 255, 255, 0.88); + --fg: rgba(255, 255, 255, 0.88); + --bg: #0f1115; /* deep dark background */ + } + + a { + color: #8ea2ff; + } + + a:hover { + color: #aab6ff; + } + + /* allow Puppertino to style .btn in dark mode */ + + .input-box .input { + background-color: #111827; /* gray-900 */ + color: #e5e7eb; + caret-color: #ffffff; + border: 1px solid #374151; /* slate-700 */ + } + + .input-box .input:hover, + .input-box .input:focus { + background-color: #0b1220; + border-color: #4b5563; /* slate-600 */ + } + + /* allow Puppertino to handle active state */ +} + +/* Mobile baseline overrides (apply to both light and dark) */ +@media (max-width: 768px) { + /* Prevent iOS zoom on focus */ + input, textarea, select, button { font-size: 16px; } + + /* Make layout vertical and scrollable */ + html, body { + height: auto; + min-height: 100svh; + overflow-x: hidden; + overflow-y: auto; + -webkit-overflow-scrolling: touch; + } + + body { + padding-top: env(safe-area-inset-top); + padding-bottom: env(safe-area-inset-bottom); + position: static; + } + + .container { + width: 100%; + max-width: 520px; /* allow a bit wider on phones */ + align-items: stretch; + } + + /* Stack controls vertically with full-width tap targets */ + .input-box { + display: flex; + flex-direction: column; + align-items: stretch; + gap: 10px; + } + + .input-box .input, + .input, + button, + .p-btn { + width: 100%; + min-height: 44px; /* comfortable touch target */ + } + + /* Tabs vertical and full-width */ + .tabs { + display: grid; + grid-template-columns: 1fr; + gap: 8px; + } + .tabs .p-btn { width: 100%; } + + /* Cap device info height for readability */ + #deviceInfo { + max-height: 30vh; + overflow: auto; + padding: 8px; + border-radius: 8px; + background: rgba(0,0,0,0.04); + } +} \ No newline at end of file diff --git a/v3/examples/ios/frontend/public/wails.png b/v3/examples/ios/frontend/public/wails.png new file mode 100644 index 000000000..8bdf42483 Binary files /dev/null and b/v3/examples/ios/frontend/public/wails.png differ diff --git a/v3/examples/ios/frontend/vite.config.js b/v3/examples/ios/frontend/vite.config.js new file mode 100644 index 000000000..87b093bc3 --- /dev/null +++ b/v3/examples/ios/frontend/vite.config.js @@ -0,0 +1,11 @@ +import { defineConfig } from 'vite'; +import path from 'path'; + +export default defineConfig({ + resolve: { + alias: { + // Use the local repo runtime sources instead of the published package + '@wailsio/runtime': path.resolve(__dirname, '../../../internal/runtime/desktop/@wailsio/runtime/src/index.ts'), + }, + }, +}); diff --git a/v3/examples/ios/go.mod b/v3/examples/ios/go.mod new file mode 100644 index 000000000..d2e86c73a --- /dev/null +++ b/v3/examples/ios/go.mod @@ -0,0 +1,49 @@ +module ios-example + +go 1.25 + +require github.com/wailsapp/wails/v3 v3.0.0-dev + +require ( + dario.cat/mergo v1.0.2 // indirect + github.com/Microsoft/go-winio v0.6.2 // indirect + github.com/ProtonMail/go-crypto v1.3.0 // indirect + github.com/adrg/xdg v0.5.3 // indirect + github.com/bep/debounce v1.2.1 // indirect + github.com/cloudflare/circl v1.6.3 // indirect + github.com/coder/websocket v1.8.14 // indirect + github.com/cyphar/filepath-securejoin v0.6.1 // indirect + github.com/ebitengine/purego v0.9.1 // indirect + github.com/emirpasic/gods v1.18.1 // indirect + github.com/go-git/gcfg v1.5.1-0.20230307220236-3a3c6141e376 // indirect + github.com/go-git/go-billy/v5 v5.7.0 // indirect + github.com/go-git/go-git/v5 v5.16.4 // indirect + github.com/go-ole/go-ole v1.3.0 // indirect + github.com/godbus/dbus/v5 v5.2.2 // indirect + github.com/golang/groupcache v0.0.0-20241129210726-2c02b8208cf8 // indirect + github.com/google/uuid v1.6.0 // indirect + github.com/jbenet/go-context v0.0.0-20150711004518-d14ea06fba99 // indirect + github.com/jchv/go-winloader v0.0.0-20250406163304-c1995be93bd1 // indirect + github.com/kevinburke/ssh_config v1.4.0 // indirect + github.com/klauspost/cpuid/v2 v2.3.0 // indirect + github.com/leaanthony/go-ansi-parser v1.6.1 // indirect + github.com/leaanthony/u v1.1.1 // indirect + github.com/lmittmann/tint v1.1.2 // indirect + github.com/mattn/go-colorable v0.1.14 // indirect + github.com/mattn/go-isatty v0.0.20 // indirect + github.com/pjbgf/sha1cd v0.5.0 // indirect + github.com/pkg/browser v0.0.0-20240102092130-5ac0b6a4141c // indirect + github.com/rivo/uniseg v0.4.7 // indirect + github.com/samber/lo v1.52.0 // indirect + github.com/sergi/go-diff v1.4.0 // indirect + github.com/skeema/knownhosts v1.3.2 // indirect + github.com/wailsapp/go-webview2 v1.0.23 // indirect + github.com/xanzy/ssh-agent v0.3.3 // indirect + golang.org/x/crypto v0.47.0 // indirect + golang.org/x/net v0.49.0 // indirect + golang.org/x/sys v0.40.0 // indirect + golang.org/x/text v0.33.0 // indirect + gopkg.in/warnings.v0 v0.1.2 // indirect +) + +replace github.com/wailsapp/wails/v3 => ../../../v3 diff --git a/v3/examples/ios/go.sum b/v3/examples/ios/go.sum new file mode 100644 index 000000000..56f1153ea --- /dev/null +++ b/v3/examples/ios/go.sum @@ -0,0 +1,147 @@ +dario.cat/mergo v1.0.2 h1:85+piFYR1tMbRrLcDwR18y4UKJ3aH1Tbzi24VRW1TK8= +dario.cat/mergo v1.0.2/go.mod h1:E/hbnu0NxMFBjpMIE34DRGLWqDy0g5FuKDhCb31ngxA= +github.com/Microsoft/go-winio v0.5.2/go.mod h1:WpS1mjBmmwHBEWmogvA2mj8546UReBk4v8QkMxJ6pZY= +github.com/Microsoft/go-winio v0.6.2 h1:F2VQgta7ecxGYO8k3ZZz3RS8fVIXVxONVUPlNERoyfY= +github.com/Microsoft/go-winio v0.6.2/go.mod h1:yd8OoFMLzJbo9gZq8j5qaps8bJ9aShtEA8Ipt1oGCvU= +github.com/ProtonMail/go-crypto v1.3.0 h1:ILq8+Sf5If5DCpHQp4PbZdS1J7HDFRXz/+xKBiRGFrw= +github.com/ProtonMail/go-crypto v1.3.0/go.mod h1:9whxjD8Rbs29b4XWbB8irEcE8KHMqaR2e7GWU1R+/PE= +github.com/adrg/xdg v0.5.3 h1:xRnxJXne7+oWDatRhR1JLnvuccuIeCoBu2rtuLqQB78= +github.com/adrg/xdg v0.5.3/go.mod h1:nlTsY+NNiCBGCK2tpm09vRqfVzrc2fLmXGpBLF0zlTQ= +github.com/anmitsu/go-shlex v0.0.0-20200514113438-38f4b401e2be h1:9AeTilPcZAjCFIImctFaOjnTIavg87rW78vTPkQqLI8= +github.com/anmitsu/go-shlex v0.0.0-20200514113438-38f4b401e2be/go.mod h1:ySMOLuWl6zY27l47sB3qLNK6tF2fkHG55UZxx8oIVo4= +github.com/armon/go-socks5 v0.0.0-20160902184237-e75332964ef5 h1:0CwZNZbxp69SHPdPJAN/hZIm0C4OItdklCFmMRWYpio= +github.com/armon/go-socks5 v0.0.0-20160902184237-e75332964ef5/go.mod h1:wHh0iHkYZB8zMSxRWpUBQtwG5a7fFgvEO+odwuTv2gs= +github.com/bep/debounce v1.2.1 h1:v67fRdBA9UQu2NhLFXrSg0Brw7CexQekrBwDMM8bzeY= +github.com/bep/debounce v1.2.1/go.mod h1:H8yggRPQKLUhUoqrJC1bO2xNya7vanpDl7xR3ISbCJ0= +github.com/cloudflare/circl v1.6.3 h1:9GPOhQGF9MCYUeXyMYlqTR6a5gTrgR/fBLXvUgtVcg8= +github.com/cloudflare/circl v1.6.3/go.mod h1:2eXP6Qfat4O/Yhh8BznvKnJ+uzEoTQ6jVKJRn81BiS4= +github.com/coder/websocket v1.8.14 h1:9L0p0iKiNOibykf283eHkKUHHrpG7f65OE3BhhO7v9g= +github.com/coder/websocket v1.8.14/go.mod h1:NX3SzP+inril6yawo5CQXx8+fk145lPDC6pumgx0mVg= +github.com/cyphar/filepath-securejoin v0.6.1 h1:5CeZ1jPXEiYt3+Z6zqprSAgSWiggmpVyciv8syjIpVE= +github.com/cyphar/filepath-securejoin v0.6.1/go.mod h1:A8hd4EnAeyujCJRrICiOWqjS1AX0a9kM5XL+NwKoYSc= +github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= +github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c= +github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= +github.com/ebitengine/purego v0.9.1 h1:a/k2f2HQU3Pi399RPW1MOaZyhKJL9w/xFpKAg4q1s0A= +github.com/ebitengine/purego v0.9.1/go.mod h1:iIjxzd6CiRiOG0UyXP+V1+jWqUXVjPKLAI0mRfJZTmQ= +github.com/elazarl/goproxy v1.7.2 h1:Y2o6urb7Eule09PjlhQRGNsqRfPmYI3KKQLFpCAV3+o= +github.com/elazarl/goproxy v1.7.2/go.mod h1:82vkLNir0ALaW14Rc399OTTjyNREgmdL2cVoIbS6XaE= +github.com/emirpasic/gods v1.18.1 h1:FXtiHYKDGKCW2KzwZKx0iC0PQmdlorYgdFG9jPXJ1Bc= +github.com/emirpasic/gods v1.18.1/go.mod h1:8tpGGwCnJ5H4r6BWwaV6OrWmMoPhUl5jm/FMNAnJvWQ= +github.com/gliderlabs/ssh v0.3.8 h1:a4YXD1V7xMF9g5nTkdfnja3Sxy1PVDCj1Zg4Wb8vY6c= +github.com/gliderlabs/ssh v0.3.8/go.mod h1:xYoytBv1sV0aL3CavoDuJIQNURXkkfPA/wxQ1pL1fAU= +github.com/go-git/gcfg v1.5.1-0.20230307220236-3a3c6141e376 h1:+zs/tPmkDkHx3U66DAb0lQFJrpS6731Oaa12ikc+DiI= +github.com/go-git/gcfg v1.5.1-0.20230307220236-3a3c6141e376/go.mod h1:an3vInlBmSxCcxctByoQdvwPiA7DTK7jaaFDBTtu0ic= +github.com/go-git/go-billy/v5 v5.7.0 h1:83lBUJhGWhYp0ngzCMSgllhUSuoHP1iEWYjsPl9nwqM= +github.com/go-git/go-billy/v5 v5.7.0/go.mod h1:/1IUejTKH8xipsAcdfcSAlUlo2J7lkYV8GTKxAT/L3E= +github.com/go-git/go-git-fixtures/v4 v4.3.2-0.20231010084843-55a94097c399 h1:eMje31YglSBqCdIqdhKBW8lokaMrL3uTkpGYlE2OOT4= +github.com/go-git/go-git-fixtures/v4 v4.3.2-0.20231010084843-55a94097c399/go.mod h1:1OCfN199q1Jm3HZlxleg+Dw/mwps2Wbk9frAWm+4FII= +github.com/go-git/go-git/v5 v5.16.4 h1:7ajIEZHZJULcyJebDLo99bGgS0jRrOxzZG4uCk2Yb2Y= +github.com/go-git/go-git/v5 v5.16.4/go.mod h1:4Ge4alE/5gPs30F2H1esi2gPd69R0C39lolkucHBOp8= +github.com/go-json-experiment/json v0.0.0-20251027170946-4849db3c2f7e h1:Lf/gRkoycfOBPa42vU2bbgPurFong6zXeFtPoxholzU= +github.com/go-json-experiment/json v0.0.0-20251027170946-4849db3c2f7e/go.mod h1:uNVvRXArCGbZ508SxYYTC5v1JWoz2voff5pm25jU1Ok= +github.com/go-ole/go-ole v1.3.0 h1:Dt6ye7+vXGIKZ7Xtk4s6/xVdGDQynvom7xCFEdWr6uE= +github.com/go-ole/go-ole v1.3.0/go.mod h1:5LS6F96DhAwUc7C+1HLexzMXY1xGRSryjyPPKW6zv78= +github.com/godbus/dbus/v5 v5.2.2 h1:TUR3TgtSVDmjiXOgAAyaZbYmIeP3DPkld3jgKGV8mXQ= +github.com/godbus/dbus/v5 v5.2.2/go.mod h1:3AAv2+hPq5rdnr5txxxRwiGjPXamgoIHgz9FPBfOp3c= +github.com/golang/groupcache v0.0.0-20241129210726-2c02b8208cf8 h1:f+oWsMOmNPc8JmEHVZIycC7hBoQxHH9pNKQORJNozsQ= +github.com/golang/groupcache v0.0.0-20241129210726-2c02b8208cf8/go.mod h1:wcDNUvekVysuuOpQKo3191zZyTpiI6se1N1ULghS0sw= +github.com/google/go-cmp v0.7.0 h1:wk8382ETsv4JYUZwIsn6YpYiWiBsYLSJiTsyBybVuN8= +github.com/google/go-cmp v0.7.0/go.mod h1:pXiqmnSA92OHEEa9HXL2W4E7lf9JzCmGVUdgjX3N/iU= +github.com/google/uuid v1.6.0 h1:NIvaJDMOsjHA8n1jAhLSgzrAzy1Hgr+hNrb57e+94F0= +github.com/google/uuid v1.6.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo= +github.com/jbenet/go-context v0.0.0-20150711004518-d14ea06fba99 h1:BQSFePA1RWJOlocH6Fxy8MmwDt+yVQYULKfN0RoTN8A= +github.com/jbenet/go-context v0.0.0-20150711004518-d14ea06fba99/go.mod h1:1lJo3i6rXxKeerYnT8Nvf0QmHCRC1n8sfWVwXF2Frvo= +github.com/jchv/go-winloader v0.0.0-20250406163304-c1995be93bd1 h1:njuLRcjAuMKr7kI3D85AXWkw6/+v9PwtV6M6o11sWHQ= +github.com/jchv/go-winloader v0.0.0-20250406163304-c1995be93bd1/go.mod h1:alcuEEnZsY1WQsagKhZDsoPCRoOijYqhZvPwLG0kzVs= +github.com/kevinburke/ssh_config v1.4.0 h1:6xxtP5bZ2E4NF5tuQulISpTO2z8XbtH8cg1PWkxoFkQ= +github.com/kevinburke/ssh_config v1.4.0/go.mod h1:q2RIzfka+BXARoNexmF9gkxEX7DmvbW9P4hIVx2Kg4M= +github.com/klauspost/cpuid/v2 v2.3.0 h1:S4CRMLnYUhGeDFDqkGriYKdfoFlDnMtqTiI/sFzhA9Y= +github.com/klauspost/cpuid/v2 v2.3.0/go.mod h1:hqwkgyIinND0mEev00jJYCxPNVRVXFQeu1XKlok6oO0= +github.com/kr/pretty v0.1.0/go.mod h1:dAy3ld7l9f0ibDNOQOHHMYYIIbhfbHSm3C4ZsoJORNo= +github.com/kr/pretty v0.3.1 h1:flRD4NNwYAUpkphVc1HcthR4KEIFJ65n8Mw5qdRn3LE= +github.com/kr/pretty v0.3.1/go.mod h1:hoEshYVHaxMs3cyo3Yncou5ZscifuDolrwPKZanG3xk= +github.com/kr/pty v1.1.1/go.mod h1:pFQYn66WHrOpPYNljwOMqo10TkYh1fy3cYio2l3bCsQ= +github.com/kr/text v0.1.0/go.mod h1:4Jbv+DJW3UT/LiOwJeYQe1efqtUx/iVham/4vfdArNI= +github.com/kr/text v0.2.0 h1:5Nx0Ya0ZqY2ygV366QzturHI13Jq95ApcVaJBhpS+AY= +github.com/kr/text v0.2.0/go.mod h1:eLer722TekiGuMkidMxC/pM04lWEeraHUUmBw8l2grE= +github.com/leaanthony/go-ansi-parser v1.6.1 h1:xd8bzARK3dErqkPFtoF9F3/HgN8UQk0ed1YDKpEz01A= +github.com/leaanthony/go-ansi-parser v1.6.1/go.mod h1:+vva/2y4alzVmmIEpk9QDhA7vLC5zKDTRwfZGOp3IWU= +github.com/leaanthony/u v1.1.1 h1:TUFjwDGlNX+WuwVEzDqQwC2lOv0P4uhTQw7CMFdiK7M= +github.com/leaanthony/u v1.1.1/go.mod h1:9+o6hejoRljvZ3BzdYlVL0JYCwtnAsVuN9pVTQcaRfI= +github.com/lmittmann/tint v1.1.2 h1:2CQzrL6rslrsyjqLDwD11bZ5OpLBPU+g3G/r5LSfS8w= +github.com/lmittmann/tint v1.1.2/go.mod h1:HIS3gSy7qNwGCj+5oRjAutErFBl4BzdQP6cJZ0NfMwE= +github.com/matryer/is v1.4.0/go.mod h1:8I/i5uYgLzgsgEloJE1U6xx5HkBQpAZvepWuujKwMRU= +github.com/matryer/is v1.4.1 h1:55ehd8zaGABKLXQUe2awZ99BD/PTc2ls+KV/dXphgEQ= +github.com/matryer/is v1.4.1/go.mod h1:8I/i5uYgLzgsgEloJE1U6xx5HkBQpAZvepWuujKwMRU= +github.com/mattn/go-colorable v0.1.14 h1:9A9LHSqF/7dyVVX6g0U9cwm9pG3kP9gSzcuIPHPsaIE= +github.com/mattn/go-colorable v0.1.14/go.mod h1:6LmQG8QLFO4G5z1gPvYEzlUgJ2wF+stgPZH1UqBm1s8= +github.com/mattn/go-isatty v0.0.20 h1:xfD0iDuEKnDkl03q4limB+vH+GxLEtL/jb4xVJSWWEY= +github.com/mattn/go-isatty v0.0.20/go.mod h1:W+V8PltTTMOvKvAeJH7IuucS94S2C6jfK/D7dTCTo3Y= +github.com/onsi/gomega v1.34.1 h1:EUMJIKUjM8sKjYbtxQI9A4z2o+rruxnzNvpknOXie6k= +github.com/onsi/gomega v1.34.1/go.mod h1:kU1QgUvBDLXBJq618Xvm2LUX6rSAfRaFRTcdOeDLwwY= +github.com/pjbgf/sha1cd v0.5.0 h1:a+UkboSi1znleCDUNT3M5YxjOnN1fz2FhN48FlwCxs0= +github.com/pjbgf/sha1cd v0.5.0/go.mod h1:lhpGlyHLpQZoxMv8HcgXvZEhcGs0PG/vsZnEJ7H0iCM= +github.com/pkg/browser v0.0.0-20240102092130-5ac0b6a4141c h1:+mdjkGKdHQG3305AYmdv1U2eRNDiU2ErMBj1gwrq8eQ= +github.com/pkg/browser v0.0.0-20240102092130-5ac0b6a4141c/go.mod h1:7rwL4CYBLnjLxUqIJNnCWiEdr3bn6IUYi15bNlnbCCU= +github.com/pkg/errors v0.9.1 h1:FEBLx1zS214owpjy7qsBeixbURkuhQAwrK5UwLGTwt4= +github.com/pkg/errors v0.9.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0= +github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM= +github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= +github.com/rivo/uniseg v0.2.0/go.mod h1:J6wj4VEh+S6ZtnVlnTBMWIodfgj8LQOQFoIToxlJtxc= +github.com/rivo/uniseg v0.4.7 h1:WUdvkW8uEhrYfLC4ZzdpI2ztxP1I582+49Oc5Mq64VQ= +github.com/rivo/uniseg v0.4.7/go.mod h1:FN3SvrM+Zdj16jyLfmOkMNblXMcoc8DfTHruCPUcx88= +github.com/rogpeppe/go-internal v1.14.1 h1:UQB4HGPB6osV0SQTLymcB4TgvyWu6ZyliaW0tI/otEQ= +github.com/rogpeppe/go-internal v1.14.1/go.mod h1:MaRKkUm5W0goXpeCfT7UZI6fk/L7L7so1lCWt35ZSgc= +github.com/samber/lo v1.52.0 h1:Rvi+3BFHES3A8meP33VPAxiBZX/Aws5RxrschYGjomw= +github.com/samber/lo v1.52.0/go.mod h1:4+MXEGsJzbKGaUEQFKBq2xtfuznW9oz/WrgyzMzRoM0= +github.com/sergi/go-diff v1.4.0 h1:n/SP9D5ad1fORl+llWyN+D6qoUETXNZARKjyY2/KVCw= +github.com/sergi/go-diff v1.4.0/go.mod h1:A0bzQcvG0E7Rwjx0REVgAGH58e96+X0MeOfepqsbeW4= +github.com/sirupsen/logrus v1.7.0/go.mod h1:yWOB1SBYBC5VeMP7gHvWumXLIWorT60ONWic61uBYv0= +github.com/skeema/knownhosts v1.3.2 h1:EDL9mgf4NzwMXCTfaxSD/o/a5fxDw/xL9nkU28JjdBg= +github.com/skeema/knownhosts v1.3.2/go.mod h1:bEg3iQAuw+jyiw+484wwFJoKSLwcfd7fqRy+N0QTiow= +github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME= +github.com/stretchr/testify v1.2.2/go.mod h1:a8OnRcib4nhh0OaRAV+Yts87kKdq0PP7pXfy6kDkUVs= +github.com/stretchr/testify v1.4.0/go.mod h1:j7eGeouHqKxXV5pUuKE4zz7dFj8WfuZ+81PSLYec5m4= +github.com/stretchr/testify v1.11.1 h1:7s2iGBzp5EwR7/aIZr8ao5+dra3wiQyKjjFuvgVKu7U= +github.com/stretchr/testify v1.11.1/go.mod h1:wZwfW3scLgRK+23gO65QZefKpKQRnfz6sD981Nm4B6U= +github.com/wailsapp/go-webview2 v1.0.23 h1:jmv8qhz1lHibCc79bMM/a/FqOnnzOGEisLav+a0b9P0= +github.com/wailsapp/go-webview2 v1.0.23/go.mod h1:qJmWAmAmaniuKGZPWwne+uor3AHMB5PFhqiK0Bbj8kc= +github.com/xanzy/ssh-agent v0.3.3 h1:+/15pJfg/RsTxqYcX6fHqOXZwwMP+2VyYWJeWM2qQFM= +github.com/xanzy/ssh-agent v0.3.3/go.mod h1:6dzNDKs0J9rVPHPhaGCukekBHKqfl+L3KghI1Bc68Uw= +golang.org/x/crypto v0.0.0-20220622213112-05595931fe9d/go.mod h1:IxCIyHEi3zRg3s0A5j5BB6A9Jmi73HwBIUl50j+osU4= +golang.org/x/crypto v0.47.0 h1:V6e3FRj+n4dbpw86FJ8Fv7XVOql7TEwpHapKoMJ/GO8= +golang.org/x/crypto v0.47.0/go.mod h1:ff3Y9VzzKbwSSEzWqJsJVBnWmRwRSHt/6Op5n9bQc4A= +golang.org/x/exp v0.0.0-20260112195511-716be5621a96 h1:Z/6YuSHTLOHfNFdb8zVZomZr7cqNgTJvA8+Qz75D8gU= +golang.org/x/exp v0.0.0-20260112195511-716be5621a96/go.mod h1:nzimsREAkjBCIEFtHiYkrJyT+2uy9YZJB7H1k68CXZU= +golang.org/x/net v0.0.0-20211112202133-69e39bad7dc2/go.mod h1:9nx3DQGgdP8bBQD5qxJ1jj9UTztislL4KSBs9R2vV5Y= +golang.org/x/net v0.49.0 h1:eeHFmOGUTtaaPSGNmjBKpbng9MulQsJURQUAfUwY++o= +golang.org/x/net v0.49.0/go.mod h1:/ysNB2EvaqvesRkuLAyjI1ycPZlQHM3q01F02UY/MV8= +golang.org/x/sys v0.0.0-20191026070338-33540a1f6037/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20200810151505-1b9f1253b3ed/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20201119102817-f84b799fce68/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20210124154548-22da62e12c0c/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20210423082822-04245dca01da/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20210615035016-665e8c7367d1/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.0.0-20220715151400-c0bba94af5f8/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.1.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.6.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.40.0 h1:DBZZqJ2Rkml6QMQsZywtnjnnGvHza6BTfYFWY9kjEWQ= +golang.org/x/sys v0.40.0/go.mod h1:OgkHotnGiDImocRcuBABYBEXf8A9a87e/uXjp9XT3ks= +golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo= +golang.org/x/term v0.39.0 h1:RclSuaJf32jOqZz74CkPA9qFuVTX7vhLlpfj/IGWlqY= +golang.org/x/term v0.39.0/go.mod h1:yxzUCTP/U+FzoxfdKmLaA0RV1WgE0VY7hXBwKtY/4ww= +golang.org/x/text v0.3.6/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ= +golang.org/x/text v0.33.0 h1:B3njUFyqtHDUI5jMn1YIr5B0IE2U0qck04r6d4KPAxE= +golang.org/x/text v0.33.0/go.mod h1:LuMebE6+rBincTi9+xWTY8TztLzKHc/9C1uBCG27+q8= +golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ= +gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= +gopkg.in/check.v1 v1.0.0-20190902080502-41f04d3bba15/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= +gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c h1:Hei/4ADfdWqJk1ZMxUNpqntNwaWcugrBjAiHlqqRiVk= +gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c/go.mod h1:JHkPIbrfpd72SG/EVd6muEfDQjcINNoR0C8j2r3qZ4Q= +gopkg.in/warnings.v0 v0.1.2 h1:wFXVbFY8DY5/xOe1ECiWdKCzZlxgshcYVNkBHstARME= +gopkg.in/warnings.v0 v0.1.2/go.mod h1:jksf8JmL6Qr/oQM2OXTHunEvvTAsrWBLb6OOjuVWRNI= +gopkg.in/yaml.v2 v2.2.2/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI= +gopkg.in/yaml.v2 v2.4.0/go.mod h1:RDklbk79AGWmwhnvt/jBztapEOGDOx6ZbXqjP6csGnQ= +gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA= +gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= diff --git a/v3/examples/ios/greetservice.go b/v3/examples/ios/greetservice.go new file mode 100644 index 000000000..8972c39cd --- /dev/null +++ b/v3/examples/ios/greetservice.go @@ -0,0 +1,7 @@ +package main + +type GreetService struct{} + +func (g *GreetService) Greet(name string) string { + return "Hello " + name + "!" +} diff --git a/v3/examples/ios/ios_runtime_events_ios.go b/v3/examples/ios/ios_runtime_events_ios.go new file mode 100644 index 000000000..99ccf66d4 --- /dev/null +++ b/v3/examples/ios/ios_runtime_events_ios.go @@ -0,0 +1,62 @@ +//go:build ios + +package main + +import ( + "github.com/wailsapp/wails/v3/pkg/application" +) + +// registerIOSRuntimeEventHandlers registers Go-side event listeners that mutate iOS WKWebView at runtime. +func registerIOSRuntimeEventHandlers(app *application.App) { + // Helper to fetch boolean from event data. Accepts {"enabled":bool} or a bare bool. + getBool := func(data any, key string, def bool) bool { + switch v := data.(type) { + case bool: + return v + case map[string]any: + if raw, ok := v[key]; ok { + if b, ok := raw.(bool); ok { + return b + } + } + } + return def + } + // Helper to fetch string from event data. Accepts {"ua":string} or bare string. + getString := func(data any, key string) string { + switch v := data.(type) { + case string: + return v + case map[string]any: + if raw, ok := v[key]; ok { + if s, ok := raw.(string); ok { + return s + } + } + } + return "" + } + + app.Event.On("ios:setScrollEnabled", func(e *application.CustomEvent) { + application.IOSSetScrollEnabled(getBool(e.Data, "enabled", true)) + }) + app.Event.On("ios:setBounceEnabled", func(e *application.CustomEvent) { + application.IOSSetBounceEnabled(getBool(e.Data, "enabled", true)) + }) + app.Event.On("ios:setScrollIndicatorsEnabled", func(e *application.CustomEvent) { + application.IOSSetScrollIndicatorsEnabled(getBool(e.Data, "enabled", true)) + }) + app.Event.On("ios:setBackForwardGesturesEnabled", func(e *application.CustomEvent) { + application.IOSSetBackForwardGesturesEnabled(getBool(e.Data, "enabled", false)) + }) + app.Event.On("ios:setLinkPreviewEnabled", func(e *application.CustomEvent) { + application.IOSSetLinkPreviewEnabled(getBool(e.Data, "enabled", true)) + }) + app.Event.On("ios:setInspectableEnabled", func(e *application.CustomEvent) { + application.IOSSetInspectableEnabled(getBool(e.Data, "enabled", true)) + }) + app.Event.On("ios:setCustomUserAgent", func(e *application.CustomEvent) { + ua := getString(e.Data, "ua") + application.IOSSetCustomUserAgent(ua) + }) +} diff --git a/v3/examples/ios/ios_runtime_events_stub.go b/v3/examples/ios/ios_runtime_events_stub.go new file mode 100644 index 000000000..4c7376d7d --- /dev/null +++ b/v3/examples/ios/ios_runtime_events_stub.go @@ -0,0 +1,8 @@ +//go:build !ios + +package main + +import "github.com/wailsapp/wails/v3/pkg/application" + +// Non-iOS: no-op so examples build on other platforms +func registerIOSRuntimeEventHandlers(app *application.App) {} diff --git a/v3/examples/ios/main.go b/v3/examples/ios/main.go new file mode 100644 index 000000000..f49b73cd8 --- /dev/null +++ b/v3/examples/ios/main.go @@ -0,0 +1,88 @@ +package main + +import ( + "embed" + _ "embed" + "log" + "time" + + "github.com/wailsapp/wails/v3/pkg/application" +) + +// Wails uses Go's `embed` package to embed the frontend files into the binary. +// Any files in the frontend/dist folder will be embedded into the binary and +// made available to the frontend. +// See https://pkg.go.dev/embed for more information. + +//go:embed all:frontend/dist +var assets embed.FS + +// main function serves as the application's entry point. It initializes the application, creates a window, +// and starts a goroutine that emits a time-based event every second. It subsequently runs the application and +// logs any error that might occur. +func main() { + + // Create a new Wails application by providing the necessary options. + // Variables 'Name' and 'Description' are for application metadata. + // 'Assets' configures the asset server with the 'FS' variable pointing to the frontend files. + // 'Bind' is a list of Go struct instances. The frontend has access to the methods of these instances. + // 'Mac' options tailor the application when running an macOS. + app := application.New(application.Options{ + Name: "ios", + Description: "A demo of using raw HTML & CSS", + Services: []application.Service{ + application.NewService(&GreetService{}), + }, + Assets: application.AssetOptions{ + Handler: application.AssetFileServerFS(assets), + }, + Mac: application.MacOptions{ + ApplicationShouldTerminateAfterLastWindowClosed: true, + }, + IOS: application.IOSOptions{ + EnableNativeTabs: true, + NativeTabsItems: []application.NativeTabItem{ + {Title: "Home", SystemImage: "house"}, + {Title: "Settings", SystemImage: "gear"}, + }, + }, + }) + + // Register iOS runtime event handlers so the frontend can emit events + // to toggle WKWebView settings at runtime (Go path). + registerIOSRuntimeEventHandlers(app) + + // Create a new window with the necessary options. + // 'Title' is the title of the window. + // 'Mac' options tailor the window when running on macOS. + // 'BackgroundColour' is the background colour of the window. + // 'URL' is the URL that will be loaded into the webview. + app.Window.NewWithOptions(application.WebviewWindowOptions{ + Title: "Window 1", + Mac: application.MacWindow{ + InvisibleTitleBarHeight: 50, + Backdrop: application.MacBackdropTranslucent, + TitleBar: application.MacTitleBarHiddenInset, + }, + BackgroundColour: application.NewRGB(27, 38, 54), + URL: "/", + }) + + // Create a goroutine that emits an event containing the current time every second. + // The frontend can listen to this event and update the UI accordingly. + go func() { + for { + now := time.Now().Format(time.RFC1123) + app.Event.Emit("time", now) + time.Sleep(time.Second) + } + }() + + // Run the application. This blocks until the application has been exited. + err := app.Run() + + // If an error occurred while running the application, log it and exit. + if err != nil { + log.Fatal(err) + } +} diff --git a/v3/examples/keybindings/README.md b/v3/examples/keybindings/README.md new file mode 100644 index 000000000..2180cc9d0 --- /dev/null +++ b/v3/examples/keybindings/README.md @@ -0,0 +1,21 @@ +# Keybindings Example + +This simple example demonstrates how to use keybindings in your application. +Run the example and press `Ctrl/CMD+Shift+C` to center the focused window. + +## Running the example + +To run the example, simply run the following command: + +```bash +go run . +``` + +# Status + +| Platform | Status | +|----------|---------| +| Mac | Working | +| Windows | Working | +| Linux | | + diff --git a/v3/examples/keybindings/main.go b/v3/examples/keybindings/main.go new file mode 100644 index 000000000..b07bf366b --- /dev/null +++ b/v3/examples/keybindings/main.go @@ -0,0 +1,50 @@ +package main + +import ( + _ "embed" + "github.com/wailsapp/wails/v3/pkg/application" + "log" +) + +func main() { + app := application.New(application.Options{ + Name: "Key Bindings Demo", + Description: "A demo of the Key Bindings Options", + Mac: application.MacOptions{ + ApplicationShouldTerminateAfterLastWindowClosed: true, + }, + KeyBindings: map[string]func(window application.Window){ + "shift+ctrl+c": func(window application.Window) { + window.Center() + }, + }, + }) + + app.Window.NewWithOptions(application.WebviewWindowOptions{ + Name: "Window 1", + Title: "Window 1", + URL: "https://wails.io", + KeyBindings: map[string]func(window application.Window){ + "F12": func(window application.Window) { + window.OpenDevTools() + }, + }, + }) + + app.Window.NewWithOptions(application.WebviewWindowOptions{ + Name: "Window 2", + Title: "Window 2", + URL: "https://google.com", + KeyBindings: map[string]func(window application.Window){ + "F12": func(window application.Window) { + println("Window 2: Toggle Dev Tools") + }, + }, + }) + + err := app.Run() + if err != nil { + log.Fatal(err) + } + +} diff --git a/v3/examples/linux_status.org b/v3/examples/linux_status.org new file mode 100644 index 000000000..fdb31ac27 --- /dev/null +++ b/v3/examples/linux_status.org @@ -0,0 +1,28 @@ + +* Status + +| Example | Status | Notes | +|--------------+-----------------+-------------------------------------------------------------------------------| +| binding | works | | +| build | works | removed OS X specific env variables from default target | +| clipboard | works | | +| contextmenus | works (partial) | | +| dev | works | purpose? | +| dialogs | | broken | +| drag-n-drop | works | | +| events | partial | receives WailsEvents - not ApplicationEvents | +| frameless | partial | drag areas do not function | +| hide-window | partial | crash on windowShow - believe this is because window is being destroyed not hidden | +| keybindings | working | | +| menu | working | Lock WebviewWindow Resize isn't correct | +| oauth | failed | Can't type in window - but can paste - redirect failed as well | +| plain | works | | +| plugins | works | Might should provide example commands or something. | +| screen | failed | | +| server | works | | +| systray | works | | +| video | works | binary is named 'frameless' | +| window | partial | Screens related stuff isn't implemented | +| wml | partial | | + + diff --git a/v3/examples/liquid-glass/.gitignore b/v3/examples/liquid-glass/.gitignore new file mode 100644 index 000000000..45d2406b0 --- /dev/null +++ b/v3/examples/liquid-glass/.gitignore @@ -0,0 +1 @@ +liquid-glass-demo diff --git a/v3/examples/liquid-glass/README.md b/v3/examples/liquid-glass/README.md new file mode 100644 index 000000000..33875af54 --- /dev/null +++ b/v3/examples/liquid-glass/README.md @@ -0,0 +1,70 @@ +# Liquid Glass Demo for Wails v3 + +This demo showcases the native Liquid Glass effect available in macOS 15.0+ with fallback to NSVisualEffectView for older systems. + +## Features Demonstrated + +### Window Styles + +1. **Light Glass** - Clean, light appearance with no tint +2. **Dark Glass** - Dark themed glass effect +3. **Vibrant Glass** - Enhanced vibrant effect for maximum transparency +4. **Tinted Glass** - Blue tinted glass with custom RGBA color +5. **Sheet Material** - Using specific NSVisualEffectMaterialSheet +6. **HUD Window** - Ultra-light HUD window material +7. **Content Background** - Content background material with warm tint + +### Customization Options + +- **Style**: `LiquidGlassStyleAutomatic`, `LiquidGlassStyleLight`, `LiquidGlassStyleDark`, `LiquidGlassStyleVibrant` +- **Material**: Direct NSVisualEffectMaterial selection (when NSGlassEffectView is not available) + - `NSVisualEffectMaterialAppearanceBased` + - `NSVisualEffectMaterialLight` + - `NSVisualEffectMaterialDark` + - `NSVisualEffectMaterialSheet` + - `NSVisualEffectMaterialHUDWindow` + - `NSVisualEffectMaterialContentBackground` + - `NSVisualEffectMaterialUnderWindowBackground` + - `NSVisualEffectMaterialUnderPageBackground` + - And more... +- **CornerRadius**: Rounded corners (0 for square corners) +- **TintColor**: Custom RGBA tint overlay +- **GroupID**: For grouping multiple glass windows (future feature) +- **GroupSpacing**: Spacing between grouped windows (future feature) + +### Running the Demo + +```bash +go build -o liquid-glass-demo . +./liquid-glass-demo +``` + +### Requirements + +- macOS 10.14+ (best experience on macOS 26.0+ with native NSGlassEffectView) +- Wails v3 + +### Implementation Details + +The implementation uses: +- Native `NSGlassEffectView` on macOS 26.0+ for authentic glass effect +- Falls back to `NSVisualEffectView` on older systems +- Runtime detection using `NSClassFromString` for compatibility +- Key-Value Coding (KVC) for dynamic property setting + +### Example Usage + +```go +window := app.Window.NewWithOptions(application.WebviewWindowOptions{ + Mac: application.MacWindow{ + Backdrop: application.MacBackdropLiquidGlass, + InvisibleTitleBarHeight: 500, // Make window draggable + LiquidGlass: application.MacLiquidGlass{ + Style: application.LiquidGlassStyleLight, + Material: application.NSVisualEffectMaterialHUDWindow, + CornerRadius: 20.0, + TintColor: &application.RGBA{Red: 0, Green: 100, Blue: 200, Alpha: 50}, + }, + }, +}) +``` \ No newline at end of file diff --git a/v3/examples/liquid-glass/index.html b/v3/examples/liquid-glass/index.html new file mode 100644 index 000000000..7f9ff4545 --- /dev/null +++ b/v3/examples/liquid-glass/index.html @@ -0,0 +1,50 @@ + + + + + + Wails Liquid Glass + + + +
            + +

            LIQUID GLASS

            +
            + + \ No newline at end of file diff --git a/v3/examples/liquid-glass/main.go b/v3/examples/liquid-glass/main.go new file mode 100644 index 000000000..61f338b96 --- /dev/null +++ b/v3/examples/liquid-glass/main.go @@ -0,0 +1,237 @@ +package main + +import ( + _ "embed" + "encoding/base64" + "fmt" + "log" + "runtime" + "strings" + + "github.com/wailsapp/wails/v3/pkg/application" +) + +//go:embed index.html +var indexHTML string + +//go:embed wails-logo.png +var wailsLogo []byte + +func main() { + app := application.New(application.Options{ + Name: "Wails Liquid Glass Demo", + Description: "Demonstrates the native Liquid Glass effect on macOS", + }) + + // Check if running on macOS + if runtime.GOOS != "darwin" { + // Show dialog for non-macOS platforms + app.Dialog.Info(). + SetTitle("macOS Only Demo"). + SetMessage("The Liquid Glass effect is a macOS-specific feature that uses native NSGlassEffectView (macOS 15.0+) or NSVisualEffectView.\n\nThis demo is not available on " + runtime.GOOS + "."). + Show() + fmt.Println("The Liquid Glass effect is a macOS-specific feature. This demo is not available on", runtime.GOOS) + return + } + + // Convert logo to base64 data URI + logoDataURI := "data:image/png;base64," + base64.StdEncoding.EncodeToString(wailsLogo) + + // Create different HTML for each window + lightHTML := strings.Replace(indexHTML, "wails-logo.png", logoDataURI, 1) + lightHTML = strings.Replace(lightHTML, "LIQUID GLASS", "Light Style", 1) + + darkHTML := strings.Replace(indexHTML, "wails-logo.png", logoDataURI, 1) + darkHTML = strings.Replace(darkHTML, "LIQUID GLASS", "Dark Style", 1) + + vibrantHTML := strings.Replace(indexHTML, "wails-logo.png", logoDataURI, 1) + vibrantHTML = strings.Replace(vibrantHTML, "LIQUID GLASS", "Vibrant Style", 1) + + tintedHTML := strings.Replace(indexHTML, "wails-logo.png", logoDataURI, 1) + tintedHTML = strings.Replace(tintedHTML, "LIQUID GLASS", "Blue Tint", 1) + + sheetHTML := strings.Replace(indexHTML, "wails-logo.png", logoDataURI, 1) + sheetHTML = strings.Replace(sheetHTML, "LIQUID GLASS", "Sheet Material", 1) + + hudHTML := strings.Replace(indexHTML, "wails-logo.png", logoDataURI, 1) + hudHTML = strings.Replace(hudHTML, "LIQUID GLASS", "HUD Window", 1) + + contentHTML := strings.Replace(indexHTML, "wails-logo.png", logoDataURI, 1) + contentHTML = strings.Replace(contentHTML, "LIQUID GLASS", "Content Background", 1) + + // Window 1: Light style with no tint + window1 := app.Window.NewWithOptions(application.WebviewWindowOptions{ + Title: "Light Glass", + Width: 350, + Height: 280, + X: 100, + Y: 100, + Frameless: true, + EnableFileDrop: false, + HTML: lightHTML, + InitialPosition: application.WindowXY, + Mac: application.MacWindow{ + Backdrop: application.MacBackdropLiquidGlass, + InvisibleTitleBarHeight: 500, + LiquidGlass: application.MacLiquidGlass{ + Style: application.LiquidGlassStyleLight, + Material: application.NSVisualEffectMaterialAuto, + CornerRadius: 20.0, + TintColor: nil, + }, + }, + }) + + // Window 2: Dark style + window2 := app.Window.NewWithOptions(application.WebviewWindowOptions{ + Title: "Dark Glass", + Width: 350, + Height: 280, + X: 500, + Y: 100, + Frameless: true, + EnableFileDrop: false, + HTML: darkHTML, + InitialPosition: application.WindowXY, + Mac: application.MacWindow{ + Backdrop: application.MacBackdropLiquidGlass, + InvisibleTitleBarHeight: 500, + LiquidGlass: application.MacLiquidGlass{ + Style: application.LiquidGlassStyleDark, + Material: application.NSVisualEffectMaterialAuto, + CornerRadius: 20.0, + TintColor: nil, + }, + }, + }) + + // Window 3: Vibrant style + window3 := app.Window.NewWithOptions(application.WebviewWindowOptions{ + Title: "Vibrant Glass", + Width: 350, + Height: 280, + X: 900, + Y: 100, + Frameless: true, + EnableFileDrop: false, + HTML: vibrantHTML, + InitialPosition: application.WindowXY, + Mac: application.MacWindow{ + Backdrop: application.MacBackdropLiquidGlass, + InvisibleTitleBarHeight: 500, + LiquidGlass: application.MacLiquidGlass{ + Style: application.LiquidGlassStyleVibrant, + Material: application.NSVisualEffectMaterialAuto, + CornerRadius: 20.0, + TintColor: nil, + }, + }, + }) + + // Window 4: Blue tinted glass + window4 := app.Window.NewWithOptions(application.WebviewWindowOptions{ + Title: "Tinted Glass", + Width: 350, + Height: 280, + X: 300, + Y: 420, + Frameless: true, + EnableFileDrop: false, + HTML: tintedHTML, + InitialPosition: application.WindowXY, + Mac: application.MacWindow{ + Backdrop: application.MacBackdropLiquidGlass, + InvisibleTitleBarHeight: 500, + LiquidGlass: application.MacLiquidGlass{ + Style: application.LiquidGlassStyleLight, + Material: application.NSVisualEffectMaterialAuto, + CornerRadius: 25.0, // Different corner radius + TintColor: &application.RGBA{Red: 0, Green: 100, Blue: 200, Alpha: 50}, // Blue tint + }, + }, + }) + + // Window 5: Using specific NSVisualEffectMaterial + window5 := app.Window.NewWithOptions(application.WebviewWindowOptions{ + Title: "Sheet Material", + Width: 350, + Height: 280, + X: 700, + Y: 420, + Frameless: true, + EnableFileDrop: false, + HTML: sheetHTML, + InitialPosition: application.WindowXY, + Mac: application.MacWindow{ + Backdrop: application.MacBackdropLiquidGlass, + InvisibleTitleBarHeight: 500, + LiquidGlass: application.MacLiquidGlass{ + Style: application.LiquidGlassStyleAutomatic, // Automatic style + Material: application.NSVisualEffectMaterialSheet, // Specific material + CornerRadius: 15.0, // Different corner radius + TintColor: nil, + }, + }, + }) + + // Window 6: HUD Window Material (very light, translucent) + window6 := app.Window.NewWithOptions(application.WebviewWindowOptions{ + Title: "HUD Window", + Width: 350, + Height: 280, + X: 100, + Y: 740, + Frameless: true, + EnableFileDrop: false, + HTML: hudHTML, + InitialPosition: application.WindowXY, + Mac: application.MacWindow{ + Backdrop: application.MacBackdropLiquidGlass, + InvisibleTitleBarHeight: 500, + LiquidGlass: application.MacLiquidGlass{ + Style: application.LiquidGlassStyleAutomatic, + Material: application.NSVisualEffectMaterialHUDWindow, // HUD Window material - very light + CornerRadius: 30.0, // Larger corner radius + TintColor: nil, + }, + }, + }) + + // Window 7: Content Background Material + window7 := app.Window.NewWithOptions(application.WebviewWindowOptions{ + Title: "Content Background", + Width: 350, + Height: 280, + X: 500, + Y: 740, + Frameless: true, + EnableFileDrop: false, + HTML: contentHTML, + InitialPosition: application.WindowXY, + Mac: application.MacWindow{ + Backdrop: application.MacBackdropLiquidGlass, + InvisibleTitleBarHeight: 500, + LiquidGlass: application.MacLiquidGlass{ + Style: application.LiquidGlassStyleAutomatic, + Material: application.NSVisualEffectMaterialContentBackground, // Content background + CornerRadius: 10.0, // Smaller corner radius + TintColor: &application.RGBA{Red: 0, Green: 200, Blue: 100, Alpha: 30}, // Warm tint + }, + }, + }) + + // Show all windows + window1.Show() + window2.Show() + window3.Show() + window4.Show() + window5.Show() + window6.Show() + window7.Show() + + // Run the application + err := app.Run() + if err != nil { + log.Fatal(err) + } +} diff --git a/v3/examples/liquid-glass/wails-logo.png b/v3/examples/liquid-glass/wails-logo.png new file mode 100644 index 000000000..e65c582ff Binary files /dev/null and b/v3/examples/liquid-glass/wails-logo.png differ diff --git a/v3/examples/menu/README.md b/v3/examples/menu/README.md new file mode 100644 index 000000000..cc926df73 --- /dev/null +++ b/v3/examples/menu/README.md @@ -0,0 +1,27 @@ +# Menu Example + +This example is a demonstration of different ways to create applications without using npm. + +## Running the example + +To run the example, simply run the following command: + +```bash +go run . +``` + +# Status + +| Platform | Status | +|----------|---------| +| Mac | Working | +| Windows | Working | +| Linux | | + +# Known Issues + +- [Resize cursor still visible when not resizable](https://github.com/orgs/wailsapp/projects/6/views/1?pane=issue&itemId=40962163) + +--- + +Icon attribution: [Click icons created by kusumapotter - Flaticon](https://www.flaticon.com/free-icons/click) \ No newline at end of file diff --git a/v3/examples/menu/icon.png b/v3/examples/menu/icon.png new file mode 100644 index 000000000..e934687ca Binary files /dev/null and b/v3/examples/menu/icon.png differ diff --git a/v3/examples/menu/main.go b/v3/examples/menu/main.go new file mode 100644 index 000000000..b034cbb68 --- /dev/null +++ b/v3/examples/menu/main.go @@ -0,0 +1,161 @@ +package main + +import ( + _ "embed" + "log" + "runtime" + + "github.com/wailsapp/wails/v3/pkg/application" +) + +//go:embed icon.png +var clickBitmap []byte + +func main() { + + app := application.New(application.Options{ + Name: "Menu Demo", + Description: "A demo of the menu system", + Assets: application.AlphaAssets, + Mac: application.MacOptions{ + ApplicationShouldTerminateAfterLastWindowClosed: true, + }, + }) + + // Create a custom menu + menu := app.NewMenu() + if runtime.GOOS == "darwin" { + menu.AddRole(application.AppMenu) + } + menu.AddRole(application.FileMenu) + menu.AddRole(application.EditMenu) + menu.AddRole(application.WindowMenu) + menu.AddRole(application.HelpMenu) + + // Let's make a "Demo" menu + myMenu := menu.AddSubmenu("Demo") + + // Hidden menu item that can be unhidden + hidden := myMenu.Add("I was hidden").SetHidden(true) + myMenu.Add("Toggle the hidden menu").OnClick(func(ctx *application.Context) { + hidden.SetHidden(!hidden.Hidden()) + }) + + // Disabled menu item + myMenu.Add("Not Enabled").SetEnabled(false) + + // Click callbacks + myMenu.Add("Click Me!").SetAccelerator("CmdOrCtrl+l").OnClick(func(ctx *application.Context) { + switch ctx.ClickedMenuItem().Label() { + case "Click Me!": + ctx.ClickedMenuItem().SetLabel("Thanks mate!") + case "Thanks mate!": + ctx.ClickedMenuItem().SetLabel("Click Me!") + } + }) + + // You can control the current window from the menu + myMenu.Add("Lock WebviewWindow Resize").OnClick(func(ctx *application.Context) { + if app.Window.Current().Resizable() { + app.Window.Current().SetResizable(false) + ctx.ClickedMenuItem().SetLabel("Unlock WebviewWindow Resize") + } else { + app.Window.Current().SetResizable(true) + ctx.ClickedMenuItem().SetLabel("Lock WebviewWindow Resize") + } + }) + + myMenu.AddSeparator() + + // Checkboxes will tell you their new state so you don't need to track it + myMenu.AddCheckbox("My checkbox", true).OnClick(func(context *application.Context) { + println("Clicked checkbox. Checked:", context.ClickedMenuItem().Checked()) + }) + myMenu.AddSeparator() + + // Callbacks can be shared. This is useful for radio groups + radioCallback := func(ctx *application.Context) { + menuItem := ctx.ClickedMenuItem() + menuItem.SetLabel(menuItem.Label() + "!") + } + + // Radio groups are created implicitly by placing radio items next to each other in a menu + myMenu.AddRadio("Radio 1", true).OnClick(radioCallback) + myMenu.AddRadio("Radio 2", false).OnClick(radioCallback) + myMenu.AddRadio("Radio 3", false).OnClick(radioCallback) + + // Submenus are also supported + submenu := myMenu.AddSubmenu("Submenu") + submenu.Add("Submenu item 1") + submenu.Add("Submenu item 2") + submenu.Add("Submenu item 3") + + myMenu.AddSeparator() + + beatles := myMenu.Add("Hello").OnClick(func(*application.Context) { + println("The beatles would be proud") + }) + myMenu.Add("Toggle the menuitem above").OnClick(func(*application.Context) { + if beatles.Enabled() { + beatles.SetEnabled(false) + beatles.SetLabel("Goodbye") + } else { + beatles.SetEnabled(true) + beatles.SetLabel("Hello") + } + }) + myMenu.Add("Hide the beatles").OnClick(func(ctx *application.Context) { + if beatles.Hidden() { + ctx.ClickedMenuItem().SetLabel("Hide the beatles!") + beatles.SetHidden(false) + } else { + beatles.SetHidden(true) + ctx.ClickedMenuItem().SetLabel("Unhide the beatles!") + } + }) + + myMenu.AddSeparator() + + coffee := myMenu.Add("Request Coffee").OnClick(func(*application.Context) { + println("Coffee dispatched. Productivity +10!") + }) + + myMenu.Add("Toggle coffee availability").OnClick(func(*application.Context) { + if coffee.Enabled() { + coffee.SetEnabled(false) + coffee.SetLabel("Coffee Machine Broken") + println("Alert: Developer morale critically low.") + } else { + coffee.SetEnabled(true) + coffee.SetLabel("Request Coffee") + println("All systems nominal. Coffee restored.") + } + }) + + myMenu.Add("Hide the coffee option").OnClick(func(ctx *application.Context) { + if coffee.Hidden() { + ctx.ClickedMenuItem().SetLabel("Hide the coffee option") + coffee.SetHidden(false) + println("Coffee menu item has been resurrected!") + } else { + coffee.SetHidden(true) + ctx.ClickedMenuItem().SetLabel("Unhide the coffee option") + println("The coffee option has vanished into the void.") + } + }) + + app.Menu.Set(menu) + + // UseApplicationMenu allows Windows/Linux to inherit the app menu + app.Window.NewWithOptions(application.WebviewWindowOptions{ + Name: "menu-example", + Title: "Menu Example", + UseApplicationMenu: true, + }).SetBackgroundColour(application.NewRGB(33, 37, 41)) + + err := app.Run() + + if err != nil { + log.Fatal(err.Error()) + } +} diff --git a/v3/examples/menu/menu_demo b/v3/examples/menu/menu_demo new file mode 100755 index 000000000..78926ad95 Binary files /dev/null and b/v3/examples/menu/menu_demo differ diff --git a/v3/examples/notifications/README.md b/v3/examples/notifications/README.md new file mode 100644 index 000000000..ad12c3f40 --- /dev/null +++ b/v3/examples/notifications/README.md @@ -0,0 +1,59 @@ +# Welcome to Your New Wails3 Project! + +Congratulations on generating your Wails3 application! This README will guide you through the next steps to get your project up and running. + +## Getting Started + +1. Navigate to your project directory in the terminal. + +2. To run your application in development mode, use the following command: + + ``` + wails3 dev + ``` + + This will start your application and enable hot-reloading for both frontend and backend changes. + +3. To build your application for production, use: + + ``` + wails3 build + ``` + + This will create a production-ready executable in the `build` directory. + +## Exploring Wails3 Features + +Now that you have your project set up, it's time to explore the features that Wails3 offers: + +1. **Check out the examples**: The best way to learn is by example. Visit the `examples` directory in the `v3/examples` directory to see various sample applications. + +2. **Run an example**: To run any of the examples, navigate to the example's directory and use: + + ``` + go run . + ``` + + Note: Some examples may be under development during the alpha phase. + +3. **Explore the documentation**: Visit the [Wails3 documentation](https://v3.wails.io/) for in-depth guides and API references. + +4. **Join the community**: Have questions or want to share your progress? Join the [Wails Discord](https://discord.gg/JDdSxwjhGf) or visit the [Wails discussions on GitHub](https://github.com/wailsapp/wails/discussions). + +## Project Structure + +Take a moment to familiarize yourself with your project structure: + +- `frontend/`: Contains your frontend code (HTML, CSS, JavaScript/TypeScript) +- `main.go`: The entry point of your Go backend +- `app.go`: Define your application structure and methods here +- `wails.json`: Configuration file for your Wails project + +## Next Steps + +1. Modify the frontend in the `frontend/` directory to create your desired UI. +2. Add backend functionality in `main.go`. +3. Use `wails3 dev` to see your changes in real-time. +4. When ready, build your application with `wails3 build`. + +Happy coding with Wails3! If you encounter any issues or have questions, don't hesitate to consult the documentation or reach out to the Wails community. diff --git a/v3/examples/notifications/Taskfile.yml b/v3/examples/notifications/Taskfile.yml new file mode 100644 index 000000000..1455cd70c --- /dev/null +++ b/v3/examples/notifications/Taskfile.yml @@ -0,0 +1,34 @@ +version: '3' + +includes: + common: ./build/Taskfile.yml + windows: ./build/windows/Taskfile.yml + darwin: ./build/darwin/Taskfile.yml + linux: ./build/linux/Taskfile.yml + +vars: + APP_NAME: "Notifications\\ Demo" + BIN_DIR: "bin" + VITE_PORT: '{{.WAILS_VITE_PORT | default 9245}}' + +tasks: + build: + summary: Builds the application + cmds: + - task: "{{OS}}:build" + + package: + summary: Packages a production build of the application + cmds: + - task: "{{OS}}:package" + + run: + summary: Runs the application + cmds: + - task: "{{OS}}:run" + + dev: + summary: Runs the application in development mode + cmds: + - wails3 dev -config ./build/config.yml -port {{.VITE_PORT}} + diff --git a/v3/examples/notifications/build/Taskfile.yml b/v3/examples/notifications/build/Taskfile.yml new file mode 100644 index 000000000..f0aab9b9c --- /dev/null +++ b/v3/examples/notifications/build/Taskfile.yml @@ -0,0 +1,87 @@ +version: '3' + +tasks: + go:mod:tidy: + summary: Runs `go mod tidy` + internal: true + cmds: + - go mod tidy + + install:frontend:deps: + summary: Install frontend dependencies + dir: frontend + sources: + - package.json + - package-lock.json + generates: + - node_modules/* + preconditions: + - sh: npm version + msg: "Looks like npm isn't installed. Npm is part of the Node installer: https://nodejs.org/en/download/" + cmds: + - npm install + + build:frontend: + label: build:frontend (PRODUCTION={{.PRODUCTION}}) + summary: Build the frontend project + dir: frontend + sources: + - "**/*" + - exclude: node_modules/**/* + generates: + - dist/**/* + deps: + - task: install:frontend:deps + - task: generate:bindings + vars: + BUILD_FLAGS: + ref: .BUILD_FLAGS + cmds: + - npm run {{.BUILD_COMMAND}} -q + env: + PRODUCTION: '{{.PRODUCTION | default "false"}}' + vars: + BUILD_COMMAND: '{{if eq .PRODUCTION "true"}}build{{else}}build:dev{{end}}' + + + generate:bindings: + label: generate:bindings (BUILD_FLAGS={{.BUILD_FLAGS}}) + summary: Generates bindings for the frontend + deps: + - task: go:mod:tidy + sources: + - "**/*.[jt]s" + - exclude: frontend/**/* + - frontend/bindings/**/* # Rerun when switching between dev/production mode causes changes in output + - "**/*.go" + - go.mod + - go.sum + generates: + - frontend/bindings/**/* + cmds: + - wails3 generate bindings -f '{{.BUILD_FLAGS}}' -clean=true -ts + + generate:icons: + summary: Generates Windows `.ico` and Mac `.icns` files from an image + dir: build + sources: + - "appicon.png" + generates: + - "darwin/icons.icns" + - "windows/icon.ico" + cmds: + - wails3 generate icons -input appicon.png -macfilename darwin/icons.icns -windowsfilename windows/icon.ico + + dev:frontend: + summary: Runs the frontend in development mode + dir: frontend + deps: + - task: install:frontend:deps + cmds: + - npm run dev -- --port {{.VITE_PORT}} --strictPort + + update:build-assets: + summary: Updates the build assets + dir: build + cmds: + - wails3 update build-assets -name "{{.APP_NAME}}" -binaryname "{{.APP_NAME}}" -config config.yml -dir . diff --git a/v3/examples/notifications/build/appicon.png b/v3/examples/notifications/build/appicon.png new file mode 100644 index 000000000..63617fe4f Binary files /dev/null and b/v3/examples/notifications/build/appicon.png differ diff --git a/v3/examples/notifications/build/config.yml b/v3/examples/notifications/build/config.yml new file mode 100644 index 000000000..bc09a6d28 --- /dev/null +++ b/v3/examples/notifications/build/config.yml @@ -0,0 +1,62 @@ +# This file contains the configuration for this project. +# When you update `info` or `fileAssociations`, run `wails3 task common:update:build-assets` to update the assets. +# Note that this will overwrite any changes you have made to the assets. +version: '3' + +# This information is used to generate the build assets. +info: + companyName: "My Company" # The name of the company + productName: "My Product" # The name of the application + productIdentifier: "com.mycompany.myproduct" # The unique product identifier + description: "A program that does X" # The application description + copyright: "(c) 2025, My Company" # Copyright text + comments: "Some Product Comments" # Comments + version: "v0.0.1" # The application version + +# Dev mode configuration +dev_mode: + root_path: . + log_level: warn + debounce: 1000 + ignore: + dir: + - .git + - node_modules + - frontend + - bin + file: + - .DS_Store + - .gitignore + - .gitkeep + watched_extension: + - "*.go" + git_ignore: true + executes: + - cmd: wails3 task common:install:frontend:deps + type: once + - cmd: wails3 task common:dev:frontend + type: background + - cmd: go mod tidy + type: blocking + - cmd: wails3 task build + type: blocking + - cmd: wails3 task run + type: primary + +# File Associations +# More information at: https://v3.wails.io/noit/done/yet +fileAssociations: +# - ext: wails +# name: Wails +# description: Wails Application File +# iconName: wailsFileIcon +# role: Editor +# - ext: jpg +# name: JPEG +# description: Image File +# iconName: jpegFileIcon +# role: Editor + +# Other data +other: + - name: My Other Data \ No newline at end of file diff --git a/v3/examples/notifications/build/darwin/Info.dev.plist b/v3/examples/notifications/build/darwin/Info.dev.plist new file mode 100644 index 000000000..3a5b9735f --- /dev/null +++ b/v3/examples/notifications/build/darwin/Info.dev.plist @@ -0,0 +1,32 @@ + + + + CFBundlePackageType + APPL + CFBundleName + My Product + CFBundleExecutable + Notifications Demo + CFBundleIdentifier + com.wails.notifications-demo + CFBundleVersion + 0.1.0 + CFBundleGetInfoString + This is a comment + CFBundleShortVersionString + 0.1.0 + CFBundleIconFile + icons + LSMinimumSystemVersion + 10.15.0 + NSHighResolutionCapable + true + NSHumanReadableCopyright + © now, My Company + NSAppTransportSecurity + + NSAllowsLocalNetworking + + + + \ No newline at end of file diff --git a/v3/examples/notifications/build/darwin/Info.plist b/v3/examples/notifications/build/darwin/Info.plist new file mode 100644 index 000000000..464270019 --- /dev/null +++ b/v3/examples/notifications/build/darwin/Info.plist @@ -0,0 +1,27 @@ + + + + CFBundlePackageType + APPL + CFBundleName + My Product + CFBundleExecutable + Notifications Demo + CFBundleIdentifier + com.wails.notifications-demo + CFBundleVersion + 0.1.0 + CFBundleGetInfoString + This is a comment + CFBundleShortVersionString + 0.1.0 + CFBundleIconFile + icons + LSMinimumSystemVersion + 10.15.0 + NSHighResolutionCapable + true + NSHumanReadableCopyright + © now, My Company + + \ No newline at end of file diff --git a/v3/examples/notifications/build/darwin/Taskfile.yml b/v3/examples/notifications/build/darwin/Taskfile.yml new file mode 100644 index 000000000..3b6a9dc99 --- /dev/null +++ b/v3/examples/notifications/build/darwin/Taskfile.yml @@ -0,0 +1,80 @@ +version: '3' + +includes: + common: ../Taskfile.yml + +tasks: + build: + summary: Creates a production build of the application + deps: + - task: common:go:mod:tidy + - task: common:build:frontend + vars: + BUILD_FLAGS: + ref: .BUILD_FLAGS + PRODUCTION: + ref: .PRODUCTION + - task: common:generate:icons + cmds: + - go build {{.BUILD_FLAGS}} -o {{.OUTPUT}} + vars: + BUILD_FLAGS: '{{if eq .PRODUCTION "true"}}-tags production -trimpath -buildvcs=false -ldflags="-w -s"{{else}}-buildvcs=false -gcflags=all="-l"{{end}}' + DEFAULT_OUTPUT: '{{.BIN_DIR}}/{{.APP_NAME}}' + OUTPUT: '{{ .OUTPUT | default .DEFAULT_OUTPUT }}' + env: + GOOS: darwin + CGO_ENABLED: 1 + GOARCH: '{{.ARCH | default ARCH}}' + CGO_CFLAGS: "-mmacosx-version-min=10.15" + CGO_LDFLAGS: "-mmacosx-version-min=10.15" + MACOSX_DEPLOYMENT_TARGET: "10.15" + PRODUCTION: '{{.PRODUCTION | default "false"}}' + + build:universal: + summary: Builds darwin universal binary (arm64 + amd64) + deps: + - task: build + vars: + ARCH: amd64 + OUTPUT: "{{.BIN_DIR}}/{{.APP_NAME}}-amd64" + - task: build + vars: + ARCH: arm64 + OUTPUT: "{{.BIN_DIR}}/{{.APP_NAME}}-arm64" + cmds: + - lipo -create -output "{{.BIN_DIR}}/{{.APP_NAME}}" "{{.BIN_DIR}}/{{.APP_NAME}}-amd64" "{{.BIN_DIR}}/{{.APP_NAME}}-arm64" + - rm "{{.BIN_DIR}}/{{.APP_NAME}}-amd64" "{{.BIN_DIR}}/{{.APP_NAME}}-arm64" + + package: + summary: Packages a production build of the application into a `.app` bundle + deps: + - task: build + vars: + PRODUCTION: "true" + cmds: + - task: create:app:bundle + + package:universal: + summary: Packages darwin universal binary (arm64 + amd64) + deps: + - task: build:universal + cmds: + - task: create:app:bundle + + + create:app:bundle: + summary: Creates an `.app` bundle + cmds: + - mkdir -p {{.BIN_DIR}}/{{.APP_NAME}}.app/Contents/{MacOS,Resources} + - cp build/darwin/icons.icns {{.BIN_DIR}}/{{.APP_NAME}}.app/Contents/Resources + - cp {{.BIN_DIR}}/{{.APP_NAME}} {{.BIN_DIR}}/{{.APP_NAME}}.app/Contents/MacOS + - cp build/darwin/Info.plist {{.BIN_DIR}}/{{.APP_NAME}}.app/Contents + + run: + cmds: + - mkdir -p {{.BIN_DIR}}/dev/{{.APP_NAME}}.app/Contents/{MacOS,Resources} + - cp build/darwin/icons.icns {{.BIN_DIR}}/dev/{{.APP_NAME}}.app/Contents/Resources + - cp {{.BIN_DIR}}/{{.APP_NAME}} {{.BIN_DIR}}/dev/{{.APP_NAME}}.app/Contents/MacOS + - cp build/darwin/Info.dev.plist {{.BIN_DIR}}/dev/{{.APP_NAME}}.app/Contents/Info.plist + - codesign --force --deep --sign - {{.BIN_DIR}}/dev/{{.APP_NAME}}.app + - '{{.BIN_DIR}}/dev/{{.APP_NAME}}.app/Contents/MacOS/{{.APP_NAME}}' diff --git a/v3/examples/notifications/build/darwin/icons.icns b/v3/examples/notifications/build/darwin/icons.icns new file mode 100644 index 000000000..1b5bd4c86 Binary files /dev/null and b/v3/examples/notifications/build/darwin/icons.icns differ diff --git a/v3/examples/notifications/build/linux/Taskfile.yml b/v3/examples/notifications/build/linux/Taskfile.yml new file mode 100644 index 000000000..560cc9c92 --- /dev/null +++ b/v3/examples/notifications/build/linux/Taskfile.yml @@ -0,0 +1,119 @@ +version: '3' + +includes: + common: ../Taskfile.yml + +tasks: + build: + summary: Builds the application for Linux + deps: + - task: common:go:mod:tidy + - task: common:build:frontend + vars: + BUILD_FLAGS: + ref: .BUILD_FLAGS + PRODUCTION: + ref: .PRODUCTION + - task: common:generate:icons + cmds: + - go build {{.BUILD_FLAGS}} -o {{.BIN_DIR}}/{{.APP_NAME}} + vars: + BUILD_FLAGS: '{{if eq .PRODUCTION "true"}}-tags production -trimpath -buildvcs=false -ldflags="-w -s"{{else}}-buildvcs=false -gcflags=all="-l"{{end}}' + env: + GOOS: linux + CGO_ENABLED: 1 + GOARCH: '{{.ARCH | default ARCH}}' + PRODUCTION: '{{.PRODUCTION | default "false"}}' + + package: + summary: Packages a production build of the application for Linux + deps: + - task: build + vars: + PRODUCTION: "true" + cmds: + - task: create:appimage + - task: create:deb + - task: create:rpm + - task: create:aur + + create:appimage: + summary: Creates an AppImage + dir: build/linux/appimage + deps: + - task: build + vars: + PRODUCTION: "true" + - task: generate:dotdesktop + cmds: + - cp {{.APP_BINARY}} {{.APP_NAME}} + - cp ../../appicon.png appicon.png + - wails3 generate appimage -binary {{.APP_NAME}} -icon {{.ICON}} -desktopfile {{.DESKTOP_FILE}} -outputdir {{.OUTPUT_DIR}} -builddir {{.ROOT_DIR}}/build/linux/appimage/build + vars: + APP_NAME: '{{.APP_NAME}}' + APP_BINARY: '../../../bin/{{.APP_NAME}}' + ICON: '../../appicon.png' + DESKTOP_FILE: '../{{.APP_NAME}}.desktop' + OUTPUT_DIR: '../../../bin' + + create:deb: + summary: Creates a deb package + deps: + - task: build + vars: + PRODUCTION: "true" + cmds: + - task: generate:dotdesktop + - task: generate:deb + + create:rpm: + summary: Creates a rpm package + deps: + - task: build + vars: + PRODUCTION: "true" + cmds: + - task: generate:dotdesktop + - task: generate:rpm + + create:aur: + summary: Creates a arch linux packager package + deps: + - task: build + vars: + PRODUCTION: "true" + cmds: + - task: generate:dotdesktop + - task: generate:aur + + generate:deb: + summary: Creates a deb package + cmds: + - wails3 tool package -name {{.APP_NAME}} -format deb -config ./build/linux/nfpm/nfpm.yaml -out {{.ROOT_DIR}}/bin + + generate:rpm: + summary: Creates a rpm package + cmds: + - wails3 tool package -name {{.APP_NAME}} -format rpm -config ./build/linux/nfpm/nfpm.yaml -out {{.ROOT_DIR}}/bin + + generate:aur: + summary: Creates a arch linux packager package + cmds: + - wails3 tool package -name {{.APP_NAME}} -format archlinux -config ./build/linux/nfpm/nfpm.yaml -out {{.ROOT_DIR}}/bin + + generate:dotdesktop: + summary: Generates a `.desktop` file + dir: build + cmds: + - mkdir -p {{.ROOT_DIR}}/build/linux/appimage + - wails3 generate .desktop -name "{{.APP_NAME}}" -exec "{{.EXEC}}" -icon "{{.ICON}}" -outputfile {{.ROOT_DIR}}/build/linux/{{.APP_NAME}}.desktop -categories "{{.CATEGORIES}}" + vars: + APP_NAME: '{{.APP_NAME}}' + EXEC: '{{.APP_NAME}}' + ICON: 'appicon' + CATEGORIES: 'Development;' + OUTPUTFILE: '{{.ROOT_DIR}}/build/linux/{{.APP_NAME}}.desktop' + + run: + cmds: + - '{{.BIN_DIR}}/{{.APP_NAME}}' diff --git a/v3/examples/notifications/build/linux/appimage/build.sh b/v3/examples/notifications/build/linux/appimage/build.sh new file mode 100644 index 000000000..85901c34e --- /dev/null +++ b/v3/examples/notifications/build/linux/appimage/build.sh @@ -0,0 +1,35 @@ +#!/usr/bin/env bash +# Copyright (c) 2018-Present Lea Anthony +# SPDX-License-Identifier: MIT + +# Fail script on any error +set -euxo pipefail + +# Define variables +APP_DIR="${APP_NAME}.AppDir" + +# Create AppDir structure +mkdir -p "${APP_DIR}/usr/bin" +cp -r "${APP_BINARY}" "${APP_DIR}/usr/bin/" +cp "${ICON_PATH}" "${APP_DIR}/" +cp "${DESKTOP_FILE}" "${APP_DIR}/" + +if [[ $(uname -m) == *x86_64* ]]; then + # Download linuxdeploy and make it executable + wget -q -4 -N https://github.com/linuxdeploy/linuxdeploy/releases/download/continuous/linuxdeploy-x86_64.AppImage + chmod +x linuxdeploy-x86_64.AppImage + + # Run linuxdeploy to bundle the application + ./linuxdeploy-x86_64.AppImage --appdir "${APP_DIR}" --output appimage +else + # Download linuxdeploy and make it executable (arm64) + wget -q -4 -N https://github.com/linuxdeploy/linuxdeploy/releases/download/continuous/linuxdeploy-aarch64.AppImage + chmod +x linuxdeploy-aarch64.AppImage + + # Run linuxdeploy to bundle the application (arm64) + ./linuxdeploy-aarch64.AppImage --appdir "${APP_DIR}" --output appimage +fi + +# Rename the generated AppImage +mv "${APP_NAME}*.AppImage" "${APP_NAME}.AppImage" + diff --git a/v3/examples/notifications/build/linux/nfpm/nfpm.yaml b/v3/examples/notifications/build/linux/nfpm/nfpm.yaml new file mode 100644 index 000000000..c2cb7cd81 --- /dev/null +++ b/v3/examples/notifications/build/linux/nfpm/nfpm.yaml @@ -0,0 +1,50 @@ +# Feel free to remove those if you don't want/need to use them. +# Make sure to check the documentation at https://nfpm.goreleaser.com +# +# The lines below are called `modelines`. See `:help modeline` + +name: "notifications" +arch: ${GOARCH} +platform: "linux" +version: "0.1.0" +section: "default" +priority: "extra" +maintainer: ${GIT_COMMITTER_NAME} <${GIT_COMMITTER_EMAIL}> +description: "My Product Description" +vendor: "My Company" +homepage: "https://wails.io" +license: "MIT" +release: "1" + +contents: + - src: "./bin/notifications" + dst: "/usr/local/bin/notifications" + - src: "./build/appicon.png" + dst: "/usr/share/icons/hicolor/128x128/apps/notifications.png" + - src: "./build/linux/notifications.desktop" + dst: "/usr/share/applications/notifications.desktop" + +depends: + - gtk3 + - libwebkit2gtk + +# replaces: +# - foobar +# provides: +# - bar +# depends: +# - gtk3 +# - libwebkit2gtk +# recommends: +# - whatever +# suggests: +# - something-else +# conflicts: +# - not-foo +# - not-bar +# changelog: "changelog.yaml" +# scripts: +# preinstall: ./build/linux/nfpm/scripts/preinstall.sh +# postinstall: ./build/linux/nfpm/scripts/postinstall.sh +# preremove: ./build/linux/nfpm/scripts/preremove.sh +# postremove: ./build/linux/nfpm/scripts/postremove.sh diff --git a/v3/examples/notifications/build/linux/nfpm/scripts/postinstall.sh b/v3/examples/notifications/build/linux/nfpm/scripts/postinstall.sh new file mode 100644 index 000000000..a9bf588e2 --- /dev/null +++ b/v3/examples/notifications/build/linux/nfpm/scripts/postinstall.sh @@ -0,0 +1 @@ +#!/bin/bash diff --git a/v3/examples/notifications/build/linux/nfpm/scripts/postremove.sh b/v3/examples/notifications/build/linux/nfpm/scripts/postremove.sh new file mode 100644 index 000000000..a9bf588e2 --- /dev/null +++ b/v3/examples/notifications/build/linux/nfpm/scripts/postremove.sh @@ -0,0 +1 @@ +#!/bin/bash diff --git a/v3/examples/notifications/build/linux/nfpm/scripts/preinstall.sh b/v3/examples/notifications/build/linux/nfpm/scripts/preinstall.sh new file mode 100644 index 000000000..a9bf588e2 --- /dev/null +++ b/v3/examples/notifications/build/linux/nfpm/scripts/preinstall.sh @@ -0,0 +1 @@ +#!/bin/bash diff --git a/v3/examples/notifications/build/linux/nfpm/scripts/preremove.sh b/v3/examples/notifications/build/linux/nfpm/scripts/preremove.sh new file mode 100644 index 000000000..a9bf588e2 --- /dev/null +++ b/v3/examples/notifications/build/linux/nfpm/scripts/preremove.sh @@ -0,0 +1 @@ +#!/bin/bash diff --git a/v3/examples/notifications/build/windows/Taskfile.yml b/v3/examples/notifications/build/windows/Taskfile.yml new file mode 100644 index 000000000..be6e4125e --- /dev/null +++ b/v3/examples/notifications/build/windows/Taskfile.yml @@ -0,0 +1,63 @@ +version: '3' + +includes: + common: ../Taskfile.yml + +tasks: + build: + summary: Builds the application for Windows + deps: + - task: common:go:mod:tidy + - task: common:build:frontend + vars: + BUILD_FLAGS: + ref: .BUILD_FLAGS + PRODUCTION: + ref: .PRODUCTION + - task: common:generate:icons + cmds: + - task: generate:syso + - go build {{.BUILD_FLAGS}} -o {{.BIN_DIR}}/{{.APP_NAME}}.exe + - cmd: powershell Remove-item *.syso + platforms: [windows] + - cmd: rm -f *.syso + platforms: [linux, darwin] + vars: + BUILD_FLAGS: '{{if eq .PRODUCTION "true"}}-tags production -trimpath -buildvcs=false -ldflags="-w -s -H windowsgui"{{else}}-buildvcs=false -gcflags=all="-l"{{end}}' + env: + GOOS: windows + CGO_ENABLED: 0 + GOARCH: '{{.ARCH | default ARCH}}' + PRODUCTION: '{{.PRODUCTION | default "false"}}' + + package: + summary: Packages a production build of the application into a `.exe` bundle + cmds: + - task: create:nsis:installer + + generate:syso: + summary: Generates Windows `.syso` file + dir: build + cmds: + - wails3 generate syso -arch {{.ARCH}} -icon windows/icon.ico -manifest windows/wails.exe.manifest -info windows/info.json -out ../wails_windows_{{.ARCH}}.syso + vars: + ARCH: '{{.ARCH | default ARCH}}' + + create:nsis:installer: + summary: Creates an NSIS installer + dir: build/windows/nsis + deps: + - task: build + vars: + PRODUCTION: "true" + cmds: + # Create the Microsoft WebView2 bootstrapper if it doesn't exist + - wails3 generate webview2bootstrapper -dir "{{.ROOT_DIR}}/build/windows/nsis" + - makensis -DARG_WAILS_{{.ARG_FLAG}}_BINARY="{{.ROOT_DIR}}/{{.BIN_DIR}}/{{.APP_NAME}}.exe" project.nsi + vars: + ARCH: '{{.ARCH | default ARCH}}' + ARG_FLAG: '{{if eq .ARCH "amd64"}}AMD64{{else}}ARM64{{end}}' + + run: + cmds: + - '{{.BIN_DIR}}\\{{.APP_NAME}}.exe' diff --git a/v3/examples/notifications/build/windows/icon.ico b/v3/examples/notifications/build/windows/icon.ico new file mode 100644 index 000000000..bfa0690b7 Binary files /dev/null and b/v3/examples/notifications/build/windows/icon.ico differ diff --git a/v3/examples/notifications/build/windows/info.json b/v3/examples/notifications/build/windows/info.json new file mode 100644 index 000000000..850b2b5b0 --- /dev/null +++ b/v3/examples/notifications/build/windows/info.json @@ -0,0 +1,15 @@ +{ + "fixed": { + "file_version": "0.1.0" + }, + "info": { + "0000": { + "ProductVersion": "0.1.0", + "CompanyName": "My Company", + "FileDescription": "My Product Description", + "LegalCopyright": "© now, My Company", + "ProductName": "My Product", + "Comments": "This is a comment" + } + } +} \ No newline at end of file diff --git a/v3/examples/notifications/build/windows/nsis/project.nsi b/v3/examples/notifications/build/windows/nsis/project.nsi new file mode 100644 index 000000000..4cb18e04f --- /dev/null +++ b/v3/examples/notifications/build/windows/nsis/project.nsi @@ -0,0 +1,112 @@ +Unicode true + +#### +## Please note: Template replacements don't work in this file. They are provided with default defines like +## mentioned underneath. +## If the keyword is not defined, "wails_tools.nsh" will populate them. +## If they are defined here, "wails_tools.nsh" will not touch them. This allows you to use this project.nsi manually +## from outside of Wails for debugging and development of the installer. +## +## For development first make a wails nsis build to populate the "wails_tools.nsh": +## > wails build --target windows/amd64 --nsis +## Then you can call makensis on this file with specifying the path to your binary: +## For a AMD64 only installer: +## > makensis -DARG_WAILS_AMD64_BINARY=..\..\bin\app.exe +## For a ARM64 only installer: +## > makensis -DARG_WAILS_ARM64_BINARY=..\..\bin\app.exe +## For a installer with both architectures: +## > makensis -DARG_WAILS_AMD64_BINARY=..\..\bin\app-amd64.exe -DARG_WAILS_ARM64_BINARY=..\..\bin\app-arm64.exe +#### +## The following information is taken from the wails_tools.nsh file, but they can be overwritten here. +#### +## !define INFO_PROJECTNAME "my-project" # Default "notifications" +## !define INFO_COMPANYNAME "My Company" # Default "My Company" +## !define INFO_PRODUCTNAME "My Product Name" # Default "My Product" +## !define INFO_PRODUCTVERSION "1.0.0" # Default "0.1.0" +## !define INFO_COPYRIGHT "(c) Now, My Company" # Default "© now, My Company" +### +## !define PRODUCT_EXECUTABLE "Application.exe" # Default "${INFO_PROJECTNAME}.exe" +## !define UNINST_KEY_NAME "UninstKeyInRegistry" # Default "${INFO_COMPANYNAME}${INFO_PRODUCTNAME}" +#### +## !define REQUEST_EXECUTION_LEVEL "admin" # Default "admin" see also https://nsis.sourceforge.io/Docs/Chapter4.html +#### +## Include the wails tools +#### +!include "wails_tools.nsh" + +# The version information for this two must consist of 4 parts +VIProductVersion "${INFO_PRODUCTVERSION}.0" +VIFileVersion "${INFO_PRODUCTVERSION}.0" + +VIAddVersionKey "CompanyName" "${INFO_COMPANYNAME}" +VIAddVersionKey "FileDescription" "${INFO_PRODUCTNAME} Installer" +VIAddVersionKey "ProductVersion" "${INFO_PRODUCTVERSION}" +VIAddVersionKey "FileVersion" "${INFO_PRODUCTVERSION}" +VIAddVersionKey "LegalCopyright" "${INFO_COPYRIGHT}" +VIAddVersionKey "ProductName" "${INFO_PRODUCTNAME}" + +# Enable HiDPI support. https://nsis.sourceforge.io/Reference/ManifestDPIAware +ManifestDPIAware true + +!include "MUI.nsh" + +!define MUI_ICON "..\icon.ico" +!define MUI_UNICON "..\icon.ico" +# !define MUI_WELCOMEFINISHPAGE_BITMAP "resources\leftimage.bmp" #Include this to add a bitmap on the left side of the Welcome Page. Must be a size of 164x314 +!define MUI_FINISHPAGE_NOAUTOCLOSE # Wait on the INSTFILES page so the user can take a look into the details of the installation steps +!define MUI_ABORTWARNING # This will warn the user if they exit from the installer. + +!insertmacro MUI_PAGE_WELCOME # Welcome to the installer page. +# !insertmacro MUI_PAGE_LICENSE "resources\eula.txt" # Adds a EULA page to the installer +!insertmacro MUI_PAGE_DIRECTORY # In which folder install page. +!insertmacro MUI_PAGE_INSTFILES # Installing page. +!insertmacro MUI_PAGE_FINISH # Finished installation page. + +!insertmacro MUI_UNPAGE_INSTFILES # Uninstalling page + +!insertmacro MUI_LANGUAGE "English" # Set the Language of the installer + +## The following two statements can be used to sign the installer and the uninstaller. The path to the binaries are provided in %1 +#!uninstfinalize 'signtool --file "%1"' +#!finalize 'signtool --file "%1"' + +Name "${INFO_PRODUCTNAME}" +OutFile "..\..\..\bin\${INFO_PROJECTNAME}-${ARCH}-installer.exe" # Name of the installer's file. +InstallDir "$PROGRAMFILES64\${INFO_COMPANYNAME}\${INFO_PRODUCTNAME}" # Default installing folder ($PROGRAMFILES is Program Files folder). +ShowInstDetails show # This will always show the installation details. + +Function .onInit + !insertmacro wails.checkArchitecture +FunctionEnd + +Section + !insertmacro wails.setShellContext + + !insertmacro wails.webview2runtime + + SetOutPath $INSTDIR + + !insertmacro wails.files + + CreateShortcut "$SMPROGRAMS\${INFO_PRODUCTNAME}.lnk" "$INSTDIR\${PRODUCT_EXECUTABLE}" + CreateShortCut "$DESKTOP\${INFO_PRODUCTNAME}.lnk" "$INSTDIR\${PRODUCT_EXECUTABLE}" + + !insertmacro wails.associateFiles + + !insertmacro wails.writeUninstaller +SectionEnd + +Section "uninstall" + !insertmacro wails.setShellContext + + RMDir /r "$AppData\${PRODUCT_EXECUTABLE}" # Remove the WebView2 DataPath + + RMDir /r $INSTDIR + + Delete "$SMPROGRAMS\${INFO_PRODUCTNAME}.lnk" + Delete "$DESKTOP\${INFO_PRODUCTNAME}.lnk" + + !insertmacro wails.unassociateFiles + + !insertmacro wails.deleteUninstaller +SectionEnd diff --git a/v3/examples/notifications/build/windows/nsis/wails_tools.nsh b/v3/examples/notifications/build/windows/nsis/wails_tools.nsh new file mode 100644 index 000000000..c47c784a4 --- /dev/null +++ b/v3/examples/notifications/build/windows/nsis/wails_tools.nsh @@ -0,0 +1,212 @@ +# DO NOT EDIT - Generated automatically by `wails build` + +!include "x64.nsh" +!include "WinVer.nsh" +!include "FileFunc.nsh" + +!ifndef INFO_PROJECTNAME + !define INFO_PROJECTNAME "notifications" +!endif +!ifndef INFO_COMPANYNAME + !define INFO_COMPANYNAME "My Company" +!endif +!ifndef INFO_PRODUCTNAME + !define INFO_PRODUCTNAME "My Product" +!endif +!ifndef INFO_PRODUCTVERSION + !define INFO_PRODUCTVERSION "0.1.0" +!endif +!ifndef INFO_COPYRIGHT + !define INFO_COPYRIGHT "© now, My Company" +!endif +!ifndef PRODUCT_EXECUTABLE + !define PRODUCT_EXECUTABLE "${INFO_PROJECTNAME}.exe" +!endif +!ifndef UNINST_KEY_NAME + !define UNINST_KEY_NAME "${INFO_COMPANYNAME}${INFO_PRODUCTNAME}" +!endif +!define UNINST_KEY "Software\Microsoft\Windows\CurrentVersion\Uninstall\${UNINST_KEY_NAME}" + +!ifndef REQUEST_EXECUTION_LEVEL + !define REQUEST_EXECUTION_LEVEL "admin" +!endif + +RequestExecutionLevel "${REQUEST_EXECUTION_LEVEL}" + +!ifdef ARG_WAILS_AMD64_BINARY + !define SUPPORTS_AMD64 +!endif + +!ifdef ARG_WAILS_ARM64_BINARY + !define SUPPORTS_ARM64 +!endif + +!ifdef SUPPORTS_AMD64 + !ifdef SUPPORTS_ARM64 + !define ARCH "amd64_arm64" + !else + !define ARCH "amd64" + !endif +!else + !ifdef SUPPORTS_ARM64 + !define ARCH "arm64" + !else + !error "Wails: Undefined ARCH, please provide at least one of ARG_WAILS_AMD64_BINARY or ARG_WAILS_ARM64_BINARY" + !endif +!endif + +!macro wails.checkArchitecture + !ifndef WAILS_WIN10_REQUIRED + !define WAILS_WIN10_REQUIRED "This product is only supported on Windows 10 (Server 2016) and later." + !endif + + !ifndef WAILS_ARCHITECTURE_NOT_SUPPORTED + !define WAILS_ARCHITECTURE_NOT_SUPPORTED "This product can't be installed on the current Windows architecture. Supports: ${ARCH}" + !endif + + ${If} ${AtLeastWin10} + !ifdef SUPPORTS_AMD64 + ${if} ${IsNativeAMD64} + Goto ok + ${EndIf} + !endif + + !ifdef SUPPORTS_ARM64 + ${if} ${IsNativeARM64} + Goto ok + ${EndIf} + !endif + + IfSilent silentArch notSilentArch + silentArch: + SetErrorLevel 65 + Abort + notSilentArch: + MessageBox MB_OK "${WAILS_ARCHITECTURE_NOT_SUPPORTED}" + Quit + ${else} + IfSilent silentWin notSilentWin + silentWin: + SetErrorLevel 64 + Abort + notSilentWin: + MessageBox MB_OK "${WAILS_WIN10_REQUIRED}" + Quit + ${EndIf} + + ok: +!macroend + +!macro wails.files + !ifdef SUPPORTS_AMD64 + ${if} ${IsNativeAMD64} + File "/oname=${PRODUCT_EXECUTABLE}" "${ARG_WAILS_AMD64_BINARY}" + ${EndIf} + !endif + + !ifdef SUPPORTS_ARM64 + ${if} ${IsNativeARM64} + File "/oname=${PRODUCT_EXECUTABLE}" "${ARG_WAILS_ARM64_BINARY}" + ${EndIf} + !endif +!macroend + +!macro wails.writeUninstaller + WriteUninstaller "$INSTDIR\uninstall.exe" + + SetRegView 64 + WriteRegStr HKLM "${UNINST_KEY}" "Publisher" "${INFO_COMPANYNAME}" + WriteRegStr HKLM "${UNINST_KEY}" "DisplayName" "${INFO_PRODUCTNAME}" + WriteRegStr HKLM "${UNINST_KEY}" "DisplayVersion" "${INFO_PRODUCTVERSION}" + WriteRegStr HKLM "${UNINST_KEY}" "DisplayIcon" "$INSTDIR\${PRODUCT_EXECUTABLE}" + WriteRegStr HKLM "${UNINST_KEY}" "UninstallString" "$\"$INSTDIR\uninstall.exe$\"" + WriteRegStr HKLM "${UNINST_KEY}" "QuietUninstallString" "$\"$INSTDIR\uninstall.exe$\" /S" + + ${GetSize} "$INSTDIR" "/S=0K" $0 $1 $2 + IntFmt $0 "0x%08X" $0 + WriteRegDWORD HKLM "${UNINST_KEY}" "EstimatedSize" "$0" +!macroend + +!macro wails.deleteUninstaller + Delete "$INSTDIR\uninstall.exe" + + SetRegView 64 + DeleteRegKey HKLM "${UNINST_KEY}" +!macroend + +!macro wails.setShellContext + ${If} ${REQUEST_EXECUTION_LEVEL} == "admin" + SetShellVarContext all + ${else} + SetShellVarContext current + ${EndIf} +!macroend + +# Install webview2 by launching the bootstrapper +# See https://docs.microsoft.com/en-us/microsoft-edge/webview2/concepts/distribution#online-only-deployment +!macro wails.webview2runtime + !ifndef WAILS_INSTALL_WEBVIEW_DETAILPRINT + !define WAILS_INSTALL_WEBVIEW_DETAILPRINT "Installing: WebView2 Runtime" + !endif + + SetRegView 64 + # If the admin key exists and is not empty then webview2 is already installed + ReadRegStr $0 HKLM "SOFTWARE\WOW6432Node\Microsoft\EdgeUpdate\Clients\{F3017226-FE2A-4295-8BDF-00C3A9A7E4C5}" "pv" + ${If} $0 != "" + Goto ok + ${EndIf} + + ${If} ${REQUEST_EXECUTION_LEVEL} == "user" + # If the installer is run in user level, check the user specific key exists and is not empty then webview2 is already installed + ReadRegStr $0 HKCU "Software\Microsoft\EdgeUpdate\Clients\{F3017226-FE2A-4295-8BDF-00C3A9A7E4C5}" "pv" + ${If} $0 != "" + Goto ok + ${EndIf} + ${EndIf} + + SetDetailsPrint both + DetailPrint "${WAILS_INSTALL_WEBVIEW_DETAILPRINT}" + SetDetailsPrint listonly + + InitPluginsDir + CreateDirectory "$pluginsdir\webview2bootstrapper" + SetOutPath "$pluginsdir\webview2bootstrapper" + File "MicrosoftEdgeWebview2Setup.exe" + ExecWait '"$pluginsdir\webview2bootstrapper\MicrosoftEdgeWebview2Setup.exe" /silent /install' + + SetDetailsPrint both + ok: +!macroend + +# Copy of APP_ASSOCIATE and APP_UNASSOCIATE macros from here https://gist.github.com/nikku/281d0ef126dbc215dd58bfd5b3a5cd5b +!macro APP_ASSOCIATE EXT FILECLASS DESCRIPTION ICON COMMANDTEXT COMMAND + ; Backup the previously associated file class + ReadRegStr $R0 SHELL_CONTEXT "Software\Classes\.${EXT}" "" + WriteRegStr SHELL_CONTEXT "Software\Classes\.${EXT}" "${FILECLASS}_backup" "$R0" + + WriteRegStr SHELL_CONTEXT "Software\Classes\.${EXT}" "" "${FILECLASS}" + + WriteRegStr SHELL_CONTEXT "Software\Classes\${FILECLASS}" "" `${DESCRIPTION}` + WriteRegStr SHELL_CONTEXT "Software\Classes\${FILECLASS}\DefaultIcon" "" `${ICON}` + WriteRegStr SHELL_CONTEXT "Software\Classes\${FILECLASS}\shell" "" "open" + WriteRegStr SHELL_CONTEXT "Software\Classes\${FILECLASS}\shell\open" "" `${COMMANDTEXT}` + WriteRegStr SHELL_CONTEXT "Software\Classes\${FILECLASS}\shell\open\command" "" `${COMMAND}` +!macroend + +!macro APP_UNASSOCIATE EXT FILECLASS + ; Backup the previously associated file class + ReadRegStr $R0 SHELL_CONTEXT "Software\Classes\.${EXT}" `${FILECLASS}_backup` + WriteRegStr SHELL_CONTEXT "Software\Classes\.${EXT}" "" "$R0" + + DeleteRegKey SHELL_CONTEXT `Software\Classes\${FILECLASS}` +!macroend + +!macro wails.associateFiles + ; Create file associations + +!macroend + +!macro wails.unassociateFiles + ; Delete app associations + +!macroend \ No newline at end of file diff --git a/v3/examples/notifications/build/windows/wails.exe.manifest b/v3/examples/notifications/build/windows/wails.exe.manifest new file mode 100644 index 000000000..0299e62ca --- /dev/null +++ b/v3/examples/notifications/build/windows/wails.exe.manifest @@ -0,0 +1,15 @@ + + + + + + + + + + + true/pm + permonitorv2,permonitor + + + \ No newline at end of file diff --git a/v3/examples/notifications/frontend/Inter Font License.txt b/v3/examples/notifications/frontend/Inter Font License.txt new file mode 100644 index 000000000..b525cbf3a --- /dev/null +++ b/v3/examples/notifications/frontend/Inter Font License.txt @@ -0,0 +1,93 @@ +Copyright 2020 The Inter Project Authors (https://github.com/rsms/inter) + +This Font Software is licensed under the SIL Open Font License, Version 1.1. +This license is copied below, and is also available with a FAQ at: +http://scripts.sil.org/OFL + + +----------------------------------------------------------- +SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007 +----------------------------------------------------------- + +PREAMBLE +The goals of the Open Font License (OFL) are to stimulate worldwide +development of collaborative font projects, to support the font creation +efforts of academic and linguistic communities, and to provide a free and +open framework in which fonts may be shared and improved in partnership +with others. + +The OFL allows the licensed fonts to be used, studied, modified and +redistributed freely as long as they are not sold by themselves. The +fonts, including any derivative works, can be bundled, embedded, +redistributed and/or sold with any software provided that any reserved +names are not used by derivative works. The fonts and derivatives, +however, cannot be released under any other type of license. The +requirement for fonts to remain under this license does not apply +to any document created using the fonts or their derivatives. + +DEFINITIONS +"Font Software" refers to the set of files released by the Copyright +Holder(s) under this license and clearly marked as such. This may +include source files, build scripts and documentation. + +"Reserved Font Name" refers to any names specified as such after the +copyright statement(s). + +"Original Version" refers to the collection of Font Software components as +distributed by the Copyright Holder(s). + +"Modified Version" refers to any derivative made by adding to, deleting, +or substituting -- in part or in whole -- any of the components of the +Original Version, by changing formats or by porting the Font Software to a +new environment. + +"Author" refers to any designer, engineer, programmer, technical +writer or other person who contributed to the Font Software. + +PERMISSION & CONDITIONS +Permission is hereby granted, free of charge, to any person obtaining +a copy of the Font Software, to use, study, copy, merge, embed, modify, +redistribute, and sell modified and unmodified copies of the Font +Software, subject to the following conditions: + +1) Neither the Font Software nor any of its individual components, +in Original or Modified Versions, may be sold by itself. + +2) Original or Modified Versions of the Font Software may be bundled, +redistributed and/or sold with any software, provided that each copy +contains the above copyright notice and this license. These can be +included either as stand-alone text files, human-readable headers or +in the appropriate machine-readable metadata fields within text or +binary files as long as those fields can be easily viewed by the user. + +3) No Modified Version of the Font Software may use the Reserved Font +Name(s) unless explicit written permission is granted by the corresponding +Copyright Holder. This restriction only applies to the primary font name as +presented to the users. + +4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font +Software shall not be used to promote, endorse or advertise any +Modified Version, except to acknowledge the contribution(s) of the +Copyright Holder(s) and the Author(s) or with their explicit written +permission. + +5) The Font Software, modified or unmodified, in part or in whole, +must be distributed entirely under this license, and must not be +distributed under any other license. The requirement for fonts to +remain under this license does not apply to any document created +using the Font Software. + +TERMINATION +This license becomes null and void if any of the above conditions are +not met. + +DISCLAIMER +THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF +MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT +OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE +COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, +INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL +DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING +FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM +OTHER DEALINGS IN THE FONT SOFTWARE. diff --git a/v3/examples/notifications/frontend/bindings/github.com/wailsapp/wails/v3/pkg/services/notifications/index.ts b/v3/examples/notifications/frontend/bindings/github.com/wailsapp/wails/v3/pkg/services/notifications/index.ts new file mode 100644 index 000000000..71eda3bb9 --- /dev/null +++ b/v3/examples/notifications/frontend/bindings/github.com/wailsapp/wails/v3/pkg/services/notifications/index.ts @@ -0,0 +1,13 @@ +// Cynhyrchwyd y ffeil hon yn awtomatig. PEIDIWCH Â MODIWL +// This file is automatically generated. DO NOT EDIT + +import * as NotificationService from "./notificationservice.js"; +export { + NotificationService +}; + +export { + NotificationAction, + NotificationCategory, + NotificationOptions +} from "./models.js"; diff --git a/v3/examples/notifications/frontend/bindings/github.com/wailsapp/wails/v3/pkg/services/notifications/models.ts b/v3/examples/notifications/frontend/bindings/github.com/wailsapp/wails/v3/pkg/services/notifications/models.ts new file mode 100644 index 000000000..d7f48edfe --- /dev/null +++ b/v3/examples/notifications/frontend/bindings/github.com/wailsapp/wails/v3/pkg/services/notifications/models.ts @@ -0,0 +1,107 @@ +// Cynhyrchwyd y ffeil hon yn awtomatig. PEIDIWCH Â MODIWL +// This file is automatically generated. DO NOT EDIT + +// eslint-disable-next-line @typescript-eslint/ban-ts-comment +// @ts-ignore: Unused imports +import { Create as $Create } from "@wailsio/runtime"; + +/** + * NotificationAction represents an action button for a notification. + */ +export class NotificationAction { + "id"?: string; + "title"?: string; + + /** + * (macOS-specific) + */ + "destructive"?: boolean; + + /** Creates a new NotificationAction instance. */ + constructor($$source: Partial = {}) { + + Object.assign(this, $$source); + } + + /** + * Creates a new NotificationAction instance from a string or object. + */ + static createFrom($$source: any = {}): NotificationAction { + let $$parsedSource = typeof $$source === 'string' ? JSON.parse($$source) : $$source; + return new NotificationAction($$parsedSource as Partial); + } +} + +/** + * NotificationCategory groups actions for notifications. + */ +export class NotificationCategory { + "id"?: string; + "actions"?: NotificationAction[]; + "hasReplyField"?: boolean; + "replyPlaceholder"?: string; + "replyButtonTitle"?: string; + + /** Creates a new NotificationCategory instance. */ + constructor($$source: Partial = {}) { + + Object.assign(this, $$source); + } + + /** + * Creates a new NotificationCategory instance from a string or object. + */ + static createFrom($$source: any = {}): NotificationCategory { + const $$createField1_0 = $$createType1; + let $$parsedSource = typeof $$source === 'string' ? JSON.parse($$source) : $$source; + if ("actions" in $$parsedSource) { + $$parsedSource["actions"] = $$createField1_0($$parsedSource["actions"]); + } + return new NotificationCategory($$parsedSource as Partial); + } +} + +/** + * NotificationOptions contains configuration for a notification + */ +export class NotificationOptions { + "id": string; + "title": string; + + /** + * (macOS and Linux only) + */ + "subtitle"?: string; + "body"?: string; + "categoryId"?: string; + "data"?: { [_: string]: any }; + + /** Creates a new NotificationOptions instance. */ + constructor($$source: Partial = {}) { + if (!("id" in $$source)) { + this["id"] = ""; + } + if (!("title" in $$source)) { + this["title"] = ""; + } + + Object.assign(this, $$source); + } + + /** + * Creates a new NotificationOptions instance from a string or object. + */ + static createFrom($$source: any = {}): NotificationOptions { + const $$createField5_0 = $$createType2; + let $$parsedSource = typeof $$source === 'string' ? JSON.parse($$source) : $$source; + if ("data" in $$parsedSource) { + $$parsedSource["data"] = $$createField5_0($$parsedSource["data"]); + } + return new NotificationOptions($$parsedSource as Partial); + } +} + +// Private type creation functions +const $$createType0 = NotificationAction.createFrom; +const $$createType1 = $Create.Array($$createType0); +const $$createType2 = $Create.Map($Create.Any, $Create.Any); diff --git a/v3/examples/notifications/frontend/bindings/github.com/wailsapp/wails/v3/pkg/services/notifications/notificationservice.ts b/v3/examples/notifications/frontend/bindings/github.com/wailsapp/wails/v3/pkg/services/notifications/notificationservice.ts new file mode 100644 index 000000000..859f3570f --- /dev/null +++ b/v3/examples/notifications/frontend/bindings/github.com/wailsapp/wails/v3/pkg/services/notifications/notificationservice.ts @@ -0,0 +1,62 @@ +// Cynhyrchwyd y ffeil hon yn awtomatig. PEIDIWCH Â MODIWL +// This file is automatically generated. DO NOT EDIT + +/** + * Service represents the notifications service + * @module + */ + +// eslint-disable-next-line @typescript-eslint/ban-ts-comment +// @ts-ignore: Unused imports +import { Call as $Call, CancellablePromise as $CancellablePromise, Create as $Create } from "@wailsio/runtime"; + +// eslint-disable-next-line @typescript-eslint/ban-ts-comment +// @ts-ignore: Unused imports +import * as $models from "./models.js"; + +export function CheckNotificationAuthorization(): $CancellablePromise { + return $Call.ByID(2216952893); +} + +export function RegisterNotificationCategory(category: $models.NotificationCategory): $CancellablePromise { + return $Call.ByID(2917562919, category); +} + +export function RemoveAllDeliveredNotifications(): $CancellablePromise { + return $Call.ByID(3956282340); +} + +export function RemoveAllPendingNotifications(): $CancellablePromise { + return $Call.ByID(108821341); +} + +export function RemoveDeliveredNotification(identifier: string): $CancellablePromise { + return $Call.ByID(975691940, identifier); +} + +export function RemoveNotification(identifier: string): $CancellablePromise { + return $Call.ByID(3966653866, identifier); +} + +export function RemoveNotificationCategory(categoryID: string): $CancellablePromise { + return $Call.ByID(2032615554, categoryID); +} + +export function RemovePendingNotification(identifier: string): $CancellablePromise { + return $Call.ByID(3729049703, identifier); +} + +/** + * Public methods that delegate to the implementation. + */ +export function RequestNotificationAuthorization(): $CancellablePromise { + return $Call.ByID(3933442950); +} + +export function SendNotification(options: $models.NotificationOptions): $CancellablePromise { + return $Call.ByID(3968228732, options); +} + +export function SendNotificationWithActions(options: $models.NotificationOptions): $CancellablePromise { + return $Call.ByID(1886542847, options); +} diff --git a/v3/examples/notifications/frontend/dist/Inter-Medium.ttf b/v3/examples/notifications/frontend/dist/Inter-Medium.ttf new file mode 100644 index 000000000..a01f3777a Binary files /dev/null and b/v3/examples/notifications/frontend/dist/Inter-Medium.ttf differ diff --git a/v3/examples/notifications/frontend/dist/assets/index-Dat4utuQ.js b/v3/examples/notifications/frontend/dist/assets/index-Dat4utuQ.js new file mode 100644 index 000000000..b1c054dfb --- /dev/null +++ b/v3/examples/notifications/frontend/dist/assets/index-Dat4utuQ.js @@ -0,0 +1,33 @@ +(function(){const e=document.createElement("link").relList;if(e&&e.supports&&e.supports("modulepreload"))return;for(const o of document.querySelectorAll('link[rel="modulepreload"]'))r(o);new MutationObserver(o=>{for(const i of o)if(i.type==="childList")for(const s of i.addedNodes)s.tagName==="LINK"&&s.rel==="modulepreload"&&r(s)}).observe(document,{childList:!0,subtree:!0});function n(o){const i={};return o.integrity&&(i.integrity=o.integrity),o.referrerPolicy&&(i.referrerPolicy=o.referrerPolicy),o.crossOrigin==="use-credentials"?i.credentials="include":o.crossOrigin==="anonymous"?i.credentials="omit":i.credentials="same-origin",i}function r(o){if(o.ep)return;o.ep=!0;const i=n(o);fetch(o.href,i)}})();const fe="useandom-26T198340PX75pxJACKVERYMINDBUSHWOLF_GQZbfghjklqvwyzrict";function oe(t=21){let e="",n=t|0;for(;n--;)e+=fe[Math.random()*64|0];return e}const pe=window.location.origin+"/wails/runtime",x=Object.freeze({Call:0,Clipboard:1,Application:2,Events:3,ContextMenu:4,Dialog:5,Window:6,Screens:7,System:8,Browser:9,CancelCall:10});let we=oe();function C(t,e=""){return function(n,r=null){return he(t,n,e,r)}}async function he(t,e,n,r){var o,i;let s=new URL(pe);s.searchParams.append("object",t.toString()),s.searchParams.append("method",e.toString()),r&&s.searchParams.append("args",JSON.stringify(r));let a={"x-wails-client-id":we};n&&(a["x-wails-window-name"]=n);let c=await fetch(s,{headers:a});if(!c.ok)throw new Error(await c.text());return((i=(o=c.headers.get("Content-Type"))===null||o===void 0?void 0:o.indexOf("application/json"))!==null&&i!==void 0?i:-1)!==-1?c.json():c.text()}C(x.System);const H=function(){var t,e,n,r,o;try{if(!((e=(t=window.chrome)===null||t===void 0?void 0:t.webview)===null||e===void 0)&&e.postMessage)return window.chrome.webview.postMessage.bind(window.chrome.webview);if(!((o=(r=(n=window.webkit)===null||n===void 0?void 0:n.messageHandlers)===null||r===void 0?void 0:r.external)===null||o===void 0)&&o.postMessage)return window.webkit.messageHandlers.external.postMessage.bind(window.webkit.messageHandlers.external)}catch{}return console.warn(` +%c⚠️ Browser Environment Detected %c + +%cOnly UI previews are available in the browser. For full functionality, please run the application in desktop mode. +More information at: https://v3.wails.io/learn/build/#using-a-browser-for-development +`,"background: #ffffff; color: #000000; font-weight: bold; padding: 4px 8px; border-radius: 4px; border: 2px solid #000000;","background: transparent;","color: #ffffff; font-style: italic; font-weight: bold;"),null}();function T(t){H==null||H(t)}function ie(){return window._wails.environment.OS==="windows"}function me(){return!!window._wails.environment.Debug}function ye(){return new MouseEvent("mousedown").buttons===0}function se(t){var e;return t.target instanceof HTMLElement?t.target:!(t.target instanceof HTMLElement)&&t.target instanceof Node&&(e=t.target.parentElement)!==null&&e!==void 0?e:document.body}document.addEventListener("DOMContentLoaded",()=>{});window.addEventListener("contextmenu",je);const ge=C(x.ContextMenu),be=0;function ve(t,e,n,r){ge(be,{id:t,x:e,y:n,data:r})}function je(t){const e=se(t),n=window.getComputedStyle(e).getPropertyValue("--custom-contextmenu").trim();if(n){t.preventDefault();const r=window.getComputedStyle(e).getPropertyValue("--custom-contextmenu-data");ve(n,t.clientX,t.clientY,r)}else Ee(t,e)}function Ee(t,e){if(me())return;switch(window.getComputedStyle(e).getPropertyValue("--default-contextmenu").trim()){case"show":return;case"hide":t.preventDefault();return}if(e.isContentEditable)return;const n=window.getSelection(),r=n&&n.toString().length>0;if(r)for(let o=0;o{F=t,F||(j=E=!1,u())};window.addEventListener("mousedown",Y,{capture:!0});window.addEventListener("mousemove",Y,{capture:!0});window.addEventListener("mouseup",Y,{capture:!0});for(const t of["click","contextmenu","dblclick"])window.addEventListener(t,ze,{capture:!0});function ze(t){(S||E)&&(t.stopImmediatePropagation(),t.stopPropagation(),t.preventDefault())}const I=0,Se=1,U=2;function Y(t){let e,n=t.buttons;switch(t.type){case"mousedown":e=I,P||(n=y|1<"u"||typeof e=="object"))try{var n=O.call(e);return(n===Ne||n===De||n===He||n===Re)&&e("")==null}catch{}return!1})}function Ue(t){if(V(t))return!0;if(!t||typeof t!="function"&&typeof t!="object")return!1;try{b(t,null,_)}catch(e){if(e!==R)return!1}return!$(t)&&B(t)}function qe(t){if(V(t))return!0;if(!t||typeof t!="function"&&typeof t!="object")return!1;if(Ae)return B(t);if($(t))return!1;var e=O.call(t);return e!==Oe&&e!==Te&&!/^\[object HTML/.test(e)?!1:B(t)}const m=b?Ue:qe;var q;class W extends Error{constructor(e,n){super(e,n),this.name="CancelError"}}class M extends Error{constructor(e,n,r){super((r??"Unhandled rejection in cancelled promise.")+" Reason: "+Fe(n),{cause:n}),this.promise=e,this.name="CancelledRejectionError"}}const p=Symbol("barrier"),G=Symbol("cancelImpl"),K=(q=Symbol.species)!==null&&q!==void 0?q:Symbol("speciesPolyfill");class l extends Promise{constructor(e,n){let r,o;if(super((c,f)=>{r=c,o=f}),this.constructor[K]!==Promise)throw new TypeError("CancellablePromise does not support transparent subclassing. Please refrain from overriding the [Symbol.species] static property.");let i={promise:this,resolve:r,reject:o,get oncancelled(){return n??null},set oncancelled(c){n=c??void 0}};const s={get root(){return s},resolving:!1,settled:!1};Object.defineProperties(this,{[p]:{configurable:!1,enumerable:!1,writable:!0,value:null},[G]:{configurable:!1,enumerable:!1,writable:!1,value:ae(i,s)}});const a=ue(i,s);try{e(le(i,s),a)}catch(c){s.resolving?console.log("Unhandled exception in CancellablePromise executor.",c):a(c)}}cancel(e){return new l(n=>{Promise.all([this[G](new W("Promise cancelled.",{cause:e})),_e(this)]).then(()=>n(),()=>n())})}cancelOn(e){return e.aborted?this.cancel(e.reason):e.addEventListener("abort",()=>void this.cancel(e.reason),{capture:!0}),this}then(e,n,r){if(!(this instanceof l))throw new TypeError("CancellablePromise.prototype.then called on an invalid object.");if(m(e)||(e=Q),m(n)||(n=Z),e===Q&&n==Z)return new l(i=>i(this));const o={};return this[p]=o,new l((i,s)=>{super.then(a=>{var c;this[p]===o&&(this[p]=null),(c=o.resolve)===null||c===void 0||c.call(o);try{i(e(a))}catch(f){s(f)}},a=>{var c;this[p]===o&&(this[p]=null),(c=o.resolve)===null||c===void 0||c.call(o);try{i(n(a))}catch(f){s(f)}})},async i=>{try{return r==null?void 0:r(i)}finally{await this.cancel(i)}})}catch(e,n){return this.then(void 0,e,n)}finally(e,n){if(!(this instanceof l))throw new TypeError("CancellablePromise.prototype.finally called on an invalid object.");return m(e)?this.then(r=>l.resolve(e()).then(()=>r),r=>l.resolve(e()).then(()=>{throw r}),n):this.then(e,e,n)}static get[K](){return Promise}static all(e){let n=Array.from(e);const r=n.length===0?l.resolve(n):new l((o,i)=>{Promise.all(n).then(o,i)},o=>L(r,n,o));return r}static allSettled(e){let n=Array.from(e);const r=n.length===0?l.resolve(n):new l((o,i)=>{Promise.allSettled(n).then(o,i)},o=>L(r,n,o));return r}static any(e){let n=Array.from(e);const r=n.length===0?l.resolve(n):new l((o,i)=>{Promise.any(n).then(o,i)},o=>L(r,n,o));return r}static race(e){let n=Array.from(e);const r=new l((o,i)=>{Promise.race(n).then(o,i)},o=>L(r,n,o));return r}static cancel(e){const n=new l(()=>{});return n.cancel(e),n}static timeout(e,n){const r=new l(()=>{});return AbortSignal&&typeof AbortSignal=="function"&&AbortSignal.timeout&&typeof AbortSignal.timeout=="function"?AbortSignal.timeout(e).addEventListener("abort",()=>void r.cancel(n)):setTimeout(()=>void r.cancel(n),e),r}static sleep(e,n){return new l(r=>{setTimeout(()=>r(n),e)})}static reject(e){return new l((n,r)=>r(e))}static resolve(e){return e instanceof l?e:new l(n=>n(e))}static withResolvers(){let e={oncancelled:null};return e.promise=new l((n,r)=>{e.resolve=n,e.reject=r},n=>{var r;(r=e.oncancelled)===null||r===void 0||r.call(e,n)}),e}}function ae(t,e){let n;return r=>{if(e.settled||(e.settled=!0,e.reason=r,t.reject(r),Promise.prototype.then.call(t.promise,void 0,o=>{if(o!==r)throw o})),!(!e.reason||!t.oncancelled))return n=new Promise(o=>{try{o(t.oncancelled(e.reason.cause))}catch(i){Promise.reject(new M(t.promise,i,"Unhandled exception in oncancelled callback."))}}).catch(o=>{Promise.reject(new M(t.promise,o,"Unhandled rejection in oncancelled callback."))}),t.oncancelled=null,n}}function le(t,e){return n=>{if(!e.resolving){if(e.resolving=!0,n===t.promise){if(e.settled)return;e.settled=!0,t.reject(new TypeError("A promise cannot be resolved with itself."));return}if(n!=null&&(typeof n=="object"||typeof n=="function")){let r;try{r=n.then}catch(o){e.settled=!0,t.reject(o);return}if(m(r)){try{let s=n.cancel;if(m(s)){const a=c=>{Reflect.apply(s,n,[c])};e.reason?ae(Object.assign(Object.assign({},t),{oncancelled:a}),e)(e.reason):t.oncancelled=a}}catch{}const o={root:e.root,resolving:!1,get settled(){return this.root.settled},set settled(s){this.root.settled=s},get reason(){return this.root.reason}},i=ue(t,o);try{Reflect.apply(r,n,[le(t,o),i])}catch(s){i(s)}return}}e.settled||(e.settled=!0,t.resolve(n))}}}function ue(t,e){return n=>{if(!e.resolving)if(e.resolving=!0,e.settled){try{if(n instanceof W&&e.reason instanceof W&&Object.is(n.cause,e.reason.cause))return}catch{}Promise.reject(new M(t.promise,n))}else e.settled=!0,t.reject(n)}}function L(t,e,n){const r=[];for(const o of e){let i;try{if(!m(o.then)||(i=o.cancel,!m(i)))continue}catch{continue}let s;try{s=Reflect.apply(i,o,[n])}catch(a){Promise.reject(new M(t,a,"Unhandled exception in cancel method."));continue}s&&r.push((s instanceof Promise?s:Promise.resolve(s)).catch(a=>{Promise.reject(new M(t,a,"Unhandled rejection in cancel method."))}))}return Promise.all(r)}function Q(t){return t}function Z(t){throw t}function Fe(t){try{if(t instanceof Error||typeof t!="object"||t.toString!==Object.prototype.toString)return""+t}catch{}try{return JSON.stringify(t)}catch{}try{return Object.prototype.toString.call(t)}catch{}return""}function _e(t){var e;let n=(e=t[p])!==null&&e!==void 0?e:{};return"promise"in n||Object.assign(n,g()),t[p]==null&&(n.resolve(),t[p]=n),n.promise}let g=Promise.withResolvers;g&&typeof g=="function"?g=g.bind(Promise):g=function(){let t,e;return{promise:new Promise((r,o)=>{t=r,e=o}),resolve:t,reject:e}};window._wails=window._wails||{};window._wails.callResultHandler=Xe;window._wails.callErrorHandler=Je;const Be=C(x.Call),We=C(x.CancelCall),v=new Map,Ye=0,$e=0;class Ve extends Error{constructor(e,n){super(e,n),this.name="RuntimeError"}}function Xe(t,e,n){const r=de(t);if(r)if(!e)r.resolve(void 0);else if(!n)r.resolve(e);else try{r.resolve(JSON.parse(e))}catch(o){r.reject(new TypeError("could not parse result: "+o.message,{cause:o}))}}function Je(t,e,n){const r=de(t);if(r)if(!n)r.reject(new Error(e));else{let o;try{o=JSON.parse(e)}catch(a){r.reject(new TypeError("could not parse error: "+a.message,{cause:a}));return}let i={};o.cause&&(i.cause=o.cause);let s;switch(o.kind){case"ReferenceError":s=new ReferenceError(o.message,i);break;case"TypeError":s=new TypeError(o.message,i);break;case"RuntimeError":s=new Ve(o.message,i);break;default:s=new Error(o.message,i);break}r.reject(s)}}function de(t){const e=v.get(t);return v.delete(t),e}function Ge(){let t;do t=oe();while(v.has(t));return t}function Ke(t){const e=Ge(),n=l.withResolvers();v.set(e,{resolve:n.resolve,reject:n.reject});const r=Be(Ye,Object.assign({"call-id":e},t));let o=!1;r.then(()=>{o=!0},s=>{v.delete(e),n.reject(s)});const i=()=>(v.delete(e),We($e,{"call-id":e}).catch(s=>{console.error("Error while requesting binding call cancellation:",s)}));return n.oncancelled=()=>o?i():r.then(i),n.promise}function k(t,...e){return Ke({methodID:t,args:e})}const w=new Map;class Qe{constructor(e,n,r){this.eventName=e,this.callback=n,this.maxCallbacks=r||-1}dispatch(e){try{this.callback(e)}catch(n){console.error(n)}return this.maxCallbacks===-1?!1:(this.maxCallbacks-=1,this.maxCallbacks===0)}}function Ze(t){let e=w.get(t.eventName);e&&(e=e.filter(n=>n!==t),e.length===0?w.delete(t.eventName):w.set(t.eventName,e))}window._wails=window._wails||{};window._wails.dispatchWailsEvent=tt;C(x.Events);class et{constructor(e,n=null){this.name=e,this.data=n}}function tt(t){let e=w.get(t.name);if(!e)return;let n=new et(t.name,t.data);"sender"in t&&(n.sender=t.sender),e=e.filter(r=>!r.dispatch(n)),e.length===0?w.delete(t.name):w.set(t.name,e)}function nt(t,e,n){let r=w.get(t)||[];const o=new Qe(t,e,n);return r.push(o),w.set(t,r),()=>Ze(o)}function rt(t,e){return nt(t,e,-1)}window._wails=window._wails||{};window._wails.invoke=T;T("wails:runtime:ready");function X(){return k(2216952893)}function ot(t){return k(2917562919,t)}function it(){return k(3933442950)}function st(t){return k(3968228732,t)}function ct(t){return k(1886542847,t)}const d=document.querySelector("#response");var ee;(ee=document.querySelector("#request"))==null||ee.addEventListener("click",async()=>{try{await it()?(d&&(d.innerHTML="

            Notifications are now authorized.

            "),console.info("Notifications are now authorized.")):(d&&(d.innerHTML="

            Notifications are not authorized. You can attempt to request again or let the user know in the UI.

            "),console.warn(`Notifications are not authorized. + You can attempt to request again or let the user know in the UI. +`))}catch(t){console.error(t)}});var te;(te=document.querySelector("#check"))==null||te.addEventListener("click",async()=>{try{await X()?(d&&(d.innerHTML="

            Notifications are authorized.

            "),console.info("Notifications are authorized.")):(d&&(d.innerHTML="

            Notifications are not authorized. You can attempt to request again or let the user know in the UI.

            "),console.warn(`Notifications are not authorized. + You can attempt to request again or let the user know in the UI. +`))}catch(t){console.error(t)}});var ne;(ne=document.querySelector("#basic"))==null||ne.addEventListener("click",async()=>{try{await X()?await st({id:crypto.randomUUID(),title:"Notification Title",subtitle:"Subtitle on macOS and Linux",body:"Body text of notification.",data:{"user-id":"user-123","message-id":"msg-123",timestamp:Date.now()}}):(d&&(d.innerHTML="

            Notifications are not authorized. You can attempt to request again or let the user know in the UI.

            "),console.warn(`Notifications are not authorized. + You can attempt to request again or let the user know in the UI. +`))}catch(t){console.error(t)}});var re;(re=document.querySelector("#complex"))==null||re.addEventListener("click",async()=>{try{if(await X()){const e="frontend-notification-id";await ot({id:e,actions:[{id:"VIEW",title:"View"},{id:"MARK_READ",title:"Mark as read"},{id:"DELETE",title:"Delete",destructive:!0}],hasReplyField:!0,replyPlaceholder:"Message...",replyButtonTitle:"Reply"}),await ct({id:crypto.randomUUID(),title:"Notification Title",subtitle:"Subtitle on macOS and Linux",body:"Body text of notification.",categoryId:e,data:{"user-id":"user-123","message-id":"msg-123",timestamp:Date.now()}})}else d&&(d.innerHTML="

            Notifications are not authorized. You can attempt to request again or let the user know in the UI.

            "),console.warn(`Notifications are not authorized. + You can attempt to request again or let the user know in the UI. +`)}catch(t){console.error(t)}});const at=rt("notification:action",t=>{console.info(`Recieved a ${t.name} event`);const{userInfo:e,...n}=t.data[0];console.info("Notification Response:"),console.table(n),console.info("Notification Response Metadata:"),console.table(e);const r=` +
            Notification Response
            + + + ${Object.keys(n).map(i=>``).join("")} + + + ${Object.values(n).map(i=>``).join("")} + +
            ${i}
            ${i}
            +
            Notification Metadata
            + + + ${Object.keys(e).map(i=>``).join("")} + + + ${Object.values(e).map(i=>``).join("")} + +
            ${i}
            ${i}
            + `,o=document.querySelector("#response");o&&(o.innerHTML=r)});window.onbeforeunload=()=>at(); diff --git a/v3/examples/notifications/frontend/dist/index.html b/v3/examples/notifications/frontend/dist/index.html new file mode 100644 index 000000000..b7794f4d8 --- /dev/null +++ b/v3/examples/notifications/frontend/dist/index.html @@ -0,0 +1,32 @@ + + + + + + + + Wails App + + + +
            + +

            Wails + Typescript + Desktop Notifications

            +

            Send notifications 👇

            +
            + + + + +
            + +
            + + diff --git a/v3/examples/notifications/frontend/dist/style.css b/v3/examples/notifications/frontend/dist/style.css new file mode 100644 index 000000000..074717bca --- /dev/null +++ b/v3/examples/notifications/frontend/dist/style.css @@ -0,0 +1,131 @@ +:root { + font-family: "Inter", -apple-system, BlinkMacSystemFont, "Segoe UI", "Roboto", + "Oxygen", "Ubuntu", "Cantarell", "Fira Sans", "Droid Sans", "Helvetica Neue", + sans-serif; + font-size: 16px; + line-height: 24px; + font-weight: 400; + color-scheme: light dark; + color: rgba(255, 255, 255, 0.87); + background-color: rgba(27, 38, 54, 1); + font-synthesis: none; + text-rendering: optimizeLegibility; + -webkit-font-smoothing: antialiased; + -moz-osx-font-smoothing: grayscale; + -webkit-text-size-adjust: 100%; +} + +* { + user-select: none; + -webkit-user-select: none; + -moz-user-select: none; + -ms-user-select: none; +} + +@font-face { + font-family: "Inter"; + font-style: normal; + font-weight: 400; + src: local(""), + url("./Inter-Medium.ttf") format("truetype"); +} + +a { + font-weight: 500; + color: #646cff; + text-decoration: inherit; +} + +a:hover { + color: #535bf2; +} + +.controls { + display: flex; + gap: 1em; +} + +button { + height: 30px; + line-height: 30px; + border-radius: 3px; + border: none; + margin: 0 0 0 20px; + padding: 0 8px; + cursor: pointer; +} + +body { + margin: 0; + display: flex; + place-items: center; + place-content: center; + min-width: 320px; + min-height: 100vh; +} + +.container { + display: flex; + flex-direction: column; + align-items: center; + justify-content: center; + padding: 3em; +} + +h1, h3 { + line-height: 1.1; + text-align: center; +} + +#app { + max-width: 1280px; + margin: 0 auto; + padding: 2rem; + text-align: center; +} + +.logo { + height: 6em; + padding: 1.5em; + will-change: filter; +} + +.logo:hover { + filter: drop-shadow(0 0 2em #e80000aa); +} + +.logo.vanilla:hover { + filter: drop-shadow(0 0 2em #f7df1eaa); +} + +.footer { + margin-top: 1rem; + align-content: center; + text-align: center; +} + +.footer table { + font-size: 12px; + border-collapse: collapse; + margin: 0 auto; +} + +.footer table, th, td { + border: 1px solid #ddd; + padding: 0.5em; +} + +@media (prefers-color-scheme: light) { + :root { + color: #213547; + background-color: #ffffff; + } + + a:hover { + color: #747bff; + } + + button { + background-color: #f9f9f9; + } +} \ No newline at end of file diff --git a/v3/examples/notifications/frontend/dist/typescript.svg b/v3/examples/notifications/frontend/dist/typescript.svg new file mode 100644 index 000000000..d91c910cc --- /dev/null +++ b/v3/examples/notifications/frontend/dist/typescript.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/v3/examples/notifications/frontend/dist/wails.png b/v3/examples/notifications/frontend/dist/wails.png new file mode 100644 index 000000000..8bdf42483 Binary files /dev/null and b/v3/examples/notifications/frontend/dist/wails.png differ diff --git a/v3/examples/notifications/frontend/index.html b/v3/examples/notifications/frontend/index.html new file mode 100644 index 000000000..b873cd4f3 --- /dev/null +++ b/v3/examples/notifications/frontend/index.html @@ -0,0 +1,32 @@ + + + + + + + + Wails App + + +
            + +

            Wails + Typescript + Desktop Notifications

            +

            Send notifications 👇

            +
            + + + + +
            + +
            + + + diff --git a/v3/examples/notifications/frontend/package.json b/v3/examples/notifications/frontend/package.json new file mode 100644 index 000000000..b39da7ece --- /dev/null +++ b/v3/examples/notifications/frontend/package.json @@ -0,0 +1,19 @@ +{ + "name": "frontend", + "private": true, + "version": "0.0.0", + "type": "module", + "scripts": { + "dev": "vite", + "build:dev": "tsc && vite build --minify false --mode development", + "build": "tsc && vite build --mode production", + "preview": "vite preview" + }, + "dependencies": { + "@wailsio/runtime": "latest" + }, + "devDependencies": { + "typescript": "^4.9.3", + "vite": "^5.0.0" + } +} diff --git a/v3/examples/notifications/frontend/public/Inter-Medium.ttf b/v3/examples/notifications/frontend/public/Inter-Medium.ttf new file mode 100644 index 000000000..a01f3777a Binary files /dev/null and b/v3/examples/notifications/frontend/public/Inter-Medium.ttf differ diff --git a/v3/examples/notifications/frontend/public/style.css b/v3/examples/notifications/frontend/public/style.css new file mode 100644 index 000000000..074717bca --- /dev/null +++ b/v3/examples/notifications/frontend/public/style.css @@ -0,0 +1,131 @@ +:root { + font-family: "Inter", -apple-system, BlinkMacSystemFont, "Segoe UI", "Roboto", + "Oxygen", "Ubuntu", "Cantarell", "Fira Sans", "Droid Sans", "Helvetica Neue", + sans-serif; + font-size: 16px; + line-height: 24px; + font-weight: 400; + color-scheme: light dark; + color: rgba(255, 255, 255, 0.87); + background-color: rgba(27, 38, 54, 1); + font-synthesis: none; + text-rendering: optimizeLegibility; + -webkit-font-smoothing: antialiased; + -moz-osx-font-smoothing: grayscale; + -webkit-text-size-adjust: 100%; +} + +* { + user-select: none; + -webkit-user-select: none; + -moz-user-select: none; + -ms-user-select: none; +} + +@font-face { + font-family: "Inter"; + font-style: normal; + font-weight: 400; + src: local(""), + url("./Inter-Medium.ttf") format("truetype"); +} + +a { + font-weight: 500; + color: #646cff; + text-decoration: inherit; +} + +a:hover { + color: #535bf2; +} + +.controls { + display: flex; + gap: 1em; +} + +button { + height: 30px; + line-height: 30px; + border-radius: 3px; + border: none; + margin: 0 0 0 20px; + padding: 0 8px; + cursor: pointer; +} + +body { + margin: 0; + display: flex; + place-items: center; + place-content: center; + min-width: 320px; + min-height: 100vh; +} + +.container { + display: flex; + flex-direction: column; + align-items: center; + justify-content: center; + padding: 3em; +} + +h1, h3 { + line-height: 1.1; + text-align: center; +} + +#app { + max-width: 1280px; + margin: 0 auto; + padding: 2rem; + text-align: center; +} + +.logo { + height: 6em; + padding: 1.5em; + will-change: filter; +} + +.logo:hover { + filter: drop-shadow(0 0 2em #e80000aa); +} + +.logo.vanilla:hover { + filter: drop-shadow(0 0 2em #f7df1eaa); +} + +.footer { + margin-top: 1rem; + align-content: center; + text-align: center; +} + +.footer table { + font-size: 12px; + border-collapse: collapse; + margin: 0 auto; +} + +.footer table, th, td { + border: 1px solid #ddd; + padding: 0.5em; +} + +@media (prefers-color-scheme: light) { + :root { + color: #213547; + background-color: #ffffff; + } + + a:hover { + color: #747bff; + } + + button { + background-color: #f9f9f9; + } +} \ No newline at end of file diff --git a/v3/examples/notifications/frontend/public/typescript.svg b/v3/examples/notifications/frontend/public/typescript.svg new file mode 100644 index 000000000..d91c910cc --- /dev/null +++ b/v3/examples/notifications/frontend/public/typescript.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/v3/examples/notifications/frontend/public/wails.png b/v3/examples/notifications/frontend/public/wails.png new file mode 100644 index 000000000..8bdf42483 Binary files /dev/null and b/v3/examples/notifications/frontend/public/wails.png differ diff --git a/v3/examples/notifications/frontend/src/main.ts b/v3/examples/notifications/frontend/src/main.ts new file mode 100644 index 000000000..94bbb7df3 --- /dev/null +++ b/v3/examples/notifications/frontend/src/main.ts @@ -0,0 +1,129 @@ +import { Events } from "@wailsio/runtime"; +import { NotificationService } from "../bindings/github.com/wailsapp/wails/v3/pkg/services/notifications"; + +const footer = document.querySelector("#response"); + +document.querySelector("#request")?.addEventListener("click", async () => { + try { + const authorized = await NotificationService.RequestNotificationAuthorization(); + if (authorized) { + if (footer) footer.innerHTML = "

            Notifications are now authorized.

            "; + console.info("Notifications are now authorized."); + } else { + if (footer) footer.innerHTML = "

            Notifications are not authorized. You can attempt to request again or let the user know in the UI.

            "; + console.warn("Notifications are not authorized.\n You can attempt to request again or let the user know in the UI.\n"); + } + } catch (error) { + console.error(error); + } +}); + +document.querySelector("#check")?.addEventListener("click", async () => { + try { + const authorized = await NotificationService.CheckNotificationAuthorization(); + if (authorized) { + if (footer) footer.innerHTML = "

            Notifications are authorized.

            "; + console.info("Notifications are authorized."); + } else { + if (footer) footer.innerHTML = "

            Notifications are not authorized. You can attempt to request again or let the user know in the UI.

            "; + console.warn("Notifications are not authorized.\n You can attempt to request again or let the user know in the UI.\n"); + } + } catch (error) { + console.error(error); + } +}); + +document.querySelector("#basic")?.addEventListener("click", async () => { + try { + const authorized = await NotificationService.CheckNotificationAuthorization(); + if (authorized) { + await NotificationService.SendNotification({ + id: crypto.randomUUID(), + title: "Notification Title", + subtitle: "Subtitle on macOS and Linux", + body: "Body text of notification.", + data: { + "user-id": "user-123", + "message-id": "msg-123", + "timestamp": Date.now(), + }, + }); + } else { + if (footer) footer.innerHTML = "

            Notifications are not authorized. You can attempt to request again or let the user know in the UI.

            "; + console.warn("Notifications are not authorized.\n You can attempt to request again or let the user know in the UI.\n"); + } + } catch (error) { + console.error(error); + } +}); +document.querySelector("#complex")?.addEventListener("click", async () => { + try { + const authorized = await NotificationService.CheckNotificationAuthorization(); + if (authorized) { + const CategoryID = "frontend-notification-id"; + + await NotificationService.RegisterNotificationCategory({ + id: CategoryID, + actions: [ + { id: "VIEW", title: "View" }, + { id: "MARK_READ", title: "Mark as read" }, + { id: "DELETE", title: "Delete", destructive: true }, + ], + hasReplyField: true, + replyPlaceholder: "Message...", + replyButtonTitle: "Reply", + }); + + await NotificationService.SendNotificationWithActions({ + id: crypto.randomUUID(), + title: "Notification Title", + subtitle: "Subtitle on macOS and Linux", + body: "Body text of notification.", + categoryId: CategoryID, + data: { + "user-id": "user-123", + "message-id": "msg-123", + "timestamp": Date.now(), + }, + }); + } else { + if (footer) footer.innerHTML = "

            Notifications are not authorized. You can attempt to request again or let the user know in the UI.

            "; + console.warn("Notifications are not authorized.\n You can attempt to request again or let the user know in the UI.\n"); + } + } catch (error) { + console.error(error); + } +}); + +const unlisten = Events.On("notification:action", (response) => { + console.info(`Recieved a ${response.name} event`); + const { userInfo, ...base } = response.data[0]; + console.info("Notification Response:"); + console.table(base); + console.info("Notification Response Metadata:"); + console.table(userInfo); + const table = ` +
            Notification Response
            + + + ${Object.keys(base).map(key => ``).join("")} + + + ${Object.values(base).map(value => ``).join("")} + +
            ${key}
            ${value}
            +
            Notification Metadata
            + + + ${Object.keys(userInfo).map(key => ``).join("")} + + + ${Object.values(userInfo).map(value => ``).join("")} + +
            ${key}
            ${value}
            + `; + const footer = document.querySelector("#response"); + if (footer) footer.innerHTML = table; +}); + +window.onbeforeunload = () => unlisten(); \ No newline at end of file diff --git a/v3/examples/notifications/frontend/src/vite-env.d.ts b/v3/examples/notifications/frontend/src/vite-env.d.ts new file mode 100644 index 000000000..11f02fe2a --- /dev/null +++ b/v3/examples/notifications/frontend/src/vite-env.d.ts @@ -0,0 +1 @@ +/// diff --git a/v3/examples/notifications/frontend/tsconfig.json b/v3/examples/notifications/frontend/tsconfig.json new file mode 100644 index 000000000..c267ecf24 --- /dev/null +++ b/v3/examples/notifications/frontend/tsconfig.json @@ -0,0 +1,20 @@ +{ + "compilerOptions": { + "target": "ESNext", + "useDefineForClassFields": true, + "module": "ESNext", + "lib": ["ESNext", "DOM"], + "moduleResolution": "Node", + "strict": true, + "resolveJsonModule": true, + "isolatedModules": true, + "esModuleInterop": true, + "noEmit": true, + "noUnusedLocals": true, + "noUnusedParameters": false, + "noImplicitAny": false, + "noImplicitReturns": true, + "skipLibCheck": true + }, + "include": ["src"] +} diff --git a/v3/examples/notifications/go.mod b/v3/examples/notifications/go.mod new file mode 100644 index 000000000..af22c8e53 --- /dev/null +++ b/v3/examples/notifications/go.mod @@ -0,0 +1,50 @@ +module notifications + +go 1.25 + +require github.com/wailsapp/wails/v3 v3.0.0-dev + +require ( + dario.cat/mergo v1.0.2 // indirect + git.sr.ht/~jackmordaunt/go-toast/v2 v2.0.3 // indirect + github.com/Microsoft/go-winio v0.6.2 // indirect + github.com/ProtonMail/go-crypto v1.3.0 // indirect + github.com/adrg/xdg v0.5.3 // indirect + github.com/bep/debounce v1.2.1 // indirect + github.com/cloudflare/circl v1.6.3 // indirect + github.com/coder/websocket v1.8.14 // indirect + github.com/cyphar/filepath-securejoin v0.6.1 // indirect + github.com/ebitengine/purego v0.9.1 // indirect + github.com/emirpasic/gods v1.18.1 // indirect + github.com/go-git/gcfg v1.5.1-0.20230307220236-3a3c6141e376 // indirect + github.com/go-git/go-billy/v5 v5.7.0 // indirect + github.com/go-git/go-git/v5 v5.16.4 // indirect + github.com/go-ole/go-ole v1.3.0 // indirect + github.com/godbus/dbus/v5 v5.2.2 // indirect + github.com/golang/groupcache v0.0.0-20241129210726-2c02b8208cf8 // indirect + github.com/google/uuid v1.6.0 // indirect + github.com/jbenet/go-context v0.0.0-20150711004518-d14ea06fba99 // indirect + github.com/jchv/go-winloader v0.0.0-20250406163304-c1995be93bd1 // indirect + github.com/kevinburke/ssh_config v1.4.0 // indirect + github.com/klauspost/cpuid/v2 v2.3.0 // indirect + github.com/leaanthony/go-ansi-parser v1.6.1 // indirect + github.com/leaanthony/u v1.1.1 // indirect + github.com/lmittmann/tint v1.1.2 // indirect + github.com/mattn/go-colorable v0.1.14 // indirect + github.com/mattn/go-isatty v0.0.20 // indirect + github.com/pjbgf/sha1cd v0.5.0 // indirect + github.com/pkg/browser v0.0.0-20240102092130-5ac0b6a4141c // indirect + github.com/rivo/uniseg v0.4.7 // indirect + github.com/samber/lo v1.52.0 // indirect + github.com/sergi/go-diff v1.4.0 // indirect + github.com/skeema/knownhosts v1.3.2 // indirect + github.com/wailsapp/go-webview2 v1.0.23 // indirect + github.com/xanzy/ssh-agent v0.3.3 // indirect + golang.org/x/crypto v0.47.0 // indirect + golang.org/x/net v0.49.0 // indirect + golang.org/x/sys v0.40.0 // indirect + golang.org/x/text v0.33.0 // indirect + gopkg.in/warnings.v0 v0.1.2 // indirect +) + +replace github.com/wailsapp/wails/v3 => ../.. diff --git a/v3/examples/notifications/go.sum b/v3/examples/notifications/go.sum new file mode 100644 index 000000000..85f7a05c3 --- /dev/null +++ b/v3/examples/notifications/go.sum @@ -0,0 +1,149 @@ +dario.cat/mergo v1.0.2 h1:85+piFYR1tMbRrLcDwR18y4UKJ3aH1Tbzi24VRW1TK8= +dario.cat/mergo v1.0.2/go.mod h1:E/hbnu0NxMFBjpMIE34DRGLWqDy0g5FuKDhCb31ngxA= +git.sr.ht/~jackmordaunt/go-toast/v2 v2.0.3 h1:N3IGoHHp9pb6mj1cbXbuaSXV/UMKwmbKLf53nQmtqMA= +git.sr.ht/~jackmordaunt/go-toast/v2 v2.0.3/go.mod h1:QtOLZGz8olr4qH2vWK0QH0w0O4T9fEIjMuWpKUsH7nc= +github.com/Microsoft/go-winio v0.5.2/go.mod h1:WpS1mjBmmwHBEWmogvA2mj8546UReBk4v8QkMxJ6pZY= +github.com/Microsoft/go-winio v0.6.2 h1:F2VQgta7ecxGYO8k3ZZz3RS8fVIXVxONVUPlNERoyfY= +github.com/Microsoft/go-winio v0.6.2/go.mod h1:yd8OoFMLzJbo9gZq8j5qaps8bJ9aShtEA8Ipt1oGCvU= +github.com/ProtonMail/go-crypto v1.3.0 h1:ILq8+Sf5If5DCpHQp4PbZdS1J7HDFRXz/+xKBiRGFrw= +github.com/ProtonMail/go-crypto v1.3.0/go.mod h1:9whxjD8Rbs29b4XWbB8irEcE8KHMqaR2e7GWU1R+/PE= +github.com/adrg/xdg v0.5.3 h1:xRnxJXne7+oWDatRhR1JLnvuccuIeCoBu2rtuLqQB78= +github.com/adrg/xdg v0.5.3/go.mod h1:nlTsY+NNiCBGCK2tpm09vRqfVzrc2fLmXGpBLF0zlTQ= +github.com/anmitsu/go-shlex v0.0.0-20200514113438-38f4b401e2be h1:9AeTilPcZAjCFIImctFaOjnTIavg87rW78vTPkQqLI8= +github.com/anmitsu/go-shlex v0.0.0-20200514113438-38f4b401e2be/go.mod h1:ySMOLuWl6zY27l47sB3qLNK6tF2fkHG55UZxx8oIVo4= +github.com/armon/go-socks5 v0.0.0-20160902184237-e75332964ef5 h1:0CwZNZbxp69SHPdPJAN/hZIm0C4OItdklCFmMRWYpio= +github.com/armon/go-socks5 v0.0.0-20160902184237-e75332964ef5/go.mod h1:wHh0iHkYZB8zMSxRWpUBQtwG5a7fFgvEO+odwuTv2gs= +github.com/bep/debounce v1.2.1 h1:v67fRdBA9UQu2NhLFXrSg0Brw7CexQekrBwDMM8bzeY= +github.com/bep/debounce v1.2.1/go.mod h1:H8yggRPQKLUhUoqrJC1bO2xNya7vanpDl7xR3ISbCJ0= +github.com/cloudflare/circl v1.6.3 h1:9GPOhQGF9MCYUeXyMYlqTR6a5gTrgR/fBLXvUgtVcg8= +github.com/cloudflare/circl v1.6.3/go.mod h1:2eXP6Qfat4O/Yhh8BznvKnJ+uzEoTQ6jVKJRn81BiS4= +github.com/coder/websocket v1.8.14 h1:9L0p0iKiNOibykf283eHkKUHHrpG7f65OE3BhhO7v9g= +github.com/coder/websocket v1.8.14/go.mod h1:NX3SzP+inril6yawo5CQXx8+fk145lPDC6pumgx0mVg= +github.com/cyphar/filepath-securejoin v0.6.1 h1:5CeZ1jPXEiYt3+Z6zqprSAgSWiggmpVyciv8syjIpVE= +github.com/cyphar/filepath-securejoin v0.6.1/go.mod h1:A8hd4EnAeyujCJRrICiOWqjS1AX0a9kM5XL+NwKoYSc= +github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= +github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c= +github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= +github.com/ebitengine/purego v0.9.1 h1:a/k2f2HQU3Pi399RPW1MOaZyhKJL9w/xFpKAg4q1s0A= +github.com/ebitengine/purego v0.9.1/go.mod h1:iIjxzd6CiRiOG0UyXP+V1+jWqUXVjPKLAI0mRfJZTmQ= +github.com/elazarl/goproxy v1.7.2 h1:Y2o6urb7Eule09PjlhQRGNsqRfPmYI3KKQLFpCAV3+o= +github.com/elazarl/goproxy v1.7.2/go.mod h1:82vkLNir0ALaW14Rc399OTTjyNREgmdL2cVoIbS6XaE= +github.com/emirpasic/gods v1.18.1 h1:FXtiHYKDGKCW2KzwZKx0iC0PQmdlorYgdFG9jPXJ1Bc= +github.com/emirpasic/gods v1.18.1/go.mod h1:8tpGGwCnJ5H4r6BWwaV6OrWmMoPhUl5jm/FMNAnJvWQ= +github.com/gliderlabs/ssh v0.3.8 h1:a4YXD1V7xMF9g5nTkdfnja3Sxy1PVDCj1Zg4Wb8vY6c= +github.com/gliderlabs/ssh v0.3.8/go.mod h1:xYoytBv1sV0aL3CavoDuJIQNURXkkfPA/wxQ1pL1fAU= +github.com/go-git/gcfg v1.5.1-0.20230307220236-3a3c6141e376 h1:+zs/tPmkDkHx3U66DAb0lQFJrpS6731Oaa12ikc+DiI= +github.com/go-git/gcfg v1.5.1-0.20230307220236-3a3c6141e376/go.mod h1:an3vInlBmSxCcxctByoQdvwPiA7DTK7jaaFDBTtu0ic= +github.com/go-git/go-billy/v5 v5.7.0 h1:83lBUJhGWhYp0ngzCMSgllhUSuoHP1iEWYjsPl9nwqM= +github.com/go-git/go-billy/v5 v5.7.0/go.mod h1:/1IUejTKH8xipsAcdfcSAlUlo2J7lkYV8GTKxAT/L3E= +github.com/go-git/go-git-fixtures/v4 v4.3.2-0.20231010084843-55a94097c399 h1:eMje31YglSBqCdIqdhKBW8lokaMrL3uTkpGYlE2OOT4= +github.com/go-git/go-git-fixtures/v4 v4.3.2-0.20231010084843-55a94097c399/go.mod h1:1OCfN199q1Jm3HZlxleg+Dw/mwps2Wbk9frAWm+4FII= +github.com/go-git/go-git/v5 v5.16.4 h1:7ajIEZHZJULcyJebDLo99bGgS0jRrOxzZG4uCk2Yb2Y= +github.com/go-git/go-git/v5 v5.16.4/go.mod h1:4Ge4alE/5gPs30F2H1esi2gPd69R0C39lolkucHBOp8= +github.com/go-json-experiment/json v0.0.0-20251027170946-4849db3c2f7e h1:Lf/gRkoycfOBPa42vU2bbgPurFong6zXeFtPoxholzU= +github.com/go-json-experiment/json v0.0.0-20251027170946-4849db3c2f7e/go.mod h1:uNVvRXArCGbZ508SxYYTC5v1JWoz2voff5pm25jU1Ok= +github.com/go-ole/go-ole v1.3.0 h1:Dt6ye7+vXGIKZ7Xtk4s6/xVdGDQynvom7xCFEdWr6uE= +github.com/go-ole/go-ole v1.3.0/go.mod h1:5LS6F96DhAwUc7C+1HLexzMXY1xGRSryjyPPKW6zv78= +github.com/godbus/dbus/v5 v5.2.2 h1:TUR3TgtSVDmjiXOgAAyaZbYmIeP3DPkld3jgKGV8mXQ= +github.com/godbus/dbus/v5 v5.2.2/go.mod h1:3AAv2+hPq5rdnr5txxxRwiGjPXamgoIHgz9FPBfOp3c= +github.com/golang/groupcache v0.0.0-20241129210726-2c02b8208cf8 h1:f+oWsMOmNPc8JmEHVZIycC7hBoQxHH9pNKQORJNozsQ= +github.com/golang/groupcache v0.0.0-20241129210726-2c02b8208cf8/go.mod h1:wcDNUvekVysuuOpQKo3191zZyTpiI6se1N1ULghS0sw= +github.com/google/go-cmp v0.7.0 h1:wk8382ETsv4JYUZwIsn6YpYiWiBsYLSJiTsyBybVuN8= +github.com/google/go-cmp v0.7.0/go.mod h1:pXiqmnSA92OHEEa9HXL2W4E7lf9JzCmGVUdgjX3N/iU= +github.com/google/uuid v1.6.0 h1:NIvaJDMOsjHA8n1jAhLSgzrAzy1Hgr+hNrb57e+94F0= +github.com/google/uuid v1.6.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo= +github.com/jbenet/go-context v0.0.0-20150711004518-d14ea06fba99 h1:BQSFePA1RWJOlocH6Fxy8MmwDt+yVQYULKfN0RoTN8A= +github.com/jbenet/go-context v0.0.0-20150711004518-d14ea06fba99/go.mod h1:1lJo3i6rXxKeerYnT8Nvf0QmHCRC1n8sfWVwXF2Frvo= +github.com/jchv/go-winloader v0.0.0-20250406163304-c1995be93bd1 h1:njuLRcjAuMKr7kI3D85AXWkw6/+v9PwtV6M6o11sWHQ= +github.com/jchv/go-winloader v0.0.0-20250406163304-c1995be93bd1/go.mod h1:alcuEEnZsY1WQsagKhZDsoPCRoOijYqhZvPwLG0kzVs= +github.com/kevinburke/ssh_config v1.4.0 h1:6xxtP5bZ2E4NF5tuQulISpTO2z8XbtH8cg1PWkxoFkQ= +github.com/kevinburke/ssh_config v1.4.0/go.mod h1:q2RIzfka+BXARoNexmF9gkxEX7DmvbW9P4hIVx2Kg4M= +github.com/klauspost/cpuid/v2 v2.3.0 h1:S4CRMLnYUhGeDFDqkGriYKdfoFlDnMtqTiI/sFzhA9Y= +github.com/klauspost/cpuid/v2 v2.3.0/go.mod h1:hqwkgyIinND0mEev00jJYCxPNVRVXFQeu1XKlok6oO0= +github.com/kr/pretty v0.1.0/go.mod h1:dAy3ld7l9f0ibDNOQOHHMYYIIbhfbHSm3C4ZsoJORNo= +github.com/kr/pretty v0.3.1 h1:flRD4NNwYAUpkphVc1HcthR4KEIFJ65n8Mw5qdRn3LE= +github.com/kr/pretty v0.3.1/go.mod h1:hoEshYVHaxMs3cyo3Yncou5ZscifuDolrwPKZanG3xk= +github.com/kr/pty v1.1.1/go.mod h1:pFQYn66WHrOpPYNljwOMqo10TkYh1fy3cYio2l3bCsQ= +github.com/kr/text v0.1.0/go.mod h1:4Jbv+DJW3UT/LiOwJeYQe1efqtUx/iVham/4vfdArNI= +github.com/kr/text v0.2.0 h1:5Nx0Ya0ZqY2ygV366QzturHI13Jq95ApcVaJBhpS+AY= +github.com/kr/text v0.2.0/go.mod h1:eLer722TekiGuMkidMxC/pM04lWEeraHUUmBw8l2grE= +github.com/leaanthony/go-ansi-parser v1.6.1 h1:xd8bzARK3dErqkPFtoF9F3/HgN8UQk0ed1YDKpEz01A= +github.com/leaanthony/go-ansi-parser v1.6.1/go.mod h1:+vva/2y4alzVmmIEpk9QDhA7vLC5zKDTRwfZGOp3IWU= +github.com/leaanthony/u v1.1.1 h1:TUFjwDGlNX+WuwVEzDqQwC2lOv0P4uhTQw7CMFdiK7M= +github.com/leaanthony/u v1.1.1/go.mod h1:9+o6hejoRljvZ3BzdYlVL0JYCwtnAsVuN9pVTQcaRfI= +github.com/lmittmann/tint v1.1.2 h1:2CQzrL6rslrsyjqLDwD11bZ5OpLBPU+g3G/r5LSfS8w= +github.com/lmittmann/tint v1.1.2/go.mod h1:HIS3gSy7qNwGCj+5oRjAutErFBl4BzdQP6cJZ0NfMwE= +github.com/matryer/is v1.4.0/go.mod h1:8I/i5uYgLzgsgEloJE1U6xx5HkBQpAZvepWuujKwMRU= +github.com/matryer/is v1.4.1 h1:55ehd8zaGABKLXQUe2awZ99BD/PTc2ls+KV/dXphgEQ= +github.com/matryer/is v1.4.1/go.mod h1:8I/i5uYgLzgsgEloJE1U6xx5HkBQpAZvepWuujKwMRU= +github.com/mattn/go-colorable v0.1.14 h1:9A9LHSqF/7dyVVX6g0U9cwm9pG3kP9gSzcuIPHPsaIE= +github.com/mattn/go-colorable v0.1.14/go.mod h1:6LmQG8QLFO4G5z1gPvYEzlUgJ2wF+stgPZH1UqBm1s8= +github.com/mattn/go-isatty v0.0.20 h1:xfD0iDuEKnDkl03q4limB+vH+GxLEtL/jb4xVJSWWEY= +github.com/mattn/go-isatty v0.0.20/go.mod h1:W+V8PltTTMOvKvAeJH7IuucS94S2C6jfK/D7dTCTo3Y= +github.com/onsi/gomega v1.34.1 h1:EUMJIKUjM8sKjYbtxQI9A4z2o+rruxnzNvpknOXie6k= +github.com/onsi/gomega v1.34.1/go.mod h1:kU1QgUvBDLXBJq618Xvm2LUX6rSAfRaFRTcdOeDLwwY= +github.com/pjbgf/sha1cd v0.5.0 h1:a+UkboSi1znleCDUNT3M5YxjOnN1fz2FhN48FlwCxs0= +github.com/pjbgf/sha1cd v0.5.0/go.mod h1:lhpGlyHLpQZoxMv8HcgXvZEhcGs0PG/vsZnEJ7H0iCM= +github.com/pkg/browser v0.0.0-20240102092130-5ac0b6a4141c h1:+mdjkGKdHQG3305AYmdv1U2eRNDiU2ErMBj1gwrq8eQ= +github.com/pkg/browser v0.0.0-20240102092130-5ac0b6a4141c/go.mod h1:7rwL4CYBLnjLxUqIJNnCWiEdr3bn6IUYi15bNlnbCCU= +github.com/pkg/errors v0.9.1 h1:FEBLx1zS214owpjy7qsBeixbURkuhQAwrK5UwLGTwt4= +github.com/pkg/errors v0.9.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0= +github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM= +github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= +github.com/rivo/uniseg v0.2.0/go.mod h1:J6wj4VEh+S6ZtnVlnTBMWIodfgj8LQOQFoIToxlJtxc= +github.com/rivo/uniseg v0.4.7 h1:WUdvkW8uEhrYfLC4ZzdpI2ztxP1I582+49Oc5Mq64VQ= +github.com/rivo/uniseg v0.4.7/go.mod h1:FN3SvrM+Zdj16jyLfmOkMNblXMcoc8DfTHruCPUcx88= +github.com/rogpeppe/go-internal v1.14.1 h1:UQB4HGPB6osV0SQTLymcB4TgvyWu6ZyliaW0tI/otEQ= +github.com/rogpeppe/go-internal v1.14.1/go.mod h1:MaRKkUm5W0goXpeCfT7UZI6fk/L7L7so1lCWt35ZSgc= +github.com/samber/lo v1.52.0 h1:Rvi+3BFHES3A8meP33VPAxiBZX/Aws5RxrschYGjomw= +github.com/samber/lo v1.52.0/go.mod h1:4+MXEGsJzbKGaUEQFKBq2xtfuznW9oz/WrgyzMzRoM0= +github.com/sergi/go-diff v1.4.0 h1:n/SP9D5ad1fORl+llWyN+D6qoUETXNZARKjyY2/KVCw= +github.com/sergi/go-diff v1.4.0/go.mod h1:A0bzQcvG0E7Rwjx0REVgAGH58e96+X0MeOfepqsbeW4= +github.com/sirupsen/logrus v1.7.0/go.mod h1:yWOB1SBYBC5VeMP7gHvWumXLIWorT60ONWic61uBYv0= +github.com/skeema/knownhosts v1.3.2 h1:EDL9mgf4NzwMXCTfaxSD/o/a5fxDw/xL9nkU28JjdBg= +github.com/skeema/knownhosts v1.3.2/go.mod h1:bEg3iQAuw+jyiw+484wwFJoKSLwcfd7fqRy+N0QTiow= +github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME= +github.com/stretchr/testify v1.2.2/go.mod h1:a8OnRcib4nhh0OaRAV+Yts87kKdq0PP7pXfy6kDkUVs= +github.com/stretchr/testify v1.4.0/go.mod h1:j7eGeouHqKxXV5pUuKE4zz7dFj8WfuZ+81PSLYec5m4= +github.com/stretchr/testify v1.11.1 h1:7s2iGBzp5EwR7/aIZr8ao5+dra3wiQyKjjFuvgVKu7U= +github.com/stretchr/testify v1.11.1/go.mod h1:wZwfW3scLgRK+23gO65QZefKpKQRnfz6sD981Nm4B6U= +github.com/wailsapp/go-webview2 v1.0.23 h1:jmv8qhz1lHibCc79bMM/a/FqOnnzOGEisLav+a0b9P0= +github.com/wailsapp/go-webview2 v1.0.23/go.mod h1:qJmWAmAmaniuKGZPWwne+uor3AHMB5PFhqiK0Bbj8kc= +github.com/xanzy/ssh-agent v0.3.3 h1:+/15pJfg/RsTxqYcX6fHqOXZwwMP+2VyYWJeWM2qQFM= +github.com/xanzy/ssh-agent v0.3.3/go.mod h1:6dzNDKs0J9rVPHPhaGCukekBHKqfl+L3KghI1Bc68Uw= +golang.org/x/crypto v0.0.0-20220622213112-05595931fe9d/go.mod h1:IxCIyHEi3zRg3s0A5j5BB6A9Jmi73HwBIUl50j+osU4= +golang.org/x/crypto v0.47.0 h1:V6e3FRj+n4dbpw86FJ8Fv7XVOql7TEwpHapKoMJ/GO8= +golang.org/x/crypto v0.47.0/go.mod h1:ff3Y9VzzKbwSSEzWqJsJVBnWmRwRSHt/6Op5n9bQc4A= +golang.org/x/exp v0.0.0-20260112195511-716be5621a96 h1:Z/6YuSHTLOHfNFdb8zVZomZr7cqNgTJvA8+Qz75D8gU= +golang.org/x/exp v0.0.0-20260112195511-716be5621a96/go.mod h1:nzimsREAkjBCIEFtHiYkrJyT+2uy9YZJB7H1k68CXZU= +golang.org/x/net v0.0.0-20211112202133-69e39bad7dc2/go.mod h1:9nx3DQGgdP8bBQD5qxJ1jj9UTztislL4KSBs9R2vV5Y= +golang.org/x/net v0.49.0 h1:eeHFmOGUTtaaPSGNmjBKpbng9MulQsJURQUAfUwY++o= +golang.org/x/net v0.49.0/go.mod h1:/ysNB2EvaqvesRkuLAyjI1ycPZlQHM3q01F02UY/MV8= +golang.org/x/sys v0.0.0-20191026070338-33540a1f6037/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20200810151505-1b9f1253b3ed/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20201119102817-f84b799fce68/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20210124154548-22da62e12c0c/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20210423082822-04245dca01da/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20210615035016-665e8c7367d1/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.0.0-20220715151400-c0bba94af5f8/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.1.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.6.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.40.0 h1:DBZZqJ2Rkml6QMQsZywtnjnnGvHza6BTfYFWY9kjEWQ= +golang.org/x/sys v0.40.0/go.mod h1:OgkHotnGiDImocRcuBABYBEXf8A9a87e/uXjp9XT3ks= +golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo= +golang.org/x/term v0.39.0 h1:RclSuaJf32jOqZz74CkPA9qFuVTX7vhLlpfj/IGWlqY= +golang.org/x/term v0.39.0/go.mod h1:yxzUCTP/U+FzoxfdKmLaA0RV1WgE0VY7hXBwKtY/4ww= +golang.org/x/text v0.3.6/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ= +golang.org/x/text v0.33.0 h1:B3njUFyqtHDUI5jMn1YIr5B0IE2U0qck04r6d4KPAxE= +golang.org/x/text v0.33.0/go.mod h1:LuMebE6+rBincTi9+xWTY8TztLzKHc/9C1uBCG27+q8= +golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ= +gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= +gopkg.in/check.v1 v1.0.0-20190902080502-41f04d3bba15/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= +gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c h1:Hei/4ADfdWqJk1ZMxUNpqntNwaWcugrBjAiHlqqRiVk= +gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c/go.mod h1:JHkPIbrfpd72SG/EVd6muEfDQjcINNoR0C8j2r3qZ4Q= +gopkg.in/warnings.v0 v0.1.2 h1:wFXVbFY8DY5/xOe1ECiWdKCzZlxgshcYVNkBHstARME= +gopkg.in/warnings.v0 v0.1.2/go.mod h1:jksf8JmL6Qr/oQM2OXTHunEvvTAsrWBLb6OOjuVWRNI= +gopkg.in/yaml.v2 v2.2.2/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI= +gopkg.in/yaml.v2 v2.4.0/go.mod h1:RDklbk79AGWmwhnvt/jBztapEOGDOx6ZbXqjP6csGnQ= +gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA= +gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= diff --git a/v3/examples/notifications/main.go b/v3/examples/notifications/main.go new file mode 100644 index 000000000..c0e006652 --- /dev/null +++ b/v3/examples/notifications/main.go @@ -0,0 +1,82 @@ +package main + +import ( + "embed" + _ "embed" + "fmt" + "log" + + "github.com/wailsapp/wails/v3/pkg/application" + "github.com/wailsapp/wails/v3/pkg/services/notifications" +) + +// Wails uses Go's `embed` package to embed the frontend files into the binary. +// Any files in the frontend/dist folder will be embedded into the binary and +// made available to the frontend. +// See https://pkg.go.dev/embed for more information. + +//go:embed all:frontend/dist +var assets embed.FS + +// main function serves as the application's entry point. It initializes the application, creates a window, +// and starts a goroutine that emits a time-based event every second. It subsequently runs the application and +// logs any error that might occur. +func main() { + // Create a new Notification Service + ns := notifications.New() + + // Create a new Wails application by providing the necessary options. + // Variables 'Name' and 'Description' are for application metadata. + // 'Assets' configures the asset server with the 'FS' variable pointing to the frontend files. + // 'Bind' is a list of Go struct instances. The frontend has access to the methods of these instances. + // 'Mac' options tailor the application when running an macOS. + app := application.New(application.Options{ + Name: "Notifications Demo", + Description: "A demo of using desktop notifications with Wails", + Services: []application.Service{ + application.NewService(ns), + }, + Assets: application.AssetOptions{ + Handler: application.AssetFileServerFS(assets), + }, + Mac: application.MacOptions{ + ApplicationShouldTerminateAfterLastWindowClosed: true, + }, + }) + + // Create a new window with the necessary options. + // 'Title' is the title of the window. + // 'Mac' options tailor the window when running on macOS. + // 'BackgroundColour' is the background colour of the window. + // 'URL' is the URL that will be loaded into the webview. + app.Window.NewWithOptions(application.WebviewWindowOptions{ + Title: "Window 1", + Name: "main", + Mac: application.MacWindow{ + InvisibleTitleBarHeight: 50, + Backdrop: application.MacBackdropTranslucent, + TitleBar: application.MacTitleBarHiddenInset, + }, + BackgroundColour: application.NewRGB(27, 38, 54), + URL: "/", + }) + + // Pass a notification callback that will be called when a notification is actioned. + ns.OnNotificationResponse(func(result notifications.NotificationResult) { + if result.Error != nil { + println(fmt.Errorf("parsing notification result failed: %s", result.Error)) + } else { + fmt.Printf("Response: %+v\n", result.Response) + println("Sending response to frontend...") + app.Event.Emit("notification:action", result.Response) + } + }) + + // Run the application. This blocks until the application has been exited. + err := app.Run() + + // If an error occurred while running the application, log it and exit. + if err != nil { + log.Fatal(err) + } +} diff --git a/v3/examples/panic-handling/README.md b/v3/examples/panic-handling/README.md new file mode 100644 index 000000000..99068495f --- /dev/null +++ b/v3/examples/panic-handling/README.md @@ -0,0 +1,11 @@ +# Panic Handling Example + +This example is a demonstration of how to handle panics in your application. + +## Running the example + +To run the example, simply run the following command: + +```bash +go run . +``` diff --git a/v3/examples/panic-handling/assets/index.html b/v3/examples/panic-handling/assets/index.html new file mode 100644 index 000000000..f4b5fe886 --- /dev/null +++ b/v3/examples/panic-handling/assets/index.html @@ -0,0 +1,27 @@ + + + + + + Window Call Demo + + + + + + + + + \ No newline at end of file diff --git a/v3/examples/panic-handling/main.go b/v3/examples/panic-handling/main.go new file mode 100644 index 000000000..3bf02136c --- /dev/null +++ b/v3/examples/panic-handling/main.go @@ -0,0 +1,62 @@ +package main + +import ( + "embed" + "fmt" + "github.com/wailsapp/wails/v3/pkg/application" + "log" +) + +//go:embed assets/* +var assets embed.FS + +var app *application.App + +type WindowService struct{} + +func (s *WindowService) GeneratePanic() { + s.call1() +} + +func (s *WindowService) call1() { + s.call2() +} + +func (s *WindowService) call2() { + panic("oh no! something went wrong deep in my service! :(") +} + +// ============================================== + +func main() { + app = application.New(application.Options{ + Name: "Panic Handler Demo", + Description: "A demo of Handling Panics", + Assets: application.AssetOptions{ + Handler: application.BundledAssetFileServer(assets), + }, + Mac: application.MacOptions{ + ApplicationShouldTerminateAfterLastWindowClosed: false, + }, + Services: []application.Service{ + application.NewService(&WindowService{}), + }, + PanicHandler: func(panicDetails *application.PanicDetails) { + fmt.Printf("*** There was a panic! ***\n") + fmt.Printf("Time: %s\n", panicDetails.Time) + fmt.Printf("Error: %s\n", panicDetails.Error) + fmt.Printf("Stacktrace: %s\n", panicDetails.StackTrace) + app.Dialog.Info().SetMessage("There was a panic!").Show() + }, + }) + + app.Window.New(). + SetTitle("WebviewWindow 1"). + Show() + + err := app.Run() + + if err != nil { + log.Fatal(err) + } +} diff --git a/v3/examples/plain/README.md b/v3/examples/plain/README.md new file mode 100644 index 000000000..9d44f5119 --- /dev/null +++ b/v3/examples/plain/README.md @@ -0,0 +1,19 @@ +# Plain Example + +This example is a demonstration of different ways to create applications without using npm. + +## Running the example + +To run the example, simply run the following command: + +```bash +go run . +``` + +# Status + +| Platform | Status | +|----------|---------| +| Mac | Working | +| Windows | Working | +| Linux | | diff --git a/v3/examples/plain/main.go b/v3/examples/plain/main.go new file mode 100644 index 000000000..3132d65b8 --- /dev/null +++ b/v3/examples/plain/main.go @@ -0,0 +1,84 @@ +package main + +import ( + _ "embed" + "log" + "net/http" + "time" + + "github.com/wailsapp/wails/v3/pkg/application" +) + +func main() { + app := application.New(application.Options{ + Name: "Plain", + Description: "A demo of using raw HTML & CSS", + Mac: application.MacOptions{ + ApplicationShouldTerminateAfterLastWindowClosed: true, + }, + Assets: application.AssetOptions{ + Handler: http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { + w.WriteHeader(http.StatusOK) + w.Write([]byte(`Plain Bundle

            Plain Bundle

            This is a plain bundle. It has no frontend code but this was Served by the AssetServer's Handler.



            Clicking this paragraph emits an event...

            `)) + }), + }, + }) + // Create window - Note: In future versions, window creation may return errors + // that should be checked. For now, window creation is deferred until app.Run() + app.Window.NewWithOptions(application.WebviewWindowOptions{ + Title: "Plain Bundle", + CSS: `body { background-color: rgb(255, 255, 255); font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", "Roboto", "Oxygen", "Ubuntu", "Cantarell", "Fira Sans", "Droid Sans", "Helvetica Neue", sans-serif; user-select: none; -ms-user-select: none; -webkit-user-select: none; } .main { color: white; margin: 20%; }`, + Mac: application.MacWindow{ + InvisibleTitleBarHeight: 50, + Backdrop: application.MacBackdropTranslucent, + TitleBar: application.MacTitleBarHiddenInsetUnified, + }, + URL: "/", + }) + + // Create second window with direct HTML content + app.Window.NewWithOptions(application.WebviewWindowOptions{ + Title: "HTML TEST", + HTML: "

            AWESOME!

            ", + CSS: `body { background-color: rgb(255, 0, 0); font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", "Roboto", "Oxygen", "Ubuntu", "Cantarell", "Fira Sans", "Droid Sans", "Helvetica Neue", sans-serif; user-select: none; -ms-user-select: none; -webkit-user-select: none; } .main { color: white; margin: 20%; }`, + JS: `window.iamhere = function() { console.log("Hello World!"); }`, + }) + + // Store the cleanup function to remove event listener when needed + removeClickHandler := app.Event.On("clicked", func(_ *application.CustomEvent) { + println("clicked") + }) + // Note: In a real application, you would call removeClickHandler() when appropriate + _ = removeClickHandler // Acknowledge we're storing the cleanup function + + // Use context-aware goroutine for graceful shutdown + go func() { + // Use a ticker instead of sleep to allow for cancellation + ticker := time.NewTicker(5 * time.Second) + defer ticker.Stop() + + select { + case <-ticker.C: + // Create window after delay - in production, you should handle potential errors + app.Window.NewWithOptions(application.WebviewWindowOptions{ + Title: "Plain Bundle new Window from GoRoutine", + Width: 500, + Height: 500, + Mac: application.MacWindow{ + Backdrop: application.MacBackdropTranslucent, + TitleBar: application.MacTitleBarHiddenInsetUnified, + InvisibleTitleBarHeight: 50, + }, + }) + case <-app.Context().Done(): + // Application is shutting down, cancel the goroutine + return + } + }() + + err := app.Run() + + if err != nil { + log.Fatal(err) + } +} diff --git a/v3/examples/print/.gitignore b/v3/examples/print/.gitignore new file mode 100644 index 000000000..bd7887dea --- /dev/null +++ b/v3/examples/print/.gitignore @@ -0,0 +1,2 @@ +bindings/ +build/ diff --git a/v3/examples/print/assets/index.html b/v3/examples/print/assets/index.html new file mode 100644 index 000000000..30ec4e0ab --- /dev/null +++ b/v3/examples/print/assets/index.html @@ -0,0 +1,143 @@ + + + + + + Print Dialog Test + + + +

            Print Dialog Test

            +

            Issue #4290: macOS Print dialog does not open

            + +
            +

            Test Instructions

            +
              +
            1. Click the "Print via Go API" button below, OR
            2. +
            3. Use the menu: File > Print, OR
            4. +
            5. Press Cmd+P
            6. +
            +

            Expected: A print dialog should appear as a sheet attached to this window.

            +

            Bug: Before the fix, nothing happens when trying to print.

            +
            + +
            +

            Test Actions

            + + +
            Ready to test...
            +
            + +
            +

            Sample Content to Print

            +

            This is sample content that should appear in the print preview.

            +
              +
            • Item 1: Testing print functionality
            • +
            • Item 2: Verifying dialog appearance
            • +
            • Item 3: Checking modal behavior
            • +
            +
            + +
            + Technical Details: +

            The bug was caused by passing a raw void* pointer instead of the properly cast NSWindow* to runOperationModalForWindow:.

            +

            Note: window.print() may not be natively supported in WKWebView. The Go API uses NSPrintOperation instead.

            +
            + + + + diff --git a/v3/examples/print/go.mod b/v3/examples/print/go.mod new file mode 100644 index 000000000..183b2bc09 --- /dev/null +++ b/v3/examples/print/go.mod @@ -0,0 +1,49 @@ +module print + +go 1.25 + +replace github.com/wailsapp/wails/v3 => ../../ + +require github.com/wailsapp/wails/v3 v3.0.0-alpha.0 + +require ( + dario.cat/mergo v1.0.2 // indirect + github.com/Microsoft/go-winio v0.6.2 // indirect + github.com/ProtonMail/go-crypto v1.3.0 // indirect + github.com/adrg/xdg v0.5.3 // indirect + github.com/bep/debounce v1.2.1 // indirect + github.com/cloudflare/circl v1.6.3 // indirect + github.com/coder/websocket v1.8.14 // indirect + github.com/cyphar/filepath-securejoin v0.6.1 // indirect + github.com/ebitengine/purego v0.9.1 // indirect + github.com/emirpasic/gods v1.18.1 // indirect + github.com/go-git/gcfg v1.5.1-0.20230307220236-3a3c6141e376 // indirect + github.com/go-git/go-billy/v5 v5.7.0 // indirect + github.com/go-git/go-git/v5 v5.16.4 // indirect + github.com/go-ole/go-ole v1.3.0 // indirect + github.com/godbus/dbus/v5 v5.2.2 // indirect + github.com/golang/groupcache v0.0.0-20241129210726-2c02b8208cf8 // indirect + github.com/google/uuid v1.6.0 // indirect + github.com/jbenet/go-context v0.0.0-20150711004518-d14ea06fba99 // indirect + github.com/jchv/go-winloader v0.0.0-20250406163304-c1995be93bd1 // indirect + github.com/kevinburke/ssh_config v1.4.0 // indirect + github.com/klauspost/cpuid/v2 v2.3.0 // indirect + github.com/leaanthony/go-ansi-parser v1.6.1 // indirect + github.com/leaanthony/u v1.1.1 // indirect + github.com/lmittmann/tint v1.1.2 // indirect + github.com/mattn/go-colorable v0.1.14 // indirect + github.com/mattn/go-isatty v0.0.20 // indirect + github.com/pjbgf/sha1cd v0.5.0 // indirect + github.com/pkg/browser v0.0.0-20240102092130-5ac0b6a4141c // indirect + github.com/rivo/uniseg v0.4.7 // indirect + github.com/samber/lo v1.52.0 // indirect + github.com/sergi/go-diff v1.4.0 // indirect + github.com/skeema/knownhosts v1.3.2 // indirect + github.com/wailsapp/go-webview2 v1.0.23 // indirect + github.com/xanzy/ssh-agent v0.3.3 // indirect + golang.org/x/crypto v0.47.0 // indirect + golang.org/x/net v0.49.0 // indirect + golang.org/x/sys v0.40.0 // indirect + golang.org/x/text v0.33.0 // indirect + gopkg.in/warnings.v0 v0.1.2 // indirect +) diff --git a/v3/examples/print/go.sum b/v3/examples/print/go.sum new file mode 100644 index 000000000..56f1153ea --- /dev/null +++ b/v3/examples/print/go.sum @@ -0,0 +1,147 @@ +dario.cat/mergo v1.0.2 h1:85+piFYR1tMbRrLcDwR18y4UKJ3aH1Tbzi24VRW1TK8= +dario.cat/mergo v1.0.2/go.mod h1:E/hbnu0NxMFBjpMIE34DRGLWqDy0g5FuKDhCb31ngxA= +github.com/Microsoft/go-winio v0.5.2/go.mod h1:WpS1mjBmmwHBEWmogvA2mj8546UReBk4v8QkMxJ6pZY= +github.com/Microsoft/go-winio v0.6.2 h1:F2VQgta7ecxGYO8k3ZZz3RS8fVIXVxONVUPlNERoyfY= +github.com/Microsoft/go-winio v0.6.2/go.mod h1:yd8OoFMLzJbo9gZq8j5qaps8bJ9aShtEA8Ipt1oGCvU= +github.com/ProtonMail/go-crypto v1.3.0 h1:ILq8+Sf5If5DCpHQp4PbZdS1J7HDFRXz/+xKBiRGFrw= +github.com/ProtonMail/go-crypto v1.3.0/go.mod h1:9whxjD8Rbs29b4XWbB8irEcE8KHMqaR2e7GWU1R+/PE= +github.com/adrg/xdg v0.5.3 h1:xRnxJXne7+oWDatRhR1JLnvuccuIeCoBu2rtuLqQB78= +github.com/adrg/xdg v0.5.3/go.mod h1:nlTsY+NNiCBGCK2tpm09vRqfVzrc2fLmXGpBLF0zlTQ= +github.com/anmitsu/go-shlex v0.0.0-20200514113438-38f4b401e2be h1:9AeTilPcZAjCFIImctFaOjnTIavg87rW78vTPkQqLI8= +github.com/anmitsu/go-shlex v0.0.0-20200514113438-38f4b401e2be/go.mod h1:ySMOLuWl6zY27l47sB3qLNK6tF2fkHG55UZxx8oIVo4= +github.com/armon/go-socks5 v0.0.0-20160902184237-e75332964ef5 h1:0CwZNZbxp69SHPdPJAN/hZIm0C4OItdklCFmMRWYpio= +github.com/armon/go-socks5 v0.0.0-20160902184237-e75332964ef5/go.mod h1:wHh0iHkYZB8zMSxRWpUBQtwG5a7fFgvEO+odwuTv2gs= +github.com/bep/debounce v1.2.1 h1:v67fRdBA9UQu2NhLFXrSg0Brw7CexQekrBwDMM8bzeY= +github.com/bep/debounce v1.2.1/go.mod h1:H8yggRPQKLUhUoqrJC1bO2xNya7vanpDl7xR3ISbCJ0= +github.com/cloudflare/circl v1.6.3 h1:9GPOhQGF9MCYUeXyMYlqTR6a5gTrgR/fBLXvUgtVcg8= +github.com/cloudflare/circl v1.6.3/go.mod h1:2eXP6Qfat4O/Yhh8BznvKnJ+uzEoTQ6jVKJRn81BiS4= +github.com/coder/websocket v1.8.14 h1:9L0p0iKiNOibykf283eHkKUHHrpG7f65OE3BhhO7v9g= +github.com/coder/websocket v1.8.14/go.mod h1:NX3SzP+inril6yawo5CQXx8+fk145lPDC6pumgx0mVg= +github.com/cyphar/filepath-securejoin v0.6.1 h1:5CeZ1jPXEiYt3+Z6zqprSAgSWiggmpVyciv8syjIpVE= +github.com/cyphar/filepath-securejoin v0.6.1/go.mod h1:A8hd4EnAeyujCJRrICiOWqjS1AX0a9kM5XL+NwKoYSc= +github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= +github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c= +github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= +github.com/ebitengine/purego v0.9.1 h1:a/k2f2HQU3Pi399RPW1MOaZyhKJL9w/xFpKAg4q1s0A= +github.com/ebitengine/purego v0.9.1/go.mod h1:iIjxzd6CiRiOG0UyXP+V1+jWqUXVjPKLAI0mRfJZTmQ= +github.com/elazarl/goproxy v1.7.2 h1:Y2o6urb7Eule09PjlhQRGNsqRfPmYI3KKQLFpCAV3+o= +github.com/elazarl/goproxy v1.7.2/go.mod h1:82vkLNir0ALaW14Rc399OTTjyNREgmdL2cVoIbS6XaE= +github.com/emirpasic/gods v1.18.1 h1:FXtiHYKDGKCW2KzwZKx0iC0PQmdlorYgdFG9jPXJ1Bc= +github.com/emirpasic/gods v1.18.1/go.mod h1:8tpGGwCnJ5H4r6BWwaV6OrWmMoPhUl5jm/FMNAnJvWQ= +github.com/gliderlabs/ssh v0.3.8 h1:a4YXD1V7xMF9g5nTkdfnja3Sxy1PVDCj1Zg4Wb8vY6c= +github.com/gliderlabs/ssh v0.3.8/go.mod h1:xYoytBv1sV0aL3CavoDuJIQNURXkkfPA/wxQ1pL1fAU= +github.com/go-git/gcfg v1.5.1-0.20230307220236-3a3c6141e376 h1:+zs/tPmkDkHx3U66DAb0lQFJrpS6731Oaa12ikc+DiI= +github.com/go-git/gcfg v1.5.1-0.20230307220236-3a3c6141e376/go.mod h1:an3vInlBmSxCcxctByoQdvwPiA7DTK7jaaFDBTtu0ic= +github.com/go-git/go-billy/v5 v5.7.0 h1:83lBUJhGWhYp0ngzCMSgllhUSuoHP1iEWYjsPl9nwqM= +github.com/go-git/go-billy/v5 v5.7.0/go.mod h1:/1IUejTKH8xipsAcdfcSAlUlo2J7lkYV8GTKxAT/L3E= +github.com/go-git/go-git-fixtures/v4 v4.3.2-0.20231010084843-55a94097c399 h1:eMje31YglSBqCdIqdhKBW8lokaMrL3uTkpGYlE2OOT4= +github.com/go-git/go-git-fixtures/v4 v4.3.2-0.20231010084843-55a94097c399/go.mod h1:1OCfN199q1Jm3HZlxleg+Dw/mwps2Wbk9frAWm+4FII= +github.com/go-git/go-git/v5 v5.16.4 h1:7ajIEZHZJULcyJebDLo99bGgS0jRrOxzZG4uCk2Yb2Y= +github.com/go-git/go-git/v5 v5.16.4/go.mod h1:4Ge4alE/5gPs30F2H1esi2gPd69R0C39lolkucHBOp8= +github.com/go-json-experiment/json v0.0.0-20251027170946-4849db3c2f7e h1:Lf/gRkoycfOBPa42vU2bbgPurFong6zXeFtPoxholzU= +github.com/go-json-experiment/json v0.0.0-20251027170946-4849db3c2f7e/go.mod h1:uNVvRXArCGbZ508SxYYTC5v1JWoz2voff5pm25jU1Ok= +github.com/go-ole/go-ole v1.3.0 h1:Dt6ye7+vXGIKZ7Xtk4s6/xVdGDQynvom7xCFEdWr6uE= +github.com/go-ole/go-ole v1.3.0/go.mod h1:5LS6F96DhAwUc7C+1HLexzMXY1xGRSryjyPPKW6zv78= +github.com/godbus/dbus/v5 v5.2.2 h1:TUR3TgtSVDmjiXOgAAyaZbYmIeP3DPkld3jgKGV8mXQ= +github.com/godbus/dbus/v5 v5.2.2/go.mod h1:3AAv2+hPq5rdnr5txxxRwiGjPXamgoIHgz9FPBfOp3c= +github.com/golang/groupcache v0.0.0-20241129210726-2c02b8208cf8 h1:f+oWsMOmNPc8JmEHVZIycC7hBoQxHH9pNKQORJNozsQ= +github.com/golang/groupcache v0.0.0-20241129210726-2c02b8208cf8/go.mod h1:wcDNUvekVysuuOpQKo3191zZyTpiI6se1N1ULghS0sw= +github.com/google/go-cmp v0.7.0 h1:wk8382ETsv4JYUZwIsn6YpYiWiBsYLSJiTsyBybVuN8= +github.com/google/go-cmp v0.7.0/go.mod h1:pXiqmnSA92OHEEa9HXL2W4E7lf9JzCmGVUdgjX3N/iU= +github.com/google/uuid v1.6.0 h1:NIvaJDMOsjHA8n1jAhLSgzrAzy1Hgr+hNrb57e+94F0= +github.com/google/uuid v1.6.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo= +github.com/jbenet/go-context v0.0.0-20150711004518-d14ea06fba99 h1:BQSFePA1RWJOlocH6Fxy8MmwDt+yVQYULKfN0RoTN8A= +github.com/jbenet/go-context v0.0.0-20150711004518-d14ea06fba99/go.mod h1:1lJo3i6rXxKeerYnT8Nvf0QmHCRC1n8sfWVwXF2Frvo= +github.com/jchv/go-winloader v0.0.0-20250406163304-c1995be93bd1 h1:njuLRcjAuMKr7kI3D85AXWkw6/+v9PwtV6M6o11sWHQ= +github.com/jchv/go-winloader v0.0.0-20250406163304-c1995be93bd1/go.mod h1:alcuEEnZsY1WQsagKhZDsoPCRoOijYqhZvPwLG0kzVs= +github.com/kevinburke/ssh_config v1.4.0 h1:6xxtP5bZ2E4NF5tuQulISpTO2z8XbtH8cg1PWkxoFkQ= +github.com/kevinburke/ssh_config v1.4.0/go.mod h1:q2RIzfka+BXARoNexmF9gkxEX7DmvbW9P4hIVx2Kg4M= +github.com/klauspost/cpuid/v2 v2.3.0 h1:S4CRMLnYUhGeDFDqkGriYKdfoFlDnMtqTiI/sFzhA9Y= +github.com/klauspost/cpuid/v2 v2.3.0/go.mod h1:hqwkgyIinND0mEev00jJYCxPNVRVXFQeu1XKlok6oO0= +github.com/kr/pretty v0.1.0/go.mod h1:dAy3ld7l9f0ibDNOQOHHMYYIIbhfbHSm3C4ZsoJORNo= +github.com/kr/pretty v0.3.1 h1:flRD4NNwYAUpkphVc1HcthR4KEIFJ65n8Mw5qdRn3LE= +github.com/kr/pretty v0.3.1/go.mod h1:hoEshYVHaxMs3cyo3Yncou5ZscifuDolrwPKZanG3xk= +github.com/kr/pty v1.1.1/go.mod h1:pFQYn66WHrOpPYNljwOMqo10TkYh1fy3cYio2l3bCsQ= +github.com/kr/text v0.1.0/go.mod h1:4Jbv+DJW3UT/LiOwJeYQe1efqtUx/iVham/4vfdArNI= +github.com/kr/text v0.2.0 h1:5Nx0Ya0ZqY2ygV366QzturHI13Jq95ApcVaJBhpS+AY= +github.com/kr/text v0.2.0/go.mod h1:eLer722TekiGuMkidMxC/pM04lWEeraHUUmBw8l2grE= +github.com/leaanthony/go-ansi-parser v1.6.1 h1:xd8bzARK3dErqkPFtoF9F3/HgN8UQk0ed1YDKpEz01A= +github.com/leaanthony/go-ansi-parser v1.6.1/go.mod h1:+vva/2y4alzVmmIEpk9QDhA7vLC5zKDTRwfZGOp3IWU= +github.com/leaanthony/u v1.1.1 h1:TUFjwDGlNX+WuwVEzDqQwC2lOv0P4uhTQw7CMFdiK7M= +github.com/leaanthony/u v1.1.1/go.mod h1:9+o6hejoRljvZ3BzdYlVL0JYCwtnAsVuN9pVTQcaRfI= +github.com/lmittmann/tint v1.1.2 h1:2CQzrL6rslrsyjqLDwD11bZ5OpLBPU+g3G/r5LSfS8w= +github.com/lmittmann/tint v1.1.2/go.mod h1:HIS3gSy7qNwGCj+5oRjAutErFBl4BzdQP6cJZ0NfMwE= +github.com/matryer/is v1.4.0/go.mod h1:8I/i5uYgLzgsgEloJE1U6xx5HkBQpAZvepWuujKwMRU= +github.com/matryer/is v1.4.1 h1:55ehd8zaGABKLXQUe2awZ99BD/PTc2ls+KV/dXphgEQ= +github.com/matryer/is v1.4.1/go.mod h1:8I/i5uYgLzgsgEloJE1U6xx5HkBQpAZvepWuujKwMRU= +github.com/mattn/go-colorable v0.1.14 h1:9A9LHSqF/7dyVVX6g0U9cwm9pG3kP9gSzcuIPHPsaIE= +github.com/mattn/go-colorable v0.1.14/go.mod h1:6LmQG8QLFO4G5z1gPvYEzlUgJ2wF+stgPZH1UqBm1s8= +github.com/mattn/go-isatty v0.0.20 h1:xfD0iDuEKnDkl03q4limB+vH+GxLEtL/jb4xVJSWWEY= +github.com/mattn/go-isatty v0.0.20/go.mod h1:W+V8PltTTMOvKvAeJH7IuucS94S2C6jfK/D7dTCTo3Y= +github.com/onsi/gomega v1.34.1 h1:EUMJIKUjM8sKjYbtxQI9A4z2o+rruxnzNvpknOXie6k= +github.com/onsi/gomega v1.34.1/go.mod h1:kU1QgUvBDLXBJq618Xvm2LUX6rSAfRaFRTcdOeDLwwY= +github.com/pjbgf/sha1cd v0.5.0 h1:a+UkboSi1znleCDUNT3M5YxjOnN1fz2FhN48FlwCxs0= +github.com/pjbgf/sha1cd v0.5.0/go.mod h1:lhpGlyHLpQZoxMv8HcgXvZEhcGs0PG/vsZnEJ7H0iCM= +github.com/pkg/browser v0.0.0-20240102092130-5ac0b6a4141c h1:+mdjkGKdHQG3305AYmdv1U2eRNDiU2ErMBj1gwrq8eQ= +github.com/pkg/browser v0.0.0-20240102092130-5ac0b6a4141c/go.mod h1:7rwL4CYBLnjLxUqIJNnCWiEdr3bn6IUYi15bNlnbCCU= +github.com/pkg/errors v0.9.1 h1:FEBLx1zS214owpjy7qsBeixbURkuhQAwrK5UwLGTwt4= +github.com/pkg/errors v0.9.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0= +github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM= +github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= +github.com/rivo/uniseg v0.2.0/go.mod h1:J6wj4VEh+S6ZtnVlnTBMWIodfgj8LQOQFoIToxlJtxc= +github.com/rivo/uniseg v0.4.7 h1:WUdvkW8uEhrYfLC4ZzdpI2ztxP1I582+49Oc5Mq64VQ= +github.com/rivo/uniseg v0.4.7/go.mod h1:FN3SvrM+Zdj16jyLfmOkMNblXMcoc8DfTHruCPUcx88= +github.com/rogpeppe/go-internal v1.14.1 h1:UQB4HGPB6osV0SQTLymcB4TgvyWu6ZyliaW0tI/otEQ= +github.com/rogpeppe/go-internal v1.14.1/go.mod h1:MaRKkUm5W0goXpeCfT7UZI6fk/L7L7so1lCWt35ZSgc= +github.com/samber/lo v1.52.0 h1:Rvi+3BFHES3A8meP33VPAxiBZX/Aws5RxrschYGjomw= +github.com/samber/lo v1.52.0/go.mod h1:4+MXEGsJzbKGaUEQFKBq2xtfuznW9oz/WrgyzMzRoM0= +github.com/sergi/go-diff v1.4.0 h1:n/SP9D5ad1fORl+llWyN+D6qoUETXNZARKjyY2/KVCw= +github.com/sergi/go-diff v1.4.0/go.mod h1:A0bzQcvG0E7Rwjx0REVgAGH58e96+X0MeOfepqsbeW4= +github.com/sirupsen/logrus v1.7.0/go.mod h1:yWOB1SBYBC5VeMP7gHvWumXLIWorT60ONWic61uBYv0= +github.com/skeema/knownhosts v1.3.2 h1:EDL9mgf4NzwMXCTfaxSD/o/a5fxDw/xL9nkU28JjdBg= +github.com/skeema/knownhosts v1.3.2/go.mod h1:bEg3iQAuw+jyiw+484wwFJoKSLwcfd7fqRy+N0QTiow= +github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME= +github.com/stretchr/testify v1.2.2/go.mod h1:a8OnRcib4nhh0OaRAV+Yts87kKdq0PP7pXfy6kDkUVs= +github.com/stretchr/testify v1.4.0/go.mod h1:j7eGeouHqKxXV5pUuKE4zz7dFj8WfuZ+81PSLYec5m4= +github.com/stretchr/testify v1.11.1 h1:7s2iGBzp5EwR7/aIZr8ao5+dra3wiQyKjjFuvgVKu7U= +github.com/stretchr/testify v1.11.1/go.mod h1:wZwfW3scLgRK+23gO65QZefKpKQRnfz6sD981Nm4B6U= +github.com/wailsapp/go-webview2 v1.0.23 h1:jmv8qhz1lHibCc79bMM/a/FqOnnzOGEisLav+a0b9P0= +github.com/wailsapp/go-webview2 v1.0.23/go.mod h1:qJmWAmAmaniuKGZPWwne+uor3AHMB5PFhqiK0Bbj8kc= +github.com/xanzy/ssh-agent v0.3.3 h1:+/15pJfg/RsTxqYcX6fHqOXZwwMP+2VyYWJeWM2qQFM= +github.com/xanzy/ssh-agent v0.3.3/go.mod h1:6dzNDKs0J9rVPHPhaGCukekBHKqfl+L3KghI1Bc68Uw= +golang.org/x/crypto v0.0.0-20220622213112-05595931fe9d/go.mod h1:IxCIyHEi3zRg3s0A5j5BB6A9Jmi73HwBIUl50j+osU4= +golang.org/x/crypto v0.47.0 h1:V6e3FRj+n4dbpw86FJ8Fv7XVOql7TEwpHapKoMJ/GO8= +golang.org/x/crypto v0.47.0/go.mod h1:ff3Y9VzzKbwSSEzWqJsJVBnWmRwRSHt/6Op5n9bQc4A= +golang.org/x/exp v0.0.0-20260112195511-716be5621a96 h1:Z/6YuSHTLOHfNFdb8zVZomZr7cqNgTJvA8+Qz75D8gU= +golang.org/x/exp v0.0.0-20260112195511-716be5621a96/go.mod h1:nzimsREAkjBCIEFtHiYkrJyT+2uy9YZJB7H1k68CXZU= +golang.org/x/net v0.0.0-20211112202133-69e39bad7dc2/go.mod h1:9nx3DQGgdP8bBQD5qxJ1jj9UTztislL4KSBs9R2vV5Y= +golang.org/x/net v0.49.0 h1:eeHFmOGUTtaaPSGNmjBKpbng9MulQsJURQUAfUwY++o= +golang.org/x/net v0.49.0/go.mod h1:/ysNB2EvaqvesRkuLAyjI1ycPZlQHM3q01F02UY/MV8= +golang.org/x/sys v0.0.0-20191026070338-33540a1f6037/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20200810151505-1b9f1253b3ed/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20201119102817-f84b799fce68/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20210124154548-22da62e12c0c/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20210423082822-04245dca01da/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20210615035016-665e8c7367d1/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.0.0-20220715151400-c0bba94af5f8/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.1.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.6.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.40.0 h1:DBZZqJ2Rkml6QMQsZywtnjnnGvHza6BTfYFWY9kjEWQ= +golang.org/x/sys v0.40.0/go.mod h1:OgkHotnGiDImocRcuBABYBEXf8A9a87e/uXjp9XT3ks= +golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo= +golang.org/x/term v0.39.0 h1:RclSuaJf32jOqZz74CkPA9qFuVTX7vhLlpfj/IGWlqY= +golang.org/x/term v0.39.0/go.mod h1:yxzUCTP/U+FzoxfdKmLaA0RV1WgE0VY7hXBwKtY/4ww= +golang.org/x/text v0.3.6/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ= +golang.org/x/text v0.33.0 h1:B3njUFyqtHDUI5jMn1YIr5B0IE2U0qck04r6d4KPAxE= +golang.org/x/text v0.33.0/go.mod h1:LuMebE6+rBincTi9+xWTY8TztLzKHc/9C1uBCG27+q8= +golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ= +gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= +gopkg.in/check.v1 v1.0.0-20190902080502-41f04d3bba15/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= +gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c h1:Hei/4ADfdWqJk1ZMxUNpqntNwaWcugrBjAiHlqqRiVk= +gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c/go.mod h1:JHkPIbrfpd72SG/EVd6muEfDQjcINNoR0C8j2r3qZ4Q= +gopkg.in/warnings.v0 v0.1.2 h1:wFXVbFY8DY5/xOe1ECiWdKCzZlxgshcYVNkBHstARME= +gopkg.in/warnings.v0 v0.1.2/go.mod h1:jksf8JmL6Qr/oQM2OXTHunEvvTAsrWBLb6OOjuVWRNI= +gopkg.in/yaml.v2 v2.2.2/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI= +gopkg.in/yaml.v2 v2.4.0/go.mod h1:RDklbk79AGWmwhnvt/jBztapEOGDOx6ZbXqjP6csGnQ= +gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA= +gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= diff --git a/v3/examples/print/main.go b/v3/examples/print/main.go new file mode 100644 index 000000000..8de642cbc --- /dev/null +++ b/v3/examples/print/main.go @@ -0,0 +1,90 @@ +//go:build darwin + +package main + +import ( + "embed" + "log" + "runtime" + + "github.com/wailsapp/wails/v3/pkg/application" +) + +//go:embed assets/* +var assets embed.FS + +// PrintService provides print functionality to the frontend +type PrintService struct { + app *application.App +} + +func (p *PrintService) Print() error { + if w := p.app.Window.Current(); w != nil { + log.Println("PrintService.Print() called") + return w.Print() + } + return nil +} + +func main() { + // Only run on macOS + if runtime.GOOS != "darwin" { + log.Fatal("This test is only for macOS") + } + + printService := &PrintService{} + + app := application.New(application.Options{ + Name: "Print Dialog Test", + Description: "Test for macOS print dialog (Issue #4290)", + Assets: application.AssetOptions{ + Handler: application.BundledAssetFileServer(assets), + }, + Services: []application.Service{ + application.NewService(printService), + }, + }) + + printService.app = app + + // Create application menu + menu := app.NewMenu() + + // File menu + fileMenu := menu.AddSubmenu("File") + fileMenu.Add("Print..."). + SetAccelerator("CmdOrCtrl+P"). + OnClick(func(ctx *application.Context) { + if w := app.Window.Current(); w != nil { + log.Println("Attempting to print...") + if err := w.Print(); err != nil { + log.Printf("Print error: %v", err) + } else { + log.Println("Print completed (or dialog dismissed)") + } + } + }) + fileMenu.AddSeparator() + fileMenu.Add("Quit"). + SetAccelerator("CmdOrCtrl+Q"). + OnClick(func(ctx *application.Context) { + app.Quit() + }) + + app.Menu.Set(menu) + + // Create main window + app.Window.NewWithOptions(application.WebviewWindowOptions{ + Title: "Print Dialog Test - Issue #4290", + Width: 800, + Height: 600, + URL: "/index.html", + }) + + log.Println("Starting application. Use File > Print or Cmd+P to test print dialog.") + + err := app.Run() + if err != nil { + log.Fatal(err) + } +} diff --git a/v3/examples/raw-message/README.md b/v3/examples/raw-message/README.md new file mode 100644 index 000000000..8d28d4f8a --- /dev/null +++ b/v3/examples/raw-message/README.md @@ -0,0 +1,11 @@ +# Raw Message Example + +This example is a demonstration of sending raw messages from JS to Go. + +## Running the example + +To run the example, simply run the following command: + +```bash +go run main.go +``` diff --git a/v3/examples/raw-message/assets/index.html b/v3/examples/raw-message/assets/index.html new file mode 100644 index 000000000..52f174336 --- /dev/null +++ b/v3/examples/raw-message/assets/index.html @@ -0,0 +1,25 @@ + + + + + Title + + + + +

            Raw Message Demo

            +
            +To send a raw message from this window, enter some text and click the button: +
            +
            + + + + diff --git a/v3/examples/raw-message/main.go b/v3/examples/raw-message/main.go new file mode 100644 index 000000000..697773373 --- /dev/null +++ b/v3/examples/raw-message/main.go @@ -0,0 +1,46 @@ +package main + +import ( + "embed" + _ "embed" + "fmt" + "log" + + "github.com/wailsapp/wails/v3/pkg/application" +) + +//go:embed assets +var assets embed.FS + +func main() { + + app := application.New(application.Options{ + Name: "Raw Message Demo", + Description: "A demo of sending raw messages from the frontend", + Assets: application.AssetOptions{ + Handler: application.BundledAssetFileServer(assets), + }, + Mac: application.MacOptions{ + ApplicationShouldTerminateAfterLastWindowClosed: true, + }, + RawMessageHandler: func(window application.Window, message string, originInfo *application.OriginInfo) { + println(fmt.Sprintf("Raw message received from Window %s with message: %s, origin %s, topOrigin %s, isMainFrame %t", window.Name(), message, originInfo.Origin, originInfo.TopOrigin, originInfo.IsMainFrame)) + }, + }) + + app.Window.NewWithOptions(application.WebviewWindowOptions{ + Title: "Window 1", + Name: "Window 1", + Mac: application.MacWindow{ + Backdrop: application.MacBackdropTranslucent, + TitleBar: application.MacTitleBarHiddenInsetUnified, + InvisibleTitleBarHeight: 50, + }, + }) + + err := app.Run() + + if err != nil { + log.Fatal(err.Error()) + } +} diff --git a/v3/examples/screen/README.md b/v3/examples/screen/README.md new file mode 100644 index 000000000..1f922f341 --- /dev/null +++ b/v3/examples/screen/README.md @@ -0,0 +1,19 @@ +# Screen Example + +This example will detect all attached screens and display their details. + +## Running the example + +To run the example, simply run the following command: + +```bash +go run . +``` + +# Status + +| Platform | Status | +|----------|---------| +| Mac | Working | +| Windows | Working | +| Linux | | diff --git a/v3/examples/screen/assets/examples.js b/v3/examples/screen/assets/examples.js new file mode 100644 index 000000000..8abe3f0ca --- /dev/null +++ b/v3/examples/screen/assets/examples.js @@ -0,0 +1,206 @@ +window.examples = [ + [ + // Normal examples (demonstrate real life scenarios) + { + name: "Single 4k monitor", + screens: [ + {id: 1, w: 3840, h: 2160, s: 163.0 / 96, name: `27" 4K UHD 163DPI`}, + ] + }, + { + name: "Two monitors", + screens: [ + {id: 1, w: 3840, h: 2160, s: 163.0 / 96, name: `27" 4K UHD 163DPI`}, + {id: 2, w: 1920, h: 1080, s: 1, parent: {id: 1, align: "r", offset: 0}, name: `23" FHD 96DPI`}, + ] + }, + { + name: "Two monitors (2)", + screens: [ + {id: 1, w: 1920, h: 1080, s: 1, name: `23" FHD 96DPI`}, + {id: 2, w: 1920, h: 1080, s: 1.25, parent: {id: 1, align: "r", offset: 0}, name: `23" FHD 96DPI (125%)`}, + ] + }, + { + name: "Three monitors", + screens: [ + {id: 1, w: 3840, h: 2160, s: 163.0 / 96, name: `27" 4K UHD 163DPI`}, + {id: 2, w: 1920, h: 1080, s: 1, parent: {id: 1, align: "r", offset: 0}, name: `23" FHD 96DPI`}, + {id: 3, w: 1920, h: 1080, s: 1.25, parent: {id: 1, align: "l", offset: 0}, name: `23" FHD 96DPI (125%)`}, + ] + }, + { + name: "Four monitors", + screens: [ + {id: 1, w: 3840, h: 2160, s: 163.0 / 96, name: `27" 4K UHD 163DPI`}, + {id: 2, w: 1920, h: 1080, s: 1, parent: {id: 1, align: "r", offset: 0}, name: `23" FHD 96DPI`}, + {id: 3, w: 1920, h: 1080, s: 1.25, parent: {id: 2, align: "b", offset: 0}, name: `23" FHD 96DPI (125%)`}, + {id: 4, w: 1080, h: 1920, s: 1, parent: {id: 1, align: "l", offset: 0}, name: `23" FHD (90deg)`}, + ] + }, + ], + [ + // Test cases examples (demonstrate the algorithm basics) + { + name: "Child scaled, Start offset", + screens: [ + {id: 1, w: 1200, h: 1200, s: 1, name: "Parent"}, + {id: 2, w: 1200, h: 1200, s: 1.5, parent: {id: 1, align: "r", offset: 600}, name: "Child"}, + ] + }, + { + name: "Child scaled, End offset", + screens: [ + {id: 1, w: 1200, h: 1200, s: 1, name: "Parent"}, + {id: 2, w: 1200, h: 1200, s: 1.5, parent: {id: 1, align: "r", offset: -600}, name: "Child"}, + ] + }, + { + name: "Parent scaled, Start offset percent", + screens: [ + {id: 1, w: 1200, h: 1200, s: 1.5, name: "Parent"}, + {id: 2, w: 1200, h: 1200, s: 1, parent: {id: 1, align: "r", offset: 600}, name: "Child"}, + ] + }, + { + name: "Parent scaled, End offset percent", + screens: [ + {id: 1, w: 1200, h: 1200, s: 1.5, name: "Parent"}, + {id: 2, w: 1200, h: 1200, s: 1, parent: {id: 1, align: "r", offset: -600}, name: "Child"}, + ] + }, + { + name: "Parent scaled, Start align", + screens: [ + {id: 1, w: 1200, h: 1200, s: 1.5, name: "Parent"}, + {id: 2, w: 1200, h: 1100, s: 1, parent: {id: 1, align: "r", offset: 0}, name: "Child"}, + ] + }, + { + name: "Parent scaled, End align", + screens: [ + {id: 1, w: 1200, h: 1200, s: 1.5, name: "Parent"}, + {id: 2, w: 1200, h: 1200, s: 1, parent: {id: 1, align: "r", offset: 0}, name: "Child"}, + ] + }, + { + name: "Parent scaled, in-between", + screens: [ + {id: 1, w: 1200, h: 1200, s: 1.5, name: "Parent"}, + {id: 2, w: 1200, h: 1500, s: 1, parent: {id: 1, align: "r", offset: -200}, name: "Child"}, + ] + }, + ], + [ + // Edge cases examples + { + name: "Parent order (5 is parent of 4)", + screens: [ + {id: 1, w: 1920, h: 1080, s: 1}, + {id: 2, w: 1024, h: 600, s: 1.25, parent: {id: 1, align: "r", offset: -200}}, + {id: 3, w: 800, h: 800, s: 1.25, parent: {id: 2, align: "b", offset: 0}}, + {id: 4, w: 800, h: 1080, s: 1.5, parent: {id: 2, align: "re", offset: 100}}, + {id: 5, w: 600, h: 600, s: 1, parent: {id: 3, align: "r", offset: 100}}, + ] + }, + { + name: "de-intersection reparent", + screens: [ + {id: 1, w: 1920, h: 1080, s: 1}, + {id: 2, w: 1680, h: 1050, s: 1.25, parent: {id: 1, align: "r", offset: 10}}, + {id: 3, w: 1440, h: 900, s: 1.5, parent: {id: 1, align: "le", offset: 150}}, + {id: 4, w: 1024, h: 768, s: 1, parent: {id: 3, align: "bc", offset: -200}}, + {id: 5, w: 1024, h: 768, s: 1.25, parent: {id: 4, align: "r", offset: 400}}, + ] + }, + { + name: "de-intersection (unattached child)", + screens: [ + {id: 1, w: 1920, h: 1080, s: 1}, + {id: 2, w: 1024, h: 768, s: 1.5, parent: {id: 1, align: "le", offset: 10}}, + {id: 3, w: 1024, h: 768, s: 1.25, parent: {id: 2, align: "b", offset: 100}}, + {id: 4, w: 1024, h: 768, s: 1, parent: {id: 3, align: "r", offset: 500}}, + ] + }, + { + name: "Multiple de-intersection", + screens: [ + {id: 1, w: 1920, h: 1080, s: 1}, + {id: 2, w: 1024, h: 768, s: 1, parent: {id: 1, align: "be", offset: 0}}, + {id: 3, w: 1024, h: 768, s: 1, parent: {id: 2, align: "b", offset: 300}}, + {id: 4, w: 1024, h: 768, s: 1.5, parent: {id: 2, align: "le", offset: 100}}, + {id: 5, w: 1024, h: 768, s: 1, parent: {id: 4, align: "be", offset: 100}}, + ] + }, + { + name: "Multiple de-intersection (left-side)", + screens: [ + {id: 1, w: 1920, h: 1080, s: 1}, + {id: 2, w: 1024, h: 768, s: 1, parent: {id: 1, align: "le", offset: 0}}, + {id: 3, w: 1024, h: 768, s: 1, parent: {id: 2, align: "b", offset: 300}}, + {id: 4, w: 1024, h: 768, s: 1.5, parent: {id: 2, align: "le", offset: 100}}, + {id: 5, w: 1024, h: 768, s: 1, parent: {id: 4, align: "be", offset: 100}}, + ] + }, + { + name: "Parent de-intersection child offset", + screens: [ + {id: 1, w: 1600, h: 1600, s: 1.5}, + {id: 2, w: 800, h: 800, s: 1, parent: {id: 1, align: "r", offset: 0}}, + {id: 3, w: 800, h: 800, s: 1, parent: {id: 1, align: "r", offset: 800}}, + {id: 4, w: 800, h: 1600, s: 1, parent: {id: 2, align: "r", offset: 0}}, + ] + }, + ], +].map(sections => sections.map(layout => { + return parseLayout(layout) +})) + +function parseLayout(layout) { + const screens = [] + + for (const screen of layout.screens) { + let x = 0, y = 0 + const {w, h} = screen + + if (screen.parent) { + const parent = screens.find(s => s.ID == screen.parent.id).Bounds + const offset = screen.parent.offset + let align = screen.parent.align + let align2 = "" + + if (align.length == 2) { + align2 = align.charAt(1) + align = align.charAt(0) + } + + x = parent.X + y = parent.Y + // t: top, b: bottom, l: left, r: right, e: edge, c: corner + if (align == "t" || align == "b") { + x += offset + (align2 == "e" || align2 == "c" ? parent.Width : 0) - (align2 == "e" ? w : 0) + y += (align == "t" ? -h : parent.Height) + } else { + y += offset + (align2 == "e" || align2 == "c" ? parent.Height : 0) - (align2 == "e" ? h : 0) + x += (align == "l" ? -w : parent.Width) + } + } + + screens.push({ + ID: `${screen.id}`, + Name: screen.name ?? `Display${screen.id}`, + ScaleFactor: Math.round(screen.s * 100) / 100, + X: x, + Y: y, + Size: {Width: w, Height: h}, + Bounds: {X: x, Y: y, Width: w, Height: h}, + PhysicalBounds: {X: x, Y: y, Width: w, Height: h}, + WorkArea: {X: x, Y: y, Width: w, Height: h-Math.round(40*screen.s)}, + PhysicalWorkArea: {X: x, Y: y, Width: w, Height: h-Math.round(40*screen.s)}, + IsPrimary: screen.id == 1, + Rotation: 0 + }) + } + + return {name: layout.name, screens} +} diff --git a/v3/examples/screen/assets/index.html b/v3/examples/screen/assets/index.html new file mode 100644 index 000000000..780f5854d --- /dev/null +++ b/v3/examples/screen/assets/index.html @@ -0,0 +1,143 @@ + + + + + Screens Demo + + + +
            + + +
            + +  X: + + +  Width: + + +   + + +   + + +   + +   + Layers: +
            +
            +
            +
            + Screens:  + System + +  - Examples + : +   + + +
            +
            + Coordinates:  + Physical (PX) + Logical (DIP) + + +   + + + + + +
            +
            + + + + + + +
            + + + + + + diff --git a/v3/examples/screen/assets/main.js b/v3/examples/screen/assets/main.js new file mode 100644 index 000000000..316c08002 --- /dev/null +++ b/v3/examples/screen/assets/main.js @@ -0,0 +1,406 @@ +setExamplesType(document.getElementById('examples-type').value, 0) + +function setExamplesType(type, autoSelectLayout = 1) { + window.examples_type = parseInt(type) + document.getElementById('examples-list').innerHTML = examples[examples_type].map((layout, i) => { + return `${i + 1}` + }).join("\n") + if (autoSelectLayout != null) setLayout(autoSelectLayout) +} + +async function setLayout(indexOrLayout, physicalCoordinate = true) { + if (typeof indexOrLayout == 'number') { + await radioBtnClick(null, `#layout-selector [data-value="${indexOrLayout}"]`) + } else { + document.querySelectorAll('#layout-selector .active').forEach(el => el.classList.remove('active')) + window.layout = indexOrLayout + window.point = null + window.rect = null + await processLayout() + await draw() + } + + const physical = !parseInt(document.querySelector('#coordinate-selector .active').dataset.value) + if (physical != physicalCoordinate) { + await setCoordinateType(physicalCoordinate) + } +} + +async function setCoordinateType(physicalCoordinate = true) { + await radioBtnClick(null, `#coordinate-selector [data-value="${physicalCoordinate ? 0 : 1}"]`) +} + +async function radioBtnClick(e, selector) { + if (e == null) { + e = new Event("mousedown") + document.querySelector(selector).dispatchEvent(e) + } + if (!e.target.classList.contains('radio-btn')) return + const btnGroup = e.target.closest('.radio-btn-group') + btnGroup.querySelectorAll('.radio-btn.active').forEach(el => el.classList.remove('active')) + e.target.classList.add('active') + + if (btnGroup.id == 'layout-selector') { + window.point = null + window.rect = null + await processLayout() + } + + await draw() +} + +async function processLayout() { + const layoutBtn = document.querySelector('#layout-selector .active') + const i = layoutBtn ? parseInt(layoutBtn.dataset.value) : -1 + if (i == 0) { + // system screens + window.layout = { + name: '', + screens: await callBinding('main.ScreenService.GetSystemScreens'), + } + } else { + if (i > 0) { + // example layouts + window.layout = structuredClone(examples[examples_type][i - 1]) + } + layout.screens = await callBinding('main.ScreenService.ProcessExampleScreens', layout.screens) + } + document.getElementById('example-name').textContent = layout.name +} + +async function draw() { + console.log(layout) + let minX = 0, minY = 0, maxX = 0, maxY = 0; + let html = ''; + + const physical = !parseInt(document.querySelector('#coordinate-selector .active').dataset.value) + const retainViewbox = document.querySelector('#retain-viewbox').checked + + layout.screens.forEach(screen => { + const b = physical ? screen.PhysicalBounds : screen.Bounds + const wa = physical ? screen.PhysicalWorkArea : screen.WorkArea + const vbBounds = retainViewbox ? [screen.Bounds, screen.PhysicalBounds] : [b] + + minX = Math.min(minX, ...vbBounds.map(b => b.X)) + minY = Math.min(minY, ...vbBounds.map(b => b.Y)) + maxX = Math.max(maxX, ...vbBounds.map(b => b.X + b.Width)) + maxY = Math.max(maxY, ...vbBounds.map(b => b.Y + b.Height)) + + html += ` + + + + + + (${b.X}, ${b.Y}) + + ${screen.Name} + ${b.Width} x ${b.Height} + Scale factor: ${screen.ScaleFactor} + + + ` + }) + + const svg = document.getElementById('svg') + svg.innerHTML = ` + ${svg.querySelector('& > defs').outerHTML} + + ${html} + + + ` + + svg.setAttribute('viewBox', `${minX} ${minY} ${maxX - minX} ${maxY - minY}`) + + if (window.point) await probePoint() + if (window.rect) await drawRect() + + svg.onmousedown = async function(e) { + let pt = new DOMPoint(e.clientX, e.clientY) + pt = pt.matrixTransform(svg.getScreenCTM().inverse()) + pt.x = parseInt(pt.x) + pt.y = parseInt(pt.y) + if (e.buttons == 1) { + await probePoint({X: pt.x, Y: pt.y}) + } else if (e.buttons == 2) { + if (e.ctrlKey) { + if (!window.rect) { + window.rect = {X: pt.x, Y: pt.y, Width: 0, Height: 0} + } + if (!window.rectCursor) { + window.rectAnchor = {x: window.rect.X, y: window.rect.Y} + window.rectCursor = {x: window.rectAnchor.x + window.rect.Width, y: window.rectAnchor.y + window.rect.Height} + } + window.rectCursorOffset = { + x: pt.x - window.rectCursor.x, + y: pt.y - window.rectCursor.y, + } + } else { + window.rectAnchor = pt + window.rectCursorOffset = {x: 0, y: 0} + window.probing = true + drawRect({X: pt.x, Y: pt.y, Width: 0, Height: 0}) + window.probing = false + } + } else if (e.buttons == 4) { + drawRect({X: pt.x, Y: pt.y, Width: 50, Height: 50}) + } + } + svg.onmousemove = async function(e) { + if (window.probing) return + window.probing = true + if (e.buttons == 1) { + await svg.onmousedown(e) + } else if (e.buttons == 2) { + let pt = new DOMPoint(e.clientX, e.clientY) + pt = pt.matrixTransform(svg.getScreenCTM().inverse()) + if (e.ctrlKey) { + window.rectAnchor.x += pt.x - rectCursor.x - window.rectCursorOffset.x + window.rectAnchor.y += pt.y - rectCursor.y - window.rectCursorOffset.y + } + window.rectCursor = { + x: pt.x - window.rectCursorOffset.x, + y: pt.y - window.rectCursorOffset.y, + } + await drawRect({ + X: parseInt(Math.min(window.rectAnchor.x, window.rectCursor.x)), + Y: parseInt(Math.min(window.rectAnchor.y, window.rectCursor.y)), + Width: parseInt(Math.abs(window.rectCursor.x - window.rectAnchor.x)), + Height: parseInt(Math.abs(window.rectCursor.y - window.rectAnchor.y)), + }) + } + window.probing = false + } + svg.oncontextmenu = function(e) { + e.preventDefault() + } +} + +async function probePoint(p = null) { + const svg = document.getElementById('svg'); + const physical = !parseInt(document.querySelector('#coordinate-selector .active').dataset.value) + + if (p == null) { + if (window.pointIsPhysical == physical) { + p = window.point + } else { + p = (await callBinding('main.ScreenService.TransformPoint', window.point, window.pointIsPhysical))[0] + } + } + + window.point = p + window.pointIsPhysical = physical + const [ptTransformed, ptDblTransformed] = await callBinding('main.ScreenService.TransformPoint', p, physical) + + svg.getElementById('points').innerHTML = ` + + + + + ` + // await new Promise((resolve) => setTimeout(resolve, 200)) // delay + return ptDblTransformed +} + +async function drawRect(r = null) { + const svg = document.getElementById('svg'); + const physical = !parseInt(document.querySelector('#coordinate-selector .active').dataset.value) + + if (r == null) { + if (window.rectIsPhysical == physical) { + r = window.rect + } else { + r = await callBinding('main.ScreenService.TransformRect', window.rect, window.rectIsPhysical) + } + } + + if (!window.probing) { + window.rectAnchor = null + window.rectCursor = null + } + + document.getElementById('x').value = r.X + document.getElementById('y').value = r.Y + document.getElementById('w').value = r.Width + document.getElementById('h').value = r.Height + + window.rect = r + window.rectIsPhysical = physical + window.rTransformed = await callBinding('main.ScreenService.TransformRect', r, physical) + window.rDblTransformed = await callBinding('main.ScreenService.TransformRect', rTransformed, !physical) + window.rTransformed = rTransformed + + await rectLayers() + return rDblTransformed +} + +async function rectLayers() { + const s = document.getElementById('slider').value + if (window.rect == null) await test1() + + const r = await callBinding('main.ScreenService.TransformRect', rectIsPhysical ? rect : rTransformed, true) + const rShifted = {...r, X: r.X+50} + const rShiftedPhysical = await callBinding('main.ScreenService.TransformRect', rShifted, false) + + svg.getElementById('rects').innerHTML = [ + [window.rect, 'rgb(255 255 255 / 100%)'], // w + [window.rTransformed, 'rgb(0 255 0 / 25%)'], // g + [window.rDblTransformed, 'none'], // none + [rShifted, 'rgb(255 0 0 / 15%)'], // r + [rShiftedPhysical, 'rgb(0 0 255 / 15%)'], // b + ].filter((_,i) => i { + let lines = '' + if (i == 0) { + const center = {X: r.X + (r.Width-1)/2, Y: r.Y + (r.Height-1)/2} + lines += ` + + + ` + } + return `${lines}` + }).join('/n') +} + +async function updateDipRect(x, y=0, w=0, h=0) { + if (rect == null) { + await drawRect({ + X: +document.getElementById('x').value, + Y: +document.getElementById('y').value, + Width: +document.getElementById('w').value, + Height: +document.getElementById('h').value, + }) + } + // Simulate real window by first retrieving the physical bounds then transforming it to dip + // then updating the bounds and transforming it back to physical + let rPhysical = rectIsPhysical ? rect : rTransformed + const r = await callBinding('main.ScreenService.TransformRect', rPhysical, true) + r.X += x + r.Y += y + r.Width += w + r.Height += h + rPhysical = await callBinding('main.ScreenService.TransformRect', r, false) + drawRect(rectIsPhysical ? rPhysical : r) +} + +function arrowMove(e) { + let x = 0, y = 0 + if (e.key == 'ArrowLeft') x = -step.value + if (e.key == 'ArrowRight') x = +step.value + if (e.key == 'ArrowUp') y = -step.value + if (e.key == 'ArrowDown') y = +step.value + if (!(x || y)) return + e.preventDefault() + updateDipRect(x, y) +} + +async function test1() { + // Edge case 1: invalid dip rect: no physical rect can produce it + await setLayout(parseLayout({screens: [ + {id: 1, w: 1200, h: 1200, s: 1}, + {id: 2, w: 1200, h: 1100, s: 1.5, parent: {id: 1, align: "r", offset: 0}}, + ]}), false) + await drawRect({X: 1050, Y: 700, Width: 400, Height: 300}) +} + +async function test2() { + // Edge case 2: physical rect that changes when double transformed (2 physical rects produce the same dip rect) + await setLayout(parseLayout({screens: [ + {id: 1, w: 1200, h: 1200, s: 1.5}, + {id: 2, w: 1200, h: 900, s: 1, parent: {id: 1, align: "r", offset: 0}}, + ]}), true) + await drawRect({X: 1050, Y: 890, Width: 400, Height: 300}) +} + +async function probeLayout(finishup = true) { + const probeButtons = document.getElementById('probe-buttons') + const svg = document.getElementById('svg') + const threshold = 1 + + const physical = !parseInt(document.querySelector('#coordinate-selector .active').dataset.value) + window.cancelProbing = false + probeButtons.classList.add('active') + + const steps = 3 + let failed = false + for (const screen of layout.screens) { + if (window.cancelProbing) break + const b = physical ? screen.PhysicalBounds : screen.Bounds + const xStep = parseInt(b.Width / steps) || 1 + const yStep = parseInt(b.Height / steps) || 1 + let x = b.X, y = b.Y + let xDone = false, yDone = false + + while (!(yDone || window.cancelProbing)) { + if (y >= b.Y + b.Height - 1) { + y = b.Y + b.Height - 1 + yDone = true + } + x = b.X + xDone = false + while (!(xDone || window.cancelProbing)) { + if (x >= b.X + b.Width - 1) { + x = b.X + b.Width - 1 + xDone = true + } + const pt = {X: x, Y: y} + let ptDblTransformed, err + try { + ptDblTransformed = await probePoint(pt) + } catch (e) { + err = e + } + if (err || Math.abs(pt.X - ptDblTransformed.X) > threshold || Math.abs(pt.Y - ptDblTransformed.Y) > threshold) { + failed = true + console.log(pt, ptDblTransformed) + window.cancelProbing = true + setTimeout(() => { + alert(err ?? `**FAILED**\nProbing failed at point: {X: ${pt.X}, Y: ${pt.Y}}\nDouble transformed point: {X: ${ptDblTransformed.X}, Y: ${ptDblTransformed.Y}}\n(Exceeded threshold of ${threshold} pixels)`) + }, 50) + } + x += xStep + } + y += yStep + } + } + + if (finishup || window.cancelProbing) probeButtons.classList.remove('active') + if (!(failed || window.cancelProbing)) { + window.point = null + if (finishup) { + setTimeout(() => { + svg.getElementById('points').innerHTML = '' + alert(`Successfully probed all points!, All within threshold of ${threshold} pixels.`) + }, 50) + } + return true + } +} + +async function probeAllExamples() { + console.time('probeAllExamples') +loop1: + for (let typeI = 0; typeI < examples.length; typeI++) { + document.getElementById('examples-type').value = typeI + setExamplesType(typeI, null) + + for (let layoutI = (typeI ? 0 : -1); layoutI < examples[typeI].length; layoutI++) { + await radioBtnClick(null, `#layout-selector [data-value="${layoutI + 1}"]`) + for (let i = 0; i < 2; i++) { + const lastLayout = (typeI == examples.length - 1 && layoutI == examples[typeI].length - 1 && i == 1) + if (!await probeLayout(lastLayout)) break loop1 + if (i == 0) await setCoordinateType(!pointIsPhysical) + } + } + } + console.timeEnd('probeAllExamples') +} + +async function callBinding(name, ...params) { + return wails.Call.ByName(name, ...params) +} + +function showAdvanced(e) { + e.target.style.display = 'none' + document.querySelectorAll('.advanced').forEach(el => el.style.display = 'initial') +} diff --git a/v3/examples/screen/main.go b/v3/examples/screen/main.go new file mode 100644 index 000000000..75d0c8bd2 --- /dev/null +++ b/v3/examples/screen/main.go @@ -0,0 +1,78 @@ +package main + +import ( + "embed" + "log" + "log/slog" + "net/http" + "os" + "path/filepath" + "runtime" + + "github.com/wailsapp/wails/v3/pkg/application" +) + +//go:embed assets/* +var assets embed.FS + +func main() { + + app := application.New(application.Options{ + Name: "Screen Demo", + Description: "A demo of the Screen API", + Mac: application.MacOptions{ + ApplicationShouldTerminateAfterLastWindowClosed: true, + }, + Windows: application.WindowsOptions{ + WndProcInterceptor: nil, + DisableQuitOnLastWindowClosed: false, + WebviewUserDataPath: "", + WebviewBrowserPath: "", + }, + Services: []application.Service{ + application.NewService(&ScreenService{}), + }, + LogLevel: slog.LevelError, + Assets: application.AssetOptions{ + Handler: application.BundledAssetFileServer(assets), + Middleware: func(next http.Handler) http.Handler { + return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { + // Disable caching + w.Header().Set("Cache-Control", "no-cache, no-store, must-revalidate") + w.Header().Set("Pragma", "no-cache") + w.Header().Set("Expires", "0") + + _, filename, _, _ := runtime.Caller(0) + dir := filepath.Dir(filename) + url := r.URL.Path + path := dir + "/assets" + url + + if _, err := os.Stat(path); err == nil { + // Serve file from disk to make testing easy + http.ServeFile(w, r, path) + } else { + // Passthrough to the default asset handler if file not found on disk + next.ServeHTTP(w, r) + } + }) + }, + }, + }) + + app.Window.NewWithOptions(application.WebviewWindowOptions{ + Title: "Screen Demo", + Width: 800, + Height: 600, + Mac: application.MacWindow{ + Backdrop: application.MacBackdropTranslucent, + TitleBar: application.MacTitleBarHiddenInsetUnified, + InvisibleTitleBarHeight: 50, + }, + }) + + err := app.Run() + + if err != nil { + log.Fatal(err.Error()) + } +} diff --git a/v3/examples/screen/screens.go b/v3/examples/screen/screens.go new file mode 100644 index 000000000..95e8abed0 --- /dev/null +++ b/v3/examples/screen/screens.go @@ -0,0 +1,182 @@ +package main + +import ( + "github.com/wailsapp/wails/v3/pkg/application" +) + +type ScreenService struct { + screenManager application.ScreenManager + isExampleLayout bool +} + +// Helper to safely get float64 from interface{} +func getFloat64(v interface{}) float64 { + if v == nil { + return 0 + } + if f, ok := v.(float64); ok { + return f + } + return 0 +} + +// Helper to safely get int from interface{} (expecting float64 from JSON) +func getInt(v interface{}) int { + return int(getFloat64(v)) +} + +func (s *ScreenService) GetSystemScreens() []*application.Screen { + s.isExampleLayout = false + screens := application.Get().Screen.GetAll() + return screens +} + +func (s *ScreenService) ProcessExampleScreens(rawScreens []interface{}) []*application.Screen { + s.isExampleLayout = true + + parseRect := func(m map[string]interface{}) application.Rect { + if m == nil { + return application.Rect{} + } + return application.Rect{ + X: getInt(m["X"]), + Y: getInt(m["Y"]), + Width: getInt(m["Width"]), + Height: getInt(m["Height"]), + } + } + + // Prevent unbounded slice growth by limiting the number of screens + maxScreens := 32 // Reasonable limit for screen configurations + if len(rawScreens) > maxScreens { + rawScreens = rawScreens[:maxScreens] + } + + screens := make([]*application.Screen, 0, len(rawScreens)) + for _, s := range rawScreens { + sm, ok := s.(map[string]interface{}) + if !ok { + continue + } + + boundsVal, ok := sm["Bounds"] + if !ok { + continue + } + boundsMap, ok := boundsVal.(map[string]interface{}) + if !ok { + continue + } + bounds := parseRect(boundsMap) + + var id, name string + var isPrimary bool + if idVal, ok := sm["ID"].(string); ok { + id = idVal + } + if nameVal, ok := sm["Name"].(string); ok { + name = nameVal + } + if primaryVal, ok := sm["IsPrimary"].(bool); ok { + isPrimary = primaryVal + } + + var physicalBounds, workArea, physicalWorkArea application.Rect + if pb, ok := sm["PhysicalBounds"].(map[string]interface{}); ok { + physicalBounds = parseRect(pb) + } + if wa, ok := sm["WorkArea"].(map[string]interface{}); ok { + workArea = parseRect(wa) + } + if pwa, ok := sm["PhysicalWorkArea"].(map[string]interface{}); ok { + physicalWorkArea = parseRect(pwa) + } + + screens = append(screens, &application.Screen{ + ID: id, + Name: name, + X: bounds.X, + Y: bounds.Y, + Size: application.Size{Width: bounds.Width, Height: bounds.Height}, + Bounds: bounds, + PhysicalBounds: physicalBounds, + WorkArea: workArea, + PhysicalWorkArea: physicalWorkArea, + IsPrimary: isPrimary, + ScaleFactor: float32(getFloat64(sm["ScaleFactor"])), + Rotation: 0, + }) + } + + s.screenManager.LayoutScreens(screens) + return s.screenManager.GetAll() +} + +func (s *ScreenService) transformPoint(point application.Point, toDIP bool) application.Point { + if s.isExampleLayout { + if toDIP { + return s.screenManager.PhysicalToDipPoint(point) + } else { + return s.screenManager.DipToPhysicalPoint(point) + } + } else { + if toDIP { + return application.PhysicalToDipPoint(point) + } else { + return application.DipToPhysicalPoint(point) + } + } +} + +func (s *ScreenService) TransformPoint(point map[string]interface{}, toDIP bool) (points [2]application.Point) { + if point == nil { + return points + } + + pt := application.Point{ + X: getInt(point["X"]), + Y: getInt(point["Y"]), + } + + ptTransformed := s.transformPoint(pt, toDIP) + ptDblTransformed := s.transformPoint(ptTransformed, !toDIP) + + // double-transform a limited number of times to catch any double-rounding issues + // Limit iterations to prevent potential performance issues + maxIterations := 3 // Reduced from 10 to limit computational overhead + for i := 0; i < maxIterations; i++ { + ptTransformed = s.transformPoint(ptDblTransformed, toDIP) + ptDblTransformed = s.transformPoint(ptTransformed, !toDIP) + } + + points[0] = ptTransformed + points[1] = ptDblTransformed + return points +} + +func (s *ScreenService) TransformRect(rect map[string]interface{}, toDIP bool) application.Rect { + if rect == nil { + return application.Rect{} + } + + r := application.Rect{ + X: getInt(rect["X"]), + Y: getInt(rect["Y"]), + Width: getInt(rect["Width"]), + Height: getInt(rect["Height"]), + } + + if s.isExampleLayout { + if toDIP { + return s.screenManager.PhysicalToDipRect(r) + } else { + return s.screenManager.DipToPhysicalRect(r) + } + } else { + if toDIP { + return application.PhysicalToDipRect(r) + } else { + return application.DipToPhysicalRect(r) + } + } +} diff --git a/v3/examples/server/Dockerfile b/v3/examples/server/Dockerfile new file mode 100644 index 000000000..765354108 --- /dev/null +++ b/v3/examples/server/Dockerfile @@ -0,0 +1,55 @@ +# Wails Server Mode Dockerfile +# Multi-stage build for minimal image size +# +# BUILD FROM v3 ROOT (to use local code before server mode is published): +# docker build -t server-example -f examples/server/Dockerfile . +# +# BUILD FROM EXAMPLE DIR (after server mode is published): +# cd examples/server && docker build -t server-example . + +# Build stage +FROM golang:alpine AS builder + +WORKDIR /app + +# Install build dependencies +RUN apk add --no-cache git + +# Copy source code +COPY . . + +# If building from example dir, remove replace directive +# If building from v3 root, this is a no-op +RUN sed -i '/^replace/d' go.mod 2>/dev/null || true + +# Download dependencies +RUN go mod tidy + +# Build the server binary and prepare assets +# When building from v3 root, change to example dir +RUN if [ -d "examples/server" ]; then \ + cd examples/server && go build -tags server -ldflags="-s -w" -o /app/server . && \ + cp -r frontend/dist /app/frontend_dist; \ + else \ + go build -tags server -ldflags="-s -w" -o /app/server . && \ + cp -r frontend/dist /app/frontend_dist; \ + fi + +# Runtime stage - minimal image +FROM gcr.io/distroless/static-debian12 + +# Copy the binary +COPY --from=builder /app/server /server + +# Copy frontend assets +COPY --from=builder /app/frontend_dist /frontend/dist + +# Expose the default port +EXPOSE 8080 + +# Bind to all interfaces (required for Docker) +# Can be overridden at runtime with -e WAILS_SERVER_HOST=... +ENV WAILS_SERVER_HOST=0.0.0.0 + +# Run the server +ENTRYPOINT ["/server"] diff --git a/v3/examples/server/README.md b/v3/examples/server/README.md new file mode 100644 index 000000000..ca9f16514 --- /dev/null +++ b/v3/examples/server/README.md @@ -0,0 +1,134 @@ +# Server Mode Example + +> **Experimental** - This feature is experimental and may change in future releases. + +This example demonstrates running a Wails application in server mode - without a native GUI window. + +## What is Server Mode? + +Server mode allows you to run your Wails application as a pure HTTP server. This enables: + +- **Docker/Container deployments** - Deploy your Wails app without X11/Wayland dependencies +- **Server-side rendering** - Use your Wails app as a web server +- **Web-only access** - Share the same codebase between desktop and web deployments +- **CI/CD testing** - Run integration tests without a display server + +## Building and Running + +The recommended way to build server mode applications is using the Taskfile: + +```bash +# Build for server mode +wails3 task build:server + +# Build and run +wails3 task run:server +``` + +Or using Go directly: + +```bash +# Build with server tag +go build -tags server -o myapp-server . + +# Run +go run -tags server . +``` + +Then open in your browser. + +## Key Differences from Desktop Mode + +1. **No native window** - The app runs as an HTTP server only +2. **Browser access** - Users access the app via their web browser +3. **No CGO required** - Can build without CGO dependencies +4. **Window APIs are no-ops** - Calls to window-related APIs are safely ignored +5. **Browser windows** - Each browser tab is represented as a "window" named `browser-1`, `browser-2`, etc. + +## Events + +Events work bidirectionally in server mode: + +- **Frontend to Backend**: Events emitted from the browser are sent via HTTP and received by your Go event handlers +- **Backend to Frontend**: Events emitted from Go are broadcast to all connected browsers via WebSocket + +```go +// Listen for events from browsers +app.Event.On("user-action", func(event *application.CustomEvent) { + log.Printf("Event from %s: %v", event.Sender, event.Data) + // event.Sender will be "browser-1", "browser-2", etc. +}) + +// Emit events to all browsers +app.Event.Emit("server-update", data) +``` + +## Configuration + +Server mode is enabled by building with the `server` build tag. Configure the HTTP server options: + +```go +app := application.New(application.Options{ + // Configure the HTTP server (used when built with -tags server) + Server: application.ServerOptions{ + Host: "localhost", // Use "0.0.0.0" for all interfaces + Port: 8080, + }, + + // ... other options work the same as desktop mode +}) +``` + +## Health Check + +A health check endpoint is automatically available at `/health`: + +```bash +curl http://localhost:8080/health +# {"status":"ok"} +``` + +## Building for Production + +```bash +# Using Taskfile (recommended) +wails3 task build:server + +# Or using Go directly +go build -tags server -o myapp-server . +``` + +## Docker + +Build and run with Docker using the built-in tasks: + +```bash +# Build Docker image +task build:docker + +# Build and run +task run:docker + +# Run on a different port +task run:docker PORT=3000 +``` + +Or build manually: + +```bash +docker build -t server-example . +docker run --rm -p 8080:8080 server-example +``` + +## Limitations + +Since server mode runs without a native GUI, the following features are not available: + +- Native dialogs (file open/save, message boxes) +- System tray +- Native menus +- Window manipulation (resize, move, minimize, etc.) +- Clipboard access (use browser clipboard APIs instead) +- Screen information + +These APIs are safe to call but will have no effect or return default values. diff --git a/v3/examples/server/Taskfile.yml b/v3/examples/server/Taskfile.yml new file mode 100644 index 000000000..bc9d3acf8 --- /dev/null +++ b/v3/examples/server/Taskfile.yml @@ -0,0 +1,80 @@ +version: '3' + +vars: + APP_NAME: "server-example" + BIN_DIR: "bin" + +tasks: + default: + summary: Shows available tasks + cmds: + - task --list + + build: + summary: Builds the application in server mode + desc: | + Builds the application with the server build tag enabled. + Server mode runs as a pure HTTP server without native GUI dependencies. + deps: + - task: build:frontend + cmds: + - go build -tags server -o {{.BIN_DIR}}/{{.APP_NAME}} . + + build:frontend: + summary: Ensures frontend assets exist (static HTML, no build needed) + dir: frontend + sources: + - dist/index.html + preconditions: + - sh: test -f dist/index.html + msg: "frontend/dist/index.html not found" + + run: + summary: Builds and runs the application in server mode + deps: + - task: build + cmds: + - ./{{.BIN_DIR}}/{{.APP_NAME}} + + dev: + summary: Runs the application in development mode (no build step) + desc: | + Runs the application directly with `go run` for rapid development. + Changes require restarting the command. + cmds: + - go run -tags server . + + clean: + summary: Removes build artifacts + cmds: + - rm -rf {{.BIN_DIR}} + + build:docker: + summary: Builds a Docker image for deployment + desc: | + Builds from v3 root to include local server mode code. + After server mode is published, can build from example dir directly. + dir: ../.. + cmds: + - docker build -t {{.TAG | default "server-example:latest"}} -f examples/server/Dockerfile . + vars: + TAG: '{{.TAG}}' + preconditions: + - sh: docker info > /dev/null 2>&1 + msg: "Docker is required. Please install Docker first." + + run:docker: + summary: Builds and runs the Docker image + deps: + - task: build:docker + cmds: + - docker run --rm -p {{.PORT | default "8080"}}:8080 {{.TAG | default "server-example:latest"}} + vars: + TAG: '{{.TAG}}' + PORT: '{{.PORT}}' + + test: + summary: Runs the server mode tests + dir: ../../pkg/application + cmds: + - go test -tags server -v -run TestServerMode . diff --git a/v3/examples/server/frontend/dist/index.html b/v3/examples/server/frontend/dist/index.html new file mode 100644 index 000000000..207a89bad --- /dev/null +++ b/v3/examples/server/frontend/dist/index.html @@ -0,0 +1,187 @@ + + + + + + Wails Headless Example + + + + +
            +

            Wails Headless

            +

            Running without a native window

            + Server Mode + +
            + + +
            + +
            Enter a name and click Greet
            + +
            + +
            + +
            + Events: +
            +
            + +

            + This Wails application is running in headless mode.
            + It serves content via HTTP without requiring a native GUI. +

            +
            + + + + diff --git a/v3/examples/server/go.mod b/v3/examples/server/go.mod new file mode 100644 index 000000000..ba596d27a --- /dev/null +++ b/v3/examples/server/go.mod @@ -0,0 +1,50 @@ +module github.com/wailsapp/wails/v3/examples/server + +go 1.25 + +require github.com/wailsapp/wails/v3 v3.0.0-alpha.62 + +require ( + dario.cat/mergo v1.0.2 // indirect + github.com/Microsoft/go-winio v0.6.2 // indirect + github.com/ProtonMail/go-crypto v1.3.0 // indirect + github.com/adrg/xdg v0.5.3 // indirect + github.com/bep/debounce v1.2.1 // indirect + github.com/cloudflare/circl v1.6.3 // indirect + github.com/coder/websocket v1.8.14 // indirect + github.com/cyphar/filepath-securejoin v0.6.1 // indirect + github.com/ebitengine/purego v0.9.1 // indirect + github.com/emirpasic/gods v1.18.1 // indirect + github.com/go-git/gcfg v1.5.1-0.20230307220236-3a3c6141e376 // indirect + github.com/go-git/go-billy/v5 v5.7.0 // indirect + github.com/go-git/go-git/v5 v5.16.4 // indirect + github.com/go-ole/go-ole v1.3.0 // indirect + github.com/godbus/dbus/v5 v5.2.2 // indirect + github.com/golang/groupcache v0.0.0-20241129210726-2c02b8208cf8 // indirect + github.com/google/uuid v1.6.0 // indirect + github.com/jbenet/go-context v0.0.0-20150711004518-d14ea06fba99 // indirect + github.com/jchv/go-winloader v0.0.0-20250406163304-c1995be93bd1 // indirect + github.com/kevinburke/ssh_config v1.4.0 // indirect + github.com/klauspost/cpuid/v2 v2.3.0 // indirect + github.com/leaanthony/go-ansi-parser v1.6.1 // indirect + github.com/leaanthony/u v1.1.1 // indirect + github.com/lmittmann/tint v1.1.2 // indirect + github.com/mattn/go-colorable v0.1.14 // indirect + github.com/mattn/go-isatty v0.0.20 // indirect + github.com/pjbgf/sha1cd v0.5.0 // indirect + github.com/pkg/browser v0.0.0-20240102092130-5ac0b6a4141c // indirect + github.com/rivo/uniseg v0.4.7 // indirect + github.com/samber/lo v1.52.0 // indirect + github.com/sergi/go-diff v1.4.0 // indirect + github.com/skeema/knownhosts v1.3.2 // indirect + github.com/wailsapp/go-webview2 v1.0.23 // indirect + github.com/xanzy/ssh-agent v0.3.3 // indirect + golang.org/x/crypto v0.47.0 // indirect + golang.org/x/net v0.49.0 // indirect + golang.org/x/sys v0.40.0 // indirect + golang.org/x/text v0.33.0 // indirect + gopkg.in/warnings.v0 v0.1.2 // indirect +) + +// For local development - remove this line before publishing +replace github.com/wailsapp/wails/v3 => ../.. diff --git a/v3/examples/server/go.sum b/v3/examples/server/go.sum new file mode 100644 index 000000000..56f1153ea --- /dev/null +++ b/v3/examples/server/go.sum @@ -0,0 +1,147 @@ +dario.cat/mergo v1.0.2 h1:85+piFYR1tMbRrLcDwR18y4UKJ3aH1Tbzi24VRW1TK8= +dario.cat/mergo v1.0.2/go.mod h1:E/hbnu0NxMFBjpMIE34DRGLWqDy0g5FuKDhCb31ngxA= +github.com/Microsoft/go-winio v0.5.2/go.mod h1:WpS1mjBmmwHBEWmogvA2mj8546UReBk4v8QkMxJ6pZY= +github.com/Microsoft/go-winio v0.6.2 h1:F2VQgta7ecxGYO8k3ZZz3RS8fVIXVxONVUPlNERoyfY= +github.com/Microsoft/go-winio v0.6.2/go.mod h1:yd8OoFMLzJbo9gZq8j5qaps8bJ9aShtEA8Ipt1oGCvU= +github.com/ProtonMail/go-crypto v1.3.0 h1:ILq8+Sf5If5DCpHQp4PbZdS1J7HDFRXz/+xKBiRGFrw= +github.com/ProtonMail/go-crypto v1.3.0/go.mod h1:9whxjD8Rbs29b4XWbB8irEcE8KHMqaR2e7GWU1R+/PE= +github.com/adrg/xdg v0.5.3 h1:xRnxJXne7+oWDatRhR1JLnvuccuIeCoBu2rtuLqQB78= +github.com/adrg/xdg v0.5.3/go.mod h1:nlTsY+NNiCBGCK2tpm09vRqfVzrc2fLmXGpBLF0zlTQ= +github.com/anmitsu/go-shlex v0.0.0-20200514113438-38f4b401e2be h1:9AeTilPcZAjCFIImctFaOjnTIavg87rW78vTPkQqLI8= +github.com/anmitsu/go-shlex v0.0.0-20200514113438-38f4b401e2be/go.mod h1:ySMOLuWl6zY27l47sB3qLNK6tF2fkHG55UZxx8oIVo4= +github.com/armon/go-socks5 v0.0.0-20160902184237-e75332964ef5 h1:0CwZNZbxp69SHPdPJAN/hZIm0C4OItdklCFmMRWYpio= +github.com/armon/go-socks5 v0.0.0-20160902184237-e75332964ef5/go.mod h1:wHh0iHkYZB8zMSxRWpUBQtwG5a7fFgvEO+odwuTv2gs= +github.com/bep/debounce v1.2.1 h1:v67fRdBA9UQu2NhLFXrSg0Brw7CexQekrBwDMM8bzeY= +github.com/bep/debounce v1.2.1/go.mod h1:H8yggRPQKLUhUoqrJC1bO2xNya7vanpDl7xR3ISbCJ0= +github.com/cloudflare/circl v1.6.3 h1:9GPOhQGF9MCYUeXyMYlqTR6a5gTrgR/fBLXvUgtVcg8= +github.com/cloudflare/circl v1.6.3/go.mod h1:2eXP6Qfat4O/Yhh8BznvKnJ+uzEoTQ6jVKJRn81BiS4= +github.com/coder/websocket v1.8.14 h1:9L0p0iKiNOibykf283eHkKUHHrpG7f65OE3BhhO7v9g= +github.com/coder/websocket v1.8.14/go.mod h1:NX3SzP+inril6yawo5CQXx8+fk145lPDC6pumgx0mVg= +github.com/cyphar/filepath-securejoin v0.6.1 h1:5CeZ1jPXEiYt3+Z6zqprSAgSWiggmpVyciv8syjIpVE= +github.com/cyphar/filepath-securejoin v0.6.1/go.mod h1:A8hd4EnAeyujCJRrICiOWqjS1AX0a9kM5XL+NwKoYSc= +github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= +github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c= +github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= +github.com/ebitengine/purego v0.9.1 h1:a/k2f2HQU3Pi399RPW1MOaZyhKJL9w/xFpKAg4q1s0A= +github.com/ebitengine/purego v0.9.1/go.mod h1:iIjxzd6CiRiOG0UyXP+V1+jWqUXVjPKLAI0mRfJZTmQ= +github.com/elazarl/goproxy v1.7.2 h1:Y2o6urb7Eule09PjlhQRGNsqRfPmYI3KKQLFpCAV3+o= +github.com/elazarl/goproxy v1.7.2/go.mod h1:82vkLNir0ALaW14Rc399OTTjyNREgmdL2cVoIbS6XaE= +github.com/emirpasic/gods v1.18.1 h1:FXtiHYKDGKCW2KzwZKx0iC0PQmdlorYgdFG9jPXJ1Bc= +github.com/emirpasic/gods v1.18.1/go.mod h1:8tpGGwCnJ5H4r6BWwaV6OrWmMoPhUl5jm/FMNAnJvWQ= +github.com/gliderlabs/ssh v0.3.8 h1:a4YXD1V7xMF9g5nTkdfnja3Sxy1PVDCj1Zg4Wb8vY6c= +github.com/gliderlabs/ssh v0.3.8/go.mod h1:xYoytBv1sV0aL3CavoDuJIQNURXkkfPA/wxQ1pL1fAU= +github.com/go-git/gcfg v1.5.1-0.20230307220236-3a3c6141e376 h1:+zs/tPmkDkHx3U66DAb0lQFJrpS6731Oaa12ikc+DiI= +github.com/go-git/gcfg v1.5.1-0.20230307220236-3a3c6141e376/go.mod h1:an3vInlBmSxCcxctByoQdvwPiA7DTK7jaaFDBTtu0ic= +github.com/go-git/go-billy/v5 v5.7.0 h1:83lBUJhGWhYp0ngzCMSgllhUSuoHP1iEWYjsPl9nwqM= +github.com/go-git/go-billy/v5 v5.7.0/go.mod h1:/1IUejTKH8xipsAcdfcSAlUlo2J7lkYV8GTKxAT/L3E= +github.com/go-git/go-git-fixtures/v4 v4.3.2-0.20231010084843-55a94097c399 h1:eMje31YglSBqCdIqdhKBW8lokaMrL3uTkpGYlE2OOT4= +github.com/go-git/go-git-fixtures/v4 v4.3.2-0.20231010084843-55a94097c399/go.mod h1:1OCfN199q1Jm3HZlxleg+Dw/mwps2Wbk9frAWm+4FII= +github.com/go-git/go-git/v5 v5.16.4 h1:7ajIEZHZJULcyJebDLo99bGgS0jRrOxzZG4uCk2Yb2Y= +github.com/go-git/go-git/v5 v5.16.4/go.mod h1:4Ge4alE/5gPs30F2H1esi2gPd69R0C39lolkucHBOp8= +github.com/go-json-experiment/json v0.0.0-20251027170946-4849db3c2f7e h1:Lf/gRkoycfOBPa42vU2bbgPurFong6zXeFtPoxholzU= +github.com/go-json-experiment/json v0.0.0-20251027170946-4849db3c2f7e/go.mod h1:uNVvRXArCGbZ508SxYYTC5v1JWoz2voff5pm25jU1Ok= +github.com/go-ole/go-ole v1.3.0 h1:Dt6ye7+vXGIKZ7Xtk4s6/xVdGDQynvom7xCFEdWr6uE= +github.com/go-ole/go-ole v1.3.0/go.mod h1:5LS6F96DhAwUc7C+1HLexzMXY1xGRSryjyPPKW6zv78= +github.com/godbus/dbus/v5 v5.2.2 h1:TUR3TgtSVDmjiXOgAAyaZbYmIeP3DPkld3jgKGV8mXQ= +github.com/godbus/dbus/v5 v5.2.2/go.mod h1:3AAv2+hPq5rdnr5txxxRwiGjPXamgoIHgz9FPBfOp3c= +github.com/golang/groupcache v0.0.0-20241129210726-2c02b8208cf8 h1:f+oWsMOmNPc8JmEHVZIycC7hBoQxHH9pNKQORJNozsQ= +github.com/golang/groupcache v0.0.0-20241129210726-2c02b8208cf8/go.mod h1:wcDNUvekVysuuOpQKo3191zZyTpiI6se1N1ULghS0sw= +github.com/google/go-cmp v0.7.0 h1:wk8382ETsv4JYUZwIsn6YpYiWiBsYLSJiTsyBybVuN8= +github.com/google/go-cmp v0.7.0/go.mod h1:pXiqmnSA92OHEEa9HXL2W4E7lf9JzCmGVUdgjX3N/iU= +github.com/google/uuid v1.6.0 h1:NIvaJDMOsjHA8n1jAhLSgzrAzy1Hgr+hNrb57e+94F0= +github.com/google/uuid v1.6.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo= +github.com/jbenet/go-context v0.0.0-20150711004518-d14ea06fba99 h1:BQSFePA1RWJOlocH6Fxy8MmwDt+yVQYULKfN0RoTN8A= +github.com/jbenet/go-context v0.0.0-20150711004518-d14ea06fba99/go.mod h1:1lJo3i6rXxKeerYnT8Nvf0QmHCRC1n8sfWVwXF2Frvo= +github.com/jchv/go-winloader v0.0.0-20250406163304-c1995be93bd1 h1:njuLRcjAuMKr7kI3D85AXWkw6/+v9PwtV6M6o11sWHQ= +github.com/jchv/go-winloader v0.0.0-20250406163304-c1995be93bd1/go.mod h1:alcuEEnZsY1WQsagKhZDsoPCRoOijYqhZvPwLG0kzVs= +github.com/kevinburke/ssh_config v1.4.0 h1:6xxtP5bZ2E4NF5tuQulISpTO2z8XbtH8cg1PWkxoFkQ= +github.com/kevinburke/ssh_config v1.4.0/go.mod h1:q2RIzfka+BXARoNexmF9gkxEX7DmvbW9P4hIVx2Kg4M= +github.com/klauspost/cpuid/v2 v2.3.0 h1:S4CRMLnYUhGeDFDqkGriYKdfoFlDnMtqTiI/sFzhA9Y= +github.com/klauspost/cpuid/v2 v2.3.0/go.mod h1:hqwkgyIinND0mEev00jJYCxPNVRVXFQeu1XKlok6oO0= +github.com/kr/pretty v0.1.0/go.mod h1:dAy3ld7l9f0ibDNOQOHHMYYIIbhfbHSm3C4ZsoJORNo= +github.com/kr/pretty v0.3.1 h1:flRD4NNwYAUpkphVc1HcthR4KEIFJ65n8Mw5qdRn3LE= +github.com/kr/pretty v0.3.1/go.mod h1:hoEshYVHaxMs3cyo3Yncou5ZscifuDolrwPKZanG3xk= +github.com/kr/pty v1.1.1/go.mod h1:pFQYn66WHrOpPYNljwOMqo10TkYh1fy3cYio2l3bCsQ= +github.com/kr/text v0.1.0/go.mod h1:4Jbv+DJW3UT/LiOwJeYQe1efqtUx/iVham/4vfdArNI= +github.com/kr/text v0.2.0 h1:5Nx0Ya0ZqY2ygV366QzturHI13Jq95ApcVaJBhpS+AY= +github.com/kr/text v0.2.0/go.mod h1:eLer722TekiGuMkidMxC/pM04lWEeraHUUmBw8l2grE= +github.com/leaanthony/go-ansi-parser v1.6.1 h1:xd8bzARK3dErqkPFtoF9F3/HgN8UQk0ed1YDKpEz01A= +github.com/leaanthony/go-ansi-parser v1.6.1/go.mod h1:+vva/2y4alzVmmIEpk9QDhA7vLC5zKDTRwfZGOp3IWU= +github.com/leaanthony/u v1.1.1 h1:TUFjwDGlNX+WuwVEzDqQwC2lOv0P4uhTQw7CMFdiK7M= +github.com/leaanthony/u v1.1.1/go.mod h1:9+o6hejoRljvZ3BzdYlVL0JYCwtnAsVuN9pVTQcaRfI= +github.com/lmittmann/tint v1.1.2 h1:2CQzrL6rslrsyjqLDwD11bZ5OpLBPU+g3G/r5LSfS8w= +github.com/lmittmann/tint v1.1.2/go.mod h1:HIS3gSy7qNwGCj+5oRjAutErFBl4BzdQP6cJZ0NfMwE= +github.com/matryer/is v1.4.0/go.mod h1:8I/i5uYgLzgsgEloJE1U6xx5HkBQpAZvepWuujKwMRU= +github.com/matryer/is v1.4.1 h1:55ehd8zaGABKLXQUe2awZ99BD/PTc2ls+KV/dXphgEQ= +github.com/matryer/is v1.4.1/go.mod h1:8I/i5uYgLzgsgEloJE1U6xx5HkBQpAZvepWuujKwMRU= +github.com/mattn/go-colorable v0.1.14 h1:9A9LHSqF/7dyVVX6g0U9cwm9pG3kP9gSzcuIPHPsaIE= +github.com/mattn/go-colorable v0.1.14/go.mod h1:6LmQG8QLFO4G5z1gPvYEzlUgJ2wF+stgPZH1UqBm1s8= +github.com/mattn/go-isatty v0.0.20 h1:xfD0iDuEKnDkl03q4limB+vH+GxLEtL/jb4xVJSWWEY= +github.com/mattn/go-isatty v0.0.20/go.mod h1:W+V8PltTTMOvKvAeJH7IuucS94S2C6jfK/D7dTCTo3Y= +github.com/onsi/gomega v1.34.1 h1:EUMJIKUjM8sKjYbtxQI9A4z2o+rruxnzNvpknOXie6k= +github.com/onsi/gomega v1.34.1/go.mod h1:kU1QgUvBDLXBJq618Xvm2LUX6rSAfRaFRTcdOeDLwwY= +github.com/pjbgf/sha1cd v0.5.0 h1:a+UkboSi1znleCDUNT3M5YxjOnN1fz2FhN48FlwCxs0= +github.com/pjbgf/sha1cd v0.5.0/go.mod h1:lhpGlyHLpQZoxMv8HcgXvZEhcGs0PG/vsZnEJ7H0iCM= +github.com/pkg/browser v0.0.0-20240102092130-5ac0b6a4141c h1:+mdjkGKdHQG3305AYmdv1U2eRNDiU2ErMBj1gwrq8eQ= +github.com/pkg/browser v0.0.0-20240102092130-5ac0b6a4141c/go.mod h1:7rwL4CYBLnjLxUqIJNnCWiEdr3bn6IUYi15bNlnbCCU= +github.com/pkg/errors v0.9.1 h1:FEBLx1zS214owpjy7qsBeixbURkuhQAwrK5UwLGTwt4= +github.com/pkg/errors v0.9.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0= +github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM= +github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= +github.com/rivo/uniseg v0.2.0/go.mod h1:J6wj4VEh+S6ZtnVlnTBMWIodfgj8LQOQFoIToxlJtxc= +github.com/rivo/uniseg v0.4.7 h1:WUdvkW8uEhrYfLC4ZzdpI2ztxP1I582+49Oc5Mq64VQ= +github.com/rivo/uniseg v0.4.7/go.mod h1:FN3SvrM+Zdj16jyLfmOkMNblXMcoc8DfTHruCPUcx88= +github.com/rogpeppe/go-internal v1.14.1 h1:UQB4HGPB6osV0SQTLymcB4TgvyWu6ZyliaW0tI/otEQ= +github.com/rogpeppe/go-internal v1.14.1/go.mod h1:MaRKkUm5W0goXpeCfT7UZI6fk/L7L7so1lCWt35ZSgc= +github.com/samber/lo v1.52.0 h1:Rvi+3BFHES3A8meP33VPAxiBZX/Aws5RxrschYGjomw= +github.com/samber/lo v1.52.0/go.mod h1:4+MXEGsJzbKGaUEQFKBq2xtfuznW9oz/WrgyzMzRoM0= +github.com/sergi/go-diff v1.4.0 h1:n/SP9D5ad1fORl+llWyN+D6qoUETXNZARKjyY2/KVCw= +github.com/sergi/go-diff v1.4.0/go.mod h1:A0bzQcvG0E7Rwjx0REVgAGH58e96+X0MeOfepqsbeW4= +github.com/sirupsen/logrus v1.7.0/go.mod h1:yWOB1SBYBC5VeMP7gHvWumXLIWorT60ONWic61uBYv0= +github.com/skeema/knownhosts v1.3.2 h1:EDL9mgf4NzwMXCTfaxSD/o/a5fxDw/xL9nkU28JjdBg= +github.com/skeema/knownhosts v1.3.2/go.mod h1:bEg3iQAuw+jyiw+484wwFJoKSLwcfd7fqRy+N0QTiow= +github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME= +github.com/stretchr/testify v1.2.2/go.mod h1:a8OnRcib4nhh0OaRAV+Yts87kKdq0PP7pXfy6kDkUVs= +github.com/stretchr/testify v1.4.0/go.mod h1:j7eGeouHqKxXV5pUuKE4zz7dFj8WfuZ+81PSLYec5m4= +github.com/stretchr/testify v1.11.1 h1:7s2iGBzp5EwR7/aIZr8ao5+dra3wiQyKjjFuvgVKu7U= +github.com/stretchr/testify v1.11.1/go.mod h1:wZwfW3scLgRK+23gO65QZefKpKQRnfz6sD981Nm4B6U= +github.com/wailsapp/go-webview2 v1.0.23 h1:jmv8qhz1lHibCc79bMM/a/FqOnnzOGEisLav+a0b9P0= +github.com/wailsapp/go-webview2 v1.0.23/go.mod h1:qJmWAmAmaniuKGZPWwne+uor3AHMB5PFhqiK0Bbj8kc= +github.com/xanzy/ssh-agent v0.3.3 h1:+/15pJfg/RsTxqYcX6fHqOXZwwMP+2VyYWJeWM2qQFM= +github.com/xanzy/ssh-agent v0.3.3/go.mod h1:6dzNDKs0J9rVPHPhaGCukekBHKqfl+L3KghI1Bc68Uw= +golang.org/x/crypto v0.0.0-20220622213112-05595931fe9d/go.mod h1:IxCIyHEi3zRg3s0A5j5BB6A9Jmi73HwBIUl50j+osU4= +golang.org/x/crypto v0.47.0 h1:V6e3FRj+n4dbpw86FJ8Fv7XVOql7TEwpHapKoMJ/GO8= +golang.org/x/crypto v0.47.0/go.mod h1:ff3Y9VzzKbwSSEzWqJsJVBnWmRwRSHt/6Op5n9bQc4A= +golang.org/x/exp v0.0.0-20260112195511-716be5621a96 h1:Z/6YuSHTLOHfNFdb8zVZomZr7cqNgTJvA8+Qz75D8gU= +golang.org/x/exp v0.0.0-20260112195511-716be5621a96/go.mod h1:nzimsREAkjBCIEFtHiYkrJyT+2uy9YZJB7H1k68CXZU= +golang.org/x/net v0.0.0-20211112202133-69e39bad7dc2/go.mod h1:9nx3DQGgdP8bBQD5qxJ1jj9UTztislL4KSBs9R2vV5Y= +golang.org/x/net v0.49.0 h1:eeHFmOGUTtaaPSGNmjBKpbng9MulQsJURQUAfUwY++o= +golang.org/x/net v0.49.0/go.mod h1:/ysNB2EvaqvesRkuLAyjI1ycPZlQHM3q01F02UY/MV8= +golang.org/x/sys v0.0.0-20191026070338-33540a1f6037/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20200810151505-1b9f1253b3ed/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20201119102817-f84b799fce68/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20210124154548-22da62e12c0c/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20210423082822-04245dca01da/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20210615035016-665e8c7367d1/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.0.0-20220715151400-c0bba94af5f8/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.1.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.6.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.40.0 h1:DBZZqJ2Rkml6QMQsZywtnjnnGvHza6BTfYFWY9kjEWQ= +golang.org/x/sys v0.40.0/go.mod h1:OgkHotnGiDImocRcuBABYBEXf8A9a87e/uXjp9XT3ks= +golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo= +golang.org/x/term v0.39.0 h1:RclSuaJf32jOqZz74CkPA9qFuVTX7vhLlpfj/IGWlqY= +golang.org/x/term v0.39.0/go.mod h1:yxzUCTP/U+FzoxfdKmLaA0RV1WgE0VY7hXBwKtY/4ww= +golang.org/x/text v0.3.6/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ= +golang.org/x/text v0.33.0 h1:B3njUFyqtHDUI5jMn1YIr5B0IE2U0qck04r6d4KPAxE= +golang.org/x/text v0.33.0/go.mod h1:LuMebE6+rBincTi9+xWTY8TztLzKHc/9C1uBCG27+q8= +golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ= +gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= +gopkg.in/check.v1 v1.0.0-20190902080502-41f04d3bba15/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= +gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c h1:Hei/4ADfdWqJk1ZMxUNpqntNwaWcugrBjAiHlqqRiVk= +gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c/go.mod h1:JHkPIbrfpd72SG/EVd6muEfDQjcINNoR0C8j2r3qZ4Q= +gopkg.in/warnings.v0 v0.1.2 h1:wFXVbFY8DY5/xOe1ECiWdKCzZlxgshcYVNkBHstARME= +gopkg.in/warnings.v0 v0.1.2/go.mod h1:jksf8JmL6Qr/oQM2OXTHunEvvTAsrWBLb6OOjuVWRNI= +gopkg.in/yaml.v2 v2.2.2/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI= +gopkg.in/yaml.v2 v2.4.0/go.mod h1:RDklbk79AGWmwhnvt/jBztapEOGDOx6ZbXqjP6csGnQ= +gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA= +gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= diff --git a/v3/examples/server/main.go b/v3/examples/server/main.go new file mode 100644 index 000000000..5b9bbdbae --- /dev/null +++ b/v3/examples/server/main.go @@ -0,0 +1,82 @@ +package main + +import ( + "embed" + "log" + "log/slog" + "os" + "time" + + "github.com/wailsapp/wails/v3/pkg/application" +) + +//go:embed frontend/dist +var assets embed.FS + +// GreetService is a simple service that provides greeting functionality. +type GreetService struct{} + +// Greet returns a greeting message. +func (g *GreetService) Greet(name string) string { + if name == "" { + name = "World" + } + return "Hello, " + name + "!" +} + +func main() { + // Create a logger for better visibility + logger := slog.New(slog.NewTextHandler(os.Stdout, &slog.HandlerOptions{ + Level: slog.LevelInfo, + })) + + app := application.New(application.Options{ + Name: "Server Mode Example", + Description: "A Wails application running in server mode", + Logger: logger, + LogLevel: slog.LevelInfo, + + // Server mode is enabled by building with -tags server + // Host/port can be overridden via WAILS_SERVER_HOST and WAILS_SERVER_PORT env vars + Server: application.ServerOptions{ + Host: "localhost", + Port: 8080, + }, + + // Register services (bindings work the same as desktop mode) + Services: []application.Service{ + application.NewService(&GreetService{}), + }, + + // Serve frontend assets + Assets: application.AssetOptions{ + Handler: application.AssetFileServerFS(assets), + }, + }) + + log.Println("Starting Wails application in server mode...") + log.Println("Access at: http://localhost:8080") + log.Println("Health check: http://localhost:8080/health") + log.Println("Press Ctrl+C to stop") + + // Listen for broadcast events from browsers + app.Event.On("broadcast", func(event *application.CustomEvent) { + log.Printf("Received broadcast from %s: %v\n", event.Sender, event.Data) + }) + + // Emit periodic events to test WebSocket broadcasting + go func() { + time.Sleep(2 * time.Second) // Wait for server to start + ticker := time.NewTicker(5 * time.Second) + defer ticker.Stop() + for { + <-ticker.C + app.Event.Emit("server-tick", time.Now().Format(time.RFC3339)) + log.Println("Emitted server-tick event") + } + }() + + if err := app.Run(); err != nil { + log.Fatal(err) + } +} diff --git a/v3/examples/services/assets/bindings/github.com/wailsapp/wails/v3/examples/services/hashes/index.js b/v3/examples/services/assets/bindings/github.com/wailsapp/wails/v3/examples/services/hashes/index.js new file mode 100644 index 000000000..cb6c1ff84 --- /dev/null +++ b/v3/examples/services/assets/bindings/github.com/wailsapp/wails/v3/examples/services/hashes/index.js @@ -0,0 +1,14 @@ +// @ts-check +// Cynhyrchwyd y ffeil hon yn awtomatig. PEIDIWCH Â MODIWL +// This file is automatically generated. DO NOT EDIT + +import * as Service from "./service.js"; +export { + Service +}; + +import * as $models from "./models.js"; + +/** + * @typedef {$models.Hashes} Hashes + */ diff --git a/v3/examples/services/assets/bindings/github.com/wailsapp/wails/v3/examples/services/hashes/models.js b/v3/examples/services/assets/bindings/github.com/wailsapp/wails/v3/examples/services/hashes/models.js new file mode 100644 index 000000000..a48737a6b --- /dev/null +++ b/v3/examples/services/assets/bindings/github.com/wailsapp/wails/v3/examples/services/hashes/models.js @@ -0,0 +1,14 @@ +// @ts-check +// Cynhyrchwyd y ffeil hon yn awtomatig. PEIDIWCH Â MODIWL +// This file is automatically generated. DO NOT EDIT + +// eslint-disable-next-line @typescript-eslint/ban-ts-comment +// @ts-ignore: Unused imports +import {Create as $Create} from "/wails/runtime.js"; + +/** + * @typedef {Object} Hashes + * @property {string} md5 + * @property {string} sha1 + * @property {string} sha256 + */ diff --git a/v3/examples/services/assets/bindings/github.com/wailsapp/wails/v3/examples/services/hashes/service.js b/v3/examples/services/assets/bindings/github.com/wailsapp/wails/v3/examples/services/hashes/service.js new file mode 100644 index 000000000..f5c01b306 --- /dev/null +++ b/v3/examples/services/assets/bindings/github.com/wailsapp/wails/v3/examples/services/hashes/service.js @@ -0,0 +1,19 @@ +// @ts-check +// Cynhyrchwyd y ffeil hon yn awtomatig. PEIDIWCH Â MODIWL +// This file is automatically generated. DO NOT EDIT + +// eslint-disable-next-line @typescript-eslint/ban-ts-comment +// @ts-ignore: Unused imports +import {Call as $Call, CancellablePromise as $CancellablePromise, Create as $Create} from "/wails/runtime.js"; + +// eslint-disable-next-line @typescript-eslint/ban-ts-comment +// @ts-ignore: Unused imports +import * as $models from "./models.js"; + +/** + * @param {string} s + * @returns {$CancellablePromise<$models.Hashes>} + */ +export function Generate(s) { + return $Call.ByID(1123907498, s); +} diff --git a/v3/examples/services/assets/bindings/github.com/wailsapp/wails/v3/pkg/services/kvstore/index.js b/v3/examples/services/assets/bindings/github.com/wailsapp/wails/v3/pkg/services/kvstore/index.js new file mode 100644 index 000000000..d2bf43c94 --- /dev/null +++ b/v3/examples/services/assets/bindings/github.com/wailsapp/wails/v3/pkg/services/kvstore/index.js @@ -0,0 +1,8 @@ +// @ts-check +// Cynhyrchwyd y ffeil hon yn awtomatig. PEIDIWCH Â MODIWL +// This file is automatically generated. DO NOT EDIT + +import * as Service from "./service.js"; +export { + Service +}; diff --git a/v3/examples/services/assets/bindings/github.com/wailsapp/wails/v3/pkg/services/kvstore/keyvaluestore.js b/v3/examples/services/assets/bindings/github.com/wailsapp/wails/v3/pkg/services/kvstore/keyvaluestore.js new file mode 100644 index 000000000..e69de29bb diff --git a/v3/examples/services/assets/bindings/github.com/wailsapp/wails/v3/pkg/services/kvstore/service.js b/v3/examples/services/assets/bindings/github.com/wailsapp/wails/v3/pkg/services/kvstore/service.js new file mode 100644 index 000000000..b4285097c --- /dev/null +++ b/v3/examples/services/assets/bindings/github.com/wailsapp/wails/v3/pkg/services/kvstore/service.js @@ -0,0 +1,69 @@ +// @ts-check +// Cynhyrchwyd y ffeil hon yn awtomatig. PEIDIWCH Â MODIWL +// This file is automatically generated. DO NOT EDIT + +// eslint-disable-next-line @typescript-eslint/ban-ts-comment +// @ts-ignore: Unused imports +import {Call as $Call, Create as $Create} from "/wails/runtime.js"; + +/** + * Clear deletes all keys from the store. If AutoSave is true, the store is saved to disk. + * @returns {Promise & { cancel(): void }} + */ +export function Clear() { + let $resultPromise = /** @type {any} */($Call.ByID(816318109)); + return $resultPromise; +} + +/** + * Delete deletes the given key from the store. If AutoSave is true, the store is saved to disk. + * @param {string} key + * @returns {Promise & { cancel(): void }} + */ +export function Delete(key) { + let $resultPromise = /** @type {any} */($Call.ByID(2889946731, key)); + return $resultPromise; +} + +/** + * Get returns the value for the given key. If key is empty, the entire store is returned. + * @param {string} key + * @returns {Promise & { cancel(): void }} + */ +export function Get(key) { + let $resultPromise = /** @type {any} */($Call.ByID(376909388, key)); + return $resultPromise; +} + +/** + * Load loads the store from disk. + * If the store is in-memory, i.e. not associated with a file, Load has no effect. + * If the operation fails, a non-nil error is returned + * and the store's content and state at call time are preserved. + * @returns {Promise & { cancel(): void }} + */ +export function Load() { + let $resultPromise = /** @type {any} */($Call.ByID(1850778156)); + return $resultPromise; +} + +/** + * Save saves the store to disk. + * If the store is in-memory, i.e. not associated with a file, Save has no effect. + * @returns {Promise & { cancel(): void }} + */ +export function Save() { + let $resultPromise = /** @type {any} */($Call.ByID(3572737965)); + return $resultPromise; +} + +/** + * Set sets the value for the given key. If AutoSave is true, the store is saved to disk. + * @param {string} key + * @param {any} value + * @returns {Promise & { cancel(): void }} + */ +export function Set(key, value) { + let $resultPromise = /** @type {any} */($Call.ByID(2491766752, key, value)); + return $resultPromise; +} diff --git a/v3/examples/services/assets/bindings/github.com/wailsapp/wails/v3/pkg/services/log/index.js b/v3/examples/services/assets/bindings/github.com/wailsapp/wails/v3/pkg/services/log/index.js new file mode 100644 index 000000000..564a31eeb --- /dev/null +++ b/v3/examples/services/assets/bindings/github.com/wailsapp/wails/v3/pkg/services/log/index.js @@ -0,0 +1,12 @@ +// @ts-check +// Cynhyrchwyd y ffeil hon yn awtomatig. PEIDIWCH Â MODIWL +// This file is automatically generated. DO NOT EDIT + +import * as Service from "./service.js"; +export { + Service +}; + +export { + Level +} from "./models.js"; diff --git a/v3/examples/services/assets/bindings/github.com/wailsapp/wails/v3/pkg/services/log/models.js b/v3/examples/services/assets/bindings/github.com/wailsapp/wails/v3/pkg/services/log/models.js new file mode 100644 index 000000000..d8579b51a --- /dev/null +++ b/v3/examples/services/assets/bindings/github.com/wailsapp/wails/v3/pkg/services/log/models.js @@ -0,0 +1,26 @@ +// @ts-check +// Cynhyrchwyd y ffeil hon yn awtomatig. PEIDIWCH Â MODIWL +// This file is automatically generated. DO NOT EDIT + +// eslint-disable-next-line @typescript-eslint/ban-ts-comment +// @ts-ignore: Unused imports +import {Create as $Create} from "/wails/runtime.js"; + +/** + * A Level is the importance or severity of a log event. + * The higher the level, the more important or severe the event. + * + * Values are arbitrary, but there are four predefined ones. + * @typedef {number} Level + */ + +/** + * Predefined constants for type Level. + * @namespace + */ +export const Level = { + Debug: -4, + Info: 0, + Warning: 4, + Error: 8, +}; diff --git a/v3/examples/services/assets/bindings/github.com/wailsapp/wails/v3/pkg/services/log/service.js b/v3/examples/services/assets/bindings/github.com/wailsapp/wails/v3/pkg/services/log/service.js new file mode 100644 index 000000000..e5128d9bc --- /dev/null +++ b/v3/examples/services/assets/bindings/github.com/wailsapp/wails/v3/pkg/services/log/service.js @@ -0,0 +1,106 @@ +// @ts-check +// Cynhyrchwyd y ffeil hon yn awtomatig. PEIDIWCH Â MODIWL +// This file is automatically generated. DO NOT EDIT + +// eslint-disable-next-line @typescript-eslint/ban-ts-comment +// @ts-ignore: Unused imports +import {Call as $Call, Create as $Create} from "/wails/runtime.js"; + +// eslint-disable-next-line @typescript-eslint/ban-ts-comment +// @ts-ignore: Unused imports +import * as $models from "./models.js"; + +/** + * DebugContext logs at level [Debug]. + * @param {string} message + * @param {any[]} args + * @returns {Promise & { cancel(): void }} + */ +function DebugContext(message, ...args) { + let $resultPromise = /** @type {any} */($Call.ByID(1481024990, message, args)); + return $resultPromise; +} + +/** + * ErrorContext logs at level [Error]. + * @param {string} message + * @param {any[]} args + * @returns {Promise & { cancel(): void }} + */ +function ErrorContext(message, ...args) { + let $resultPromise = /** @type {any} */($Call.ByID(4028761057, message, args)); + return $resultPromise; +} + +/** + * InfoContext logs at level [Info]. + * @param {string} message + * @param {any[]} args + * @returns {Promise & { cancel(): void }} + */ +function InfoContext(message, ...args) { + let $resultPromise = /** @type {any} */($Call.ByID(1400061359, message, args)); + return $resultPromise; +} + +/** + * Log emits a log record with the current time and the given level and message. + * The Record's attributes consist of the Logger's attributes followed by + * the attributes specified by args. + * + * The attribute arguments are processed as follows: + * - If an argument is a string and this is not the last argument, + * the following argument is treated as the value and the two are combined + * into an attribute. + * - Otherwise, the argument is treated as a value with key "!BADKEY". + * + * Log feeds the binding call context into the configured logger, + * so custom handlers may access context values, e.g. the current window. + * @param {$models.Level} level + * @param {string} message + * @param {any[]} args + * @returns {Promise & { cancel(): void }} + */ +export function Log(level, message, ...args) { + let $resultPromise = /** @type {any} */($Call.ByID(4156699346, level, message, args)); + return $resultPromise; +} + +/** + * LogLevel returns the currently configured log level, + * that is either the one configured initially + * or the last value passed to [Service.SetLogLevel]. + * @returns {Promise<$models.Level> & { cancel(): void }} + */ +export function LogLevel() { + let $resultPromise = /** @type {any} */($Call.ByID(4058368160)); + return $resultPromise; +} + +/** + * SetLogLevel changes the current log level. + * @param {$models.Level} level + * @returns {Promise & { cancel(): void }} + */ +export function SetLogLevel(level) { + let $resultPromise = /** @type {any} */($Call.ByID(3988219088, level)); + return $resultPromise; +} + +/** + * WarningContext logs at level [Warn]. + * @param {string} message + * @param {any[]} args + * @returns {Promise & { cancel(): void }} + */ +function WarningContext(message, ...args) { + let $resultPromise = /** @type {any} */($Call.ByID(52282975, message, args)); + return $resultPromise; +} + +export { + DebugContext as Debug, + InfoContext as Info, + WarningContext as Warning, + ErrorContext as Error, +}; diff --git a/v3/examples/services/assets/bindings/github.com/wailsapp/wails/v3/pkg/services/sqlite/index.js b/v3/examples/services/assets/bindings/github.com/wailsapp/wails/v3/pkg/services/sqlite/index.js new file mode 100644 index 000000000..0918a51f0 --- /dev/null +++ b/v3/examples/services/assets/bindings/github.com/wailsapp/wails/v3/pkg/services/sqlite/index.js @@ -0,0 +1,22 @@ +// @ts-check +// Cynhyrchwyd y ffeil hon yn awtomatig. PEIDIWCH Â MODIWL +// This file is automatically generated. DO NOT EDIT + +import * as Service from "./service.js"; +export { + Service +}; + +import * as $models from "./models.js"; + +/** + * Row holds a single row in the result of a query. + * It is a key-value map where keys are column names. + * @typedef {$models.Row} Row + */ + +/** + * Rows holds the result of a query + * as an array of key-value maps where keys are column names. + * @typedef {$models.Rows} Rows + */ diff --git a/v3/examples/services/assets/bindings/github.com/wailsapp/wails/v3/pkg/services/sqlite/models.js b/v3/examples/services/assets/bindings/github.com/wailsapp/wails/v3/pkg/services/sqlite/models.js new file mode 100644 index 000000000..041151c86 --- /dev/null +++ b/v3/examples/services/assets/bindings/github.com/wailsapp/wails/v3/pkg/services/sqlite/models.js @@ -0,0 +1,25 @@ +// @ts-check +// Cynhyrchwyd y ffeil hon yn awtomatig. PEIDIWCH Â MODIWL +// This file is automatically generated. DO NOT EDIT + +// eslint-disable-next-line @typescript-eslint/ban-ts-comment +// @ts-ignore: Unused imports +import {Create as $Create} from "/wails/runtime.js"; + +/** + * Row holds a single row in the result of a query. + * It is a key-value map where keys are column names. + * @typedef {{ [_: string]: any }} Row + */ + +/** + * Rows holds the result of a query + * as an array of key-value maps where keys are column names. + * @typedef {Row[]} Rows + */ + +/** + * Stmt wraps a prepared sql statement pointer. + * It provides the same methods as the [sql.Stmt] type. + * @typedef {string} Stmt + */ diff --git a/v3/examples/services/assets/bindings/github.com/wailsapp/wails/v3/pkg/services/sqlite/service.js b/v3/examples/services/assets/bindings/github.com/wailsapp/wails/v3/pkg/services/sqlite/service.js new file mode 100644 index 000000000..9330c1e4d --- /dev/null +++ b/v3/examples/services/assets/bindings/github.com/wailsapp/wails/v3/pkg/services/sqlite/service.js @@ -0,0 +1,167 @@ +// @ts-check +// Cynhyrchwyd y ffeil hon yn awtomatig. PEIDIWCH Â MODIWL +// This file is automatically generated. DO NOT EDIT + +// eslint-disable-next-line @typescript-eslint/ban-ts-comment +// @ts-ignore: Unused imports +import {Call as $Call, Create as $Create} from "/wails/runtime.js"; + +// eslint-disable-next-line @typescript-eslint/ban-ts-comment +// @ts-ignore: Unused imports +import * as $models from "./models.js"; + +/** + * Close closes the current database connection if one is open, otherwise has no effect. + * Additionally, Close closes all open prepared statements associated to the connection. + * + * Even when a non-nil error is returned, + * the database service is left in a consistent state, + * ready for a call to [Service.Open]. + * @returns {Promise & { cancel(): void }} + */ +export function Close() { + let $resultPromise = /** @type {any} */($Call.ByID(1888105376)); + return $resultPromise; +} + +/** + * ClosePrepared closes a prepared statement + * obtained with [Service.Prepare] or [Service.PrepareContext]. + * ClosePrepared is idempotent: + * it has no effect on prepared statements that are already closed. + * @param {$models.Stmt | null} stmt + * @returns {Promise & { cancel(): void }} + */ +function ClosePrepared(stmt) { + let $resultPromise = /** @type {any} */($Call.ByID(2526200629, stmt)); + return $resultPromise; +} + +/** + * ExecContext executes a query without returning any rows. + * It supports early cancellation. + * @param {string} query + * @param {any[]} args + * @returns {Promise & { cancel(): void }} + */ +function ExecContext(query, ...args) { + let $resultPromise = /** @type {any} */($Call.ByID(674944556, query, args)); + return $resultPromise; +} + +/** + * ExecPrepared executes a prepared statement + * obtained with [Service.Prepare] or [Service.PrepareContext] + * without returning any rows. + * It supports early cancellation. + * @param {$models.Stmt | null} stmt + * @param {any[]} args + * @returns {Promise & { cancel(): void }} + */ +function ExecPrepared(stmt, ...args) { + let $resultPromise = /** @type {any} */($Call.ByID(2086877656, stmt, args)); + return $resultPromise; +} + +/** + * Open validates the current configuration, + * closes the current connection if one is present, + * then opens and validates a new connection. + * + * Even when a non-nil error is returned, + * the database service is left in a consistent state, + * ready for a new call to Open. + * @returns {Promise & { cancel(): void }} + */ +export function Open() { + let $resultPromise = /** @type {any} */($Call.ByID(2012175612)); + return $resultPromise; +} + +/** + * PrepareContext creates a prepared statement for later queries or executions. + * Multiple queries or executions may be run concurrently from the returned statement. + * + * The caller must call the statement's Close method when it is no longer needed. + * Statements are closed automatically + * when the connection they are associated with is closed. + * + * PrepareContext supports early cancellation. + * @param {string} query + * @returns {Promise<$models.Stmt | null> & { cancel(): void }} + */ +function PrepareContext(query) { + let $resultPromise = /** @type {any} */($Call.ByID(570941694, query)); + return $resultPromise; +} + +/** + * QueryContext executes a query and returns a slice of key-value records, + * one per row, with column names as keys. + * It supports early cancellation, returning the slice of results fetched so far. + * @param {string} query + * @param {any[]} args + * @returns {Promise<$models.Rows> & { cancel(): void }} + */ +function QueryContext(query, ...args) { + let $resultPromise = /** @type {any} */($Call.ByID(4115542347, query, args)); + let $typingPromise = /** @type {any} */($resultPromise.then(($result) => { + return $$createType1($result); + })); + $typingPromise.cancel = $resultPromise.cancel.bind($resultPromise); + return $typingPromise; +} + +/** + * QueryPrepared executes a prepared statement + * obtained with [Service.Prepare] or [Service.PrepareContext] + * and returns a slice of key-value records, one per row, with column names as keys. + * It supports early cancellation, returning the slice of results fetched so far. + * @param {$models.Stmt | null} stmt + * @param {any[]} args + * @returns {Promise<$models.Rows> & { cancel(): void }} + */ +function QueryPrepared(stmt, ...args) { + let $resultPromise = /** @type {any} */($Call.ByID(3885083725, stmt, args)); + let $typingPromise = /** @type {any} */($resultPromise.then(($result) => { + return $$createType1($result); + })); + $typingPromise.cancel = $resultPromise.cancel.bind($resultPromise); + return $typingPromise; +} + +// Private type creation functions +const $$createType0 = $Create.Map($Create.Any, $Create.Any); +const $$createType1 = $Create.Array($$createType0); + +export { + ExecContext as Execute, + QueryContext as Query +}; + +import { Stmt } from "./stmt.js"; + +/** + * Prepare creates a prepared statement for later queries or executions. + * Multiple queries or executions may be run concurrently from the returned statement. + * + * The caller must call the statement's Close method when it is no longer needed. + * Statements are closed automatically + * when the connection they are associated with is closed. + * + * Prepare supports early cancellation. + * + * @param {string} query + * @returns {Promise & { cancel(): void }} + */ +export function Prepare(query) { + const promise = PrepareContext(query); + const wrapper = /** @type {any} */(promise.then(function (id) { + return id == null ? null : new Stmt( + ClosePrepared.bind(null, id), + ExecPrepared.bind(null, id), + QueryPrepared.bind(null, id)); + })); + wrapper.cancel = promise.cancel; + return wrapper; +} diff --git a/v3/examples/services/assets/bindings/github.com/wailsapp/wails/v3/pkg/services/sqlite/stmt.js b/v3/examples/services/assets/bindings/github.com/wailsapp/wails/v3/pkg/services/sqlite/stmt.js new file mode 100644 index 000000000..948b0c3dd --- /dev/null +++ b/v3/examples/services/assets/bindings/github.com/wailsapp/wails/v3/pkg/services/sqlite/stmt.js @@ -0,0 +1,79 @@ +//@ts-check + +//@ts-ignore: Unused imports +import * as $models from "./models.js"; + +const execSymbol = Symbol("exec"), + querySymbol = Symbol("query"), + closeSymbol = Symbol("close"); + +/** + * Stmt represents a prepared statement for later queries or executions. + * Multiple queries or executions may be run concurrently on the same statement. + * + * The caller must call the statement's Close method when it is no longer needed. + * Statements are closed automatically + * when the connection they are associated with is closed. + */ +export class Stmt { + /** + * Constructs a new prepared statement instance. + * @param {(...args: any[]) => Promise} close + * @param {(...args: any[]) => Promise & { cancel(): void }} exec + * @param {(...args: any[]) => Promise<$models.Rows> & { cancel(): void }} query + */ + constructor(close, exec, query) { + /** + * @member + * @private + * @type {typeof close} + */ + this[closeSymbol] = close; + + /** + * @member + * @private + * @type {typeof exec} + */ + this[execSymbol] = exec; + + /** + * @member + * @private + * @type {typeof query} + */ + this[querySymbol] = query; + } + + /** + * Closes the prepared statement. + * It has no effect when the statement is already closed. + * @returns {Promise} + */ + Close() { + return this[closeSymbol](); + } + + /** + * Executes the prepared statement without returning any rows. + * It supports early cancellation. + * + * @param {any[]} args + * @returns {Promise & { cancel(): void }} + */ + Exec(...args) { + return this[execSymbol](...args); + } + + /** + * Executes the prepared statement + * and returns a slice of key-value records, one per row, with column names as keys. + * It supports early cancellation, returning the array of results fetched so far. + * + * @param {any[]} args + * @returns {Promise<$models.Rows> & { cancel(): void }} + */ + Query(...args) { + return this[querySymbol](...args); + } +} diff --git a/v3/examples/services/assets/index.html b/v3/examples/services/assets/index.html new file mode 100644 index 000000000..c44a0679a --- /dev/null +++ b/v3/examples/services/assets/index.html @@ -0,0 +1,287 @@ + + + + + Wails Alpha + + + + + + +

            Services

            +
            +
            + + + + +
            +
            +

            The sqlite service provides easy integration with sqlite dbs.

            +

            The demo DB has a single table: Users.

            +

            Enter a query below and hit the "Run" button.

            +
            +
            +
            + +
            +
            +
            +
            +
            +
            +

            The hashes service provides hashing functions.

            +
            +
            +
            + +
            +
            +
            +
            +
            +
            +

            The kvstore service provides a means for reading and writing to a json file.

            +

            Enter a key/value pair in the form below to add it to the file.

            +

            A blank value will remove the key.

            +
            +
            + + + +
            +
            +
            +
            +
            +
            +

            The log plugin provides a means for sending frontend logs to a Go logger.

            +

            Enter some text below, press submit and check your console logs.

            +
            + + + +
            +
            +
            + + diff --git a/v3/examples/services/assets/style.css b/v3/examples/services/assets/style.css new file mode 100644 index 000000000..f128a1aa1 --- /dev/null +++ b/v3/examples/services/assets/style.css @@ -0,0 +1,213 @@ +html { + background-color: rgba(33, 37, 43); + text-align: center; + color: white; + user-select: none; + -webkit-user-select: none; + -moz-user-select: none; + -ms-user-select: none; + -webkit-touch-callout: none; + height: 100vh; + width: 100%; +} + +body { + padding-top: 40px; + margin: 0; + font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", "Roboto", + "Oxygen", "Ubuntu", "Cantarell", "Fira Sans", "Droid Sans", "Helvetica Neue", + sans-serif; + overscroll-behavior: none; + overflow-y: hidden; + background-image: url("/files/images/eryri1.png"); + background-color: rgba(33, 37, 43, 0.85); + background-blend-mode: overlay; + background-size: cover; + background-position: center; + background-repeat: no-repeat; + height: 100vh; + width: 100%; +} + +.logo { + width: 30%; + height: 20%; +} +/* CSS */ +.button-42 { + background-color: initial; + background-image: linear-gradient(-180deg, #555555, #2f2f2f); + border-radius: 6px; + box-shadow: rgba(0, 0, 0, 0.1) 0 2px 4px; + color: #FFFFFF; + cursor: pointer; + display: inline-block; + font-family: Inter,-apple-system,system-ui,Roboto,"Helvetica Neue",Arial,sans-serif; + height: 35px; + line-height: 35px; + outline: 0; + overflow: hidden; + padding: 0 20px; + pointer-events: auto; + position: relative; + text-align: center; + touch-action: manipulation; + user-select: none; + -webkit-user-select: none; + vertical-align: top; + white-space: nowrap; + z-index: 9; + border: 0; + transition: box-shadow .2s; + font-size: medium; +} +p { + font-size: 1rem; +} + +.button-42:hover { + background-image: linear-gradient(-180deg, #cb3939, #610000); +} +html { + background-color: rgba(33, 37, 43); + text-align: center; + color: white; + user-select: none; + -webkit-user-select: none; + -moz-user-select: none; + -ms-user-select: none; + -webkit-touch-callout: none; +} + +body { + padding-top: 40px; + margin: 0; + font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", "Roboto", + "Oxygen", "Ubuntu", "Cantarell", "Fira Sans", "Droid Sans", "Helvetica Neue", + sans-serif; + overscroll-behavior: none; +} + +.button-42 { + background-color: initial; + background-image: linear-gradient(-180deg, #555555, #2f2f2f); + border-radius: 6px; + box-shadow: rgba(0, 0, 0, 0.1) 0 2px 4px; + color: #FFFFFF; + cursor: pointer; + display: inline-block; + font-family: Inter,-apple-system,system-ui,Roboto,"Helvetica Neue",Arial,sans-serif; + height: 35px; + line-height: 35px; + outline: 0; + overflow: hidden; + padding: 0 20px; + pointer-events: auto; + position: relative; + text-align: center; + touch-action: manipulation; + user-select: none; + -webkit-user-select: none; + vertical-align: top; + white-space: nowrap; + z-index: 9; + border: 0; + transition: box-shadow .2s; + font-size: medium; +} + +p { + font-size: 1rem; +} + +.button-42:hover { + background-image: linear-gradient(-180deg, #cb3939, #610000); +} + +.tab { + overflow: hidden; + background-color: #f1f1f100; + margin-left: 20px; +} + +.tab button { + background-color: transparent; /* Make the background transparent */ + color: white; /* Make the text white */ + float: left; + border: none; + outline: none; + cursor: pointer; + padding: 14px 16px; + transition: 0.3s; + position: relative; /* Added for the underline */ +} + +.tab button::after { /* Added for the underline */ + content: ''; + position: absolute; + width: 0; + height: 2px; + bottom: 0; + left: 0; + background-color: #a40505; + visibility: hidden; + transition: all 0.3s ease-in-out; +} + +.tab button:hover::after, /* Added for the underline */ +.tab button.active::after { /* Added for the underline */ + width: 100%; + visibility: visible; +} + +.tab button.active { + background-color: transparent; /* Make the background transparent */ + color: red; +} +.tabcontent { + display: none; + padding: 6px 12px; + border-top: none; +} +#sqlresults, #hashresults { + font-family: 'Courier New', Courier, monospace; + min-height: 100px; +} +#selectquery { + width: 90%; +} +table { + width: 100%; + border-collapse: collapse; + margin-top: 20px; +} + +th, td { + border: 1px solid #ddd; + padding: 8px; + text-align: left; +} + +th { + background-color: #005467; + color: white; +} + +tr:hover { + background-color: #888; +} + +.error-message { + color: #FF4B2B; /* Bright red color for better visibility in dark mode */ + background-color: #1E1E1E; /* Dark background for the error message */ + border: 1px solid #FF4B2B; /* Border color same as text color */ + padding: 10px; /* Padding around the text */ + margin: 10px 0; /* Margin top and bottom */ + border-radius: 5px; /* Rounded corners */ + text-align: center; /* Center the text */ +} + +.narrowColumn { + width: 1%; /* Adjust as needed */ + white-space: nowrap; +} \ No newline at end of file diff --git a/v3/examples/services/files/images/eryri1.png b/v3/examples/services/files/images/eryri1.png new file mode 100644 index 000000000..224d3b4ac Binary files /dev/null and b/v3/examples/services/files/images/eryri1.png differ diff --git a/v3/examples/services/hashes/hashes.go b/v3/examples/services/hashes/hashes.go new file mode 100644 index 000000000..1e4653dbd --- /dev/null +++ b/v3/examples/services/hashes/hashes.go @@ -0,0 +1,45 @@ +package hashes + +import ( + "context" + "crypto/md5" + "crypto/sha1" + "crypto/sha256" + "encoding/hex" + + "github.com/wailsapp/wails/v3/pkg/application" +) + +type Hashes = struct { + MD5 string `json:"md5"` + SHA1 string `json:"sha1"` + SHA256 string `json:"sha256"` +} + +type Service struct{} + +func (h *Service) Generate(s string) Hashes { + md5Hash := md5.Sum([]byte(s)) + sha1Hash := sha1.Sum([]byte(s)) + sha256Hash := sha256.Sum256([]byte(s)) + + return Hashes{ + MD5: hex.EncodeToString(md5Hash[:]), + SHA1: hex.EncodeToString(sha1Hash[:]), + SHA256: hex.EncodeToString(sha256Hash[:]), + } +} + +func New() *Service { + return &Service{} +} + +func (h *Service) ServiceName() string { + return "Hashes Service" +} + +func (h *Service) ServiceStartup(context.Context, application.ServiceOptions) error { + return nil +} + +func (h *Service) ServiceShutdown() error { return nil } diff --git a/v3/examples/services/main.go b/v3/examples/services/main.go new file mode 100644 index 000000000..c753a79c7 --- /dev/null +++ b/v3/examples/services/main.go @@ -0,0 +1,69 @@ +package main + +import ( + "embed" + "log/slog" + "os" + "path/filepath" + "runtime" + + "github.com/wailsapp/wails/v3/examples/services/hashes" + "github.com/wailsapp/wails/v3/pkg/application" + "github.com/wailsapp/wails/v3/pkg/services/fileserver" + "github.com/wailsapp/wails/v3/pkg/services/kvstore" + "github.com/wailsapp/wails/v3/pkg/services/log" + "github.com/wailsapp/wails/v3/pkg/services/sqlite" +) + +//go:embed assets/* +var assets embed.FS + +func main() { + + // Get the local directory of this source file + // This isn't needed when running the example with `go run .` + // but is needed when running the example from an IDE + _, thisFile, _, _ := runtime.Caller(0) + localDir := filepath.Dir(thisFile) + + rootPath := filepath.Join(localDir, "files") + app := application.New(application.Options{ + Name: "Services Demo", + Description: "A demo of the services API", + Mac: application.MacOptions{ + ApplicationShouldTerminateAfterLastWindowClosed: true, + }, + LogLevel: slog.LevelDebug, + Services: []application.Service{ + application.NewService(hashes.New()), + application.NewService(sqlite.NewWithConfig(&sqlite.Config{ + DBSource: "test.db", + })), + application.NewService(kvstore.NewWithConfig(&kvstore.Config{ + Filename: "store.json", + AutoSave: true, + })), + application.NewService(log.New()), + application.NewServiceWithOptions(fileserver.NewWithConfig(&fileserver.Config{ + RootPath: rootPath, + }), application.ServiceOptions{ + Route: "/files", + }), + }, + Assets: application.AssetOptions{ + Handler: application.BundledAssetFileServer(assets), + }, + }) + + app.Window.NewWithOptions(application.WebviewWindowOptions{ + Width: 1024, + Height: 768, + }) + + err := app.Run() + + if err != nil { + println(err.Error()) + os.Exit(1) + } +} diff --git a/v3/examples/services/store.json b/v3/examples/services/store.json new file mode 100644 index 000000000..a56bb9842 --- /dev/null +++ b/v3/examples/services/store.json @@ -0,0 +1 @@ +{"q":"www","url2":"https://reddit.com"} \ No newline at end of file diff --git a/v3/examples/services/test.db b/v3/examples/services/test.db new file mode 100644 index 000000000..ced6a916c Binary files /dev/null and b/v3/examples/services/test.db differ diff --git a/v3/examples/show-macos-toolbar/README.md b/v3/examples/show-macos-toolbar/README.md new file mode 100644 index 000000000..21bbeac96 --- /dev/null +++ b/v3/examples/show-macos-toolbar/README.md @@ -0,0 +1,20 @@ +# Show macOS Toolbar Example + +This example is a demonstration of the macOS option `ShowToolbarWhenFullscreen`, which keeps +the system toolbar visible when in fullscreen mode. + +## Running the example + +To run the example (on macOS), simply run the following command: + +```bash +go run . +``` + +# Status + +| Platform | Status | +|----------|---------| +| Mac | Working | +| Windows | N/A | +| Linux | N/A | diff --git a/v3/examples/show-macos-toolbar/main.go b/v3/examples/show-macos-toolbar/main.go new file mode 100644 index 000000000..648432da6 --- /dev/null +++ b/v3/examples/show-macos-toolbar/main.go @@ -0,0 +1,51 @@ +package main + +import ( + _ "embed" + "log" + + "github.com/wailsapp/wails/v3/pkg/application" +) + +func main() { + app := application.New(application.Options{ + Name: "Show macOS Toolbar", + Description: "A demo of the ShowToolbarWhenFullscreen option", + Mac: application.MacOptions{ + ApplicationShouldTerminateAfterLastWindowClosed: true, + }, + }) + + // Create window + app.Window.NewWithOptions(application.WebviewWindowOptions{ + Title: "Toolbar hidden (default behaviour)", + HTML: "

            Switch this window to fullscreen: the toolbar will be hidden

            ", + CSS: `body { background-color: blue; color: white; height: 100vh; display: flex; justify-content: center; align-items: center; }`, + Mac: application.MacWindow{ + TitleBar: application.MacTitleBar{ + UseToolbar: true, + HideToolbarSeparator: true, + }, + }, + }) + + // Create window + app.Window.NewWithOptions(application.WebviewWindowOptions{ + Title: "Toolbar visible", + HTML: "

            Switch this window to fullscreen: the toolbar will stay visible

            ", + CSS: `body { background-color: red; color: white; height: 100vh; display: flex; justify-content: center; align-items: center; }`, + Mac: application.MacWindow{ + TitleBar: application.MacTitleBar{ + UseToolbar: true, + HideToolbarSeparator: true, + ShowToolbarWhenFullscreen: true, + }, + }, + }) + + err := app.Run() + + if err != nil { + log.Fatal(err) + } +} diff --git a/v3/examples/single-instance/README.md b/v3/examples/single-instance/README.md new file mode 100644 index 000000000..5982cb909 --- /dev/null +++ b/v3/examples/single-instance/README.md @@ -0,0 +1,62 @@ +# Single Instance Example + +This example demonstrates the single instance functionality in Wails v3. It shows how to: + +1. Ensure only one instance of your application can run at a time +2. Notify the first instance when a second instance is launched +3. Pass data between instances +4. Handle command line arguments and working directory information from second instances + +## Running the Example + +1. Build and run the application: + ```bash + go build + ./single-instance + ``` + +2. Try launching a second instance of the application. You'll notice: + - The second instance will exit immediately + - The first instance will receive and display: + - Command line arguments from the second instance + - Working directory of the second instance + - Additional data passed from the second instance + +3. Check the application logs to see the information received from second instances. + +## Features Demonstrated + +- Setting up single instance lock with a unique identifier +- Handling second instance launches through callbacks +- Passing custom data between instances +- Displaying instance information in a web UI +- Cross-platform support (Windows, macOS, Linux) + +## Code Overview + +The example consists of: + +- `main.go`: The main application code demonstrating single instance setup +- A simple web UI showing current instance information +- Callback handling for second instance launches + +## Implementation Details + +The application uses the Wails v3 single instance feature: + +```go +app := application.New(&application.Options{ + SingleInstance: &application.SingleInstanceOptions{ + UniqueID: "com.wails.example.single-instance", + OnSecondInstance: func(data application.SecondInstanceData) { + // Handle second instance launch + }, + AdditionalData: map[string]string{ + }, + }, +}) +``` + +The implementation uses platform-specific mechanisms: +- Windows: Named mutex and window messages +- Unix (Linux/macOS): File locking with flock and signals diff --git a/v3/examples/single-instance/assets/index.html b/v3/examples/single-instance/assets/index.html new file mode 100644 index 000000000..330b062ec --- /dev/null +++ b/v3/examples/single-instance/assets/index.html @@ -0,0 +1,141 @@ + + + + + + Single Instance Demo + + + + +
            +

            Single Instance Demo

            + +
            +

            Current Instance Information

            +
            Loading...
            +
            + +
            +

            Instructions

            +

            Try launching another instance of this application. The first instance will:

            +
              +
            • Receive notification of the second instance launch
            • +
            • Get the command line arguments of the second instance
            • +
            • Get the working directory of the second instance
            • +
            • Receive any additional data passed from the second instance
            • +
            +

            Check the application logs to see the information received from second instances.

            +
            +
            + + + + \ No newline at end of file diff --git a/v3/examples/single-instance/main.go b/v3/examples/single-instance/main.go new file mode 100644 index 000000000..51ca48a38 --- /dev/null +++ b/v3/examples/single-instance/main.go @@ -0,0 +1,82 @@ +package main + +import ( + "embed" + "log" + "log/slog" + "os" + "time" + + "github.com/wailsapp/wails/v3/pkg/application" +) + +//go:embed assets/index.html +var assets embed.FS + +type App struct{} + +func (a *App) GetCurrentInstanceInfo() map[string]interface{} { + return map[string]interface{}{ + "args": os.Args, + "workingDir": getCurrentWorkingDir(), + } +} + +var encryptionKey = [32]byte{ + 0x1e, 0x1f, 0x1c, 0x1d, 0x1a, 0x1b, 0x18, 0x19, + 0x16, 0x17, 0x14, 0x15, 0x12, 0x13, 0x10, 0x11, + 0x0e, 0x0f, 0x0c, 0x0d, 0x0a, 0x0b, 0x08, 0x09, + 0x06, 0x07, 0x04, 0x05, 0x02, 0x03, 0x00, 0x01, +} + +func main() { + + var window *application.WebviewWindow + app := application.New(application.Options{ + Name: "Single Instance Example", + LogLevel: slog.LevelDebug, + Description: "An example of single instance functionality in Wails v3", + Services: []application.Service{ + application.NewService(&App{}), + }, + SingleInstance: &application.SingleInstanceOptions{ + UniqueID: "com.wails.example.single-instance", + EncryptionKey: encryptionKey, + OnSecondInstanceLaunch: func(data application.SecondInstanceData) { + if window != nil { + window.EmitEvent("secondInstanceLaunched", data) + window.Restore() + window.Focus() + } + log.Printf("Second instance launched with args: %v\n", data.Args) + log.Printf("Working directory: %s\n", data.WorkingDir) + if data.AdditionalData != nil { + log.Printf("Additional data: %v\n", data.AdditionalData) + } + }, + AdditionalData: map[string]string{ + "launchtime": time.Now().Local().String(), + }, + }, + Assets: application.AssetOptions{ + Handler: application.BundledAssetFileServer(assets), + }, + }) + + window = app.Window.NewWithOptions(application.WebviewWindowOptions{ + Title: "Single Instance Demo", + Width: 800, + Height: 700, + URL: "/", + }) + + app.Run() +} + +func getCurrentWorkingDir() string { + dir, err := os.Getwd() + if err != nil { + return "" + } + return dir +} diff --git a/v3/examples/spotlight/README.md b/v3/examples/spotlight/README.md new file mode 100644 index 000000000..bda8f464e --- /dev/null +++ b/v3/examples/spotlight/README.md @@ -0,0 +1,66 @@ +# Spotlight Example + +This example demonstrates how to create a Spotlight-like launcher window using the `CollectionBehavior` option on macOS. + +## Features + +- **Appears on all Spaces**: Using `MacWindowCollectionBehaviorCanJoinAllSpaces`, the window is visible across all virtual desktops +- **Overlays fullscreen apps**: Using `MacWindowCollectionBehaviorFullScreenAuxiliary`, the window can appear over fullscreen applications +- **Combined behaviors**: Demonstrates combining multiple behaviors with bitwise OR +- **Floating window**: `MacWindowLevelFloating` keeps the window above other windows +- **Accessory app**: Doesn't appear in the Dock (uses `ActivationPolicyAccessory`) +- **Frameless design**: Clean, borderless appearance with translucent backdrop + +## Running the example + +```bash +go run . +``` + +**Note**: This example is macOS-specific due to the use of `CollectionBehavior`. + +## Combining CollectionBehaviors + +Behaviors can be combined using bitwise OR (`|`): + +```go +CollectionBehavior: application.MacWindowCollectionBehaviorCanJoinAllSpaces | + application.MacWindowCollectionBehaviorFullScreenAuxiliary, +``` + +## CollectionBehavior Options + +These are bitmask values that can be combined: + +**Space behavior:** +| Option | Description | +|--------|-------------| +| `MacWindowCollectionBehaviorDefault` | Uses FullScreenPrimary (default) | +| `MacWindowCollectionBehaviorCanJoinAllSpaces` | Window appears on all Spaces | +| `MacWindowCollectionBehaviorMoveToActiveSpace` | Moves to active Space when shown | +| `MacWindowCollectionBehaviorManaged` | Default managed window behavior | +| `MacWindowCollectionBehaviorTransient` | Temporary/transient window | +| `MacWindowCollectionBehaviorStationary` | Stays stationary during Space switches | + +**Fullscreen behavior:** +| Option | Description | +|--------|-------------| +| `MacWindowCollectionBehaviorFullScreenPrimary` | Can enter fullscreen mode | +| `MacWindowCollectionBehaviorFullScreenAuxiliary` | Can overlay fullscreen apps | +| `MacWindowCollectionBehaviorFullScreenNone` | Disables fullscreen | +| `MacWindowCollectionBehaviorFullScreenAllowsTiling` | Allows side-by-side tiling | + +## Use Cases + +- **Launcher apps** (like Spotlight, Alfred, Raycast) +- **Quick capture tools** (notes, screenshots) +- **System utilities** that need to be accessible anywhere +- **Overlay widgets** that should appear over fullscreen apps + +## Status + +| Platform | Status | +|----------|--------| +| Mac | Working | +| Windows | N/A (macOS-specific feature) | +| Linux | N/A (macOS-specific feature) | diff --git a/v3/examples/spotlight/main.go b/v3/examples/spotlight/main.go new file mode 100644 index 000000000..d961f1f54 --- /dev/null +++ b/v3/examples/spotlight/main.go @@ -0,0 +1,142 @@ +package main + +import ( + "log" + "net/http" + + "github.com/wailsapp/wails/v3/pkg/application" +) + +// This example demonstrates how to create a Spotlight-like launcher window +// that appears on all macOS Spaces and can overlay fullscreen applications. +// +// Key features: +// - Window appears on all Spaces (virtual desktops) +// - Can overlay fullscreen applications +// - Floating window level keeps it above other windows +// - Accessory activation policy hides from Dock +// - Frameless design with translucent backdrop + +func main() { + app := application.New(application.Options{ + Name: "Spotlight Example", + Description: "A Spotlight-like launcher demonstrating CollectionBehavior", + Mac: application.MacOptions{ + // Accessory apps don't appear in the Dock + ActivationPolicy: application.ActivationPolicyAccessory, + ApplicationShouldTerminateAfterLastWindowClosed: true, + }, + Assets: application.AssetOptions{ + Handler: http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { + w.WriteHeader(http.StatusOK) + w.Write([]byte(spotlightHTML)) + }), + }, + }) + + // Create a Spotlight-like window + app.Window.NewWithOptions(application.WebviewWindowOptions{ + Title: "Spotlight", + Width: 680, + Height: 80, + Frameless: true, + // Center the window + InitialPosition: application.WindowCentered, + // Prevent resizing + DisableResize: true, + Mac: application.MacWindow{ + // Combine multiple behaviors using bitwise OR: + // - CanJoinAllSpaces: window appears on ALL Spaces (virtual desktops) + // - FullScreenAuxiliary: window can overlay fullscreen applications + CollectionBehavior: application.MacWindowCollectionBehaviorCanJoinAllSpaces | + application.MacWindowCollectionBehaviorFullScreenAuxiliary, + // Float above other windows + WindowLevel: application.MacWindowLevelFloating, + // Translucent vibrancy effect + Backdrop: application.MacBackdropTranslucent, + // Hidden title bar for clean look + TitleBar: application.MacTitleBar{ + AppearsTransparent: true, + Hide: true, + }, + }, + URL: "/", + }) + + err := app.Run() + if err != nil { + log.Fatal(err) + } +} + +const spotlightHTML = ` + + + Spotlight + + + + +
            + + + + + +
            + +` diff --git a/v3/examples/systray-basic/README.md b/v3/examples/systray-basic/README.md new file mode 100644 index 000000000..11b84a0bf --- /dev/null +++ b/v3/examples/systray-basic/README.md @@ -0,0 +1,16 @@ +# Systray Basic Example + +This example creates a simple system tray with an attached window. +The window is hidden by default and toggled by left-clicking on the systray icon. +The window will hide automatically when it loses focus. + +On Windows, if the icon is in the notification flyout, +then the window will be shown in the bottom right corner. + +# Status + +| Platform | Status | +|----------|---------| +| Mac | Working | +| Windows | Working | +| Linux | | diff --git a/v3/examples/systray-basic/main.go b/v3/examples/systray-basic/main.go new file mode 100644 index 000000000..0c1dbf7a2 --- /dev/null +++ b/v3/examples/systray-basic/main.go @@ -0,0 +1,60 @@ +package main + +import ( + _ "embed" + "log" + "runtime" + + "github.com/wailsapp/wails/v3/pkg/application" + "github.com/wailsapp/wails/v3/pkg/events" + "github.com/wailsapp/wails/v3/pkg/icons" +) + +func main() { + app := application.New(application.Options{ + Name: "Systray Demo", + Description: "A demo of the Systray API", + Assets: application.AlphaAssets, + Mac: application.MacOptions{ + ActivationPolicy: application.ActivationPolicyAccessory, + }, + }) + + systemTray := app.SystemTray.New() + + window := app.Window.NewWithOptions(application.WebviewWindowOptions{ + Width: 500, + Height: 500, + Name: "Systray Demo Window", + Frameless: true, + AlwaysOnTop: true, + Hidden: true, + DisableResize: true, + HideOnEscape: true, + HideOnFocusLost: true, + Windows: application.WindowsWindow{ + HiddenOnTaskbar: true, + }, + KeyBindings: map[string]func(window application.Window){ + "F12": func(window application.Window) { + systemTray.OpenMenu() + }, + }, + }) + + window.RegisterHook(events.Common.WindowClosing, func(e *application.WindowEvent) { + window.Hide() + e.Cancel() + }) + + if runtime.GOOS == "darwin" { + systemTray.SetTemplateIcon(icons.SystrayMacTemplate) + } + + systemTray.AttachWindow(window).WindowOffset(5) + + err := app.Run() + if err != nil { + log.Fatal(err) + } +} diff --git a/v3/examples/systray-clock/main.go b/v3/examples/systray-clock/main.go new file mode 100644 index 000000000..c00d6093d --- /dev/null +++ b/v3/examples/systray-clock/main.go @@ -0,0 +1,59 @@ +package main + +import ( + "log" + "runtime" + "time" + + "github.com/wailsapp/wails/v3/pkg/application" + "github.com/wailsapp/wails/v3/pkg/icons" +) + +func main() { + app := application.New(application.Options{ + Name: "Systray Clock", + Description: "System tray clock with live tooltip updates", + Assets: application.AlphaAssets, + Mac: application.MacOptions{ + ActivationPolicy: application.ActivationPolicyAccessory, + }, + Windows: application.WindowsOptions{ + DisableQuitOnLastWindowClosed: true, + }, + }) + + systemTray := app.SystemTray.New() + + // Use the template icon on macOS so the clock respects light/dark modes. + if runtime.GOOS == "darwin" { + systemTray.SetTemplateIcon(icons.SystrayMacTemplate) + } + + menu := app.NewMenu() + menu.Add("Quit").OnClick(func(ctx *application.Context) { + app.Quit() + }) + systemTray.SetMenu(menu) + + updateTooltip := func() { + systemTray.SetTooltip(time.Now().Format("15:04:05")) + } + updateTooltip() + + go func() { + ticker := time.NewTicker(time.Second) + defer ticker.Stop() + for { + select { + case <-ticker.C: + updateTooltip() + case <-app.Context().Done(): + return + } + } + }() + + if err := app.Run(); err != nil { + log.Fatal(err) + } +} diff --git a/v3/examples/systray-custom/README.md b/v3/examples/systray-custom/README.md new file mode 100644 index 000000000..598d84496 --- /dev/null +++ b/v3/examples/systray-custom/README.md @@ -0,0 +1,16 @@ +# Systray Custom Example + +This example creates a simple system tray and uses hooks to attach a custom window. +The window is hidden by default and toggled by left-clicking on the systray icon. +The window will hide automatically when it loses focus. + +On Windows, if the icon is in the notification flyout, +then the window will be shown in the bottom right corner. + +# Status + +| Platform | Status | +|----------|---------| +| Mac | Working | +| Windows | | +| Linux | | diff --git a/v3/examples/systray-custom/main.go b/v3/examples/systray-custom/main.go new file mode 100644 index 000000000..f10140792 --- /dev/null +++ b/v3/examples/systray-custom/main.go @@ -0,0 +1,73 @@ +package main + +import ( + _ "embed" + "github.com/wailsapp/wails/v3/pkg/application" + "github.com/wailsapp/wails/v3/pkg/events" + "github.com/wailsapp/wails/v3/pkg/icons" + "log" + "runtime" +) + +var windowShowing bool + +func createWindow(app *application.App) { + if windowShowing { + return + } + // Log the time taken to create the window + window := app.Window.NewWithOptions(application.WebviewWindowOptions{ + Width: 500, + Height: 500, + Name: "Systray Demo Window", + AlwaysOnTop: true, + Hidden: true, + BackgroundColour: application.NewRGB(33, 37, 41), + DisableResize: true, + Windows: application.WindowsWindow{ + HiddenOnTaskbar: true, + }, + }) + windowShowing = true + + window.OnWindowEvent(events.Common.WindowClosing, func(e *application.WindowEvent) { + windowShowing = false + }) + + window.Show() +} + +func main() { + app := application.New(application.Options{ + Name: "Systray Demo", + Description: "A demo of the Systray API", + Assets: application.AlphaAssets, + Windows: application.WindowsOptions{ + DisableQuitOnLastWindowClosed: true, + }, + Mac: application.MacOptions{ + ActivationPolicy: application.ActivationPolicyAccessory, + }, + }) + + systemTray := app.SystemTray.New() + menu := app.NewMenu() + menu.Add("Quit").OnClick(func(data *application.Context) { + app.Quit() + }) + systemTray.SetMenu(menu) + systemTray.SetTooltip("Systray Demo") + + if runtime.GOOS == "darwin" { + systemTray.SetTemplateIcon(icons.SystrayMacTemplate) + } + + systemTray.OnClick(func() { + createWindow(app) + }) + + err := app.Run() + if err != nil { + log.Fatal(err) + } +} diff --git a/v3/examples/systray-menu/README.md b/v3/examples/systray-menu/README.md new file mode 100644 index 000000000..2de57faea --- /dev/null +++ b/v3/examples/systray-menu/README.md @@ -0,0 +1,17 @@ +# Systray Menu Example + +This example creates a system tray with an attached window and a menu. +The window is hidden by default and toggled by left-clicking on the systray icon. +The window will hide automatically when it loses focus. +Right-clicking on the systray icon will show the menu. + +On Windows, if the icon is in the notification flyout, +then the window will be shown in the bottom right corner. + +# Status + +| Platform | Status | +|----------|---------| +| Mac | Working | +| Windows | Working | +| Linux | | diff --git a/v3/examples/systray-menu/logo-dark-xsmall.png b/v3/examples/systray-menu/logo-dark-xsmall.png new file mode 100644 index 000000000..83a514c74 Binary files /dev/null and b/v3/examples/systray-menu/logo-dark-xsmall.png differ diff --git a/v3/examples/systray-menu/main.go b/v3/examples/systray-menu/main.go new file mode 100644 index 000000000..b342f0fe1 --- /dev/null +++ b/v3/examples/systray-menu/main.go @@ -0,0 +1,114 @@ +package main + +import ( + _ "embed" + "github.com/wailsapp/wails/v3/pkg/events" + "log" + "runtime" + "time" + + "github.com/wailsapp/wails/v3/pkg/application" + "github.com/wailsapp/wails/v3/pkg/icons" +) + +//go:embed logo-dark-xsmall.png +var logo []byte + +func main() { + app := application.New(application.Options{ + Name: "Systray Demo", + Description: "A demo of the Systray API", + Assets: application.AlphaAssets, + Mac: application.MacOptions{ + ActivationPolicy: application.ActivationPolicyAccessory, + }, + }) + + systemTray := app.SystemTray.New() + + window := app.Window.NewWithOptions(application.WebviewWindowOptions{ + Width: 500, + Height: 500, + Name: "Systray Demo Window", + Frameless: true, + AlwaysOnTop: true, + Hidden: true, + DisableResize: true, + Windows: application.WindowsWindow{ + HiddenOnTaskbar: true, + }, + KeyBindings: map[string]func(window application.Window){ + "F12": func(window application.Window) { + systemTray.OpenMenu() + }, + }, + }) + + window.RegisterHook(events.Common.WindowClosing, func(e *application.WindowEvent) { + window.Hide() + e.Cancel() + }) + + if runtime.GOOS == "darwin" { + systemTray.SetTemplateIcon(icons.SystrayMacTemplate) + } + + myMenu := app.NewMenu() + myMenu.Add("Wails").SetBitmap(logo).SetEnabled(false) + myMenu.Add("Hidden").SetHidden(true) + + myMenu.Add("Hello World!").OnClick(func(ctx *application.Context) { + println("Hello World!") + q := app.Dialog.Question().SetTitle("Ready?").SetMessage("Are you feeling ready?") + q.AddButton("Yes").OnClick(func() { + println("Awesome!") + }) + q.AddButton("No").SetAsDefault().OnClick(func() { + println("Boo!") + }) + q.Show() + }) + subMenu := myMenu.AddSubmenu("Submenu") + subMenu.Add("Click me!").OnClick(func(ctx *application.Context) { + ctx.ClickedMenuItem().SetLabel("Clicked!") + }) + myMenu.AddSeparator() + myMenu.AddCheckbox("Checked", true).OnClick(func(ctx *application.Context) { + println("Checked: ", ctx.ClickedMenuItem().Checked()) + app.Dialog.Info().SetTitle("Hello World!").SetMessage("Hello World!").Show() + }) + myMenu.Add("Enabled").OnClick(func(ctx *application.Context) { + println("Click me!") + ctx.ClickedMenuItem().SetLabel("Disabled!").SetEnabled(false) + }) + myMenu.AddSeparator() + // Callbacks can be shared. This is useful for radio groups + radioCallback := func(ctx *application.Context) { + menuItem := ctx.ClickedMenuItem() + menuItem.SetLabel(menuItem.Label() + "!") + } + + // Radio groups are created implicitly by placing radio items next to each other in a menu + myMenu.AddRadio("Radio 1", true).OnClick(radioCallback) + myMenu.AddRadio("Radio 2", false).OnClick(radioCallback) + myMenu.AddRadio("Radio 3", false).OnClick(radioCallback) + myMenu.AddSeparator() + myMenu.Add("Hide System tray for 3 seconds...").OnClick(func(ctx *application.Context) { + systemTray.Hide() + time.Sleep(3 * time.Second) + systemTray.Show() + }) + myMenu.AddSeparator() + myMenu.Add("Quit").OnClick(func(ctx *application.Context) { + app.Quit() + }) + + systemTray.SetMenu(myMenu) + + systemTray.AttachWindow(window).WindowOffset(2) + + err := app.Run() + if err != nil { + log.Fatal(err) + } +} diff --git a/v3/examples/video/README.md b/v3/examples/video/README.md new file mode 100644 index 000000000..012469afb --- /dev/null +++ b/v3/examples/video/README.md @@ -0,0 +1,19 @@ +# Video Example + +This example shows support for HTML5 video. + +## Running the example + +To run the example, simply run the following command: + +```bash +go run . +``` + +# Status + +| Platform | Status | +|----------|---------| +| Mac | | +| Windows | Working | +| Linux | | diff --git a/v3/examples/video/main.go b/v3/examples/video/main.go new file mode 100644 index 000000000..879172c61 --- /dev/null +++ b/v3/examples/video/main.go @@ -0,0 +1,47 @@ +package main + +import ( + _ "embed" + "github.com/wailsapp/wails/v3/pkg/events" + "log" + + "github.com/wailsapp/wails/v3/pkg/application" +) + +func main() { + app := application.New(application.Options{ + Name: "Video Demo", + Description: "A demo of HTML5 Video API", + Assets: application.AlphaAssets, + Mac: application.MacOptions{ + ApplicationShouldTerminateAfterLastWindowClosed: true, + }, + Windows: application.WindowsOptions{ + WndProcInterceptor: nil, + DisableQuitOnLastWindowClosed: false, + WebviewUserDataPath: "", + WebviewBrowserPath: "", + }, + }) + app.Event.OnApplicationEvent(events.Mac.ApplicationDidFinishLaunching, func(event *application.ApplicationEvent) { + log.Println("ApplicationDidFinishLaunching") + }) + + app.Window.NewWithOptions(application.WebviewWindowOptions{ + BackgroundColour: application.NewRGB(33, 37, 41), + Mac: application.MacWindow{ + DisableShadow: true, + WebviewPreferences: application.MacWebviewPreferences{ + FullscreenEnabled: application.Enabled, + }, + }, + HTML: "", + }) + + err := app.Run() + + if err != nil { + log.Fatal(err) + } + +} diff --git a/v3/examples/web-apis/beacon/frontend/index.html b/v3/examples/web-apis/beacon/frontend/index.html new file mode 100644 index 000000000..f75654d56 --- /dev/null +++ b/v3/examples/web-apis/beacon/frontend/index.html @@ -0,0 +1,315 @@ + + + + + + Beacon API Demo + + + +
            +
            +

            Beacon API Demo

            + Checking... +
            + +
            +
            +

            Send Beacon

            +
            Beacons are fire-and-forget. Returns true/false for queue status only.
            + + + + + +
            + + + + +
            + + + + +
            + + + + +
            +
            + +
            +

            Statistics & Log

            +
            +
            +
            0
            +
            Sent
            +
            +
            +
            0
            +
            Queued
            +
            +
            +
            0
            +
            Failed
            +
            +
            +
            0
            +
            Bytes
            +
            +
            +
            + + +
            +
            +
            + --:-- + READY + Configure endpoint and send beacons +
            +
            +
            +
            +
            + + + + diff --git a/v3/examples/web-apis/beacon/main.go b/v3/examples/web-apis/beacon/main.go new file mode 100644 index 000000000..cc1d30e29 --- /dev/null +++ b/v3/examples/web-apis/beacon/main.go @@ -0,0 +1,27 @@ +package main + +import ( + "embed" + + "github.com/wailsapp/wails/v3/pkg/application" +) + +//go:embed frontend/* +var assets embed.FS + +func main() { + app := application.New(application.Options{ + Name: "Beacon API Demo", + Description: "Beacon API for analytics", + Assets: application.AssetOptions{ + Handler: application.BundledAssetFileServer(assets), + }, + }) + app.Window.NewWithOptions(application.WebviewWindowOptions{ + Title: "Beacon API Demo", + Width: 900, + Height: 600, + URL: "/", + }) + app.Run() +} diff --git a/v3/examples/web-apis/blob/frontend/index.html b/v3/examples/web-apis/blob/frontend/index.html new file mode 100644 index 000000000..6ef330d16 --- /dev/null +++ b/v3/examples/web-apis/blob/frontend/index.html @@ -0,0 +1,351 @@ + + + + + + Blob API Demo + + + +
            +
            +

            Blob API Demo

            + Checking... +
            + +
            + +
            +

            Create Blob

            +
            + + + + +
            + +
            + +
            +
            +
            +
            + +
            + +
            + + +
            + +
            +
            +
            +
            + + + +
            + +
            +
            +
            +
            +
            +
            + +
            +
            + +
            Select a tab and create a blob...
            +
            + + +
            +

            Stored Blobs

            +
            +

            No blobs yet

            +
            +
            +

            Operations

            +
            +
            +
            +
            + + + +
            +
            +
            +
            +
            +
            +
            +
            + + +
            +

            API Features

            +
            +

            Output

            +
            Conversion/slice results appear here...
            +
            +
            +
            + + + + diff --git a/v3/examples/web-apis/blob/main.go b/v3/examples/web-apis/blob/main.go new file mode 100644 index 000000000..91c96783e --- /dev/null +++ b/v3/examples/web-apis/blob/main.go @@ -0,0 +1,26 @@ +package main + +import ( + "embed" + "github.com/wailsapp/wails/v3/pkg/application" +) + +//go:embed frontend/* +var assets embed.FS + +func main() { + app := application.New(application.Options{ + Name: "Blob API Demo", + Description: "Binary large objects", + Assets: application.AssetOptions{ + Handler: application.BundledAssetFileServer(assets), + }, + }) + app.Window.NewWithOptions(application.WebviewWindowOptions{ + Title: "Blob API Demo", + Width: 900, + Height: 700, + URL: "/", + }) + app.Run() +} diff --git a/v3/examples/web-apis/broadcast-channel/frontend/index.html b/v3/examples/web-apis/broadcast-channel/frontend/index.html new file mode 100644 index 000000000..81ffe2a34 --- /dev/null +++ b/v3/examples/web-apis/broadcast-channel/frontend/index.html @@ -0,0 +1,259 @@ + + + + + + Broadcast Channel API Demo + + + +
            +
            +

            Broadcast Channel API Demo

            + Checking... +
            + +
            +
            +

            API Features

            +
            + +

            Channel

            +
            +
            +
            Channel
            +
            demo-channel
            +
            +
            +
            Window ID
            +
            --
            +
            +
            + +
            + + +
            + +

            Send Message

            + +
            + + +
            + +
            + Hello! + Sync + Logout + Theme +
            + +

            Stats

            +
            +
            0
            Sent
            +
            0
            Received
            +
            +
            + +
            +

            Messages

            +
            +
            Open another window to test cross-window messaging
            +
            +
            +
            +
            + + + + + diff --git a/v3/examples/web-apis/broadcast-channel/main.go b/v3/examples/web-apis/broadcast-channel/main.go new file mode 100644 index 000000000..3cac5dcfc --- /dev/null +++ b/v3/examples/web-apis/broadcast-channel/main.go @@ -0,0 +1,47 @@ +package main + +import ( + "embed" + + "github.com/wailsapp/wails/v3/pkg/application" +) + +//go:embed frontend/* +var assets embed.FS + +var app *application.App + +// WindowService allows the frontend to open new windows +type WindowService struct{} + +// OpenNewWindow creates a new application window +func (s *WindowService) OpenNewWindow() { + app.Window.NewWithOptions(application.WebviewWindowOptions{ + Title: "Broadcast Channel Demo", + Width: 800, + Height: 550, + URL: "/", + }) +} + +func main() { + app = application.New(application.Options{ + Name: "Broadcast Channel Demo", + Description: "Cross-window communication via BroadcastChannel API", + Assets: application.AssetOptions{ + Handler: application.BundledAssetFileServer(assets), + }, + Services: []application.Service{ + application.NewService(&WindowService{}), + }, + }) + + app.Window.NewWithOptions(application.WebviewWindowOptions{ + Title: "Broadcast Channel Demo", + Width: 800, + Height: 550, + URL: "/", + }) + + app.Run() +} diff --git a/v3/examples/web-apis/cache-api/frontend/index.html b/v3/examples/web-apis/cache-api/frontend/index.html new file mode 100644 index 000000000..5eb9d948e --- /dev/null +++ b/v3/examples/web-apis/cache-api/frontend/index.html @@ -0,0 +1,600 @@ + + + + + + Cache API Demo + + + +
            +

            Cache API Demo

            +

            + The Cache API provides a mechanism for storing and retrieving network requests and responses. + It's commonly used with Service Workers for offline support and performance optimization. +

            + +
            + Cache API: checking... +
            + +
            +

            Cache Management

            +
            + + +
            + + + +
            Cache list will appear here...
            +
            + +
            +

            Add to Cache

            +
            + + +
            + + + +
            + +
            +

            Retrieve from Cache

            +
            + + +
            + + + +
            + +
            +

            Cached Entries (0)

            + + +
              +
              + +
              +

              Cache-First Strategy Demo

              +

              + Demonstrates a common caching pattern: try cache first, fall back to network. +

              +
              + + +
              + + +
              Strategy results will appear here...
              +
              + +
              +

              API Support

              +
              +
              + +
              +

              Event Log

              + +
              Cache operations will be logged here...
              +
              +
              + + + + diff --git a/v3/examples/web-apis/cache-api/main.go b/v3/examples/web-apis/cache-api/main.go new file mode 100644 index 000000000..6732fe5cf --- /dev/null +++ b/v3/examples/web-apis/cache-api/main.go @@ -0,0 +1,26 @@ +package main + +import ( + "embed" + "github.com/wailsapp/wails/v3/pkg/application" +) + +//go:embed frontend/* +var assets embed.FS + +func main() { + app := application.New(application.Options{ + Name: "Cache API Demo", + Description: "Cache API for offline resources", + Assets: application.AssetOptions{ + Handler: application.BundledAssetFileServer(assets), + }, + }) + app.Window.NewWithOptions(application.WebviewWindowOptions{ + Title: "Cache API Demo", + Width: 900, + Height: 700, + URL: "/", + }) + app.Run() +} diff --git a/v3/examples/web-apis/canvas/frontend/index.html b/v3/examples/web-apis/canvas/frontend/index.html new file mode 100644 index 000000000..36ab79212 --- /dev/null +++ b/v3/examples/web-apis/canvas/frontend/index.html @@ -0,0 +1,324 @@ + + + + + + Canvas 2D API Demo + + + +
              +

              Canvas 2D API Demo

              +

              + The Canvas API provides a means for drawing graphics via JavaScript and HTML. + It can be used for animation, game graphics, data visualization, and image manipulation. +

              + +
              + Canvas 2D supported: checking... +
              + +
              +

              Drawing Canvas

              +
              +
              + + +
              +
              + + + 5 +
              +
              + + + + + +
              +
              +
              + + + +
              + +
              + +
              +

              Canvas Demos

              +
              +
              + +
              Shapes & Paths
              +
              +
              + +
              Gradients
              +
              +
              + +
              Text Rendering
              +
              +
              + +
              Animation
              +
              +
              +
              +
              + + + + diff --git a/v3/examples/web-apis/canvas/main.go b/v3/examples/web-apis/canvas/main.go new file mode 100644 index 000000000..5980435b7 --- /dev/null +++ b/v3/examples/web-apis/canvas/main.go @@ -0,0 +1,29 @@ +package main + +import ( + "embed" + + "github.com/wailsapp/wails/v3/pkg/application" +) + +//go:embed frontend/* +var assets embed.FS + +func main() { + app := application.New(application.Options{ + Name: "Canvas 2D Demo", + Description: "Demonstrates the Canvas 2D API for graphics rendering", + Assets: application.AssetOptions{ + Handler: application.BundledAssetFileServer(assets), + }, + }) + + app.Window.NewWithOptions(application.WebviewWindowOptions{ + Title: "Canvas 2D Demo", + Width: 800, + Height: 600, + URL: "/", + }) + + app.Run() +} diff --git a/v3/examples/web-apis/clipboard/frontend/index.html b/v3/examples/web-apis/clipboard/frontend/index.html new file mode 100644 index 000000000..27a765769 --- /dev/null +++ b/v3/examples/web-apis/clipboard/frontend/index.html @@ -0,0 +1,258 @@ + + + + + + Clipboard API Demo + + + +
              +

              Clipboard API Demo

              +

              + The Clipboard API provides asynchronous read and write access to the system clipboard, + enabling secure copy/paste operations for text and other data types. +

              + +
              + Clipboard API: checking... +
              + +
              +

              Write to Clipboard

              + + + +
              + +
              +

              Read from Clipboard

              + + +
              Click "Paste Text" to read clipboard contents...
              +
              + +
              +

              Clipboard Events

              +

              Try using Ctrl+C/Ctrl+V in the text area below:

              + +
              Clipboard events will be logged here...
              +
              + +
              +

              API Support

              +
              +
              +
              + +
              + + + + diff --git a/v3/examples/web-apis/clipboard/main.go b/v3/examples/web-apis/clipboard/main.go new file mode 100644 index 000000000..b7e2eac6c --- /dev/null +++ b/v3/examples/web-apis/clipboard/main.go @@ -0,0 +1,29 @@ +package main + +import ( + "embed" + + "github.com/wailsapp/wails/v3/pkg/application" +) + +//go:embed frontend/* +var assets embed.FS + +func main() { + app := application.New(application.Options{ + Name: "Clipboard API Demo", + Description: "Demonstrates the Clipboard API for copy/paste", + Assets: application.AssetOptions{ + Handler: application.BundledAssetFileServer(assets), + }, + }) + + app.Window.NewWithOptions(application.WebviewWindowOptions{ + Title: "Clipboard API Demo", + Width: 800, + Height: 600, + URL: "/", + }) + + app.Run() +} diff --git a/v3/examples/web-apis/device-orientation/frontend/index.html b/v3/examples/web-apis/device-orientation/frontend/index.html new file mode 100644 index 000000000..fe1896d5b --- /dev/null +++ b/v3/examples/web-apis/device-orientation/frontend/index.html @@ -0,0 +1,475 @@ + + + + + + Device Orientation API Demo + + + +
              +

              Device Orientation API Demo

              +

              + The Device Orientation API provides access to the physical orientation of the device. + It reports alpha (compass direction), beta (front-to-back tilt), and gamma (left-to-right tilt). +

              + +
              + Device Orientation: checking... +
              + +
              +

              Orientation Controls

              + + + + + +
              + +
              +

              Orientation Values

              +
              +
              +
              Alpha (Z-axis rotation)
              +
              -
              +
              degrees (0-360)
              +
              +
              +
              +
              Beta (X-axis tilt)
              +
              -
              +
              degrees (-180 to 180)
              +
              +
              +
              +
              Gamma (Y-axis tilt)
              +
              -
              +
              degrees (-90 to 90)
              +
              +
              +
              +
              + +
              +

              Visual Representation

              +
              +
              +
              +
              +
              + N + S + W + E +
              +
              +
              +
              +
              +
              Compass (Alpha)
              +
              +
              +
              +
              +
              +
              FRONT
              +
              BACK
              +
              L
              +
              R
              +
              TOP
              +
              BOT
              +
              +
              +
              +
              Device Tilt (Beta/Gamma)
              +
              +
              +
              + +
              +

              Additional Information

              +
              +
              + Absolute Orientation + - +
              +
              + WebKit Compass Heading + - +
              +
              + WebKit Compass Accuracy + - +
              +
              + Update Count + 0 +
              +
              +
              + +
              +

              Event Log

              +
              +
              Waiting for orientation events...
              +
              +
              +
              + + + + diff --git a/v3/examples/web-apis/device-orientation/main.go b/v3/examples/web-apis/device-orientation/main.go new file mode 100644 index 000000000..a6fdab2bc --- /dev/null +++ b/v3/examples/web-apis/device-orientation/main.go @@ -0,0 +1,26 @@ +package main + +import ( + "embed" + "github.com/wailsapp/wails/v3/pkg/application" +) + +//go:embed frontend/* +var assets embed.FS + +func main() { + app := application.New(application.Options{ + Name: "Device Orientation Demo", + Description: "Accelerometer and gyroscope", + Assets: application.AssetOptions{ + Handler: application.BundledAssetFileServer(assets), + }, + }) + app.Window.NewWithOptions(application.WebviewWindowOptions{ + Title: "Device Orientation Demo", + Width: 900, + Height: 700, + URL: "/", + }) + app.Run() +} diff --git a/v3/examples/web-apis/dialog/frontend/index.html b/v3/examples/web-apis/dialog/frontend/index.html new file mode 100644 index 000000000..2e3bfe491 --- /dev/null +++ b/v3/examples/web-apis/dialog/frontend/index.html @@ -0,0 +1,587 @@ + + + + + + Dialog Element API Demo + + + +
              +

              Dialog Element API Demo

              +

              + The HTML <dialog> element provides a native way to create modal and non-modal dialog boxes, + with built-in accessibility features and backdrop handling. +

              + +
              + Dialog Element API: checking... +
              + +
              +

              API Support

              +
              +
              + +
              +

              Basic Modal Dialog

              +

              Modal dialogs block interaction with the rest of the page:

              + +
              +
              Last action:
              +
              -
              +
              +
              + +
              +

              Non-Modal Dialog

              +

              Non-modal dialogs allow interaction with the page:

              + + +
              + +
              +

              Confirm Dialog

              +

              A custom confirm dialog that returns user choice:

              + +
              +
              User choice:
              +
              -
              +
              +
              + +
              +

              Form Dialog

              +

              Dialog with form that uses method="dialog":

              + +
              +
              Form data:
              +
              -
              +
              +
              + +
              +

              Alert Variants

              +

              Different styled dialogs for various purposes:

              + + + + +
              + +
              +

              Stacked Dialogs

              +

              Multiple dialogs can be stacked:

              + +
              + +
              +

              Event Log

              + +
              Dialog events will appear here...
              +
              +
              + + + +
              +

              Basic Modal Dialog

              + +
              +
              +

              This is a modal dialog. The backdrop prevents interaction with the page behind it.

              +

              Press Escape or click outside to close (if enabled).

              +
              + +
              + + + +
              +

              Non-Modal Dialog

              + +
              +
              +

              This dialog allows interaction with the page behind it.

              +

              You can still click buttons and scroll the page.

              +
              +
              + + + +
              +

              Confirm Action

              + +
              +
              +

              Are you sure you want to proceed with this action?

              +

              This action may have consequences.

              +
              + +
              + + + +
              +
              +

              User Information

              + +
              +
              +
              + + +
              +
              + + +
              +
              + + +
              +
              + + +
              +
              + +
              +
              + + + +
              +

              Alert

              + +
              +
              +

              Alert message

              +
              + +
              + + + +
              +

              First Dialog

              + +
              +
              +

              This is the first dialog in the stack.

              +

              Click the button below to open another dialog on top.

              +
              + +
              + + + +
              +

              Second Dialog

              + +
              +
              +

              This is the second dialog, stacked on top of the first.

              +

              You can stack as many dialogs as needed.

              +
              + +
              + + + +
              +

              Third Dialog

              + +
              +
              +

              This is the third and final dialog in the stack.

              +

              Close dialogs in reverse order by pressing Escape or clicking Close.

              +
              + +
              + + + + diff --git a/v3/examples/web-apis/dialog/main.go b/v3/examples/web-apis/dialog/main.go new file mode 100644 index 000000000..de3e722fe --- /dev/null +++ b/v3/examples/web-apis/dialog/main.go @@ -0,0 +1,26 @@ +package main + +import ( + "embed" + "github.com/wailsapp/wails/v3/pkg/application" +) + +//go:embed frontend/* +var assets embed.FS + +func main() { + app := application.New(application.Options{ + Name: "Dialog Element Demo", + Description: "Native modal dialogs", + Assets: application.AssetOptions{ + Handler: application.BundledAssetFileServer(assets), + }, + }) + app.Window.NewWithOptions(application.WebviewWindowOptions{ + Title: "Dialog Element Demo", + Width: 900, + Height: 700, + URL: "/", + }) + app.Run() +} diff --git a/v3/examples/web-apis/drag-drop/frontend/index.html b/v3/examples/web-apis/drag-drop/frontend/index.html new file mode 100644 index 000000000..db60169ea --- /dev/null +++ b/v3/examples/web-apis/drag-drop/frontend/index.html @@ -0,0 +1,740 @@ + + + + + + HTML5 Drag and Drop API Demo + + + +
              +

              HTML5 Drag and Drop API Demo

              +

              + The HTML5 Drag and Drop API enables drag-and-drop functionality for + web applications, supporting both element dragging and file drops. +

              + +
              + Drag and Drop API: checking... +
              + +
              +

              Statistics

              +
              +
              +
              0
              +
              Drag Operations
              +
              +
              +
              0
              +
              Successful Drops
              +
              +
              +
              0
              +
              Files Dropped
              +
              +
              +
              0
              +
              Sort Operations
              +
              +
              +
              + +
              +

              Drag Items to Categories

              +

              + Drag the food items on the left and drop them into the correct category zones. +

              + +
              +
              +
              Apple
              +
              Carrot
              +
              Cheese
              +
              Steak
              +
              Banana
              +
              Broccoli
              +
              Milk
              +
              Chicken
              +
              +
              +
              +
              Fruits
              +
              +
              Drop fruits here
              +
              +
              +
              +
              Vegetables
              +
              +
              Drop vegetables here
              +
              +
              +
              +
              Dairy
              +
              +
              Drop dairy here
              +
              +
              +
              +
              Meat
              +
              +
              Drop meat here
              +
              +
              +
              +
              +
              + +
              +

              File Drop Zone

              +

              + Drag and drop files from your computer into the zone below. +

              +
              +
              📁
              +
              Drag files here or click to select
              + +
              +
              + +
              + +
              +

              Sortable List

              +

              + Drag items to reorder the list. The rank numbers will update automatically. +

              + +
                +
              • + + 1 + Learn HTML5 Drag and Drop +
              • +
              • + + 2 + Build interactive interfaces +
              • +
              • + + 3 + Implement file uploads +
              • +
              • + + 4 + Create sortable lists +
              • +
              • + + 5 + Master drag events +
              • +
              +
              + +
              +

              API Support

              +
              +
              + +
              +

              Event Log

              + +
              Drag and drop events will be logged here... + +Try dragging items between zones or dropping files.
              +
              +
              + + + + diff --git a/v3/examples/web-apis/drag-drop/main.go b/v3/examples/web-apis/drag-drop/main.go new file mode 100644 index 000000000..9e4342a67 --- /dev/null +++ b/v3/examples/web-apis/drag-drop/main.go @@ -0,0 +1,26 @@ +package main + +import ( + "embed" + "github.com/wailsapp/wails/v3/pkg/application" +) + +//go:embed frontend/* +var assets embed.FS + +func main() { + app := application.New(application.Options{ + Name: "Drag and Drop Demo", + Description: "Native drag and drop", + Assets: application.AssetOptions{ + Handler: application.BundledAssetFileServer(assets), + }, + }) + app.Window.NewWithOptions(application.WebviewWindowOptions{ + Title: "Drag and Drop Demo", + Width: 900, + Height: 700, + URL: "/", + }) + app.Run() +} diff --git a/v3/examples/web-apis/eventsource/frontend/index.html b/v3/examples/web-apis/eventsource/frontend/index.html new file mode 100644 index 000000000..d85dac7eb --- /dev/null +++ b/v3/examples/web-apis/eventsource/frontend/index.html @@ -0,0 +1,495 @@ + + + + + + Server-Sent Events (EventSource) Demo + + + +
              +

              Server-Sent Events (EventSource) Demo

              +

              + Server-Sent Events (SSE) enable servers to push data to web clients over HTTP. + Unlike WebSockets, SSE is unidirectional (server to client) and works over standard HTTP. +

              + +
              +
              + EventSource: Checking... +
              + +
              +

              Connection

              +
              +
              + + +
              +
              + + +

              + Public SSE test servers: sse.dev/test, or use the mock stream below for testing. +

              +
              + +
              +

              Mock Event Stream

              +
              +

              Local Mock (No Server Required)

              +

              + Since SSE requires a server, this mock simulates event streams locally for testing. +

              +
              + + +
              +
              + + +
              + + +
              +
              + +
              +

              Statistics

              +
              +
              +
              0
              +
              Total Events
              +
              +
              +
              0
              +
              Messages
              +
              +
              +
              0
              +
              Custom Events
              +
              +
              +
              0
              +
              Errors
              +
              +
              +
              + +
              +

              Event Log

              + +
              +
              + --:--:-- + INFO + Ready to connect to an SSE endpoint or start mock stream... +
              +
              +
              + +
              +

              EventSource API Reference

              +
              +// Create EventSource connection +const source = new EventSource('https://api.example.com/stream'); + +// Connection opened +source.onopen = (event) => { + console.log('Connection opened'); +}; + +// Default message event +source.onmessage = (event) => { + console.log('Message:', event.data); + console.log('Last Event ID:', event.lastEventId); + console.log('Origin:', event.origin); +}; + +// Custom named events +source.addEventListener('update', (event) => { + console.log('Update event:', event.data); +}); + +source.addEventListener('notification', (event) => { + console.log('Notification:', event.data); +}); + +// Error handling +source.onerror = (event) => { + if (source.readyState === EventSource.CONNECTING) { + console.log('Reconnecting...'); + } else { + console.log('Error occurred'); + } +}; + +// Close connection +source.close(); + +// Ready states +EventSource.CONNECTING // 0 - Connecting +EventSource.OPEN // 1 - Open +EventSource.CLOSED // 2 - Closed + +// Server response format (text/event-stream): +// data: Simple message\n\n +// data: {"json": "data"}\n\n +// event: custom\ndata: Custom event\n\n +// id: 123\ndata: Message with ID\n\n +// retry: 5000\n\n
              +
              +
              + + + + diff --git a/v3/examples/web-apis/eventsource/main.go b/v3/examples/web-apis/eventsource/main.go new file mode 100644 index 000000000..97c5622c4 --- /dev/null +++ b/v3/examples/web-apis/eventsource/main.go @@ -0,0 +1,26 @@ +package main + +import ( + "embed" + "github.com/wailsapp/wails/v3/pkg/application" +) + +//go:embed frontend/* +var assets embed.FS + +func main() { + app := application.New(application.Options{ + Name: "Server-Sent Events Demo", + Description: "EventSource/SSE API demonstration", + Assets: application.AssetOptions{ + Handler: application.BundledAssetFileServer(assets), + }, + }) + app.Window.NewWithOptions(application.WebviewWindowOptions{ + Title: "Server-Sent Events Demo", + Width: 900, + Height: 700, + URL: "/", + }) + app.Run() +} diff --git a/v3/examples/web-apis/fetch/frontend/index.html b/v3/examples/web-apis/fetch/frontend/index.html new file mode 100644 index 000000000..e5f21526d --- /dev/null +++ b/v3/examples/web-apis/fetch/frontend/index.html @@ -0,0 +1,286 @@ + + + + + + Fetch API Demo + + + +
              +

              Fetch API Demo

              +

              + The Fetch API provides a modern interface for making HTTP requests. + It returns Promises and supports various request/response types. +

              + +
              + Fetch API available: checking... +
              + +
              +

              Make Request

              +
              +
              + + +
              +
              + + +
              +
              +
              + + +
              +
              + + +
              + + + + +
              + +
              +

              Response

              + + +
              + + +
              +
              Make a request to see the response...
              + +
              + +
              +

              Fetch API Features

              +
              +fetch(url, options) returns a Promise<Response> + +Options: +- method: 'GET', 'POST', 'PUT', 'DELETE', etc. +- headers: Headers object or plain object +- body: String, FormData, Blob, ArrayBuffer, URLSearchParams +- mode: 'cors', 'no-cors', 'same-origin' +- credentials: 'omit', 'same-origin', 'include' +- cache: 'default', 'no-store', 'reload', 'no-cache', 'force-cache' +- redirect: 'follow', 'error', 'manual' +- signal: AbortController.signal for cancellation + +Response methods: +- response.json() - Parse as JSON +- response.text() - Get as text +- response.blob() - Get as Blob +- response.arrayBuffer() - Get as ArrayBuffer +- response.formData() - Get as FormData + +Response properties: +- response.ok (status 200-299) +- response.status +- response.statusText +- response.headers +- response.url +- response.type
              +
              +
              + + + + diff --git a/v3/examples/web-apis/fetch/main.go b/v3/examples/web-apis/fetch/main.go new file mode 100644 index 000000000..2e738954d --- /dev/null +++ b/v3/examples/web-apis/fetch/main.go @@ -0,0 +1,29 @@ +package main + +import ( + "embed" + + "github.com/wailsapp/wails/v3/pkg/application" +) + +//go:embed frontend/* +var assets embed.FS + +func main() { + app := application.New(application.Options{ + Name: "Fetch API Demo", + Description: "Demonstrates the Fetch API for network requests", + Assets: application.AssetOptions{ + Handler: application.BundledAssetFileServer(assets), + }, + }) + + app.Window.NewWithOptions(application.WebviewWindowOptions{ + Title: "Fetch API Demo", + Width: 800, + Height: 600, + URL: "/", + }) + + app.Run() +} diff --git a/v3/examples/web-apis/file-api/frontend/index.html b/v3/examples/web-apis/file-api/frontend/index.html new file mode 100644 index 000000000..eee807321 --- /dev/null +++ b/v3/examples/web-apis/file-api/frontend/index.html @@ -0,0 +1,623 @@ + + + + + + File API Demo + + + +
              +

              File API Demo

              +

              + The File API provides access to file information and content, enabling web applications + to read files selected by users through file inputs or drag-and-drop operations. +

              + +
              + File API available: checking... +
              + +
              +

              API Support

              +
              +
              + +
              +

              Select Files

              +
              +

              Drop files here or click to select

              +

              Supports multiple files of any type

              + +
              +
              +
              + +
              +

              File Information

              +

              Select a file above to see its details

              +
              No file selected yet...
              +
              + +
              +

              Read File Content

              +

              Choose how to read the selected file

              +
              + + + + +
              + + +
              +
              +
              +
              Select a file and click "Read File" to see content...
              +
              +
              + +
              +

              File Slice Demo

              +

              Read a portion of the selected file using slice()

              +
              +
              + + +
              +
              + + +
              +
              + +
              Select a file and define a range to read a slice...
              +
              + +
              +

              Create File from Text

              +

              Create a new File object from text content

              +
              + + +
              +
              +
              + + +
              +
              + + +
              +
              + + +
              Click "Create File" to create a new File object...
              +
              + +
              +

              Event Log

              + +
              +
              Ready to log file events...
              +
              +
              +
              + + + + diff --git a/v3/examples/web-apis/file-api/main.go b/v3/examples/web-apis/file-api/main.go new file mode 100644 index 000000000..2a81b0d64 --- /dev/null +++ b/v3/examples/web-apis/file-api/main.go @@ -0,0 +1,26 @@ +package main + +import ( + "embed" + "github.com/wailsapp/wails/v3/pkg/application" +) + +//go:embed frontend/* +var assets embed.FS + +func main() { + app := application.New(application.Options{ + Name: "File API Demo", + Description: "File reading and handling", + Assets: application.AssetOptions{ + Handler: application.BundledAssetFileServer(assets), + }, + }) + app.Window.NewWithOptions(application.WebviewWindowOptions{ + Title: "File API Demo", + Width: 900, + Height: 700, + URL: "/", + }) + app.Run() +} diff --git a/v3/examples/web-apis/fullscreen/frontend/index.html b/v3/examples/web-apis/fullscreen/frontend/index.html new file mode 100644 index 000000000..99adeb357 --- /dev/null +++ b/v3/examples/web-apis/fullscreen/frontend/index.html @@ -0,0 +1,286 @@ + + + + + + Fullscreen API Demo + + + +
              +

              Fullscreen API Demo

              +

              + The Fullscreen API allows elements to be displayed in full-screen mode, + hiding all browser UI for an immersive experience. +

              + +
              + Fullscreen API: checking... +
              + +
              +

              Element Fullscreen

              +
              +

              Fullscreen Target

              +

              Click the button below to make this element fullscreen

              +

              Press ESC or click Exit to leave fullscreen

              + + +
              +
              + +
              +

              Document Fullscreen

              + + + +
              + +
              +

              Video Fullscreen

              +
              + +
              + + + +
              +
              +

              + Note: A sample video would play here. The fullscreen button demonstrates video fullscreen. +

              +
              + +
              +

              Fullscreen State

              +
              Current state will be displayed here...
              +
              + +
              +

              API Support

              +
              +
              +
              + + + + diff --git a/v3/examples/web-apis/fullscreen/main.go b/v3/examples/web-apis/fullscreen/main.go new file mode 100644 index 000000000..4c717c91e --- /dev/null +++ b/v3/examples/web-apis/fullscreen/main.go @@ -0,0 +1,29 @@ +package main + +import ( + "embed" + + "github.com/wailsapp/wails/v3/pkg/application" +) + +//go:embed frontend/* +var assets embed.FS + +func main() { + app := application.New(application.Options{ + Name: "Fullscreen Demo", + Description: "Demonstrates the Fullscreen API", + Assets: application.AssetOptions{ + Handler: application.BundledAssetFileServer(assets), + }, + }) + + app.Window.NewWithOptions(application.WebviewWindowOptions{ + Title: "Fullscreen Demo", + Width: 800, + Height: 600, + URL: "/", + }) + + app.Run() +} diff --git a/v3/examples/web-apis/gamepad/frontend/index.html b/v3/examples/web-apis/gamepad/frontend/index.html new file mode 100644 index 000000000..9cfc14e92 --- /dev/null +++ b/v3/examples/web-apis/gamepad/frontend/index.html @@ -0,0 +1,754 @@ + + + + + + Gamepad API Demo + + + +
              +

              Gamepad API Demo

              +

              + The Gamepad API provides access to game controllers. Connect a gamepad and press any button to activate it. + Supports standard controllers, analog sticks, triggers, and rumble feedback. +

              + +
              + Gamepad API: checking... +
              + +
              +

              Connected Controllers

              +
              +
              +
              1
              +
              No controller
              +
              +
              +
              2
              +
              No controller
              +
              +
              +
              3
              +
              No controller
              +
              +
              +
              4
              +
              No controller
              +
              +
              +
              + + + + + +
              +

              Axes Values

              +
              +
              Connect a gamepad to see axis values
              +
              +
              + +
              +

              Gamepad Info

              +
              +
              + ID + - +
              +
              + Mapping + - +
              +
              + Buttons + - +
              +
              + Axes + - +
              +
              + Timestamp + - +
              +
              + Vibration + - +
              +
              +
              + +
              +

              Event Log

              + +
              +
              Waiting for gamepad events... Press a button on your controller.
              +
              +
              +
              + + + + diff --git a/v3/examples/web-apis/gamepad/main.go b/v3/examples/web-apis/gamepad/main.go new file mode 100644 index 000000000..6604670fa --- /dev/null +++ b/v3/examples/web-apis/gamepad/main.go @@ -0,0 +1,26 @@ +package main + +import ( + "embed" + "github.com/wailsapp/wails/v3/pkg/application" +) + +//go:embed frontend/* +var assets embed.FS + +func main() { + app := application.New(application.Options{ + Name: "Gamepad API Demo", + Description: "Game controller input", + Assets: application.AssetOptions{ + Handler: application.BundledAssetFileServer(assets), + }, + }) + app.Window.NewWithOptions(application.WebviewWindowOptions{ + Title: "Gamepad API Demo", + Width: 900, + Height: 700, + URL: "/", + }) + app.Run() +} diff --git a/v3/examples/web-apis/geolocation/frontend/index.html b/v3/examples/web-apis/geolocation/frontend/index.html new file mode 100644 index 000000000..110f9fa68 --- /dev/null +++ b/v3/examples/web-apis/geolocation/frontend/index.html @@ -0,0 +1,315 @@ + + + + + + Geolocation API Demo + + + +
              +

              Geolocation API Demo

              +

              + The Geolocation API allows web applications to access the user's geographical location. + It requires user permission and works best with GPS-enabled devices. +

              + +
              + Geolocation: checking... +
              + +
              +

              Current Position

              + + + + + + +
              + Get location to see coordinates +
              +
              + +
              +

              Position Options

              +
              + + + +
              +
              + +
              +

              Position History

              +
                +
              • No positions recorded yet...
              • +
              +
              + +
              +

              Raw Position Data

              +
              Position data will appear here...
              +
              +
              + + + + diff --git a/v3/examples/web-apis/geolocation/main.go b/v3/examples/web-apis/geolocation/main.go new file mode 100644 index 000000000..2be228d3d --- /dev/null +++ b/v3/examples/web-apis/geolocation/main.go @@ -0,0 +1,29 @@ +package main + +import ( + "embed" + + "github.com/wailsapp/wails/v3/pkg/application" +) + +//go:embed frontend/* +var assets embed.FS + +func main() { + app := application.New(application.Options{ + Name: "Geolocation Demo", + Description: "Demonstrates the Geolocation API", + Assets: application.AssetOptions{ + Handler: application.BundledAssetFileServer(assets), + }, + }) + + app.Window.NewWithOptions(application.WebviewWindowOptions{ + Title: "Geolocation Demo", + Width: 800, + Height: 600, + URL: "/", + }) + + app.Run() +} diff --git a/v3/examples/web-apis/history/frontend/index.html b/v3/examples/web-apis/history/frontend/index.html new file mode 100644 index 000000000..a21a58623 --- /dev/null +++ b/v3/examples/web-apis/history/frontend/index.html @@ -0,0 +1,736 @@ + + + + + + History API Demo + + + +
              +

              History API Demo

              +

              + The History API allows manipulation of the browser session history, enabling + single-page applications (SPAs) to update the URL without full page reloads. +

              + +
              + History API: checking... +
              + +
              +

              Current State

              +
              + URL: + -- +
              + +
              +
              history.state:
              +
              null
              +
              + +
              +
              +
              0
              +
              History Length
              +
              +
              +
              0
              +
              pushState Calls
              +
              +
              +
              0
              +
              replaceState Calls
              +
              +
              +
              0
              +
              popstate Events
              +
              +
              +
              + +
              +

              Navigation Controls

              + + +
              +
              Note on Navigation
              +
              + The back/forward buttons use history.back() and history.forward(). + You can also use history.go(n) to jump multiple entries. + Navigation will trigger the popstate event. +
              +
              +
              + +
              +

              Simulated SPA Navigation

              +

              + Click pages below to navigate. The URL updates without a page reload. +

              +
              + Home + Products + About + Contact + Settings +
              + +
              +
              🏠
              +
              Home
              +
              Welcome to the home page
              +
              +
              + +
              +

              pushState

              +

              + Add a new entry to the browser history. This does not reload the page. +

              +
              + + +
              +
              + + +
              +
              + + +
              + +
              + +
              +

              replaceState

              +

              + Replace the current history entry. Does not create a new entry. +

              +
              + + +
              +
              + + +
              + +
              + +
              +

              History Stack (Local Tracking)

              +

              + Note: The History API does not provide access to the full history stack for privacy reasons. + This list tracks only entries created during this session. +

              + +
              +
              +
              + 0 + -- +
              +
              Loading...
              +
              state: null
              +
              +
              +
              + +
              +

              API Support

              +
              +
              + +
              +

              Event Log

              + +
              History events will be logged here... + +Use the controls above to manipulate history and see events logged.
              +
              +
              + + + + diff --git a/v3/examples/web-apis/history/main.go b/v3/examples/web-apis/history/main.go new file mode 100644 index 000000000..20b75133d --- /dev/null +++ b/v3/examples/web-apis/history/main.go @@ -0,0 +1,26 @@ +package main + +import ( + "embed" + "github.com/wailsapp/wails/v3/pkg/application" +) + +//go:embed frontend/* +var assets embed.FS + +func main() { + app := application.New(application.Options{ + Name: "History API Demo", + Description: "Browser history manipulation", + Assets: application.AssetOptions{ + Handler: application.BundledAssetFileServer(assets), + }, + }) + app.Window.NewWithOptions(application.WebviewWindowOptions{ + Title: "History API Demo", + Width: 900, + Height: 700, + URL: "/", + }) + app.Run() +} diff --git a/v3/examples/web-apis/indexeddb/frontend/index.html b/v3/examples/web-apis/indexeddb/frontend/index.html new file mode 100644 index 000000000..2a40533b5 --- /dev/null +++ b/v3/examples/web-apis/indexeddb/frontend/index.html @@ -0,0 +1,364 @@ + + + + + + IndexedDB API Demo + + + +
              +

              IndexedDB API Demo

              +

              + IndexedDB is a low-level API for storing significant amounts of structured data, + including files and blobs. It uses indexes for high-performance searches. +

              + +
              + IndexedDB available: checking... +
              + +
              +

              Add Person Record

              +
              +
              + + +
              +
              + + +
              +
              + + +
              +
              + + +
              + +
              +

              Search Records

              +
              +
              + + +
              +
              + + +
              +
              + + + +
              + +
              +

              Records

              + + + + + + + + + + + +
              IDNameEmailAgeActions
              +
              + +
              +

              Database Info

              +
              +
              +
              + + + + diff --git a/v3/examples/web-apis/indexeddb/main.go b/v3/examples/web-apis/indexeddb/main.go new file mode 100644 index 000000000..c6c532d79 --- /dev/null +++ b/v3/examples/web-apis/indexeddb/main.go @@ -0,0 +1,29 @@ +package main + +import ( + "embed" + + "github.com/wailsapp/wails/v3/pkg/application" +) + +//go:embed frontend/* +var assets embed.FS + +func main() { + app := application.New(application.Options{ + Name: "IndexedDB Demo", + Description: "Demonstrates the IndexedDB API for client-side database storage", + Assets: application.AssetOptions{ + Handler: application.BundledAssetFileServer(assets), + }, + }) + + app.Window.NewWithOptions(application.WebviewWindowOptions{ + Title: "IndexedDB Demo", + Width: 800, + Height: 600, + URL: "/", + }) + + app.Run() +} diff --git a/v3/examples/web-apis/intersection-observer/frontend/index.html b/v3/examples/web-apis/intersection-observer/frontend/index.html new file mode 100644 index 000000000..07e21afa9 --- /dev/null +++ b/v3/examples/web-apis/intersection-observer/frontend/index.html @@ -0,0 +1,285 @@ + + + + + + Intersection Observer API Demo + + + +
              +

              Intersection Observer API Demo

              +

              + The Intersection Observer API provides a way to asynchronously observe changes + in the intersection of a target element with an ancestor element or viewport. +

              + +
              + Intersection Observer: checking... +
              + +
              +
              Visibility
              +
              Box 1
              +
              Box 2
              +
              Box 3
              +
              Box 4
              +
              Box 5
              +
              + +
              +

              Observer Options

              +
              +
              + + +
              +
              + + +
              + +
              +
              + +
              +

              Scroll Demo

              +

              Scroll down to see elements animate when they enter the viewport.

              +
              +
              +
              Box 1 - I animate when visible!
              +
              +
              Box 2 - Intersection detected!
              +
              +
              Box 3 - Lazy loading example
              +
              +
              Box 4 - Analytics trigger
              +
              +
              Box 5 - Infinite scroll trigger
              +
              +
              +
              + +
              +

              Lazy Loading Images

              +

              Images load when they enter the viewport.

              +
              +
              Scroll to load...
              +
              Scroll to load...
              +
              Scroll to load...
              +
              +
              + +
              +

              Event Log

              +
              Intersection events will appear here...
              +
              +
              + + + + diff --git a/v3/examples/web-apis/intersection-observer/main.go b/v3/examples/web-apis/intersection-observer/main.go new file mode 100644 index 000000000..60f32a377 --- /dev/null +++ b/v3/examples/web-apis/intersection-observer/main.go @@ -0,0 +1,29 @@ +package main + +import ( + "embed" + + "github.com/wailsapp/wails/v3/pkg/application" +) + +//go:embed frontend/* +var assets embed.FS + +func main() { + app := application.New(application.Options{ + Name: "Intersection Observer Demo", + Description: "Demonstrates the Intersection Observer API", + Assets: application.AssetOptions{ + Handler: application.BundledAssetFileServer(assets), + }, + }) + + app.Window.NewWithOptions(application.WebviewWindowOptions{ + Title: "Intersection Observer Demo", + Width: 800, + Height: 600, + URL: "/", + }) + + app.Run() +} diff --git a/v3/examples/web-apis/localstorage/frontend/index.html b/v3/examples/web-apis/localstorage/frontend/index.html new file mode 100644 index 000000000..59df31656 --- /dev/null +++ b/v3/examples/web-apis/localstorage/frontend/index.html @@ -0,0 +1,226 @@ + + + + + + LocalStorage API Demo + + + +
              +

              LocalStorage API Demo

              +

              + The Web Storage API provides localStorage for persistent key-value storage + that survives browser restarts. +

              + +
              + localStorage is available: checking... +
              + +
              +

              Store Data

              +
              + + +
              +
              + + +
              + + +
              + +
              +

              Stored Items (0)

              + + +
                +
                + +
                +

                Storage Info

                +
                +
                +
                + + + + diff --git a/v3/examples/web-apis/localstorage/main.go b/v3/examples/web-apis/localstorage/main.go new file mode 100644 index 000000000..1fc617464 --- /dev/null +++ b/v3/examples/web-apis/localstorage/main.go @@ -0,0 +1,29 @@ +package main + +import ( + "embed" + + "github.com/wailsapp/wails/v3/pkg/application" +) + +//go:embed frontend/* +var assets embed.FS + +func main() { + app := application.New(application.Options{ + Name: "LocalStorage Demo", + Description: "Demonstrates the Web Storage API (localStorage)", + Assets: application.AssetOptions{ + Handler: application.BundledAssetFileServer(assets), + }, + }) + + app.Window.NewWithOptions(application.WebviewWindowOptions{ + Title: "LocalStorage API Demo", + Width: 800, + Height: 600, + URL: "/", + }) + + app.Run() +} diff --git a/v3/examples/web-apis/mediadevices/frontend/index.html b/v3/examples/web-apis/mediadevices/frontend/index.html new file mode 100644 index 000000000..56d581834 --- /dev/null +++ b/v3/examples/web-apis/mediadevices/frontend/index.html @@ -0,0 +1,560 @@ + + + + + + MediaDevices API Demo + + + +
                +

                MediaDevices API Demo

                +

                + The MediaDevices API provides access to connected media input devices like cameras and microphones. + It enables applications to enumerate devices and request audio/video streams. +

                + +
                + MediaDevices API: checking... +
                + +
                +

                API Support

                +
                +
                + +
                +

                Available Devices

                + + +
                +

                Click "Enumerate Devices" to list available media devices...

                +
                +
                + +
                +

                Camera & Microphone Preview

                +
                + + +
                + + + + + +
                +
                +

                Video Preview

                + +
                +
                +

                Audio Level

                +
                +
                +
                +

                + Start preview to see audio levels... +

                +
                +
                +
                + +
                +

                Constraints Builder

                +

                Configure media constraints for getUserMedia:

                +
                + + + + + + +
                + + +
                + +
                +

                Event Log

                + +
                Events will be logged here...
                +
                +
                + + + + diff --git a/v3/examples/web-apis/mediadevices/main.go b/v3/examples/web-apis/mediadevices/main.go new file mode 100644 index 000000000..5cc8d1ba6 --- /dev/null +++ b/v3/examples/web-apis/mediadevices/main.go @@ -0,0 +1,26 @@ +package main + +import ( + "embed" + "github.com/wailsapp/wails/v3/pkg/application" +) + +//go:embed frontend/* +var assets embed.FS + +func main() { + app := application.New(application.Options{ + Name: "Media Devices Demo", + Description: "Camera and microphone access", + Assets: application.AssetOptions{ + Handler: application.BundledAssetFileServer(assets), + }, + }) + app.Window.NewWithOptions(application.WebviewWindowOptions{ + Title: "Media Devices Demo", + Width: 900, + Height: 700, + URL: "/", + }) + app.Run() +} diff --git a/v3/examples/web-apis/mediarecorder/frontend/index.html b/v3/examples/web-apis/mediarecorder/frontend/index.html new file mode 100644 index 000000000..8979d9454 --- /dev/null +++ b/v3/examples/web-apis/mediarecorder/frontend/index.html @@ -0,0 +1,803 @@ + + + + + + MediaRecorder API Demo + + + +
                +

                MediaRecorder API Demo

                +

                + The MediaRecorder API enables recording audio and video streams from MediaDevices. + Create recordings from camera, microphone, or screen capture sources. +

                + +
                + MediaRecorder API: checking... +
                + +
                +

                API Support

                +
                +
                + +
                +

                Supported MIME Types

                +
                +
                + +
                +

                Audio Recording

                + + + + + + + +
                +

                Audio Playback

                + +
                +
                + +
                +

                Video Recording

                + + +
                + +
                + +
                + + + Data chunks interval +
                + + + + + + + +
                +
                +

                Live Preview

                + +
                +
                +

                Recording Playback

                + +
                +
                + +
                +
                +
                0
                +
                Data Chunks
                +
                +
                +
                0 KB
                +
                Total Size
                +
                +
                +
                inactive
                +
                State
                +
                +
                +
                + +
                +

                Recordings

                + +
                +

                No recordings yet. Start recording to see them here.

                +
                +
                + +
                +

                Event Log

                + +
                Events will be logged here...
                +
                +
                + + + + diff --git a/v3/examples/web-apis/mediarecorder/main.go b/v3/examples/web-apis/mediarecorder/main.go new file mode 100644 index 000000000..85761962d --- /dev/null +++ b/v3/examples/web-apis/mediarecorder/main.go @@ -0,0 +1,26 @@ +package main + +import ( + "embed" + "github.com/wailsapp/wails/v3/pkg/application" +) + +//go:embed frontend/* +var assets embed.FS + +func main() { + app := application.New(application.Options{ + Name: "MediaRecorder Demo", + Description: "Record audio/video streams", + Assets: application.AssetOptions{ + Handler: application.BundledAssetFileServer(assets), + }, + }) + app.Window.NewWithOptions(application.WebviewWindowOptions{ + Title: "MediaRecorder Demo", + Width: 900, + Height: 700, + URL: "/", + }) + app.Run() +} diff --git a/v3/examples/web-apis/mutation-observer/frontend/index.html b/v3/examples/web-apis/mutation-observer/frontend/index.html new file mode 100644 index 000000000..7f4dad734 --- /dev/null +++ b/v3/examples/web-apis/mutation-observer/frontend/index.html @@ -0,0 +1,506 @@ + + + + + + MutationObserver API Demo + + + +
                +

                MutationObserver API Demo

                +

                + The MutationObserver API provides the ability to watch for changes being made to the DOM tree, + including child elements, attributes, and text content. +

                + +
                + MutationObserver: checking... +
                + +
                +

                Observer Configuration

                +

                Configure what types of mutations to observe:

                +
                +
                + +
                Watch for added/removed child nodes
                +
                +
                + +
                Watch for attribute changes
                +
                +
                + +
                Watch for text content changes
                +
                +
                + +
                Include descendant nodes
                +
                +
                +
                + + + Inactive +
                +
                + +
                +

                Mutation Statistics

                +
                +
                +
                0
                +
                Child List Mutations
                +
                +
                +
                0
                +
                Attribute Mutations
                +
                +
                +
                0
                +
                Character Data Mutations
                +
                +
                + +
                + +
                +

                Child List Mutations

                +

                Add, remove, or modify child elements:

                +
                + + + +
                +
                +
                Initial Element 1
                +
                Initial Element 2
                +
                +
                + +
                +

                Attribute Mutations

                +

                Modify element attributes:

                +
                + + + +
                +
                +
                Watch my attributes change!
                +
                +
                + +
                +

                Character Data Mutations

                +

                Edit the text content below (click to edit):

                +
                + Edit this text to trigger characterData mutations. Try typing, deleting, or pasting text! +
                +
                + +
                +

                Batch Mutations

                +

                Perform multiple mutations at once:

                +
                + + + +
                +
                + +
                +

                Event Log

                +
                Mutation events will appear here...
                + +
                +
                + + + + diff --git a/v3/examples/web-apis/mutation-observer/main.go b/v3/examples/web-apis/mutation-observer/main.go new file mode 100644 index 000000000..5405a9529 --- /dev/null +++ b/v3/examples/web-apis/mutation-observer/main.go @@ -0,0 +1,26 @@ +package main + +import ( + "embed" + "github.com/wailsapp/wails/v3/pkg/application" +) + +//go:embed frontend/* +var assets embed.FS + +func main() { + app := application.New(application.Options{ + Name: "Mutation Observer Demo", + Description: "DOM change observation", + Assets: application.AssetOptions{ + Handler: application.BundledAssetFileServer(assets), + }, + }) + app.Window.NewWithOptions(application.WebviewWindowOptions{ + Title: "Mutation Observer Demo", + Width: 900, + Height: 700, + URL: "/", + }) + app.Run() +} diff --git a/v3/examples/web-apis/notifications/frontend/index.html b/v3/examples/web-apis/notifications/frontend/index.html new file mode 100644 index 000000000..0a968c90a --- /dev/null +++ b/v3/examples/web-apis/notifications/frontend/index.html @@ -0,0 +1,299 @@ + + + + + + Notifications API Demo + + + +
                +

                Notifications API Demo

                +

                + The Notifications API allows web applications to display system notifications + to the user, even when the app is in the background. +

                + +
                + Notifications: checking... +
                + +
                +

                Permission

                +

                Current permission: checking...

                + +

                + Note: Permission must be granted before notifications can be shown. + Some browsers block permission requests in webviews. +

                +
                + +
                +

                Create Notification

                +
                +
                + + +
                +
                + + +
                +
                + + +
                +
                + + +
                +
                + + + +
                + +
                +

                Preview

                +
                +
                -
                +
                +
                Notification Title
                +
                Notification body text...
                +
                +
                +
                + +
                +

                Event Log

                +
                Notification events will appear here...
                +
                +
                + + + + diff --git a/v3/examples/web-apis/notifications/main.go b/v3/examples/web-apis/notifications/main.go new file mode 100644 index 000000000..88f1fe9de --- /dev/null +++ b/v3/examples/web-apis/notifications/main.go @@ -0,0 +1,29 @@ +package main + +import ( + "embed" + + "github.com/wailsapp/wails/v3/pkg/application" +) + +//go:embed frontend/* +var assets embed.FS + +func main() { + app := application.New(application.Options{ + Name: "Notifications Demo", + Description: "Demonstrates the Notifications API", + Assets: application.AssetOptions{ + Handler: application.BundledAssetFileServer(assets), + }, + }) + + app.Window.NewWithOptions(application.WebviewWindowOptions{ + Title: "Notifications Demo", + Width: 800, + Height: 600, + URL: "/", + }) + + app.Run() +} diff --git a/v3/examples/web-apis/page-visibility/frontend/index.html b/v3/examples/web-apis/page-visibility/frontend/index.html new file mode 100644 index 000000000..aa5917b45 --- /dev/null +++ b/v3/examples/web-apis/page-visibility/frontend/index.html @@ -0,0 +1,543 @@ + + + + + + Page Visibility API Demo + + + +
                +

                Page Visibility API Demo

                +

                + The Page Visibility API provides events to know when a document becomes visible or hidden, + allowing you to pause/resume activities, save resources, and improve user experience. +

                + +
                + Page Visibility API: checking... +
                + +
                +
                +
                👁
                +
                VISIBLE
                +
                document.visibilityState: visible
                +
                + +
                +
                +
                0s
                +
                Time Visible
                +
                +
                +
                0s
                +
                Time Hidden
                +
                +
                +
                0
                +
                State Changes
                +
                +
                +
                0
                +
                Times Hidden
                +
                +
                +
                + +
                +

                Timer Demo (Pauses When Hidden)

                +

                + This timer pauses when the page is hidden and resumes when visible. + Try switching to another tab or minimizing the window. +

                +
                00:00:00
                + + + + Timer stopped +
                + +
                +

                Video Simulation (Pauses When Hidden)

                +

                + Simulated video player that automatically pauses when you switch tabs. +

                +
                +
                +
                + + + Video paused +
                + +
                +

                Use Cases

                +
                +

                Common Applications

                +
                  +
                • Pause media playback - Stop videos/audio when tab is hidden
                • +
                • Stop animations - Pause CSS/JS animations to save CPU
                • +
                • Defer updates - Skip DOM updates while hidden
                • +
                • Analytics - Track actual time spent viewing content
                • +
                • Save resources - Stop polling/WebSocket activity
                • +
                • Show notifications - Alert users to updates when they return
                • +
                +
                +
                + +
                +

                API Support

                +
                +
                + +
                +

                Event Log

                + +
                Visibility events will be logged here... + +Try switching tabs, minimizing the window, or switching to another application.
                +
                +
                + + + + diff --git a/v3/examples/web-apis/page-visibility/main.go b/v3/examples/web-apis/page-visibility/main.go new file mode 100644 index 000000000..e5499baea --- /dev/null +++ b/v3/examples/web-apis/page-visibility/main.go @@ -0,0 +1,26 @@ +package main + +import ( + "embed" + "github.com/wailsapp/wails/v3/pkg/application" +) + +//go:embed frontend/* +var assets embed.FS + +func main() { + app := application.New(application.Options{ + Name: "Page Visibility Demo", + Description: "Tab visibility detection", + Assets: application.AssetOptions{ + Handler: application.BundledAssetFileServer(assets), + }, + }) + app.Window.NewWithOptions(application.WebviewWindowOptions{ + Title: "Page Visibility Demo", + Width: 900, + Height: 700, + URL: "/", + }) + app.Run() +} diff --git a/v3/examples/web-apis/performance/frontend/index.html b/v3/examples/web-apis/performance/frontend/index.html new file mode 100644 index 000000000..57f1bf586 --- /dev/null +++ b/v3/examples/web-apis/performance/frontend/index.html @@ -0,0 +1,537 @@ + + + + + + Performance API Demo + + + +
                +

                Performance API Demo

                +

                + The Performance API provides access to performance-related information, + enabling precise timing measurements, user timing marks, and performance metrics. +

                + +
                + Performance API: checking... +
                + +
                +

                Page Load Timing

                +

                Key performance metrics from page navigation:

                +
                +
                +
                DOM Content Loaded
                +
                --
                +
                milliseconds
                +
                +
                +
                Page Load Time
                +
                --
                +
                milliseconds
                +
                +
                +
                DNS Lookup
                +
                --
                +
                milliseconds
                +
                +
                +
                Time to First Byte
                +
                --
                +
                milliseconds
                +
                +
                + +
                + +
                +

                Performance Marks & Measures

                +

                Create custom timing marks and measure durations:

                +
                + + + + +
                +
                + + + + + + + + + + + + +
                TypeNameStart TimeDuration
                No marks or measures yet
                +
                +
                + +
                +

                Simulated Task Performance

                +

                Run simulated tasks and measure their performance:

                +
                +
                +
                +
                + + + + +
                +
                +
                +
                Last Task Duration
                +
                --
                +
                milliseconds
                +
                +
                +
                Total Tasks Run
                +
                0
                +
                tasks
                +
                +
                +
                Average Duration
                +
                --
                +
                milliseconds
                +
                +
                +
                + +
                +

                Navigation Timeline

                +

                Visual timeline of page load phases:

                +
                +
                Loading timeline...
                +
                +
                + +
                +

                Resource Timing

                +

                Performance entries for loaded resources:

                +
                Loading resource timing data...
                + +
                + +
                +

                Event Log

                +
                Performance events will appear here...
                +
                +
                + + + + diff --git a/v3/examples/web-apis/performance/main.go b/v3/examples/web-apis/performance/main.go new file mode 100644 index 000000000..2543c6c4b --- /dev/null +++ b/v3/examples/web-apis/performance/main.go @@ -0,0 +1,26 @@ +package main + +import ( + "embed" + "github.com/wailsapp/wails/v3/pkg/application" +) + +//go:embed frontend/* +var assets embed.FS + +func main() { + app := application.New(application.Options{ + Name: "Performance API Demo", + Description: "Performance timing and metrics", + Assets: application.AssetOptions{ + Handler: application.BundledAssetFileServer(assets), + }, + }) + app.Window.NewWithOptions(application.WebviewWindowOptions{ + Title: "Performance API Demo", + Width: 900, + Height: 700, + URL: "/", + }) + app.Run() +} diff --git a/v3/examples/web-apis/permissions/frontend/index.html b/v3/examples/web-apis/permissions/frontend/index.html new file mode 100644 index 000000000..b6c752617 --- /dev/null +++ b/v3/examples/web-apis/permissions/frontend/index.html @@ -0,0 +1,512 @@ + + + + + + Permissions API Demo + + + +
                +

                Permissions API Demo

                +

                + The Permissions API allows you to query and monitor the status of various browser permissions. + It provides a unified way to check whether permissions are granted, denied, or need to be requested. +

                + +
                + Permissions API: checking... +
                + +
                +

                Permission Summary

                +
                +
                + 0 + Granted +
                +
                + 0 + Denied +
                +
                + 0 + Prompt +
                +
                + +
                + +
                +

                Standard Permissions

                +

                + These are the commonly supported permission types across browsers. +

                +
                +
                + +
                +

                Extended Permissions

                +

                + These permissions may not be supported in all browsers or WebView implementations. +

                +
                +
                + +
                +

                Custom Permission Query

                +

                + Query any permission by name. Some permissions may require additional parameters. +

                +
                + + +
                +
                Enter a permission name and click Query to check its status...
                +
                + +
                +

                API Support

                +
                +
                + +
                +

                Event Log

                +
                Permission events will appear here...
                +
                +
                + +
                + + + + diff --git a/v3/examples/web-apis/permissions/main.go b/v3/examples/web-apis/permissions/main.go new file mode 100644 index 000000000..62da88fe0 --- /dev/null +++ b/v3/examples/web-apis/permissions/main.go @@ -0,0 +1,26 @@ +package main + +import ( + "embed" + "github.com/wailsapp/wails/v3/pkg/application" +) + +//go:embed frontend/* +var assets embed.FS + +func main() { + app := application.New(application.Options{ + Name: "Permissions API Demo", + Description: "Permission queries", + Assets: application.AssetOptions{ + Handler: application.BundledAssetFileServer(assets), + }, + }) + app.Window.NewWithOptions(application.WebviewWindowOptions{ + Title: "Permissions API Demo", + Width: 900, + Height: 700, + URL: "/", + }) + app.Run() +} diff --git a/v3/examples/web-apis/pointer-events/frontend/index.html b/v3/examples/web-apis/pointer-events/frontend/index.html new file mode 100644 index 000000000..0182d0a7d --- /dev/null +++ b/v3/examples/web-apis/pointer-events/frontend/index.html @@ -0,0 +1,579 @@ + + + + + + Pointer Events API Demo + + + +
                +

                Pointer Events API Demo

                +

                + The Pointer Events API provides a unified way to handle input from mouse, touch, and pen/stylus + devices with a single event model, including pressure and tilt information. +

                + +
                + Pointer Events API: checking... +
                + +
                +

                API Support

                +
                +
                + +
                +

                Pointer Tracking

                +

                Move your mouse, touch, or use a stylus in the area below:

                +
                +
                +
                +
                Pointer ID
                +
                -
                +
                +
                +
                Pointer Type
                +
                -
                +
                +
                +
                Position (X, Y)
                +
                -, -
                +
                +
                +
                Pressure
                +
                -
                +
                +
                +
                Tilt (X, Y)
                +
                -, -
                +
                +
                +
                Width x Height
                +
                -
                +
                +
                +
                Twist
                +
                -
                +
                +
                +
                Buttons
                +
                -
                +
                +
                +
                +
                + +
                +

                Pressure-Sensitive Drawing

                +

                Draw with pressure sensitivity (size varies with pressure):

                +
                +
                + + +
                +
                + + + 8 +
                +
                + + +
                +
                +
                + + +
                + +
                + +
                +

                Pointer Capture Demo

                +

                Click and drag the box - it captures pointer events even outside itself:

                +
                +
                + Drag Me +
                +
                +
                +
                Capture Status
                +
                Not captured
                +
                +
                +
                +
                + +
                +

                Multi-Touch Points

                +

                Touch with multiple fingers (on touch devices):

                +
                +

                Active touch points: 0

                +
                + +
                +

                Event Log

                + +
                Pointer events will appear here...
                +
                +
                + + + + diff --git a/v3/examples/web-apis/pointer-events/main.go b/v3/examples/web-apis/pointer-events/main.go new file mode 100644 index 000000000..401b6b106 --- /dev/null +++ b/v3/examples/web-apis/pointer-events/main.go @@ -0,0 +1,26 @@ +package main + +import ( + "embed" + "github.com/wailsapp/wails/v3/pkg/application" +) + +//go:embed frontend/* +var assets embed.FS + +func main() { + app := application.New(application.Options{ + Name: "Pointer Events Demo", + Description: "Unified input handling", + Assets: application.AssetOptions{ + Handler: application.BundledAssetFileServer(assets), + }, + }) + app.Window.NewWithOptions(application.WebviewWindowOptions{ + Title: "Pointer Events Demo", + Width: 900, + Height: 700, + URL: "/", + }) + app.Run() +} diff --git a/v3/examples/web-apis/resize-observer/frontend/index.html b/v3/examples/web-apis/resize-observer/frontend/index.html new file mode 100644 index 000000000..4f108edbf --- /dev/null +++ b/v3/examples/web-apis/resize-observer/frontend/index.html @@ -0,0 +1,303 @@ + + + + + + Resize Observer API Demo + + + +
                +

                Resize Observer API Demo

                +

                + The Resize Observer API provides a way to observe changes to the size of elements, + enabling responsive layouts without relying solely on media queries. +

                + +
                + Resize Observer: checking... +
                + +
                +

                Resizable Element

                +

                Drag the bottom-right corner to resize this element:

                +
                +
                Drag to resize me!
                +
                + Width: -- | Height: -- +
                +
                +
                + +
                +

                Responsive Component

                +

                This component changes based on its container size (not viewport):

                +
                +
                Small
                < 300px
                +
                Medium
                300-500px
                +
                Large
                > 500px
                +
                +
                +
                Resize the window to see me change
                +
                --
                +
                +
                + +
                +

                Aspect Ratio Monitor

                +

                This box displays its current aspect ratio:

                +
                + -- +
                +
                + +
                +

                Responsive Chart

                +

                This chart redraws when its container resizes:

                +
                +
                + +
                +

                Resize Events Log

                +
                Resize events will appear here...
                +
                +
                + + + + diff --git a/v3/examples/web-apis/resize-observer/main.go b/v3/examples/web-apis/resize-observer/main.go new file mode 100644 index 000000000..b1818d2ec --- /dev/null +++ b/v3/examples/web-apis/resize-observer/main.go @@ -0,0 +1,29 @@ +package main + +import ( + "embed" + + "github.com/wailsapp/wails/v3/pkg/application" +) + +//go:embed frontend/* +var assets embed.FS + +func main() { + app := application.New(application.Options{ + Name: "Resize Observer Demo", + Description: "Demonstrates the Resize Observer API", + Assets: application.AssetOptions{ + Handler: application.BundledAssetFileServer(assets), + }, + }) + + app.Window.NewWithOptions(application.WebviewWindowOptions{ + Title: "Resize Observer Demo", + Width: 800, + Height: 600, + URL: "/", + }) + + app.Run() +} diff --git a/v3/examples/web-apis/selection/frontend/index.html b/v3/examples/web-apis/selection/frontend/index.html new file mode 100644 index 000000000..2d7cd0fe7 --- /dev/null +++ b/v3/examples/web-apis/selection/frontend/index.html @@ -0,0 +1,548 @@ + + + + + + Selection API Demo + + + +
                +

                Selection API Demo

                +

                + The Selection API provides methods to programmatically select text, get the current selection, + and manipulate selected ranges within a document. +

                + +
                + Selection API: checking... +
                + +
                +

                API Support

                +
                +
                + +
                +

                Text Selection Monitor

                +

                Select any text in the paragraph below:

                +
                + The Selection API is a powerful browser feature that allows JavaScript to programmatically + interact with user text selections. It provides methods to get the currently selected text, + create new selections, modify existing selections, and respond to selection changes. + This API is essential for building rich text editors, annotation tools, and other + interactive text-based applications. Try selecting different parts of this text to see + the API in action! +
                +
                +
                +
                Selected Text
                +
                -
                +
                +
                +
                Character Count
                +
                0
                +
                +
                +
                Range Count
                +
                0
                +
                +
                +
                Selection Type
                +
                None
                +
                +
                +
                Is Collapsed
                +
                -
                +
                +
                +
                Anchor/Focus Offset
                +
                -, -
                +
                +
                +
                + +
                +

                Programmatic Selection

                +

                Select text programmatically by character position:

                +
                + ABCDEFGHIJKLMNOPQRSTUVWXYZ abcdefghijklmnopqrstuvwxyz 0123456789 +
                +
                + + + + + + + +
                +
                + +
                +

                Word Selection

                +

                Click a word to select it in the text:

                +
                + JavaScript provides powerful APIs for working with text selections in the browser. + The Selection and Range objects give developers fine-grained control over selected content. +
                +
                +
                + +
                +

                Selection Manipulation

                +

                Select text below, then apply actions:

                +
                + This is an editable area where you can select text and apply transformations. + Try selecting some text and clicking the buttons below to see the Selection API in action. + You can also type and edit the content directly. +
                +
                + + + + + + +
                +
                + +
                +

                Find and Select

                +

                Find and select text matches:

                +
                + The quick brown fox jumps over the lazy dog. The fox was very quick indeed. + A quick movement of the enemy will jeopardize five gunboats. + The five boxing wizards jump quickly. +
                +
                + + + + +
                +
                +
                + +
                +

                Event Log

                + +
                Selection events will appear here...
                +
                +
                + + + + diff --git a/v3/examples/web-apis/selection/main.go b/v3/examples/web-apis/selection/main.go new file mode 100644 index 000000000..fe5caf580 --- /dev/null +++ b/v3/examples/web-apis/selection/main.go @@ -0,0 +1,26 @@ +package main + +import ( + "embed" + "github.com/wailsapp/wails/v3/pkg/application" +) + +//go:embed frontend/* +var assets embed.FS + +func main() { + app := application.New(application.Options{ + Name: "Selection API Demo", + Description: "Text selection handling", + Assets: application.AssetOptions{ + Handler: application.BundledAssetFileServer(assets), + }, + }) + app.Window.NewWithOptions(application.WebviewWindowOptions{ + Title: "Selection API Demo", + Width: 900, + Height: 700, + URL: "/", + }) + app.Run() +} diff --git a/v3/examples/web-apis/sessionstorage/frontend/index.html b/v3/examples/web-apis/sessionstorage/frontend/index.html new file mode 100644 index 000000000..90a917925 --- /dev/null +++ b/v3/examples/web-apis/sessionstorage/frontend/index.html @@ -0,0 +1,385 @@ + + + + + + Session Storage API Demo + + + +
                +

                Session Storage API Demo

                +

                + The Web Storage API provides sessionStorage for key-value storage that persists only + for the duration of the page session (until the tab or browser is closed). +

                + +
                + sessionStorage is available: checking... +
                + +
                +

                Store Data

                +
                + + +
                +
                + + +
                + + +
                + +
                +

                Stored Items (0)

                + + +
                  +
                  + +
                  +

                  Session vs Local Storage Comparison

                  +

                  Save the same key to both storages to compare behavior:

                  +
                  + + +
                  + + +
                  +
                  +

                  sessionStorage

                  +
                  -
                  +
                  +
                  +

                  localStorage

                  +
                  -
                  +
                  +
                  +

                  + Tip: Refresh the page or open a new tab to see the difference - sessionStorage is unique per tab! +

                  +
                  + +
                  +

                  Storage Info

                  +
                  +
                  + +
                  +

                  API Support

                  +
                  +
                  + +
                  +

                  Event Log

                  + +
                  Storage events will appear here... + +Note: Storage events fire when data is changed from ANOTHER tab/window of the same origin.
                  +
                  +
                  + + + + diff --git a/v3/examples/web-apis/sessionstorage/main.go b/v3/examples/web-apis/sessionstorage/main.go new file mode 100644 index 000000000..3beda3a5a --- /dev/null +++ b/v3/examples/web-apis/sessionstorage/main.go @@ -0,0 +1,26 @@ +package main + +import ( + "embed" + "github.com/wailsapp/wails/v3/pkg/application" +) + +//go:embed frontend/* +var assets embed.FS + +func main() { + app := application.New(application.Options{ + Name: "Session Storage Demo", + Description: "sessionStorage API demonstration", + Assets: application.AssetOptions{ + Handler: application.BundledAssetFileServer(assets), + }, + }) + app.Window.NewWithOptions(application.WebviewWindowOptions{ + Title: "Session Storage Demo", + Width: 900, + Height: 700, + URL: "/", + }) + app.Run() +} diff --git a/v3/examples/web-apis/share/frontend/index.html b/v3/examples/web-apis/share/frontend/index.html new file mode 100644 index 000000000..47f5a9f17 --- /dev/null +++ b/v3/examples/web-apis/share/frontend/index.html @@ -0,0 +1,503 @@ + + + + + + Web Share API Demo + + + +
                  +

                  Web Share API Demo

                  +

                  + The Web Share API allows web applications to invoke the native sharing capabilities + of the device, enabling users to share text, URLs, and files to other apps. +

                  + +
                  + Web Share API: checking... +
                  + +
                  +

                  Share Text and URL

                  +
                  +
                  + + +
                  +
                  + + + + + + + +
                  + + +
                  +
                  + +
                  +

                  Share Files

                  +
                  +

                  Drag and drop files here or click to select

                  + +
                  +
                    + + +

                    + Note: File sharing requires the canShare() API to verify file types are supported. +

                    +
                    + +
                    +

                    Quick Share Examples

                    +
                    + + + + +
                    +
                    + +
                    +

                    API Support

                    +
                    +
                    + +
                    +

                    Event Log

                    +
                    Share events will appear here...
                    +
                    +
                    + +
                    + + + + diff --git a/v3/examples/web-apis/share/main.go b/v3/examples/web-apis/share/main.go new file mode 100644 index 000000000..a253809d1 --- /dev/null +++ b/v3/examples/web-apis/share/main.go @@ -0,0 +1,26 @@ +package main + +import ( + "embed" + "github.com/wailsapp/wails/v3/pkg/application" +) + +//go:embed frontend/* +var assets embed.FS + +func main() { + app := application.New(application.Options{ + Name: "Web Share API Demo", + Description: "Native sharing", + Assets: application.AssetOptions{ + Handler: application.BundledAssetFileServer(assets), + }, + }) + app.Window.NewWithOptions(application.WebviewWindowOptions{ + Title: "Web Share API Demo", + Width: 900, + Height: 700, + URL: "/", + }) + app.Run() +} diff --git a/v3/examples/web-apis/speech-synthesis/frontend/index.html b/v3/examples/web-apis/speech-synthesis/frontend/index.html new file mode 100644 index 000000000..d71b67130 --- /dev/null +++ b/v3/examples/web-apis/speech-synthesis/frontend/index.html @@ -0,0 +1,656 @@ + + + + + + Speech Synthesis API Demo + + + +
                    +

                    Speech Synthesis API Demo

                    +

                    + The Speech Synthesis API (Web Speech API) enables text-to-speech functionality, + allowing web applications to read text aloud using different voices and settings. +

                    + +
                    + Speech Synthesis API: checking... +
                    + +
                    +

                    API Support

                    +
                    +
                    + +
                    +

                    Text to Speech

                    + + + + + +
                    +
                    +
                    + +
                    +
                    + + +
                    +
                    + + +
                    +
                    + + +
                    +
                    + + +
                    +
                    + + + + + +
                    + +
                    +

                    Quick Phrases

                    +

                    Click a phrase to speak it immediately:

                    +
                    + + + + + + + + +
                    +
                    + +
                    +

                    Available Voices (0)

                    +
                    + +
                    +
                    +

                    Loading voices...

                    +
                    +
                    + +
                    +

                    Speech Queue Demo

                    +

                    Queue multiple utterances to be spoken in sequence:

                    + + + +
                    + Queue length: 0 utterances +
                    +
                    + +
                    +

                    Event Log

                    + +
                    Events will be logged here...
                    +
                    +
                    + + + + diff --git a/v3/examples/web-apis/speech-synthesis/main.go b/v3/examples/web-apis/speech-synthesis/main.go new file mode 100644 index 000000000..e5e00fa2d --- /dev/null +++ b/v3/examples/web-apis/speech-synthesis/main.go @@ -0,0 +1,26 @@ +package main + +import ( + "embed" + "github.com/wailsapp/wails/v3/pkg/application" +) + +//go:embed frontend/* +var assets embed.FS + +func main() { + app := application.New(application.Options{ + Name: "Speech Synthesis Demo", + Description: "Text-to-speech API", + Assets: application.AssetOptions{ + Handler: application.BundledAssetFileServer(assets), + }, + }) + app.Window.NewWithOptions(application.WebviewWindowOptions{ + Title: "Speech Synthesis Demo", + Width: 900, + Height: 700, + URL: "/", + }) + app.Run() +} diff --git a/v3/examples/web-apis/streams/frontend/index.html b/v3/examples/web-apis/streams/frontend/index.html new file mode 100644 index 000000000..f0cfe26d1 --- /dev/null +++ b/v3/examples/web-apis/streams/frontend/index.html @@ -0,0 +1,580 @@ + + + + + + Streams API Demo + + + +
                    +

                    Streams API Demo

                    +

                    + The Streams API allows JavaScript to programmatically access streams of data, + enabling efficient processing of large data sets chunk by chunk without loading everything into memory. +

                    + +
                    + Streams API available: checking... +
                    + +
                    +

                    API Support

                    +
                    +
                    + +
                    +

                    ReadableStream Demo

                    +

                    + Create a custom ReadableStream that generates data chunks on demand. +

                    +
                    + + + + +
                    + + +
                    +
                    Click "Start ReadableStream" to begin...
                    +
                    + +
                    +

                    WritableStream Demo

                    +

                    + Create a WritableStream that processes and logs each written chunk. +

                    +
                    + + +
                    + +
                    Click "Write to Stream" to begin...
                    +
                    + +
                    +

                    TransformStream Demo

                    +

                    + Transform data as it flows through a stream pipeline. +

                    +
                    + + +
                    +
                    + + +
                    + +
                    Click "Transform" to see the result...
                    +
                    + +
                    +

                    Pipe Chain Demo

                    +

                    + Chain multiple transforms together using pipeThrough and pipeTo. +

                    +
                    + + +
                    + +

                    + Pipeline: Input -> Split into chars -> Uppercase -> Add index -> Collect +

                    +
                    Click "Run Pipe Chain" to see the result...
                    +
                    + +
                    +

                    Fetch with Streams

                    +

                    + Use streams to process fetch response body progressively. +

                    +
                    + + +
                    + + +
                    +
                    Click "Fetch with Stream" to begin...
                    +
                    + +
                    +

                    Event Log

                    + +
                    +
                    Ready to log stream events...
                    +
                    +
                    +
                    + + + + diff --git a/v3/examples/web-apis/streams/main.go b/v3/examples/web-apis/streams/main.go new file mode 100644 index 000000000..d1dc4048a --- /dev/null +++ b/v3/examples/web-apis/streams/main.go @@ -0,0 +1,26 @@ +package main + +import ( + "embed" + "github.com/wailsapp/wails/v3/pkg/application" +) + +//go:embed frontend/* +var assets embed.FS + +func main() { + app := application.New(application.Options{ + Name: "Streams API Demo", + Description: "Readable and writable streams", + Assets: application.AssetOptions{ + Handler: application.BundledAssetFileServer(assets), + }, + }) + app.Window.NewWithOptions(application.WebviewWindowOptions{ + Title: "Streams API Demo", + Width: 900, + Height: 700, + URL: "/", + }) + app.Run() +} diff --git a/v3/examples/web-apis/vibration/frontend/index.html b/v3/examples/web-apis/vibration/frontend/index.html new file mode 100644 index 000000000..0aa429b17 --- /dev/null +++ b/v3/examples/web-apis/vibration/frontend/index.html @@ -0,0 +1,581 @@ + + + + + + Vibration API Demo + + + +
                    +

                    Vibration API Demo

                    +

                    + The Vibration API provides access to the device's vibration hardware. + It allows triggering single vibrations or complex patterns of vibrations and pauses. +

                    + +
                    + Vibration API: checking... +
                    + +
                    +

                    Quick Vibrations

                    + + + + + +
                    + +
                    +

                    Vibration Presets

                    +
                    +
                    +
                    *
                    +
                    Notification
                    +
                    [100, 50, 100]
                    +
                    +
                    +
                    +
                    +
                    Success
                    +
                    [50, 50, 50, 50, 200]
                    +
                    +
                    +
                    !
                    +
                    Error
                    +
                    [200, 100, 200, 100, 200]
                    +
                    +
                    +
                    ?
                    +
                    Warning
                    +
                    [100, 100, 100]
                    +
                    +
                    +
                    <3
                    +
                    Heartbeat
                    +
                    [100, 100, 100, 400]
                    +
                    +
                    +
                    SOS
                    +
                    SOS
                    +
                    [100,50,100,50,100,200,...]
                    +
                    +
                    +
                    ~
                    +
                    Ringtone
                    +
                    [300, 200, 300, 200, ...]
                    +
                    +
                    +
                    3-2-1
                    +
                    Countdown
                    +
                    [100, 900, 100, 900, ...]
                    +
                    +
                    +
                    + +
                    +

                    Pattern Builder

                    +
                    +
                    + Click buttons below to build a pattern... +
                    + +
                    +
                    + + + ms +
                    + + + +
                    + +
                    + + + +
                    + +
                    +
                    +
                    +
                    +
                    + +
                    +

                    Haptic Pad

                    +

                    + Tap the buttons for different haptic feedback +

                    +
                    + + + + + + + + + +
                    +
                    + +
                    +

                    Event Log

                    +
                    +
                    Waiting for vibration events...
                    +
                    +
                    +
                    + + + + diff --git a/v3/examples/web-apis/vibration/main.go b/v3/examples/web-apis/vibration/main.go new file mode 100644 index 000000000..4ec2d52c1 --- /dev/null +++ b/v3/examples/web-apis/vibration/main.go @@ -0,0 +1,26 @@ +package main + +import ( + "embed" + "github.com/wailsapp/wails/v3/pkg/application" +) + +//go:embed frontend/* +var assets embed.FS + +func main() { + app := application.New(application.Options{ + Name: "Vibration API Demo", + Description: "Device vibration patterns", + Assets: application.AssetOptions{ + Handler: application.BundledAssetFileServer(assets), + }, + }) + app.Window.NewWithOptions(application.WebviewWindowOptions{ + Title: "Vibration API Demo", + Width: 900, + Height: 700, + URL: "/", + }) + app.Run() +} diff --git a/v3/examples/web-apis/web-components/frontend/index.html b/v3/examples/web-apis/web-components/frontend/index.html new file mode 100644 index 000000000..94d97b53a --- /dev/null +++ b/v3/examples/web-apis/web-components/frontend/index.html @@ -0,0 +1,518 @@ + + + + + + Web Components API Demo + + + +
                    +

                    Web Components API Demo

                    +

                    + Web Components is a suite of APIs allowing you to create reusable custom elements with encapsulated + functionality using Custom Elements, Shadow DOM, and HTML Templates. +

                    + +
                    + Web Components API: checking... +
                    + +
                    +

                    API Support

                    +
                    +
                    + +
                    +

                    Custom Element Demo: <wails-card>

                    +

                    A custom card element with Shadow DOM encapsulation:

                    +
                    + + This is content inside a custom Web Component. The styling is encapsulated via Shadow DOM. + +
                    +
                    + + Different theme variant using the same component. + +
                    +
                    + + + +
                    +
                    +
                    + +
                    +

                    Custom Element Demo: <wails-counter>

                    +

                    A stateful counter component with reactive attributes:

                    +
                    + +
                    +
                    + +
                    +
                    + +
                    +

                    HTML Template Demo

                    +

                    Using <template> for efficient cloning:

                    + + + + +
                    +
                    + +
                    +

                    Slot Demo: <wails-panel>

                    +

                    Named slots for flexible content composition:

                    +
                    + + Panel Header +

                    This is the default slot content - the main body of the panel.

                    + Panel Footer - Created with Web Components +
                    +
                    +
                    + +
                    +

                    Event Log

                    + +
                    Component events will appear here...
                    +
                    +
                    + + + + diff --git a/v3/examples/web-apis/web-components/main.go b/v3/examples/web-apis/web-components/main.go new file mode 100644 index 000000000..2aea17c41 --- /dev/null +++ b/v3/examples/web-apis/web-components/main.go @@ -0,0 +1,26 @@ +package main + +import ( + "embed" + "github.com/wailsapp/wails/v3/pkg/application" +) + +//go:embed frontend/* +var assets embed.FS + +func main() { + app := application.New(application.Options{ + Name: "Web Components Demo", + Description: "Custom elements and Shadow DOM", + Assets: application.AssetOptions{ + Handler: application.BundledAssetFileServer(assets), + }, + }) + app.Window.NewWithOptions(application.WebviewWindowOptions{ + Title: "Web Components Demo", + Width: 900, + Height: 700, + URL: "/", + }) + app.Run() +} diff --git a/v3/examples/web-apis/webaudio/frontend/index.html b/v3/examples/web-apis/webaudio/frontend/index.html new file mode 100644 index 000000000..344398d89 --- /dev/null +++ b/v3/examples/web-apis/webaudio/frontend/index.html @@ -0,0 +1,402 @@ + + + + + + Web Audio API Demo + + + +
                    +

                    Web Audio API Demo

                    +

                    + The Web Audio API provides a powerful system for controlling audio, + allowing developers to generate, process, and analyze audio in real time. +

                    + +
                    + Web Audio API supported: checking... +
                    + +
                    +

                    Oscillator Synthesizer

                    +
                    +
                    + + +
                    +
                    + + +
                    +
                    + + +
                    +
                    + + +
                    + +
                    +

                    Piano Keyboard

                    +

                    Click keys or use keyboard: A S D F G H J K

                    +
                    +
                    C
                    +
                    C#
                    +
                    D
                    +
                    D#
                    +
                    E
                    +
                    F
                    +
                    F#
                    +
                    G
                    +
                    G#
                    +
                    A
                    +
                    A#
                    +
                    B
                    +
                    C
                    +
                    +
                    + +
                    +

                    Audio Visualizer

                    + + + +
                    + +
                    +

                    Sound Effects

                    + + + + +
                    +
                    + + + + diff --git a/v3/examples/web-apis/webaudio/main.go b/v3/examples/web-apis/webaudio/main.go new file mode 100644 index 000000000..6c672060c --- /dev/null +++ b/v3/examples/web-apis/webaudio/main.go @@ -0,0 +1,29 @@ +package main + +import ( + "embed" + + "github.com/wailsapp/wails/v3/pkg/application" +) + +//go:embed frontend/* +var assets embed.FS + +func main() { + app := application.New(application.Options{ + Name: "Web Audio Demo", + Description: "Demonstrates the Web Audio API for audio processing", + Assets: application.AssetOptions{ + Handler: application.BundledAssetFileServer(assets), + }, + }) + + app.Window.NewWithOptions(application.WebviewWindowOptions{ + Title: "Web Audio Demo", + Width: 800, + Height: 600, + URL: "/", + }) + + app.Run() +} diff --git a/v3/examples/web-apis/webcrypto/frontend/index.html b/v3/examples/web-apis/webcrypto/frontend/index.html new file mode 100644 index 000000000..bfd68155b --- /dev/null +++ b/v3/examples/web-apis/webcrypto/frontend/index.html @@ -0,0 +1,354 @@ + + + + + + Web Crypto API Demo + + + +
                    +

                    Web Crypto API Demo

                    +

                    + The Web Cryptography API provides cryptographic operations including hashing, + signature generation, encryption/decryption, and key management. +

                    + +
                    + Web Crypto API: checking... +
                    + +
                    +

                    Random Values

                    + + + + +
                    Click a button to generate random values...
                    +
                    + +
                    +

                    Hash Functions

                    + + +
                    +
                    + + +
                    +
                    + +
                    Hash will appear here...
                    +
                    + +
                    +

                    Symmetric Encryption (AES-GCM)

                    + + + + + + +
                    Encrypted/decrypted data will appear here...
                    +
                    + +
                    +

                    Digital Signatures (ECDSA)

                    + + + + + +
                    Generate a key pair first...
                    +
                    + +
                    +

                    HMAC

                    + + + + + +
                    HMAC will appear here...
                    +
                    +
                    + + + + diff --git a/v3/examples/web-apis/webcrypto/main.go b/v3/examples/web-apis/webcrypto/main.go new file mode 100644 index 000000000..116259b72 --- /dev/null +++ b/v3/examples/web-apis/webcrypto/main.go @@ -0,0 +1,29 @@ +package main + +import ( + "embed" + + "github.com/wailsapp/wails/v3/pkg/application" +) + +//go:embed frontend/* +var assets embed.FS + +func main() { + app := application.New(application.Options{ + Name: "Web Crypto Demo", + Description: "Demonstrates the Web Cryptography API", + Assets: application.AssetOptions{ + Handler: application.BundledAssetFileServer(assets), + }, + }) + + app.Window.NewWithOptions(application.WebviewWindowOptions{ + Title: "Web Crypto Demo", + Width: 800, + Height: 600, + URL: "/", + }) + + app.Run() +} diff --git a/v3/examples/web-apis/webgl/frontend/index.html b/v3/examples/web-apis/webgl/frontend/index.html new file mode 100644 index 000000000..43e64516c --- /dev/null +++ b/v3/examples/web-apis/webgl/frontend/index.html @@ -0,0 +1,386 @@ + + + + + + WebGL API Demo + + + +
                    +

                    WebGL API Demo

                    +

                    + WebGL enables rendering interactive 2D and 3D graphics in the browser + using the GPU for hardware-accelerated rendering. +

                    + +
                    + WebGL: checking... +
                    + +
                    +

                    3D Rotating Cube

                    +
                    +
                    + + +
                    +
                    + + +
                    +
                    + + +
                    +
                    +
                    + + +
                    + +
                    + +
                    +

                    WebGL Info

                    +
                    +
                    +
                    + + + + diff --git a/v3/examples/web-apis/webgl/main.go b/v3/examples/web-apis/webgl/main.go new file mode 100644 index 000000000..65ce347c5 --- /dev/null +++ b/v3/examples/web-apis/webgl/main.go @@ -0,0 +1,29 @@ +package main + +import ( + "embed" + + "github.com/wailsapp/wails/v3/pkg/application" +) + +//go:embed frontend/* +var assets embed.FS + +func main() { + app := application.New(application.Options{ + Name: "WebGL Demo", + Description: "Demonstrates the WebGL API for 3D graphics", + Assets: application.AssetOptions{ + Handler: application.BundledAssetFileServer(assets), + }, + }) + + app.Window.NewWithOptions(application.WebviewWindowOptions{ + Title: "WebGL Demo", + Width: 800, + Height: 600, + URL: "/", + }) + + app.Run() +} diff --git a/v3/examples/web-apis/websocket/frontend/index.html b/v3/examples/web-apis/websocket/frontend/index.html new file mode 100644 index 000000000..02f14c3a9 --- /dev/null +++ b/v3/examples/web-apis/websocket/frontend/index.html @@ -0,0 +1,302 @@ + + + + + + WebSocket API Demo + + + +
                    +

                    WebSocket API Demo

                    +

                    + WebSocket provides full-duplex communication channels over a single TCP connection, + enabling real-time data exchange between client and server. +

                    + +
                    +
                    + WebSocket: Disconnected +
                    + +
                    +

                    Connection

                    +
                    +
                    + + +
                    +
                    + + +

                    + Try: wss://echo.websocket.org (echo server) or wss://ws.postman-echo.com/raw +

                    +
                    + +
                    +

                    Send Message

                    +
                    +
                    + + +
                    + +
                    +
                    + +
                    +

                    Messages

                    + +
                    +
                    + Connect to a WebSocket server to start... +
                    +
                    +
                    + +
                    +

                    WebSocket API Reference

                    +
                    +// Create connection +const ws = new WebSocket('wss://example.com/socket'); + +// Connection opened +ws.onopen = (event) => { + console.log('Connected'); + ws.send('Hello Server!'); +}; + +// Listen for messages +ws.onmessage = (event) => { + console.log('Received:', event.data); +}; + +// Connection closed +ws.onclose = (event) => { + console.log('Disconnected', event.code, event.reason); +}; + +// Error handling +ws.onerror = (error) => { + console.error('WebSocket error:', error); +}; + +// Send data +ws.send('text message'); +ws.send(new Blob(['binary data'])); +ws.send(new ArrayBuffer(8)); + +// Close connection +ws.close(1000, 'Normal closure'); + +// Properties +ws.readyState // 0=CONNECTING, 1=OPEN, 2=CLOSING, 3=CLOSED +ws.bufferedAmount // Bytes queued for transmission +ws.protocol // Selected sub-protocol +ws.url // WebSocket URL
                    +
                    +
                    + + + + diff --git a/v3/examples/web-apis/websocket/main.go b/v3/examples/web-apis/websocket/main.go new file mode 100644 index 000000000..806d7e8da --- /dev/null +++ b/v3/examples/web-apis/websocket/main.go @@ -0,0 +1,29 @@ +package main + +import ( + "embed" + + "github.com/wailsapp/wails/v3/pkg/application" +) + +//go:embed frontend/* +var assets embed.FS + +func main() { + app := application.New(application.Options{ + Name: "WebSocket Demo", + Description: "Demonstrates the WebSocket API for real-time communication", + Assets: application.AssetOptions{ + Handler: application.BundledAssetFileServer(assets), + }, + }) + + app.Window.NewWithOptions(application.WebviewWindowOptions{ + Title: "WebSocket Demo", + Width: 800, + Height: 600, + URL: "/", + }) + + app.Run() +} diff --git a/v3/examples/web-apis/webworkers/frontend/index.html b/v3/examples/web-apis/webworkers/frontend/index.html new file mode 100644 index 000000000..546d5d400 --- /dev/null +++ b/v3/examples/web-apis/webworkers/frontend/index.html @@ -0,0 +1,373 @@ + + + + + + Web Workers API Demo + + + +
                    +

                    Web Workers API Demo

                    +

                    + Web Workers allow JavaScript to run in background threads, + enabling CPU-intensive tasks without blocking the UI. +

                    + +
                    + Web Workers: checking... +
                    + +
                    +

                    Prime Number Calculator

                    +

                    + Calculate prime numbers up to a given limit. Try with/without a worker to see the difference. +

                    + + +
                    +
                    + This animation should stay smooth when using a worker +
                    + + + +
                    +
                    +
                    +
                    Results will appear here...
                    +
                    + +
                    +

                    Fibonacci Calculator

                    +

                    + Calculate Fibonacci numbers using a dedicated worker. +

                    + + + +
                    Result will appear here...
                    +
                    + +
                    +

                    Message Passing

                    +

                    + Send custom messages to a worker and receive responses. +

                    + + + +
                    Messages will appear here...
                    +
                    + +
                    +

                    API Support

                    +
                    +
                    +
                    + + + + diff --git a/v3/examples/web-apis/webworkers/main.go b/v3/examples/web-apis/webworkers/main.go new file mode 100644 index 000000000..2fbd516bd --- /dev/null +++ b/v3/examples/web-apis/webworkers/main.go @@ -0,0 +1,29 @@ +package main + +import ( + "embed" + + "github.com/wailsapp/wails/v3/pkg/application" +) + +//go:embed frontend/* +var assets embed.FS + +func main() { + app := application.New(application.Options{ + Name: "Web Workers Demo", + Description: "Demonstrates Web Workers for background processing", + Assets: application.AssetOptions{ + Handler: application.BundledAssetFileServer(assets), + }, + }) + + app.Window.NewWithOptions(application.WebviewWindowOptions{ + Title: "Web Workers Demo", + Width: 800, + Height: 600, + URL: "/", + }) + + app.Run() +} diff --git a/v3/examples/web-apis/xmlhttprequest/frontend/index.html b/v3/examples/web-apis/xmlhttprequest/frontend/index.html new file mode 100644 index 000000000..9d75d15b9 --- /dev/null +++ b/v3/examples/web-apis/xmlhttprequest/frontend/index.html @@ -0,0 +1,496 @@ + + + + + + XMLHttpRequest API Demo + + + +
                    +

                    XMLHttpRequest API Demo

                    +

                    + XMLHttpRequest (XHR) is the classic API for making HTTP requests in JavaScript. + It provides detailed control over request/response handling with event-based progress tracking. +

                    + +
                    + XMLHttpRequest API available: checking... +
                    + +
                    +

                    Make Request

                    +
                    +
                    + + +
                    +
                    + + +
                    +
                    +
                    + + +
                    +
                    + + +
                    +
                    + +
                    + + + + + + +
                    + +
                    +

                    Response

                    + + +
                    + + +
                    +
                    Make a request to see the response...
                    + +
                    + +
                    +

                    Event Log

                    + +
                    +
                    + --:--:-- + INFO + Ready to make requests... +
                    +
                    +
                    + +
                    +

                    XMLHttpRequest API Reference

                    +
                    +// Create request +const xhr = new XMLHttpRequest(); + +// Configure request +xhr.open('GET', 'https://api.example.com/data', true); // async=true + +// Set headers +xhr.setRequestHeader('Content-Type', 'application/json'); +xhr.setRequestHeader('X-Custom-Header', 'value'); + +// Event handlers +xhr.onreadystatechange = () => { + // 0=UNSENT, 1=OPENED, 2=HEADERS_RECEIVED, 3=LOADING, 4=DONE + console.log('Ready state:', xhr.readyState); +}; + +xhr.onload = () => console.log('Load complete'); +xhr.onerror = () => console.log('Network error'); +xhr.onprogress = (e) => console.log(`Progress: ${e.loaded}/${e.total}`); +xhr.onabort = () => console.log('Request aborted'); +xhr.ontimeout = () => console.log('Request timed out'); + +// Response properties +xhr.status // HTTP status code (200, 404, etc.) +xhr.statusText // Status text ("OK", "Not Found", etc.) +xhr.responseText // Response as text +xhr.responseXML // Response as XML document +xhr.response // Response based on responseType +xhr.responseType // '', 'arraybuffer', 'blob', 'document', 'json', 'text' + +// Send request +xhr.send(); // GET/DELETE +xhr.send('data'); // POST/PUT with string +xhr.send(new FormData(formElement)); // POST with form data +xhr.send(JSON.stringify({key: 'value'})); // POST with JSON + +// Abort request +xhr.abort();
                    +
                    +
                    + + + + diff --git a/v3/examples/web-apis/xmlhttprequest/main.go b/v3/examples/web-apis/xmlhttprequest/main.go new file mode 100644 index 000000000..38d530e25 --- /dev/null +++ b/v3/examples/web-apis/xmlhttprequest/main.go @@ -0,0 +1,26 @@ +package main + +import ( + "embed" + "github.com/wailsapp/wails/v3/pkg/application" +) + +//go:embed frontend/* +var assets embed.FS + +func main() { + app := application.New(application.Options{ + Name: "XMLHttpRequest Demo", + Description: "Classic XHR API demonstration", + Assets: application.AssetOptions{ + Handler: application.BundledAssetFileServer(assets), + }, + }) + app.Window.NewWithOptions(application.WebviewWindowOptions{ + Title: "XMLHttpRequest Demo", + Width: 900, + Height: 700, + URL: "/", + }) + app.Run() +} diff --git a/v3/examples/websocket-transport/GreetService.go b/v3/examples/websocket-transport/GreetService.go new file mode 100644 index 000000000..bdb21a277 --- /dev/null +++ b/v3/examples/websocket-transport/GreetService.go @@ -0,0 +1,73 @@ +package main + +import ( + "context" + "fmt" + "sync" + "time" + + "github.com/wailsapp/wails/v3/pkg/application" +) + +// GreetService is a service that demonstrates bound methods over WebSocket transport +type GreetService struct { + mu sync.Mutex + greetCount int + app *application.App +} + +// ServiceStartup is called when the service is initialized +func (g *GreetService) ServiceStartup(ctx context.Context, options application.ServiceOptions) error { + g.app = application.Get() + + // Start a timer that emits events every second + // This demonstrates automatic event forwarding to WebSocket transport + go func() { + ticker := time.NewTicker(1 * time.Second) + defer ticker.Stop() + + for { + select { + case <-ctx.Done(): + return + case t := <-ticker.C: + // Emit a timer event - automatically forwarded to WebSocket! + g.app.Event.Emit("timer:tick", t.Format("15:04:05")) + } + } + }() + + return nil +} + +// Greet greets a person by name and emits an event +func (g *GreetService) Greet(name string) string { + g.mu.Lock() + g.greetCount++ + count := g.greetCount + g.mu.Unlock() + result := fmt.Sprintf("Hello, %s! (Greeted %d times via WebSocket)", name, count) + + // Emit an event to demonstrate event support over WebSocket + // Events are automatically forwarded to the WebSocket transport! + if g.app != nil { + g.app.Event.Emit("greet:count", count) + } + + return result +} + +// GetTime returns the current server time +func (g *GreetService) GetTime() string { + return time.Now().Format("2006-01-02 15:04:05") +} + +// Echo echoes back the input message +func (g *GreetService) Echo(message string) string { + return "Echo: " + message +} + +// Add adds two numbers together +func (g *GreetService) Add(a, b int) int { + return a + b +} diff --git a/v3/examples/websocket-transport/README.md b/v3/examples/websocket-transport/README.md new file mode 100644 index 000000000..d66170eb1 --- /dev/null +++ b/v3/examples/websocket-transport/README.md @@ -0,0 +1,113 @@ +# WebSocket Transport Example + +This example demonstrates how to use a custom transport like WebSocket for Wails IPC instead of the default HTTP fetch transport. All Wails bindings and features work identically - only the underlying transport layer changes. + +## What This Example Shows + +- How to configure a WebSocket transport on the backend using `NewWebSocketTransport()` +- How to override the runtime transport on the frontend using `setTransport()` and `createWebSocketTransport()` +- Full compatibility with generated bindings - no code generation changes needed +- Real-time connection status monitoring +- Automatic reconnection handling + +## Architecture + +```text +┌─────────────────────────────────────────┐ +│ Frontend (JavaScript) │ +│ - setTransport(wsTransport) │ +│ - All bindings work unchanged │ +└───────────────┬─────────────────────────┘ + │ + │ WebSocket (ws://localhost:9099) + │ +┌───────────────▼─────────────────────────┐ +│ Backend (Go) │ +│ - WebSocketTransport on port 9099 │ +│ - Standard MessageProcessor │ +│ - All Wails features available │ +└─────────────────────────────────────────┘ +``` + +## How to Run + +1. Navigate to this directory: + ```bash + cd v3/examples/websocket-transport + ``` + +2. Run the example: + ```bash + go run . + ``` + +3. The application will start with: + - WebView window displaying the UI + - WebSocket server listening on `ws://localhost:9099/wails/ws` + - Real-time connection status indicator + +## Backend Setup + +The backend configuration is simple - just pass a `WebSocketTransport` to the application options: + +```go +// Create WebSocket transport on port 9099 +wsTransport := NewWebSocketTransport(":9099") + +app := application.New(application.Options{ + Name: "WebSocket Transport Example", + Services: []application.Service{ + application.NewService(&GreetService{}), + }, + Assets: application.AssetOptions{ + Handler: application.BundledAssetFileServer(assets), + }, + // Use WebSocket transport instead of default HTTP + Transport: wsTransport, +}) +``` + +## Frontend Setup + +The frontend uses the WebSocket transport with **generated bindings**: + +```typescript +import { setTransport } from "/wails/runtime.js"; +import { createWebSocketTransport } from "/websocket-transport.js"; +import { GreetService } from "/bindings/github.com/wailsapp/wails/v3/examples/websocket-transport/index.js"; + +// Create and configure WebSocket transport +const wsTransport = createWebSocketTransport('ws://localhost:9099/wails/ws', { + reconnectDelay: 2000, // Reconnect after 2 seconds if disconnected + requestTimeout: 30000 // Request timeout of 30 seconds +}); + +// Set as the active transport +setTransport(wsTransport); + +// Now all generated bindings use WebSocket instead of HTTP fetch! +const result = await GreetService.Greet("World"); +``` + +**Key Point**: The generated bindings (`GreetService.Greet()`, `GreetService.Echo()`, etc.) automatically use whatever transport is configured via `setTransport()`. This proves the custom transport hijack works seamlessly with Wails code generation! + +## Features Demonstrated + +### 1. Generated Bindings with Custom Transport +All generated bindings work identically with WebSocket transport: +- `GreetService.Greet(name)` - Simple string parameter and return +- `GreetService.Echo(message)` - Echo back messages +- `GreetService.Add(a, b)` - Multiple parameters with numeric types +- `GreetService.GetTime()` - No parameters, string return + +### 2. Connection Management +- Automatic connection establishment on startup +- Visual connection status indicator (green = connected, red = disconnected) +- Automatic reconnection with configurable delay +- Graceful handling of connection failures + +### 3. Error Handling +- Request timeouts +- Connection errors +- Backend method errors +- All propagate correctly to the frontend diff --git a/v3/examples/websocket-transport/assets/bindings/github.com/wailsapp/wails/v3/examples/websocket-transport/greetservice.js b/v3/examples/websocket-transport/assets/bindings/github.com/wailsapp/wails/v3/examples/websocket-transport/greetservice.js new file mode 100644 index 000000000..ffdc9c702 --- /dev/null +++ b/v3/examples/websocket-transport/assets/bindings/github.com/wailsapp/wails/v3/examples/websocket-transport/greetservice.js @@ -0,0 +1,48 @@ +// @ts-check +// Cynhyrchwyd y ffeil hon yn awtomatig. PEIDIWCH Â MODIWL +// This file is automatically generated. DO NOT EDIT + +/** + * GreetService is a service that demonstrates bound methods over WebSocket transport + * @module + */ + +// eslint-disable-next-line @typescript-eslint/ban-ts-comment +// @ts-ignore: Unused imports +import { Call as $Call, CancellablePromise as $CancellablePromise, Create as $Create } from "/wails/runtime.js"; + +/** + * Add adds two numbers together + * @param {number} a + * @param {number} b + * @returns {$CancellablePromise} + */ +export function Add(a, b) { + return $Call.ByID(1578108007, a, b); +} + +/** + * Echo echoes back the input message + * @param {string} message + * @returns {$CancellablePromise} + */ +export function Echo(message) { + return $Call.ByID(1259920061, message); +} + +/** + * GetTime returns the current server time + * @returns {$CancellablePromise} + */ +export function GetTime() { + return $Call.ByID(570467169); +} + +/** + * Greet greets a person by name + * @param {string} name + * @returns {$CancellablePromise} + */ +export function Greet(name) { + return $Call.ByID(1411160069, name); +} diff --git a/v3/examples/websocket-transport/assets/bindings/github.com/wailsapp/wails/v3/examples/websocket-transport/index.js b/v3/examples/websocket-transport/assets/bindings/github.com/wailsapp/wails/v3/examples/websocket-transport/index.js new file mode 100644 index 000000000..fdf1ff435 --- /dev/null +++ b/v3/examples/websocket-transport/assets/bindings/github.com/wailsapp/wails/v3/examples/websocket-transport/index.js @@ -0,0 +1,8 @@ +// @ts-check +// Cynhyrchwyd y ffeil hon yn awtomatig. PEIDIWCH Â MODIWL +// This file is automatically generated. DO NOT EDIT + +import * as GreetService from "./greetservice.js"; +export { + GreetService +}; diff --git a/v3/examples/websocket-transport/assets/index.html b/v3/examples/websocket-transport/assets/index.html new file mode 100644 index 000000000..5672616f7 --- /dev/null +++ b/v3/examples/websocket-transport/assets/index.html @@ -0,0 +1,353 @@ + + + + + + WebSocket Transport Example + + + +
                    +

                    🚀 WebSocket Transport Example

                    +

                    Custom IPC transport using WebSockets instead of HTTP fetch

                    + +
                    +

                    Connection Status

                    +
                    + Disconnected +
                    +
                    + ℹ️ Transport Info: + This example uses a custom WebSocket transport running on ws://localhost:9099/wails/ws + instead of the default HTTP fetch-based transport. All Wails generated bindings work identically! +

                    + The methods below use GreetService.Greet(), GreetService.Echo(), etc. from the generated bindings, + proving that custom transports work seamlessly with Wails code generation. +
                    +
                    + +
                    +

                    🕐 Server Timer (Auto-updating via Events)

                    +
                    + Waiting for timer... +
                    +
                    + ✨ Automatic Event Forwarding: + The server emits a timer:tick event every second. Because the WebSocket transport + implements EventTransport, these events are automatically forwarded to + the frontend with zero manual wiring code! +
                    +
                    + +
                    +

                    Test Dialog

                    +
                    + +
                    +
                    Click "Open" to test the binding...
                    +
                    + +
                    +

                    Test Greet Method (with Events)

                    +
                    + + +
                    +
                    Click "Greet" to test the binding...
                    +
                    + 📡 Event Counter: + 0 (Updates via WebSocket events) +
                    +
                    + +
                    +

                    Test Echo Method

                    +
                    + + +
                    +
                    Click "Echo" to test...
                    +
                    + +
                    +

                    Test Add Method

                    +
                    + + + +
                    +
                    Click "Add" to calculate...
                    +
                    + +
                    +

                    Test GetTime Method

                    + +
                    Click to get current server time...
                    +
                    +
                    + + + + diff --git a/v3/examples/websocket-transport/frontend/bindings/github.com/wailsapp/wails/v3/examples/websocket-transport/greetservice.js b/v3/examples/websocket-transport/frontend/bindings/github.com/wailsapp/wails/v3/examples/websocket-transport/greetservice.js new file mode 100644 index 000000000..2e837223c --- /dev/null +++ b/v3/examples/websocket-transport/frontend/bindings/github.com/wailsapp/wails/v3/examples/websocket-transport/greetservice.js @@ -0,0 +1,48 @@ +// @ts-check +// Cynhyrchwyd y ffeil hon yn awtomatig. PEIDIWCH Â MODIWL +// This file is automatically generated. DO NOT EDIT + +/** + * GreetService is a service that demonstrates bound methods over WebSocket transport + * @module + */ + +// eslint-disable-next-line @typescript-eslint/ban-ts-comment +// @ts-ignore: Unused imports +import { Call as $Call, CancellablePromise as $CancellablePromise } from "/wails/runtime.js"; + +/** + * Add adds two numbers together + * @param {number} a + * @param {number} b + * @returns {$CancellablePromise} + */ +export function Add(a, b) { + return $Call.ByID(1578108007, a, b); +} + +/** + * Echo echoes back the input message + * @param {string} message + * @returns {$CancellablePromise} + */ +export function Echo(message) { + return $Call.ByID(1259920061, message); +} + +/** + * GetTime returns the current server time + * @returns {$CancellablePromise} + */ +export function GetTime() { + return $Call.ByID(570467169); +} + +/** + * Greet greets a person by name + * @param {string} name + * @returns {$CancellablePromise} + */ +export function Greet(name) { + return $Call.ByID(1411160069, name); +} diff --git a/v3/examples/websocket-transport/frontend/bindings/github.com/wailsapp/wails/v3/examples/websocket-transport/index.js b/v3/examples/websocket-transport/frontend/bindings/github.com/wailsapp/wails/v3/examples/websocket-transport/index.js new file mode 100644 index 000000000..fdf1ff435 --- /dev/null +++ b/v3/examples/websocket-transport/frontend/bindings/github.com/wailsapp/wails/v3/examples/websocket-transport/index.js @@ -0,0 +1,8 @@ +// @ts-check +// Cynhyrchwyd y ffeil hon yn awtomatig. PEIDIWCH Â MODIWL +// This file is automatically generated. DO NOT EDIT + +import * as GreetService from "./greetservice.js"; +export { + GreetService +}; diff --git a/v3/examples/websocket-transport/main.go b/v3/examples/websocket-transport/main.go new file mode 100644 index 000000000..3105d2231 --- /dev/null +++ b/v3/examples/websocket-transport/main.go @@ -0,0 +1,56 @@ +package main + +import ( + "embed" + "log" + + "github.com/wailsapp/wails/v3/pkg/application" +) + +//go:embed assets/* +var assets embed.FS + +func main() { + // Create WebSocket transport on port 9099 + wsTransport := NewWebSocketTransport(":9099") + + app := application.New(application.Options{ + Name: "WebSocket Transport Example", + Description: "Example demonstrating custom WebSocket-based IPC transport with event support", + Services: []application.Service{ + application.NewService(&GreetService{}), + }, + Assets: application.AssetOptions{ + Handler: application.BundledAssetFileServer(assets), + }, + Mac: application.MacOptions{ + ApplicationShouldTerminateAfterLastWindowClosed: true, + }, + // Use WebSocket transport instead of default HTTP + // Events are automatically forwarded to the transport since it implements EventTransport + Transport: wsTransport, + }) + + // ✨ NO MANUAL EVENT WIRING NEEDED! ✨ + // Events are automatically forwarded to the WebSocket transport because it implements + // the EventTransport interface. The following code is no longer necessary: + // + // app.Events.On("greet:count", func(event *application.WailsEvent) { + // wsTransport.SendEvent(event) + // }) + // + // All events emitted via app.Events.Emit() are automatically broadcast to connected clients! + + app.Window.NewWithOptions(application.WebviewWindowOptions{ + Title: "WebSocket Transport Example", + URL: "/", + Width: 800, + Height: 600, + DevToolsEnabled: true, + }) + + err := app.Run() + if err != nil { + log.Fatal(err) + } +} diff --git a/v3/examples/websocket-transport/transport_websocket.go b/v3/examples/websocket-transport/transport_websocket.go new file mode 100644 index 000000000..482e7319c --- /dev/null +++ b/v3/examples/websocket-transport/transport_websocket.go @@ -0,0 +1,261 @@ +package main + +import ( + "context" + _ "embed" + "log" + "net/http" + "sync" + + "github.com/gorilla/websocket" + "github.com/wailsapp/wails/v3/pkg/application" +) + +//go:embed websocket-transport.js +var jsClient []byte + +// WebSocketTransport is an example implementation of a WebSocket-based transport. +// This demonstrates how to create a custom transport that can replace the default +// HTTP fetch-based IPC while retaining all Wails bindings and event communication. +// +// This implementation is provided as an example and is not production-ready. +// You may need to add error handling, reconnection logic, authentication, etc. +type WebSocketTransport struct { + addr string + server *http.Server + upgrader websocket.Upgrader + clients map[*websocket.Conn]chan *WebSocketMessage + mu sync.RWMutex + handler *application.MessageProcessor +} + +// WebSocketTransportOption is a functional option for configuring WebSocketTransport +type WebSocketTransportOption func(*WebSocketTransport) + +// wsResponse represents the response to a runtime call. +type wsResponse struct { + // StatusCode is the HTTP status code equivalent (200 for success, 422 for error, etc.) + StatusCode int `json:"statusCode"` + + // Data contains the response body (can be struct, string) + Data any `json:"data"` +} + +// WebSocketMessage represents a message sent over the WebSocket transport +type WebSocketMessage struct { + ID string `json:"id"` // Unique message ID for request/response matching + Type string `json:"type"` // "request" or "response" + Request *application.RuntimeRequest `json:"request,omitempty"` + Response *wsResponse `json:"response,omitempty"` + Event *application.CustomEvent `json:"event,omitempty"` +} + +// NewWebSocketTransport creates a new WebSocket transport listening on the specified address. +// Example: NewWebSocketTransport(":9099") +func NewWebSocketTransport(addr string, opts ...WebSocketTransportOption) *WebSocketTransport { + t := &WebSocketTransport{ + addr: addr, + upgrader: websocket.Upgrader{ + CheckOrigin: func(r *http.Request) bool { + // In production, you should validate the origin + return true + }, + }, + clients: make(map[*websocket.Conn]chan *WebSocketMessage), + } + + // Apply options + for _, opt := range opts { + opt(t) + } + + return t +} + +// Start initializes and starts the WebSocket server +func (w *WebSocketTransport) Start(ctx context.Context, handler *application.MessageProcessor) error { + w.handler = handler + + // Create HTTP server but don't start it yet + // We'll set up the handler in ServeAssets() if it's called + w.server = &http.Server{ + Addr: w.addr, + } + + // Handle context cancellation + go func() { + <-ctx.Done() + w.Stop() + }() + + return nil +} + +func (w *WebSocketTransport) JSClient() []byte { + return jsClient +} + +// ServeAssets configures the transport to serve assets alongside WebSocket IPC. +// This implements the AssetServerTransport interface for browser-based deployments. +func (w *WebSocketTransport) ServeAssets(assetHandler http.Handler) error { + mux := http.NewServeMux() + + // Mount WebSocket endpoint for IPC + mux.HandleFunc("/wails/ws", w.handleWebSocket) + + // Mount asset server for all other requests + mux.Handle("/", assetHandler) + + // Set the handler and start the server + w.server.Handler = mux + + // Start server in background + go func() { + log.Printf("WebSocket transport serving assets and IPC on %s", w.addr) + log.Printf(" - Assets: http://%s/", w.addr) + log.Printf(" - WebSocket IPC: ws://%s/wails/ws", w.addr) + if err := w.server.ListenAndServe(); err != nil && err != http.ErrServerClosed { + log.Printf("WebSocket server error: %v", err) + } + }() + + return nil +} + +// Stop gracefully shuts down the WebSocket server +func (w *WebSocketTransport) Stop() error { + if w.server == nil { + return nil + } + + w.mu.Lock() + for conn := range w.clients { + conn.Close() + } + w.mu.Unlock() + + return w.server.Shutdown(context.Background()) +} + +// handleWebSocket handles WebSocket connections +func (w *WebSocketTransport) handleWebSocket(rw http.ResponseWriter, r *http.Request) { + conn, err := w.upgrader.Upgrade(rw, r, nil) + if err != nil { + log.Printf("WebSocket upgrade failed: %v", err) + return + } + + w.mu.Lock() + messageChan := make(chan *WebSocketMessage, 100) + w.clients[conn] = messageChan + w.mu.Unlock() + + ctx, cancel := context.WithCancel(r.Context()) + + defer func() { + w.mu.Lock() + cancel() + close(messageChan) + if _, ok := w.clients[conn]; ok { + delete(w.clients, conn) + } + w.mu.Unlock() + conn.Close() + }() + + // write responses in one place, as concurrent writeJSON is not allowed + go func() { + for { + select { + case msg, ok := <-messageChan: + if !ok { + return + } + + w.mu.RLock() + if err := conn.WriteJSON(msg); err != nil { + log.Printf("[WebSocket] Failed to send message: %v", err) + } else { + if msg.Type == "response" { + log.Printf("[WebSocket] Successfully sent response for msgID=%s", msg.ID) + } + } + w.mu.RUnlock() + } + } + }() + + // Read messages from client + for { + var msg WebSocketMessage + err := conn.ReadJSON(&msg) + if err != nil { + if websocket.IsUnexpectedCloseError(err, websocket.CloseGoingAway, websocket.CloseAbnormalClosure) { + log.Printf("WebSocket read error: %v", err) + } + break + } + + // Process request + if msg.Type == "request" && msg.Request != nil { + if msg.Request.Args == nil { + msg.Request.Args = &application.Args{} + } + go w.handleRequest(ctx, messageChan, msg.ID, msg.Request) + } + } +} + +// handleRequest processes a runtime call request and sends the response +func (w *WebSocketTransport) handleRequest(ctx context.Context, messageChan chan *WebSocketMessage, msgID string, req *application.RuntimeRequest) { + log.Printf("[WebSocket] Received request: msgID=%s, object=%d, method=%d, args=%s", msgID, req.Object, req.Method, req.Args.String()) + + // Call the Wails runtime handler + response, err := w.handler.HandleRuntimeCallWithIDs(ctx, req) + + w.sendResponse(ctx, messageChan, msgID, response, err) +} + +// sendResponse sends a response message to the client +func (w *WebSocketTransport) sendResponse(ctx context.Context, messageChan chan *WebSocketMessage, msgID string, resp any, err error) { + response := &wsResponse{ + StatusCode: 200, + Data: resp, + } + if err != nil { + response.StatusCode = 422 + response.Data = err.Error() + } + + responseMsg := &WebSocketMessage{ + ID: msgID, + Type: "response", + Response: response, + } + + w.mu.RLock() + defer w.mu.RUnlock() + + select { + case <-ctx.Done(): + log.Println("[WebSocket] Context cancelled before sending response.") + default: + messageChan <- responseMsg + } +} + +// BroadcastEvent sends an event to all connected clients +// This can be used for server-pushed events +func (w *WebSocketTransport) DispatchWailsEvent(event *application.CustomEvent) { + msg := &WebSocketMessage{ + Type: "event", + Event: event, + } + + w.mu.RLock() + defer w.mu.RUnlock() + + for _, channel := range w.clients { + channel <- msg + } +} diff --git a/v3/examples/websocket-transport/websocket-transport.js b/v3/examples/websocket-transport/websocket-transport.js new file mode 100644 index 000000000..ff8d055fd --- /dev/null +++ b/v3/examples/websocket-transport/websocket-transport.js @@ -0,0 +1,253 @@ +/** + * WebSocket Transport Implementation for Wails + * + * This is a custom transport that replaces the default HTTP fetch transport + * with WebSocket-based communication. + * + * VERSION 5 - SIMPLIFIED + */ + +console.log("[WebSocket Transport] Loading VERSION 5 - simplified"); + +import { clientId } from "/wails/runtime.js"; + +/** + * Generate a unique ID (simplified nanoid implementation) + */ +function nanoid(size = 21) { + const alphabet = "useandom-26T198340PX75pxJACKVERYMINDBUSHWOLF_GQZbfghjklqvwyzrict"; + let id = ""; + let i = size; + while (i--) { + id += alphabet[(Math.random() * 64) | 0]; + } + return id; +} + +/** + * WebSocket Transport class + */ +export class WebSocketTransport { + constructor(url, options = {}) { + this.url = url; + this.ws = null; + this.wsReady = false; + this.pendingRequests = new Map(); + this.messageQueue = []; + this.reconnectTimer = null; + this.reconnectDelay = options.reconnectDelay || 2000; + this.requestTimeout = options.requestTimeout || 30000; + this.maxQueueSize = options.maxQueueSize || 100; + } + + /** + * Connect to the WebSocket server + */ + connect() { + if (this.ws?.readyState === WebSocket.OPEN || this.ws?.readyState === WebSocket.CONNECTING) { + return Promise.resolve(); + } + + return new Promise((resolve, reject) => { + this.ws = new WebSocket(this.url); + + this.ws.onopen = () => { + console.log(`[WebSocket] ✓ Connected to ${this.url}`); + this.wsReady = true; + + // Send queued messages + while (this.messageQueue.length > 0) { + const msg = this.messageQueue.shift(); + this.ws.send(JSON.stringify(msg)); + } + + resolve(); + }; + + this.ws.onmessage = async(event) => { + // Handle both text and binary messages + let data = event.data; + if (data instanceof Blob) { + data = await data.text(); + } + this.handleMessage(data); + }; + + this.ws.onerror = (error) => { + console.error("[WebSocket] Error:", error); + this.wsReady = false; + reject(error); + }; + + this.ws.onclose = () => { + console.log("[WebSocket] Disconnected"); + this.wsReady = false; + + // Reject all pending requests + this.pendingRequests.forEach(({ reject, timeout }) => { + clearTimeout(timeout); + reject(new Error("WebSocket connection closed")); + }); + this.pendingRequests.clear(); + this.messageQueue = []; + + // Attempt to reconnect + if (!this.reconnectTimer) { + this.reconnectTimer = setTimeout(() => { + this.reconnectTimer = null; + console.log("[WebSocket] Attempting to reconnect..."); + this.connect().catch(err => { + console.error("[WebSocket] Reconnection failed:", err); + }); + }, this.reconnectDelay); + } + }; + }); + } + + /** + * Handle incoming WebSocket message + */ + handleMessage(data) { + console.log("[WebSocket] Received raw message:", data); + try { + const msg = JSON.parse(data); + console.log("[WebSocket] Parsed message:", msg); + + if (msg.type === "response" && msg.id) { + const pending = this.pendingRequests.get(msg.id); + if (!pending) { + console.warn("[WebSocket] No pending request for ID:", msg.id); + return; + } + + this.pendingRequests.delete(msg.id); + clearTimeout(pending.timeout); + + const response = msg.response; + if (!response) { + pending.reject(new Error("Invalid response: missing response field")); + return; + } + + console.log("[WebSocket] Response statusCode:", response.statusCode); + + if (response.statusCode === 200) { + let responseData = response.data; + + console.log("[WebSocket] Response data:", responseData); + pending.resolve(responseData ?? undefined); + } else { + let errorData = response.data; + console.error("[WebSocket] Error response:", errorData); + pending.reject(new Error(errorData)); + } + } else if (msg.type === "event") { + console.log("[WebSocket] Received server event:", msg); + // Dispatch to Wails event system + if (msg.event && window._wails?.dispatchWailsEvent) { + window._wails.dispatchWailsEvent(msg.event); + console.log("[WebSocket] Event dispatched to Wails:", msg.event.name); + } + } + } catch (err) { + console.error("[WebSocket] Failed to parse WebSocket message:", err); + console.error("[WebSocket] Raw message that failed:", data); + } + } + + /** + * Send a runtime call over WebSocket + * Implements the RuntimeTransport.call() interface + */ + async call(objectID, method, windowName, args) { + // Ensure WebSocket is connected + if (!this.wsReady) { + await this.connect(); + } + + return new Promise((resolve, reject) => { + const msgID = nanoid(); + + // Set up timeout + const timeout = setTimeout(() => { + if (this.pendingRequests.has(msgID)) { + this.pendingRequests.delete(msgID); + reject(new Error(`Request timeout (${this.requestTimeout}ms)`)); + } + }, this.requestTimeout); + + // Register pending request with the message for later reference + this.pendingRequests.set(msgID, { resolve, reject, timeout, request: { object: objectID, method, args } }); + + // Build message + const message = { + id: msgID, + type: "request", + request: { + object: objectID, + method: method, + args: args, + windowName: windowName || undefined, + clientId: clientId + } + }; + + // Send or queue message + if (this.wsReady && this.ws?.readyState === WebSocket.OPEN) { + this.ws.send(JSON.stringify(message)); + } else { + if (this.messageQueue.length >= this.maxQueueSize) { + reject(new Error("Message queue full")); + return; + } + this.messageQueue.push(message); + this.connect().catch(reject); + } + }); + } + + /** + * Close the WebSocket connection + */ + close() { + if (this.reconnectTimer) { + clearTimeout(this.reconnectTimer); + this.reconnectTimer = null; + } + + if (this.ws) { + this.ws.close(); + this.ws = null; + } + + this.wsReady = false; + } + + /** + * Get connection status + */ + isConnected() { + return this.wsReady && this.ws?.readyState === WebSocket.OPEN; + } +} + +/** + * Create and configure a WebSocket transport + * + * @param url - WebSocket URL (e.g., 'ws://localhost:9099/wails/ws') + * @param options - Optional configuration + * @returns WebSocketTransport instance + */ +export async function createWebSocketTransport(url, options = {}) { + const transport = new WebSocketTransport(url, options); + await transport.connect(); + return transport; +} + +const wsTransport = await createWebSocketTransport("ws://localhost:9099/wails/ws", { + reconnectDelay: 2000, + requestTimeout: 30000 +}); + +export default wsTransport; diff --git a/v3/examples/webview-api-check/.gitignore b/v3/examples/webview-api-check/.gitignore new file mode 100644 index 000000000..d3ca1b3e4 --- /dev/null +++ b/v3/examples/webview-api-check/.gitignore @@ -0,0 +1,6 @@ +# Compiled binary +webview-api-check +webview-api-check.exe + +# Generated reports +webview-api-report-*.json diff --git a/v3/examples/webview-api-check/README.md b/v3/examples/webview-api-check/README.md new file mode 100644 index 000000000..835962654 --- /dev/null +++ b/v3/examples/webview-api-check/README.md @@ -0,0 +1,93 @@ +# WebView API Compatibility Check + +This example application tests and reports which Web APIs are available in the current WebView engine. + +## Purpose + +Different platforms use different WebView engines: +- **Linux GTK4**: WebKitGTK 6.0 (WebKit-based) +- **Linux GTK3**: WebKit2GTK 4.1 (WebKit-based) +- **Windows**: WebView2 (Chromium-based) +- **macOS**: WKWebView (WebKit-based) + +Each engine supports different Web APIs. This tool helps you understand what APIs are available for your Wails application on each platform. + +## Building + +```bash +# Linux GTK4 +go build -tags gtk4 -o webview-api-check . + +# Linux GTK3 +go build -tags gtk3 -o webview-api-check . + +# Windows/macOS +go build -o webview-api-check . +``` + +## Usage + +1. Run the application +2. Click "Run API Tests" to test all Web APIs +3. View results organized by category +4. Use filters to find specific APIs +5. Export report as JSON for comparison + +## API Categories Tested + +| Category | APIs Tested | +|----------|-------------| +| Storage | localStorage, IndexedDB, Cache API, File System Access | +| Network | Fetch, WebSocket, EventSource, WebTransport | +| Media | Web Audio, MediaRecorder, MediaDevices, Speech | +| Graphics | Canvas, WebGL, WebGL2, WebGPU | +| Device | Geolocation, Sensors, Battery, Bluetooth, USB | +| Workers | Web Workers, Service Workers, Shared Workers | +| Performance | Observers, Timing APIs | +| Security | Web Crypto, Credentials, WebAuthn | +| UI & DOM | Custom Elements, Shadow DOM, Pointer Events | +| CSS | CSSOM, Container Queries, Modern Selectors | +| JavaScript | ES Modules, BigInt, Private Fields, etc. | + +## Understanding Results + +- **Supported** (green): API is fully available +- **Partial** (yellow): API exists but may have limitations +- **Unsupported** (red): API is not available + +Some APIs are marked with notes: +- "Chromium only" - Available in WebView2 but not WebKit +- "Experimental" - May not be stable +- "Requires secure context" - Needs HTTPS +- "PWA context" - Only available in installed PWAs + +## Comparing Platforms + +Run the app on different platforms and export JSON reports. Compare them to understand API availability differences: + +```bash +# On Linux GTK4 +./webview-api-check +# Export: webview-api-report-linux-20240115-143052.json + +# On Windows +./webview-api-check.exe +# Export: webview-api-report-windows-20240115-143052.json +``` + +## Known Differences + +### WebKitGTK vs WebView2 (Chromium) + +WebView2 (Windows) typically supports more APIs because Chromium is updated more frequently: +- File System Access API (Chromium only) +- Web Serial, WebHID, WebUSB (Chromium only) +- Various experimental features + +WebKitGTK may have better support for: +- Standard DOM APIs +- CSS features (varies by version) + +### GTK3 vs GTK4 WebKitGTK + +GTK4 uses WebKitGTK 6.0, GTK3 uses WebKit2GTK 4.1. The WebKit version determines API support, not GTK version. diff --git a/v3/examples/webview-api-check/frontend/api-tests.js b/v3/examples/webview-api-check/frontend/api-tests.js new file mode 100644 index 000000000..6da1d2471 --- /dev/null +++ b/v3/examples/webview-api-check/frontend/api-tests.js @@ -0,0 +1,664 @@ +// Comprehensive Web API Tests +// Each test returns { supported: true|false|'partial', note?: string } + +const API_TESTS = { + "Storage APIs": { + "localStorage": () => ({ + supported: typeof localStorage !== 'undefined', + note: typeof localStorage !== 'undefined' ? `${localStorage.length} items` : undefined + }), + "sessionStorage": () => ({ + supported: typeof sessionStorage !== 'undefined' + }), + "IndexedDB": () => ({ + supported: typeof indexedDB !== 'undefined' + }), + "Cache API": () => ({ + supported: 'caches' in window + }), + "CookieStore API": () => ({ + supported: 'cookieStore' in window, + note: !('cookieStore' in window) ? 'Chromium only' : undefined + }), + "Storage API": () => ({ + supported: navigator.storage !== undefined + }), + "Storage Access API": () => ({ + supported: 'hasStorageAccess' in document + }), + "File System Access": () => ({ + supported: 'showOpenFilePicker' in window, + note: !('showOpenFilePicker' in window) ? 'Chromium only' : undefined + }), + "Origin Private File System": () => ({ + supported: navigator.storage && 'getDirectory' in navigator.storage + }) + }, + + "Network APIs": { + "Fetch API": () => ({ + supported: typeof fetch !== 'undefined' + }), + "XMLHttpRequest": () => ({ + supported: typeof XMLHttpRequest !== 'undefined' + }), + "WebSocket": () => ({ + supported: typeof WebSocket !== 'undefined' + }), + "EventSource (SSE)": () => ({ + supported: typeof EventSource !== 'undefined' + }), + "Beacon API": () => ({ + supported: 'sendBeacon' in navigator + }), + "WebTransport": () => ({ + supported: typeof WebTransport !== 'undefined', + note: typeof WebTransport === 'undefined' ? 'Experimental' : undefined + }), + "Background Fetch": () => ({ + supported: 'BackgroundFetchManager' in window, + note: !('BackgroundFetchManager' in window) ? 'Chromium only' : undefined + }), + "Background Sync": () => ({ + supported: 'SyncManager' in window, + note: !('SyncManager' in window) ? 'Chromium only' : undefined + }) + }, + + "Media APIs": { + "Web Audio API": () => ({ + supported: typeof AudioContext !== 'undefined' || typeof webkitAudioContext !== 'undefined', + note: typeof AudioContext === 'undefined' && typeof webkitAudioContext !== 'undefined' ? 'webkit prefix' : undefined + }), + "MediaDevices": () => ({ + supported: 'mediaDevices' in navigator + }), + "getUserMedia": () => ({ + supported: navigator.mediaDevices && 'getUserMedia' in navigator.mediaDevices + }), + "getDisplayMedia": () => ({ + supported: navigator.mediaDevices && 'getDisplayMedia' in navigator.mediaDevices + }), + "MediaRecorder": () => ({ + supported: typeof MediaRecorder !== 'undefined' + }), + "Media Session": () => ({ + supported: 'mediaSession' in navigator + }), + "Media Capabilities": () => ({ + supported: 'mediaCapabilities' in navigator + }), + "MediaSource Extensions": () => ({ + supported: typeof MediaSource !== 'undefined' + }), + "Picture-in-Picture": () => ({ + supported: 'pictureInPictureEnabled' in document + }), + "Audio Worklet": () => ({ + supported: typeof AudioWorkletNode !== 'undefined' + }), + "Web Speech (Recognition)": () => ({ + supported: 'SpeechRecognition' in window || 'webkitSpeechRecognition' in window + }), + "Web Speech (Synthesis)": () => ({ + supported: 'speechSynthesis' in window + }), + "Encrypted Media Extensions": () => ({ + supported: 'MediaKeys' in window + }) + }, + + "Graphics APIs": { + "Canvas 2D": () => { + const canvas = document.createElement('canvas'); + const ctx = canvas.getContext('2d'); + return { supported: ctx !== null }; + }, + "WebGL": () => { + const canvas = document.createElement('canvas'); + const gl = canvas.getContext('webgl') || canvas.getContext('experimental-webgl'); + return { supported: gl !== null }; + }, + "WebGL2": () => { + const canvas = document.createElement('canvas'); + const gl = canvas.getContext('webgl2'); + return { supported: gl !== null }; + }, + "WebGPU": () => ({ + supported: 'gpu' in navigator, + note: !('gpu' in navigator) ? 'Experimental' : undefined + }), + "OffscreenCanvas": () => ({ + supported: typeof OffscreenCanvas !== 'undefined' + }), + "ImageBitmap": () => ({ + supported: typeof createImageBitmap !== 'undefined' + }), + "CSS Painting API": () => ({ + supported: 'paintWorklet' in CSS, + note: !('paintWorklet' in CSS) ? 'Houdini API' : undefined + }), + "Web Animations": () => ({ + supported: typeof Element.prototype.animate !== 'undefined' + }), + "View Transitions": () => ({ + supported: 'startViewTransition' in document, + note: !('startViewTransition' in document) ? 'Chromium 111+' : undefined + }) + }, + + "Device APIs": { + "Geolocation": () => ({ + supported: 'geolocation' in navigator + }), + "Device Orientation": () => ({ + supported: 'DeviceOrientationEvent' in window + }), + "Device Motion": () => ({ + supported: 'DeviceMotionEvent' in window + }), + "Accelerometer": () => ({ + supported: 'Accelerometer' in window, + note: !('Accelerometer' in window) ? 'Requires secure context' : undefined + }), + "Gyroscope": () => ({ + supported: 'Gyroscope' in window, + note: !('Gyroscope' in window) ? 'Requires secure context' : undefined + }), + "Magnetometer": () => ({ + supported: 'Magnetometer' in window, + note: !('Magnetometer' in window) ? 'Chromium only' : undefined + }), + "Ambient Light Sensor": () => ({ + supported: 'AmbientLightSensor' in window, + note: !('AmbientLightSensor' in window) ? 'Limited support' : undefined + }), + "Battery Status": () => ({ + supported: 'getBattery' in navigator, + note: !('getBattery' in navigator) ? 'Chromium only' : undefined + }), + "Device Memory": () => ({ + supported: 'deviceMemory' in navigator, + note: 'deviceMemory' in navigator ? `${navigator.deviceMemory} GB` : 'Chromium only' + }), + "Screen Orientation": () => ({ + supported: 'orientation' in screen + }), + "Screen Wake Lock": () => ({ + supported: 'wakeLock' in navigator + }), + "Vibration": () => ({ + supported: 'vibrate' in navigator + }), + "Web MIDI": () => ({ + supported: 'requestMIDIAccess' in navigator + }), + "Web Serial": () => ({ + supported: 'serial' in navigator, + note: !('serial' in navigator) ? 'Chromium only' : undefined + }), + "WebHID": () => ({ + supported: 'hid' in navigator, + note: !('hid' in navigator) ? 'Chromium only' : undefined + }), + "WebUSB": () => ({ + supported: 'usb' in navigator, + note: !('usb' in navigator) ? 'Chromium only' : undefined + }), + "Web NFC": () => ({ + supported: 'NDEFReader' in window, + note: !('NDEFReader' in window) ? 'Android Chrome only' : undefined + }), + "Web Bluetooth": () => ({ + supported: 'bluetooth' in navigator, + note: !('bluetooth' in navigator) ? 'Limited support' : undefined + }), + "Gamepad API": () => ({ + supported: 'getGamepads' in navigator + }) + }, + + "Worker APIs": { + "Web Workers": () => ({ + supported: typeof Worker !== 'undefined' + }), + "Shared Workers": () => ({ + supported: typeof SharedWorker !== 'undefined' + }), + "Service Worker": () => ({ + supported: 'serviceWorker' in navigator + }), + "Worklets": () => ({ + supported: typeof Worklet !== 'undefined' + }) + }, + + "Performance APIs": { + "Performance API": () => ({ + supported: typeof performance !== 'undefined' + }), + "Performance Observer": () => ({ + supported: typeof PerformanceObserver !== 'undefined' + }), + "Navigation Timing": () => ({ + supported: typeof PerformanceNavigationTiming !== 'undefined' + }), + "Resource Timing": () => ({ + supported: typeof PerformanceResourceTiming !== 'undefined' + }), + "User Timing": () => ({ + supported: performance && 'mark' in performance && 'measure' in performance + }), + "Long Tasks API": () => ({ + supported: typeof PerformanceLongTaskTiming !== 'undefined' + }), + "Intersection Observer": () => ({ + supported: typeof IntersectionObserver !== 'undefined' + }), + "Resize Observer": () => ({ + supported: typeof ResizeObserver !== 'undefined' + }), + "Mutation Observer": () => ({ + supported: typeof MutationObserver !== 'undefined' + }), + "Reporting API": () => ({ + supported: typeof ReportingObserver !== 'undefined' + }), + "Compute Pressure": () => ({ + supported: 'PressureObserver' in window, + note: !('PressureObserver' in window) ? 'Experimental' : undefined + }) + }, + + "Security APIs": { + "Web Crypto": () => ({ + supported: typeof crypto !== 'undefined' && 'subtle' in crypto + }), + "Credentials API": () => ({ + supported: 'credentials' in navigator + }), + "Web Authentication": () => ({ + supported: typeof PublicKeyCredential !== 'undefined' + }), + "Permissions API": () => ({ + supported: 'permissions' in navigator + }), + "Trusted Types": () => ({ + supported: 'trustedTypes' in window + }), + "Content Security Policy": () => ({ + supported: typeof SecurityPolicyViolationEvent !== 'undefined' + }) + }, + + "UI & DOM APIs": { + "Custom Elements": () => ({ + supported: 'customElements' in window + }), + "Shadow DOM": () => ({ + supported: 'attachShadow' in Element.prototype + }), + "HTML Templates": () => ({ + supported: 'content' in document.createElement('template') + }), + "Pointer Events": () => ({ + supported: 'PointerEvent' in window + }), + "Touch Events": () => ({ + supported: 'ontouchstart' in window || navigator.maxTouchPoints > 0 + }), + "Pointer Lock": () => ({ + supported: 'requestPointerLock' in Element.prototype + }), + "Fullscreen API": () => ({ + supported: 'fullscreenEnabled' in document || 'webkitFullscreenEnabled' in document + }), + "Selection API": () => ({ + supported: typeof Selection !== 'undefined' + }), + "Clipboard API": () => ({ + supported: 'clipboard' in navigator + }), + "Clipboard (read)": async () => { + if (!navigator.clipboard) return { supported: false }; + return { supported: 'read' in navigator.clipboard }; + }, + "Clipboard (write)": async () => { + if (!navigator.clipboard) return { supported: false }; + return { supported: 'write' in navigator.clipboard }; + }, + "Drag and Drop": () => ({ + supported: 'draggable' in document.createElement('div') + }), + "EditContext": () => ({ + supported: 'EditContext' in window, + note: !('EditContext' in window) ? 'Experimental' : undefined + }), + "Virtual Keyboard": () => ({ + supported: 'virtualKeyboard' in navigator, + note: !('virtualKeyboard' in navigator) ? 'Chromium only' : undefined + }), + "Popover API": () => ({ + supported: 'popover' in HTMLElement.prototype + }), + "Dialog Element": () => ({ + supported: typeof HTMLDialogElement !== 'undefined' + }) + }, + + "Notifications & Messaging": { + "Notifications API": () => ({ + supported: 'Notification' in window + }), + "Push API": () => ({ + supported: 'PushManager' in window + }), + "Channel Messaging": () => ({ + supported: typeof MessageChannel !== 'undefined' + }), + "Broadcast Channel": () => ({ + supported: typeof BroadcastChannel !== 'undefined' + }), + "postMessage": () => ({ + supported: 'postMessage' in window + }) + }, + + "Navigation & History": { + "History API": () => ({ + supported: 'pushState' in history + }), + "Navigation API": () => ({ + supported: 'navigation' in window, + note: !('navigation' in window) ? 'Chromium 102+' : undefined + }), + "URL API": () => ({ + supported: typeof URL !== 'undefined' + }), + "URLSearchParams": () => ({ + supported: typeof URLSearchParams !== 'undefined' + }), + "URLPattern": () => ({ + supported: typeof URLPattern !== 'undefined', + note: typeof URLPattern === 'undefined' ? 'Limited support' : undefined + }) + }, + + "Sharing & Content": { + "Share API": () => ({ + supported: 'share' in navigator + }), + "Web Share Target": () => ({ + supported: 'share' in navigator && 'canShare' in navigator + }), + "Badging API": () => ({ + supported: 'setAppBadge' in navigator, + note: !('setAppBadge' in navigator) ? 'PWA context' : undefined + }), + "Content Index": () => ({ + supported: 'ContentIndex' in window, + note: !('ContentIndex' in window) ? 'PWA context' : undefined + }), + "Contact Picker": () => ({ + supported: 'contacts' in navigator, + note: !('contacts' in navigator) ? 'Android Chrome only' : undefined + }) + }, + + "Streams & Encoding": { + "Streams API": () => ({ + supported: typeof ReadableStream !== 'undefined' + }), + "WritableStream": () => ({ + supported: typeof WritableStream !== 'undefined' + }), + "TransformStream": () => ({ + supported: typeof TransformStream !== 'undefined' + }), + "Compression Streams": () => ({ + supported: typeof CompressionStream !== 'undefined' + }), + "TextEncoder/Decoder": () => ({ + supported: typeof TextEncoder !== 'undefined' && typeof TextDecoder !== 'undefined' + }), + "Encoding API (streams)": () => ({ + supported: typeof TextEncoderStream !== 'undefined' + }), + "Blob": () => ({ + supported: typeof Blob !== 'undefined' + }), + "File API": () => ({ + supported: typeof File !== 'undefined' && typeof FileReader !== 'undefined' + }), + "FileReader": () => ({ + supported: typeof FileReader !== 'undefined' + }), + "ArrayBuffer": () => ({ + supported: typeof ArrayBuffer !== 'undefined' + }), + "DataView": () => ({ + supported: typeof DataView !== 'undefined' + }), + "Typed Arrays": () => ({ + supported: typeof Uint8Array !== 'undefined' + }) + }, + + "Payment APIs": { + "Payment Request": () => ({ + supported: 'PaymentRequest' in window + }), + "Payment Handler": () => ({ + supported: 'PaymentManager' in window, + note: !('PaymentManager' in window) ? 'Limited support' : undefined + }) + }, + + "Extended/Experimental": { + "WebXR": () => ({ + supported: 'xr' in navigator, + note: !('xr' in navigator) ? 'VR/AR devices' : undefined + }), + "Presentation API": () => ({ + supported: 'presentation' in navigator, + note: !('presentation' in navigator) ? 'Cast-like APIs' : undefined + }), + "Remote Playback": () => ({ + supported: 'remote' in HTMLMediaElement.prototype + }), + "Window Management": () => ({ + supported: 'getScreenDetails' in window, + note: !('getScreenDetails' in window) ? 'Multi-screen' : undefined + }), + "Document Picture-in-Picture": () => ({ + supported: 'documentPictureInPicture' in window, + note: !('documentPictureInPicture' in window) ? 'Chromium only' : undefined + }), + "EyeDropper": () => ({ + supported: 'EyeDropper' in window, + note: !('EyeDropper' in window) ? 'Chromium only' : undefined + }), + "File Handling": () => ({ + supported: 'launchQueue' in window, + note: !('launchQueue' in window) ? 'PWA only' : undefined + }), + "Launch Handler": () => ({ + supported: 'LaunchParams' in window, + note: !('LaunchParams' in window) ? 'PWA only' : undefined + }), + "Idle Detection": () => ({ + supported: 'IdleDetector' in window, + note: !('IdleDetector' in window) ? 'Chromium only' : undefined + }), + "Keyboard Lock": () => ({ + supported: 'keyboard' in navigator && 'lock' in navigator.keyboard, + note: !('keyboard' in navigator) ? 'Fullscreen only' : undefined + }), + "Local Font Access": () => ({ + supported: 'queryLocalFonts' in window, + note: !('queryLocalFonts' in window) ? 'Chromium only' : undefined + }), + "Screen Capture": () => ({ + supported: navigator.mediaDevices && 'getDisplayMedia' in navigator.mediaDevices + }), + "Scheduler API": () => ({ + supported: 'scheduler' in window + }), + "Task Attribution": () => ({ + supported: typeof TaskAttributionTiming !== 'undefined' + }), + "Web Codecs (Video)": () => ({ + supported: typeof VideoEncoder !== 'undefined' + }), + "Web Codecs (Audio)": () => ({ + supported: typeof AudioEncoder !== 'undefined' + }), + "Web Locks": () => ({ + supported: 'locks' in navigator + }), + "Prioritized Task Scheduling": () => ({ + supported: 'scheduler' in window && 'postTask' in scheduler + }) + }, + + "CSS APIs": { + "CSSOM": () => ({ + supported: typeof CSSStyleSheet !== 'undefined' + }), + "Constructable Stylesheets": () => ({ + supported: 'adoptedStyleSheets' in document + }), + "CSS Typed OM": () => ({ + supported: 'attributeStyleMap' in Element.prototype + }), + "CSS Properties & Values": () => ({ + supported: CSS && 'registerProperty' in CSS + }), + "CSS.supports": () => ({ + supported: CSS && 'supports' in CSS + }), + "CSS Font Loading": () => ({ + supported: 'fonts' in document + }), + "CSS Container Queries": () => ({ + supported: CSS && CSS.supports && CSS.supports('container-type', 'inline-size') + }), + "@layer support": () => ({ + supported: CSS && CSS.supports && CSS.supports('@layer test { }') + }), + "Subgrid": () => ({ + supported: CSS && CSS.supports && CSS.supports('grid-template-columns', 'subgrid') + }), + ":has() selector": () => ({ + supported: CSS && CSS.supports && CSS.supports('selector(:has(a))') + }), + "color-mix()": () => ({ + supported: CSS && CSS.supports && CSS.supports('color', 'color-mix(in srgb, red, blue)') + }), + "Scroll-driven Animations": () => ({ + supported: CSS && CSS.supports && CSS.supports('animation-timeline', 'scroll()'), + note: !(CSS && CSS.supports && CSS.supports('animation-timeline', 'scroll()')) ? 'Chromium 115+' : undefined + }) + }, + + "JavaScript Features": { + "ES Modules": () => ({ + supported: 'noModule' in document.createElement('script') + }), + "Import Maps": () => ({ + supported: HTMLScriptElement.supports && HTMLScriptElement.supports('importmap') + }), + "Dynamic Import": async () => { + try { + await import('data:text/javascript,export default 1'); + return { supported: true }; + } catch { + return { supported: false }; + } + }, + "Top-level Await": () => ({ + supported: true, // If we're running, it's supported in modules + note: 'Module context' + }), + "WeakRef": () => ({ + supported: typeof WeakRef !== 'undefined' + }), + "FinalizationRegistry": () => ({ + supported: typeof FinalizationRegistry !== 'undefined' + }), + "BigInt": () => ({ + supported: typeof BigInt !== 'undefined' + }), + "globalThis": () => ({ + supported: typeof globalThis !== 'undefined' + }), + "Optional Chaining": () => { + try { + eval('const x = null?.foo'); + return { supported: true }; + } catch { + return { supported: false }; + } + }, + "Nullish Coalescing": () => { + try { + eval('const x = null ?? "default"'); + return { supported: true }; + } catch { + return { supported: false }; + } + }, + "Private Class Fields": () => { + try { + eval('class C { #x = 1 }'); + return { supported: true }; + } catch { + return { supported: false }; + } + }, + "Static Class Blocks": () => { + try { + eval('class C { static { } }'); + return { supported: true }; + } catch { + return { supported: false }; + } + }, + "Temporal (Stage 3)": () => ({ + supported: typeof Temporal !== 'undefined', + note: typeof Temporal === 'undefined' ? 'Proposal' : undefined + }), + "Iterator Helpers": () => ({ + supported: typeof Iterator !== 'undefined' && 'from' in Iterator, + note: !(typeof Iterator !== 'undefined') ? 'Proposal' : undefined + }), + "Array.at()": () => ({ + supported: 'at' in Array.prototype + }), + "Object.hasOwn()": () => ({ + supported: 'hasOwn' in Object + }), + "structuredClone": () => ({ + supported: typeof structuredClone !== 'undefined' + }), + "Atomics.waitAsync": () => ({ + supported: typeof Atomics !== 'undefined' && 'waitAsync' in Atomics + }), + "Array.fromAsync": () => ({ + supported: 'fromAsync' in Array, + note: !('fromAsync' in Array) ? 'ES2024' : undefined + }), + "Promise.withResolvers": () => ({ + supported: 'withResolvers' in Promise, + note: !('withResolvers' in Promise) ? 'ES2024' : undefined + }), + "RegExp v flag": () => { + try { + new RegExp('.', 'v'); + return { supported: true }; + } catch { + return { supported: false, note: 'ES2024' }; + } + } + } +}; diff --git a/v3/examples/webview-api-check/frontend/index.html b/v3/examples/webview-api-check/frontend/index.html new file mode 100644 index 000000000..bd05f0b50 --- /dev/null +++ b/v3/examples/webview-api-check/frontend/index.html @@ -0,0 +1,539 @@ + + + + + + WebView API Compatibility Check + + + +
                    +
                    +

                    WebView API Compatibility Check

                    +

                    Testing Web API support in your current WebView

                    +
                    + +
                    +
                    + Operating System + Loading... +
                    +
                    + Architecture + - +
                    +
                    + WebView Engine + - +
                    +
                    + User Agent + - +
                    +
                    + +
                    + + + + +
                    + +
                    +
                    +
                    + +
                    +
                    +
                    -
                    +
                    Supported
                    +
                    +
                    +
                    -
                    +
                    Partial
                    +
                    +
                    +
                    -
                    +
                    Unsupported
                    +
                    +
                    + +
                    + + +
                    + +
                    +
                    + + + + + diff --git a/v3/examples/webview-api-check/main.go b/v3/examples/webview-api-check/main.go new file mode 100644 index 000000000..667dd6ef1 --- /dev/null +++ b/v3/examples/webview-api-check/main.go @@ -0,0 +1,126 @@ +package main + +import ( + "embed" + "encoding/json" + "flag" + "fmt" + "os" + "runtime" + "time" + + "github.com/wailsapp/wails/v3/pkg/application" +) + +var autorun = flag.Bool("autorun", false, "Automatically run tests and save report") + +//go:embed frontend/* +var assets embed.FS + +// PlatformInfo contains information about the platform and webview +type PlatformInfo struct { + OS string `json:"os"` + Arch string `json:"arch"` + GoVersion string `json:"goVersion"` + WailsInfo string `json:"wailsInfo"` + WebViewInfo string `json:"webViewInfo"` + GTKVersion string `json:"gtkVersion,omitempty"` + Timestamp string `json:"timestamp"` +} + +// APIReport represents the full API compatibility report +type APIReport struct { + Platform PlatformInfo `json:"platform"` + APIs map[string]interface{} `json:"apis"` +} + +var appInstance *application.App + +// APICheckService provides methods for the frontend +type APICheckService struct{} + +// GetPlatformInfo returns information about the current platform +func (s *APICheckService) GetPlatformInfo() PlatformInfo { + info := PlatformInfo{ + OS: runtime.GOOS, + Arch: runtime.GOARCH, + GoVersion: runtime.Version(), + WailsInfo: "v3.0.0-dev", + Timestamp: time.Now().Format(time.RFC3339), + } + + // Platform-specific webview info + switch runtime.GOOS { + case "linux": + info.WebViewInfo = getLinuxWebViewInfo() + info.GTKVersion = getGTKVersionInfo() + case "darwin": + info.WebViewInfo = "WKWebView (WebKit)" + case "windows": + info.WebViewInfo = "WebView2 (Chromium-based)" + default: + info.WebViewInfo = "Unknown" + } + + return info +} + +// SaveReport saves the API report to a file +func (s *APICheckService) SaveReport(report APIReport) error { + filename := fmt.Sprintf("webview-api-report-%s-%s.json", + report.Platform.OS, + time.Now().Format("20060102-150405")) + + data, err := json.MarshalIndent(report, "", " ") + if err != nil { + return fmt.Errorf("failed to marshal report: %w", err) + } + + err = os.WriteFile(filename, data, 0644) + if err != nil { + return fmt.Errorf("failed to write report: %w", err) + } + + fmt.Printf("Report saved to: %s\n", filename) + return nil +} + +// Quit exits the application +func (s *APICheckService) Quit() { + if appInstance != nil { + appInstance.Quit() + } +} + +func main() { + flag.Parse() + + appInstance = application.New(application.Options{ + Name: "WebView API Check", + Description: "Check which Web APIs are available in the webview", + Assets: application.AssetOptions{ + Handler: application.BundledAssetFileServer(assets), + }, + Services: []application.Service{ + application.NewService(&APICheckService{}), + }, + }) + + url := "/" + if *autorun { + url = "/?autorun=1" + } + + appInstance.Window.NewWithOptions(application.WebviewWindowOptions{ + Title: "WebView API Compatibility Check", + Width: 1200, + Height: 800, + URL: url, + }) + + err := appInstance.Run() + if err != nil { + fmt.Fprintf(os.Stderr, "Error: %v\n", err) + os.Exit(1) + } +} diff --git a/v3/examples/webview-api-check/platform_darwin.go b/v3/examples/webview-api-check/platform_darwin.go new file mode 100644 index 000000000..b6551de04 --- /dev/null +++ b/v3/examples/webview-api-check/platform_darwin.go @@ -0,0 +1,11 @@ +//go:build darwin + +package main + +func getLinuxWebViewInfo() string { + return "" +} + +func getGTKVersionInfo() string { + return "" +} diff --git a/v3/examples/webview-api-check/platform_linux.go b/v3/examples/webview-api-check/platform_linux.go new file mode 100644 index 000000000..17445842b --- /dev/null +++ b/v3/examples/webview-api-check/platform_linux.go @@ -0,0 +1,33 @@ +//go:build linux + +package main + +import "os/exec" + +func getLinuxWebViewInfo() string { + // Try to get WebKitGTK version from pkg-config + // For GTK4 builds, this will be webkitgtk-6.0 + // For GTK3 builds, this will be webkit2gtk-4.1 + out, err := exec.Command("pkg-config", "--modversion", "webkitgtk-6.0").Output() + if err == nil { + return "WebKitGTK " + string(out[:len(out)-1]) + } + out, err = exec.Command("pkg-config", "--modversion", "webkit2gtk-4.1").Output() + if err == nil { + return "WebKit2GTK " + string(out[:len(out)-1]) + } + return "WebKitGTK (unknown version)" +} + +func getGTKVersionInfo() string { + // Try GTK4 first + out, err := exec.Command("pkg-config", "--modversion", "gtk4").Output() + if err == nil { + return "GTK " + string(out[:len(out)-1]) + } + out, err = exec.Command("pkg-config", "--modversion", "gtk+-3.0").Output() + if err == nil { + return "GTK " + string(out[:len(out)-1]) + } + return "GTK (unknown version)" +} diff --git a/v3/examples/webview-api-check/platform_windows.go b/v3/examples/webview-api-check/platform_windows.go new file mode 100644 index 000000000..b224da990 --- /dev/null +++ b/v3/examples/webview-api-check/platform_windows.go @@ -0,0 +1,11 @@ +//go:build windows + +package main + +func getLinuxWebViewInfo() string { + return "" +} + +func getGTKVersionInfo() string { + return "" +} diff --git a/v3/examples/window-api/README.md b/v3/examples/window-api/README.md new file mode 100644 index 000000000..02c726062 --- /dev/null +++ b/v3/examples/window-api/README.md @@ -0,0 +1,19 @@ +# Window API Example + +This is an example of how to use the JS Window API + +## Running the example + +To run the example, simply run the following command: + +```bash +go run . +``` + +# Status + +| Platform | Status | +|----------|---------| +| Mac | Working | +| Windows | | +| Linux | | diff --git a/v3/examples/window-api/assets/index.html b/v3/examples/window-api/assets/index.html new file mode 100644 index 000000000..a0dd5d8b2 --- /dev/null +++ b/v3/examples/window-api/assets/index.html @@ -0,0 +1,159 @@ + + + + + Wails Alpha + + + + + +
                    Alpha
                    +
                    +

                    Close the Window?

                    +

                    Center

                    +

                    Minimise

                    +

                    Maximise

                    +

                    UnMaximise

                    +

                    Fullscreen

                    +

                    UnFullscreen

                    +

                    Restore

                    +
                    +
                    +

                    ToggleMaximise

                    +

                    IsFocused

                    +

                    IsMaximised

                    +

                    IsFullscreen

                    +
                    +
                    + + + + + diff --git a/v3/examples/window-api/main.go b/v3/examples/window-api/main.go new file mode 100644 index 000000000..252608641 --- /dev/null +++ b/v3/examples/window-api/main.go @@ -0,0 +1,42 @@ +package main + +import ( + "embed" + "log" + + "github.com/wailsapp/wails/v3/pkg/application" +) + +//go:embed assets/* +var assets embed.FS + +func main() { + + app := application.New(application.Options{ + Name: "JS Window API Demo", + Description: "A demo of the JS Window API", + Mac: application.MacOptions{ + ApplicationShouldTerminateAfterLastWindowClosed: true, + }, + Assets: application.AssetOptions{ + Handler: application.BundledAssetFileServer(assets), + }, + }) + + app.Window.NewWithOptions(application.WebviewWindowOptions{ + Title: "JS Window API Demo", + Width: 1280, + Height: 1024, + Mac: application.MacWindow{ + Backdrop: application.MacBackdropTranslucent, + TitleBar: application.MacTitleBarHiddenInsetUnified, + InvisibleTitleBarHeight: 50, + }, + }) + + err := app.Run() + + if err != nil { + log.Fatal(err.Error()) + } +} diff --git a/v3/examples/window-call/README.md b/v3/examples/window-call/README.md new file mode 100644 index 000000000..baffad046 --- /dev/null +++ b/v3/examples/window-call/README.md @@ -0,0 +1,11 @@ +# Window Call Example + +This example is a demonstration of how to know which window is calling a service. + +## Running the example + +To run the example, simply run the following command: + +```bash +go run . +``` diff --git a/v3/examples/window-call/assets/index.html b/v3/examples/window-call/assets/index.html new file mode 100644 index 000000000..a99293f03 --- /dev/null +++ b/v3/examples/window-call/assets/index.html @@ -0,0 +1,27 @@ + + + + + + Window Call Demo + + + + + + + + + \ No newline at end of file diff --git a/v3/examples/window-call/main.go b/v3/examples/window-call/main.go new file mode 100644 index 000000000..e6bdee23b --- /dev/null +++ b/v3/examples/window-call/main.go @@ -0,0 +1,73 @@ +package main + +import ( + "context" + "embed" + "github.com/wailsapp/wails/v3/pkg/application" + "log" + "math/rand" + "runtime" + "strconv" +) + +//go:embed assets/* +var assets embed.FS + +type WindowService struct{} + +func (s *WindowService) RandomTitle(ctx context.Context) { + callingWindow := ctx.Value(application.WindowKey).(application.Window) + title := "Random Title " + strconv.Itoa(rand.Intn(1000)) + callingWindow.SetTitle(title) +} + +// ============================================== + +func main() { + app := application.New(application.Options{ + Name: "Window call Demo", + Description: "A demo of the WebviewWindow API", + Assets: application.AssetOptions{ + Handler: application.BundledAssetFileServer(assets), + }, + Mac: application.MacOptions{ + ApplicationShouldTerminateAfterLastWindowClosed: false, + }, + Services: []application.Service{ + application.NewService(&WindowService{}), + }, + }) + + app.Window.New(). + SetTitle("WebviewWindow 1"). + Show() + + // Create a custom menu + menu := app.NewMenu() + if runtime.GOOS == "darwin" { + menu.AddRole(application.AppMenu) + } + + windowCounter := 1 + + // Let's make a "Demo" menu + myMenu := menu.AddSubmenu("New") + + myMenu.Add("New WebviewWindow"). + SetAccelerator("CmdOrCtrl+N"). + OnClick(func(ctx *application.Context) { + app.Window.New(). + SetTitle("WebviewWindow "+strconv.Itoa(windowCounter)). + SetRelativePosition(rand.Intn(1000), rand.Intn(800)). + Show() + windowCounter++ + }) + + app.Menu.Set(menu) + err := app.Run() + + if err != nil { + log.Fatal(err) + } + +} diff --git a/v3/examples/window-menu/README.md b/v3/examples/window-menu/README.md new file mode 100644 index 000000000..0d825364f --- /dev/null +++ b/v3/examples/window-menu/README.md @@ -0,0 +1,24 @@ +# Window Menu Example + +*** Windows Only *** + +This example demonstrates how to create a window with a menu bar that can be toggled using the window.ToggleMenuBar() method. + +## Features + +- Default menu bar with File, Edit, and Help menus +- F1 key to toggle menu bar visibility +- Simple HTML interface with instructions + +## Running the Example + +```bash +cd v3/examples/window-menu +go run . +``` + +## How it Works + +The example creates a window with a default menu and binds the F1 key to toggle the menu bar's visibility. The menu bar will show when F2 is pressed and hide when F3 is released. + +Note: The menu bar toggling functionality only works on Windows. On other platforms, the F1 key binding will have no effect. diff --git a/v3/examples/window-menu/assets/about.html b/v3/examples/window-menu/assets/about.html new file mode 100644 index 000000000..e887a84ce --- /dev/null +++ b/v3/examples/window-menu/assets/about.html @@ -0,0 +1,14 @@ + + + Window Menu Demo + + + +
                    +

                    About Window Menu Demo

                    +

                    Press F1 to toggle menu bar visibility

                    +

                    Press F2 to show menu bar

                    +

                    Press F3 to hide menu bar

                    +
                    + + \ No newline at end of file diff --git a/v3/examples/window-menu/assets/index.html b/v3/examples/window-menu/assets/index.html new file mode 100644 index 000000000..b18f601e0 --- /dev/null +++ b/v3/examples/window-menu/assets/index.html @@ -0,0 +1,48 @@ + + + Window Menu Demo + + + +
                    +

                    Window Menu Demo

                    +

                    This example demonstrates the menu bar visibility toggle feature.

                    +

                    Press F1 to toggle the menu bar.

                    +

                    Press F2 to show the menu bar.

                    +

                    Press F3 to hide the menu bar.

                    +

                    The menu includes:

                    +
                      +
                    • File menu with Exit option
                    • +
                    • MenuBar menu with Hide options
                    • +
                    • Help menu with About
                    • +
                    +
                    + + \ No newline at end of file diff --git a/v3/examples/window-menu/assets/style.css b/v3/examples/window-menu/assets/style.css new file mode 100644 index 000000000..c7fc71f39 --- /dev/null +++ b/v3/examples/window-menu/assets/style.css @@ -0,0 +1,26 @@ +body { + font-family: system-ui, -apple-system, sans-serif; + margin: 0; + padding: 2rem; + background: #f5f5f5; + color: #333; +} +.container { + max-width: 600px; + margin: 0 auto; + background: white; + padding: 2rem; + border-radius: 8px; + box-shadow: 0 2px 4px rgba(0,0,0,0.1); +} +h1 { + margin-top: 0; + color: #2d2d2d; +} +.key { + background: #e9e9e9; + padding: 2px 8px; + border-radius: 4px; + border: 1px solid #ccc; + font-family: monospace; +} diff --git a/v3/examples/window-menu/main.go b/v3/examples/window-menu/main.go new file mode 100644 index 000000000..107213b44 --- /dev/null +++ b/v3/examples/window-menu/main.go @@ -0,0 +1,64 @@ +package main + +import ( + "embed" + _ "embed" + "github.com/wailsapp/wails/v3/pkg/application" + "log" +) + +//go:embed assets/* +var assets embed.FS + +func main() { + app := application.New(application.Options{ + Name: "Window MenuBar Demo", + Description: "A demo of menu bar toggling", + Assets: application.AssetOptions{ + Handler: application.BundledAssetFileServer(assets), + }, + }) + + // Create a menu + menu := app.NewMenu() + fileMenu := menu.AddSubmenu("File") + fileMenu.Add("Exit").OnClick(func(ctx *application.Context) { + app.Quit() + }) + + editMenu := menu.AddSubmenu("MenuBar") + editMenu.Add("Hide MenuBar").OnClick(func(ctx *application.Context) { + app.Window.Current().HideMenuBar() + }) + + helpMenu := menu.AddSubmenu("Help") + helpMenu.Add("About").OnClick(func(ctx *application.Context) { + app.Window.Current().SetURL("/about.html") + }) + + // Create window with menu + app.Window.NewWithOptions(application.WebviewWindowOptions{ + Title: "Window MenuBar Demo", + Width: 800, + Height: 600, + Windows: application.WindowsWindow{ + Menu: menu, + }, + KeyBindings: map[string]func(window application.Window){ + "F1": func(window application.Window) { + window.ToggleMenuBar() + }, + "F2": func(window application.Window) { + window.ShowMenuBar() + }, + "F3": func(window application.Window) { + window.HideMenuBar() + }, + }, + }) + + err := app.Run() + if err != nil { + log.Fatal(err) + } +} diff --git a/v3/examples/window/README.md b/v3/examples/window/README.md new file mode 100644 index 000000000..2f1c7e810 --- /dev/null +++ b/v3/examples/window/README.md @@ -0,0 +1,19 @@ +# Window Example + +This example is a demonstration of the Windows API. + +## Running the example + +To run the example, simply run the following command: + +```bash +go run . +``` + +# Status + +| Platform | Status | +|----------|---------| +| Mac | | +| Windows | Working | +| Linux | | diff --git a/v3/examples/window/assets/index.html b/v3/examples/window/assets/index.html new file mode 100644 index 000000000..16baa68ff --- /dev/null +++ b/v3/examples/window/assets/index.html @@ -0,0 +1,90 @@ + + + + + + Window Demo + + + + + +
                    +
                    + +
                    +
                    +
                    + +
                    + +  X: + + +  Width: + + +   + + +
                    + + + +   + + + +   + +
                    + + + + + + \ No newline at end of file diff --git a/v3/examples/window/main.go b/v3/examples/window/main.go new file mode 100644 index 000000000..a70cc1e8a --- /dev/null +++ b/v3/examples/window/main.go @@ -0,0 +1,761 @@ +package main + +import ( + "embed" + "fmt" + "log" + "math/rand" + "runtime" + "strconv" + "time" + + "github.com/samber/lo" + "github.com/wailsapp/wails/v3/pkg/events" + + "github.com/wailsapp/wails/v3/pkg/application" +) + +// This is a stub for non-windows platforms +var getExStyle = func() int { + return 0 +} + +//go:embed assets/* +var assets embed.FS + +type WindowService struct{} + +// ============================================== +func (s *WindowService) SetPos(relative bool, x, y float64) { + win := application.Get().Window.Current() + initX, initY := win.Position() + if relative { + x += float64(initX) + y += float64(initY) + } + win.SetPosition(int(x), int(y)) + currentX, currentY := win.Position() + fmt.Printf("SetPos: %d, %d => %d, %d\n", initX, initY, currentX, currentY) +} +func (s *WindowService) SetSize(relative bool, wdt, hgt float64) { + win := application.Get().Window.Current() + initW, initH := win.Size() + if relative { + wdt += float64(initW) + hgt += float64(initH) + } + win.SetSize(int(wdt), int(hgt)) + currentW, currentH := win.Size() + fmt.Printf("SetSize: %d, %d => %d, %d\n", initW, initH, currentW, currentH) +} +func (s *WindowService) SetBounds(x, y, w, h float64) { + win := application.Get().Window.Current() + initR := win.Bounds() + win.SetBounds(application.Rect{ + X: int(x), + Y: int(y), + Width: int(w), + Height: int(h), + }) + currentR := win.Bounds() + fmt.Printf("SetBounds: %+v => %+v\n", initR, currentR) +} +func (s *WindowService) GetBounds() application.Rect { + win := application.Get().Window.Current() + r := win.Bounds() + mid := r.X + (r.Width-1)/2 + fmt.Printf("GetBounds: %+v: mid: %d\n", r, mid) + return r +} + +// ============================================== + +func main() { + app := application.New(application.Options{ + Name: "WebviewWindow Demo", + Description: "A demo of the WebviewWindow API", + Assets: application.AssetOptions{ + Handler: application.BundledAssetFileServer(assets), + }, + Mac: application.MacOptions{ + ApplicationShouldTerminateAfterLastWindowClosed: false, + }, + Services: []application.Service{ + application.NewService(&WindowService{}), + }, + }) + app.Event.OnApplicationEvent(events.Common.ApplicationStarted, func(event *application.ApplicationEvent) { + log.Println("ApplicationDidFinishLaunching") + }) + + var hiddenWindows []application.Window + + currentWindow := func(fn func(window application.Window)) { + if app.Window.Current() != nil { + fn(app.Window.Current()) + } else { + println("Current Window is nil") + } + } + + // Create a custom menu + menu := app.NewMenu() + if runtime.GOOS == "darwin" { + menu.AddRole(application.AppMenu) + } else { + menu.AddRole(application.FileMenu) + } + windowCounter := 1 + + // Let's make a "Demo" menu + myMenu := menu.AddSubmenu("New") + + myMenu.Add("New WebviewWindow"). + SetAccelerator("CmdOrCtrl+N"). + OnClick(func(ctx *application.Context) { + app.Window.New(). + SetTitle("WebviewWindow "+strconv.Itoa(windowCounter)). + SetRelativePosition(rand.Intn(1000), rand.Intn(800)). + SetURL("https://wails.io"). + Show() + windowCounter++ + }) + if runtime.GOOS != "linux" { + myMenu.Add("New WebviewWindow (Content Protection Enabled)"). + OnClick(func(ctx *application.Context) { + app.Window.NewWithOptions(application.WebviewWindowOptions{ + MinimiseButtonState: application.ButtonDisabled, + ContentProtectionEnabled: true, + }). + SetTitle("WebviewWindow "+strconv.Itoa(windowCounter)). + SetRelativePosition(rand.Intn(1000), rand.Intn(800)). + SetURL("https://wails.io"). + Show() + windowCounter++ + }) + myMenu.Add("New WebviewWindow (Disable Minimise)"). + OnClick(func(ctx *application.Context) { + app.Window.NewWithOptions(application.WebviewWindowOptions{ + MinimiseButtonState: application.ButtonDisabled, + }). + SetTitle("WebviewWindow "+strconv.Itoa(windowCounter)). + SetRelativePosition(rand.Intn(1000), rand.Intn(800)). + SetURL("https://wails.io"). + Show() + windowCounter++ + }) + myMenu.Add("New WebviewWindow (Disable Maximise)"). + OnClick(func(ctx *application.Context) { + app.Window.NewWithOptions(application.WebviewWindowOptions{ + MaximiseButtonState: application.ButtonDisabled, + }). + SetTitle("WebviewWindow "+strconv.Itoa(windowCounter)). + SetRelativePosition(rand.Intn(1000), rand.Intn(800)). + SetURL("https://wails.io"). + Show() + windowCounter++ + }) + myMenu.Add("New WebviewWindow (Hide Minimise)"). + OnClick(func(ctx *application.Context) { + app.Window.NewWithOptions(application.WebviewWindowOptions{ + MinimiseButtonState: application.ButtonHidden, + }). + SetTitle("WebviewWindow "+strconv.Itoa(windowCounter)). + SetRelativePosition(rand.Intn(1000), rand.Intn(800)). + SetURL("https://wails.io"). + Show() + windowCounter++ + }) + myMenu.Add("New WebviewWindow (Always on top)"). + OnClick(func(ctx *application.Context) { + app.Window.NewWithOptions(application.WebviewWindowOptions{ + AlwaysOnTop: true, + }). + SetTitle("WebviewWindow "+strconv.Itoa(windowCounter)). + SetRelativePosition(rand.Intn(1000), rand.Intn(800)). + SetURL("https://wails.io"). + Show() + windowCounter++ + }) + myMenu.Add("New WebviewWindow (Hide Maximise)"). + OnClick(func(ctx *application.Context) { + app.Window.NewWithOptions(application.WebviewWindowOptions{ + MaximiseButtonState: application.ButtonHidden, + }). + SetTitle("WebviewWindow "+strconv.Itoa(windowCounter)). + SetRelativePosition(rand.Intn(1000), rand.Intn(800)). + SetURL("https://wails.io"). + Show() + windowCounter++ + }) + + myMenu.Add("New WebviewWindow (Centered)"). + OnClick(func(ctx *application.Context) { + app.Window.NewWithOptions(application.WebviewWindowOptions{ + MaximiseButtonState: application.ButtonHidden, + InitialPosition: application.WindowCentered, + }). + SetTitle("WebviewWindow " + strconv.Itoa(windowCounter)). + SetURL("https://wails.io"). + Show() + windowCounter++ + }) + + myMenu.Add("New WebviewWindow (Position 100,100)"). + OnClick(func(ctx *application.Context) { + app.Window.NewWithOptions(application.WebviewWindowOptions{ + MaximiseButtonState: application.ButtonHidden, + X: 100, + Y: 100, + InitialPosition: application.WindowXY, + }). + SetTitle("WebviewWindow " + strconv.Itoa(windowCounter)). + SetURL("https://wails.io"). + Show() + windowCounter++ + }) + } + if runtime.GOOS == "darwin" || runtime.GOOS == "windows" { + myMenu.Add("New WebviewWindow (Disable Close)"). + OnClick(func(ctx *application.Context) { + app.Window.NewWithOptions(application.WebviewWindowOptions{ + CloseButtonState: application.ButtonDisabled, + }). + SetTitle("WebviewWindow "+strconv.Itoa(windowCounter)). + SetRelativePosition(rand.Intn(1000), rand.Intn(800)). + SetURL("https://wails.io"). + Show() + windowCounter++ + }) + myMenu.Add("New WebviewWindow (Hide Close)"). + OnClick(func(ctx *application.Context) { + app.Window.NewWithOptions(application.WebviewWindowOptions{ + CloseButtonState: application.ButtonHidden, + }). + SetTitle("WebviewWindow "+strconv.Itoa(windowCounter)). + SetRelativePosition(rand.Intn(1000), rand.Intn(800)). + SetURL("https://wails.io"). + Show() + windowCounter++ + }) + + } + + if runtime.GOOS == "windows" { + myMenu.Add("New WebviewWindow (Custom ExStyle)"). + OnClick(func(ctx *application.Context) { + app.Window.NewWithOptions(application.WebviewWindowOptions{ + Windows: application.WindowsWindow{ + ExStyle: getExStyle(), + }, + }). + SetTitle("WebviewWindow "+strconv.Itoa(windowCounter)). + SetRelativePosition(rand.Intn(1000), rand.Intn(800)). + SetURL("https://wails.io"). + Show() + windowCounter++ + }) + } + myMenu.Add("New WebviewWindow (Listen to Move)"). + OnClick(func(ctx *application.Context) { + w := app.Window.NewWithOptions(application.WebviewWindowOptions{}). + SetTitle("WebviewWindow "+strconv.Itoa(windowCounter)). + SetRelativePosition(rand.Intn(1000), rand.Intn(800)). + SetURL("https://wails.io"). + Show() + w.OnWindowEvent(events.Common.WindowDidMove, func(event *application.WindowEvent) { + x, y := w.Position() + fmt.Printf("WindowDidMove event triggered. New position: (%d, %d)\n", x, y) + }) + windowCounter++ + }) + myMenu.Add("New WebviewWindow (Listen to Resize)"). + OnClick(func(ctx *application.Context) { + w := app.Window.NewWithOptions(application.WebviewWindowOptions{}). + SetTitle("WebviewWindow "+strconv.Itoa(windowCounter)). + SetRelativePosition(rand.Intn(1000), rand.Intn(800)). + SetURL("https://wails.io"). + Show() + w.OnWindowEvent(events.Common.WindowDidResize, func(event *application.WindowEvent) { + width, height := w.Size() + + fmt.Printf("WindowDidResize event triggered. New size: (%d, %d)\n", width, height) + }) + windowCounter++ + }) + myMenu.Add("New WebviewWindow (Hides on Close one time)"). + SetAccelerator("CmdOrCtrl+H"). + OnClick(func(ctx *application.Context) { + var w application.Window = app.Window.New() + + w.RegisterHook(events.Common.WindowClosing, func(e *application.WindowEvent) { + if !lo.Contains(hiddenWindows, w) { + hiddenWindows = append(hiddenWindows, w) + go func() { + time.Sleep(5 * time.Second) + w.Show() + }() + w.Hide() + e.Cancel() + } + // Remove the window from the hiddenWindows list + hiddenWindows = lo.Without(hiddenWindows, w) + }) + + w.SetTitle("WebviewWindow "+strconv.Itoa(windowCounter)). + SetRelativePosition(rand.Intn(1000), rand.Intn(800)). + SetURL("https://wails.io"). + Show() + + windowCounter++ + + }) + myMenu.Add("New WebviewWindow (Frameless)"). + SetAccelerator("CmdOrCtrl+F"). + OnClick(func(ctx *application.Context) { + app.Window.NewWithOptions(application.WebviewWindowOptions{ + X: rand.Intn(1000), + Y: rand.Intn(800), + BackgroundColour: application.NewRGB(33, 37, 41), + Frameless: true, + Mac: application.MacWindow{ + InvisibleTitleBarHeight: 50, + }, + }).Show() + windowCounter++ + }) + myMenu.Add("New WebviewWindow (Ignores mouse events)"). + SetAccelerator("CmdOrCtrl+F"). + OnClick(func(ctx *application.Context) { + app.Window.NewWithOptions(application.WebviewWindowOptions{ + HTML: "
                    ", + X: rand.Intn(1000), + Y: rand.Intn(800), + IgnoreMouseEvents: true, + BackgroundType: application.BackgroundTypeTransparent, + Mac: application.MacWindow{ + InvisibleTitleBarHeight: 50, + }, + }).Show() + windowCounter++ + }) + if runtime.GOOS == "darwin" { + myMenu.Add("New WebviewWindow (MacTitleBarHiddenInset)"). + OnClick(func(ctx *application.Context) { + app.Window.NewWithOptions(application.WebviewWindowOptions{ + Mac: application.MacWindow{ + TitleBar: application.MacTitleBarHiddenInset, + InvisibleTitleBarHeight: 25, + }, + }). + SetBackgroundColour(application.NewRGB(33, 37, 41)). + SetTitle("WebviewWindow "+strconv.Itoa(windowCounter)). + SetRelativePosition(rand.Intn(1000), rand.Intn(800)). + SetHTML("

                    A MacTitleBarHiddenInset WebviewWindow example

                    "). + Show() + windowCounter++ + }) + myMenu.Add("New WebviewWindow (MacTitleBarHiddenInsetUnified)"). + OnClick(func(ctx *application.Context) { + app.Window.NewWithOptions(application.WebviewWindowOptions{ + Mac: application.MacWindow{ + TitleBar: application.MacTitleBarHiddenInsetUnified, + InvisibleTitleBarHeight: 50, + }, + }). + SetTitle("WebviewWindow "+strconv.Itoa(windowCounter)). + SetRelativePosition(rand.Intn(1000), rand.Intn(800)). + SetHTML("

                    A MacTitleBarHiddenInsetUnified WebviewWindow example

                    "). + Show() + windowCounter++ + }) + myMenu.Add("New WebviewWindow (MacTitleBarHidden)"). + OnClick(func(ctx *application.Context) { + app.Window.NewWithOptions(application.WebviewWindowOptions{ + Mac: application.MacWindow{ + TitleBar: application.MacTitleBarHidden, + InvisibleTitleBarHeight: 25, + }, + }). + SetTitle("WebviewWindow "+strconv.Itoa(windowCounter)). + SetRelativePosition(rand.Intn(1000), rand.Intn(800)). + SetHTML("

                    A MacTitleBarHidden WebviewWindow example

                    "). + Show() + windowCounter++ + }) + } + if runtime.GOOS == "windows" { + myMenu.Add("New WebviewWindow (Mica)"). + OnClick(func(ctx *application.Context) { + app.Window.NewWithOptions(application.WebviewWindowOptions{ + Title: "WebviewWindow " + strconv.Itoa(windowCounter), + X: rand.Intn(1000), + Y: rand.Intn(800), + BackgroundType: application.BackgroundTypeTranslucent, + HTML: ` + + + + + +
                    +

                    This is a Window with a Mica backdrop

                    +
                    + +`, + Windows: application.WindowsWindow{ + BackdropType: application.Mica, + }, + }).Show() + windowCounter++ + }) + myMenu.Add("New WebviewWindow (Acrylic)"). + OnClick(func(ctx *application.Context) { + app.Window.NewWithOptions(application.WebviewWindowOptions{ + Title: "WebviewWindow " + strconv.Itoa(windowCounter), + X: rand.Intn(1000), + Y: rand.Intn(800), + BackgroundType: application.BackgroundTypeTranslucent, + HTML: ` + + + + + +
                    +

                    This is a Window with an Acrylic backdrop

                    +
                    + +`, + Windows: application.WindowsWindow{ + BackdropType: application.Acrylic, + }, + }).Show() + windowCounter++ + }) + myMenu.Add("New WebviewWindow (Tabbed)"). + OnClick(func(ctx *application.Context) { + app.Window.NewWithOptions(application.WebviewWindowOptions{ + Title: "WebviewWindow " + strconv.Itoa(windowCounter), + X: rand.Intn(1000), + Y: rand.Intn(800), + BackgroundType: application.BackgroundTypeTranslucent, + HTML: ` + + + + + +
                    +

                    This is a Window with a Tabbed-effect backdrop

                    +
                    + +`, + Windows: application.WindowsWindow{ + BackdropType: application.Tabbed, + }, + }).Show() + windowCounter++ + }) + } + + sizeMenu := menu.AddSubmenu("Size") + sizeMenu.Add("Set Size (800,600)").OnClick(func(ctx *application.Context) { + currentWindow(func(w application.Window) { + w.SetSize(800, 600) + }) + }) + + sizeMenu.Add("Set Size (Random)").OnClick(func(ctx *application.Context) { + currentWindow(func(w application.Window) { + w.SetSize(rand.Intn(800)+200, rand.Intn(600)+200) + }) + }) + sizeMenu.Add("Set Min Size (200,200)").OnClick(func(ctx *application.Context) { + currentWindow(func(w application.Window) { + w.SetMinSize(200, 200) + }) + }) + sizeMenu.Add("Set Max Size (600,600)").OnClick(func(ctx *application.Context) { + currentWindow(func(w application.Window) { + w.SetMaxSize(600, 600) + w.SetMaximiseButtonState(application.ButtonDisabled) + }) + }) + sizeMenu.Add("Get Current WebviewWindow Size").OnClick(func(ctx *application.Context) { + currentWindow(func(w application.Window) { + width, height := w.Size() + app.Dialog.Info().SetTitle("Current WebviewWindow Size").SetMessage("Width: " + strconv.Itoa(width) + " Height: " + strconv.Itoa(height)).Show() + }) + }) + + sizeMenu.Add("Reset Min Size").OnClick(func(ctx *application.Context) { + currentWindow(func(w application.Window) { + w.SetMinSize(0, 0) + }) + }) + sizeMenu.Add("Reset Max Size").OnClick(func(ctx *application.Context) { + currentWindow(func(w application.Window) { + w.SetMaxSize(0, 0) + w.SetMaximiseButtonState(application.ButtonEnabled) + }) + }) + + positionMenu := menu.AddSubmenu("Position") + positionMenu.Add("Set Position (0,0)").OnClick(func(ctx *application.Context) { + currentWindow(func(w application.Window) { + w.SetPosition(0, 0) + }) + }) + + positionMenu.Add("Set Position (Random)").OnClick(func(ctx *application.Context) { + currentWindow(func(w application.Window) { + w.SetPosition(rand.Intn(1000), rand.Intn(800)) + }) + }) + + positionMenu.Add("Get Position").OnClick(func(ctx *application.Context) { + currentWindow(func(w application.Window) { + x, y := w.Position() + app.Dialog.Info().SetTitle("Current WebviewWindow Position").SetMessage("X: " + strconv.Itoa(x) + " Y: " + strconv.Itoa(y)).Show() + }) + }) + + positionMenu.Add("Set Relative Position (0,0)").OnClick(func(ctx *application.Context) { + currentWindow(func(w application.Window) { + w.SetRelativePosition(0, 0) + }) + }) + positionMenu.Add("Set Relative Position (Corner)").OnClick(func(ctx *application.Context) { + currentWindow(func(w application.Window) { + screen, _ := w.GetScreen() + w.SetRelativePosition(screen.WorkArea.Width-w.Width(), screen.WorkArea.Height-w.Height()) + }) + }) + positionMenu.Add("Set Relative Position (Random)").OnClick(func(ctx *application.Context) { + currentWindow(func(w application.Window) { + w.SetRelativePosition(rand.Intn(1000), rand.Intn(800)) + }) + }) + + positionMenu.Add("Get Relative Position").OnClick(func(ctx *application.Context) { + currentWindow(func(w application.Window) { + x, y := w.RelativePosition() + app.Dialog.Info().SetTitle("Current WebviewWindow Position").SetMessage("X: " + strconv.Itoa(x) + " Y: " + strconv.Itoa(y)).Show() + }) + }) + + positionMenu.Add("Center").OnClick(func(ctx *application.Context) { + currentWindow(func(w application.Window) { + w.Center() + }) + }) + titleBarMenu := menu.AddSubmenu("Controls") + titleBarMenu.Add("Disable Minimise").OnClick(func(ctx *application.Context) { + currentWindow(func(w application.Window) { + w.SetMinimiseButtonState(application.ButtonDisabled) + }) + }) + titleBarMenu.Add("Enable Minimise").OnClick(func(ctx *application.Context) { + currentWindow(func(w application.Window) { + w.SetMinimiseButtonState(application.ButtonEnabled) + }) + }) + titleBarMenu.Add("Hide Minimise").OnClick(func(ctx *application.Context) { + currentWindow(func(w application.Window) { + w.SetMinimiseButtonState(application.ButtonHidden) + }) + }) + titleBarMenu.Add("Disable Maximise").OnClick(func(ctx *application.Context) { + currentWindow(func(w application.Window) { + w.SetMaximiseButtonState(application.ButtonDisabled) + }) + }) + titleBarMenu.Add("Enable Maximise").OnClick(func(ctx *application.Context) { + currentWindow(func(w application.Window) { + w.SetMaximiseButtonState(application.ButtonEnabled) + }) + }) + titleBarMenu.Add("Hide Maximise").OnClick(func(ctx *application.Context) { + currentWindow(func(w application.Window) { + w.SetMaximiseButtonState(application.ButtonHidden) + }) + }) + titleBarMenu.Add("Disable Close").OnClick(func(ctx *application.Context) { + currentWindow(func(w application.Window) { + w.SetCloseButtonState(application.ButtonDisabled) + }) + }) + titleBarMenu.Add("Enable Close").OnClick(func(ctx *application.Context) { + currentWindow(func(w application.Window) { + w.SetCloseButtonState(application.ButtonEnabled) + }) + }) + titleBarMenu.Add("Hide Close").OnClick(func(ctx *application.Context) { + currentWindow(func(w application.Window) { + w.SetCloseButtonState(application.ButtonHidden) + }) + }) + stateMenu := menu.AddSubmenu("State") + stateMenu.Add("Minimise (for 2 secs)").OnClick(func(ctx *application.Context) { + currentWindow(func(w application.Window) { + w.Minimise() + time.Sleep(2 * time.Second) + w.Restore() + }) + }) + stateMenu.Add("Maximise").OnClick(func(ctx *application.Context) { + currentWindow(func(w application.Window) { + w.Maximise() + }) + }) + stateMenu.Add("Fullscreen").OnClick(func(ctx *application.Context) { + currentWindow(func(w application.Window) { + w.Fullscreen() + }) + }) + stateMenu.Add("UnFullscreen").OnClick(func(ctx *application.Context) { + currentWindow(func(w application.Window) { + w.UnFullscreen() + }) + }) + stateMenu.Add("Restore").OnClick(func(ctx *application.Context) { + currentWindow(func(w application.Window) { + w.Restore() + }) + }) + stateMenu.Add("Hide (for 2 seconds)").OnClick(func(ctx *application.Context) { + currentWindow(func(w application.Window) { + w.Hide() + time.Sleep(2 * time.Second) + w.Show() + }) + }) + stateMenu.Add("Always on Top").OnClick(func(ctx *application.Context) { + currentWindow(func(w application.Window) { + w.SetAlwaysOnTop(true) + }) + }) + stateMenu.Add("Not always on Top").OnClick(func(ctx *application.Context) { + currentWindow(func(w application.Window) { + w.SetAlwaysOnTop(false) + }) + }) + stateMenu.Add("Google.com").OnClick(func(ctx *application.Context) { + currentWindow(func(w application.Window) { + w.SetURL("https://google.com") + }) + }) + stateMenu.Add("wails.io").OnClick(func(ctx *application.Context) { + currentWindow(func(w application.Window) { + w.SetURL("https://wails.io") + }) + }) + stateMenu.Add("Get Primary Screen").OnClick(func(ctx *application.Context) { + screen := app.Screen.GetPrimary() + msg := fmt.Sprintf("Screen: %+v", screen) + app.Dialog.Info().SetTitle("Primary Screen").SetMessage(msg).Show() + }) + stateMenu.Add("Get Screens").OnClick(func(ctx *application.Context) { + screens := app.Screen.GetAll() + for _, screen := range screens { + msg := fmt.Sprintf("Screen: %+v", screen) + app.Dialog.Info().SetTitle(fmt.Sprintf("Screen %s", screen.ID)).SetMessage(msg).Show() + } + }) + stateMenu.Add("Get Screen for WebviewWindow").OnClick(func(ctx *application.Context) { + currentWindow(func(w application.Window) { + screen, err := w.GetScreen() + if err != nil { + app.Dialog.Error().SetTitle("Error").SetMessage(err.Error()).Show() + return + } + msg := fmt.Sprintf("Screen: %+v", screen) + app.Dialog.Info().SetTitle(fmt.Sprintf("Screen %s", screen.ID)).SetMessage(msg).Show() + }) + }) + stateMenu.Add("Disable for 5s").OnClick(func(ctx *application.Context) { + currentWindow(func(w application.Window) { + w.SetEnabled(false) + time.Sleep(5 * time.Second) + w.SetEnabled(true) + }) + }) + stateMenu.Add("Open Dev Tools").OnClick(func(ctx *application.Context) { + currentWindow(func(w application.Window) { + w.OpenDevTools() + }) + }) + + if runtime.GOOS != "darwin" { + stateMenu.Add("Flash for 5s").OnClick(func(ctx *application.Context) { + currentWindow(func(w application.Window) { + time.Sleep(2 * time.Second) + w.Flash(true) + time.Sleep(5 * time.Second) + w.Flash(false) + }) + }) + } + + if runtime.GOOS == "windows" { + stateMenu.Add("Snap Assist").OnClick(func(ctx *application.Context) { + currentWindow(func(w application.Window) { + w.SnapAssist() + }) + }) + } + + printMenu := menu.AddSubmenu("Print") + printMenu.Add("Print").OnClick(func(ctx *application.Context) { + currentWindow(func(w application.Window) { + _ = w.Print() + }) + }) + + app.Window.NewWithOptions(application.WebviewWindowOptions{ + Title: "Window Demo", + BackgroundColour: application.NewRGB(33, 37, 41), + Mac: application.MacWindow{ + DisableShadow: true, + }, + Windows: application.WindowsWindow{ + Menu: menu, + }, + }) + + app.Menu.Set(menu) + err := app.Run() + + if err != nil { + log.Fatal(err) + } + +} diff --git a/v3/examples/window/windows.go b/v3/examples/window/windows.go new file mode 100644 index 000000000..d66984d18 --- /dev/null +++ b/v3/examples/window/windows.go @@ -0,0 +1,11 @@ +//go:build windows + +package main + +import "github.com/wailsapp/wails/v3/pkg/w32" + +func init() { + getExStyle = func() int { + return w32.WS_EX_TOOLWINDOW | w32.WS_EX_NOREDIRECTIONBITMAP | w32.WS_EX_TOPMOST + } +} diff --git a/v3/examples/wml/README.md b/v3/examples/wml/README.md new file mode 100644 index 000000000..c8ea7850e --- /dev/null +++ b/v3/examples/wml/README.md @@ -0,0 +1,19 @@ +# WML Example + +This is an example of how to use the experimental WML, which provides HTMX style calling of the Wails JS API. + +## Running the example + +To run the example, simply run the following command: + +```bash +go run . +``` + +# Status + +| Platform | Status | +|----------|---------| +| Mac | Working | +| Windows | Working | +| Linux | | diff --git a/v3/examples/wml/assets/index.html b/v3/examples/wml/assets/index.html new file mode 100644 index 000000000..466f4c5f0 --- /dev/null +++ b/v3/examples/wml/assets/index.html @@ -0,0 +1,160 @@ + + + + + Wails Alpha + + + + + +
                    Alpha
                    +
                    +

                    Documentation

                    +

                    Feedback

                    +
                    +

                    This application contains no Javascript!

                    +

                    Emit event

                    +

                    Delete all the things!

                    +

                    Close the Window?

                    +

                    Center

                    +

                    Minimise

                    +

                    Maximise

                    +

                    UnMaximise

                    +

                    Fullscreen

                    +

                    UnFullscreen

                    +

                    Restore

                    +

                    Open Browser?

                    +

                    Hover over me

                    +
                    + + + + + diff --git a/v3/examples/wml/main.go b/v3/examples/wml/main.go new file mode 100644 index 000000000..8d4a55481 --- /dev/null +++ b/v3/examples/wml/main.go @@ -0,0 +1,50 @@ +package main + +import ( + "embed" + _ "embed" + "log" + + "github.com/wailsapp/wails/v3/pkg/application" +) + +//go:embed assets/* +var assets embed.FS + +func main() { + + app := application.New(application.Options{ + Name: "Wails ML Demo", + Description: "A demo of the Wails ML API", + Mac: application.MacOptions{ + ApplicationShouldTerminateAfterLastWindowClosed: true, + }, + Assets: application.AssetOptions{ + Handler: application.BundledAssetFileServer(assets), + }, + }) + + app.Window.NewWithOptions(application.WebviewWindowOptions{ + Title: "Wails ML Demo", + Width: 1280, + Height: 1024, + Mac: application.MacWindow{ + Backdrop: application.MacBackdropTranslucent, + TitleBar: application.MacTitleBarHiddenInsetUnified, + InvisibleTitleBarHeight: 50, + }, + }) + + app.Event.On("button-pressed", func(_ *application.CustomEvent) { + println("Button Pressed!") + }) + app.Event.On("hover", func(_ *application.CustomEvent) { + println("Hover time!") + }) + + err := app.Run() + + if err != nil { + log.Fatal(err.Error()) + } +} diff --git a/v3/fix-darwin-ios-constraints.sh b/v3/fix-darwin-ios-constraints.sh new file mode 100644 index 000000000..67211e7b9 --- /dev/null +++ b/v3/fix-darwin-ios-constraints.sh @@ -0,0 +1,54 @@ +#!/bin/bash + +# Fix build constraints for Darwin files to exclude iOS +echo "Fixing build constraints to exclude iOS from Darwin builds..." + +# List of files that need updating +files=( + "pkg/application/webview_window_darwin.m" + "pkg/application/webview_window_darwin.h" + "pkg/application/webview_window_darwin.go" + "pkg/application/webview_window_darwin_drag.m" + "pkg/application/webview_window_darwin_drag.h" + "pkg/application/webview_window_close_darwin.go" + "pkg/application/systemtray_darwin.m" + "pkg/application/systemtray_darwin.h" + "pkg/application/systemtray_darwin.go" + "pkg/application/single_instance_darwin.go" + "pkg/application/screen_darwin.go" + "pkg/application/menuitem_selectors_darwin.go" + "pkg/application/menuitem_darwin.m" + "pkg/application/menuitem_darwin.go" + "pkg/application/menu_darwin.go" + "pkg/application/mainthread_darwin.go" + "pkg/application/keys_darwin.go" + "pkg/application/events_common_darwin.go" + "pkg/application/dialogs_darwin_delegate.m" + "pkg/application/dialogs_darwin_delegate.h" + "pkg/application/dialogs_darwin.go" + "pkg/application/clipboard_darwin.go" + "pkg/application/application_darwin_delegate.m" + "pkg/application/application_darwin_delegate.h" + "pkg/application/application_darwin.h" +) + +for file in "${files[@]}"; do + if [ -f "$file" ]; then + # Check if file has the build constraint + if grep -q "^//go:build darwin$" "$file"; then + echo "Updating $file" + sed -i '' 's|^//go:build darwin$|//go:build darwin \&\& !ios|' "$file" + fi + fi +done + +# Also check for other darwin-specific files +echo "Checking for other darwin-specific build constraints..." +find . -name "*_darwin*.go" -o -name "*_darwin*.m" -o -name "*_darwin*.h" | while read -r file; do + if grep -q "^//go:build darwin$" "$file"; then + echo "Also updating: $file" + sed -i '' 's|^//go:build darwin$|//go:build darwin \&\& !ios|' "$file" + fi +done + +echo "Done! Build constraints updated." \ No newline at end of file diff --git a/v3/old b/v3/old new file mode 120000 index 000000000..4532eb733 --- /dev/null +++ b/v3/old @@ -0,0 +1 @@ +../../../GolandProjects/ios \ No newline at end of file diff --git a/v3/pkg/doctor-ng/doctor.go b/v3/pkg/doctor-ng/doctor.go new file mode 100644 index 000000000..eed8ceee1 --- /dev/null +++ b/v3/pkg/doctor-ng/doctor.go @@ -0,0 +1,144 @@ +package doctorng + +import ( + "path/filepath" + "runtime" + "runtime/debug" + "strings" + + "github.com/go-git/go-git/v5" + "github.com/samber/lo" + "github.com/wailsapp/wails/v3/internal/operatingsystem" + "github.com/wailsapp/wails/v3/internal/version" +) + +type Doctor struct { + report *Report +} + +func New() *Doctor { + return &Doctor{ + report: NewReport(), + } +} + +func (d *Doctor) Run() (*Report, error) { + if err := d.collectSystemInfo(); err != nil { + return nil, err + } + + if err := d.collectBuildInfo(); err != nil { + return nil, err + } + + if err := d.collectDependencies(); err != nil { + return nil, err + } + + d.runDiagnostics() + d.generateSummary() + + return d.report, nil +} + +func (d *Doctor) collectSystemInfo() error { + info, err := operatingsystem.Info() + if err != nil { + return err + } + + d.report.System.OS = OSInfo{ + Name: info.Name, + Version: info.Version, + ID: info.ID, + Branding: info.Branding, + Platform: runtime.GOOS, + Arch: runtime.GOARCH, + } + + d.report.System.Hardware = collectHardwareInfo() + d.report.System.PlatformExtras = collectPlatformExtras() + + return nil +} + +func (d *Doctor) collectBuildInfo() error { + buildInfo, ok := debug.ReadBuildInfo() + if !ok { + d.report.Build = BuildInfo{ + WailsVersion: version.String(), + GoVersion: runtime.Version(), + } + return nil + } + + settings := make(map[string]string) + for _, s := range buildInfo.Settings { + settings[s.Key] = s.Value + } + + wailsVersion := strings.TrimSpace(version.String()) + wailsPackage, found := lo.Find(buildInfo.Deps, func(dep *debug.Module) bool { + return dep.Path == "github.com/wailsapp/wails/v3" + }) + + if found && wailsPackage != nil && wailsPackage.Replace != nil { + wailsVersion = "(local) => " + filepath.ToSlash(wailsPackage.Replace.Path) + repo, err := git.PlainOpen(filepath.Join(wailsPackage.Replace.Path, "..")) + if err == nil { + head, err := repo.Head() + if err == nil { + wailsVersion += " (" + head.Hash().String()[:8] + ")" + } + } + } + + d.report.Build = BuildInfo{ + WailsVersion: wailsVersion, + GoVersion: runtime.Version(), + BuildMode: settings["-buildmode"], + Compiler: settings["-compiler"], + CGOEnabled: settings["CGO_ENABLED"] == "1", + Settings: settings, + } + + return nil +} + +func (d *Doctor) generateSummary() { + missing := d.report.Dependencies.RequiredMissing() + errCount := 0 + warnCount := 0 + + for _, diag := range d.report.Diagnostics { + switch diag.Severity { + case SeverityError: + errCount++ + case SeverityWarning: + warnCount++ + } + } + + if len(missing) == 0 && errCount == 0 { + d.report.Ready = true + if warnCount > 0 { + d.report.Summary = "System is ready for Wails development with some warnings" + } else { + d.report.Summary = "System is ready for Wails development!" + } + } else { + d.report.Ready = false + var parts []string + if len(missing) > 0 { + parts = append(parts, lo.Ternary(len(missing) == 1, + "1 missing dependency", + string(rune(len(missing)+'0'))+" missing dependencies")) + } + if errCount > 0 { + parts = append(parts, lo.Ternary(errCount == 1, + "1 error", + string(rune(errCount+'0'))+" errors")) + } + d.report.Summary = "System has issues: " + strings.Join(parts, ", ") + } +} diff --git a/v3/pkg/doctor-ng/hardware.go b/v3/pkg/doctor-ng/hardware.go new file mode 100644 index 000000000..ba0967296 --- /dev/null +++ b/v3/pkg/doctor-ng/hardware.go @@ -0,0 +1,119 @@ +package doctorng + +import ( + "bytes" + "os/exec" + "regexp" + "runtime" + "strconv" + "strings" + + "github.com/jaypipes/ghw" +) + +func collectHardwareInfo() HardwareInfo { + hw := HardwareInfo{ + CPUs: make([]CPUInfo, 0), + GPUs: make([]GPUInfo, 0), + Memory: "Unknown", + } + + hw.CPUs = collectCPUs() + hw.GPUs = collectGPUs() + hw.Memory = collectMemory() + + return hw +} + +func collectCPUs() []CPUInfo { + cpus, err := ghw.CPU() + if err != nil || cpus == nil { + return []CPUInfo{{Model: "Unknown"}} + } + + result := make([]CPUInfo, 0, len(cpus.Processors)) + for _, cpu := range cpus.Processors { + result = append(result, CPUInfo{ + Model: cpu.Model, + Cores: int(cpu.NumCores), + }) + } + return result +} + +func collectGPUs() []GPUInfo { + gpu, err := ghw.GPU(ghw.WithDisableWarnings()) + if err == nil && gpu != nil { + result := make([]GPUInfo, 0, len(gpu.GraphicsCards)) + for _, card := range gpu.GraphicsCards { + info := GPUInfo{Name: "Unknown"} + if card.DeviceInfo != nil { + if card.DeviceInfo.Product != nil { + info.Name = card.DeviceInfo.Product.Name + } + if card.DeviceInfo.Vendor != nil { + info.Vendor = card.DeviceInfo.Vendor.Name + } + info.Driver = card.DeviceInfo.Driver + } + result = append(result, info) + } + if len(result) > 0 { + return result + } + } + + if runtime.GOOS == "darwin" { + return collectMacGPU() + } + + return []GPUInfo{{Name: "Unknown"}} +} + +func collectMacGPU() []GPUInfo { + var numCores string + cmd := exec.Command("sh", "-c", "ioreg -l | grep gpu-core-count") + output, err := cmd.Output() + if err == nil { + re := regexp.MustCompile(`= *(\d+)`) + matches := re.FindAllStringSubmatch(string(output), -1) + if len(matches) > 0 { + numCores = matches[0][1] + } + } + + var metalSupport string + cmd = exec.Command("sh", "-c", "system_profiler SPDisplaysDataType | grep Metal") + output, err = cmd.Output() + if err == nil { + metalSupport = strings.TrimSpace(string(output)) + } + + name := "Apple GPU" + if numCores != "" { + name = numCores + " cores" + } + if metalSupport != "" { + name += ", " + metalSupport + } + + return []GPUInfo{{Name: name}} +} + +func collectMemory() string { + memory, err := ghw.Memory() + if err == nil && memory != nil { + return strconv.Itoa(int(memory.TotalPhysicalBytes/1024/1024/1024)) + "GB" + } + + if runtime.GOOS == "darwin" { + cmd := exec.Command("sh", "-c", "system_profiler SPHardwareDataType | grep 'Memory'") + output, err := cmd.Output() + if err == nil { + output = bytes.Replace(output, []byte("Memory: "), []byte(""), 1) + return strings.TrimSpace(string(output)) + } + } + + return "Unknown" +} diff --git a/v3/pkg/doctor-ng/packagemanager/apt.go b/v3/pkg/doctor-ng/packagemanager/apt.go new file mode 100644 index 000000000..af7fccf47 --- /dev/null +++ b/v3/pkg/doctor-ng/packagemanager/apt.go @@ -0,0 +1,101 @@ +//go:build linux + +package packagemanager + +import ( + "regexp" + "strings" +) + +// Apt represents the Apt manager +type Apt struct { + name string + osid string +} + +// NewApt creates a new Apt instance +func NewApt(osid string) *Apt { + return &Apt{ + name: "apt", + osid: osid, + } +} + +// Packages returns the libraries that we need for Wails to compile +// They will potentially differ on different distributions or versions +func (a *Apt) Packages() Packagemap { + return Packagemap{ + "gtk4": []*Package{ + {Name: "libgtk-4-dev", SystemPackage: true, Library: true}, + }, + "webkitgtk-6.0": []*Package{ + {Name: "libwebkitgtk-6.0-dev", SystemPackage: true, Library: true}, + }, + "gtk3 (legacy)": []*Package{ + {Name: "libgtk-3-dev", SystemPackage: true, Library: true, Optional: true}, + }, + "webkit2gtk (legacy)": []*Package{ + {Name: "libwebkit2gtk-4.1-dev", SystemPackage: true, Library: true, Optional: true}, + }, + "gcc": []*Package{ + {Name: "build-essential", SystemPackage: true}, + }, + "pkg-config": []*Package{ + {Name: "pkg-config", SystemPackage: true}, + }, + "npm": []*Package{ + {Name: "npm", SystemPackage: true}, + }, + } +} + +// Name returns the name of the package manager +func (a *Apt) Name() string { + return a.name +} + +func (a *Apt) listPackage(name string) (string, error) { + return execCmd("apt", "list", "-qq", name) +} + +// PackageInstalled tests if the given package name is installed +func (a *Apt) PackageInstalled(pkg *Package) (bool, error) { + if !pkg.SystemPackage { + if pkg.InstallCheck != nil { + return pkg.InstallCheck(), nil + } + return false, nil + } + output, err := a.listPackage(pkg.Name) + // apt list -qq returns "all" if you have packages installed globally and locally + return strings.Contains(output, "installed") || strings.Contains(output, " all"), err +} + +// PackageAvailable tests if the given package is available for installation +func (a *Apt) PackageAvailable(pkg *Package) (bool, error) { + if !pkg.SystemPackage { + return true, nil + } + output, err := a.listPackage(pkg.Name) + // We add a space to ensure we get a full match, not partial match + escapechars, _ := regexp.Compile(`\x1B(?:[@-Z\\-_]|\[[0-?]*[ -/]*[@-~])`) + escapechars.ReplaceAllString(output, "") + installed := strings.HasPrefix(output, pkg.Name) + a.getPackageVersion(pkg, output) + return installed, err +} + +// InstallCommand returns the package manager specific command to install a package +func (a *Apt) InstallCommand(pkg *Package) string { + if !pkg.SystemPackage { + return pkg.InstallCommand + } + return "sudo apt install " + pkg.Name +} + +func (a *Apt) getPackageVersion(pkg *Package, output string) { + splitOutput := strings.Split(output, " ") + if len(splitOutput) > 1 { + pkg.Version = splitOutput[1] + } +} diff --git a/v3/pkg/doctor-ng/packagemanager/dnf.go b/v3/pkg/doctor-ng/packagemanager/dnf.go new file mode 100644 index 000000000..ac873e6d4 --- /dev/null +++ b/v3/pkg/doctor-ng/packagemanager/dnf.go @@ -0,0 +1,129 @@ +//go:build linux + +package packagemanager + +import ( + "os/exec" + "strings" +) + +// Dnf represents the Dnf manager +type Dnf struct { + name string + osid string +} + +// NewDnf creates a new Dnf instance +func NewDnf(osid string) *Dnf { + return &Dnf{ + name: "dnf", + osid: osid, + } +} + +// Packages returns the libraries that we need for Wails to compile +// They will potentially differ on different distributions or versions +func (y *Dnf) Packages() Packagemap { + return Packagemap{ + "gtk4": []*Package{ + {Name: "gtk4-devel", SystemPackage: true, Library: true}, + }, + "webkitgtk-6.0": []*Package{ + {Name: "webkitgtk6.0-devel", SystemPackage: true, Library: true}, + }, + "gtk3 (legacy)": []*Package{ + {Name: "gtk3-devel", SystemPackage: true, Library: true, Optional: true}, + }, + "webkit2gtk (legacy)": []*Package{ + {Name: "webkit2gtk4.1-devel", SystemPackage: true, Library: true, Optional: true}, + {Name: "webkit2gtk3-devel", SystemPackage: true, Library: true, Optional: true}, + }, + "gcc": []*Package{ + {Name: "gcc-c++", SystemPackage: true}, + }, + "pkg-config": []*Package{ + {Name: "pkgconf-pkg-config", SystemPackage: true}, + }, + "npm": []*Package{ + {Name: "npm", SystemPackage: true}, + {Name: "nodejs-npm", SystemPackage: true}, + }, + } +} + +// Name returns the name of the package manager +func (y *Dnf) Name() string { + return y.name +} + +// PackageInstalled tests if the given package name is installed +func (y *Dnf) PackageInstalled(pkg *Package) (bool, error) { + if !pkg.SystemPackage { + if pkg.InstallCheck != nil { + return pkg.InstallCheck(), nil + } + return false, nil + } + stdout, err := execCmd("dnf", "-q", "list", "--installed", pkg.Name) + if err != nil { + _, ok := err.(*exec.ExitError) + if ok { + return false, nil + } + return false, err + } + + // Output format: "package-name.arch version repo" + // e.g., "webkit2gtk4.0-devel.x86_64 2.46.5-1.fc41 @updates" + splitoutput := strings.Split(stdout, "\n") + for _, line := range splitoutput { + if strings.HasPrefix(line, pkg.Name) { + fields := strings.Fields(line) + if len(fields) >= 2 { + pkg.Version = fields[1] + } + return true, nil + } + } + + return false, nil +} + +// PackageAvailable tests if the given package is available for installation +func (y *Dnf) PackageAvailable(pkg *Package) (bool, error) { + if pkg.SystemPackage == false { + return false, nil + } + stdout, err := execCmd("dnf", "info", pkg.Name) + // We add a space to ensure we get a full match, not partial match + if err != nil { + _, ok := err.(*exec.ExitError) + if ok { + return false, nil + } + return false, err + } + splitoutput := strings.Split(stdout, "\n") + for _, line := range splitoutput { + if strings.HasPrefix(line, "Version") { + splitline := strings.Split(line, ":") + pkg.Version = strings.TrimSpace(splitline[1]) + } + } + return true, nil +} + +// InstallCommand returns the package manager specific command to install a package +func (y *Dnf) InstallCommand(pkg *Package) string { + if pkg.SystemPackage == false { + return pkg.InstallCommand + } + return "sudo dnf install " + pkg.Name +} + +func (y *Dnf) getPackageVersion(pkg *Package, output string) { + splitOutput := strings.Split(output, " ") + if len(splitOutput) > 0 { + pkg.Version = splitOutput[1] + } +} diff --git a/v3/pkg/doctor-ng/packagemanager/emerge.go b/v3/pkg/doctor-ng/packagemanager/emerge.go new file mode 100644 index 000000000..910a3f77a --- /dev/null +++ b/v3/pkg/doctor-ng/packagemanager/emerge.go @@ -0,0 +1,119 @@ +//go:build linux + +package packagemanager + +import ( + "os/exec" + "regexp" + "strings" +) + +// Emerge represents the Emerge package manager +type Emerge struct { + name string + osid string +} + +// NewEmerge creates a new Emerge instance +func NewEmerge(osid string) *Emerge { + return &Emerge{ + name: "emerge", + osid: osid, + } +} + +// Packages returns the libraries that we need for Wails to compile +// They will potentially differ on different distributions or versions +func (e *Emerge) Packages() Packagemap { + return Packagemap{ + "gtk4": []*Package{ + {Name: "gui-libs/gtk", SystemPackage: true, Library: true}, + }, + "webkitgtk-6.0": []*Package{ + {Name: "net-libs/webkit-gtk:6", SystemPackage: true, Library: true}, + }, + "gtk3 (legacy)": []*Package{ + {Name: "x11-libs/gtk+:3", SystemPackage: true, Library: true, Optional: true}, + }, + "webkit2gtk (legacy)": []*Package{ + {Name: "net-libs/webkit-gtk:4.1", SystemPackage: true, Library: true, Optional: true}, + {Name: "net-libs/webkit-gtk:4", SystemPackage: true, Library: true, Optional: true}, + }, + "gcc": []*Package{ + {Name: "sys-devel/gcc", SystemPackage: true}, + }, + "pkg-config": []*Package{ + {Name: "dev-util/pkgconf", SystemPackage: true}, + }, + "npm": []*Package{ + {Name: "net-libs/nodejs", SystemPackage: true}, + }, + } +} + +// Name returns the name of the package manager +func (e *Emerge) Name() string { + return e.name +} + +// PackageInstalled tests if the given package name is installed +func (e *Emerge) PackageInstalled(pkg *Package) (bool, error) { + if pkg.SystemPackage == false { + return false, nil + } + stdout, err := execCmd("emerge", "-s", pkg.Name+"$") + if err != nil { + _, ok := err.(*exec.ExitError) + if ok { + return false, nil + } + return false, err + } + + regex := `.*\*\s+` + regexp.QuoteMeta(pkg.Name) + `\n(?:\S|\s)+?Latest version installed: (.*)` + installedRegex := regexp.MustCompile(regex) + matches := installedRegex.FindStringSubmatch(stdout) + pkg.Version = "" + noOfMatches := len(matches) + installed := false + if noOfMatches > 1 && matches[1] != "[ Not Installed ]" { + installed = true + pkg.Version = strings.TrimSpace(matches[1]) + } + return installed, err +} + +// PackageAvailable tests if the given package is available for installation +func (e *Emerge) PackageAvailable(pkg *Package) (bool, error) { + if pkg.SystemPackage == false { + return false, nil + } + stdout, err := execCmd("emerge", "-s", pkg.Name+"$") + // We add a space to ensure we get a full match, not partial match + if err != nil { + _, ok := err.(*exec.ExitError) + if ok { + return false, nil + } + return false, err + } + + installedRegex := regexp.MustCompile(`.*\*\s+` + regexp.QuoteMeta(pkg.Name) + `\n(?:\S|\s)+?Latest version available: (.*)`) + matches := installedRegex.FindStringSubmatch(stdout) + pkg.Version = "" + noOfMatches := len(matches) + available := false + if noOfMatches > 1 { + available = true + pkg.Version = strings.TrimSpace(matches[1]) + } + return available, nil +} + +// InstallCommand returns the package manager specific command to install a package +func (e *Emerge) InstallCommand(pkg *Package) string { + if pkg.SystemPackage == false { + return pkg.InstallCommand + } + return "sudo emerge " + pkg.Name +} diff --git a/v3/pkg/doctor-ng/packagemanager/eopkg.go b/v3/pkg/doctor-ng/packagemanager/eopkg.go new file mode 100644 index 000000000..2bd809822 --- /dev/null +++ b/v3/pkg/doctor-ng/packagemanager/eopkg.go @@ -0,0 +1,117 @@ +//go:build linux + +package packagemanager + +import ( + "regexp" + "strings" +) + +type Eopkg struct { + name string + osid string +} + +// NewEopkg creates a new Eopkg instance +func NewEopkg(osid string) *Eopkg { + result := &Eopkg{ + name: "eopkg", + osid: osid, + } + result.intialiseName() + return result +} + +// Packages returns the packages that we need for Wails to compile +// They will potentially differ on different distributions or versions +func (e *Eopkg) Packages() Packagemap { + return Packagemap{ + "gtk4": []*Package{ + {Name: "libgtk-4-devel", SystemPackage: true, Library: true}, + }, + "webkitgtk-6.0": []*Package{ + {Name: "libwebkit-gtk6-devel", SystemPackage: true, Library: true}, + }, + "gtk3 (legacy)": []*Package{ + {Name: "libgtk-3-devel", SystemPackage: true, Library: true, Optional: true}, + }, + "webkit2gtk (legacy)": []*Package{ + {Name: "libwebkit-gtk-devel", SystemPackage: true, Library: true, Optional: true}, + }, + "gcc": []*Package{ + {Name: "gcc", SystemPackage: true}, + }, + "pkg-config": []*Package{ + {Name: "pkg-config", SystemPackage: true}, + }, + "npm": []*Package{ + {Name: "nodejs", SystemPackage: true}, + }, + } +} + +// Name returns the name of the package manager +func (e *Eopkg) Name() string { + return e.name +} + +// PackageInstalled tests if the given package is installed +func (e *Eopkg) PackageInstalled(pkg *Package) (bool, error) { + if !pkg.SystemPackage { + if pkg.InstallCheck != nil { + return pkg.InstallCheck(), nil + } + return false, nil + } + stdout, err := execCmd("eopkg", "info", pkg.Name) + return strings.HasPrefix(stdout, "Installed"), err +} + +// PackageAvailable tests if the given package is available for installation +func (e *Eopkg) PackageAvailable(pkg *Package) (bool, error) { + if pkg.SystemPackage == false { + return false, nil + } + stdout, err := execCmd("eopkg", "info", pkg.Name) + // We add a space to ensure we get a full match, not partial match + output := e.removeEscapeSequences(stdout) + installed := strings.Contains(output, "Package found in Solus repository") + e.getPackageVersion(pkg, output) + return installed, err +} + +// InstallCommand returns the package manager specific command to install a package +func (e *Eopkg) InstallCommand(pkg *Package) string { + if pkg.SystemPackage == false { + return pkg.InstallCommand + } + return "sudo eopkg it " + pkg.Name +} + +func (e *Eopkg) removeEscapeSequences(in string) string { + escapechars, _ := regexp.Compile(`\x1B(?:[@-Z\\-_]|\[[0-?]*[ -/]*[@-~])`) + return escapechars.ReplaceAllString(in, "") +} + +func (e *Eopkg) intialiseName() { + result := "eopkg" + stdout, err := execCmd("eopkg", "--version") + if err == nil { + result = strings.TrimSpace(stdout) + } + e.name = result +} + +func (e *Eopkg) getPackageVersion(pkg *Package, output string) { + + versionRegex := regexp.MustCompile(`.*Name.*version:\s+(.*)+, release: (.*)`) + matches := versionRegex.FindStringSubmatch(output) + pkg.Version = "" + noOfMatches := len(matches) + if noOfMatches > 1 { + pkg.Version = matches[1] + if noOfMatches > 2 { + pkg.Version += " (r" + matches[2] + ")" + } + } +} diff --git a/v3/pkg/doctor-ng/packagemanager/nixpkgs.go b/v3/pkg/doctor-ng/packagemanager/nixpkgs.go new file mode 100644 index 000000000..5aedd114e --- /dev/null +++ b/v3/pkg/doctor-ng/packagemanager/nixpkgs.go @@ -0,0 +1,159 @@ +//go:build linux + +package packagemanager + +import ( + "encoding/json" +) + +// Nixpkgs represents the Nixpkgs manager +type Nixpkgs struct { + name string + osid string +} + +type NixPackageDetail struct { + Name string + Pname string + Version string +} + +var available map[string]NixPackageDetail + +// NewNixpkgs creates a new Nixpkgs instance +func NewNixpkgs(osid string) *Nixpkgs { + available = map[string]NixPackageDetail{} + + return &Nixpkgs{ + name: "nixpkgs", + osid: osid, + } +} + +// Packages returns the libraries that we need for Wails to compile +// They will potentially differ on different distributions or versions +func (n *Nixpkgs) Packages() Packagemap { + // Currently, only support checking the default channel. + channel := "nixpkgs" + if n.osid == "nixos" { + channel = "nixos" + } + + return Packagemap{ + // GTK4 + WebKitGTK 6.0 (primary - default for Wails v3) + "gtk4": []*Package{ + {Name: channel + ".gtk4", SystemPackage: true, Library: true}, + }, + "webkitgtk-6.0": []*Package{ + {Name: channel + ".webkitgtk_6_0", SystemPackage: true, Library: true}, + }, + // GTK3 + WebKitGTK 4.1 (legacy - requires -tags gtk3) + "gtk3 (legacy)": []*Package{ + {Name: channel + ".gtk3", SystemPackage: true, Library: true, Optional: true}, + }, + "webkit2gtk (legacy)": []*Package{ + {Name: channel + ".webkitgtk", SystemPackage: true, Library: true, Optional: true}, + }, + "gcc": []*Package{ + {Name: channel + ".gcc", SystemPackage: true}, + }, + "pkg-config": []*Package{ + {Name: channel + ".pkg-config", SystemPackage: true}, + }, + "npm": []*Package{ + {Name: channel + ".nodejs", SystemPackage: true}, + }, + } +} + +// Name returns the name of the package manager +func (n *Nixpkgs) Name() string { + return n.name +} + +// PackageInstalled tests if the given package name is installed +func (n *Nixpkgs) PackageInstalled(pkg *Package) (bool, error) { + if !pkg.SystemPackage { + if pkg.InstallCheck != nil { + return pkg.InstallCheck(), nil + } + return false, nil + } + + stdout, err := execCmd("nix-env", "--json", "-qA", pkg.Name) + if err != nil { + return false, nil + } + + var attributes map[string]NixPackageDetail + err = json.Unmarshal([]byte(stdout), &attributes) + if err != nil { + return false, err + } + + // Did we get one? + installed := false + for attribute, detail := range attributes { + if attribute == pkg.Name { + installed = true + pkg.Version = detail.Version + } + break + } + + // If on NixOS, package may be installed via system config, so check the nix store. + detail, ok := available[pkg.Name] + if !installed && n.osid == "nixos" && ok { + cmd := "nix-store --query --requisites /run/current-system | cut -d- -f2- | sort | uniq | grep '^" + detail.Pname + "'" + + if pkg.Library { + cmd += " | grep 'dev$'" + } + + stdout, err = execCmd("sh", "-c", cmd) + if err != nil { + return false, nil + } + + if len(stdout) > 0 { + installed = true + } + } + + return installed, nil +} + +// PackageAvailable tests if the given package is available for installation +func (n *Nixpkgs) PackageAvailable(pkg *Package) (bool, error) { + if pkg.SystemPackage == false { + return false, nil + } + + stdout, err := execCmd("nix-env", "--json", "-qaA", pkg.Name) + if err != nil { + return false, nil + } + + var attributes map[string]NixPackageDetail + err = json.Unmarshal([]byte(stdout), &attributes) + if err != nil { + return false, err + } + + // Grab first version. + for attribute, detail := range attributes { + pkg.Version = detail.Version + available[attribute] = detail + break + } + + return len(pkg.Version) > 0, nil +} + +// InstallCommand returns the package manager specific command to install a package +func (n *Nixpkgs) InstallCommand(pkg *Package) string { + if pkg.SystemPackage == false { + return pkg.InstallCommand + } + return "nix-env -iA " + pkg.Name +} diff --git a/v3/pkg/doctor-ng/packagemanager/packagemanager.go b/v3/pkg/doctor-ng/packagemanager/packagemanager.go new file mode 100644 index 000000000..46f174117 --- /dev/null +++ b/v3/pkg/doctor-ng/packagemanager/packagemanager.go @@ -0,0 +1,140 @@ +//go:build linux + +package packagemanager + +import ( + "bytes" + "os" + "os/exec" + "sort" + "strings" +) + +func execCmd(command string, args ...string) (string, error) { + cmd := exec.Command(command, args...) + var stdo, stde bytes.Buffer + cmd.Stdout = &stdo + cmd.Stderr = &stde + cmd.Env = append(os.Environ(), "LANGUAGE=en_US.utf-8") + err := cmd.Run() + return stdo.String(), err +} + +var pmCommands = []string{ + "eopkg", + "apt", + "dnf", + "pacman", + "emerge", + "zypper", + "nix-env", +} + +func commandExists(name string) bool { + _, err := exec.LookPath(name) + return err == nil +} + +func Find(osid string) PackageManager { + for _, pmname := range pmCommands { + if commandExists(pmname) { + return newPackageManager(pmname, osid) + } + } + return nil +} + +func newPackageManager(pmname string, osid string) PackageManager { + switch pmname { + case "eopkg": + return NewEopkg(osid) + case "apt": + return NewApt(osid) + case "dnf": + return NewDnf(osid) + case "pacman": + return NewPacman(osid) + case "emerge": + return NewEmerge(osid) + case "zypper": + return NewZypper(osid) + case "nix-env": + return NewNixpkgs(osid) + } + return nil +} + +func Dependencies(p PackageManager) (DependencyList, error) { + var dependencies DependencyList + + for name, packages := range p.Packages() { + dependency := &Dependency{Name: name} + for _, pkg := range packages { + dependency.Optional = pkg.Optional + dependency.External = !pkg.SystemPackage + dependency.InstallCommand = p.InstallCommand(pkg) + packageavailable, err := p.PackageAvailable(pkg) + if err != nil { + return nil, err + } + if packageavailable { + dependency.Version = pkg.Version + dependency.PackageName = pkg.Name + installed, err := p.PackageInstalled(pkg) + if err != nil { + return nil, err + } + if installed { + dependency.Installed = true + dependency.Version = pkg.Version + if !pkg.SystemPackage { + dependency.Version = AppVersion(name) + } + } else { + dependency.InstallCommand = p.InstallCommand(pkg) + } + break + } + } + dependencies = append(dependencies, dependency) + } + + sort.Slice(dependencies, func(i, j int) bool { + return dependencies[i].Name < dependencies[j].Name + }) + + return dependencies, nil +} + +func AppVersion(name string) string { + switch name { + case "gcc": + return gccVersion() + case "pkg-config": + return pkgConfigVersion() + case "npm": + return npmVersion() + } + return "" +} + +func gccVersion() string { + version, err := execCmd("gcc", "-dumpfullversion") + if err != nil { + dumpversion, err := execCmd("gcc", "-dumpversion") + if err == nil { + version = dumpversion + } + } + return strings.TrimSpace(version) +} + +func pkgConfigVersion() string { + version, _ := execCmd("pkg-config", "--version") + return strings.TrimSpace(version) +} + +func npmVersion() string { + version, _ := execCmd("npm", "--version") + return strings.TrimSpace(version) +} diff --git a/v3/pkg/doctor-ng/packagemanager/pacman.go b/v3/pkg/doctor-ng/packagemanager/pacman.go new file mode 100644 index 000000000..30d111c89 --- /dev/null +++ b/v3/pkg/doctor-ng/packagemanager/pacman.go @@ -0,0 +1,119 @@ +//go:build linux + +package packagemanager + +import ( + "os/exec" + "regexp" + "strings" +) + +// Pacman represents the Pacman package manager +type Pacman struct { + name string + osid string +} + +// NewPacman creates a new Pacman instance +func NewPacman(osid string) *Pacman { + return &Pacman{ + name: "pacman", + osid: osid, + } +} + +// Packages returns the libraries that we need for Wails to compile +// They will potentially differ on different distributions or versions +func (p *Pacman) Packages() Packagemap { + return Packagemap{ + "gtk4": []*Package{ + {Name: "gtk4", SystemPackage: true, Library: true}, + }, + "webkitgtk-6.0": []*Package{ + {Name: "webkitgtk-6.0", SystemPackage: true, Library: true}, + }, + "gtk3 (legacy)": []*Package{ + {Name: "gtk3", SystemPackage: true, Library: true, Optional: true}, + }, + "webkit2gtk (legacy)": []*Package{ + {Name: "webkit2gtk-4.1", SystemPackage: true, Library: true, Optional: true}, + {Name: "webkit2gtk", SystemPackage: true, Library: true, Optional: true}, + }, + "gcc": []*Package{ + {Name: "gcc", SystemPackage: true}, + }, + "pkg-config": []*Package{ + {Name: "pkgconf", SystemPackage: true}, + }, + "npm": []*Package{ + {Name: "npm", SystemPackage: true}, + }, + } +} + +// Name returns the name of the package manager +func (p *Pacman) Name() string { + return p.name +} + +// PackageInstalled tests if the given package name is installed +func (p *Pacman) PackageInstalled(pkg *Package) (bool, error) { + if !pkg.SystemPackage { + if pkg.InstallCheck != nil { + return pkg.InstallCheck(), nil + } + return false, nil + } + stdout, err := execCmd("pacman", "-Q", pkg.Name) + if err != nil { + _, ok := err.(*exec.ExitError) + if ok { + return false, nil + } + return false, err + } + + splitoutput := strings.Split(stdout, "\n") + for _, line := range splitoutput { + if strings.HasPrefix(line, pkg.Name) { + splitline := strings.Split(line, " ") + pkg.Version = strings.TrimSpace(splitline[1]) + } + } + + return true, err +} + +// PackageAvailable tests if the given package is available for installation +func (p *Pacman) PackageAvailable(pkg *Package) (bool, error) { + if pkg.SystemPackage == false { + return false, nil + } + output, err := execCmd("pacman", "-Si", pkg.Name) + // We add a space to ensure we get a full match, not partial match + if err != nil { + _, ok := err.(*exec.ExitError) + if ok { + return false, nil + } + return false, err + } + + reg := regexp.MustCompile(`.*Version.*?:\s+(.*)`) + matches := reg.FindStringSubmatch(output) + pkg.Version = "" + noOfMatches := len(matches) + if noOfMatches > 1 { + pkg.Version = strings.TrimSpace(matches[1]) + } + + return true, nil +} + +// InstallCommand returns the package manager specific command to install a package +func (p *Pacman) InstallCommand(pkg *Package) string { + if pkg.SystemPackage == false { + return pkg.InstallCommand + } + return "sudo pacman -S " + pkg.Name +} diff --git a/v3/pkg/doctor-ng/packagemanager/types.go b/v3/pkg/doctor-ng/packagemanager/types.go new file mode 100644 index 000000000..824f10be4 --- /dev/null +++ b/v3/pkg/doctor-ng/packagemanager/types.go @@ -0,0 +1,35 @@ +//go:build linux + +package packagemanager + +type Package struct { + Name string + Version string + InstallCommand string + InstallCheck func() bool + SystemPackage bool + Library bool + Optional bool +} + +type Packagemap = map[string][]*Package + +type PackageManager interface { + Name() string + Packages() Packagemap + PackageInstalled(*Package) (bool, error) + PackageAvailable(*Package) (bool, error) + InstallCommand(*Package) string +} + +type Dependency struct { + Name string + PackageName string + Installed bool + InstallCommand string + Version string + Optional bool + External bool +} + +type DependencyList []*Dependency diff --git a/v3/pkg/doctor-ng/packagemanager/zypper.go b/v3/pkg/doctor-ng/packagemanager/zypper.go new file mode 100644 index 000000000..1f41adadb --- /dev/null +++ b/v3/pkg/doctor-ng/packagemanager/zypper.go @@ -0,0 +1,127 @@ +//go:build linux +// +build linux + +package packagemanager + +import ( + "os/exec" + "regexp" + "strings" +) + +// Zypper represents the Zypper package manager +type Zypper struct { + name string + osid string +} + +// NewZypper creates a new Zypper instance +func NewZypper(osid string) *Zypper { + return &Zypper{ + name: "zypper", + osid: osid, + } +} + +// Packages returns the libraries that we need for Wails to compile +// They will potentially differ on different distributions or versions +func (z *Zypper) Packages() Packagemap { + return Packagemap{ + "gtk4": []*Package{ + {Name: "gtk4-devel", SystemPackage: true, Library: true}, + }, + "webkitgtk-6.0": []*Package{ + {Name: "webkitgtk-6_0-devel", SystemPackage: true, Library: true}, + }, + "gtk3 (legacy)": []*Package{ + {Name: "gtk3-devel", SystemPackage: true, Library: true, Optional: true}, + }, + "webkit2gtk (legacy)": []*Package{ + {Name: "webkit2gtk4_1-devel", SystemPackage: true, Library: true, Optional: true}, + {Name: "webkit2gtk3-soup2-devel", SystemPackage: true, Library: true, Optional: true}, + }, + "gcc": []*Package{ + {Name: "gcc-c++", SystemPackage: true}, + }, + "pkg-config": []*Package{ + {Name: "pkg-config", SystemPackage: true}, + {Name: "pkgconf-pkg-config", SystemPackage: true}, + }, + "npm": []*Package{ + {Name: "npm10", SystemPackage: true}, + }, + } +} + +// Name returns the name of the package manager +func (z *Zypper) Name() string { + return z.name +} + +// PackageInstalled tests if the given package name is installed +func (z *Zypper) PackageInstalled(pkg *Package) (bool, error) { + if !pkg.SystemPackage { + if pkg.InstallCheck != nil { + return pkg.InstallCheck(), nil + } + return false, nil + } + stdout, err := execCmd("zypper", "info", pkg.Name) + if err != nil { + _, ok := err.(*exec.ExitError) + if ok { + return false, nil + } + return false, err + } + reg := regexp.MustCompile(`.*Installed\s*:\s*(Yes)\s*`) + matches := reg.FindStringSubmatch(stdout) + pkg.Version = "" + noOfMatches := len(matches) + if noOfMatches > 1 { + z.getPackageVersion(pkg, stdout) + } + return noOfMatches > 1, err +} + +// PackageAvailable tests if the given package is available for installation +func (z *Zypper) PackageAvailable(pkg *Package) (bool, error) { + if pkg.SystemPackage == false { + return false, nil + } + stdout, err := execCmd("zypper", "info", pkg.Name) + // We add a space to ensure we get a full match, not partial match + if err != nil { + _, ok := err.(*exec.ExitError) + if ok { + return false, nil + } + return false, err + } + + available := strings.Contains(stdout, "Information for package") + if available { + z.getPackageVersion(pkg, stdout) + } + + return available, nil +} + +// InstallCommand returns the package manager specific command to install a package +func (z *Zypper) InstallCommand(pkg *Package) string { + if pkg.SystemPackage == false { + return pkg.InstallCommand + } + return "sudo zypper in " + pkg.Name +} + +func (z *Zypper) getPackageVersion(pkg *Package, output string) { + + reg := regexp.MustCompile(`.*Version.*:(.*)`) + matches := reg.FindStringSubmatch(output) + pkg.Version = "" + noOfMatches := len(matches) + if noOfMatches > 1 { + pkg.Version = strings.TrimSpace(matches[1]) + } +} diff --git a/v3/pkg/doctor-ng/platform_darwin.go b/v3/pkg/doctor-ng/platform_darwin.go new file mode 100644 index 000000000..e057d6736 --- /dev/null +++ b/v3/pkg/doctor-ng/platform_darwin.go @@ -0,0 +1,244 @@ +//go:build darwin + +package doctorng + +import ( + "bytes" + "os/exec" + "strings" + "syscall" + + "github.com/samber/lo" +) + +type macPackageManager int + +const ( + macPMNone macPackageManager = iota + macPMBrew + macPMMacPorts + macPMNix +) + +var detectedMacPM macPackageManager +var macPMDetected bool + +func detectMacPackageManager() macPackageManager { + if macPMDetected { + return detectedMacPM + } + macPMDetected = true + + if _, err := exec.LookPath("brew"); err == nil { + detectedMacPM = macPMBrew + return detectedMacPM + } + if _, err := exec.LookPath("port"); err == nil { + detectedMacPM = macPMMacPorts + return detectedMacPM + } + if _, err := exec.LookPath("nix-env"); err == nil { + detectedMacPM = macPMNix + return detectedMacPM + } + + detectedMacPM = macPMNone + return detectedMacPM +} + +func macInstallCmd(brew, macports, nix, manual string) string { + switch detectMacPackageManager() { + case macPMBrew: + return brew + case macPMMacPorts: + if macports != "" { + return "sudo " + macports + } + return manual + case macPMNix: + if nix != "" { + return nix + } + return manual + default: + return manual + } +} + +func collectPlatformExtras() map[string]string { + extras := make(map[string]string) + + appleSilicon := "unknown" + r, err := syscall.Sysctl("sysctl.proc_translated") + if err == nil { + appleSilicon = lo.Ternary(r == "\x00\x00\x00" || r == "\x01\x00\x00", "true", "false") + } + extras["Apple Silicon"] = appleSilicon + + pm := "none" + switch detectMacPackageManager() { + case macPMBrew: + pm = "homebrew" + case macPMMacPorts: + pm = "macports" + case macPMNix: + pm = "nix" + } + extras["Package Manager"] = pm + + return extras +} + +func (d *Doctor) collectDependencies() error { + output, err := exec.Command("xcode-select", "-v").Output() + xcodeStatus := StatusMissing + xcodeVersion := "" + if err == nil { + xcodeStatus = StatusOK + xcodeVersion = strings.TrimPrefix(string(output), "xcode-select version ") + xcodeVersion = strings.TrimSpace(xcodeVersion) + xcodeVersion = strings.TrimSuffix(xcodeVersion, ".") + } + + d.report.Dependencies = append(d.report.Dependencies, &Dependency{ + Name: "Xcode CLI Tools", + Version: xcodeVersion, + Status: xcodeStatus, + Required: true, + InstallCommand: "xcode-select --install", + Category: "build-tools", + }) + + d.checkCommonDependencies() + + nsisVersion := "" + nsisStatus := StatusMissing + output, err = exec.Command("makensis", "-VERSION").Output() + if err == nil && output != nil { + nsisStatus = StatusOK + nsisVersion = strings.TrimSpace(string(output)) + } + + d.report.Dependencies = append(d.report.Dependencies, &Dependency{ + Name: "NSIS", + Version: nsisVersion, + Status: nsisStatus, + InstallCommand: macInstallCmd( + "brew install makensis", + "port install nsis", + "nix-env -iA nixpkgs.nsis", + "Download from https://nsis.sourceforge.io/", + ), + Required: false, + Category: "optional", + Description: "For Windows installer generation", + }) + + return nil +} + +func (d *Doctor) checkCommonDependencies() { + npmVersion := "" + npmStatus := StatusMissing + output, err := exec.Command("npm", "--version").Output() + if err == nil { + npmStatus = StatusOK + npmVersion = strings.TrimSpace(string(output)) + } + + d.report.Dependencies = append(d.report.Dependencies, &Dependency{ + Name: "npm", + Version: npmVersion, + Status: npmStatus, + InstallCommand: macInstallCmd( + "brew install node", + "port install nodejs18", + "nix-env -iA nixpkgs.nodejs", + "Download from https://nodejs.org/", + ), + Required: true, + Category: "frontend", + }) + + dockerVersion := "" + dockerStatus := StatusMissing + output, err = exec.Command("docker", "--version").Output() + if err == nil { + dockerStatus = StatusOK + dockerVersion = strings.TrimSpace(string(output)) + output = bytes.Replace(output, []byte("Docker version "), []byte(""), 1) + dockerVersion = strings.TrimSpace(string(output)) + } + + d.report.Dependencies = append(d.report.Dependencies, &Dependency{ + Name: "docker", + Version: dockerVersion, + Status: dockerStatus, + InstallCommand: macInstallCmd( + "brew install --cask docker", + "", + "", + "Download from https://docker.com/", + ), + Required: false, + Category: "optional", + Description: "For cross-compilation", + }) +} + +func (d *Doctor) runDiagnostics() { + d.checkGoInstallation() + d.checkMacSpecific() + d.checkPackageManager() +} + +func (d *Doctor) checkGoInstallation() { + if d.report.Build.GoVersion == "" { + d.report.Diagnostics = append(d.report.Diagnostics, DiagnosticResult{ + Name: "Go Installation", + Message: "Go installation not found", + Severity: SeverityError, + HelpURL: "/getting-started/installation/", + Fix: &Fix{ + Description: "Install Go", + Command: macInstallCmd( + "brew install go", + "port install go", + "nix-env -iA nixpkgs.go", + "Download from https://go.dev/dl/", + ), + }, + }) + } +} + +func (d *Doctor) checkMacSpecific() { + matches, _ := exec.Command("sh", "-c", "ls *.syso 2>/dev/null").Output() + if len(matches) > 0 { + d.report.Diagnostics = append(d.report.Diagnostics, DiagnosticResult{ + Name: ".syso files found", + Message: "Found .syso file(s) which may cause issues on macOS", + Severity: SeverityWarning, + HelpURL: "/troubleshooting/mac-syso", + Fix: &Fix{ + Description: "Remove .syso files before building on macOS", + Command: "rm *.syso", + }, + }) + } +} + +func (d *Doctor) checkPackageManager() { + if detectMacPackageManager() == macPMNone { + d.report.Diagnostics = append(d.report.Diagnostics, DiagnosticResult{ + Name: "Package Manager", + Message: "No package manager found (homebrew, macports, or nix)", + Severity: SeverityWarning, + HelpURL: "/getting-started/installation/#macos", + Fix: &Fix{ + Description: "Install Homebrew for easier dependency management", + Command: `/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"`, + }, + }) + } +} diff --git a/v3/pkg/doctor-ng/platform_linux.go b/v3/pkg/doctor-ng/platform_linux.go new file mode 100644 index 000000000..5ac393b96 --- /dev/null +++ b/v3/pkg/doctor-ng/platform_linux.go @@ -0,0 +1,141 @@ +//go:build linux + +package doctorng + +import ( + "os" + "strings" + + "github.com/wailsapp/wails/v3/internal/operatingsystem" + "github.com/wailsapp/wails/v3/pkg/doctor-ng/packagemanager" +) + +func collectPlatformExtras() map[string]string { + extras := make(map[string]string) + + extras["XDG_SESSION_TYPE"] = getEnvOrDefault("XDG_SESSION_TYPE", "unset") + extras["Desktop Environment"] = getEnvOrDefault("XDG_CURRENT_DESKTOP", "unset") + extras["NVIDIA Driver"] = getNvidiaDriverInfo() + + return extras +} + +func getEnvOrDefault(key, defaultVal string) string { + if val := os.Getenv(key); val != "" { + return val + } + return defaultVal +} + +func getNvidiaDriverInfo() string { + version, err := os.ReadFile("/sys/module/nvidia/version") + if err != nil { + return "N/A" + } + + versionStr := strings.TrimSpace(string(version)) + + srcVersion, err := os.ReadFile("/sys/module/nvidia/srcversion") + if err != nil { + return versionStr + } + + return versionStr + " (" + strings.TrimSpace(string(srcVersion)) + ")" +} + +func (d *Doctor) collectDependencies() error { + info, _ := operatingsystem.Info() + pm := packagemanager.Find(info.ID) + if pm == nil { + return nil + } + + deps, err := packagemanager.Dependencies(pm) + if err != nil { + return err + } + + for _, dep := range deps { + status := StatusMissing + if dep.Installed { + status = StatusOK + } + + d.report.Dependencies = append(d.report.Dependencies, &Dependency{ + Name: dep.Name, + PackageName: dep.PackageName, + Version: dep.Version, + Status: status, + Required: !dep.Optional, + InstallCommand: dep.InstallCommand, + Category: categorizeLinuxDep(dep.Name), + }) + } + + return nil +} + +func categorizeLinuxDep(name string) string { + lower := strings.ToLower(name) + switch { + case strings.Contains(lower, "gtk"): + return "gtk" + case strings.Contains(lower, "webkit"): + return "webkit" + case name == "gcc" || name == "pkg-config": + return "build-tools" + case name == "npm": + return "frontend" + case name == "docker": + return "optional" + default: + return "other" + } +} + +func (d *Doctor) runDiagnostics() { + d.checkGoInstallation() + d.checkLinuxSpecific() +} + +func (d *Doctor) checkGoInstallation() { + if d.report.Build.GoVersion == "" { + d.report.Diagnostics = append(d.report.Diagnostics, DiagnosticResult{ + Name: "Go Installation", + Message: "Go installation not found", + Severity: SeverityError, + HelpURL: "/getting-started/installation/", + Fix: &Fix{ + Description: "Install Go from https://go.dev/dl/", + ManualSteps: []string{ + "Download Go from https://go.dev/dl/", + "Extract and add to PATH", + }, + }, + }) + } +} + +func (d *Doctor) checkLinuxSpecific() { + missingRequired := d.report.Dependencies.RequiredMissing() + if len(missingRequired) > 0 { + var commands []string + for _, dep := range missingRequired { + if dep.InstallCommand != "" { + commands = append(commands, dep.InstallCommand) + } + } + + d.report.Diagnostics = append(d.report.Diagnostics, DiagnosticResult{ + Name: "Missing Dependencies", + Message: "Required system packages are not installed", + Severity: SeverityError, + HelpURL: "/getting-started/installation/#linux", + Fix: &Fix{ + Description: "Install missing packages", + Command: strings.Join(commands, " && "), + RequiresSudo: true, + }, + }) + } +} diff --git a/v3/pkg/doctor-ng/platform_windows.go b/v3/pkg/doctor-ng/platform_windows.go new file mode 100644 index 000000000..98aaf0e1c --- /dev/null +++ b/v3/pkg/doctor-ng/platform_windows.go @@ -0,0 +1,242 @@ +//go:build windows + +package doctorng + +import ( + "os/exec" + "strings" + + "github.com/samber/lo" + "github.com/wailsapp/go-webview2/webviewloader" +) + +type windowsPackageManager int + +const ( + pmNone windowsPackageManager = iota + pmWinget + pmChoco + pmScoop +) + +var detectedPM windowsPackageManager +var pmDetected bool + +func detectWindowsPackageManager() windowsPackageManager { + if pmDetected { + return detectedPM + } + pmDetected = true + + if _, err := exec.LookPath("winget"); err == nil { + detectedPM = pmWinget + return detectedPM + } + if _, err := exec.LookPath("scoop"); err == nil { + detectedPM = pmScoop + return detectedPM + } + if _, err := exec.LookPath("choco"); err == nil { + detectedPM = pmChoco + return detectedPM + } + + detectedPM = pmNone + return detectedPM +} + +func windowsInstallCmd(winget, scoop, choco, manual string) string { + switch detectWindowsPackageManager() { + case pmWinget: + return winget + case pmScoop: + return scoop + case pmChoco: + return choco + " (requires admin)" + default: + return manual + } +} + +func collectPlatformExtras() map[string]string { + extras := make(map[string]string) + + extras["Go WebView2Loader"] = lo.Ternary(webviewloader.UsingGoWebview2Loader, "true", "false") + + webviewVersion, err := webviewloader.GetAvailableCoreWebView2BrowserVersionString("") + if err != nil { + extras["WebView2 Version"] = "Error: " + err.Error() + } else { + extras["WebView2 Version"] = webviewVersion + } + + pm := "none" + switch detectWindowsPackageManager() { + case pmWinget: + pm = "winget" + case pmScoop: + pm = "scoop" + case pmChoco: + pm = "choco" + } + extras["Package Manager"] = pm + + return extras +} + +func (d *Doctor) collectDependencies() error { + d.checkCommonDependencies() + + nsisVersion, nsisStatus := d.checkCommand("makensis", "-VERSION") + d.report.Dependencies = append(d.report.Dependencies, &Dependency{ + Name: "NSIS", + Version: nsisVersion, + Status: nsisStatus, + InstallCommand: windowsInstallCmd( + "winget install NSIS.NSIS", + "scoop install nsis", + "choco install nsis", + "Download from https://nsis.sourceforge.io/", + ), + Required: false, + Category: "optional", + Description: "For Windows installer generation", + }) + + makeAppxStatus := StatusMissing + if _, err := exec.LookPath("MakeAppx.exe"); err == nil { + makeAppxStatus = StatusOK + } + d.report.Dependencies = append(d.report.Dependencies, &Dependency{ + Name: "MakeAppx.exe", + Status: makeAppxStatus, + Required: false, + Category: "optional", + Description: "Part of Windows SDK, for MSIX packaging", + }) + + signToolStatus := StatusMissing + if _, err := exec.LookPath("signtool.exe"); err == nil { + signToolStatus = StatusOK + } + d.report.Dependencies = append(d.report.Dependencies, &Dependency{ + Name: "SignTool.exe", + Status: signToolStatus, + Required: false, + Category: "optional", + Description: "Part of Windows SDK, for code signing", + }) + + return nil +} + +func (d *Doctor) checkCommand(cmd string, args ...string) (string, Status) { + output, err := exec.Command(cmd, args...).Output() + if err != nil { + return "", StatusMissing + } + return strings.TrimSpace(string(output)), StatusOK +} + +func (d *Doctor) checkCommonDependencies() { + npmVersion, npmStatus := d.checkCommand("npm", "--version") + d.report.Dependencies = append(d.report.Dependencies, &Dependency{ + Name: "npm", + Version: npmVersion, + Status: npmStatus, + InstallCommand: windowsInstallCmd( + "winget install OpenJS.NodeJS.LTS", + "scoop install nodejs-lts", + "choco install nodejs-lts", + "Download from https://nodejs.org/", + ), + Required: true, + Category: "frontend", + }) + + dockerVersion, dockerStatus := d.checkCommand("docker", "--version") + if dockerStatus == StatusOK { + dockerVersion = strings.TrimPrefix(dockerVersion, "Docker version ") + if idx := strings.Index(dockerVersion, ","); idx > 0 { + dockerVersion = dockerVersion[:idx] + } + } + d.report.Dependencies = append(d.report.Dependencies, &Dependency{ + Name: "docker", + Version: dockerVersion, + Status: dockerStatus, + InstallCommand: windowsInstallCmd( + "winget install Docker.DockerDesktop", + "Download from https://docker.com/", + "choco install docker-desktop", + "Download from https://docker.com/", + ), + Required: false, + Category: "optional", + Description: "For cross-compilation", + }) +} + +func (d *Doctor) runDiagnostics() { + d.checkGoInstallation() + d.checkWebView2() + d.checkPackageManager() +} + +func (d *Doctor) checkGoInstallation() { + if d.report.Build.GoVersion == "" { + d.report.Diagnostics = append(d.report.Diagnostics, DiagnosticResult{ + Name: "Go Installation", + Message: "Go installation not found", + Severity: SeverityError, + HelpURL: "/getting-started/installation/", + Fix: &Fix{ + Description: "Install Go", + Command: windowsInstallCmd( + "winget install GoLang.Go", + "scoop install go", + "choco install golang", + "Download from https://go.dev/dl/", + ), + }, + }) + } +} + +func (d *Doctor) checkWebView2() { + _, err := webviewloader.GetAvailableCoreWebView2BrowserVersionString("") + if err != nil { + d.report.Diagnostics = append(d.report.Diagnostics, DiagnosticResult{ + Name: "WebView2 Runtime", + Message: "WebView2 runtime not found or unavailable", + Severity: SeverityError, + HelpURL: "/getting-started/installation/#windows", + Fix: &Fix{ + Description: "Install Microsoft Edge WebView2 Runtime", + ManualSteps: []string{ + "Download from https://developer.microsoft.com/en-us/microsoft-edge/webview2/", + "Or it may be bundled with recent Windows updates", + }, + }, + }) + } +} + +func (d *Doctor) checkPackageManager() { + if detectWindowsPackageManager() == pmNone { + d.report.Diagnostics = append(d.report.Diagnostics, DiagnosticResult{ + Name: "Package Manager", + Message: "No package manager found (winget, scoop, or choco)", + Severity: SeverityWarning, + HelpURL: "/getting-started/installation/#windows", + Fix: &Fix{ + Description: "Install a package manager for easier dependency management", + ManualSteps: []string{ + "winget: Built into Windows 11, or install from Microsoft Store", + "scoop: Run in PowerShell: irm get.scoop.sh | iex", + "choco: See https://chocolatey.org/install", + }, + }, + }) + } +} diff --git a/v3/pkg/doctor-ng/tui/model.go b/v3/pkg/doctor-ng/tui/model.go new file mode 100644 index 000000000..2fb5c5027 --- /dev/null +++ b/v3/pkg/doctor-ng/tui/model.go @@ -0,0 +1,417 @@ +package tui + +import ( + "fmt" + "os/exec" + "sort" + "strings" + + "github.com/atotto/clipboard" + "github.com/charmbracelet/bubbles/spinner" + tea "github.com/charmbracelet/bubbletea" + "github.com/charmbracelet/lipgloss" + doctorng "github.com/wailsapp/wails/v3/pkg/doctor-ng" +) + +type state int + +const ( + stateLoading state = iota + stateReport +) + +type Model struct { + state state + report *doctorng.Report + spinner spinner.Model + err error + width int + height int + showHelp bool + copiedNotice bool +} + +type reportReadyMsg struct { + report *doctorng.Report + err error +} + +type installCompleteMsg struct { + err error +} + +func NewModel() Model { + s := spinner.New() + s.Spinner = spinner.Dot + s.Style = spinnerStyle + + return Model{ + state: stateLoading, + spinner: s, + } +} + +func (m Model) Init() tea.Cmd { + return tea.Batch( + m.spinner.Tick, + runDoctor, + ) +} + +func runDoctor() tea.Msg { + d := doctorng.New() + report, err := d.Run() + return reportReadyMsg{report: report, err: err} +} + +func (m Model) Update(msg tea.Msg) (tea.Model, tea.Cmd) { + switch msg := msg.(type) { + case tea.KeyMsg: + switch msg.String() { + case "q", "ctrl+c": + return m, tea.Quit + case "?": + m.showHelp = !m.showHelp + + case "i": + if m.state == stateReport && m.report != nil { + missing := m.report.Dependencies.RequiredMissing() + if len(missing) > 0 { + return m, tea.ExecProcess( + createInstallCmd(missing), + func(err error) tea.Msg { return installCompleteMsg{err: err} }, + ) + } + } + + case "r": + if m.state == stateReport { + m.state = stateLoading + return m, tea.Batch(m.spinner.Tick, runDoctor) + } + case "c": + if m.state == stateReport && m.report != nil { + text := m.generateClipboardText() + if err := clipboard.WriteAll(text); err == nil { + m.copiedNotice = true + } + } + } + + case tea.WindowSizeMsg: + m.width = msg.Width + m.height = msg.Height + + case reportReadyMsg: + m.report = msg.report + m.err = msg.err + m.state = stateReport + + case spinner.TickMsg: + var cmd tea.Cmd + m.spinner, cmd = m.spinner.Update(msg) + return m, cmd + + case installCompleteMsg: + m.state = stateLoading + return m, tea.Batch(m.spinner.Tick, runDoctor) + } + + return m, nil +} + +func (m Model) View() string { + switch m.state { + case stateLoading: + return m.viewLoading() + case stateReport: + return m.viewReport() + default: + return "" + } +} + +func (m Model) viewLoading() string { + return fmt.Sprintf("\n %s Scanning system...\n", m.spinner.View()) +} + +func (m Model) viewReport() string { + if m.err != nil { + return errStyle.Render(fmt.Sprintf("Error: %v", m.err)) + } + if m.report == nil { + return "" + } + + var b strings.Builder + + b.WriteString(titleStyle.Render(" Wails Doctor ")) + b.WriteString("\n\n") + + b.WriteString(m.renderSystemInfo()) + b.WriteString(m.renderBuildInfo()) + b.WriteString(m.renderDependencies()) + b.WriteString(m.renderDiagnostics()) + b.WriteString(m.renderSummary()) + + if m.showHelp { + b.WriteString(m.renderHelp()) + } else if m.copiedNotice { + b.WriteString(okStyle.Render("Copied to clipboard!") + " " + helpStyle.Render("Press ? for help, q to quit")) + } else { + b.WriteString(helpStyle.Render("Press c to copy, ? for help, q to quit")) + } + + return b.String() +} + +func (m Model) renderSystemInfo() string { + var b strings.Builder + b.WriteString(sectionStyle.Render("System")) + b.WriteString("\n") + + sys := m.report.System + rows := [][]string{ + {"OS", fmt.Sprintf("%s %s", sys.OS.Name, sys.OS.Version)}, + {"Platform", fmt.Sprintf("%s/%s", sys.OS.Platform, sys.OS.Arch)}, + } + + if len(sys.Hardware.CPUs) > 0 { + rows = append(rows, []string{"CPU", sys.Hardware.CPUs[0].Model}) + } + if len(sys.Hardware.GPUs) > 0 { + gpuInfo := sys.Hardware.GPUs[0].Name + if sys.Hardware.GPUs[0].Vendor != "" { + gpuInfo += " (" + sys.Hardware.GPUs[0].Vendor + ")" + } + rows = append(rows, []string{"GPU", gpuInfo}) + } + rows = append(rows, []string{"Memory", sys.Hardware.Memory}) + + keys := make([]string, 0, len(sys.PlatformExtras)) + for k := range sys.PlatformExtras { + keys = append(keys, k) + } + sort.Strings(keys) + for _, k := range keys { + rows = append(rows, []string{k, sys.PlatformExtras[k]}) + } + + b.WriteString(renderTable(rows)) + return b.String() +} + +func (m Model) renderBuildInfo() string { + var b strings.Builder + b.WriteString(sectionStyle.Render("Build Environment")) + b.WriteString("\n") + + build := m.report.Build + rows := [][]string{ + {"Wails", build.WailsVersion}, + {"Go", build.GoVersion}, + {"CGO", fmt.Sprintf("%v", build.CGOEnabled)}, + } + + b.WriteString(renderTable(rows)) + return b.String() +} + +func (m Model) renderDependencies() string { + var b strings.Builder + b.WriteString(sectionStyle.Render("Dependencies")) + b.WriteString("\n") + + for _, dep := range m.report.Dependencies { + icon := statusIconTri(dep.Status.String()) + name := dep.Name + version := dep.Version + if version == "" { + version = mutedStyle.Render("not installed") + } + + row := fmt.Sprintf(" %s %-25s %s", icon, name, version) + + if !dep.Required { + row += mutedStyle.Render(" (optional)") + } + + b.WriteString(row) + b.WriteString("\n") + } + + return b.String() +} + +func (m Model) renderDiagnostics() string { + if len(m.report.Diagnostics) == 0 { + return "" + } + + var b strings.Builder + b.WriteString(sectionStyle.Render("Issues Found")) + b.WriteString("\n") + + for _, diag := range m.report.Diagnostics { + var icon string + var style lipgloss.Style + switch diag.Severity { + case doctorng.SeverityError: + icon = "✗" + style = errStyle + case doctorng.SeverityWarning: + icon = "!" + style = warnStyle + default: + icon = "i" + style = mutedStyle + } + + b.WriteString(fmt.Sprintf(" %s %s: %s\n", + style.Render(icon), + style.Render(diag.Name), + diag.Message)) + + if diag.Fix != nil && diag.Fix.Command != "" { + b.WriteString(fmt.Sprintf(" Fix: %s\n", mutedStyle.Render(diag.Fix.Command))) + } + } + + return b.String() +} + +func (m Model) renderSummary() string { + var b strings.Builder + b.WriteString("\n") + + if m.report.Ready { + b.WriteString(okStyle.Render("✓ " + m.report.Summary)) + } else { + b.WriteString(errStyle.Render("✗ " + m.report.Summary)) + + missing := m.report.Dependencies.RequiredMissing() + if len(missing) > 0 { + b.WriteString("\n\n") + b.WriteString(mutedStyle.Render("Press 'i' to install missing dependencies")) + } + } + + b.WriteString("\n") + return b.String() +} + +func (m Model) renderHelp() string { + var b strings.Builder + b.WriteString("\n") + + help := "Keyboard Shortcuts:\n" + help += " c Copy report to clipboard\n" + help += " r Refresh / re-scan system\n" + + if m.report != nil && len(m.report.Dependencies.RequiredMissing()) > 0 { + help += " i Install missing dependencies\n" + } + + help += " ? Toggle help\n" + help += " q Quit" + + b.WriteString(boxStyle.Render(help)) + return b.String() +} + +func renderTable(rows [][]string) string { + var b strings.Builder + maxKeyLen := 0 + for _, row := range rows { + if len(row[0]) > maxKeyLen { + maxKeyLen = len(row[0]) + } + } + + for _, row := range rows { + key := tableCellStyle.Render(fmt.Sprintf("%-*s", maxKeyLen, row[0])) + val := row[1] + b.WriteString(fmt.Sprintf(" %s %s\n", mutedStyle.Render(key), val)) + } + + return b.String() +} + +func createInstallCmd(deps doctorng.DependencyList) *exec.Cmd { + var commands []string + for _, dep := range deps { + if dep.InstallCommand != "" { + commands = append(commands, dep.InstallCommand) + } + } + + if len(commands) == 0 { + return exec.Command("echo", "Nothing to install") + } + + combined := strings.Join(commands, " && ") + return exec.Command("sh", "-c", combined) +} + +func (m Model) generateClipboardText() string { + if m.report == nil { + return "" + } + + var b strings.Builder + b.WriteString("Wails Doctor Report\n") + b.WriteString("===================\n\n") + + sys := m.report.System + b.WriteString("System:\n") + b.WriteString(fmt.Sprintf(" OS: %s %s\n", sys.OS.Name, sys.OS.Version)) + b.WriteString(fmt.Sprintf(" Platform: %s/%s\n", sys.OS.Platform, sys.OS.Arch)) + if len(sys.Hardware.CPUs) > 0 { + b.WriteString(fmt.Sprintf(" CPU: %s\n", sys.Hardware.CPUs[0].Model)) + } + if len(sys.Hardware.GPUs) > 0 { + b.WriteString(fmt.Sprintf(" GPU: %s\n", sys.Hardware.GPUs[0].Name)) + } + b.WriteString(fmt.Sprintf(" Memory: %s\n", sys.Hardware.Memory)) + + keys := make([]string, 0, len(sys.PlatformExtras)) + for k := range sys.PlatformExtras { + keys = append(keys, k) + } + sort.Strings(keys) + for _, k := range keys { + b.WriteString(fmt.Sprintf(" %s: %s\n", k, sys.PlatformExtras[k])) + } + + b.WriteString("\nBuild Environment:\n") + b.WriteString(fmt.Sprintf(" Wails: %s\n", m.report.Build.WailsVersion)) + b.WriteString(fmt.Sprintf(" Go: %s\n", m.report.Build.GoVersion)) + + b.WriteString("\nDependencies:\n") + for _, dep := range m.report.Dependencies { + status := "✓" + if dep.Status != doctorng.StatusOK { + status = "✗" + } + version := dep.Version + if version == "" { + version = "not installed" + } + optional := "" + if !dep.Required { + optional = " (optional)" + } + b.WriteString(fmt.Sprintf(" %s %s: %s%s\n", status, dep.Name, version, optional)) + } + + if len(m.report.Diagnostics) > 0 { + b.WriteString("\nIssues:\n") + for _, diag := range m.report.Diagnostics { + b.WriteString(fmt.Sprintf(" - %s: %s\n", diag.Name, diag.Message)) + } + } + + b.WriteString(fmt.Sprintf("\nStatus: %s\n", m.report.Summary)) + + return b.String() +} diff --git a/v3/pkg/doctor-ng/tui/run.go b/v3/pkg/doctor-ng/tui/run.go new file mode 100644 index 000000000..169e0537f --- /dev/null +++ b/v3/pkg/doctor-ng/tui/run.go @@ -0,0 +1,44 @@ +package tui + +import ( + "fmt" + "os" + + tea "github.com/charmbracelet/bubbletea" +) + +func Run() error { + p := tea.NewProgram(NewModel(), tea.WithAltScreen()) + if _, err := p.Run(); err != nil { + return fmt.Errorf("error running TUI: %w", err) + } + return nil +} + +func RunSimple() error { + p := tea.NewProgram(NewModel()) + if _, err := p.Run(); err != nil { + return fmt.Errorf("error running TUI: %w", err) + } + return nil +} + +func RunNonInteractive() error { + m := NewModel() + + msg := runDoctor() + reportMsg, ok := msg.(reportReadyMsg) + if !ok { + return fmt.Errorf("unexpected message type") + } + + if reportMsg.err != nil { + return reportMsg.err + } + + m.report = reportMsg.report + m.state = stateReport + + fmt.Fprint(os.Stdout, m.View()) + return nil +} diff --git a/v3/pkg/doctor-ng/tui/styles.go b/v3/pkg/doctor-ng/tui/styles.go new file mode 100644 index 000000000..ff2f47bc5 --- /dev/null +++ b/v3/pkg/doctor-ng/tui/styles.go @@ -0,0 +1,92 @@ +package tui + +import "github.com/charmbracelet/lipgloss" + +var ( + primaryColor = lipgloss.Color("#7C3AED") + successColor = lipgloss.Color("#10B981") + warningColor = lipgloss.Color("#F59E0B") + errorColor = lipgloss.Color("#EF4444") + mutedColor = lipgloss.Color("#6B7280") + backgroundColor = lipgloss.Color("#1F2937") + + titleStyle = lipgloss.NewStyle(). + Bold(true). + Foreground(lipgloss.Color("#FFFFFF")). + Background(primaryColor). + Padding(0, 1) + + sectionStyle = lipgloss.NewStyle(). + Bold(true). + Foreground(primaryColor). + MarginTop(1). + MarginBottom(1) + + okStyle = lipgloss.NewStyle(). + Foreground(successColor) + + warnStyle = lipgloss.NewStyle(). + Foreground(warningColor) + + errStyle = lipgloss.NewStyle(). + Foreground(errorColor) + + mutedStyle = lipgloss.NewStyle(). + Foreground(mutedColor) + + tableHeaderStyle = lipgloss.NewStyle(). + Bold(true). + Foreground(lipgloss.Color("#FFFFFF")). + Background(lipgloss.Color("#374151")). + Padding(0, 1) + + tableCellStyle = lipgloss.NewStyle(). + Padding(0, 1) + + boxStyle = lipgloss.NewStyle(). + Border(lipgloss.RoundedBorder()). + BorderForeground(lipgloss.Color("#374151")). + Padding(1, 2) + + selectedStyle = lipgloss.NewStyle(). + Bold(true). + Foreground(lipgloss.Color("#FFFFFF")). + Background(primaryColor) + + buttonStyle = lipgloss.NewStyle(). + Foreground(lipgloss.Color("#FFFFFF")). + Background(lipgloss.Color("#4B5563")). + Padding(0, 2) + + buttonActiveStyle = lipgloss.NewStyle(). + Foreground(lipgloss.Color("#FFFFFF")). + Background(primaryColor). + Padding(0, 2) + + spinnerStyle = lipgloss.NewStyle(). + Foreground(primaryColor) + + helpStyle = lipgloss.NewStyle(). + Foreground(mutedColor). + MarginTop(1) +) + +func statusIcon(ok bool) string { + if ok { + return okStyle.Render("✓") + } + return errStyle.Render("✗") +} + +func statusIconTri(status string) string { + switch status { + case "ok": + return okStyle.Render("✓") + case "warning": + return warnStyle.Render("!") + case "missing", "error": + return errStyle.Render("✗") + default: + return mutedStyle.Render("?") + } +} diff --git a/v3/pkg/doctor-ng/types.go b/v3/pkg/doctor-ng/types.go new file mode 100644 index 000000000..e67991bbd --- /dev/null +++ b/v3/pkg/doctor-ng/types.go @@ -0,0 +1,271 @@ +// Package doctorng provides system diagnostics and dependency checking for Wails. +// It exposes a public API suitable for both CLI and GUI consumption. +package doctorng + +import ( + "encoding/json" + "time" +) + +// Status represents the health status of a check +type Status int + +const ( + StatusUnknown Status = iota + StatusOK + StatusWarning + StatusError + StatusMissing +) + +func (s Status) String() string { + switch s { + case StatusOK: + return "ok" + case StatusWarning: + return "warning" + case StatusError: + return "error" + case StatusMissing: + return "missing" + default: + return "unknown" + } +} + +func (s Status) MarshalJSON() ([]byte, error) { + return json.Marshal(s.String()) +} + +// SystemInfo contains information about the host system +type SystemInfo struct { + // Operating system details + OS OSInfo `json:"os"` + + // Hardware information + Hardware HardwareInfo `json:"hardware"` + + // Environment variables relevant to Wails + Environment map[string]string `json:"environment"` + + // Platform-specific extras (e.g., XDG_SESSION_TYPE on Linux) + PlatformExtras map[string]string `json:"platform_extras,omitempty"` +} + +// OSInfo contains operating system details +type OSInfo struct { + Name string `json:"name"` + Version string `json:"version"` + ID string `json:"id"` + Branding string `json:"branding,omitempty"` + Platform string `json:"platform"` // darwin, linux, windows + Arch string `json:"arch"` // amd64, arm64, etc. +} + +// HardwareInfo contains hardware details +type HardwareInfo struct { + CPUs []CPUInfo `json:"cpus"` + GPUs []GPUInfo `json:"gpus"` + Memory string `json:"memory"` +} + +// CPUInfo contains CPU details +type CPUInfo struct { + Model string `json:"model"` + Cores int `json:"cores,omitempty"` +} + +// GPUInfo contains GPU details +type GPUInfo struct { + Name string `json:"name"` + Vendor string `json:"vendor,omitempty"` + Driver string `json:"driver,omitempty"` +} + +// BuildInfo contains build environment information +type BuildInfo struct { + WailsVersion string `json:"wails_version"` + GoVersion string `json:"go_version"` + BuildMode string `json:"build_mode,omitempty"` + Compiler string `json:"compiler,omitempty"` + CGOEnabled bool `json:"cgo_enabled"` + Settings map[string]string `json:"settings,omitempty"` +} + +// Dependency represents a system dependency +type Dependency struct { + // Name is the display name for this dependency + Name string `json:"name"` + + // PackageName is the actual package name in the package manager + PackageName string `json:"package_name,omitempty"` + + // Version is the installed version (empty if not installed) + Version string `json:"version,omitempty"` + + // Status indicates the installation status + Status Status `json:"status"` + + // Required indicates if this dependency is required (vs optional) + Required bool `json:"required"` + + // InstallCommand is the command to install this dependency + InstallCommand string `json:"install_command,omitempty"` + + // Description provides context about what this dependency is for + Description string `json:"description,omitempty"` + + // Category groups related dependencies (e.g., "gtk", "build-tools") + Category string `json:"category,omitempty"` +} + +// DependencyList is a collection of dependencies with helper methods +type DependencyList []*Dependency + +// RequiredMissing returns all required dependencies that are missing +func (d DependencyList) RequiredMissing() DependencyList { + var result DependencyList + for _, dep := range d { + if dep.Required && dep.Status != StatusOK { + result = append(result, dep) + } + } + return result +} + +// OptionalMissing returns all optional dependencies that are missing +func (d DependencyList) OptionalMissing() DependencyList { + var result DependencyList + for _, dep := range d { + if !dep.Required && dep.Status != StatusOK { + result = append(result, dep) + } + } + return result +} + +// AllInstalled returns true if all required dependencies are installed +func (d DependencyList) AllInstalled() bool { + for _, dep := range d { + if dep.Required && dep.Status != StatusOK { + return false + } + } + return true +} + +// ByCategory groups dependencies by their category +func (d DependencyList) ByCategory() map[string]DependencyList { + result := make(map[string]DependencyList) + for _, dep := range d { + cat := dep.Category + if cat == "" { + cat = "other" + } + result[cat] = append(result[cat], dep) + } + return result +} + +// InstallCommands returns install commands for all missing dependencies +func (d DependencyList) InstallCommands(requiredOnly bool) []string { + var commands []string + for _, dep := range d { + if dep.Status != StatusOK && dep.InstallCommand != "" { + if requiredOnly && !dep.Required { + continue + } + commands = append(commands, dep.InstallCommand) + } + } + return commands +} + +// DiagnosticSeverity indicates the severity of a diagnostic issue +type DiagnosticSeverity int + +const ( + SeverityInfo DiagnosticSeverity = iota + SeverityWarning + SeverityError +) + +func (s DiagnosticSeverity) String() string { + switch s { + case SeverityInfo: + return "info" + case SeverityWarning: + return "warning" + case SeverityError: + return "error" + default: + return "unknown" + } +} + +// DiagnosticResult represents the result of a diagnostic check +type DiagnosticResult struct { + // Name is a short identifier for this diagnostic + Name string `json:"name"` + + // Message describes the issue or status + Message string `json:"message"` + + // Severity indicates how serious the issue is + Severity DiagnosticSeverity `json:"severity"` + + // HelpURL points to documentation about this issue + HelpURL string `json:"help_url,omitempty"` + + // Fix contains instructions or a command to fix the issue + Fix *Fix `json:"fix,omitempty"` +} + +// Fix describes how to fix an issue +type Fix struct { + // Description explains what the fix does + Description string `json:"description"` + + // Command is a shell command that can be run to fix the issue + // May be empty if manual intervention is required + Command string `json:"command,omitempty"` + + // RequiresSudo indicates if the fix requires elevated privileges + RequiresSudo bool `json:"requires_sudo,omitempty"` + + // ManualSteps are human-readable instructions if no command is available + ManualSteps []string `json:"manual_steps,omitempty"` +} + +// Report is the complete doctor report +type Report struct { + // Timestamp when the report was generated + Timestamp time.Time `json:"timestamp"` + + // System information + System SystemInfo `json:"system"` + + // Build environment + Build BuildInfo `json:"build"` + + // Dependencies and their status + Dependencies DependencyList `json:"dependencies"` + + // Diagnostic results (issues found) + Diagnostics []DiagnosticResult `json:"diagnostics"` + + // Overall status + Ready bool `json:"ready"` + + // Summary message + Summary string `json:"summary"` +} + +// NewReport creates a new empty report with the current timestamp +func NewReport() *Report { + return &Report{ + Timestamp: time.Now(), + Dependencies: make(DependencyList, 0), + Diagnostics: make([]DiagnosticResult, 0), + } +} diff --git a/v3/pkg/mac/mac.go b/v3/pkg/mac/mac.go new file mode 100644 index 000000000..73e0258b0 --- /dev/null +++ b/v3/pkg/mac/mac.go @@ -0,0 +1,24 @@ +//go:build darwin + +// Package mac provides a set of functions to interact with the macOS platform. +package mac + +/* +#cgo CFLAGS: -x objective-c +#cgo LDFLAGS: -framework Foundation -framework ServiceManagement + +#import +#import + +// Get the bundle ID +char* getBundleID() { + NSString *bundleID = [[NSBundle mainBundle] bundleIdentifier]; + return (char*)[bundleID UTF8String]; +} +*/ +import "C" + +// GetBundleID returns the bundle ID of the application. +func GetBundleID() string { + return C.GoString(C.getBundleID()) +} diff --git a/v3/pkg/services/dock/badge_ios.go b/v3/pkg/services/dock/badge_ios.go new file mode 100644 index 000000000..136771839 --- /dev/null +++ b/v3/pkg/services/dock/badge_ios.go @@ -0,0 +1,71 @@ +//go:build ios + +package dock + +import ( + "context" + + "github.com/wailsapp/wails/v3/pkg/application" +) + +type iosDock struct { +} + +// New creates a new Dock Service. +// On iOS, this returns a stub implementation. +// iOS badge functionality will be implemented via native bridges. +func New() *DockService { + return &DockService{ + impl: &iosDock{}, + } +} + +// NewWithOptions creates a new dock service with badge options. +// On iOS, this returns a stub implementation. Options are ignored. +func NewWithOptions(options BadgeOptions) *DockService { + return New() +} + +func (d *iosDock) Startup(ctx context.Context, options application.ServiceOptions) error { + // iOS dock/badge startup - implementation pending native bridge + return nil +} + +func (d *iosDock) Shutdown() error { + // iOS dock/badge shutdown - implementation pending native bridge + return nil +} + +// HideAppIcon is a stub on iOS. +func (d *iosDock) HideAppIcon() { + // No-op: iOS doesn't support hiding app icon +} + +// ShowAppIcon is a stub on iOS. +func (d *iosDock) ShowAppIcon() { + // No-op: iOS doesn't support showing/hiding app icon +} + +// SetBadge sets the badge on the iOS app icon. +func (d *iosDock) SetBadge(label string) error { + // iOS badge implementation would go here via native bridge + return nil +} + +// SetCustomBadge is a stub on iOS since iOS badges don't support custom styling. +func (d *iosDock) SetCustomBadge(label string, options BadgeOptions) error { + // iOS doesn't support custom badge styling, fall back to standard badge + return d.SetBadge(label) +} + +// RemoveBadge removes the badge from the iOS app icon. +func (d *iosDock) RemoveBadge() error { + // iOS badge removal would go here via native bridge + return nil +} + +// GetBadge retrieves the badge from the iOS app icon. +func (d *iosDock) GetBadge() *string { + // iOS badge retrieval would go here via native bridge + return nil +} diff --git a/v3/pkg/services/dock/dock.go b/v3/pkg/services/dock/dock.go new file mode 100644 index 000000000..3f9890c67 --- /dev/null +++ b/v3/pkg/services/dock/dock.go @@ -0,0 +1,83 @@ +package dock + +import ( + "context" + "image/color" + + "github.com/wailsapp/wails/v3/pkg/application" +) + +type platformDock interface { + // Lifecycle methods + Startup(ctx context.Context, options application.ServiceOptions) error + Shutdown() error + + // Dock icon visibility methods + HideAppIcon() + ShowAppIcon() + + // Badge methods + SetBadge(label string) error + SetCustomBadge(label string, options BadgeOptions) error + RemoveBadge() error + GetBadge() *string +} + +// Service represents the dock service +type DockService struct { + impl platformDock +} + +// BadgeOptions represents options for customizing badge appearance +type BadgeOptions struct { + TextColour color.RGBA + BackgroundColour color.RGBA + FontName string + FontSize int + SmallFontSize int +} + +// ServiceName returns the name of the service. +func (d *DockService) ServiceName() string { + return "github.com/wailsapp/wails/v3/pkg/services/dock" +} + +// ServiceStartup is called when the service is loaded. +func (d *DockService) ServiceStartup(ctx context.Context, options application.ServiceOptions) error { + return d.impl.Startup(ctx, options) +} + +// ServiceShutdown is called when the service is unloaded. +func (d *DockService) ServiceShutdown() error { + return d.impl.Shutdown() +} + +// HideAppIcon hides the app icon in the dock/taskbar. +func (d *DockService) HideAppIcon() { + d.impl.HideAppIcon() +} + +// ShowAppIcon shows the app icon in the dock/taskbar. +func (d *DockService) ShowAppIcon() { + d.impl.ShowAppIcon() +} + +// SetBadge sets the badge label on the application icon. +func (d *DockService) SetBadge(label string) error { + return d.impl.SetBadge(label) +} + +// SetCustomBadge sets the badge label on the application icon with custom options. +func (d *DockService) SetCustomBadge(label string, options BadgeOptions) error { + return d.impl.SetCustomBadge(label, options) +} + +// RemoveBadge removes the badge label from the application icon. +func (d *DockService) RemoveBadge() error { + return d.impl.RemoveBadge() +} + +// GetBadge returns the badge label on the application icon. +func (d *DockService) GetBadge() *string { + return d.impl.GetBadge() +} diff --git a/v3/pkg/services/dock/dock_darwin.go b/v3/pkg/services/dock/dock_darwin.go new file mode 100644 index 000000000..361e3ef8a --- /dev/null +++ b/v3/pkg/services/dock/dock_darwin.go @@ -0,0 +1,140 @@ +//go:build darwin + +package dock + +/* +#cgo CFLAGS: -x objective-c +#cgo LDFLAGS: -framework Cocoa +#import + +void hideDockIcon() { + dispatch_sync(dispatch_get_main_queue(), ^{ + [NSApp setActivationPolicy:NSApplicationActivationPolicyAccessory]; + }); +} + +void showDockIcon() { + dispatch_sync(dispatch_get_main_queue(), ^{ + [NSApp setActivationPolicy:NSApplicationActivationPolicyRegular]; + }); +} + +bool setBadge(const char *label) { + __block bool success = false; + dispatch_sync(dispatch_get_main_queue(), ^{ + // Ensure the app is in Regular activation policy (dock icon visible) + NSApplicationActivationPolicy currentPolicy = [NSApp activationPolicy]; + if (currentPolicy != NSApplicationActivationPolicyRegular) { + success = false; + return; + } + + NSString *nsLabel = nil; + if (label != NULL) { + nsLabel = [NSString stringWithUTF8String:label]; + } + [[NSApp dockTile] setBadgeLabel:nsLabel]; + [[NSApp dockTile] display]; + success = true; + }); + return success; +} +*/ +import "C" +import ( + "context" + "fmt" + "sync" + "unsafe" + + "github.com/wailsapp/wails/v3/pkg/application" +) + +type darwinDock struct { + mu sync.RWMutex + Badge *string +} + +// Creates a new Dock Service. +func New() *DockService { + return &DockService{ + impl: &darwinDock{ + Badge: nil, + }, + } +} + +// NewWithOptions creates a new dock service with badge options. +// Currently, options are not available on macOS and are ignored. +func NewWithOptions(options BadgeOptions) *DockService { + return New() +} + +func (d *darwinDock) Startup(ctx context.Context, options application.ServiceOptions) error { + return nil +} + +func (d *darwinDock) Shutdown() error { + return nil +} + +// HideAppIcon hides the app icon in the macOS Dock. +func (d *darwinDock) HideAppIcon() { + C.hideDockIcon() +} + +// ShowAppIcon shows the app icon in the macOS Dock. +// Note: After showing the dock icon, you may need to call SetBadge again +// to reapply any previously set badge, as changing activation policies clears the badge. +func (d *darwinDock) ShowAppIcon() { + C.showDockIcon() +} + +// setBadge handles the C call and updates the internal badge state with locking. +func (d *darwinDock) setBadge(label *string) error { + var cLabel *C.char + if label != nil { + cLabel = C.CString(*label) + defer C.free(unsafe.Pointer(cLabel)) + } + + success := C.setBadge(cLabel) + if !success { + return fmt.Errorf("failed to set badge") + } + + d.mu.Lock() + d.Badge = label + d.mu.Unlock() + + return nil +} + +// SetBadge sets the badge label on the application icon. +// Available default badge labels: +// Single space " " empty badge +// Empty string "" dot "●" indeterminate badge +func (d *darwinDock) SetBadge(label string) error { + // Always pick a label (use "●" if empty), then allocate + free exactly once. + if label == "" { + label = "●" // Default badge character + } + return d.setBadge(&label) +} + +// SetCustomBadge is not supported on macOS, SetBadge is called instead. +func (d *darwinDock) SetCustomBadge(label string, options BadgeOptions) error { + return d.SetBadge(label) +} + +// RemoveBadge removes the badge label from the application icon. +func (d *darwinDock) RemoveBadge() error { + return d.setBadge(nil) +} + +// GetBadge returns the badge label on the application icon. +func (d *darwinDock) GetBadge() *string { + d.mu.RLock() + defer d.mu.RUnlock() + return d.Badge +} diff --git a/v3/pkg/services/dock/dock_linux.go b/v3/pkg/services/dock/dock_linux.go new file mode 100644 index 000000000..633e6b005 --- /dev/null +++ b/v3/pkg/services/dock/dock_linux.go @@ -0,0 +1,75 @@ +//go:build linux + +package dock + +import ( + "context" + + "github.com/wailsapp/wails/v3/pkg/application" +) + +type linuxDock struct{} + +// New creates a new Dock Service. +// On Linux, this returns a stub implementation since dock icon visibility +// and badge functionality are not standardized across desktop environments. +func New() *DockService { + return &DockService{ + impl: &linuxDock{}, + } +} + +// NewWithOptions creates a new dock service with badge options. +// On Linux, this returns a stub implementation since badge functionality +// is not standardized across desktop environments. Options are ignored. +func NewWithOptions(options BadgeOptions) *DockService { + return New() +} + +func (l *linuxDock) Startup(ctx context.Context, options application.ServiceOptions) error { + // No-op: Linux doesn't have standardized dock/badge support + return nil +} + +func (l *linuxDock) Shutdown() error { + // No-op: Linux doesn't have standardized dock/badge support + return nil +} + +// HideAppIcon is a stub on Linux since dock icon visibility is not +// standardized across desktop environments. +func (l *linuxDock) HideAppIcon() { + // No-op: Linux doesn't have standardized dock icon visibility support +} + +// ShowAppIcon is a stub on Linux since dock icon visibility is not +// standardized across desktop environments. +func (l *linuxDock) ShowAppIcon() { + // No-op: Linux doesn't have standardized dock icon visibility support +} + +// SetBadge is a stub on Linux since most desktop environments don't support +// application dock badges. This method exists for cross-platform compatibility. +func (l *linuxDock) SetBadge(label string) error { + // No-op: Linux doesn't have standardized badge support + return nil +} + +// SetCustomBadge is a stub on Linux since most desktop environments don't support +// application dock badges. This method exists for cross-platform compatibility. +func (l *linuxDock) SetCustomBadge(label string, options BadgeOptions) error { + // No-op: Linux doesn't have standardized badge support + return nil +} + +// RemoveBadge is a stub on Linux since most desktop environments don't support +// application dock badges. This method exists for cross-platform compatibility. +func (l *linuxDock) RemoveBadge() error { + // No-op: Linux doesn't have standardized badge support + return nil +} + +func (l *linuxDock) GetBadge() *string { + // No-op: Linux doesn't have standardized badge support + return nil +} \ No newline at end of file diff --git a/v3/pkg/services/dock/dock_windows.go b/v3/pkg/services/dock/dock_windows.go new file mode 100644 index 000000000..0a0c45efe --- /dev/null +++ b/v3/pkg/services/dock/dock_windows.go @@ -0,0 +1,405 @@ +//go:build windows + +package dock + +import ( + "bytes" + "context" + "errors" + "image" + "image/color" + "image/png" + "os" + + "github.com/wailsapp/wails/v3/pkg/application" + "github.com/wailsapp/wails/v3/pkg/w32" + "golang.org/x/image/font" + "golang.org/x/image/font/opentype" + "golang.org/x/image/math/fixed" +) + +type windowsDock struct { + taskbar *w32.ITaskbarList3 + badgeImg *image.RGBA + badgeSize int + fontManager *FontManager + badgeOptions BadgeOptions + badge *string +} + +var defaultOptions = BadgeOptions{ + TextColour: color.RGBA{255, 255, 255, 255}, + BackgroundColour: color.RGBA{255, 0, 0, 255}, + FontName: "segoeuib.ttf", + FontSize: 18, + SmallFontSize: 14, +} + +// Creates a new Badge Service. +func New() *DockService { + return &DockService{ + impl: &windowsDock{ + badgeOptions: defaultOptions, + }, + } +} + +// NewWithOptions creates a new badge service with the given badge options. +func NewWithOptions(options BadgeOptions) *DockService { + return &DockService{ + impl: &windowsDock{ + badgeOptions: options, + badge: nil, + }, + } +} + +func (w *windowsDock) Startup(ctx context.Context, options application.ServiceOptions) error { + taskbar, err := w32.NewTaskbarList3() + if err != nil { + return err + } + w.taskbar = taskbar + w.fontManager = NewFontManager() + + return nil +} + +func (w *windowsDock) Shutdown() error { + if w.taskbar != nil { + w.taskbar.Release() + } + + return nil +} + +// HideAppIcon hides the app icon in the macOS Dock. +func (w *windowsDock) HideAppIcon() { + // No-op: researching Windows options +} + +// ShowAppIcon shows the app icon in the macOS Dock. +func (w *windowsDock) ShowAppIcon() { + // No-op: researching Windows options +} + +// SetBadge sets the badge label on the application icon. +func (w *windowsDock) SetBadge(label string) error { + return application.InvokeSyncWithError(func() error { + if w.taskbar == nil { + return nil + } + + app := application.Get() + if app == nil { + return nil + } + + window := app.Window.Current() + if window == nil { + return nil + } + + nativeWindow := window.NativeWindow() + if nativeWindow == nil { + return errors.New("window native handle unavailable") + } + hwnd := uintptr(nativeWindow) + + w.createBadge() + + var hicon w32.HICON + var err error + if label == "" { + hicon, err = w.createBadgeIcon() + if err != nil { + return err + } + } else { + hicon, err = w.createBadgeIconWithText(label) + if err != nil { + return err + } + } + defer w32.DestroyIcon(hicon) + + w.badge = &label + return w.taskbar.SetOverlayIcon(hwnd, hicon, nil) + }) +} + +// SetCustomBadge sets the badge label on the application icon with one-off options. +func (w *windowsDock) SetCustomBadge(label string, options BadgeOptions) error { + return application.InvokeSyncWithError(func() error { + if w.taskbar == nil { + return nil + } + + app := application.Get() + if app == nil { + return nil + } + + window := app.Window.Current() + if window == nil { + return nil + } + + nativeWindow := window.NativeWindow() + if nativeWindow == nil { + return errors.New("window native handle unavailable") + } + hwnd := uintptr(nativeWindow) + + const badgeSize = 32 + + img := image.NewRGBA(image.Rect(0, 0, badgeSize, badgeSize)) + + backgroundColour := options.BackgroundColour + radius := badgeSize / 2 + centerX, centerY := radius, radius + + for y := 0; y < badgeSize; y++ { + for x := 0; x < badgeSize; x++ { + dx := float64(x - centerX) + dy := float64(y - centerY) + + if dx*dx+dy*dy < float64(radius*radius) { + img.Set(x, y, backgroundColour) + } + } + } + + var hicon w32.HICON + var err error + if label == "" { + hicon, err = createBadgeIcon(badgeSize, img, options) + if err != nil { + return err + } + } else { + hicon, err = createBadgeIconWithText(w, label, badgeSize, img, options) + if err != nil { + return err + } + } + defer w32.DestroyIcon(hicon) + + w.badge = &label + return w.taskbar.SetOverlayIcon(hwnd, hicon, nil) + }) +} + +// RemoveBadge removes the badge label from the application icon. +func (w *windowsDock) RemoveBadge() error { + return application.InvokeSyncWithError(func() error { + if w.taskbar == nil { + return nil + } + + app := application.Get() + if app == nil { + return nil + } + + window := app.Window.Current() + if window == nil { + return nil + } + + nativeWindow := window.NativeWindow() + if nativeWindow == nil { + return errors.New("window native handle unavailable") + } + hwnd := uintptr(nativeWindow) + + w.badge = nil + return w.taskbar.SetOverlayIcon(hwnd, 0, nil) + }) +} + +// createBadgeIcon creates a badge icon with the specified size and color. +func (w *windowsDock) createBadgeIcon() (w32.HICON, error) { + radius := w.badgeSize / 2 + centerX, centerY := radius, radius + innerRadius := w.badgeSize / 5 + + for y := 0; y < w.badgeSize; y++ { + for x := 0; x < w.badgeSize; x++ { + dx := float64(x - centerX) + dy := float64(y - centerY) + + if dx*dx+dy*dy < float64(innerRadius*innerRadius) { + w.badgeImg.Set(x, y, w.badgeOptions.TextColour) + } + } + } + + var buf bytes.Buffer + if err := png.Encode(&buf, w.badgeImg); err != nil { + return 0, err + } + + hicon, err := w32.CreateSmallHIconFromImage(buf.Bytes()) + return hicon, err +} + +func createBadgeIcon(badgeSize int, img *image.RGBA, options BadgeOptions) (w32.HICON, error) { + radius := badgeSize / 2 + centerX, centerY := radius, radius + innerRadius := badgeSize / 5 + + for y := 0; y < badgeSize; y++ { + for x := 0; x < badgeSize; x++ { + dx := float64(x - centerX) + dy := float64(y - centerY) + + if dx*dx+dy*dy < float64(innerRadius*innerRadius) { + img.Set(x, y, options.TextColour) + } + } + } + + var buf bytes.Buffer + if err := png.Encode(&buf, img); err != nil { + return 0, err + } + + hicon, err := w32.CreateSmallHIconFromImage(buf.Bytes()) + return hicon, err +} + +// createBadgeIconWithText creates a badge icon with the specified text. +func (w *windowsDock) createBadgeIconWithText(label string) (w32.HICON, error) { + fontPath := w.fontManager.FindFontOrDefault(w.badgeOptions.FontName) + if fontPath == "" { + return w.createBadgeIcon() + } + + fontBytes, err := os.ReadFile(fontPath) + if err != nil { + return w.createBadgeIcon() + } + + ttf, err := opentype.Parse(fontBytes) + if err != nil { + return w.createBadgeIcon() + } + + fontSize := float64(w.badgeOptions.FontSize) + if len(label) > 1 { + fontSize = float64(w.badgeOptions.SmallFontSize) + } + + // Get DPI of the current screen + screen := w32.GetDesktopWindow() + dpi := w32.GetDpiForWindow(screen) + + face, err := opentype.NewFace(ttf, &opentype.FaceOptions{ + Size: fontSize, + DPI: float64(dpi), + Hinting: font.HintingFull, + }) + if err != nil { + return w.createBadgeIcon() + } + defer face.Close() + + d := &font.Drawer{ + Dst: w.badgeImg, + Src: image.NewUniform(w.badgeOptions.TextColour), + Face: face, + } + + textWidth := d.MeasureString(label).Ceil() + d.Dot = fixed.P((w.badgeSize-textWidth)/2, int(float64(w.badgeSize)/2+fontSize/2)) + d.DrawString(label) + + var buf bytes.Buffer + if err := png.Encode(&buf, w.badgeImg); err != nil { + return 0, err + } + + return w32.CreateSmallHIconFromImage(buf.Bytes()) +} + +func createBadgeIconWithText(w *windowsDock, label string, badgeSize int, img *image.RGBA, options BadgeOptions) (w32.HICON, error) { + fontPath := w.fontManager.FindFontOrDefault(options.FontName) + if fontPath == "" { + return createBadgeIcon(badgeSize, img, options) + } + + fontBytes, err := os.ReadFile(fontPath) + if err != nil { + return createBadgeIcon(badgeSize, img, options) + } + + ttf, err := opentype.Parse(fontBytes) + if err != nil { + return createBadgeIcon(badgeSize, img, options) + } + + fontSize := float64(options.FontSize) + if len(label) > 1 { + fontSize = float64(options.SmallFontSize) + } + + // Get DPI of the current screen + screen := w32.GetDesktopWindow() + dpi := w32.GetDpiForWindow(screen) + + face, err := opentype.NewFace(ttf, &opentype.FaceOptions{ + Size: fontSize, + DPI: float64(dpi), + Hinting: font.HintingFull, + }) + if err != nil { + return createBadgeIcon(badgeSize, img, options) + } + defer face.Close() + + d := &font.Drawer{ + Dst: img, + Src: image.NewUniform(options.TextColour), + Face: face, + } + + textWidth := d.MeasureString(label).Ceil() + d.Dot = fixed.P((badgeSize-textWidth)/2, int(float64(badgeSize)/2+fontSize/2)) + d.DrawString(label) + + var buf bytes.Buffer + if err := png.Encode(&buf, img); err != nil { + return 0, err + } + + return w32.CreateSmallHIconFromImage(buf.Bytes()) +} + +// createBadge creates a circular badge with the specified background color. +func (w *windowsDock) createBadge() { + w.badgeSize = 32 + + img := image.NewRGBA(image.Rect(0, 0, w.badgeSize, w.badgeSize)) + + backgroundColour := w.badgeOptions.BackgroundColour + radius := w.badgeSize / 2 + centerX, centerY := radius, radius + + for y := 0; y < w.badgeSize; y++ { + for x := 0; x < w.badgeSize; x++ { + dx := float64(x - centerX) + dy := float64(y - centerY) + + if dx*dx+dy*dy < float64(radius*radius) { + img.Set(x, y, backgroundColour) + } + } + } + + w.badgeImg = img +} + +func (w *windowsDock) GetBadge() *string { + return w.badge +} \ No newline at end of file diff --git a/v3/pkg/services/dock/font.go b/v3/pkg/services/dock/font.go new file mode 100644 index 000000000..54dcc8cd6 --- /dev/null +++ b/v3/pkg/services/dock/font.go @@ -0,0 +1,153 @@ +//go:build windows + +package dock + +import ( + "errors" + "os" + "path/filepath" + "strings" + "sync" + + "golang.org/x/sys/windows/registry" +) + +// FontManager handles font discovery on Windows with minimal caching +type FontManager struct { + fontCache map[string]string // Maps only requested font filenames to paths + fontDirs []string // Directories to search for fonts + mu sync.RWMutex // Mutex for thread-safe access to the cache + registryPaths []string // Registry paths to search for fonts +} + +// NewFontManager creates a new FontManager instance +func NewFontManager() *FontManager { + return &FontManager{ + fontCache: make(map[string]string), + fontDirs: []string{ + filepath.Join(os.Getenv("windir"), "Fonts"), + filepath.Join(os.Getenv("localappdata"), "Microsoft", "Windows", "Fonts"), + }, + registryPaths: []string{ + `SOFTWARE\Microsoft\Windows NT\CurrentVersion\Fonts`, + }, + } +} + +// FindFont searches for a font by filename and returns its full path +// Only caches fonts that are found +func (fm *FontManager) FindFont(fontFilename string) (string, error) { + fontKey := strings.ToLower(fontFilename) + + // Check if already in cache + fm.mu.RLock() + if path, exists := fm.fontCache[fontKey]; exists { + fm.mu.RUnlock() + return path, nil + } + fm.mu.RUnlock() + + // If not in cache, search for the font + fontPath, err := fm.searchForFont(fontFilename) + if err != nil { + return "", err + } + + // Add to cache only if found + fm.mu.Lock() + fm.fontCache[fontKey] = fontPath + fm.mu.Unlock() + + return fontPath, nil +} + +// searchForFont looks for a font in all known locations +func (fm *FontManager) searchForFont(fontFilename string) (string, error) { + fontFileLower := strings.ToLower(fontFilename) + + // 1. Direct file check in font directories (fastest approach) + for _, dir := range fm.fontDirs { + fontPath := filepath.Join(dir, fontFilename) + if fileExists(fontPath) { + return fontPath, nil + } + } + + // 2. Search in registry (can find fonts with different paths) + // System fonts (HKEY_LOCAL_MACHINE) + for _, regPath := range fm.registryPaths { + k, err := registry.OpenKey(registry.LOCAL_MACHINE, regPath, registry.QUERY_VALUE) + if err == nil { + defer k.Close() + + // Look for the specific font in registry values + fontPath, found := fm.findFontInRegistry(k, fontFileLower, fm.fontDirs[0]) + if found { + return fontPath, nil + } + } + } + + // 3. User fonts (HKEY_CURRENT_USER) + for _, regPath := range fm.registryPaths { + k, err := registry.OpenKey(registry.CURRENT_USER, regPath, registry.QUERY_VALUE) + if err == nil { + defer k.Close() + + // Look for the specific font in registry values + fontPath, found := fm.findFontInRegistry(k, fontFileLower, fm.fontDirs[1]) + if found { + return fontPath, nil + } + } + } + + return "", errors.New("font not found: " + fontFilename) +} + +// findFontInRegistry searches for a specific font in a registry key +func (fm *FontManager) findFontInRegistry(k registry.Key, fontFileLower string, defaultDir string) (string, bool) { + valueNames, err := k.ReadValueNames(0) + if err != nil { + return "", false + } + + for _, name := range valueNames { + value, _, err := k.GetStringValue(name) + if err != nil { + continue + } + + // Check if this registry entry corresponds to our font + valueLower := strings.ToLower(value) + if strings.HasSuffix(valueLower, fontFileLower) { + // If it's a relative path, assume it's in the default font directory + if !strings.Contains(value, "\\") { + value = filepath.Join(defaultDir, value) + } + + if fileExists(value) { + return value, true + } + } + } + + return "", false +} + +func (fm *FontManager) FindFontOrDefault(name string) string { + fontsToFind := []string{name, "segoeuib.ttf", "arialbd.ttf"} + for _, font := range fontsToFind { + path, err := fm.FindFont(font) + if err == nil { + return path + } + } + return "" +} + +// Helper functions +func fileExists(path string) bool { + info, err := os.Stat(path) + return err == nil && !info.IsDir() +} diff --git a/v3/pkg/services/fileserver/fileserver.go b/v3/pkg/services/fileserver/fileserver.go new file mode 100644 index 000000000..de06f5c1a --- /dev/null +++ b/v3/pkg/services/fileserver/fileserver.go @@ -0,0 +1,54 @@ +package fileserver + +import ( + "net/http" + "sync/atomic" +) + +type Config struct { + // RootPath specifies the filesystem path from which requests are to be served. + RootPath string +} + +type FileserverService struct { + fs atomic.Pointer[http.Handler] +} + +// New initialises an unconfigured fileserver. See [Configure] for details. +func New() *FileserverService { + return NewWithConfig(nil) +} + +// New initialises and optionally configures a fileserver. See [Service.Configure] for details. +func NewWithConfig(config *Config) *FileserverService { + result := &FileserverService{} + result.Configure(config) + return result +} + +// ServiceName returns the name of the plugin. +// You should use the go module format e.g. github.com/myuser/myplugin +func (s *FileserverService) ServiceName() string { + return "github.com/wailsapp/wails/v3/services/fileserver" +} + +// Configure reconfigures the fileserver. +// If config is nil, then every request will receive a 503 Service Unavailable response. +// +//wails:ignore +func (s *FileserverService) Configure(config *Config) { + if config == nil { + s.fs.Store(&dummyHandler) + } else { + var fs http.Handler = http.FileServer(http.Dir(config.RootPath)) + s.fs.Store(&fs) + } +} + +func (s *FileserverService) ServeHTTP(w http.ResponseWriter, r *http.Request) { + (*s.fs.Load()).ServeHTTP(w, r) +} + +var dummyHandler http.Handler = http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { + http.Error(w, "Fileserver service has not been configured yet", http.StatusServiceUnavailable) +}) diff --git a/v3/pkg/services/kvstore/kvstore.go b/v3/pkg/services/kvstore/kvstore.go new file mode 100644 index 000000000..4d2f511b0 --- /dev/null +++ b/v3/pkg/services/kvstore/kvstore.go @@ -0,0 +1,228 @@ +package kvstore + +import ( + "context" + "os" + "sync" + + "encoding/json" + "github.com/pkg/errors" + "github.com/wailsapp/wails/v3/pkg/application" +) + +type Config struct { + // Filename specifies the path of the on-disk file associated to the key-value store. + Filename string + + // AutoSave specifies whether the store + // must be written to disk automatically after every modification. + // When AutoSave is false, stores are only saved to disk upon shutdown + // or when the [Service.Save] method is called manually. + AutoSave bool +} + +type KVStoreService struct { + lock sync.RWMutex + + config *Config + + data map[string]any + unsaved bool +} + +// New initialises an in-memory key-value store. See [NewWithConfig] for details. +func New() *KVStoreService { + return NewWithConfig(nil) +} + +// NewWithConfig initialises a key-value store with the given configuration: +// - if config is nil, the new store is in-memory, i.e. not associated with a file; +// - if config is non-nil, the associated file is not loaded until [Service.Load] is called. +// +// If the store is registered with the application as a service, +// [Service.Load] will be called automatically at startup. +func NewWithConfig(config *Config) *KVStoreService { + result := &KVStoreService{data: make(map[string]any)} + result.Configure(config) + return result +} + +// ServiceName returns the name of the plugin. +func (kvs *KVStoreService) ServiceName() string { + return "github.com/wailsapp/wails/v3/plugins/kvstore" +} + +// ServiceStartup loads the store from disk if it is associated with a file. +// It returns a non-nil error in case of failure. +func (kvs *KVStoreService) ServiceStartup(ctx context.Context, options application.ServiceOptions) error { + return errors.Wrap(kvs.Load(), "error loading store") +} + +// ServiceShutdown saves the store to disk if it is associated with a file. +// It returns a non-nil error in case of failure. +func (kvs *KVStoreService) ServiceShutdown() error { + return errors.Wrap(kvs.Save(), "error saving store") +} + +// Configure changes the store's configuration. +// The contents of the store at call time are preserved and marked unsaved. +// Consumers will need to call [Service.Load] manually after Configure +// in order to load a new file. +// +// If the store is unsaved upon calling Configure, no attempt is made at saving it. +// Consumers will need to call [Service.Save] manually beforehand. +// +// See [NewWithConfig] for details on configuration. +// +//wails:ignore +func (kvs *KVStoreService) Configure(config *Config) { + if config != nil { + // Clone to prevent changes from the outside. + clone := new(Config) + *clone = *config + config = clone + } + + kvs.lock.Lock() + defer kvs.lock.Unlock() + + kvs.config = config + kvs.unsaved = true +} + +// Load loads the store from disk. +// If the store is in-memory, i.e. not associated with a file, Load has no effect. +// If the operation fails, a non-nil error is returned +// and the store's content and state at call time are preserved. +func (kvs *KVStoreService) Load() error { + kvs.lock.Lock() + defer kvs.lock.Unlock() + + if kvs.config == nil { + return nil + } + + bytes, err := os.ReadFile(kvs.config.Filename) + if err != nil { + if os.IsNotExist(err) { + return nil + } else { + return err + } + } + + // Init new map because [json.Unmarshal] does not clear the previous one. + data := make(map[string]any) + + if len(bytes) > 0 { + if err := json.Unmarshal(bytes, &data); err != nil { + return err + } + } + + kvs.data = data + kvs.unsaved = false + return nil +} + +// Save saves the store to disk. +// If the store is in-memory, i.e. not associated with a file, Save has no effect. +func (kvs *KVStoreService) Save() error { + kvs.lock.Lock() + defer kvs.lock.Unlock() + + if kvs.config == nil { + return nil + } + + bytes, err := json.Marshal(kvs.data) + if err != nil { + return err + } + + err = os.WriteFile(kvs.config.Filename, bytes, 0644) + if err != nil { + return err + } + + kvs.unsaved = false + return nil +} + +// Get returns the value for the given key. If key is empty, the entire store is returned. +func (kvs *KVStoreService) Get(key string) any { + kvs.lock.RLock() + defer kvs.lock.RUnlock() + + if key == "" { + return kvs.data + } + + return kvs.data[key] +} + +// Set sets the value for the given key. If AutoSave is true, the store is saved to disk. +func (kvs *KVStoreService) Set(key string, value any) error { + var autosave bool + func() { + kvs.lock.Lock() + defer kvs.lock.Unlock() + + kvs.data[key] = value + kvs.unsaved = true + + if kvs.config != nil { + autosave = kvs.config.AutoSave + } + }() + + if autosave { + return kvs.Save() + } else { + return nil + } +} + +// Delete deletes the given key from the store. If AutoSave is true, the store is saved to disk. +func (kvs *KVStoreService) Delete(key string) error { + var autosave bool + func() { + kvs.lock.Lock() + defer kvs.lock.Unlock() + + delete(kvs.data, key) + kvs.unsaved = true + + if kvs.config != nil { + autosave = kvs.config.AutoSave + } + }() + + if autosave { + return kvs.Save() + } else { + return nil + } +} + +// Clear deletes all keys from the store. If AutoSave is true, the store is saved to disk. +func (kvs *KVStoreService) Clear() error { + var autosave bool + func() { + kvs.lock.Lock() + defer kvs.lock.Unlock() + + kvs.data = make(map[string]any) + kvs.unsaved = true + + if kvs.config != nil { + autosave = kvs.config.AutoSave + } + }() + + if autosave { + return kvs.Save() + } else { + return nil + } +} diff --git a/v3/pkg/services/log/log.go b/v3/pkg/services/log/log.go new file mode 100644 index 000000000..3c8c6300c --- /dev/null +++ b/v3/pkg/services/log/log.go @@ -0,0 +1,195 @@ +package log + +import ( + "context" + _ "embed" + "log/slog" + "sync/atomic" + + "github.com/wailsapp/wails/v3/pkg/application" +) + +// A Level is the importance or severity of a log event. +// The higher the level, the more important or severe the event. +// +// Values are arbitrary, but there are four predefined ones. +type Level = int + +const ( + Debug = Level(slog.LevelDebug) + Info = Level(slog.LevelInfo) + Warning = Level(slog.LevelWarn) + Error = Level(slog.LevelError) +) + +type Config struct { + // Logger is the logger to use. If not set, a default logger will be used. + Logger *slog.Logger + + // LogLevel defines the log level of the logger. + LogLevel slog.Level +} + +//wails:inject export { +//wails:inject DebugContext as Debug, +//wails:inject InfoContext as Info, +//wails:inject WarningContext as Warning, +//wails:inject ErrorContext as Error, +//wails:inject }; +type LogService struct { + config atomic.Pointer[Config] + level slog.LevelVar +} + +// New initialises a logging service with the default configuration. +func New() *LogService { + return NewWithConfig(nil) +} + +// NewWithConfig initialises a logging service with a custom configuration. +func NewWithConfig(config *Config) *LogService { + result := &LogService{} + result.Configure(config) + return result +} + +// ServiceName returns the name of the plugin. +// You should use the go module format e.g. github.com/myuser/myplugin +func (l *LogService) ServiceName() string { + return "github.com/wailsapp/wails/v3/plugins/log" +} + +// Configure reconfigures the logger dynamically. +// If config is nil, it falls back to the default configuration. +// +//wails:ignore +func (l *LogService) Configure(config *Config) { + if config == nil { + config = &Config{} + } else { + // Clone to prevent changes from the outside. + clone := new(Config) + *clone = *config + config = clone + } + + l.level.Set(slog.Level(config.LogLevel)) + + if config.Logger == nil { + config.Logger = application.DefaultLogger(&l.level) + } + + l.config.Store(config) +} + +// Level returns the currently configured log level, +// that is either the one configured initially +// or the last value passed to [Service.SetLogLevel]. +// +// Through this method, [Service] implements the [slog.Leveler] interface. +// The intended use case is to propagate +// the service's dynamic level setting to custom loggers. +// For example: +// +// logService := log.New() +// customLogger := slog.New(slog.NewTextHandler( +// customWriter, +// &slog.HandlerOptions{ +// Level: logService, +// }, +// )) +// logService.Configure(&log.Config{ +// Logger: customLogger +// }) +// +// By doing so, setting updates made through [Service.SetLogLevel] +// will propagate dynamically to the custom logger. +// +//wails:ignore +func (l *LogService) Level() slog.Level { + return l.level.Level() +} + +// LogLevel returns the currently configured log level, +// that is either the one configured initially +// or the last value passed to [Service.SetLogLevel]. +func (l *LogService) LogLevel() Level { + return Level(l.Level()) +} + +// SetLogLevel changes the current log level. +func (l *LogService) SetLogLevel(level Level) { + l.level.Set(slog.Level(level)) +} + +// Log emits a log record with the current time and the given level and message. +// The Record's attributes consist of the Logger's attributes followed by +// the attributes specified by args. +// +// The attribute arguments are processed as follows: +// - If an argument is a string and this is not the last argument, +// the following argument is treated as the value and the two are combined +// into an attribute. +// - Otherwise, the argument is treated as a value with key "!BADKEY". +// +// Log feeds the binding call context into the configured logger, +// so custom handlers may access context values, e.g. the current window. +func (l *LogService) Log(ctx context.Context, level Level, message string, args ...any) { + l.config.Load().Logger.Log(ctx, slog.Level(level), message, args...) +} + +// Debug logs at level [Debug]. +// +//wails:ignore +func (l *LogService) Debug(message string, args ...any) { + l.DebugContext(context.Background(), message, args...) +} + +// Info logs at level [Info]. +// +//wails:ignore +func (l *LogService) Info(message string, args ...any) { + l.InfoContext(context.Background(), message, args...) +} + +// Warning logs at level [Warning]. +// +//wails:ignore +func (l *LogService) Warning(message string, args ...any) { + l.WarningContext(context.Background(), message, args...) +} + +// Error logs at level [Error]. +// +//wails:ignore +func (l *LogService) Error(message string, args ...any) { + l.ErrorContext(context.Background(), message, args...) +} + +// DebugContext logs at level [Debug]. +// +//wails:internal +func (l *LogService) DebugContext(ctx context.Context, message string, args ...any) { + l.Log(ctx, Debug, message, args...) +} + +// InfoContext logs at level [Info]. +// +//wails:internal +func (l *LogService) InfoContext(ctx context.Context, message string, args ...any) { + l.Log(ctx, Info, message, args...) +} + +// WarningContext logs at level [Warn]. +// +//wails:internal +func (l *LogService) WarningContext(ctx context.Context, message string, args ...any) { + l.Log(ctx, Warning, message, args...) +} + +// ErrorContext logs at level [Error]. +// +//wails:internal +func (l *LogService) ErrorContext(ctx context.Context, message string, args ...any) { + l.Log(ctx, Error, message, args...) +} diff --git a/v3/pkg/services/notifications/notifications.go b/v3/pkg/services/notifications/notifications.go new file mode 100644 index 000000000..3382d220b --- /dev/null +++ b/v3/pkg/services/notifications/notifications.go @@ -0,0 +1,216 @@ +// Package notifications provides cross-platform notification capabilities for desktop applications. +// It supports macOS, Windows, and Linux with a consistent API while handling platform-specific +// differences internally. Key features include: +// - Basic notifications with title, subtitle, and body +// - Interactive notifications with buttons and actions +// - Notification categories for reusing configurations +// - User feedback handling with a unified callback system +// +// Platform-specific notes: +// - macOS: Requires a properly bundled and signed application +// - Windows: Uses Windows Toast notifications +// - Linux: Uses D-Bus and does not support text inputs +package notifications + +import ( + "context" + "fmt" + "sync" + + "github.com/wailsapp/wails/v3/pkg/application" +) + +type platformNotifier interface { + // Lifecycle methods + Startup(ctx context.Context, options application.ServiceOptions) error + Shutdown() error + + // Core notification methods + RequestNotificationAuthorization() (bool, error) + CheckNotificationAuthorization() (bool, error) + SendNotification(options NotificationOptions) error + SendNotificationWithActions(options NotificationOptions) error + + // Category management + RegisterNotificationCategory(category NotificationCategory) error + RemoveNotificationCategory(categoryID string) error + + // Notification management + RemoveAllPendingNotifications() error + RemovePendingNotification(identifier string) error + RemoveAllDeliveredNotifications() error + RemoveDeliveredNotification(identifier string) error + RemoveNotification(identifier string) error +} + +// Service represents the notifications service +type NotificationService struct { + impl platformNotifier + + // notificationResponseCallback is called when a notification result is received. + // Only one callback can be assigned at a time. + notificationResultCallback func(result NotificationResult) + + callbackLock sync.RWMutex +} + +var ( + notificationServiceOnce sync.Once + NotificationService_ *NotificationService + notificationServiceLock sync.RWMutex +) + +// NotificationAction represents an action button for a notification. +type NotificationAction struct { + ID string `json:"id,omitempty"` + Title string `json:"title,omitempty"` + Destructive bool `json:"destructive,omitempty"` // (macOS-specific) +} + +// NotificationCategory groups actions for notifications. +type NotificationCategory struct { + ID string `json:"id,omitempty"` + Actions []NotificationAction `json:"actions,omitempty"` + HasReplyField bool `json:"hasReplyField,omitempty"` + ReplyPlaceholder string `json:"replyPlaceholder,omitempty"` + ReplyButtonTitle string `json:"replyButtonTitle,omitempty"` +} + +// NotificationOptions contains configuration for a notification +type NotificationOptions struct { + ID string `json:"id"` + Title string `json:"title"` + Subtitle string `json:"subtitle,omitempty"` // (macOS and Linux only) + Body string `json:"body,omitempty"` + CategoryID string `json:"categoryId,omitempty"` + Data map[string]interface{} `json:"data,omitempty"` +} + +const DefaultActionIdentifier = "DEFAULT_ACTION" + +// NotificationResponse represents the response sent by interacting with a notification. +type NotificationResponse struct { + ID string `json:"id,omitempty"` + ActionIdentifier string `json:"actionIdentifier,omitempty"` + CategoryID string `json:"categoryIdentifier,omitempty"` + Title string `json:"title,omitempty"` + Subtitle string `json:"subtitle,omitempty"` // (macOS and Linux only) + Body string `json:"body,omitempty"` + UserText string `json:"userText,omitempty"` + UserInfo map[string]interface{} `json:"userInfo,omitempty"` +} + +// NotificationResult represents the result of a notification response, +// returning the response or any errors that occurred. +type NotificationResult struct { + Response NotificationResponse + Error error +} + +// ServiceName returns the name of the service. +func (ns *NotificationService) ServiceName() string { + return "github.com/wailsapp/wails/v3/services/notifications" +} + +// OnNotificationResponse registers a callback function that will be called when +// a notification response is received from the user. +// +//wails:ignore +func (ns *NotificationService) OnNotificationResponse(callback func(result NotificationResult)) { + ns.callbackLock.Lock() + defer ns.callbackLock.Unlock() + + ns.notificationResultCallback = callback +} + +// handleNotificationResponse is an internal method to handle notification responses +// and invoke the registered callback if one exists. +func (ns *NotificationService) handleNotificationResult(result NotificationResult) { + ns.callbackLock.RLock() + callback := ns.notificationResultCallback + ns.callbackLock.RUnlock() + + if callback != nil { + callback(result) + } +} + +// ServiceStartup is called when the service is loaded. +func (ns *NotificationService) ServiceStartup(ctx context.Context, options application.ServiceOptions) error { + return ns.impl.Startup(ctx, options) +} + +// ServiceShutdown is called when the service is unloaded. +func (ns *NotificationService) ServiceShutdown() error { + return ns.impl.Shutdown() +} + +// Public methods that delegate to the implementation. +func (ns *NotificationService) RequestNotificationAuthorization() (bool, error) { + return ns.impl.RequestNotificationAuthorization() +} + +func (ns *NotificationService) CheckNotificationAuthorization() (bool, error) { + return ns.impl.CheckNotificationAuthorization() +} + +func (ns *NotificationService) SendNotification(options NotificationOptions) error { + if err := validateNotificationOptions(options); err != nil { + return err + } + return ns.impl.SendNotification(options) +} + +func (ns *NotificationService) SendNotificationWithActions(options NotificationOptions) error { + if err := validateNotificationOptions(options); err != nil { + return err + } + return ns.impl.SendNotificationWithActions(options) +} + +func (ns *NotificationService) RegisterNotificationCategory(category NotificationCategory) error { + return ns.impl.RegisterNotificationCategory(category) +} + +func (ns *NotificationService) RemoveNotificationCategory(categoryID string) error { + return ns.impl.RemoveNotificationCategory(categoryID) +} + +func (ns *NotificationService) RemoveAllPendingNotifications() error { + return ns.impl.RemoveAllPendingNotifications() +} + +func (ns *NotificationService) RemovePendingNotification(identifier string) error { + return ns.impl.RemovePendingNotification(identifier) +} + +func (ns *NotificationService) RemoveAllDeliveredNotifications() error { + return ns.impl.RemoveAllDeliveredNotifications() +} + +func (ns *NotificationService) RemoveDeliveredNotification(identifier string) error { + return ns.impl.RemoveDeliveredNotification(identifier) +} + +func (ns *NotificationService) RemoveNotification(identifier string) error { + return ns.impl.RemoveNotification(identifier) +} + +func getNotificationService() *NotificationService { + notificationServiceLock.RLock() + defer notificationServiceLock.RUnlock() + return NotificationService_ +} + +// validateNotificationOptions validates an ID and Title are provided for notifications. +func validateNotificationOptions(options NotificationOptions) error { + if options.ID == "" { + return fmt.Errorf("notification ID cannot be empty") + } + + if options.Title == "" { + return fmt.Errorf("notification title cannot be empty") + } + + return nil +} diff --git a/v3/pkg/services/notifications/notifications_darwin.go b/v3/pkg/services/notifications/notifications_darwin.go new file mode 100644 index 000000000..b9695b3f9 --- /dev/null +++ b/v3/pkg/services/notifications/notifications_darwin.go @@ -0,0 +1,427 @@ +//go:build darwin && !ios + +package notifications + +/* +#cgo CFLAGS:-x objective-c +#cgo LDFLAGS: -framework Foundation -framework Cocoa + +#if __MAC_OS_X_VERSION_MAX_ALLOWED >= 110000 +#cgo LDFLAGS: -framework UserNotifications +#endif + +#import "./notifications_darwin.h" +*/ +import "C" +import ( + "context" + "fmt" + "sync" + "time" + "unsafe" + + "encoding/json" + + "github.com/wailsapp/wails/v3/pkg/application" +) + +type darwinNotifier struct { + channels map[int]chan notificationChannel + channelsLock sync.Mutex + nextChannelID int +} + +type notificationChannel struct { + Success bool + Error error +} + +type ChannelHandler interface { + GetChannel(id int) (chan notificationChannel, bool) +} + +const AppleDefaultActionIdentifier = "com.apple.UNNotificationDefaultActionIdentifier" + +// Creates a new Notifications Service. +// Your app must be packaged and signed for this feature to work. +func New() *NotificationService { + notificationServiceOnce.Do(func() { + impl := &darwinNotifier{ + channels: make(map[int]chan notificationChannel), + nextChannelID: 0, + } + + NotificationService_ = &NotificationService{ + impl: impl, + } + }) + + return NotificationService_ +} + +func (dn *darwinNotifier) Startup(ctx context.Context, options application.ServiceOptions) error { + if !isNotificationAvailable() { + return fmt.Errorf("notifications are not available on this system") + } + if !checkBundleIdentifier() { + return fmt.Errorf("notifications require a valid bundle identifier") + } + if !bool(C.ensureDelegateInitialized()) { + return fmt.Errorf("failed to initialize notification center delegate") + } + return nil +} + +func (dn *darwinNotifier) Shutdown() error { + return nil +} + +// isNotificationAvailable checks if notifications are available on the system. +func isNotificationAvailable() bool { + return bool(C.isNotificationAvailable()) +} + +func checkBundleIdentifier() bool { + return bool(C.checkBundleIdentifier()) +} + +// RequestNotificationAuthorization requests permission for notifications. +// Default timeout is 3 minutes +func (dn *darwinNotifier) RequestNotificationAuthorization() (bool, error) { + ctx, cancel := context.WithTimeout(context.Background(), 180*time.Second) + defer cancel() + + id, resultCh := dn.registerChannel() + + C.requestNotificationAuthorization(C.int(id)) + + select { + case result := <-resultCh: + return result.Success, result.Error + case <-ctx.Done(): + dn.cleanupChannel(id) + return false, fmt.Errorf("notification authorization timed out after 3 minutes: %w", ctx.Err()) + } +} + +// CheckNotificationAuthorization checks current notification permission status. +func (dn *darwinNotifier) CheckNotificationAuthorization() (bool, error) { + ctx, cancel := context.WithTimeout(context.Background(), 15*time.Second) + defer cancel() + + id, resultCh := dn.registerChannel() + + C.checkNotificationAuthorization(C.int(id)) + + select { + case result := <-resultCh: + return result.Success, result.Error + case <-ctx.Done(): + dn.cleanupChannel(id) + return false, fmt.Errorf("notification authorization timed out after 15s: %w", ctx.Err()) + } +} + +// SendNotification sends a basic notification with a unique identifier, title, subtitle, and body. +func (dn *darwinNotifier) SendNotification(options NotificationOptions) error { + ctx, cancel := context.WithTimeout(context.Background(), 5*time.Second) + defer cancel() + + cIdentifier := C.CString(options.ID) + cTitle := C.CString(options.Title) + cSubtitle := C.CString(options.Subtitle) + cBody := C.CString(options.Body) + defer C.free(unsafe.Pointer(cIdentifier)) + defer C.free(unsafe.Pointer(cTitle)) + defer C.free(unsafe.Pointer(cSubtitle)) + defer C.free(unsafe.Pointer(cBody)) + + var cDataJSON *C.char + if options.Data != nil { + jsonData, err := json.Marshal(options.Data) + if err != nil { + return fmt.Errorf("failed to marshal notification data: %w", err) + } + cDataJSON = C.CString(string(jsonData)) + defer C.free(unsafe.Pointer(cDataJSON)) + } + + id, resultCh := dn.registerChannel() + C.sendNotification(C.int(id), cIdentifier, cTitle, cSubtitle, cBody, cDataJSON) + + select { + case result := <-resultCh: + if !result.Success { + if result.Error != nil { + return result.Error + } + return fmt.Errorf("sending notification failed") + } + return nil + case <-ctx.Done(): + dn.cleanupChannel(id) + return fmt.Errorf("sending notification timed out: %w", ctx.Err()) + } +} + +// SendNotificationWithActions sends a notification with additional actions and inputs. +// A NotificationCategory must be registered with RegisterNotificationCategory first. The `CategoryID` must match the registered category. +// If a NotificationCategory is not registered a basic notification will be sent. +func (dn *darwinNotifier) SendNotificationWithActions(options NotificationOptions) error { + ctx, cancel := context.WithTimeout(context.Background(), 5*time.Second) + defer cancel() + + cIdentifier := C.CString(options.ID) + cTitle := C.CString(options.Title) + cSubtitle := C.CString(options.Subtitle) + cBody := C.CString(options.Body) + cCategoryID := C.CString(options.CategoryID) + defer C.free(unsafe.Pointer(cIdentifier)) + defer C.free(unsafe.Pointer(cTitle)) + defer C.free(unsafe.Pointer(cSubtitle)) + defer C.free(unsafe.Pointer(cBody)) + defer C.free(unsafe.Pointer(cCategoryID)) + + var cDataJSON *C.char + if options.Data != nil { + jsonData, err := json.Marshal(options.Data) + if err != nil { + return fmt.Errorf("failed to marshal notification data: %w", err) + } + cDataJSON = C.CString(string(jsonData)) + defer C.free(unsafe.Pointer(cDataJSON)) + } + + id, resultCh := dn.registerChannel() + C.sendNotificationWithActions(C.int(id), cIdentifier, cTitle, cSubtitle, cBody, cCategoryID, cDataJSON) + + select { + case result := <-resultCh: + if !result.Success { + if result.Error != nil { + return result.Error + } + return fmt.Errorf("sending notification failed") + } + return nil + case <-ctx.Done(): + dn.cleanupChannel(id) + return fmt.Errorf("sending notification timed out: %w", ctx.Err()) + } +} + +// RegisterNotificationCategory registers a new NotificationCategory to be used with SendNotificationWithActions. +// Registering a category with the same name as a previously registered NotificationCategory will override it. +func (dn *darwinNotifier) RegisterNotificationCategory(category NotificationCategory) error { + ctx, cancel := context.WithTimeout(context.Background(), 5*time.Second) + defer cancel() + + cCategoryID := C.CString(category.ID) + defer C.free(unsafe.Pointer(cCategoryID)) + + actionsJSON, err := json.Marshal(category.Actions) + if err != nil { + return fmt.Errorf("failed to marshal notification category: %w", err) + } + cActionsJSON := C.CString(string(actionsJSON)) + defer C.free(unsafe.Pointer(cActionsJSON)) + + var cReplyPlaceholder, cReplyButtonTitle *C.char + if category.HasReplyField { + cReplyPlaceholder = C.CString(category.ReplyPlaceholder) + cReplyButtonTitle = C.CString(category.ReplyButtonTitle) + defer C.free(unsafe.Pointer(cReplyPlaceholder)) + defer C.free(unsafe.Pointer(cReplyButtonTitle)) + } + + id, resultCh := dn.registerChannel() + C.registerNotificationCategory(C.int(id), cCategoryID, cActionsJSON, C.bool(category.HasReplyField), + cReplyPlaceholder, cReplyButtonTitle) + + select { + case result := <-resultCh: + if !result.Success { + if result.Error != nil { + return result.Error + } + return fmt.Errorf("category registration failed") + } + return nil + case <-ctx.Done(): + dn.cleanupChannel(id) + return fmt.Errorf("category registration timed out: %w", ctx.Err()) + } +} + +// RemoveNotificationCategory remove a previously registered NotificationCategory. +func (dn *darwinNotifier) RemoveNotificationCategory(categoryId string) error { + ctx, cancel := context.WithTimeout(context.Background(), 5*time.Second) + defer cancel() + + cCategoryID := C.CString(categoryId) + defer C.free(unsafe.Pointer(cCategoryID)) + + id, resultCh := dn.registerChannel() + C.removeNotificationCategory(C.int(id), cCategoryID) + + select { + case result := <-resultCh: + if !result.Success { + if result.Error != nil { + return result.Error + } + return fmt.Errorf("category removal failed") + } + return nil + case <-ctx.Done(): + dn.cleanupChannel(id) + return fmt.Errorf("category removal timed out: %w", ctx.Err()) + } +} + +// RemoveAllPendingNotifications removes all pending notifications. +func (dn *darwinNotifier) RemoveAllPendingNotifications() error { + C.removeAllPendingNotifications() + return nil +} + +// RemovePendingNotification removes a pending notification matching the unique identifier. +func (dn *darwinNotifier) RemovePendingNotification(identifier string) error { + cIdentifier := C.CString(identifier) + defer C.free(unsafe.Pointer(cIdentifier)) + C.removePendingNotification(cIdentifier) + return nil +} + +// RemoveAllDeliveredNotifications removes all delivered notifications. +func (dn *darwinNotifier) RemoveAllDeliveredNotifications() error { + C.removeAllDeliveredNotifications() + return nil +} + +// RemoveDeliveredNotification removes a delivered notification matching the unique identifier. +func (dn *darwinNotifier) RemoveDeliveredNotification(identifier string) error { + cIdentifier := C.CString(identifier) + defer C.free(unsafe.Pointer(cIdentifier)) + C.removeDeliveredNotification(cIdentifier) + return nil +} + +// RemoveNotification is a macOS stub that always returns nil. +// Use one of the following instead: +// RemoveAllPendingNotifications +// RemovePendingNotification +// RemoveAllDeliveredNotifications +// RemoveDeliveredNotification +// (Linux-specific) +func (dn *darwinNotifier) RemoveNotification(identifier string) error { + return nil +} + +//export captureResult +func captureResult(channelID C.int, success C.bool, errorMsg *C.char) { + ns := getNotificationService() + if ns == nil { + return + } + + handler, ok := ns.impl.(ChannelHandler) + if !ok { + return + } + + resultCh, exists := handler.GetChannel(int(channelID)) + if !exists { + return + } + + var err error + if errorMsg != nil { + err = fmt.Errorf("%s", C.GoString(errorMsg)) + } + + resultCh <- notificationChannel{ + Success: bool(success), + Error: err, + } + + close(resultCh) +} + +//export didReceiveNotificationResponse +func didReceiveNotificationResponse(jsonPayload *C.char, err *C.char) { + result := NotificationResult{} + + if err != nil { + errMsg := C.GoString(err) + result.Error = fmt.Errorf("notification response error: %s", errMsg) + if ns := getNotificationService(); ns != nil { + ns.handleNotificationResult(result) + } + return + } + + if jsonPayload == nil { + result.Error = fmt.Errorf("received nil JSON payload in notification response") + if ns := getNotificationService(); ns != nil { + ns.handleNotificationResult(result) + } + return + } + + payload := C.GoString(jsonPayload) + + var response NotificationResponse + if err := json.Unmarshal([]byte(payload), &response); err != nil { + result.Error = fmt.Errorf("failed to unmarshal notification response: %w", err) + if ns := getNotificationService(); ns != nil { + ns.handleNotificationResult(result) + } + return + } + + if response.ActionIdentifier == AppleDefaultActionIdentifier { + response.ActionIdentifier = DefaultActionIdentifier + } + + result.Response = response + if ns := getNotificationService(); ns != nil { + ns.handleNotificationResult(result) + } +} + +// Helper methods + +func (dn *darwinNotifier) registerChannel() (int, chan notificationChannel) { + dn.channelsLock.Lock() + defer dn.channelsLock.Unlock() + + id := dn.nextChannelID + dn.nextChannelID++ + + resultCh := make(chan notificationChannel, 1) + + dn.channels[id] = resultCh + return id, resultCh +} + +func (dn *darwinNotifier) GetChannel(id int) (chan notificationChannel, bool) { + dn.channelsLock.Lock() + defer dn.channelsLock.Unlock() + + ch, exists := dn.channels[id] + if exists { + delete(dn.channels, id) + } + return ch, exists +} + +func (dn *darwinNotifier) cleanupChannel(id int) { + dn.channelsLock.Lock() + defer dn.channelsLock.Unlock() + + if ch, exists := dn.channels[id]; exists { + delete(dn.channels, id) + close(ch) + } +} diff --git a/v3/pkg/services/notifications/notifications_darwin.h b/v3/pkg/services/notifications/notifications_darwin.h new file mode 100644 index 000000000..e0cd25036 --- /dev/null +++ b/v3/pkg/services/notifications/notifications_darwin.h @@ -0,0 +1,22 @@ +//go:build darwin && !ios + +#ifndef NOTIFICATIONS_DARWIN_H +#define NOTIFICATIONS_DARWIN_H + +#import + +bool isNotificationAvailable(void); +bool checkBundleIdentifier(void); +bool ensureDelegateInitialized(void); +void requestNotificationAuthorization(int channelID); +void checkNotificationAuthorization(int channelID); +void sendNotification(int channelID, const char *identifier, const char *title, const char *subtitle, const char *body, const char *data_json); +void sendNotificationWithActions(int channelID, const char *identifier, const char *title, const char *subtitle, const char *body, const char *categoryId, const char *actions_json); +void registerNotificationCategory(int channelID, const char *categoryId, const char *actions_json, bool hasReplyField, const char *replyPlaceholder, const char *replyButtonTitle); +void removeNotificationCategory(int channelID, const char *categoryId); +void removeAllPendingNotifications(void); +void removePendingNotification(const char *identifier); +void removeAllDeliveredNotifications(void); +void removeDeliveredNotification(const char *identifier); + +#endif /* NOTIFICATIONS_DARWIN_H */ \ No newline at end of file diff --git a/v3/pkg/services/notifications/notifications_darwin.m b/v3/pkg/services/notifications/notifications_darwin.m new file mode 100644 index 000000000..373197cb0 --- /dev/null +++ b/v3/pkg/services/notifications/notifications_darwin.m @@ -0,0 +1,377 @@ +#import "notifications_darwin.h" +#include +#import + +#if __MAC_OS_X_VERSION_MAX_ALLOWED >= 110000 +#import +#endif + +bool isNotificationAvailable(void) { + if (@available(macOS 11.0, *)) { + return YES; + } else { + return NO; + } +} + +bool checkBundleIdentifier(void) { + NSBundle *main = [NSBundle mainBundle]; + if (main.bundleIdentifier == nil) { + return NO; + } + return YES; +} + +extern void captureResult(int channelID, bool success, const char* error); +extern void didReceiveNotificationResponse(const char *jsonPayload, const char* error); + +@interface NotificationsDelegate : NSObject +@end + +@implementation NotificationsDelegate + +- (void)userNotificationCenter:(UNUserNotificationCenter *)center + willPresentNotification:(UNNotification *)notification + withCompletionHandler:(void (^)(UNNotificationPresentationOptions options))completionHandler { + UNNotificationPresentationOptions options = 0; + + if (@available(macOS 11.0, *)) { + // These options are only available in macOS 11.0+ + options = UNNotificationPresentationOptionList | + UNNotificationPresentationOptionBanner | + UNNotificationPresentationOptionSound; + } + + completionHandler(options); +} + +- (void)userNotificationCenter:(UNUserNotificationCenter *)center +didReceiveNotificationResponse:(UNNotificationResponse *)response + withCompletionHandler:(void (^)(void))completionHandler { + + NSMutableDictionary *payload = [NSMutableDictionary dictionary]; + + [payload setObject:response.notification.request.identifier forKey:@"id"]; + [payload setObject:response.actionIdentifier forKey:@"actionIdentifier"]; + [payload setObject:response.notification.request.content.title ?: @"" forKey:@"title"]; + [payload setObject:response.notification.request.content.body ?: @"" forKey:@"body"]; + + if (response.notification.request.content.categoryIdentifier) { + [payload setObject:response.notification.request.content.categoryIdentifier forKey:@"categoryIdentifier"]; + } + + if (response.notification.request.content.subtitle) { + [payload setObject:response.notification.request.content.subtitle forKey:@"subtitle"]; + } + + if (response.notification.request.content.userInfo) { + [payload setObject:response.notification.request.content.userInfo forKey:@"userInfo"]; + } + + if ([response isKindOfClass:[UNTextInputNotificationResponse class]]) { + UNTextInputNotificationResponse *textResponse = (UNTextInputNotificationResponse *)response; + [payload setObject:textResponse.userText forKey:@"userText"]; + } + + NSError *error = nil; + NSData *jsonData = [NSJSONSerialization dataWithJSONObject:payload options:0 error:&error]; + if (error) { + NSString *errorMsg = [NSString stringWithFormat:@"Error: %@", [error localizedDescription]]; + didReceiveNotificationResponse(NULL, [errorMsg UTF8String]); + } else { + NSString *jsonString = [[NSString alloc] initWithData:jsonData encoding:NSUTF8StringEncoding]; + didReceiveNotificationResponse([jsonString UTF8String], NULL); + } + + completionHandler(); +} + +@end + +static NotificationsDelegate *delegateInstance = nil; +static dispatch_once_t onceToken; + +bool ensureDelegateInitialized(void) { + __block BOOL success = YES; + + dispatch_once(&onceToken, ^{ + delegateInstance = [[NotificationsDelegate alloc] init]; + UNUserNotificationCenter *center = [UNUserNotificationCenter currentNotificationCenter]; + center.delegate = delegateInstance; + }); + + if (!delegateInstance) { + success = NO; + } + + return success; +} + +void requestNotificationAuthorization(int channelID) { + if (!ensureDelegateInitialized()) { + NSString *errorMsg = @"Notification delegate has been lost. Reinitialize the notification service."; + captureResult(channelID, false, [errorMsg UTF8String]); + return; + } + + UNUserNotificationCenter *center = [UNUserNotificationCenter currentNotificationCenter]; + UNAuthorizationOptions options = UNAuthorizationOptionAlert | UNAuthorizationOptionSound | UNAuthorizationOptionBadge; + + [center requestAuthorizationWithOptions:options completionHandler:^(BOOL granted, NSError * _Nullable error) { + if (error) { + NSString *errorMsg = [NSString stringWithFormat:@"Error: %@", [error localizedDescription]]; + captureResult(channelID, false, [errorMsg UTF8String]); + } else { + captureResult(channelID, granted, NULL); + } + }]; +} + +void checkNotificationAuthorization(int channelID) { + if (!ensureDelegateInitialized()) { + NSString *errorMsg = @"Notification delegate has been lost. Reinitialize the notification service."; + captureResult(channelID, false, [errorMsg UTF8String]); + return; + } + + UNUserNotificationCenter *center = [UNUserNotificationCenter currentNotificationCenter]; + [center getNotificationSettingsWithCompletionHandler:^(UNNotificationSettings *settings) { + BOOL isAuthorized = (settings.authorizationStatus == UNAuthorizationStatusAuthorized); + captureResult(channelID, isAuthorized, NULL); + }]; +} + +// Helper function to create notification content +UNMutableNotificationContent* createNotificationContent(const char *title, const char *subtitle, + const char *body, const char *data_json, NSError **contentError) { + NSString *nsTitle = [NSString stringWithUTF8String:title]; + NSString *nsSubtitle = subtitle ? [NSString stringWithUTF8String:subtitle] : @""; + NSString *nsBody = [NSString stringWithUTF8String:body]; + + UNMutableNotificationContent *content = [[UNMutableNotificationContent alloc] init]; + content.title = nsTitle; + if (![nsSubtitle isEqualToString:@""]) { + content.subtitle = nsSubtitle; + } + content.body = nsBody; + content.sound = [UNNotificationSound defaultSound]; + + // Parse JSON data if provided + if (data_json) { + NSString *dataJsonStr = [NSString stringWithUTF8String:data_json]; + NSData *jsonData = [dataJsonStr dataUsingEncoding:NSUTF8StringEncoding]; + NSError *error = nil; + NSDictionary *parsedData = [NSJSONSerialization JSONObjectWithData:jsonData options:0 error:&error]; + if (!error && parsedData) { + content.userInfo = parsedData; + } else if (error) { + *contentError = error; + } + } + + return content; +} + +void sendNotification(int channelID, const char *identifier, const char *title, const char *subtitle, const char *body, const char *data_json) { + if (!ensureDelegateInitialized()) { + NSString *errorMsg = @"Notification delegate has been lost. Reinitialize the notification service."; + captureResult(channelID, false, [errorMsg UTF8String]); + return; + } + + UNUserNotificationCenter *center = [UNUserNotificationCenter currentNotificationCenter]; + + NSString *nsIdentifier = [NSString stringWithUTF8String:identifier]; + + NSError *contentError = nil; + UNMutableNotificationContent *content = createNotificationContent(title, subtitle, body, data_json, &contentError); + + if (contentError) { + NSString *errorMsg = [NSString stringWithFormat:@"Error: %@", [contentError localizedDescription]]; + captureResult(channelID, false, [errorMsg UTF8String]); + return; + } + + UNTimeIntervalNotificationTrigger *trigger = nil; + + UNNotificationRequest *request = [UNNotificationRequest requestWithIdentifier:nsIdentifier content:content trigger:trigger]; + + [center addNotificationRequest:request withCompletionHandler:^(NSError * _Nullable error) { + if (error) { + NSString *errorMsg = [NSString stringWithFormat:@"Error: %@", [error localizedDescription]]; + captureResult(channelID, false, [errorMsg UTF8String]); + } else { + captureResult(channelID, true, NULL); + } + }]; +} + +void sendNotificationWithActions(int channelID, const char *identifier, const char *title, const char *subtitle, + const char *body, const char *categoryId, const char *data_json) { + if (!ensureDelegateInitialized()) { + NSString *errorMsg = @"Notification delegate has been lost. Reinitialize the notification service."; + captureResult(channelID, false, [errorMsg UTF8String]); + return; + } + + UNUserNotificationCenter *center = [UNUserNotificationCenter currentNotificationCenter]; + + NSString *nsIdentifier = [NSString stringWithUTF8String:identifier]; + NSString *nsCategoryId = [NSString stringWithUTF8String:categoryId]; + + NSError *contentError = nil; + UNMutableNotificationContent *content = createNotificationContent(title, subtitle, body, data_json, &contentError); + + if (contentError) { + NSString *errorMsg = [NSString stringWithFormat:@"Error: %@", [contentError localizedDescription]]; + captureResult(channelID, false, [errorMsg UTF8String]); + return; + } + + content.categoryIdentifier = nsCategoryId; + + UNTimeIntervalNotificationTrigger *trigger = nil; + + UNNotificationRequest *request = [UNNotificationRequest requestWithIdentifier:nsIdentifier content:content trigger:trigger]; + + [center addNotificationRequest:request withCompletionHandler:^(NSError * _Nullable error) { + if (error) { + NSString *errorMsg = [NSString stringWithFormat:@"Error: %@", [error localizedDescription]]; + captureResult(channelID, false, [errorMsg UTF8String]); + } else { + captureResult(channelID, true, NULL); + } + }]; +} + +void registerNotificationCategory(int channelID, const char *categoryId, const char *actions_json, bool hasReplyField, + const char *replyPlaceholder, const char *replyButtonTitle) { + if (!ensureDelegateInitialized()) { + NSString *errorMsg = @"Notification delegate has been lost. Reinitialize the notification service."; + captureResult(channelID, false, [errorMsg UTF8String]); + return; + } + + NSString *nsCategoryId = [NSString stringWithUTF8String:categoryId]; + NSString *actionsJsonStr = actions_json ? [NSString stringWithUTF8String:actions_json] : @"[]"; + + NSData *jsonData = [actionsJsonStr dataUsingEncoding:NSUTF8StringEncoding]; + NSError *error = nil; + NSArray *actionsArray = [NSJSONSerialization JSONObjectWithData:jsonData options:0 error:&error]; + + if (error) { + NSString *errorMsg = [NSString stringWithFormat:@"Error: %@", [error localizedDescription]]; + captureResult(channelID, false, [errorMsg UTF8String]); + return; + } + + NSMutableArray *actions = [NSMutableArray array]; + + for (NSDictionary *actionDict in actionsArray) { + NSString *actionId = actionDict[@"id"]; + NSString *actionTitle = actionDict[@"title"]; + BOOL destructive = [actionDict[@"destructive"] boolValue]; + + if (actionId && actionTitle) { + UNNotificationActionOptions options = UNNotificationActionOptionNone; + if (destructive) options |= UNNotificationActionOptionDestructive; + + UNNotificationAction *action = [UNNotificationAction + actionWithIdentifier:actionId + title:actionTitle + options:options]; + [actions addObject:action]; + } + } + + if (hasReplyField && replyPlaceholder && replyButtonTitle) { + NSString *placeholder = [NSString stringWithUTF8String:replyPlaceholder]; + NSString *buttonTitle = [NSString stringWithUTF8String:replyButtonTitle]; + + UNTextInputNotificationAction *textAction = + [UNTextInputNotificationAction actionWithIdentifier:@"TEXT_REPLY" + title:buttonTitle + options:UNNotificationActionOptionNone + textInputButtonTitle:buttonTitle + textInputPlaceholder:placeholder]; + [actions addObject:textAction]; + } + + UNNotificationCategory *newCategory = [UNNotificationCategory + categoryWithIdentifier:nsCategoryId + actions:actions + intentIdentifiers:@[] + options:UNNotificationCategoryOptionNone]; + + UNUserNotificationCenter *center = [UNUserNotificationCenter currentNotificationCenter]; + [center getNotificationCategoriesWithCompletionHandler:^(NSSet *categories) { + NSMutableSet *updatedCategories = [NSMutableSet setWithSet:categories]; + + // Remove existing category with same ID if it exists + UNNotificationCategory *existingCategory = nil; + for (UNNotificationCategory *category in updatedCategories) { + if ([category.identifier isEqualToString:nsCategoryId]) { + existingCategory = category; + break; + } + } + if (existingCategory) { + [updatedCategories removeObject:existingCategory]; + } + + // Add the new category + [updatedCategories addObject:newCategory]; + [center setNotificationCategories:updatedCategories]; + + captureResult(channelID, true, NULL); + }]; +} + +void removeNotificationCategory(int channelID, const char *categoryId) { + NSString *nsCategoryId = [NSString stringWithUTF8String:categoryId]; + UNUserNotificationCenter *center = [UNUserNotificationCenter currentNotificationCenter]; + + [center getNotificationCategoriesWithCompletionHandler:^(NSSet *categories) { + NSMutableSet *updatedCategories = [NSMutableSet setWithSet:categories]; + + // Find and remove the category with matching identifier + UNNotificationCategory *categoryToRemove = nil; + for (UNNotificationCategory *category in updatedCategories) { + if ([category.identifier isEqualToString:nsCategoryId]) { + categoryToRemove = category; + break; + } + } + + if (categoryToRemove) { + [updatedCategories removeObject:categoryToRemove]; + [center setNotificationCategories:updatedCategories]; + captureResult(channelID, true, NULL); + } else { + NSString *errorMsg = [NSString stringWithFormat:@"Category '%@' not found", nsCategoryId]; + captureResult(channelID, false, [errorMsg UTF8String]); + } + }]; +} + +void removeAllPendingNotifications(void) { + UNUserNotificationCenter *center = [UNUserNotificationCenter currentNotificationCenter]; + [center removeAllPendingNotificationRequests]; +} + +void removePendingNotification(const char *identifier) { + NSString *nsIdentifier = [NSString stringWithUTF8String:identifier]; + UNUserNotificationCenter *center = [UNUserNotificationCenter currentNotificationCenter]; + [center removePendingNotificationRequestsWithIdentifiers:@[nsIdentifier]]; +} + +void removeAllDeliveredNotifications(void) { + UNUserNotificationCenter *center = [UNUserNotificationCenter currentNotificationCenter]; + [center removeAllDeliveredNotifications]; +} + +void removeDeliveredNotification(const char *identifier) { + NSString *nsIdentifier = [NSString stringWithUTF8String:identifier]; + UNUserNotificationCenter *center = [UNUserNotificationCenter currentNotificationCenter]; + [center removeDeliveredNotificationsWithIdentifiers:@[nsIdentifier]]; +} \ No newline at end of file diff --git a/v3/pkg/services/notifications/notifications_ios.go b/v3/pkg/services/notifications/notifications_ios.go new file mode 100644 index 000000000..1f2ee5677 --- /dev/null +++ b/v3/pkg/services/notifications/notifications_ios.go @@ -0,0 +1,91 @@ +//go:build ios + +package notifications + +import ( + "context" + + "github.com/wailsapp/wails/v3/pkg/application" +) + +type iosNotifier struct{} + +// New creates a new Notifications Service. +// On iOS, this returns a stub implementation. +// iOS notification functionality will be implemented via native bridges. +func New() *NotificationService { + notificationServiceOnce.Do(func() { + impl := &iosNotifier{} + + NotificationService_ = &NotificationService{ + impl: impl, + } + }) + + return NotificationService_ +} + +func (n *iosNotifier) Startup(ctx context.Context, options application.ServiceOptions) error { + // iOS notification startup - implementation pending native bridge + return nil +} + +func (n *iosNotifier) Shutdown() error { + // iOS notification shutdown - implementation pending native bridge + return nil +} + +func (n *iosNotifier) RequestNotificationAuthorization() (bool, error) { + // iOS notification authorization would go here via native bridge + return true, nil +} + +func (n *iosNotifier) CheckNotificationAuthorization() (bool, error) { + // iOS notification authorization check would go here via native bridge + return true, nil +} + +func (n *iosNotifier) SendNotification(options NotificationOptions) error { + // iOS notification would go here via native bridge + return nil +} + +func (n *iosNotifier) SendNotificationWithActions(options NotificationOptions) error { + // iOS notification with actions would go here via native bridge + return nil +} + +func (n *iosNotifier) RegisterNotificationCategory(category NotificationCategory) error { + // iOS notification category registration would go here via native bridge + return nil +} + +func (n *iosNotifier) RemoveNotificationCategory(categoryID string) error { + // iOS notification category removal would go here via native bridge + return nil +} + +func (n *iosNotifier) RemoveAllPendingNotifications() error { + // iOS pending notifications removal would go here via native bridge + return nil +} + +func (n *iosNotifier) RemovePendingNotification(identifier string) error { + // iOS pending notification removal would go here via native bridge + return nil +} + +func (n *iosNotifier) RemoveAllDeliveredNotifications() error { + // iOS delivered notifications removal would go here via native bridge + return nil +} + +func (n *iosNotifier) RemoveDeliveredNotification(identifier string) error { + // iOS delivered notification removal would go here via native bridge + return nil +} + +func (n *iosNotifier) RemoveNotification(identifier string) error { + // iOS notification removal would go here via native bridge + return nil +} \ No newline at end of file diff --git a/v3/pkg/services/notifications/notifications_linux.go b/v3/pkg/services/notifications/notifications_linux.go new file mode 100644 index 000000000..23e21433e --- /dev/null +++ b/v3/pkg/services/notifications/notifications_linux.go @@ -0,0 +1,566 @@ +//go:build linux + +package notifications + +import ( + "context" + "fmt" + "os" + "path/filepath" + "sync" + + "encoding/json" + + "github.com/godbus/dbus/v5" + "github.com/wailsapp/wails/v3/pkg/application" +) + +type linuxNotifier struct { + conn *dbus.Conn + categories map[string]NotificationCategory + categoriesLock sync.RWMutex + notifications map[uint32]*notificationData + notificationsLock sync.RWMutex + appName string + cancel context.CancelFunc +} + +type notificationData struct { + ID string + Title string + Subtitle string + Body string + CategoryID string + Data map[string]interface{} + DBusID uint32 + ActionMap map[string]string +} + +const ( + dbusNotificationInterface = "org.freedesktop.Notifications" + dbusNotificationPath = "/org/freedesktop/Notifications" +) + +// Creates a new Notifications Service. +func New() *NotificationService { + notificationServiceOnce.Do(func() { + impl := &linuxNotifier{ + categories: make(map[string]NotificationCategory), + notifications: make(map[uint32]*notificationData), + } + + NotificationService_ = &NotificationService{ + impl: impl, + } + }) + + return NotificationService_ +} + +// Startup is called when the service is loaded. +func (ln *linuxNotifier) Startup(ctx context.Context, options application.ServiceOptions) error { + ln.appName = application.Get().Config().Name + + conn, err := dbus.ConnectSessionBus() + if err != nil { + return fmt.Errorf("failed to connect to session bus: %w", err) + } + ln.conn = conn + + if err := ln.loadCategories(); err != nil { + fmt.Printf("Failed to load notification categories: %v\n", err) + } + + var signalCtx context.Context + signalCtx, ln.cancel = context.WithCancel(context.Background()) + + if err := ln.setupSignalHandling(signalCtx); err != nil { + return fmt.Errorf("failed to set up notification signal handling: %w", err) + } + + return nil +} + +// Shutdown will save categories and close the D-Bus connection when the service unloads. +func (ln *linuxNotifier) Shutdown() error { + if ln.cancel != nil { + ln.cancel() + } + + if err := ln.saveCategories(); err != nil { + fmt.Printf("Failed to save notification categories: %v\n", err) + } + + if ln.conn != nil { + return ln.conn.Close() + } + return nil +} + +// RequestNotificationAuthorization is a Linux stub that always returns true, nil. +// (authorization is macOS-specific) +func (ln *linuxNotifier) RequestNotificationAuthorization() (bool, error) { + return true, nil +} + +// CheckNotificationAuthorization is a Linux stub that always returns true. +// (authorization is macOS-specific) +func (ln *linuxNotifier) CheckNotificationAuthorization() (bool, error) { + return true, nil +} + +// SendNotification sends a basic notification with a unique identifier, title, subtitle, and body. +func (ln *linuxNotifier) SendNotification(options NotificationOptions) error { + hints := map[string]dbus.Variant{} + + body := options.Body + if options.Subtitle != "" { + body = options.Subtitle + "\n" + body + } + + defaultActionID := "default" + actions := []string{defaultActionID, "Default"} + + actionMap := map[string]string{ + defaultActionID: DefaultActionIdentifier, + } + + hints["x-notification-id"] = dbus.MakeVariant(options.ID) + + if options.Data != nil { + userData, err := json.Marshal(options.Data) + if err == nil { + hints["x-user-data"] = dbus.MakeVariant(string(userData)) + } + } + + // Call the Notify method on the D-Bus interface + obj := ln.conn.Object(dbusNotificationInterface, dbusNotificationPath) + call := obj.Call( + dbusNotificationInterface+".Notify", + 0, + ln.appName, + uint32(0), + "", // Icon + options.Title, + body, + actions, + hints, + int32(-1), + ) + + if call.Err != nil { + return fmt.Errorf("failed to send notification: %w", call.Err) + } + + var dbusID uint32 + if err := call.Store(&dbusID); err != nil { + return fmt.Errorf("failed to store notification ID: %w", err) + } + + notification := ¬ificationData{ + ID: options.ID, + Title: options.Title, + Subtitle: options.Subtitle, + Body: options.Body, + Data: options.Data, + DBusID: dbusID, + ActionMap: actionMap, + } + + ln.notificationsLock.Lock() + ln.notifications[dbusID] = notification + ln.notificationsLock.Unlock() + + return nil +} + +// SendNotificationWithActions sends a notification with additional actions. +func (ln *linuxNotifier) SendNotificationWithActions(options NotificationOptions) error { + ln.categoriesLock.RLock() + category, exists := ln.categories[options.CategoryID] + ln.categoriesLock.RUnlock() + + if options.CategoryID == "" || !exists { + // Fall back to basic notification + return ln.SendNotification(options) + } + + body := options.Body + if options.Subtitle != "" { + body = options.Subtitle + "\n" + body + } + + var actions []string + actionMap := make(map[string]string) + + defaultActionID := "default" + actions = append(actions, defaultActionID, "Default") + actionMap[defaultActionID] = DefaultActionIdentifier + + for _, action := range category.Actions { + actions = append(actions, action.ID, action.Title) + actionMap[action.ID] = action.ID + } + + hints := map[string]dbus.Variant{} + + hints["x-notification-id"] = dbus.MakeVariant(options.ID) + + hints["x-category-id"] = dbus.MakeVariant(options.CategoryID) + + if options.Data != nil { + userData, err := json.Marshal(options.Data) + if err == nil { + hints["x-user-data"] = dbus.MakeVariant(string(userData)) + } + } + + obj := ln.conn.Object(dbusNotificationInterface, dbusNotificationPath) + call := obj.Call( + dbusNotificationInterface+".Notify", + 0, + ln.appName, + uint32(0), + "", // Icon + options.Title, + body, + actions, + hints, + int32(-1), + ) + + if call.Err != nil { + return fmt.Errorf("failed to send notification: %w", call.Err) + } + + var dbusID uint32 + if err := call.Store(&dbusID); err != nil { + return fmt.Errorf("failed to store notification ID: %w", err) + } + + notification := ¬ificationData{ + ID: options.ID, + Title: options.Title, + Subtitle: options.Subtitle, + Body: options.Body, + CategoryID: options.CategoryID, + Data: options.Data, + DBusID: dbusID, + ActionMap: actionMap, + } + + ln.notificationsLock.Lock() + ln.notifications[dbusID] = notification + ln.notificationsLock.Unlock() + + return nil +} + +// RegisterNotificationCategory registers a new NotificationCategory to be used with SendNotificationWithActions. +func (ln *linuxNotifier) RegisterNotificationCategory(category NotificationCategory) error { + ln.categoriesLock.Lock() + ln.categories[category.ID] = category + ln.categoriesLock.Unlock() + + if err := ln.saveCategories(); err != nil { + fmt.Printf("Failed to save notification categories: %v\n", err) + } + + return nil +} + +// RemoveNotificationCategory removes a previously registered NotificationCategory. +func (ln *linuxNotifier) RemoveNotificationCategory(categoryId string) error { + ln.categoriesLock.Lock() + delete(ln.categories, categoryId) + ln.categoriesLock.Unlock() + + if err := ln.saveCategories(); err != nil { + fmt.Printf("Failed to save notification categories: %v\n", err) + } + + return nil +} + +// RemoveAllPendingNotifications attempts to remove all active notifications. +func (ln *linuxNotifier) RemoveAllPendingNotifications() error { + ln.notificationsLock.Lock() + dbusIDs := make([]uint32, 0, len(ln.notifications)) + for id := range ln.notifications { + dbusIDs = append(dbusIDs, id) + } + ln.notificationsLock.Unlock() + + for _, id := range dbusIDs { + ln.closeNotification(id) + } + + return nil +} + +// RemovePendingNotification removes a pending notification. +func (ln *linuxNotifier) RemovePendingNotification(identifier string) error { + var dbusID uint32 + found := false + + ln.notificationsLock.Lock() + for id, notif := range ln.notifications { + if notif.ID == identifier { + dbusID = id + found = true + break + } + } + ln.notificationsLock.Unlock() + + if !found { + return nil + } + + return ln.closeNotification(dbusID) +} + +// RemoveAllDeliveredNotifications functionally equivalent to RemoveAllPendingNotification on Linux. +func (ln *linuxNotifier) RemoveAllDeliveredNotifications() error { + return ln.RemoveAllPendingNotifications() +} + +// RemoveDeliveredNotification functionally equivalent RemovePendingNotification on Linux. +func (ln *linuxNotifier) RemoveDeliveredNotification(identifier string) error { + return ln.RemovePendingNotification(identifier) +} + +// RemoveNotification removes a notification by identifier. +func (ln *linuxNotifier) RemoveNotification(identifier string) error { + return ln.RemovePendingNotification(identifier) +} + +// Helper method to close a notification. +func (ln *linuxNotifier) closeNotification(id uint32) error { + obj := ln.conn.Object(dbusNotificationInterface, dbusNotificationPath) + call := obj.Call(dbusNotificationInterface+".CloseNotification", 0, id) + + if call.Err != nil { + return fmt.Errorf("failed to close notification: %w", call.Err) + } + + return nil +} + +func (ln *linuxNotifier) getConfigDir() (string, error) { + configDir, err := os.UserConfigDir() + if err != nil { + return "", fmt.Errorf("failed to get user config directory: %w", err) + } + + appConfigDir := filepath.Join(configDir, ln.appName) + if err := os.MkdirAll(appConfigDir, 0755); err != nil { + return "", fmt.Errorf("failed to create app config directory: %w", err) + } + + return appConfigDir, nil +} + +// Save notification categories. +func (ln *linuxNotifier) saveCategories() error { + configDir, err := ln.getConfigDir() + if err != nil { + return err + } + + categoriesFile := filepath.Join(configDir, "notification-categories.json") + + ln.categoriesLock.RLock() + categoriesData, err := json.MarshalIndent(ln.categories, "", " ") + ln.categoriesLock.RUnlock() + + if err != nil { + return fmt.Errorf("failed to marshal notification categories: %w", err) + } + + if err := os.WriteFile(categoriesFile, categoriesData, 0644); err != nil { + return fmt.Errorf("failed to write notification categories to disk: %w", err) + } + + return nil +} + +// Load notification categories. +func (ln *linuxNotifier) loadCategories() error { + configDir, err := ln.getConfigDir() + if err != nil { + return err + } + + categoriesFile := filepath.Join(configDir, "notification-categories.json") + + if _, err := os.Stat(categoriesFile); os.IsNotExist(err) { + return nil + } + + categoriesData, err := os.ReadFile(categoriesFile) + if err != nil { + return fmt.Errorf("failed to read notification categories from disk: %w", err) + } + + categories := make(map[string]NotificationCategory) + if err := json.Unmarshal(categoriesData, &categories); err != nil { + return fmt.Errorf("failed to unmarshal notification categories: %w", err) + } + + ln.categoriesLock.Lock() + ln.categories = categories + ln.categoriesLock.Unlock() + + return nil +} + +// Setup signal handling for notification actions. +func (ln *linuxNotifier) setupSignalHandling(ctx context.Context) error { + if err := ln.conn.AddMatchSignal( + dbus.WithMatchInterface(dbusNotificationInterface), + dbus.WithMatchMember("ActionInvoked"), + ); err != nil { + return err + } + + if err := ln.conn.AddMatchSignal( + dbus.WithMatchInterface(dbusNotificationInterface), + dbus.WithMatchMember("NotificationClosed"), + ); err != nil { + return err + } + + c := make(chan *dbus.Signal, 10) + ln.conn.Signal(c) + + go ln.handleSignals(ctx, c) + + return nil +} + +// Handle incoming D-Bus signals. +func (ln *linuxNotifier) handleSignals(ctx context.Context, c chan *dbus.Signal) { + for { + select { + case <-ctx.Done(): + return + case signal, ok := <-c: + if !ok { + return + } + + switch signal.Name { + case dbusNotificationInterface + ".ActionInvoked": + ln.handleActionInvoked(signal) + case dbusNotificationInterface + ".NotificationClosed": + ln.handleNotificationClosed(signal) + } + } + } +} + +// Handle ActionInvoked signal. +func (ln *linuxNotifier) handleActionInvoked(signal *dbus.Signal) { + if len(signal.Body) < 2 { + return + } + + dbusID, ok := signal.Body[0].(uint32) + if !ok { + return + } + + actionID, ok := signal.Body[1].(string) + if !ok { + return + } + + ln.notificationsLock.Lock() + notification, exists := ln.notifications[dbusID] + if exists { + delete(ln.notifications, dbusID) + } + ln.notificationsLock.Unlock() + + if !exists { + return + } + + appActionID, ok := notification.ActionMap[actionID] + if !ok { + appActionID = actionID + } + + response := NotificationResponse{ + ID: notification.ID, + ActionIdentifier: appActionID, + Title: notification.Title, + Subtitle: notification.Subtitle, + Body: notification.Body, + CategoryID: notification.CategoryID, + UserInfo: notification.Data, + } + + result := NotificationResult{ + Response: response, + } + + if ns := getNotificationService(); ns != nil { + ns.handleNotificationResult(result) + } +} + +// Handle NotificationClosed signal. +// Reason codes: +// 1 - expired timeout +// 2 - dismissed by user (click on X) +// 3 - closed by CloseNotification call +// 4 - undefined/reserved +func (ln *linuxNotifier) handleNotificationClosed(signal *dbus.Signal) { + if len(signal.Body) < 2 { + return + } + + dbusID, ok := signal.Body[0].(uint32) + if !ok { + return + } + + reason, ok := signal.Body[1].(uint32) + if !ok { + reason = 0 // Unknown reason + } + + ln.notificationsLock.Lock() + notification, exists := ln.notifications[dbusID] + if exists { + delete(ln.notifications, dbusID) + } + ln.notificationsLock.Unlock() + + if !exists { + return + } + + if reason == 2 { + response := NotificationResponse{ + ID: notification.ID, + ActionIdentifier: DefaultActionIdentifier, + Title: notification.Title, + Subtitle: notification.Subtitle, + Body: notification.Body, + CategoryID: notification.CategoryID, + UserInfo: notification.Data, + } + + result := NotificationResult{ + Response: response, + } + + if ns := getNotificationService(); ns != nil { + ns.handleNotificationResult(result) + } + } +} diff --git a/v3/pkg/services/notifications/notifications_windows.go b/v3/pkg/services/notifications/notifications_windows.go new file mode 100644 index 000000000..b1063dbf8 --- /dev/null +++ b/v3/pkg/services/notifications/notifications_windows.go @@ -0,0 +1,460 @@ +//go:build windows + +package notifications + +import ( + "context" + "encoding/base64" + "fmt" + "os" + "path/filepath" + "sync" + _ "unsafe" + + "encoding/json" + + "git.sr.ht/~jackmordaunt/go-toast/v2" + wintoast "git.sr.ht/~jackmordaunt/go-toast/v2/wintoast" + "github.com/google/uuid" + "github.com/wailsapp/wails/v3/pkg/application" + "github.com/wailsapp/wails/v3/pkg/w32" + "golang.org/x/sys/windows/registry" +) + +type windowsNotifier struct { + categories map[string]NotificationCategory + categoriesLock sync.RWMutex + appName string + appGUID string + iconPath string + exePath string +} + +const ( + ToastRegistryPath = `Software\Classes\AppUserModelId\` + ToastRegistryGuidKey = "CustomActivator" + NotificationCategoriesRegistryPath = `SOFTWARE\%s\NotificationCategories` + NotificationCategoriesRegistryKey = "Categories" +) + +// NotificationPayload combines the action ID and user data into a single structure +type NotificationPayload struct { + Action string `json:"action"` + Options NotificationOptions `json:"payload,omitempty"` +} + +// Creates a new Notifications Service. +func New() *NotificationService { + notificationServiceOnce.Do(func() { + impl := &windowsNotifier{ + categories: make(map[string]NotificationCategory), + } + + NotificationService_ = &NotificationService{ + impl: impl, + } + }) + + return NotificationService_ +} + +//go:linkname registerFactoryInternal git.sr.ht/~jackmordaunt/go-toast/v2/wintoast.registerClassFactory +func registerFactoryInternal(factory *wintoast.IClassFactory) error + +// Startup is called when the service is loaded +// Sets an activation callback to emit an event when notifications are interacted with. +func (wn *windowsNotifier) Startup(ctx context.Context, options application.ServiceOptions) error { + wn.categoriesLock.Lock() + defer wn.categoriesLock.Unlock() + + app := application.Get() + cfg := app.Config() + + wn.appName = cfg.Name + + guid, err := wn.getGUID() + if err != nil { + return err + } + wn.appGUID = guid + + wn.iconPath = filepath.Join(os.TempDir(), wn.appName+wn.appGUID+".png") + + exe, err := os.Executable() + if err != nil { + return fmt.Errorf("failed to get executable path: %w", err) + } + wn.exePath = exe + + // Create the registry key for the toast activator + key, _, err := registry.CreateKey(registry.CURRENT_USER, + `Software\Classes\CLSID\`+wn.appGUID+`\LocalServer32`, registry.ALL_ACCESS) + if err != nil { + return fmt.Errorf("failed to create CLSID key: %w", err) + } + + if err := key.SetStringValue("", fmt.Sprintf("\"%s\" %%1", wn.exePath)); err != nil { + return fmt.Errorf("failed to set CLSID server path: %w", err) + } + key.Close() + + toast.SetAppData(toast.AppData{ + AppID: wn.appName, + GUID: guid, + IconPath: wn.iconPath, + ActivationExe: wn.exePath, + }) + + toast.SetActivationCallback(func(args string, data []toast.UserData) { + result := NotificationResult{} + + actionIdentifier, options, err := parseNotificationResponse(args) + + if err != nil { + result.Error = err + } else { + // Subtitle is retained but was not shown with the notification + response := NotificationResponse{ + ID: options.ID, + ActionIdentifier: actionIdentifier, + Title: options.Title, + Subtitle: options.Subtitle, + Body: options.Body, + CategoryID: options.CategoryID, + UserInfo: options.Data, + } + + if userText, found := wn.getUserText(data); found { + response.UserText = userText + } + + result.Response = response + } + + if ns := getNotificationService(); ns != nil { + ns.handleNotificationResult(result) + } + }) + + // Register the class factory for the toast activator + if err := registerFactoryInternal(wintoast.ClassFactory); err != nil { + return fmt.Errorf("CoRegisterClassObject failed: %w", err) + } + + return wn.loadCategoriesFromRegistry() +} + +// Shutdown will attempt to save the categories to the registry when the service unloads +func (wn *windowsNotifier) Shutdown() error { + wn.categoriesLock.Lock() + defer wn.categoriesLock.Unlock() + + return wn.saveCategoriesToRegistry() +} + +// RequestNotificationAuthorization is a Windows stub that always returns true, nil. +// (user authorization is macOS-specific) +func (wn *windowsNotifier) RequestNotificationAuthorization() (bool, error) { + return true, nil +} + +// CheckNotificationAuthorization is a Windows stub that always returns true. +// (user authorization is macOS-specific) +func (wn *windowsNotifier) CheckNotificationAuthorization() (bool, error) { + return true, nil +} + +// SendNotification sends a basic notification with a name, title, and body. All other options are ignored on Windows. +// (subtitle is only available on macOS and Linux) +func (wn *windowsNotifier) SendNotification(options NotificationOptions) error { + if err := wn.saveIconToDir(); err != nil { + fmt.Printf("Error saving icon: %v\n", err) + } + + n := toast.Notification{ + Title: options.Title, + Body: options.Body, + ActivationType: toast.Foreground, + ActivationArguments: DefaultActionIdentifier, + } + + encodedPayload, err := wn.encodePayload(DefaultActionIdentifier, options) + if err != nil { + return fmt.Errorf("failed to encode notification payload: %w", err) + } + n.ActivationArguments = encodedPayload + + return n.Push() +} + +// SendNotificationWithActions sends a notification with additional actions and inputs. +// A NotificationCategory must be registered with RegisterNotificationCategory first. The `CategoryID` must match the registered category. +// If a NotificationCategory is not registered a basic notification will be sent. +// (subtitle is only available on macOS and Linux) +func (wn *windowsNotifier) SendNotificationWithActions(options NotificationOptions) error { + if err := wn.saveIconToDir(); err != nil { + fmt.Printf("Error saving icon: %v\n", err) + } + + wn.categoriesLock.RLock() + nCategory, categoryExists := wn.categories[options.CategoryID] + wn.categoriesLock.RUnlock() + + if options.CategoryID == "" || !categoryExists { + fmt.Printf("Category '%s' not found, sending basic notification without actions\n", options.CategoryID) + } + + n := toast.Notification{ + Title: options.Title, + Body: options.Body, + ActivationType: toast.Foreground, + ActivationArguments: DefaultActionIdentifier, + } + + for _, action := range nCategory.Actions { + n.Actions = append(n.Actions, toast.Action{ + Content: action.Title, + Arguments: action.ID, + }) + } + + if nCategory.HasReplyField { + n.Inputs = append(n.Inputs, toast.Input{ + ID: "userText", + Placeholder: nCategory.ReplyPlaceholder, + }) + + n.Actions = append(n.Actions, toast.Action{ + Content: nCategory.ReplyButtonTitle, + Arguments: "TEXT_REPLY", + InputID: "userText", + }) + } + + encodedPayload, err := wn.encodePayload(n.ActivationArguments, options) + if err != nil { + return fmt.Errorf("failed to encode notification payload: %w", err) + } + n.ActivationArguments = encodedPayload + + for index := range n.Actions { + encodedPayload, err := wn.encodePayload(n.Actions[index].Arguments, options) + if err != nil { + return fmt.Errorf("failed to encode notification payload: %w", err) + } + n.Actions[index].Arguments = encodedPayload + } + + return n.Push() +} + +// RegisterNotificationCategory registers a new NotificationCategory to be used with SendNotificationWithActions. +// Registering a category with the same name as a previously registered NotificationCategory will override it. +func (wn *windowsNotifier) RegisterNotificationCategory(category NotificationCategory) error { + wn.categoriesLock.Lock() + defer wn.categoriesLock.Unlock() + + wn.categories[category.ID] = NotificationCategory{ + ID: category.ID, + Actions: category.Actions, + HasReplyField: bool(category.HasReplyField), + ReplyPlaceholder: category.ReplyPlaceholder, + ReplyButtonTitle: category.ReplyButtonTitle, + } + + return wn.saveCategoriesToRegistry() +} + +// RemoveNotificationCategory removes a previously registered NotificationCategory. +func (wn *windowsNotifier) RemoveNotificationCategory(categoryId string) error { + wn.categoriesLock.Lock() + defer wn.categoriesLock.Unlock() + + delete(wn.categories, categoryId) + + return wn.saveCategoriesToRegistry() +} + +// RemoveAllPendingNotifications is a Windows stub that always returns nil. +// (macOS and Linux only) +func (wn *windowsNotifier) RemoveAllPendingNotifications() error { + return nil +} + +// RemovePendingNotification is a Windows stub that always returns nil. +// (macOS and Linux only) +func (wn *windowsNotifier) RemovePendingNotification(_ string) error { + return nil +} + +// RemoveAllDeliveredNotifications is a Windows stub that always returns nil. +// (macOS and Linux only) +func (wn *windowsNotifier) RemoveAllDeliveredNotifications() error { + return nil +} + +// RemoveDeliveredNotification is a Windows stub that always returns nil. +// (macOS and Linux only) +func (wn *windowsNotifier) RemoveDeliveredNotification(_ string) error { + return nil +} + +// RemoveNotification is a Windows stub that always returns nil. +// (Linux-specific) +func (wn *windowsNotifier) RemoveNotification(identifier string) error { + return nil +} + +// encodePayload combines an action ID and user data into a single encoded string +func (wn *windowsNotifier) encodePayload(actionID string, options NotificationOptions) (string, error) { + payload := NotificationPayload{ + Action: actionID, + Options: options, + } + + jsonData, err := json.Marshal(payload) + if err != nil { + return actionID, err + } + + encodedPayload := base64.StdEncoding.EncodeToString(jsonData) + return encodedPayload, nil +} + +// decodePayload extracts the action ID and user data from an encoded payload +func decodePayload(encodedString string) (string, NotificationOptions, error) { + jsonData, err := base64.StdEncoding.DecodeString(encodedString) + if err != nil { + return encodedString, NotificationOptions{}, fmt.Errorf("failed to decode base64 payload: %w", err) + } + + var payload NotificationPayload + if err := json.Unmarshal(jsonData, &payload); err != nil { + return encodedString, NotificationOptions{}, fmt.Errorf("failed to unmarshal notification payload: %w", err) + } + + return payload.Action, payload.Options, nil +} + +// parseNotificationResponse updated to use structured payload decoding +func parseNotificationResponse(response string) (action string, options NotificationOptions, err error) { + actionID, options, err := decodePayload(response) + + if err != nil { + fmt.Printf("Warning: Failed to decode notification response: %v\n", err) + return response, NotificationOptions{}, err + } + + return actionID, options, nil +} + +func (wn *windowsNotifier) saveIconToDir() error { + icon, err := application.NewIconFromResource(w32.GetModuleHandle(""), uint16(3)) + if err != nil { + return fmt.Errorf("failed to retrieve application icon: %w", err) + } + + return w32.SaveHIconAsPNG(icon, wn.iconPath) +} + +func (wn *windowsNotifier) saveCategoriesToRegistry() error { + // We assume lock is held by caller + + registryPath := fmt.Sprintf(NotificationCategoriesRegistryPath, wn.appName) + + key, _, err := registry.CreateKey( + registry.CURRENT_USER, + registryPath, + registry.ALL_ACCESS, + ) + if err != nil { + return err + } + defer key.Close() + + data, err := json.Marshal(wn.categories) + if err != nil { + return err + } + + return key.SetStringValue(NotificationCategoriesRegistryKey, string(data)) +} + +func (wn *windowsNotifier) loadCategoriesFromRegistry() error { + // We assume lock is held by caller + + registryPath := fmt.Sprintf(NotificationCategoriesRegistryPath, wn.appName) + + key, err := registry.OpenKey( + registry.CURRENT_USER, + registryPath, + registry.QUERY_VALUE, + ) + if err != nil { + if err == registry.ErrNotExist { + // Not an error, no saved categories + return nil + } + return fmt.Errorf("failed to open registry key: %w", err) + } + defer key.Close() + + data, _, err := key.GetStringValue(NotificationCategoriesRegistryKey) + if err != nil { + if err == registry.ErrNotExist { + // No value yet, but key exists + return nil + } + return fmt.Errorf("failed to read categories from registry: %w", err) + } + + categories := make(map[string]NotificationCategory) + if err := json.Unmarshal([]byte(data), &categories); err != nil { + return fmt.Errorf("failed to parse notification categories from registry: %w", err) + } + + wn.categories = categories + + return nil +} + +func (wn *windowsNotifier) getUserText(data []toast.UserData) (string, bool) { + for _, d := range data { + if d.Key == "userText" { + return d.Value, true + } + } + return "", false +} + +func (wn *windowsNotifier) getGUID() (string, error) { + keyPath := ToastRegistryPath + wn.appName + + k, err := registry.OpenKey(registry.CURRENT_USER, keyPath, registry.QUERY_VALUE) + if err == nil { + guid, _, err := k.GetStringValue(ToastRegistryGuidKey) + k.Close() + if err == nil && guid != "" { + return guid, nil + } + } + + guid := wn.generateGUID() + + k, _, err = registry.CreateKey(registry.CURRENT_USER, keyPath, registry.WRITE) + if err != nil { + return "", fmt.Errorf("failed to create registry key: %w", err) + } + defer k.Close() + + if err := k.SetStringValue(ToastRegistryGuidKey, guid); err != nil { + return "", fmt.Errorf("failed to write GUID to registry: %w", err) + } + + return guid, nil +} + +func (wn *windowsNotifier) generateGUID() string { + guid := uuid.New() + return fmt.Sprintf("{%s}", guid.String()) +} diff --git a/v3/pkg/services/sqlite/sqlite.go b/v3/pkg/services/sqlite/sqlite.go new file mode 100644 index 000000000..daf3ecd05 --- /dev/null +++ b/v3/pkg/services/sqlite/sqlite.go @@ -0,0 +1,500 @@ +//wails:include stmt.js +package sqlite + +import ( + "bytes" + "context" + "database/sql" + "fmt" + "sync" + "sync/atomic" + + "github.com/pkg/errors" + "github.com/wailsapp/wails/v3/pkg/application" + _ "modernc.org/sqlite" +) + +type Config struct { + // DBSource is the database URI to use. + // The string ":memory:" can be used to create an in-memory database. + // The sqlite driver can be configured through query parameters. + // For more details see https://pkg.go.dev/modernc.org/sqlite#Driver.Open + DBSource string +} + +//wails:inject export { +//wails:inject ExecContext as Execute, +//wails:inject QueryContext as Query +//wails:inject }; +//wails:inject +//wails:inject import { Stmt } from "./stmt.js"; +//wails:inject +//wails:inject **:/** +//wails:inject **: * Prepare creates a prepared statement for later queries or executions. +//wails:inject **: * Multiple queries or executions may be run concurrently from the returned statement. +//wails:inject **: * +//wails:inject **: * The caller must call the statement's Close method when it is no longer needed. +//wails:inject **: * Statements are closed automatically +//wails:inject **: * when the connection they are associated with is closed. +//wails:inject **: * +//wails:inject **: * Prepare supports early cancellation. +//wails:inject j*: * +//wails:inject j*: * @param {string} query +//wails:inject j*: * @returns {Promise & { cancel(): void }} +//wails:inject **: */ +//wails:inject j*:export function Prepare(query) { +//wails:inject t*:export function Prepare(query: string): Promise & { cancel(): void } { +//wails:inject **: const promise = PrepareContext(query); +//wails:inject j*: const wrapper = /** @type {any} */(promise.then(function (id) { +//wails:inject t*: const wrapper: any = (promise.then(function (id) { +//wails:inject **: return id == null ? null : new Stmt( +//wails:inject **: ClosePrepared.bind(null, id), +//wails:inject **: ExecPrepared.bind(null, id), +//wails:inject **: QueryPrepared.bind(null, id)); +//wails:inject **: })); +//wails:inject **: wrapper.cancel = promise.cancel; +//wails:inject **: return wrapper; +//wails:inject **:} +type SQLiteService struct { + lock sync.RWMutex + config *Config + conn *sql.DB + stmts map[uint64]struct{} +} + +// New initialises a sqlite service with the default configuration. +func New() *SQLiteService { + return NewWithConfig(nil) +} + +// NewWithConfig initialises a sqlite service with a custom configuration. +// If config is nil, it falls back to the default configuration, i.e. an in-memory database. +// +// The database connection is not opened right away. +// A call to [Service.Open] must succeed before using all other methods. +// If the service is registered with the application, +// [Service.Open] will be called automatically at startup. +func NewWithConfig(config *Config) *SQLiteService { + result := &SQLiteService{} + result.Configure(config) + return result +} + +// ServiceName returns the name of the plugin. +// You should use the go module format e.g. github.com/myuser/myplugin +func (s *SQLiteService) ServiceName() string { + return "github.com/wailsapp/wails/v3/plugins/sqlite" +} + +// ServiceStartup opens the database connection. +// It returns a non-nil error in case of failures. +func (s *SQLiteService) ServiceStartup(ctx context.Context, options application.ServiceOptions) error { + return s.Open() +} + +// ServiceShutdown closes the database connection. +// It returns a non-nil error in case of failures. +func (s *SQLiteService) ServiceShutdown() error { + return s.Close() +} + +// Configure changes the database service configuration. +// The connection state at call time is preserved. +// Consumers will need to call [Service.Open] manually after Configure +// in order to reconnect with the new configuration. +// +// See [NewWithConfig] for details on configuration. +// +//wails:ignore +func (s *SQLiteService) Configure(config *Config) { + if config == nil { + config = &Config{DBSource: ":memory:"} + } else { + // Clone to prevent changes from the outside. + clone := new(Config) + *clone = *config + config = clone + } + + s.lock.Lock() + defer s.lock.Unlock() + + s.config = config +} + +// Open validates the current configuration, +// closes the current connection if one is present, +// then opens and validates a new connection. +// +// Even when a non-nil error is returned, +// the database service is left in a consistent state, +// ready for a new call to Open. +func (s *SQLiteService) Open() error { + s.lock.Lock() + defer s.lock.Unlock() + + if s.config.DBSource == "" { + return errors.New(`no database source specified; please set DBSource in the config to a filename or specify ":memory:" to use an in-memory database`) + } + + if err := s.closeImpl(); err != nil { + return err + } + + conn, err := sql.Open("sqlite", s.config.DBSource) + if err != nil { + return errors.Wrap(err, "error opening database connection") + } + + // Test connection + if err := conn.Ping(); err != nil { + _ = conn.Close() + return errors.Wrap(err, "error opening database connection") + } + + s.conn = conn + s.stmts = make(map[uint64]struct{}) + + return nil +} + +// Close closes the current database connection if one is open, otherwise has no effect. +// Additionally, Close closes all open prepared statements associated to the connection. +// +// Even when a non-nil error is returned, +// the database service is left in a consistent state, +// ready for a call to [Service.Open]. +func (s *SQLiteService) Close() error { + s.lock.Lock() + defer s.lock.Unlock() + + return s.closeImpl() +} + +// closeImpl performs the close operation without acquiring the lock first. +// It is the caller's responsibility +// to ensure the lock is held exclusively (in write mode) +// for the entire duration of the call. +func (s *SQLiteService) closeImpl() error { + if s.conn == nil { + return nil + } + + for id := range s.stmts { + if stmt, ok := stmts.Load(id); ok { + // WARN: do not delegate to [Stmt.Close], it would cause a deadlock. + // Ignore errors, closing the connection should free up all resources. + _ = stmt.(*Stmt).sqlStmt.Close() + } + } + + err := s.conn.Close() + + // Clear the connection even in case of errors: + // if [sql.DB.Close] returns an error, + // the connection becomes unusable. + s.conn = nil + s.stmts = nil + + return err +} + +// Execute executes a query without returning any rows. +// +//wails:ignore +func (s *SQLiteService) Execute(query string, args ...any) error { + return s.ExecContext(context.Background(), query, args...) +} + +// ExecContext executes a query without returning any rows. +// It supports early cancellation. +// +//wails:internal +func (s *SQLiteService) ExecContext(ctx context.Context, query string, args ...any) error { + s.lock.RLock() + conn := s.conn + s.lock.RUnlock() + + if conn == nil { + return errors.New("no open database connection") + } + + _, err := conn.ExecContext(ctx, query, args...) + if err != nil && !errors.Is(err, context.Canceled) { + return err + } + + return nil +} + +// Query executes a query and returns a slice of key-value records, +// one per row, with column names as keys. +// +//wails:ignore +func (s *SQLiteService) Query(query string, args ...any) (Rows, error) { + return s.QueryContext(context.Background(), query, args...) +} + +// QueryContext executes a query and returns a slice of key-value records, +// one per row, with column names as keys. +// It supports early cancellation, returning the slice of results fetched so far. +// +//wails:internal +func (s *SQLiteService) QueryContext(ctx context.Context, query string, args ...any) (Rows, error) { + s.lock.RLock() + conn := s.conn + s.lock.RUnlock() + + if conn == nil { + return nil, errors.New("no open database connection") + } + + rows, err := conn.QueryContext(ctx, query, args...) + if err != nil { + if errors.Is(err, context.Canceled) { + return Rows{}, nil + } else { + return nil, err + } + } + + return parseRows(ctx, rows) +} + +// Prepare creates a prepared statement for later queries or executions. +// Multiple queries or executions may be run concurrently from the returned statement. +// +// The caller should call the statement's Close method when it is no longer needed. +// Statements are closed automatically +// when the connection they are associated with is closed. +// +//wails:ignore +func (s *SQLiteService) Prepare(query string) (*Stmt, error) { + return s.PrepareContext(context.Background(), query) +} + +// PrepareContext creates a prepared statement for later queries or executions. +// Multiple queries or executions may be run concurrently from the returned statement. +// +// The caller must call the statement's Close method when it is no longer needed. +// Statements are closed automatically +// when the connection they are associated with is closed. +// +// PrepareContext supports early cancellation. +// +//wails:internal +func (s *SQLiteService) PrepareContext(ctx context.Context, query string) (*Stmt, error) { + s.lock.RLock() + conn := s.conn + s.lock.RUnlock() + + if conn == nil { + return nil, errors.New("no open database connection") + } + + id := nextId.Load() + for id != 0 && !nextId.CompareAndSwap(id, id+1) { + } + if id == 0 { + return nil, errors.New("prepared statement ids exhausted") + } + + stmt, err := conn.PrepareContext(ctx, query) + if err != nil { + if errors.Is(err, context.Canceled) { + return nil, nil + } else { + return nil, err + } + } + + func() { + s.lock.Lock() + defer s.lock.Unlock() + + s.stmts[id] = struct{}{} + }() + + wrapper := &Stmt{ + sqlStmt: stmt, + db: s, + id: id, + } + stmts.Store(id, wrapper) + + return wrapper, nil +} + +// ClosePrepared closes a prepared statement +// obtained with [Service.Prepare] or [Service.PrepareContext]. +// ClosePrepared is idempotent: +// it has no effect on prepared statements that are already closed. +// +//wails:internal +func (s *SQLiteService) ClosePrepared(stmt *Stmt) error { + return stmt.Close() +} + +// ExecPrepared executes a prepared statement +// obtained with [Service.Prepare] or [Service.PrepareContext] +// without returning any rows. +// It supports early cancellation. +// +//wails:internal +func (s *SQLiteService) ExecPrepared(ctx context.Context, stmt *Stmt, args ...any) error { + if stmt == nil { + return errors.New("no prepared statement provided") + } else if stmt.sqlStmt == nil { + return errors.New("prepared statement is not valid") + } + + _, err := stmt.ExecContext(ctx, args...) + if err != nil && !errors.Is(err, context.Canceled) { + return err + } + + return nil +} + +// QueryPrepared executes a prepared statement +// obtained with [Service.Prepare] or [Service.PrepareContext] +// and returns a slice of key-value records, one per row, with column names as keys. +// It supports early cancellation, returning the slice of results fetched so far. +// +//wails:internal +func (s *SQLiteService) QueryPrepared(ctx context.Context, stmt *Stmt, args ...any) (Rows, error) { + if stmt == nil { + return nil, errors.New("no prepared statement provided") + } else if stmt.sqlStmt == nil { + return nil, errors.New("prepared statement is not valid") + } + + rows, err := stmt.sqlStmt.QueryContext(ctx, args...) + if err != nil { + if errors.Is(err, context.Canceled) { + return Rows{}, nil + } else { + return nil, err + } + } + + return parseRows(ctx, rows) +} + +type ( + // Row holds a single row in the result of a query. + // It is a key-value map where keys are column names. + Row = map[string]any + + // Rows holds the result of a query + // as an array of key-value maps where keys are column names. + Rows = []Row +) + +func parseRows(ctx context.Context, rows *sql.Rows) (Rows, error) { + defer rows.Close() + + columns, _ := rows.Columns() + values := make([]any, len(columns)) + pointers := make([]any, len(columns)) + results := []map[string]any{} + + for rows.Next() { + select { + default: + case <-ctx.Done(): + return results, nil + } + + for i := range values { + pointers[i] = &values[i] + } + + if err := rows.Scan(pointers...); err != nil { + return nil, err + } + + row := make(map[string]any, len(columns)) + for i, column := range columns { + row[column] = values[i] + } + + results = append(results, row) + } + + return results, nil +} + +var ( + // stmts holds all currently active prepared statements, + // for all [Service] instances. + stmts sync.Map + + // nextId holds the next available prepared statement id. + // We use a counter to make sure IDs are never reused. + nextId atomic.Uint64 +) + +func init() { + nextId.Store(1) +} + +type ( + sqlStmt = *sql.Stmt + + // Stmt wraps a prepared sql statement pointer. + // It provides the same methods as the [sql.Stmt] type. + // + //wails:internal + Stmt struct { + sqlStmt + db *SQLiteService + id uint64 + } +) + +// Close closes the statement. +// It has no effect when the statement is already closed. +func (s *Stmt) Close() error { + if s == nil || s.sqlStmt == nil { + return nil + } + + err := s.sqlStmt.Close() + stmts.Delete(s.id) + + func() { + s.db.lock.Lock() + defer s.db.lock.Unlock() + + delete(s.db.stmts, s.id) + }() + + return errors.Wrap(err, "error closing prepared statement") +} + +func (s *Stmt) MarshalText() ([]byte, error) { + var buf bytes.Buffer + buf.Grow(16) + + if _, err := fmt.Fprintf(&buf, "%016x", s.id); err != nil { + return nil, err + } + + return buf.Bytes(), nil +} + +func (s *Stmt) UnmarshalText(text []byte) error { + if n, err := fmt.Fscanf(bytes.NewReader(text), "%x", &s.id); n < 1 || err != nil { + return errors.New("invalid prepared statement id") + } + + if stmt, ok := stmts.Load(s.id); ok { + *s = *(stmt.(*Stmt)) + } else { + s.sqlStmt = nil + s.db = nil + } + + return nil +} diff --git a/v3/pkg/services/sqlite/stmt.js b/v3/pkg/services/sqlite/stmt.js new file mode 100644 index 000000000..948b0c3dd --- /dev/null +++ b/v3/pkg/services/sqlite/stmt.js @@ -0,0 +1,79 @@ +//@ts-check + +//@ts-ignore: Unused imports +import * as $models from "./models.js"; + +const execSymbol = Symbol("exec"), + querySymbol = Symbol("query"), + closeSymbol = Symbol("close"); + +/** + * Stmt represents a prepared statement for later queries or executions. + * Multiple queries or executions may be run concurrently on the same statement. + * + * The caller must call the statement's Close method when it is no longer needed. + * Statements are closed automatically + * when the connection they are associated with is closed. + */ +export class Stmt { + /** + * Constructs a new prepared statement instance. + * @param {(...args: any[]) => Promise} close + * @param {(...args: any[]) => Promise & { cancel(): void }} exec + * @param {(...args: any[]) => Promise<$models.Rows> & { cancel(): void }} query + */ + constructor(close, exec, query) { + /** + * @member + * @private + * @type {typeof close} + */ + this[closeSymbol] = close; + + /** + * @member + * @private + * @type {typeof exec} + */ + this[execSymbol] = exec; + + /** + * @member + * @private + * @type {typeof query} + */ + this[querySymbol] = query; + } + + /** + * Closes the prepared statement. + * It has no effect when the statement is already closed. + * @returns {Promise} + */ + Close() { + return this[closeSymbol](); + } + + /** + * Executes the prepared statement without returning any rows. + * It supports early cancellation. + * + * @param {any[]} args + * @returns {Promise & { cancel(): void }} + */ + Exec(...args) { + return this[execSymbol](...args); + } + + /** + * Executes the prepared statement + * and returns a slice of key-value records, one per row, with column names as keys. + * It supports early cancellation, returning the array of results fetched so far. + * + * @param {any[]} args + * @returns {Promise<$models.Rows> & { cancel(): void }} + */ + Query(...args) { + return this[querySymbol](...args); + } +} diff --git a/v3/release-notes.txt b/v3/release-notes.txt new file mode 100644 index 000000000..1e1891b9f --- /dev/null +++ b/v3/release-notes.txt @@ -0,0 +1,2 @@ +## Added +- Add native Liquid Glass effect support for macOS with NSGlassEffectView (macOS 15.0+) and NSVisualEffectView fallback, including comprehensive material customization options by @leaanthony in [#4534](https://github.com/wailsapp/wails/pull/4534) \ No newline at end of file diff --git a/v3/release_notes.md b/v3/release_notes.md new file mode 100644 index 000000000..1e1891b9f --- /dev/null +++ b/v3/release_notes.md @@ -0,0 +1,2 @@ +## Added +- Add native Liquid Glass effect support for macOS with NSGlassEffectView (macOS 15.0+) and NSVisualEffectView fallback, including comprehensive material customization options by @leaanthony in [#4534](https://github.com/wailsapp/wails/pull/4534) \ No newline at end of file diff --git a/v3/tasks/Taskfile.yml b/v3/tasks/Taskfile.yml new file mode 100644 index 000000000..a9a8505dd --- /dev/null +++ b/v3/tasks/Taskfile.yml @@ -0,0 +1,7 @@ +version: '3' + +tasks: + generate:events: + dir: ./events + cmds: + - go run generate.go \ No newline at end of file diff --git a/v3/tasks/cleanup/cleanup.go b/v3/tasks/cleanup/cleanup.go new file mode 100644 index 000000000..bc6fd90ba --- /dev/null +++ b/v3/tasks/cleanup/cleanup.go @@ -0,0 +1,97 @@ +package main + +import ( + "fmt" + "os" + "path/filepath" + "strings" +) + +// CleanupPattern represents a cleanup rule +type CleanupPattern struct { + Type string // "prefix", "suffix", "exact" + Pattern string // The pattern to match + TargetFiles bool // true = target files, false = target directories + Description string // Description for logging +} + +// Patterns to clean up during test cleanup +var cleanupPatterns = []CleanupPattern{ + // Test binaries from examples + {Type: "prefix", Pattern: "testbuild-", TargetFiles: true, Description: "test binary"}, + + // Go test binaries + {Type: "suffix", Pattern: ".test", TargetFiles: true, Description: "Go test binary"}, + + // Package artifacts from packaging tests (only in internal/commands directory) + // Note: Only clean these from the commands directory, not from test temp directories + {Type: "exact", Pattern: "myapp.ARCHLINUX", TargetFiles: true, Description: "Linux ARCHLINUX package"}, + {Type: "exact", Pattern: "myapp.DEB", TargetFiles: true, Description: "Linux DEB package"}, + {Type: "exact", Pattern: "myapp.RPM", TargetFiles: true, Description: "Linux RPM package"}, + + // Test template directories from template tests + {Type: "prefix", Pattern: "test-template-", TargetFiles: false, Description: "test template directory"}, + + // CLI test binaries (files named exactly "appimage_testfiles") + {Type: "exact", Pattern: "appimage_testfiles", TargetFiles: true, Description: "CLI test binary"}, +} + +func main() { + fmt.Println("Starting cleanup...") + cleanedCount := 0 + + // Walk through all files and directories + err := filepath.Walk(".", func(path string, info os.FileInfo, err error) error { + if err != nil { + return nil // Continue on errors + } + + // Skip if we're in the .git directory + if strings.Contains(path, ".git") { + return nil + } + + name := info.Name() + + // Check each cleanup pattern + for _, pattern := range cleanupPatterns { + shouldClean := false + + switch pattern.Type { + case "prefix": + shouldClean = strings.HasPrefix(name, pattern.Pattern) + case "suffix": + shouldClean = strings.HasSuffix(name, pattern.Pattern) + case "exact": + shouldClean = name == pattern.Pattern + } + + if shouldClean { + // Check if the pattern targets the correct type (file or directory) + if pattern.TargetFiles && info.Mode().IsRegular() { + // This pattern targets files and this is a file + fmt.Printf("Removing %s: %s\n", pattern.Description, path) + os.Remove(path) + cleanedCount++ + break // Don't check other patterns for this file + } else if !pattern.TargetFiles && info.IsDir() { + // This pattern targets directories and this is a directory + fmt.Printf("Removing %s: %s\n", pattern.Description, path) + os.RemoveAll(path) + cleanedCount++ + return filepath.SkipDir // Don't recurse into removed directory + } + // If the pattern matches but the file type doesn't match TargetFiles, continue checking other patterns + } + } + + return nil + }) + + if err != nil { + fmt.Printf("Error during cleanup: %v\n", err) + os.Exit(1) + } + + fmt.Printf("Cleanup completed. Removed %d items.\n", cleanedCount) +} diff --git a/v3/tasks/contribs/main.go b/v3/tasks/contribs/main.go new file mode 100644 index 000000000..64fba1968 --- /dev/null +++ b/v3/tasks/contribs/main.go @@ -0,0 +1,38 @@ +package main + +import ( + "log" + "os/exec" + "strings" +) + +func main() { + cmd := exec.Command("npx", "all-contributors-cli", "check") + //cmd.Stdin = strings.NewReader("some input") + var out strings.Builder + cmd.Stdout = &out + err := cmd.Run() + missingSplit := strings.Split(out.String(), "\n") + if len(missingSplit) < 2 { + log.Fatal(out.String()) + } + missing := missingSplit[1] + missing = strings.TrimSpace(missing) + // Split on comma + for _, contrib := range strings.Split(missing, ",") { + // Trim whitespace + contrib = strings.TrimSpace(contrib) + if contrib == "dependabot[bot]" || contrib == "" { + continue + } + // Add contributor + cmd := exec.Command("npx", "all-contributors-cli", "add", contrib, "code") + err := cmd.Run() + if err != nil { + log.Fatal(err) + } + } + if err != nil { + log.Fatal(err) + } +} diff --git a/v3/tasks/events/generate.go b/v3/tasks/events/generate.go new file mode 100644 index 000000000..486749ba1 --- /dev/null +++ b/v3/tasks/events/generate.go @@ -0,0 +1,569 @@ +package main + +import ( + "bytes" + "os" + "strconv" + "strings" +) + +const eventsGo = `package events + +type ApplicationEventType uint +type WindowEventType uint + +var Common = newCommonEvents() + +type commonEvents struct { +$$COMMONEVENTSDECL} + +func newCommonEvents() commonEvents { + return commonEvents{ +$$COMMONEVENTSVALUES } +} + +var Linux = newLinuxEvents() + +type linuxEvents struct { +$$LINUXEVENTSDECL} + +func newLinuxEvents() linuxEvents { + return linuxEvents{ +$$LINUXEVENTSVALUES } +} + +var Mac = newMacEvents() + +type macEvents struct { +$$MACEVENTSDECL} + +func newMacEvents() macEvents { + return macEvents{ +$$MACEVENTSVALUES } +} + +var Windows = newWindowsEvents() + +type windowsEvents struct { +$$WINDOWSEVENTSDECL} + +func newWindowsEvents() windowsEvents { + return windowsEvents{ +$$WINDOWSEVENTSVALUES } +} + +var iOS = newIOSEvents() + +type iosEvents struct { +$$IOSEVENTSDECL} + +func newIOSEvents() iosEvents { + return iosEvents{ +$$IOSEVENTSVALUES } +} + +func JSEvent(event uint) string { + return eventToJS[event] +} + +var eventToJS = map[uint]string{ +$$EVENTTOJS} + +` + +const darwinEventsH = `//go:build darwin + +#ifndef _events_h +#define _events_h + +extern void processApplicationEvent(unsigned int, void* data); +extern void processWindowEvent(unsigned int, unsigned int); + +$$CHEADEREVENTS + +#endif` + +const linuxEventsH = `//go:build linux + +#ifndef _events_h +#define _events_h + +extern void processApplicationEvent(unsigned int, void* data); +extern void processWindowEvent(unsigned int, unsigned int); + +$$CHEADEREVENTS + +#endif` + +const iosEventsH = `//go:build ios + +#ifndef _events_h +#define _events_h + +extern void processApplicationEvent(unsigned int, void* data); +extern void processWindowEvent(unsigned int, unsigned int); + +$$CHEADEREVENTS + +#endif` + +const eventsTS = `/* + _ __ _ __ +| | / /___ _(_) /____ +| | /| / / __ ` + "`" + `/ / / ___/ +| |/ |/ / /_/ / / (__ ) +|__/|__/\__,_/_/_/____/ +The electron alternative for Go +(c) Lea Anthony 2019-present +*/ + +// Cynhyrchwyd y ffeil hon yn awtomatig. PEIDIWCH Â MODIWL +// This file is automatically generated. DO NOT EDIT + +export const Types = Object.freeze({ + Windows: Object.freeze({ +$$WINDOWSJSEVENTS }), + Mac: Object.freeze({ +$$MACJSEVENTS }), + Linux: Object.freeze({ +$$LINUXJSEVENTS }), + iOS: Object.freeze({ +$$IOSJSEVENTS }), + Common: Object.freeze({ +$$COMMONJSEVENTS }), +}); +` + +func main() { + eventNames, err := os.ReadFile("../../pkg/events/events.txt") + if err != nil { + panic(err) + } + + linuxEventsDecl := bytes.NewBufferString("") + linuxEventsValues := bytes.NewBufferString("") + linuxCHeaderEvents := bytes.NewBufferString("") + + macEventsDecl := bytes.NewBufferString("") + macEventsValues := bytes.NewBufferString("") + macCHeaderEvents := bytes.NewBufferString("") + windowDelegateEvents := bytes.NewBufferString("") + applicationDelegateEvents := bytes.NewBufferString("") + webviewDelegateEvents := bytes.NewBufferString("") + + windowsEventsDecl := bytes.NewBufferString("") + windowsEventsValues := bytes.NewBufferString("") + + iosEventsDecl := bytes.NewBufferString("") + iosEventsValues := bytes.NewBufferString("") + iosCHeaderEvents := bytes.NewBufferString("") + iosApplicationDelegateEvents := bytes.NewBufferString("") + iosWebviewDelegateEvents := bytes.NewBufferString("") + + commonEventsDecl := bytes.NewBufferString("") + commonEventsValues := bytes.NewBufferString("") + + linuxTSEvents := bytes.NewBufferString("") + macTSEvents := bytes.NewBufferString("") + windowsTSEvents := bytes.NewBufferString("") + iosTSEvents := bytes.NewBufferString("") + commonTSEvents := bytes.NewBufferString("") + + eventToJS := bytes.NewBufferString("") + + var id int + // var maxLinuxEvents int + var maxMacEvents int + var maxLinuxEvents int + var maxIOSEvents int + var line []byte + // Loop over each line in the file + for id, line = range bytes.Split(eventNames, []byte{'\n'}) { + + // First 1024 is reserved + id = id + 1024 + + // Skip empty lines + if len(line) == 0 { + continue + } + + // split on the colon + split := bytes.Split(line, []byte{':'}) + platform := strings.TrimSpace(string(split[0])) + event := strings.TrimSpace(string(split[1])) + var ignoreEvent bool + if strings.HasSuffix(event, "!") { + event = strings.TrimSuffix(event, "!") + ignoreEvent = true + } + // Strip last byte of line if it's a "!" character + if line[len(line)-1] == '!' { + line = line[:len(line)-1] + } + + // Title case the event name + eventTitle := string(bytes.ToUpper([]byte{event[0]})) + event[1:] + // delegate function name has a lowercase first character + delegateEventFunction := string(bytes.ToLower([]byte{event[0]})) + event[1:] + + // Add to buffer + switch platform { + case "linux": + eventType := "ApplicationEventType" + if strings.HasPrefix(event, "Window") { + eventType = "WindowEventType" + } + if strings.HasPrefix(event, "WebView") { + eventType = "WindowEventType" + } + linuxEventsDecl.WriteString("\t" + eventTitle + " " + eventType + "\n") + linuxEventsValues.WriteString("\t\t" + event + ": " + strconv.Itoa(id) + ",\n") + linuxTSEvents.WriteString("\t\t" + event + ": \"linux:" + event + "\",\n") + eventToJS.WriteString("\t" + strconv.Itoa(id) + ": \"linux:" + event + "\",\n") + maxLinuxEvents = id + linuxCHeaderEvents.WriteString("#define Event" + eventTitle + " " + strconv.Itoa(id) + "\n") + case "mac": + eventType := "ApplicationEventType" + if strings.HasPrefix(event, "Window") { + eventType = "WindowEventType" + } + if strings.HasPrefix(event, "WebView") { + eventType = "WindowEventType" + } + macEventsDecl.WriteString("\t" + eventTitle + " " + eventType + "\n") + macEventsValues.WriteString("\t\t" + event + ": " + strconv.Itoa(id) + ",\n") + macTSEvents.WriteString("\t\t" + event + ": \"mac:" + event + "\",\n") + macCHeaderEvents.WriteString("#define Event" + eventTitle + " " + strconv.Itoa(id) + "\n") + eventToJS.WriteString("\t" + strconv.Itoa(id) + ": \"mac:" + event + "\",\n") + maxMacEvents = id + if ignoreEvent { + continue + } + // Check if this is a window event + if strings.HasPrefix(event, "Window") { + windowDelegateEvents.WriteString(`- (void)` + delegateEventFunction + `:(NSNotification *)notification { + if( hasListeners(Event` + eventTitle + `) ) { + processWindowEvent(self.windowId, Event` + eventTitle + `); + } +} + +`) + } + // Check if this is a webview event + if strings.HasPrefix(event, "WebView") { + webViewFunction := strings.TrimPrefix(event, "WebView") + webViewFunction = string(bytes.ToLower([]byte{webViewFunction[0]})) + webViewFunction[1:] + webviewDelegateEvents.WriteString(`- (void)webView:(WKWebView *)webview ` + webViewFunction + `:(WKNavigation *)navigation { + if( hasListeners(Event` + eventTitle + `) ) { + processWindowEvent(self.windowId, Event` + eventTitle + `); + } +} + +`) + } + if strings.HasPrefix(event, "Application") { + applicationDelegateEvents.WriteString(`- (void)` + delegateEventFunction + `:(NSNotification *)notification { + if( hasListeners(Event` + eventTitle + `) ) { + processApplicationEvent(Event` + eventTitle + `, NULL); + } +} + +`) + } + case "common": + eventType := "ApplicationEventType" + if strings.HasPrefix(event, "Window") { + eventType = "WindowEventType" + } + if strings.HasPrefix(event, "WebView") { + eventType = "WindowEventType" + } + commonEventsDecl.WriteString("\t" + eventTitle + " " + eventType + "\n") + commonEventsValues.WriteString("\t\t" + event + ": " + strconv.Itoa(id) + ",\n") + commonTSEvents.WriteString("\t\t" + event + ": \"common:" + event + "\",\n") + eventToJS.WriteString("\t" + strconv.Itoa(id) + ": \"common:" + event + "\",\n") + case "windows": + eventType := "ApplicationEventType" + if strings.HasPrefix(event, "Window") { + eventType = "WindowEventType" + } + if strings.HasPrefix(event, "WebView") { + eventType = "WindowEventType" + } + windowsEventsDecl.WriteString("\t" + eventTitle + " " + eventType + "\n") + windowsEventsValues.WriteString("\t\t" + event + ": " + strconv.Itoa(id) + ",\n") + windowsTSEvents.WriteString("\t\t" + event + ": \"windows:" + event + "\",\n") + eventToJS.WriteString("\t" + strconv.Itoa(id) + ": \"windows:" + event + "\",\n") + case "ios": + eventType := "ApplicationEventType" + if strings.HasPrefix(event, "Window") { + eventType = "WindowEventType" + } + if strings.HasPrefix(event, "WebView") { + eventType = "WindowEventType" + } + iosEventsDecl.WriteString("\t" + eventTitle + " " + eventType + "\n") + iosEventsValues.WriteString("\t\t" + event + ": " + strconv.Itoa(id) + ",\n") + iosTSEvents.WriteString("\t\t" + event + ": \"ios:" + event + "\",\n") + iosCHeaderEvents.WriteString("#define Event" + eventTitle + " " + strconv.Itoa(id) + "\n") + eventToJS.WriteString("\t" + strconv.Itoa(id) + ": \"ios:" + event + "\",\n") + maxIOSEvents = id + // Note: iOS Window and Touch events are not auto-generated as delegate methods + // because they need to be integrated into existing UIViewController lifecycle methods + // and touch handling code. These events should be manually triggered where appropriate. + // Check if this is a webview navigation event + if strings.HasPrefix(event, "WebView") { + // Convert to WKNavigationDelegate method format + webViewMethod := strings.TrimPrefix(event, "WebView") + webViewMethod = string(bytes.ToLower([]byte{webViewMethod[0]})) + webViewMethod[1:] + + // Map to actual WKNavigationDelegate methods + var delegateMethod string + switch webViewMethod { + case "didStartNavigation": + delegateMethod = "didStartProvisionalNavigation" + case "didFinishNavigation": + delegateMethod = "didFinishNavigation" + case "didFailNavigation": + delegateMethod = "didFailProvisionalNavigation" + case "decidePolicyForNavigationAction": + // This needs special handling with decisionHandler + iosWebviewDelegateEvents.WriteString(`- (void)webView:(WKWebView *)webView decidePolicyForNavigationAction:(WKNavigationAction *)navigationAction decisionHandler:(void (^)(WKNavigationActionPolicy))decisionHandler { + if( hasListeners(Event` + eventTitle + `) ) { + processWindowEvent(self.windowID, Event` + eventTitle + `); + } + decisionHandler(WKNavigationActionPolicyAllow); +} + +`) + // Skip the default delegate method generation below + goto skipDefaultWebViewDelegate + default: + delegateMethod = webViewMethod + } + + iosWebviewDelegateEvents.WriteString(`- (void)webView:(WKWebView *)webView ` + delegateMethod + `:(WKNavigation *)navigation { + if( hasListeners(Event` + eventTitle + `) ) { + processWindowEvent(self.windowID, Event` + eventTitle + `); + } +} + +`) + skipDefaultWebViewDelegate: + } + // Check if this is an application event + if strings.HasPrefix(event, "Application") { + // Convert to UIApplicationDelegate method format + // e.g. "ApplicationDidBecomeActive" -> "applicationDidBecomeActive" + methodName := "application" + strings.TrimPrefix(event, "Application") + methodName = string(bytes.ToLower([]byte{methodName[0]})) + methodName[1:] + + iosApplicationDelegateEvents.WriteString(`- (void)` + methodName + `:(UIApplication *)application { + if( hasListeners(Event` + eventTitle + `) ) { + processApplicationEvent(Event` + eventTitle + `, NULL); + } +} + +`) + } + } + } + + macCHeaderEvents.WriteString("\n#define MAX_EVENTS " + strconv.Itoa(maxMacEvents+1) + "\n") + linuxCHeaderEvents.WriteString("\n#define MAX_EVENTS " + strconv.Itoa(maxLinuxEvents+1) + "\n") + iosCHeaderEvents.WriteString("\n#define MAX_EVENTS " + strconv.Itoa(maxIOSEvents+1) + "\n") + + // Save the eventsGo template substituting the values and decls + templateToWrite := strings.ReplaceAll(eventsGo, "$$LINUXEVENTSDECL", linuxEventsDecl.String()) + templateToWrite = strings.ReplaceAll(templateToWrite, "$$LINUXEVENTSVALUES", linuxEventsValues.String()) + templateToWrite = strings.ReplaceAll(templateToWrite, "$$MACEVENTSDECL", macEventsDecl.String()) + templateToWrite = strings.ReplaceAll(templateToWrite, "$$MACEVENTSVALUES", macEventsValues.String()) + + templateToWrite = strings.ReplaceAll(templateToWrite, "$$WINDOWSEVENTSDECL", windowsEventsDecl.String()) + templateToWrite = strings.ReplaceAll(templateToWrite, "$$WINDOWSEVENTSVALUES", windowsEventsValues.String()) + templateToWrite = strings.ReplaceAll(templateToWrite, "$$IOSEVENTSDECL", iosEventsDecl.String()) + templateToWrite = strings.ReplaceAll(templateToWrite, "$$IOSEVENTSVALUES", iosEventsValues.String()) + templateToWrite = strings.ReplaceAll(templateToWrite, "$$COMMONEVENTSDECL", commonEventsDecl.String()) + templateToWrite = strings.ReplaceAll(templateToWrite, "$$COMMONEVENTSVALUES", commonEventsValues.String()) + templateToWrite = strings.ReplaceAll(templateToWrite, "$$EVENTTOJS", eventToJS.String()) + err = os.WriteFile("../../pkg/events/events.go", []byte(templateToWrite), 0644) + if err != nil { + panic(err) + } + + // Save the eventsTS template substituting the values and decls + templateToWrite = strings.ReplaceAll(eventsTS, "$$MACJSEVENTS", macTSEvents.String()) + templateToWrite = strings.ReplaceAll(templateToWrite, "$$WINDOWSJSEVENTS", windowsTSEvents.String()) + templateToWrite = strings.ReplaceAll(templateToWrite, "$$LINUXJSEVENTS", linuxTSEvents.String()) + templateToWrite = strings.ReplaceAll(templateToWrite, "$$IOSJSEVENTS", iosTSEvents.String()) + templateToWrite = strings.ReplaceAll(templateToWrite, "$$COMMONJSEVENTS", commonTSEvents.String()) + err = os.WriteFile("../../internal/runtime/desktop/@wailsio/runtime/src/event_types.ts", []byte(templateToWrite), 0644) + if err != nil { + panic(err) + } + + // Save the darwinEventsH template substituting the values and decls + templateToWrite = strings.ReplaceAll(darwinEventsH, "$$CHEADEREVENTS", macCHeaderEvents.String()) + err = os.WriteFile("../../pkg/events/events_darwin.h", []byte(templateToWrite), 0644) + if err != nil { + panic(err) + } + + // Save the linuxEventsH template substituting the values and decls + templateToWrite = strings.ReplaceAll(linuxEventsH, "$$CHEADEREVENTS", linuxCHeaderEvents.String()) + err = os.WriteFile("../../pkg/events/events_linux.h", []byte(templateToWrite), 0644) + if err != nil { + panic(err) + } + + // Save the iosEventsH template substituting the values and decls + templateToWrite = strings.ReplaceAll(iosEventsH, "$$CHEADEREVENTS", iosCHeaderEvents.String()) + err = os.WriteFile("../../pkg/events/events_ios.h", []byte(templateToWrite), 0644) + if err != nil { + panic(err) + } + + // Declare buffer and flag for processing delegate files + var buffer bytes.Buffer + var inGeneratedEvents bool + + // Load the iOS app_delegate.m file + iosAppDelegate, err := os.ReadFile("../../pkg/application/application_ios_delegate.m") + if err != nil { + panic(err) + } + // iterate over the lines until we reach a line that says "// GENERATED EVENTS START" + // then we insert the events + // then we iterate until we reach a line that says "// GENERATED EVENTS END" + // then we write the file + buffer.Reset() + inGeneratedEvents = false + for _, line := range bytes.Split(iosAppDelegate, []byte{'\n'}) { + if bytes.Contains(line, []byte("// GENERATED EVENTS START")) { + inGeneratedEvents = true + buffer.WriteString("// GENERATED EVENTS START\n") + buffer.WriteString(iosApplicationDelegateEvents.String()) + continue + } + if bytes.Contains(line, []byte("// GENERATED EVENTS END")) { + inGeneratedEvents = false + buffer.WriteString("// GENERATED EVENTS END\n") + continue + } + if !inGeneratedEvents { + if len(line) > 0 { + buffer.Write(line) + buffer.WriteString("\n") + } + } + } + err = os.WriteFile("../../pkg/application/application_ios_delegate.m", buffer.Bytes(), 0755) + if err != nil { + panic(err) + } + + // Load the iOS webview_window.m file + iosWebviewWindow, err := os.ReadFile("../../pkg/application/webview_window_ios.m") + if err != nil { + panic(err) + } + // iterate over the lines until we reach a line that says "// GENERATED EVENTS START" + // then we insert the events + // then we iterate until we reach a line that says "// GENERATED EVENTS END" + // then we write the file + buffer.Reset() + for _, line := range bytes.Split(iosWebviewWindow, []byte{'\n'}) { + if bytes.Contains(line, []byte("// GENERATED EVENTS START")) { + inGeneratedEvents = true + buffer.WriteString("// GENERATED EVENTS START\n") + // Only write webview delegate events, not view controller lifecycle events + buffer.WriteString(iosWebviewDelegateEvents.String()) + continue + } + if bytes.Contains(line, []byte("// GENERATED EVENTS END")) { + inGeneratedEvents = false + buffer.WriteString("// GENERATED EVENTS END\n") + continue + } + if !inGeneratedEvents { + if len(line) > 0 { + buffer.Write(line) + buffer.WriteString("\n") + } + } + } + err = os.WriteFile("../../pkg/application/webview_window_ios.m", buffer.Bytes(), 0755) + if err != nil { + panic(err) + } + + // Load the window_delegate.m file + windowDelegate, err := os.ReadFile("../../pkg/application/webview_window_darwin.m") + if err != nil { + panic(err) + } + // iterate over the lines until we reach a line that says "// GENERATED EVENTS START" + // then we insert the events + // then we iterate until we reach a line that says "// GENERATED EVENTS END" + // then we write the file + buffer.Reset() + for _, line := range bytes.Split(windowDelegate, []byte{'\n'}) { + if bytes.Contains(line, []byte("// GENERATED EVENTS START")) { + inGeneratedEvents = true + buffer.WriteString("// GENERATED EVENTS START\n") + buffer.WriteString(windowDelegateEvents.String()) + buffer.WriteString(webviewDelegateEvents.String()) + continue + } + if bytes.Contains(line, []byte("// GENERATED EVENTS END")) { + inGeneratedEvents = false + buffer.WriteString("// GENERATED EVENTS END\n") + continue + } + if !inGeneratedEvents { + if len(line) > 0 { + buffer.Write(line) + buffer.WriteString("\n") + } + } + } + err = os.WriteFile("../../pkg/application/webview_window_darwin.m", buffer.Bytes(), 0755) + if err != nil { + panic(err) + } + + // Load the app_delegate.m file + appDelegate, err := os.ReadFile("../../pkg/application/application_darwin_delegate.m") + if err != nil { + panic(err) + } + // iterate over the lines until we reach a line that says "// GENERATED EVENTS START" + // then we insert the events + // then we iterate until we reach a line that says "// GENERATED EVENTS END" + // then we write the file + buffer.Reset() + for _, line := range bytes.Split(appDelegate, []byte{'\n'}) { + if bytes.Contains(line, []byte("// GENERATED EVENTS START")) { + inGeneratedEvents = true + buffer.WriteString("// GENERATED EVENTS START\n") + buffer.WriteString(applicationDelegateEvents.String()) + continue + } + if bytes.Contains(line, []byte("// GENERATED EVENTS END")) { + inGeneratedEvents = false + buffer.WriteString("// GENERATED EVENTS END\n") + continue + } + if !inGeneratedEvents { + if len(line) > 0 { + buffer.Write(line) + buffer.WriteString("\n") + } + } + } + err = os.WriteFile("../../pkg/application/application_darwin_delegate.m", buffer.Bytes(), 0755) + if err != nil { + panic(err) + } +} diff --git a/v3/tasks/events/go.mod b/v3/tasks/events/go.mod new file mode 100644 index 000000000..55ed969ca --- /dev/null +++ b/v3/tasks/events/go.mod @@ -0,0 +1,3 @@ +module events + +go 1.24 diff --git a/v3/tasks/release/RELEASE_NOTES_CREATION.md b/v3/tasks/release/RELEASE_NOTES_CREATION.md new file mode 100644 index 000000000..0fe04d7e0 --- /dev/null +++ b/v3/tasks/release/RELEASE_NOTES_CREATION.md @@ -0,0 +1,118 @@ +# Release Notes Creation Documentation + +## Overview + +The `release.go` script now supports a `--create-release-notes` flag that extracts changelog content from `UNRELEASED_CHANGELOG.md` and creates a clean `release_notes.md` file suitable for GitHub releases. + +## How It Works + +### 1. Command Usage + +```bash +go run release.go --create-release-notes [output_path] +``` + +- `output_path` is optional, defaults to `../../release_notes.md` +- The script expects `UNRELEASED_CHANGELOG.md` to be at `../../UNRELEASED_CHANGELOG.md` (relative to the script location) + +### 2. Extraction Process + +The `extractChangelogContent()` function: + +1. Reads the UNRELEASED_CHANGELOG.md file +2. Filters out: + - The main "# Unreleased Changes" header + - HTML comments (``) + - Empty sections (sections with no bullet points) + - Everything after the `---` separator (example entries) +3. Preserves: + - Section headers (## Added, ## Changed, etc.) that have content + - Bullet points with actual text (both `-` and `*` styles) + - Proper spacing between sections + +### 3. File Structure Expected + +```markdown +# Unreleased Changes + + + +## Added + +- Actual content preserved +- More content + +## Changed + + +## Fixed +- Bug fixes included + +--- + +### Example Entries: +Everything after the --- is ignored +``` + +### 4. Output Format + +The generated `release_notes.md` contains only the actual changelog entries: + +```markdown +## Added +- Actual content preserved +- More content + +## Fixed +- Bug fixes included +``` + +## Testing Results + +### ✅ Successful Tests + +1. **Valid Content Extraction**: Successfully extracts and formats changelog entries +2. **Empty Changelog Detection**: Properly fails when no content exists +3. **Comment Filtering**: Correctly removes HTML comments +4. **Mixed Bullet Styles**: Handles both `-` and `*` bullet points +5. **Custom Output Path**: Supports specifying custom output file location +6. **Flag Compatibility**: Works with `--check-only` and `--extract-changelog` flags + +### Test Commands Run + +```bash +# Create release notes with default path +go run release.go --create-release-notes + +# Create with custom path +go run release.go --create-release-notes /path/to/output.md + +# Check if content exists +go run release.go --check-only + +# Extract content to stdout +go run release.go --extract-changelog +``` + +## Integration with GitHub Workflow + +The nightly release workflow should: + +1. Run `go run release.go --create-release-notes` before the main release task +2. Use the generated `release_notes.md` for the GitHub release body +3. The main release task will clear UNRELEASED_CHANGELOG.md after processing + +## Error Handling + +The script will exit with status 1 if: +- UNRELEASED_CHANGELOG.md doesn't exist +- No actual content is found (only template/comments) +- File write operations fail + +## Benefits + +1. **Separation of Concerns**: Changelog extraction happens before the file is cleared +2. **Clean Output**: No template text or comments in release notes +3. **Testable**: Can be run and tested independently +4. **Flexible**: Supports custom output paths +5. **Consistent**: Same extraction logic used by all flags \ No newline at end of file diff --git a/v3/tasks/release/release.go b/v3/tasks/release/release.go new file mode 100644 index 000000000..19ca1d755 --- /dev/null +++ b/v3/tasks/release/release.go @@ -0,0 +1,988 @@ +package main + +import ( + "bytes" + "encoding/json" + "errors" + "flag" + "fmt" + "io" + "net/http" + "net/url" + "os" + "os/exec" + "path/filepath" + "strconv" + "strings" + "time" +) + +const ( + versionFile = "../../internal/version/version.txt" + changelogFile = "../../../docs/src/content/docs/changelog.mdx" + defaultReleaseBranch = "v3-alpha" + defaultReleaseTitle = "Wails %s" + defaultReleaseTarget = "v3-alpha" + githubDefaultAPI = "https://api.github.com" + githubAPIVersion = "2022-11-28" +) + +var ( + unreleasedChangelogFile = "../../UNRELEASED_CHANGELOG.md" +) + +type releaseOptions struct { + version string + dryRun bool + branch string + target string +} + +var errNoUnreleasedContent = errors.New("No unreleased changelog content found.") + +func checkError(err error) { + if err != nil { + println(err.Error()) + os.Exit(1) + } +} + +// getUnreleasedChangelogTemplate returns the template content for UNRELEASED_CHANGELOG.md +func getUnreleasedChangelogTemplate() string { + return `# Unreleased Changes + + + +## Added + + +## Changed + + +## Fixed + + +## Deprecated + + +## Removed + + +## Security + + +--- + +### Example Entries: + +**Added:** +- Add support for custom window icons in application options +- Add new ` + "`SetWindowIcon()`" + ` method to runtime API (#1234) + +**Changed:** +- Update minimum Go version requirement to 1.21 +- Improve error messages for invalid configuration files + +**Fixed:** +- Fix memory leak in event system during window close operations (#5678) +- Fix crash when using context menus on Linux with Wayland + +**Security:** +- Update dependencies to address CVE-2024-12345 in third-party library +` +} + +// clearUnreleasedChangelog clears the UNRELEASED_CHANGELOG.md file and resets it with the template +func clearUnreleasedChangelog() error { + template := getUnreleasedChangelogTemplate() + + // Write the template back to the file + err := os.WriteFile(unreleasedChangelogFile, []byte(template), 0o644) + if err != nil { + return fmt.Errorf("failed to reset UNRELEASED_CHANGELOG.md: %w", err) + } + + fmt.Printf("Successfully reset %s with template content\n", unreleasedChangelogFile) + return nil +} + +// extractChangelogContent extracts the actual changelog content from UNRELEASED_CHANGELOG.md +// It returns the content between the section headers and the example section +func extractChangelogContent() (string, error) { + content, err := os.ReadFile(unreleasedChangelogFile) + if err != nil { + return "", fmt.Errorf("failed to read %s: %w", unreleasedChangelogFile, err) + } + + contentStr := string(content) + lines := strings.Split(contentStr, "\n") + + var result []string + var inExampleSection bool + var inCommentBlock bool + var hasActualContent bool + var currentSection string + + for i, line := range lines { + trimmedLine := strings.TrimSpace(line) + + // Track comment blocks (handle multi-line comments) + if strings.Contains(line, "") { + inCommentBlock = false + } + continue + } + if inCommentBlock { + if strings.Contains(line, "-->") { + inCommentBlock = false + } + continue + } + + // Skip the main title + if strings.HasPrefix(trimmedLine, "# Unreleased Changes") { + continue + } + + // Check if we're entering the example section + if strings.HasPrefix(trimmedLine, "---") || strings.HasPrefix(trimmedLine, "### Example Entries") { + inExampleSection = true + continue + } + + // Skip example section content + if inExampleSection { + continue + } + + // Handle section headers + if strings.HasPrefix(trimmedLine, "##") { + currentSection = trimmedLine + // Only include section headers that have content after them + // We'll add it later if we find content + continue + } + + // Handle bullet points + if strings.HasPrefix(trimmedLine, "-") || strings.HasPrefix(trimmedLine, "*") { + // Check if this is actual content (not empty) + content := strings.TrimSpace(trimmedLine[1:]) + if content != "" { + // If this is the first content in a section, add the section header first + if currentSection != "" { + // Only add empty line if this isn't the first section + if len(result) > 0 { + result = append(result, "") + } + result = append(result, currentSection) + currentSection = "" // Reset so we don't add it again + } + result = append(result, line) + hasActualContent = true + } + } else if trimmedLine != "" && !strings.HasPrefix(trimmedLine, " + +## Added +- New feature 1 +- New feature 2 + +## Changed +- Changed item 1 + +## Fixed +- Bug fix 1 +- Bug fix 2 + +## Deprecated +- Deprecated feature + +## Removed +- Removed feature + +## Security +- Security fix + +--- + +### Example Entries: + +**Added:** +- Example entry +`, + expected: `## Added +- New feature 1 +- New feature 2 + +## Changed +- Changed item 1 + +## Fixed +- Bug fix 1 +- Bug fix 2 + +## Deprecated +- Deprecated feature + +## Removed +- Removed feature + +## Security +- Security fix`, + wantErr: false, + }, + { + name: "Only Added section with content", + content: `# Unreleased Changes + +## Added + +- Add Windows dark theme support +- Add new flag to release script + +## Changed + + +## Fixed + + +--- +### Example Entries: +`, + expected: `## Added +- Add Windows dark theme support +- Add new flag to release script`, + wantErr: false, + }, + { + name: "Empty sections should not be included", + content: `# Unreleased Changes + +## Added + + +## Changed + +- Update Go version to 1.23 + +## Fixed + + +--- +`, + expected: `## Changed +- Update Go version to 1.23`, + wantErr: false, + }, + { + name: "No content returns empty string", + content: `# Unreleased Changes + +## Added + + +## Changed + + +## Fixed + + +--- +`, + expected: "", + wantErr: false, + }, + { + name: "Comments should be excluded", + content: `# Unreleased Changes + + + +## Added + +- Real content here + +- More content + +--- +`, + expected: `## Added +- Real content here +- More content`, + wantErr: false, + }, + { + name: "Multi-line comments handled correctly", + content: `# Unreleased Changes + + + +## Added +- Feature 1 + +- Feature 2 + +--- +`, + expected: `## Added +- Feature 1 +- Feature 2`, + wantErr: false, + }, + { + name: "Mixed bullet point styles", + content: `# Unreleased Changes + +## Added +- Dash bullet point +* Asterisk bullet point +- Another dash + +--- +`, + expected: `## Added +- Dash bullet point +* Asterisk bullet point +- Another dash`, + wantErr: false, + }, + { + name: "Trailing empty lines removed", + content: `# Unreleased Changes + +## Added +- Feature 1 + + +## Changed +- Change 1 + + + +--- +`, + expected: `## Added +- Feature 1 + +## Changed +- Change 1`, + wantErr: false, + }, + } + + for _, tt := range tests { + t.Run(tt.name, func(t *testing.T) { + // Create a temporary file + tmpDir := t.TempDir() + tmpFile := filepath.Join(tmpDir, "UNRELEASED_CHANGELOG.md") + err := os.WriteFile(tmpFile, []byte(tt.content), 0644) + if err != nil { + t.Fatalf("Failed to create test file: %v", err) + } + + // Save original path and update it + originalPath := unreleasedChangelogFile + unreleasedChangelogFile = tmpFile + defer func() { + unreleasedChangelogFile = originalPath + }() + + // Test the function + got, err := extractChangelogContent() + if (err != nil) != tt.wantErr { + t.Errorf("extractChangelogContent() error = %v, wantErr %v", err, tt.wantErr) + return + } + + if got != tt.expected { + t.Errorf("extractChangelogContent() = %q, want %q", got, tt.expected) + } + }) + } +} + +// TestCreateReleaseNotes tests the --create-release-notes functionality +func TestCreateReleaseNotes(t *testing.T) { + tests := []struct { + name string + changelogContent string + expectSuccess bool + expectedNotes string + }{ + { + name: "Valid changelog creates release notes", + changelogContent: `# Unreleased Changes + +## Added +- New feature X +- New feature Y + +## Fixed +- Bug fix A + +--- +### Examples: +`, + expectSuccess: true, + expectedNotes: `## Added +- New feature X +- New feature Y + +## Fixed +- Bug fix A`, + }, + { + name: "Empty changelog fails", + changelogContent: `# Unreleased Changes + +## Added + + +## Changed + + +--- +`, + expectSuccess: false, + expectedNotes: "", + }, + } + + for _, tt := range tests { + t.Run(tt.name, func(t *testing.T) { + // Create temporary directory + tmpDir := t.TempDir() + + // Create UNRELEASED_CHANGELOG.md + changelogPath := filepath.Join(tmpDir, "UNRELEASED_CHANGELOG.md") + err := os.WriteFile(changelogPath, []byte(tt.changelogContent), 0644) + if err != nil { + t.Fatalf("Failed to create changelog file: %v", err) + } + + // Create release notes path + releaseNotesPath := filepath.Join(tmpDir, "release_notes.md") + + // Save original path + originalPath := unreleasedChangelogFile + unreleasedChangelogFile = changelogPath + defer func() { + unreleasedChangelogFile = originalPath + }() + + // Test the create release notes flow + content, err := extractChangelogContent() + if err != nil && tt.expectSuccess { + t.Fatalf("Failed to extract content: %v", err) + } + + if tt.expectSuccess { + if content == "" { + t.Error("Expected content but got empty string") + } else { + // Write the release notes + err = os.WriteFile(releaseNotesPath, []byte(content), 0644) + if err != nil { + t.Fatalf("Failed to write release notes: %v", err) + } + + // Verify the file was created + data, err := os.ReadFile(releaseNotesPath) + if err != nil { + t.Fatalf("Failed to read release notes: %v", err) + } + + if string(data) != tt.expectedNotes { + t.Errorf("Release notes = %q, want %q", string(data), tt.expectedNotes) + } + } + } else { + if content != "" { + t.Errorf("Expected no content but got: %q", content) + } + } + }) + } +} + +// TestHasUnreleasedContent tests the hasUnreleasedContent function +func TestHasUnreleasedContent(t *testing.T) { + tests := []struct { + name string + content string + expected bool + }{ + { + name: "Has content", + content: `# Unreleased Changes + +## Added +- New feature + +--- +`, + expected: true, + }, + { + name: "No content", + content: `# Unreleased Changes + +## Added + + +## Changed + + +--- +`, + expected: false, + }, + } + + for _, tt := range tests { + t.Run(tt.name, func(t *testing.T) { + // Create temporary file + tmpDir := t.TempDir() + tmpFile := filepath.Join(tmpDir, "UNRELEASED_CHANGELOG.md") + err := os.WriteFile(tmpFile, []byte(tt.content), 0644) + if err != nil { + t.Fatalf("Failed to create test file: %v", err) + } + + // Save original path + originalPath := unreleasedChangelogFile + unreleasedChangelogFile = tmpFile + defer func() { + unreleasedChangelogFile = originalPath + }() + + // Test the function + got, err := hasUnreleasedContent() + if err != nil { + t.Fatalf("hasUnreleasedContent() error = %v", err) + } + + if got != tt.expected { + t.Errorf("hasUnreleasedContent() = %v, want %v", got, tt.expected) + } + }) + } +} + +// TestVersionIncrement tests version incrementing logic +func TestVersionIncrement(t *testing.T) { + tests := []struct { + name string + currentVersion string + expectedNext string + }{ + { + name: "Alpha version increment", + currentVersion: "v3.0.0-alpha.15", + expectedNext: "v3.0.0-alpha.16", + }, + { + name: "Beta version increment", + currentVersion: "v3.0.0-beta.5", + expectedNext: "v3.0.0-beta.6", + }, + { + name: "Regular version increment", + currentVersion: "v3.0.0", + expectedNext: "v3.0.1", + }, + { + name: "Patch version increment", + currentVersion: "v3.1.5", + expectedNext: "v3.1.6", + }, + } + + for _, tt := range tests { + t.Run(tt.name, func(t *testing.T) { + // Test incrementPatchVersion for regular versions + if !strings.Contains(tt.currentVersion, "-") { + got := incrementPatchVersion(tt.currentVersion) + // Note: incrementPatchVersion writes to file, so we just check the return value + if got != tt.expectedNext { + t.Errorf("incrementPatchVersion(%s) = %s, want %s", tt.currentVersion, got, tt.expectedNext) + } + } + }) + } +} + +// TestClearUnreleasedChangelog tests the changelog reset functionality +func TestClearUnreleasedChangelog(t *testing.T) { + // Create temporary file + tmpDir := t.TempDir() + tmpFile := filepath.Join(tmpDir, "UNRELEASED_CHANGELOG.md") + + // Write some content + err := os.WriteFile(tmpFile, []byte("Some content"), 0644) + if err != nil { + t.Fatalf("Failed to create test file: %v", err) + } + + // Save original path + originalPath := unreleasedChangelogFile + unreleasedChangelogFile = tmpFile + defer func() { + unreleasedChangelogFile = originalPath + }() + + // Clear the changelog + err = clearUnreleasedChangelog() + if err != nil { + t.Fatalf("clearUnreleasedChangelog() error = %v", err) + } + + // Read the file + content, err := os.ReadFile(tmpFile) + if err != nil { + t.Fatalf("Failed to read cleared file: %v", err) + } + + // Check it contains the template + if !strings.Contains(string(content), "# Unreleased Changes") { + t.Error("Cleared file doesn't contain template header") + } + if !strings.Contains(string(content), "## Added") { + t.Error("Cleared file doesn't contain Added section") + } + if !strings.Contains(string(content), "### Example Entries:") { + t.Error("Cleared file doesn't contain example section") + } +} \ No newline at end of file diff --git a/v3/tasks/release/release_test.go b/v3/tasks/release/release_test.go new file mode 100644 index 000000000..e598446fc --- /dev/null +++ b/v3/tasks/release/release_test.go @@ -0,0 +1,1043 @@ +package main + +import ( + "fmt" + "os" + "path/filepath" + "strconv" + "strings" + "testing" +) + +// setupTestEnvironment creates a proper directory structure for tests +// It returns the cleanup function and the project root directory +func setupTestEnvironment(t *testing.T) (cleanup func(), projectRoot string) { + // Save current directory + originalDir, _ := os.Getwd() + + // Create a temporary directory for testing + tmpDir := t.TempDir() + + // Create the wails project structure within temp directory + projectRoot = filepath.Join(tmpDir, "wails") + v3Dir := filepath.Join(projectRoot, "v3") + releaseDir := filepath.Join(v3Dir, "tasks", "release") + + // Create all necessary directories + err := os.MkdirAll(releaseDir, 0755) + if err != nil { + t.Fatalf("Failed to create test directory structure: %v", err) + } + + // Change to the release directory (where the script would run from) + os.Chdir(releaseDir) + + // Return cleanup function and project root + cleanup = func() { + os.Chdir(originalDir) + } + return cleanup, projectRoot +} + +func TestExtractChangelogContent_EmptySections(t *testing.T) { + cleanup, _ := setupTestEnvironment(t) + defer cleanup() + + // Create a test file with only one section having content + testContent := `# Unreleased Changes + + + +## Added + + +## Changed + + +## Fixed +- Fix critical bug in the system + +## Deprecated + + +## Removed + + +## Security + + +--- + +### Example Entries: + +**Added:** +- Example entry that should not be included` + + err := os.WriteFile(unreleasedChangelogFile, []byte(testContent), 0o644) + if err != nil { + t.Fatalf("Failed to create test file: %v", err) + } + + // Extract the content + content, err := extractChangelogContent() + if err != nil { + t.Fatalf("extractChangelogContent() failed: %v", err) + } + + // Verify we got content + if content == "" { + t.Fatal("Expected to extract content, but got empty string") + } + + // Verify ONLY the Fixed section is included (the only one with content) + if !strings.Contains(content, "## Fixed") { + t.Error("Expected to find '## Fixed' section header") + } + + if !strings.Contains(content, "Fix critical bug in the system") { + t.Error("Expected to find the Fixed content") + } + + // Verify empty sections are NOT included + sections := []string{"## Added", "## Changed", "## Deprecated", "## Removed", "## Security"} + for _, section := range sections { + if strings.Contains(content, section) { + t.Errorf("Expected NOT to find empty section '%s'", section) + } + } + + // Verify comments are not included + if strings.Contains(content, "") { + t.Error("Expected NOT to find HTML comments") + } + + // Verify example content is not included + if strings.Contains(content, "Example entry that should not be included") { + t.Error("Expected NOT to find example content") + } +} + +func TestExtractChangelogContent_AllEmpty(t *testing.T) { + cleanup, _ := setupTestEnvironment(t) + defer cleanup() + + // Create a test file with all empty sections (just the template) + testContent := getUnreleasedChangelogTemplate() + + err := os.WriteFile(unreleasedChangelogFile, []byte(testContent), 0o644) + if err != nil { + t.Fatalf("Failed to create test file: %v", err) + } + + // Extract the content + content, err := extractChangelogContent() + if err != nil { + t.Fatalf("extractChangelogContent() failed: %v", err) + } + + // Verify we got empty string (no content) + if content != "" { + t.Fatalf("Expected empty string for template-only file, got: %s", content) + } +} + +func TestExtractChangelogContent_MixedSections(t *testing.T) { + cleanup, _ := setupTestEnvironment(t) + defer cleanup() + + // Create a test file with some sections having content, others empty + testContent := `# Unreleased Changes + +## Added +- New feature A +- New feature B + +## Changed + + +## Fixed + + +## Deprecated +- Deprecated feature X + +## Removed + + +## Security +- Security fix for CVE-2024-1234` + + err := os.WriteFile(unreleasedChangelogFile, []byte(testContent), 0o644) + if err != nil { + t.Fatalf("Failed to create test file: %v", err) + } + + // Extract the content + content, err := extractChangelogContent() + if err != nil { + t.Fatalf("extractChangelogContent() failed: %v", err) + } + + // Verify we got content + if content == "" { + t.Fatal("Expected to extract content, but got empty string") + } + + // Verify sections WITH content are included + if !strings.Contains(content, "## Added") { + t.Error("Expected to find '## Added' section header") + } + if !strings.Contains(content, "New feature A") { + t.Error("Expected to find Added content") + } + + if !strings.Contains(content, "## Deprecated") { + t.Error("Expected to find '## Deprecated' section header") + } + if !strings.Contains(content, "Deprecated feature X") { + t.Error("Expected to find Deprecated content") + } + + if !strings.Contains(content, "## Security") { + t.Error("Expected to find '## Security' section header") + } + if !strings.Contains(content, "Security fix for CVE-2024-1234") { + t.Error("Expected to find Security content") + } + + // Verify empty sections are NOT included + emptyHeaders := []string{"## Changed", "## Fixed", "## Removed"} + for _, header := range emptyHeaders { + if strings.Contains(content, header) { + t.Errorf("Expected NOT to find empty section '%s'", header) + } + } + + // Print the extracted content for debugging + t.Logf("Extracted content:\n%s", content) +} + +func TestGetUnreleasedChangelogTemplate(t *testing.T) { + template := getUnreleasedChangelogTemplate() + + // Check that template contains required sections + requiredSections := []string{ + "# Unreleased Changes", + "## Added", + "## Changed", + "## Fixed", + "## Deprecated", + "## Removed", + "## Security", + "### Example Entries", + } + + for _, section := range requiredSections { + if !strings.Contains(template, section) { + t.Errorf("Template missing required section: %s", section) + } + } + + // Check that template contains guidelines + if !strings.Contains(template, "Guidelines:") { + t.Error("Template missing guidelines section") + } + + // Check that template contains example entries + if !strings.Contains(template, "Add support for custom window icons") { + t.Error("Template missing example entries") + } +} + +func TestHasUnreleasedContent_WithContent(t *testing.T) { + cleanup, _ := setupTestEnvironment(t) + defer cleanup() + + // Create a file with actual content + testContent := `# Unreleased Changes + +## Added +- Add new feature for testing +- Add another important feature + +## Fixed +- Fix critical bug in system` + + err := os.WriteFile(unreleasedChangelogFile, []byte(testContent), 0o644) + if err != nil { + t.Fatalf("Failed to create test file: %v", err) + } + + hasContent, err := hasUnreleasedContent() + if err != nil { + t.Fatalf("hasUnreleasedContent() failed: %v", err) + } + + if !hasContent { + t.Error("Expected hasUnreleasedContent() to return true for file with content") + } +} + +func TestHasUnreleasedContent_WithoutContent(t *testing.T) { + cleanup, _ := setupTestEnvironment(t) + defer cleanup() + + // Create a file with only template content (no actual entries) + template := getUnreleasedChangelogTemplate() + err := os.WriteFile(unreleasedChangelogFile, []byte(template), 0o644) + if err != nil { + t.Fatalf("Failed to create test file: %v", err) + } + + hasContent, err := hasUnreleasedContent() + if err != nil { + t.Fatalf("hasUnreleasedContent() failed: %v", err) + } + + if hasContent { + t.Error("Expected hasUnreleasedContent() to return false for template-only file") + } +} + +func TestHasUnreleasedContent_WithEmptyBullets(t *testing.T) { + cleanup, _ := setupTestEnvironment(t) + defer cleanup() + + // Create a file with empty bullet points + testContent := `# Unreleased Changes + +## Added +- +- + +## Fixed +` + + err := os.WriteFile(unreleasedChangelogFile, []byte(testContent), 0o644) + if err != nil { + t.Fatalf("Failed to create test file: %v", err) + } + + hasContent, err := hasUnreleasedContent() + if err != nil { + t.Fatalf("hasUnreleasedContent() failed: %v", err) + } + + if hasContent { + t.Error("Expected hasUnreleasedContent() to return false for file with empty bullets") + } +} + +func TestHasUnreleasedContent_NonexistentFile(t *testing.T) { + cleanup, _ := setupTestEnvironment(t) + defer cleanup() + + // Don't create the file + hasContent, err := hasUnreleasedContent() + if err == nil { + t.Error("Expected hasUnreleasedContent() to return an error for nonexistent file") + } + + if hasContent { + t.Error("Expected hasUnreleasedContent() to return false for nonexistent file") + } +} + +func TestSafeFileOperation_Success(t *testing.T) { + // Create a temporary directory for testing + tmpDir := t.TempDir() + testFile := filepath.Join(tmpDir, "test.txt") + + // Create initial file + initialContent := "initial content" + err := os.WriteFile(testFile, []byte(initialContent), 0o644) + if err != nil { + t.Fatalf("Failed to create test file: %v", err) + } + + // Perform safe operation that succeeds + newContent := "new content" + err = safeFileOperation(testFile, func() error { + return os.WriteFile(testFile, []byte(newContent), 0o644) + }) + + if err != nil { + t.Fatalf("safeFileOperation() failed: %v", err) + } + + // Verify the file has new content + content, err := os.ReadFile(testFile) + if err != nil { + t.Fatalf("Failed to read file after operation: %v", err) + } + + if string(content) != newContent { + t.Errorf("Expected file content '%s', got '%s'", newContent, string(content)) + } + + // Verify backup file was cleaned up + backupFile := testFile + ".backup" + if _, err := os.Stat(backupFile); !os.IsNotExist(err) { + t.Error("Backup file was not cleaned up after successful operation") + } +} + +func TestSafeFileOperation_Failure(t *testing.T) { + // Create a temporary directory for testing + tmpDir := t.TempDir() + testFile := filepath.Join(tmpDir, "test.txt") + + // Create initial file + initialContent := "initial content" + err := os.WriteFile(testFile, []byte(initialContent), 0o644) + if err != nil { + t.Fatalf("Failed to create test file: %v", err) + } + + // Perform safe operation that fails + err = safeFileOperation(testFile, func() error { + // First write something to the file + os.WriteFile(testFile, []byte("corrupted content"), 0o644) + // Then return an error to simulate failure + return os.ErrInvalid + }) + + if err == nil { + t.Error("Expected safeFileOperation() to return error") + } + + // Verify the file was restored to original content + content, err := os.ReadFile(testFile) + if err != nil { + t.Fatalf("Failed to read file after failed operation: %v", err) + } + + if string(content) != initialContent { + t.Errorf("Expected file content to be restored to '%s', got '%s'", initialContent, string(content)) + } + + // Verify backup file was cleaned up + backupFile := testFile + ".backup" + if _, err := os.Stat(backupFile); !os.IsNotExist(err) { + t.Error("Backup file was not cleaned up after failed operation") + } +} + +func TestSafeFileOperation_NewFile(t *testing.T) { + // Create a temporary directory for testing + tmpDir := t.TempDir() + testFile := filepath.Join(tmpDir, "newfile.txt") + + // Perform safe operation on non-existent file + content := "new file content" + err := safeFileOperation(testFile, func() error { + return os.WriteFile(testFile, []byte(content), 0o644) + }) + + if err != nil { + t.Fatalf("safeFileOperation() failed: %v", err) + } + + // Verify the file was created with correct content + fileContent, err := os.ReadFile(testFile) + if err != nil { + t.Fatalf("Failed to read created file: %v", err) + } + + if string(fileContent) != content { + t.Errorf("Expected file content '%s', got '%s'", content, string(fileContent)) + } +} + +func TestCopyFile(t *testing.T) { + // Create a temporary directory for testing + tmpDir := t.TempDir() + srcFile := filepath.Join(tmpDir, "source.txt") + dstFile := filepath.Join(tmpDir, "destination.txt") + + // Create source file + content := "test content for copying" + err := os.WriteFile(srcFile, []byte(content), 0o644) + if err != nil { + t.Fatalf("Failed to create source file: %v", err) + } + + // Copy the file + err = copyFile(srcFile, dstFile) + if err != nil { + t.Fatalf("copyFile() failed: %v", err) + } + + // Verify destination file exists and has correct content + dstContent, err := os.ReadFile(dstFile) + if err != nil { + t.Fatalf("Failed to read destination file: %v", err) + } + + if string(dstContent) != content { + t.Errorf("Expected destination content '%s', got '%s'", content, string(dstContent)) + } +} + +func TestCopyFile_NonexistentSource(t *testing.T) { + // Create a temporary directory for testing + tmpDir := t.TempDir() + srcFile := filepath.Join(tmpDir, "nonexistent.txt") + dstFile := filepath.Join(tmpDir, "destination.txt") + + // Try to copy non-existent file + err := copyFile(srcFile, dstFile) + if err == nil { + t.Error("Expected copyFile() to return error for non-existent source") + } + + // Verify destination file was not created + if _, err := os.Stat(dstFile); !os.IsNotExist(err) { + t.Error("Destination file should not exist after failed copy") + } +} + +func TestUpdateVersion(t *testing.T) { + tests := []struct { + name string + currentVersion string + expectedVersion string + }{ + { + name: "Alpha version increment", + currentVersion: "v3.0.0-alpha.12", + expectedVersion: "v3.0.0-alpha.13", + }, + { + name: "Beta version increment", + currentVersion: "v3.0.0-beta.5", + expectedVersion: "v3.0.0-beta.6", + }, + { + name: "RC version increment", + currentVersion: "v2.5.0-rc.1", + expectedVersion: "v2.5.0-rc.2", + }, + { + name: "Patch version increment", + currentVersion: "v3.0.0", + expectedVersion: "v3.0.1", + }, + { + name: "Patch version with higher number", + currentVersion: "v1.2.15", + expectedVersion: "v1.2.16", + }, + { + name: "Pre-release without number becomes patch", + currentVersion: "v3.0.0-alpha", + expectedVersion: "v3.0.1", + }, + { + name: "Version without v prefix", + currentVersion: "3.0.0", + expectedVersion: "v3.0.1", + }, + { + name: "Alpha with large number", + currentVersion: "v3.0.0-alpha.999", + expectedVersion: "v3.0.0-alpha.1000", + }, + } + + for _, tt := range tests { + t.Run(tt.name, func(t *testing.T) { + // Create a temporary directory for this test + tmpDir := t.TempDir() + tempVersionFile := filepath.Join(tmpDir, "version.txt") + + // Save original versionFile path + originalVersionFile := versionFile + defer func() { + // Restore original value + _ = originalVersionFile + }() + + // Write the current version to temp file + err := os.WriteFile(tempVersionFile, []byte(tt.currentVersion), 0o644) + if err != nil { + t.Fatalf("Failed to write test version file: %v", err) + } + + // Test the updateVersion function logic directly + result := func() string { + currentVersionData, err := os.ReadFile(tempVersionFile) + if err != nil { + t.Fatalf("Failed to read version file: %v", err) + } + currentVersion := strings.TrimSpace(string(currentVersionData)) + + // Check if it has a pre-release suffix (e.g., -alpha.12, -beta.1) + if strings.Contains(currentVersion, "-") { + // Split on the dash to separate version and pre-release + parts := strings.SplitN(currentVersion, "-", 2) + baseVersion := parts[0] + preRelease := parts[1] + + // Check if pre-release has a numeric suffix (e.g., alpha.12) + lastDotIndex := strings.LastIndex(preRelease, ".") + if lastDotIndex != -1 { + preReleaseTag := preRelease[:lastDotIndex] + numberStr := preRelease[lastDotIndex+1:] + + // Try to parse the number + if number, err := strconv.Atoi(numberStr); err == nil { + // Increment the pre-release number + number++ + newVersion := fmt.Sprintf("%s-%s.%d", baseVersion, preReleaseTag, number) + return newVersion + } + } + + // If we can't parse the pre-release format, just increment patch version + // and remove pre-release suffix + return testIncrementPatchVersion(baseVersion) + } + + // No pre-release suffix, just increment patch version + return testIncrementPatchVersion(currentVersion) + }() + + if result != tt.expectedVersion { + t.Errorf("updateVersion() = %v, want %v", result, tt.expectedVersion) + } + }) + } +} + +// testIncrementPatchVersion is a test version of incrementPatchVersion that doesn't write to file +func testIncrementPatchVersion(version string) string { + // Remove 'v' prefix if present + versionWithoutV := strings.TrimPrefix(version, "v") + + // Split into major.minor.patch + parts := strings.Split(versionWithoutV, ".") + if len(parts) != 3 { + // Not a valid semver, return as-is + return version + } + + // Parse patch version + patch, err := strconv.Atoi(parts[2]) + if err != nil { + return version + } + + // Increment patch + patch++ + + // Reconstruct version + return fmt.Sprintf("v%s.%s.%d", parts[0], parts[1], patch) +} + +// extractTestContent is a test helper that extracts changelog content using the same logic as extractChangelogContent +func extractTestContent(contentStr string) string { + lines := strings.Split(contentStr, "\n") + + var result []string + var inExampleSection bool + var inCommentBlock bool + var hasActualContent bool + var currentSection string + + for i, line := range lines { + trimmedLine := strings.TrimSpace(line) + + // Track comment blocks (handle multi-line comments) + if strings.Contains(line, "") { + inCommentBlock = false + } + continue + } + if inCommentBlock { + if strings.Contains(line, "-->") { + inCommentBlock = false + } + continue + } + + // Skip the main title + if strings.HasPrefix(trimmedLine, "# Unreleased Changes") { + continue + } + + // Check if we're entering the example section + if strings.HasPrefix(trimmedLine, "---") || strings.HasPrefix(trimmedLine, "### Example Entries") { + inExampleSection = true + continue + } + + // Skip example section content + if inExampleSection { + continue + } + + // Handle section headers + if strings.HasPrefix(trimmedLine, "##") { + currentSection = trimmedLine + // Only include section headers that have content after them + // We'll add it later if we find content + continue + } + + // Handle bullet points + if strings.HasPrefix(trimmedLine, "-") || strings.HasPrefix(trimmedLine, "*") { + // Check if this is actual content (not empty) + content := strings.TrimSpace(trimmedLine[1:]) + if content != "" { + // If this is the first content in a section, add the section header first + if currentSection != "" { + // Only add empty line if this isn't the first section + if len(result) > 0 { + result = append(result, "") + } + result = append(result, currentSection) + currentSection = "" // Reset so we don't add it again + } + result = append(result, line) + hasActualContent = true + } + } else if trimmedLine != "" && !strings.HasPrefix(trimmedLine, " + +## Fixed + + +--- + +### Example Entries: + +**Added:** +- Add support for custom window icons in application options +- Add new SetWindowIcon() method to runtime API (#1234)` + + err := os.WriteFile(unreleasedChangelogFile, []byte(testContent), 0o644) + if err != nil { + t.Fatalf("Failed to create test file: %v", err) + } + + hasContent, err := hasUnreleasedContent() + if err != nil { + t.Fatalf("hasUnreleasedContent() failed: %v", err) + } + + if hasContent { + t.Error("Expected hasUnreleasedContent() to return false when content is only in example section") + } +} + +func TestHasUnreleasedContent_WithMixedContent(t *testing.T) { + cleanup, _ := setupTestEnvironment(t) + defer cleanup() + + // Create a file with both real content and example content + testContent := `# Unreleased Changes + +## Added +- Real feature addition here + +## Fixed + + +--- + +### Example Entries: + +**Added:** +- Add support for custom window icons in application options` + + err := os.WriteFile(unreleasedChangelogFile, []byte(testContent), 0o644) + if err != nil { + t.Fatalf("Failed to create test file: %v", err) + } + + hasContent, err := hasUnreleasedContent() + if err != nil { + t.Fatalf("hasUnreleasedContent() failed: %v", err) + } + + if !hasContent { + t.Error("Expected hasUnreleasedContent() to return true when file has real content") + } +} + +// Integration test for the complete cleanup workflow +func TestCleanupWorkflow_Integration(t *testing.T) { + cleanup, _ := setupTestEnvironment(t) + defer cleanup() + + // Create a changelog file with actual content + testContent := `# Unreleased Changes + +## Added +- Add comprehensive changelog processing system +- Add validation for Keep a Changelog format compliance + +## Fixed +- Fix parsing issues with various markdown bullet styles +- Fix validation edge cases for empty content sections` + + err := os.WriteFile(unreleasedChangelogFile, []byte(testContent), 0o644) + if err != nil { + t.Fatalf("Failed to create test file: %v", err) + } + + // Step 1: Check that file has content + hasContent, err := hasUnreleasedContent() + if err != nil { + t.Fatalf("hasUnreleasedContent() failed: %v", err) + } + if !hasContent { + t.Fatal("Expected file to have content") + } + + // Step 2: Perform safe cleanup operation + err = safeFileOperation(unreleasedChangelogFile, func() error { + return clearUnreleasedChangelog() + }) + if err != nil { + t.Fatalf("Safe cleanup operation failed: %v", err) + } + + // Step 3: Verify file was reset to template + content, err := os.ReadFile(unreleasedChangelogFile) + if err != nil { + t.Fatalf("Failed to read file after cleanup: %v", err) + } + + template := getUnreleasedChangelogTemplate() + if string(content) != template { + t.Error("File was not properly reset to template") + } + + // Step 4: Verify original content is gone + if strings.Contains(string(content), "Add comprehensive changelog processing system") { + t.Error("Original content still present after cleanup") + } + + // Step 5: Verify file no longer has content + hasContentAfter, err := hasUnreleasedContent() + if err != nil { + t.Fatalf("hasUnreleasedContent() failed after cleanup: %v", err) + } + if hasContentAfter { + t.Error("File should not have content after cleanup") + } +} + +func TestFullReleaseWorkflow_OnlyNonEmptySections(t *testing.T) { + cleanup, projectRoot := setupTestEnvironment(t) + defer cleanup() + + // Create subdirectories to match expected structure + err := os.MkdirAll(filepath.Join(projectRoot, "v3", "internal", "version"), 0755) + if err != nil { + t.Fatalf("Failed to create version directory: %v", err) + } + + err = os.MkdirAll(filepath.Join(projectRoot, "docs", "src", "content", "docs"), 0755) + if err != nil { + t.Fatalf("Failed to create docs directory: %v", err) + } + + // Create version file + versionFile := filepath.Join(projectRoot, "v3", "internal", "version", "version.txt") + err = os.WriteFile(versionFile, []byte("v1.0.0-alpha.5"), 0644) + if err != nil { + t.Fatalf("Failed to create version file: %v", err) + } + + // Create initial changelog + changelogFile := filepath.Join(projectRoot, "docs", "src", "content", "docs", "changelog.mdx") + initialChangelog := `--- +title: Changelog +--- + +## [Unreleased] + +## v1.0.0-alpha.4 - 2024-01-01 + +### Added +- Previous feature + +` + err = os.WriteFile(changelogFile, []byte(initialChangelog), 0644) + if err != nil { + t.Fatalf("Failed to create changelog file: %v", err) + } + + // Create UNRELEASED_CHANGELOG.md with mixed content + unreleasedContent := `# Unreleased Changes + +## Added +- New amazing feature +- Another cool addition + +## Changed + + +## Fixed + + +## Deprecated +- Old API method + +## Removed + + +## Security + +` + // The script expects the file at ../../UNRELEASED_CHANGELOG.md relative to release dir + unreleasedFile := filepath.Join(projectRoot, "v3", "UNRELEASED_CHANGELOG.md") + err = os.WriteFile(unreleasedFile, []byte(unreleasedContent), 0644) + if err != nil { + t.Fatalf("Failed to create unreleased changelog: %v", err) + } + + // Run the release process simulation + // Read and process the files manually since we can't override constants + content, err := os.ReadFile(unreleasedFile) + if err != nil { + t.Fatalf("Failed to read unreleased file: %v", err) + } + + // Extract content using the same logic as extractChangelogContent + changelogContent := extractTestContent(string(content)) + if changelogContent == "" { + t.Fatal("Failed to extract any content") + } + + // Verify only non-empty sections were extracted + if !strings.Contains(changelogContent, "## Added") { + t.Error("Expected '## Added' section to be included") + } + if !strings.Contains(changelogContent, "## Deprecated") { + t.Error("Expected '## Deprecated' section to be included") + } + + // Verify empty sections were NOT extracted + emptySections := []string{"## Changed", "## Fixed", "## Removed", "## Security"} + for _, section := range emptySections { + if strings.Contains(changelogContent, section) { + t.Errorf("Expected empty section '%s' to NOT be included", section) + } + } + + // Simulate updating the main changelog + changelogData, _ := os.ReadFile(changelogFile) + changelog := string(changelogData) + changelogSplit := strings.Split(changelog, "## [Unreleased]") + + newVersion := "v1.0.0-alpha.6" + today := "2024-01-15" + newChangelog := changelogSplit[0] + "## [Unreleased]\n\n## " + newVersion + " - " + today + "\n\n" + changelogContent + changelogSplit[1] + + // Verify the final changelog format + if !strings.Contains(newChangelog, "## v1.0.0-alpha.6 - 2024-01-15") { + t.Error("Expected new version header in changelog") + } + + // Count occurrences of section headers in the new version section + newVersionSection := strings.Split(newChangelog, "## v1.0.0-alpha.4")[0] + + addedCount := strings.Count(newVersionSection, "## Added") + if addedCount != 1 { + t.Errorf("Expected exactly 1 '## Added' section, got %d", addedCount) + } + + deprecatedCount := strings.Count(newVersionSection, "## Deprecated") + if deprecatedCount != 1 { + t.Errorf("Expected exactly 1 '## Deprecated' section, got %d", deprecatedCount) + } + + // Ensure no empty sections in the new version section + for _, section := range []string{"## Changed", "## Fixed", "## Removed", "## Security"} { + count := strings.Count(newVersionSection, section) + if count > 0 { + t.Errorf("Expected 0 occurrences of empty section '%s', got %d", section, count) + } + } +} + +// Test error handling during cleanup +func TestCleanupWorkflow_ErrorHandling(t *testing.T) { + cleanup, _ := setupTestEnvironment(t) + defer cleanup() + + // Create a changelog file with content + testContent := `# Unreleased Changes + +## Added +- Test content that should be preserved on error` + + err := os.WriteFile(unreleasedChangelogFile, []byte(testContent), 0o644) + if err != nil { + t.Fatalf("Failed to create test file: %v", err) + } + + // Simulate an error during cleanup by making the operation fail + err = safeFileOperation(unreleasedChangelogFile, func() error { + // First corrupt the file + os.WriteFile(unreleasedChangelogFile, []byte("corrupted"), 0o644) + // Then return an error + return os.ErrPermission + }) + + if err == nil { + t.Error("Expected safeFileOperation to return error") + } + + // Verify original content was restored + content, err := os.ReadFile(unreleasedChangelogFile) + if err != nil { + t.Fatalf("Failed to read file after error: %v", err) + } + + if string(content) != testContent { + t.Error("Original content was not restored after error") + } +} diff --git a/v3/tasks/release/test_create_release_notes.go b/v3/tasks/release/test_create_release_notes.go new file mode 100644 index 000000000..a9ac66d25 --- /dev/null +++ b/v3/tasks/release/test_create_release_notes.go @@ -0,0 +1,172 @@ +// +build ignore + +package main + +import ( + "fmt" + "os" + "os/exec" + "path/filepath" + "strings" +) + +func main() { + fmt.Println("Testing release.go --create-release-notes functionality") + fmt.Println("=" + strings.Repeat("=", 50)) + + // Test cases + testCases := []struct { + name string + content string + expected string + shouldFail bool + }{ + { + name: "Valid changelog with content", + content: `# Unreleased Changes + + + +## Added +- Add Windows dark theme support for menus +- Add new --create-release-notes flag + +## Changed +- Update Go version to 1.23 +- Improve error handling + +## Fixed +- Fix nightly release workflow +- Fix changelog extraction + +--- + +### Example Entries: +Example content here`, + expected: `## Added +- Add Windows dark theme support for menus +- Add new --create-release-notes flag + +## Changed +- Update Go version to 1.23 +- Improve error handling + +## Fixed +- Fix nightly release workflow +- Fix changelog extraction`, + shouldFail: false, + }, + { + name: "Empty changelog", + content: `# Unreleased Changes + +## Added + + +## Changed + + +## Fixed + + +---`, + expected: "", + shouldFail: true, + }, + { + name: "Only one section with content", + content: `# Unreleased Changes + +## Added + + +## Changed +- Single change item here + +## Fixed + + +---`, + expected: `## Changed +- Single change item here`, + shouldFail: false, + }, + } + + // Create a temporary directory for testing + tmpDir, err := os.MkdirTemp("", "release-test-*") + if err != nil { + fmt.Printf("Failed to create temp dir: %v\n", err) + os.Exit(1) + } + defer os.RemoveAll(tmpDir) + + // Save current directory + originalDir, _ := os.Getwd() + + for i, tc := range testCases { + fmt.Printf("\nTest %d: %s\n", i+1, tc.name) + fmt.Println("-" + strings.Repeat("-", 40)) + + // Create test changelog + changelogPath := filepath.Join(tmpDir, "UNRELEASED_CHANGELOG.md") + err = os.WriteFile(changelogPath, []byte(tc.content), 0644) + if err != nil { + fmt.Printf("❌ Failed to write test changelog: %v\n", err) + continue + } + + // Create release notes path + releaseNotesPath := filepath.Join(tmpDir, fmt.Sprintf("release_notes_%d.md", i)) + + // Change to temp dir (so relative paths work) + os.Chdir(tmpDir) + + // Run the command + cmd := exec.Command("go", "run", filepath.Join(originalDir, "release.go"), "--create-release-notes", releaseNotesPath) + output, err := cmd.CombinedOutput() + + // Change back + os.Chdir(originalDir) + + if tc.shouldFail { + if err == nil { + fmt.Printf("❌ Expected failure but command succeeded\n") + fmt.Printf("Output: %s\n", output) + } else { + fmt.Printf("✅ Failed as expected: %v\n", err) + } + } else { + if err != nil { + fmt.Printf("❌ Command failed: %v\n", err) + fmt.Printf("Output: %s\n", output) + } else { + fmt.Printf("✅ Command succeeded\n") + + // Read and verify the output + content, err := os.ReadFile(releaseNotesPath) + if err != nil { + fmt.Printf("❌ Failed to read release notes: %v\n", err) + } else { + actualContent := strings.TrimSpace(string(content)) + expectedContent := strings.TrimSpace(tc.expected) + + if actualContent == expectedContent { + fmt.Printf("✅ Content matches expected\n") + } else { + fmt.Printf("❌ Content mismatch\n") + fmt.Printf("Expected:\n%s\n", expectedContent) + fmt.Printf("Actual:\n%s\n", actualContent) + } + } + } + } + + // Clean up + os.Remove(changelogPath) + os.Remove(releaseNotesPath) + } + + fmt.Println("\n" + "=" + strings.Repeat("=", 50)) + fmt.Println("Testing complete!") +} \ No newline at end of file diff --git a/v3/tasks/release/test_edge_cases.bat b/v3/tasks/release/test_edge_cases.bat new file mode 100644 index 000000000..390a972ab --- /dev/null +++ b/v3/tasks/release/test_edge_cases.bat @@ -0,0 +1,111 @@ +@echo off +echo Testing edge cases for release.go +echo ================================= + +set ORIGINAL_DIR=%CD% +cd ..\.. + +REM Backup existing file +if exist UNRELEASED_CHANGELOG.md ( + copy UNRELEASED_CHANGELOG.md UNRELEASED_CHANGELOG.md.backup > nul +) + +echo. +echo Test 1: Empty changelog (should fail) +echo ------------------------------------- + +REM Create empty changelog +echo # Unreleased Changes > UNRELEASED_CHANGELOG.md +echo. >> UNRELEASED_CHANGELOG.md +echo ## Added >> UNRELEASED_CHANGELOG.md +echo ^<^!-- New features --^> >> UNRELEASED_CHANGELOG.md +echo. >> UNRELEASED_CHANGELOG.md +echo ## Changed >> UNRELEASED_CHANGELOG.md +echo ^<^!-- Changes --^> >> UNRELEASED_CHANGELOG.md +echo. >> UNRELEASED_CHANGELOG.md +echo ## Fixed >> UNRELEASED_CHANGELOG.md +echo ^<^!-- Bug fixes --^> >> UNRELEASED_CHANGELOG.md +echo. >> UNRELEASED_CHANGELOG.md +echo --- >> UNRELEASED_CHANGELOG.md + +cd tasks\release +go run release.go --create-release-notes 2>&1 +if %ERRORLEVEL% NEQ 0 ( + echo SUCCESS: Command failed as expected for empty changelog +) else ( + echo FAIL: Command should have failed for empty changelog +) + +echo. +echo Test 2: Only comments (should fail) +echo ----------------------------------- + +cd ..\.. +echo # Unreleased Changes > UNRELEASED_CHANGELOG.md +echo. >> UNRELEASED_CHANGELOG.md +echo ## Added >> UNRELEASED_CHANGELOG.md +echo ^<^!-- This is just a comment --^> >> UNRELEASED_CHANGELOG.md +echo ^<^!-- Another comment --^> >> UNRELEASED_CHANGELOG.md +echo. >> UNRELEASED_CHANGELOG.md +echo --- >> UNRELEASED_CHANGELOG.md + +cd tasks\release +go run release.go --create-release-notes 2>&1 +if %ERRORLEVEL% NEQ 0 ( + echo SUCCESS: Command failed as expected for comment-only changelog +) else ( + echo FAIL: Command should have failed for comment-only changelog +) + +echo. +echo Test 3: Mixed bullet styles +echo --------------------------- + +cd ..\.. +echo # Unreleased Changes > UNRELEASED_CHANGELOG.md +echo. >> UNRELEASED_CHANGELOG.md +echo ## Added >> UNRELEASED_CHANGELOG.md +echo - Dash bullet point >> UNRELEASED_CHANGELOG.md +echo * Asterisk bullet point >> UNRELEASED_CHANGELOG.md +echo - Another dash >> UNRELEASED_CHANGELOG.md +echo. >> UNRELEASED_CHANGELOG.md +echo --- >> UNRELEASED_CHANGELOG.md + +cd tasks\release +go run release.go --create-release-notes +if %ERRORLEVEL% EQU 0 ( + echo SUCCESS: Mixed bullet styles handled + echo Content: + type ..\..\release_notes.md +) else ( + echo FAIL: Mixed bullet styles should work +) + +echo. +echo Test 4: Custom output path +echo -------------------------- + +go run release.go --create-release-notes ..\..\custom_notes.md +if %ERRORLEVEL% EQU 0 ( + if exist "..\..\custom_notes.md" ( + echo SUCCESS: Custom path works + del ..\..\custom_notes.md + ) else ( + echo FAIL: Custom path file not created + ) +) else ( + echo FAIL: Custom path should work +) + +REM Clean up +cd ..\.. +if exist release_notes.md del release_notes.md +if exist UNRELEASED_CHANGELOG.md.backup ( + move /Y UNRELEASED_CHANGELOG.md.backup UNRELEASED_CHANGELOG.md > nul +) + +cd %ORIGINAL_DIR% + +echo. +echo ================================= +echo Edge case testing complete! \ No newline at end of file diff --git a/v3/tasks/release/test_simple.bat b/v3/tasks/release/test_simple.bat new file mode 100644 index 000000000..149655c0f --- /dev/null +++ b/v3/tasks/release/test_simple.bat @@ -0,0 +1,115 @@ +@echo off +echo Testing release.go --create-release-notes functionality +echo ====================================================== + +REM Save current directory +set ORIGINAL_DIR=%CD% + +REM Go to v3 root (where UNRELEASED_CHANGELOG.md should be) +cd ..\.. + +REM Backup existing UNRELEASED_CHANGELOG.md if it exists +if exist UNRELEASED_CHANGELOG.md ( + copy UNRELEASED_CHANGELOG.md UNRELEASED_CHANGELOG.md.backup > nul +) + +REM Create a test UNRELEASED_CHANGELOG.md +echo # Unreleased Changes > UNRELEASED_CHANGELOG.md +echo. >> UNRELEASED_CHANGELOG.md +echo ^<^!-- >> UNRELEASED_CHANGELOG.md +echo This file is used to collect changelog entries for the next v3-alpha release. >> UNRELEASED_CHANGELOG.md +echo --^> >> UNRELEASED_CHANGELOG.md +echo. >> UNRELEASED_CHANGELOG.md +echo ## Added >> UNRELEASED_CHANGELOG.md +echo ^<^!-- New features, capabilities, or enhancements --^> >> UNRELEASED_CHANGELOG.md +echo - Add Windows dark theme support for menus and menubar >> UNRELEASED_CHANGELOG.md +echo - Add `--create-release-notes` flag to release script >> UNRELEASED_CHANGELOG.md +echo. >> UNRELEASED_CHANGELOG.md +echo ## Changed >> UNRELEASED_CHANGELOG.md +echo ^<^!-- Changes in existing functionality --^> >> UNRELEASED_CHANGELOG.md +echo - Update Go version to 1.23 in workflow >> UNRELEASED_CHANGELOG.md +echo - Improve error handling in release process >> UNRELEASED_CHANGELOG.md +echo. >> UNRELEASED_CHANGELOG.md +echo ## Fixed >> UNRELEASED_CHANGELOG.md +echo ^<^!-- Bug fixes --^> >> UNRELEASED_CHANGELOG.md +echo - Fix nightly release workflow changelog extraction >> UNRELEASED_CHANGELOG.md +echo - Fix Go cache configuration in GitHub Actions >> UNRELEASED_CHANGELOG.md +echo. >> UNRELEASED_CHANGELOG.md +echo ## Deprecated >> UNRELEASED_CHANGELOG.md +echo ^<^!-- Soon-to-be removed features --^> >> UNRELEASED_CHANGELOG.md +echo. >> UNRELEASED_CHANGELOG.md +echo ## Removed >> UNRELEASED_CHANGELOG.md +echo ^<^!-- Features removed in this release --^> >> UNRELEASED_CHANGELOG.md +echo. >> UNRELEASED_CHANGELOG.md +echo ## Security >> UNRELEASED_CHANGELOG.md +echo ^<^!-- Security-related changes --^> >> UNRELEASED_CHANGELOG.md +echo. >> UNRELEASED_CHANGELOG.md +echo --- >> UNRELEASED_CHANGELOG.md +echo. >> UNRELEASED_CHANGELOG.md +echo ### Example Entries: >> UNRELEASED_CHANGELOG.md + +echo. +echo Test 1: Running with valid content +echo ----------------------------------- + +REM Run the release script +cd tasks\release +go run release.go --create-release-notes + +if %ERRORLEVEL% EQU 0 ( + echo SUCCESS: Command succeeded + + REM Check if release_notes.md was created + if exist "..\..\release_notes.md" ( + echo SUCCESS: release_notes.md was created + echo. + echo Content: + echo -------- + type ..\..\release_notes.md + echo. + echo -------- + ) else ( + echo FAIL: release_notes.md was NOT created + ) +) else ( + echo FAIL: Command failed +) + +echo. +echo Test 2: Check --check-only flag +echo -------------------------------- + +REM Test the check-only flag +go run release.go --check-only +if %ERRORLEVEL% EQU 0 ( + echo SUCCESS: --check-only detected content +) else ( + echo FAIL: --check-only did not detect content +) + +echo. +echo Test 3: Check --extract-changelog flag +echo -------------------------------------- + +REM Test the extract-changelog flag +go run release.go --extract-changelog +if %ERRORLEVEL% EQU 0 ( + echo SUCCESS: --extract-changelog succeeded +) else ( + echo FAIL: --extract-changelog failed +) + +REM Clean up +cd ..\.. +if exist release_notes.md del release_notes.md + +REM Restore original UNRELEASED_CHANGELOG.md if it exists +if exist UNRELEASED_CHANGELOG.md.backup ( + move /Y UNRELEASED_CHANGELOG.md.backup UNRELEASED_CHANGELOG.md > nul +) + +cd %ORIGINAL_DIR% + +echo. +echo ====================================================== +echo Testing complete! \ No newline at end of file diff --git a/v3/tasks/release/test_simple.sh b/v3/tasks/release/test_simple.sh new file mode 100644 index 000000000..a04446367 --- /dev/null +++ b/v3/tasks/release/test_simple.sh @@ -0,0 +1,118 @@ +#!/bin/bash + +echo "Testing release.go --create-release-notes functionality" +echo "======================================================" + +# Save current directory +ORIGINAL_DIR=$(pwd) + +# Go to v3 root (where UNRELEASED_CHANGELOG.md should be) +cd ../.. + +# Create a test UNRELEASED_CHANGELOG.md +cat > UNRELEASED_CHANGELOG.md << 'EOF' +# Unreleased Changes + + + +## Added + +- Add Windows dark theme support for menus and menubar +- Add `--create-release-notes` flag to release script + +## Changed + +- Update Go version to 1.23 in workflow +- Improve error handling in release process + +## Fixed + +- Fix nightly release workflow changelog extraction +- Fix Go cache configuration in GitHub Actions + +## Deprecated + + +## Removed + + +## Security + + +--- + +### Example Entries: + +**Added:** +- Example content +EOF + +echo "" +echo "Test 1: Running with valid content" +echo "-----------------------------------" + +# Run the release script +cd tasks/release +if go run release.go --create-release-notes; then + echo "✅ Command succeeded" + + # Check if release_notes.md was created + if [ -f "../../release_notes.md" ]; then + echo "✅ release_notes.md was created" + echo "" + echo "Content:" + echo "--------" + cat ../../release_notes.md + echo "" + echo "--------" + else + echo "❌ release_notes.md was NOT created" + fi +else + echo "❌ Command failed" +fi + +echo "" +echo "Test 2: Check --check-only flag" +echo "--------------------------------" + +# Test the check-only flag +if go run release.go --check-only; then + echo "✅ --check-only detected content" +else + echo "❌ --check-only did not detect content" +fi + +echo "" +echo "Test 3: Check --extract-changelog flag" +echo "--------------------------------------" + +# Test the extract-changelog flag +OUTPUT=$(go run release.go --extract-changelog 2>&1) +if [ $? -eq 0 ]; then + echo "✅ --extract-changelog succeeded" + echo "Output:" + echo "-------" + echo "$OUTPUT" + echo "-------" +else + echo "❌ --extract-changelog failed" + echo "Error: $OUTPUT" +fi + +# Clean up +cd ../.. +rm -f release_notes.md + +# Restore original UNRELEASED_CHANGELOG.md if it exists +if [ -f "UNRELEASED_CHANGELOG.md.backup" ]; then + mv UNRELEASED_CHANGELOG.md.backup UNRELEASED_CHANGELOG.md +fi + +cd "$ORIGINAL_DIR" + +echo "" +echo "======================================================" +echo "Testing complete!" \ No newline at end of file diff --git a/v3/tasks/sed/sed.go b/v3/tasks/sed/sed.go new file mode 100644 index 000000000..12e55f8d3 --- /dev/null +++ b/v3/tasks/sed/sed.go @@ -0,0 +1,68 @@ +package main + +import ( + "fmt" + "os" + "path/filepath" + "strings" + + "github.com/leaanthony/clir" + + "github.com/samber/lo" +) + +func main() { + app := clir.NewCli("sed", "A simple sed replacement", "v1") + app.NewSubCommandFunction("replace", "Replace a string in files", ReplaceInFiles) + err := app.Run() + if err != nil { + println(err.Error()) + os.Exit(1) + } +} + +type ReplaceInFilesOptions struct { + Dir string `name:"dir" help:"Directory to search in"` + OldString string `name:"old" description:"The string to replace"` + NewString string `name:"new" description:"The string to replace with"` + Extensions string `name:"ext" description:"The file extensions to process"` + Ignore string `name:"ignore" description:"The files to ignore"` +} + +func ReplaceInFiles(options *ReplaceInFilesOptions) error { + extensions := strings.Split(options.Extensions, ",") + ignore := strings.Split(options.Ignore, ",") + err := filepath.Walk(options.Dir, func(path string, info os.FileInfo, err error) error { + if info.IsDir() { + return nil + } + + ext := filepath.Ext(path) + if !lo.Contains(extensions, ext) { + println("Skipping", path) + return nil + } + filename := filepath.Base(path) + if lo.Contains(ignore, filename) { + println("Ignoring:", path) + return nil + } + + println("Processing file:", path) + + content, err := os.ReadFile(path) + if err != nil { + return err + } + + newContent := strings.Replace(string(content), options.OldString, options.NewString, -1) + + return os.WriteFile(path, []byte(newContent), info.Mode()) + }) + + if err != nil { + return fmt.Errorf("Error while replacing in files: %v", err) + } + + return nil +} diff --git a/v3/test-assets/index.html b/v3/test-assets/index.html new file mode 100644 index 000000000..3f5840023 --- /dev/null +++ b/v3/test-assets/index.html @@ -0,0 +1,42 @@ + + + + + + iOS Build Test + + + +

                    iOS Build Test

                    +
                    +

                    Build Status

                    +

                    ✅ iOS build system compiled successfully!

                    +

                    This demonstrates:

                    +
                      +
                    • ✅ iOS build tags working
                    • +
                    • ✅ Asset embedding functional
                    • +
                    • ✅ Application structure correct
                    • +
                    • ✅ Service binding ready
                    • +
                    +
                    + + \ No newline at end of file diff --git a/v3/test-ios-compilation.go b/v3/test-ios-compilation.go new file mode 100644 index 000000000..efcb7785e --- /dev/null +++ b/v3/test-ios-compilation.go @@ -0,0 +1,39 @@ +//go:build ios + +package main + +import ( + "embed" + "fmt" + "log" + + "github.com/wailsapp/wails/v3/pkg/application" +) + +//go:embed test-assets/* +var assets embed.FS + +type TestApp struct{} + +func (a *TestApp) Greet(name string) string { + return fmt.Sprintf("Hello %s from iOS build test!", name) +} + +func main() { + app := application.New(application.Options{ + Name: "iOS Build Test", + Description: "Testing iOS build system", + Assets: application.AssetOptions{ + FS: assets, + }, + Services: []application.Service{ + application.NewService(&TestApp{}), + }, + LogLevel: application.LogLevelDebug, + }) + + err := app.Run() + if err != nil { + log.Fatal(err) + } +} \ No newline at end of file diff --git a/v3/test-new-ios-build.sh b/v3/test-new-ios-build.sh new file mode 100644 index 000000000..e1d1e54d0 --- /dev/null +++ b/v3/test-new-ios-build.sh @@ -0,0 +1,132 @@ +#!/bin/bash +set -e + +echo "=== Testing New iOS Build Assets ===" +echo + +# Create a test project structure manually +TEST_DIR="test-ios-project" +rm -rf "$TEST_DIR" +mkdir -p "$TEST_DIR" + +echo "Creating project structure..." +mkdir -p "$TEST_DIR/build/ios" +mkdir -p "$TEST_DIR/bin" +mkdir -p "$TEST_DIR/frontend" + +# Copy iOS build assets +echo "Copying iOS build assets..." +cp internal/commands/build_assets/ios/Taskfile.yml "$TEST_DIR/build/ios/" +cp internal/commands/build_assets/ios/main.m "$TEST_DIR/build/ios/" + +# Create Info.plist from template (simplified) +cat > "$TEST_DIR/build/ios/Info.plist" << 'EOF' + + + + + CFBundleExecutable + TestIOSApp + CFBundleIdentifier + com.wails.testiosapp + CFBundleName + TestIOSApp + CFBundlePackageType + APPL + CFBundleShortVersionString + 1.0 + LSRequiresIPhoneOS + + MinimumOSVersion + 15.0 + + +EOF + +# Create Info.dev.plist +cat > "$TEST_DIR/build/ios/Info.dev.plist" << 'EOF' + + + + + CFBundleExecutable + TestIOSApp + CFBundleIdentifier + com.wails.testiosapp.dev + CFBundleName + TestIOSApp (Dev) + CFBundlePackageType + APPL + CFBundleShortVersionString + 1.0-dev + LSRequiresIPhoneOS + + MinimumOSVersion + 15.0 + + +EOF + +# Create a minimal main.go +cat > "$TEST_DIR/main.go" << 'EOF' +package main + +import "fmt" + +func main() { + fmt.Println("Wails iOS Test App") +} +EOF + +# Create a simple Taskfile that includes iOS +cat > "$TEST_DIR/Taskfile.yml" << 'EOF' +version: '3' + +includes: + ios: ./build/ios/Taskfile.yml + +vars: + APP_NAME: "TestIOSApp" + BIN_DIR: "bin" + BUNDLE_ID: "com.wails.testiosapp" + +tasks: + test: + cmds: + - echo "Test task" +EOF + +echo +echo "Project structure created in $TEST_DIR/" +echo +echo "Files created:" +ls -la "$TEST_DIR/build/ios/" +echo +echo "Now let's test compilation of main.m:" + +# Test if we can compile the Objective-C file +cd "$TEST_DIR" +echo "Attempting to compile main.m..." +xcrun -sdk iphonesimulator clang \ + -target arm64-apple-ios15.0-simulator \ + -isysroot $(xcrun --sdk iphonesimulator --show-sdk-path) \ + -framework Foundation \ + -framework UIKit \ + -framework WebKit \ + -c build/ios/main.m \ + -o build/ios/main.o 2>&1 && echo "✅ main.m compiled successfully!" || echo "❌ Compilation failed" + +echo +echo "Checking if main.o was created:" +ls -la build/ios/*.o 2>/dev/null || echo "No object file created" + +echo +echo "=== Test Complete ===" +echo +echo "Summary:" +echo "- iOS build assets properly structured ✅" +echo "- Taskfile.yml includes iOS tasks ✅" +echo "- main.m WebView implementation ready ✅" +echo "- Info.plist templates created ✅" +echo +echo "The iOS build system is ready for integration!" \ No newline at end of file diff --git a/v3/test/4769-menu/Taskfile.yml b/v3/test/4769-menu/Taskfile.yml new file mode 100644 index 000000000..e32f90e51 --- /dev/null +++ b/v3/test/4769-menu/Taskfile.yml @@ -0,0 +1,22 @@ +version: '3' + +vars: + APP_NAME: "4769-menu{{exeExt}}" + +tasks: + build: + summary: Builds the test application + cmds: + - go build -o bin/{{.APP_NAME}} . + + run: + summary: Runs the test application + deps: + - build + cmds: + - ./bin/{{.APP_NAME}} + + dev: + summary: Builds and runs the test application + cmds: + - go run . diff --git a/v3/test/4769-menu/assets/index.html b/v3/test/4769-menu/assets/index.html new file mode 100644 index 000000000..d09369614 --- /dev/null +++ b/v3/test/4769-menu/assets/index.html @@ -0,0 +1,59 @@ + + + + + + Menu Wayland Test (#4769) + + + +
                    +

                    Menu Wayland Test

                    +

                    GitHub Issue: #4769

                    +

                    This tests the window menu on Wayland.

                    +

                    If you can see this window with the menu bar above, the fix works!

                    +

                    + Try clicking the menu items (File, Edit, Help) to verify they work. +

                    +
                    + + diff --git a/v3/test/4769-menu/main.go b/v3/test/4769-menu/main.go new file mode 100644 index 000000000..59a196ebe --- /dev/null +++ b/v3/test/4769-menu/main.go @@ -0,0 +1,70 @@ +package main + +import ( + "embed" + _ "embed" + "log" + + "github.com/wailsapp/wails/v3/pkg/application" +) + +//go:embed assets/* +var assets embed.FS + +func main() { + app := application.New(application.Options{ + Name: "Menu Wayland Test (#4769)", + Description: "Test for window menu crash on Wayland", + Assets: application.AssetOptions{ + Handler: application.BundledAssetFileServer(assets), + }, + }) + + // Create a menu - this would crash on Wayland before the fix + menu := app.NewMenu() + + fileMenu := menu.AddSubmenu("File") + fileMenu.Add("New").OnClick(func(ctx *application.Context) { + log.Println("New clicked") + }) + fileMenu.Add("Open").OnClick(func(ctx *application.Context) { + log.Println("Open clicked") + }) + fileMenu.AddSeparator() + fileMenu.Add("Exit").OnClick(func(ctx *application.Context) { + app.Quit() + }) + + editMenu := menu.AddSubmenu("Edit") + editMenu.Add("Cut").OnClick(func(ctx *application.Context) { + log.Println("Cut clicked") + }) + editMenu.Add("Copy").OnClick(func(ctx *application.Context) { + log.Println("Copy clicked") + }) + editMenu.Add("Paste").OnClick(func(ctx *application.Context) { + log.Println("Paste clicked") + }) + + helpMenu := menu.AddSubmenu("Help") + helpMenu.Add("About").OnClick(func(ctx *application.Context) { + log.Println("About clicked") + }) + + // Create window with menu attached via Linux options + // This tests the fix for issue #4769 + app.Window.NewWithOptions(application.WebviewWindowOptions{ + Title: "Menu Wayland Test (#4769)", + Width: 800, + Height: 600, + Linux: application.LinuxWindow{ + Menu: menu, + }, + }) + + log.Println("Starting application - if you see this on Wayland, the fix works!") + err := app.Run() + if err != nil { + log.Fatal(err) + } +} diff --git a/v3/test/dnd-npm-runtime/README.md b/v3/test/dnd-npm-runtime/README.md new file mode 100644 index 000000000..f9c62ff2f --- /dev/null +++ b/v3/test/dnd-npm-runtime/README.md @@ -0,0 +1,49 @@ +# DND NPM Runtime Test + +This test verifies that drag-and-drop functionality works correctly when using the `@wailsio/runtime` npm module instead of the bundled `/wails/runtime.js`. + +## Background + +There was a bug where the Go backend called `window.wails.Window.HandlePlatformFileDrop()` for native file drops (macOS/Linux), but the npm module only registers the handler at `window._wails.handlePlatformFileDrop`. + +The bundled runtime sets `window.wails = Runtime`, so the call worked. But with the npm module, `window.wails` is an empty object. + +## The Fix + +Changed `v3/pkg/application/webview_window.go` to call the internal path that both runtimes set up: + +```go +// Before (only worked with bundled runtime): +"window.wails.Window.HandlePlatformFileDrop(%s, %d, %d);" + +// After (works with both): +"window._wails.handlePlatformFileDrop(%s, %d, %d);" +``` + +## Running the Test + +The frontend is pre-built, so you can run directly: + +```bash +go run . +``` + +Then drag files from Finder/Explorer onto the drop zone. Files should be categorized and displayed. + +### Rebuilding the Frontend (optional) + +Only needed if you modify the frontend code: + +```bash +cd frontend +npm install +npm run build +``` + +## What This Tests + +1. `@wailsio/runtime` npm module initialization +2. Event system (`Events.On('files-dropped', ...)`) +3. Native file drop handling on macOS/Linux via `window._wails.handlePlatformFileDrop` +4. Drop target detection with `data-file-drop-target` attribute +5. Visual feedback with `.file-drop-target-active` class diff --git a/v3/test/dnd-npm-runtime/frontend/dist/assets/index-sgSTKtcv.js b/v3/test/dnd-npm-runtime/frontend/dist/assets/index-sgSTKtcv.js new file mode 100644 index 000000000..822301da7 --- /dev/null +++ b/v3/test/dnd-npm-runtime/frontend/dist/assets/index-sgSTKtcv.js @@ -0,0 +1,6 @@ +(function(){const e=document.createElement("link").relList;if(e&&e.supports&&e.supports("modulepreload"))return;for(const i of document.querySelectorAll('link[rel="modulepreload"]'))o(i);new MutationObserver(i=>{for(const r of i)if(r.type==="childList")for(const a of r.addedNodes)a.tagName==="LINK"&&a.rel==="modulepreload"&&o(a)}).observe(document,{childList:!0,subtree:!0});function n(i){const r={};return i.integrity&&(r.integrity=i.integrity),i.referrerPolicy&&(r.referrerPolicy=i.referrerPolicy),i.crossOrigin==="use-credentials"?r.credentials="include":i.crossOrigin==="anonymous"?r.credentials="omit":r.credentials="same-origin",r}function o(i){if(i.ep)return;i.ep=!0;const r=n(i);fetch(i.href,r)}})();const V="useandom-26T198340PX75pxJACKVERYMINDBUSHWOLF_GQZbfghjklqvwyzrict";function $(t=21){let e="",n=t|0;for(;n--;)e+=V[Math.random()*64|0];return e}const q=window.location.origin+"/wails/runtime",x=Object.freeze({Call:0,Clipboard:1,Application:2,Events:3,ContextMenu:4,Dialog:5,Window:6,Screens:7,System:8,Browser:9,CancelCall:10,IOS:11});let U=$();function D(t,e=""){return function(n,o=null){return J(t,n,e,o)}}async function J(t,e,n,o){var i,r;let a=new URL(q),l={object:t,method:e};o!=null&&(l.args=o);let c={"x-wails-client-id":U,"Content-Type":"application/json"};n&&(c["x-wails-window-name"]=n);let f=await fetch(a,{method:"POST",headers:c,body:JSON.stringify(l)});if(!f.ok)throw new Error(await f.text());return((r=(i=f.headers.get("Content-Type"))===null||i===void 0?void 0:i.indexOf("application/json"))!==null&&r!==void 0?r:-1)!==-1?f.json():f.text()}D(x.System);const z=function(){var t,e,n,o,i,r;try{if(!((e=(t=window.chrome)===null||t===void 0?void 0:t.webview)===null||e===void 0)&&e.postMessage)return window.chrome.webview.postMessage.bind(window.chrome.webview);if(!((i=(o=(n=window.webkit)===null||n===void 0?void 0:n.messageHandlers)===null||o===void 0?void 0:o.external)===null||i===void 0)&&i.postMessage)return window.webkit.messageHandlers.external.postMessage.bind(window.webkit.messageHandlers.external);if(!((r=window.wails)===null||r===void 0)&&r.invoke)return a=>window.wails.invoke(typeof a=="string"?a:JSON.stringify(a))}catch{}return console.warn(` +%c⚠️ Browser Environment Detected %c + +%cOnly UI previews are available in the browser. For full functionality, please run the application in desktop mode. +More information at: https://v3.wails.io/learn/build/#using-a-browser-for-development +`,"background: #ffffff; color: #000000; font-weight: bold; padding: 4px 8px; border-radius: 4px; border: 2px solid #000000;","background: transparent;","color: #ffffff; font-style: italic; font-weight: bold;"),null}();function _(t){z==null||z(t)}function Z(){var t,e;return((e=(t=window._wails)===null||t===void 0?void 0:t.environment)===null||e===void 0?void 0:e.OS)==="windows"}function K(){var t,e;return!!(!((e=(t=window._wails)===null||t===void 0?void 0:t.environment)===null||e===void 0)&&e.Debug)}function Q(){return new MouseEvent("mousedown").buttons===0}function X(t){var e;return t.target instanceof HTMLElement?t.target:!(t.target instanceof HTMLElement)&&t.target instanceof Node&&(e=t.target.parentElement)!==null&&e!==void 0?e:document.body}document.addEventListener("DOMContentLoaded",()=>{});window.addEventListener("contextmenu",oe);const ee=D(x.ContextMenu),te=0;function ne(t,e,n,o){ee(te,{id:t,x:e,y:n,data:o})}function oe(t){const e=X(t),n=window.getComputedStyle(e).getPropertyValue("--custom-contextmenu").trim();if(n){t.preventDefault();const o=window.getComputedStyle(e).getPropertyValue("--custom-contextmenu-data");ne(n,t.clientX,t.clientY,o)}else ie(t,e)}function ie(t,e){if(K())return;switch(window.getComputedStyle(e).getPropertyValue("--default-contextmenu").trim()){case"show":return;case"hide":t.preventDefault();return}if(e.isContentEditable)return;const n=window.getSelection(),o=n&&n.toString().length>0;if(o)for(let i=0;i{R=t,R||(b=M=!1,u())};let k=!1;function se(){var t,e;const n=(e=(t=window._wails)===null||t===void 0?void 0:t.environment)===null||e===void 0?void 0:e.OS;if(n==="ios"||n==="android")return!0;const o=navigator.userAgent||navigator.vendor||window.opera||"";return/android|iphone|ipad|ipod|iemobile|wpdesktop/i.test(o)}function H(){if(!k&&!se()){window.addEventListener("mousedown",P,{capture:!0}),window.addEventListener("mousemove",P,{capture:!0}),window.addEventListener("mouseup",P,{capture:!0});for(const t of["click","contextmenu","dblclick"])window.addEventListener(t,le,{capture:!0});k=!0}}H();document.addEventListener("DOMContentLoaded",H,{once:!0});let re=0;const W=window.setInterval(()=>{if(k){window.clearInterval(W);return}H(),++re>100&&window.clearInterval(W)},50);function le(t){(E||M)&&(t.stopImmediatePropagation(),t.stopPropagation(),t.preventDefault())}const L=0,ae=1,O=2;function P(t){let e,n=t.buttons;switch(t.type){case"mousedown":e=L,C||(n=v|1<n!==t),e.length===0?h.delete(t.eventName):h.set(t.eventName,e))}window._wails=window._wails||{};window._wails.dispatchWailsEvent=pe;D(x.Events);class me{constructor(e,n){this.name=e,this.data=n??null}}function pe(t){let e=h.get(t.name);if(!e)return;let n=new me(t.name,t.name in j?j[t.name](t.data):t.data);"sender"in t&&(n.sender=t.sender),e=e.filter(o=>!o.dispatch(n)),e.length===0?h.delete(t.name):h.set(t.name,e)}function ge(t,e,n){let o=h.get(t)||[];const i=new we(t,e,n);return o.push(i),h.set(t,o),()=>he(i)}function ve(t,e){return ge(t,e,-1)}const be="data-file-drop-target",w="file-drop-target-active";let d=null;const Me=0,ye=1,Ee=2,_e=3,Se=4,Te=5,xe=6,De=7,ze=8,Fe=9,Ce=10,Le=11,Oe=12,Pe=13,Ie=14,Re=15,ke=16,He=17,Ae=18,Be=19,We=20,je=21,Ne=22,Ue=23,Ze=24,Xe=25,Ye=26,Ge=27,Ve=28,$e=29,qe=30,Je=31,Ke=32,Qe=33,et=34,tt=35,nt=36,ot=37,it=38,st=39,rt=40,lt=41,at=42,dt=43,ct=44,ut=45,ft=46,wt=47,ht=48,mt=49,pt=50,gt=51;function S(t){return t?t.closest(`[${be}]`):null}function vt(){var t,e,n,o;return((e=(t=window.chrome)===null||t===void 0?void 0:t.webview)===null||e===void 0?void 0:e.postMessageWithAdditionalObjects)==null?!1:((o=(n=window._wails)===null||n===void 0?void 0:n.flags)===null||o===void 0?void 0:o.enableFileDrop)===!0}function bt(t,e,n){var o,i;!((i=(o=window.chrome)===null||o===void 0?void 0:o.webview)===null||i===void 0)&&i.postMessageWithAdditionalObjects&&window.chrome.webview.postMessageWithAdditionalObjects(`file:drop:${t}:${e}`,n)}let A=!1;function Y(){A=!1,d&&(d.classList.remove(w),d=null)}function Mt(){var t,e;((e=(t=window._wails)===null||t===void 0?void 0:t.flags)===null||e===void 0?void 0:e.enableFileDrop)!==!1&&(A=!0)}function yt(){Y()}function Et(t,e){var n,o;if(!A||((o=(n=window._wails)===null||n===void 0?void 0:n.flags)===null||o===void 0?void 0:o.enableFileDrop)===!1)return;const i=document.elementFromPoint(t,e),r=S(i);d&&d!==r&&d.classList.remove(w),r?(r.classList.add(w),d=r):d=null}const s=Symbol("caller");class T{constructor(e=""){this[s]=D(x.Window,e);for(const n of Object.getOwnPropertyNames(T.prototype))n!=="constructor"&&typeof this[n]=="function"&&(this[n]=this[n].bind(this))}Get(e){return new T(e)}Position(){return this[s](Me)}Center(){return this[s](ye)}Close(){return this[s](Ee)}DisableSizeConstraints(){return this[s](_e)}EnableSizeConstraints(){return this[s](Se)}Focus(){return this[s](Te)}ForceReload(){return this[s](xe)}Fullscreen(){return this[s](De)}GetScreen(){return this[s](ze)}GetZoom(){return this[s](Fe)}Height(){return this[s](Ce)}Hide(){return this[s](Le)}IsFocused(){return this[s](Oe)}IsFullscreen(){return this[s](Pe)}IsMaximised(){return this[s](Ie)}IsMinimised(){return this[s](Re)}Maximise(){return this[s](ke)}Minimise(){return this[s](He)}Name(){return this[s](Ae)}OpenDevTools(){return this[s](Be)}RelativePosition(){return this[s](We)}Reload(){return this[s](je)}Resizable(){return this[s](Ne)}Restore(){return this[s](Ue)}SetPosition(e,n){return this[s](Ze,{x:e,y:n})}SetAlwaysOnTop(e){return this[s](Xe,{alwaysOnTop:e})}SetBackgroundColour(e,n,o,i){return this[s](Ye,{r:e,g:n,b:o,a:i})}SetFrameless(e){return this[s](Ge,{frameless:e})}SetFullscreenButtonEnabled(e){return this[s](Ve,{enabled:e})}SetMaxSize(e,n){return this[s]($e,{width:e,height:n})}SetMinSize(e,n){return this[s](qe,{width:e,height:n})}SetRelativePosition(e,n){return this[s](Je,{x:e,y:n})}SetResizable(e){return this[s](Ke,{resizable:e})}SetSize(e,n){return this[s](Qe,{width:e,height:n})}SetTitle(e){return this[s](et,{title:e})}SetZoom(e){return this[s](tt,{zoom:e})}Show(){return this[s](nt)}Size(){return this[s](ot)}ToggleFullscreen(){return this[s](it)}ToggleMaximise(){return this[s](st)}ToggleFrameless(){return this[s](rt)}UnFullscreen(){return this[s](lt)}UnMaximise(){return this[s](at)}UnMinimise(){return this[s](dt)}Width(){return this[s](ct)}Zoom(){return this[s](ut)}ZoomIn(){return this[s](ft)}ZoomOut(){return this[s](wt)}ZoomReset(){return this[s](ht)}HandlePlatformFileDrop(e,n,o){var i,r;if(((r=(i=window._wails)===null||i===void 0?void 0:i.flags)===null||r===void 0?void 0:r.enableFileDrop)===!1)return;const a=document.elementFromPoint(n,o),l=S(a);if(!l)return;const c={id:l.id,classList:Array.from(l.classList),attributes:{}};for(let m=0;m{var o,i,r;if(!(!((o=n.dataTransfer)===null||o===void 0)&&o.types.includes("Files")))return;if(n.preventDefault(),((r=(i=window._wails)===null||i===void 0?void 0:i.flags)===null||r===void 0?void 0:r.enableFileDrop)===!1){n.dataTransfer.dropEffect="none";return}e++;const a=document.elementFromPoint(n.clientX,n.clientY),l=S(a);d&&d!==l&&d.classList.remove(w),l?(l.classList.add(w),n.dataTransfer.dropEffect="copy",d=l):(n.dataTransfer.dropEffect="none",d=null)},!1),t.addEventListener("dragover",n=>{var o,i,r;if(!(!((o=n.dataTransfer)===null||o===void 0)&&o.types.includes("Files")))return;if(n.preventDefault(),((r=(i=window._wails)===null||i===void 0?void 0:i.flags)===null||r===void 0?void 0:r.enableFileDrop)===!1){n.dataTransfer.dropEffect="none";return}const a=document.elementFromPoint(n.clientX,n.clientY),l=S(a);d&&d!==l&&d.classList.remove(w),l?(l.classList.contains(w)||l.classList.add(w),n.dataTransfer.dropEffect="copy",d=l):(n.dataTransfer.dropEffect="none",d=null)},!1),t.addEventListener("dragleave",n=>{var o,i,r;!((o=n.dataTransfer)===null||o===void 0)&&o.types.includes("Files")&&(n.preventDefault(),((r=(i=window._wails)===null||i===void 0?void 0:i.flags)===null||r===void 0?void 0:r.enableFileDrop)!==!1&&n.relatedTarget!==null&&(e--,(e===0||d&&!d.contains(n.relatedTarget))&&(d&&(d.classList.remove(w),d=null),e=0)))},!1),t.addEventListener("drop",n=>{var o,i,r;if(!((o=n.dataTransfer)===null||o===void 0)&&o.types.includes("Files")&&(n.preventDefault(),((r=(i=window._wails)===null||i===void 0?void 0:i.flags)===null||r===void 0?void 0:r.enableFileDrop)!==!1&&(e=0,d&&(d.classList.remove(w),d=null),vt()))){const a=[];if(n.dataTransfer.items){for(const l of n.dataTransfer.items)if(l.kind==="file"){const c=l.getAsFile();c&&a.push(c)}}else if(n.dataTransfer.files)for(const l of n.dataTransfer.files)a.push(l);a.length>0&&bt(n.clientX,n.clientY,a)}},!1)}typeof window<"u"&&typeof document<"u"&&_t();window._wails=window._wails||{};window._wails.invoke=_;window._wails.clientId=U;window._wails.handlePlatformFileDrop=N.HandlePlatformFileDrop.bind(N);window._wails.handleDragEnter=Mt;window._wails.handleDragLeave=yt;window._wails.handleDragOver=Et;_("wails:runtime:ready");function St(t){return fetch(t,{method:"HEAD"}).then(e=>{if(e.ok){const n=document.createElement("script");n.src=t,document.head.appendChild(n)}}).catch(()=>{})}St("/wails/custom.js");const Tt=document.getElementById("documents-list"),xt=document.getElementById("images-list"),Dt=document.getElementById("other-list"),zt=document.getElementById("drop-details"),Ft=[".png",".jpg",".jpeg",".gif",".bmp",".svg",".webp",".ico",".tiff",".tif"],Ct=[".pdf",".doc",".docx",".txt",".rtf",".odt",".xls",".xlsx",".ppt",".pptx",".md",".csv",".json",".xml",".html",".htm"];function G(t){return t.split(/[/\\]/).pop()}function Lt(t){const e=G(t),n=e.lastIndexOf(".");return n>0?e.substring(n).toLowerCase():""}function Ot(t){const e=Lt(t);return Ft.includes(e)?"images":Ct.includes(e)?"documents":"other"}function I(t,e){const n=t.querySelector(".empty");n&&n.remove();const o=document.createElement("li");o.textContent=e,t.appendChild(o)}ve("files-dropped",t=>{const{files:e,details:n}=t.data;e.forEach(i=>{const r=G(i);switch(Ot(i)){case"documents":I(Tt,r);break;case"images":I(xt,r);break;default:I(Dt,r)}});let o=`External: ${e.length} file(s) dropped`;n&&(o+=` at (${n.x}, ${n.y})`),zt.textContent=o});console.log("[DND NPM Test] Initialized with @wailsio/runtime"); diff --git a/v3/test/dnd-npm-runtime/frontend/dist/index.html b/v3/test/dnd-npm-runtime/frontend/dist/index.html new file mode 100644 index 000000000..cf57d6b3c --- /dev/null +++ b/v3/test/dnd-npm-runtime/frontend/dist/index.html @@ -0,0 +1,185 @@ + + + + + + DND NPM Runtime Test + + + + +

                    DND NPM Runtime Test @wailsio/runtime

                    + + +

                    External File Drop

                    +
                    +

                    + This test uses the @wailsio/runtime npm module instead of the bundled /wails/runtime.js. + Drop files from your operating system to verify the fix works. +

                    +
                    + +
                    +
                    +

                    Drop files from your desktop or file manager here

                    +
                    + +
                    +
                    +

                    Documents

                    +
                      +
                    • No documents yet
                    • +
                    +
                    + +
                    +

                    Images

                    +
                      +
                    • No images yet
                    • +
                    +
                    + +
                    +

                    Other Files

                    +
                      +
                    • No other files yet
                    • +
                    +
                    +
                    +
                    + +
                    + Last action: No actions yet +
                    + + + diff --git a/v3/test/dnd-npm-runtime/frontend/index.html b/v3/test/dnd-npm-runtime/frontend/index.html new file mode 100644 index 000000000..32ed52e5b --- /dev/null +++ b/v3/test/dnd-npm-runtime/frontend/index.html @@ -0,0 +1,185 @@ + + + + + + DND NPM Runtime Test + + + +

                    DND NPM Runtime Test @wailsio/runtime

                    + + +

                    External File Drop

                    +
                    +

                    + This test uses the @wailsio/runtime npm module instead of the bundled /wails/runtime.js. + Drop files from your operating system to verify the fix works. +

                    +
                    + +
                    +
                    +

                    Drop files from your desktop or file manager here

                    +
                    + +
                    +
                    +

                    Documents

                    +
                      +
                    • No documents yet
                    • +
                    +
                    + +
                    +

                    Images

                    +
                      +
                    • No images yet
                    • +
                    +
                    + +
                    +

                    Other Files

                    +
                      +
                    • No other files yet
                    • +
                    +
                    +
                    +
                    + +
                    + Last action: No actions yet +
                    + + + + diff --git a/v3/test/dnd-npm-runtime/frontend/main.js b/v3/test/dnd-npm-runtime/frontend/main.js new file mode 100644 index 000000000..b47535cc8 --- /dev/null +++ b/v3/test/dnd-npm-runtime/frontend/main.js @@ -0,0 +1,76 @@ +/** + * DND NPM Runtime Test + * + * This file tests drag-and-drop functionality using the @wailsio/runtime npm module + * instead of the bundled /wails/runtime.js. + * + * The key difference: + * - Bundled runtime: import { Events } from '/wails/runtime.js' + * - NPM module: import { Events } from '@wailsio/runtime' + */ + +import { Events } from '@wailsio/runtime'; + +const documentsEl = document.getElementById('documents-list'); +const imagesEl = document.getElementById('images-list'); +const otherEl = document.getElementById('other-list'); +const dropDetails = document.getElementById('drop-details'); + +// ===== External File Drop ===== +const imageExtensions = ['.png', '.jpg', '.jpeg', '.gif', '.bmp', '.svg', '.webp', '.ico', '.tiff', '.tif']; +const documentExtensions = ['.pdf', '.doc', '.docx', '.txt', '.rtf', '.odt', '.xls', '.xlsx', '.ppt', '.pptx', '.md', '.csv', '.json', '.xml', '.html', '.htm']; + +function getFileName(path) { + return path.split(/[/\\]/).pop(); +} + +function getExtension(path) { + const name = getFileName(path); + const idx = name.lastIndexOf('.'); + return idx > 0 ? name.substring(idx).toLowerCase() : ''; +} + +function categoriseFile(path) { + const ext = getExtension(path); + if (imageExtensions.includes(ext)) return 'images'; + if (documentExtensions.includes(ext)) return 'documents'; + return 'other'; +} + +function addFileToList(listEl, fileName) { + const empty = listEl.querySelector('.empty'); + if (empty) empty.remove(); + + const li = document.createElement('li'); + li.textContent = fileName; + listEl.appendChild(li); +} + +// Listen for files-dropped event from Go backend +Events.On('files-dropped', (event) => { + const { files, details } = event.data; + + files.forEach(filePath => { + const fileName = getFileName(filePath); + const category = categoriseFile(filePath); + + switch (category) { + case 'documents': + addFileToList(documentsEl, fileName); + break; + case 'images': + addFileToList(imagesEl, fileName); + break; + default: + addFileToList(otherEl, fileName); + } + }); + + let info = `External: ${files.length} file(s) dropped`; + if (details) { + info += ` at (${details.x}, ${details.y})`; + } + dropDetails.textContent = info; +}); + +console.log('[DND NPM Test] Initialized with @wailsio/runtime'); diff --git a/v3/test/dnd-npm-runtime/frontend/package.json b/v3/test/dnd-npm-runtime/frontend/package.json new file mode 100644 index 000000000..f4a9f9357 --- /dev/null +++ b/v3/test/dnd-npm-runtime/frontend/package.json @@ -0,0 +1,17 @@ +{ + "name": "dnd-npm-runtime-test", + "private": true, + "version": "1.0.0", + "type": "module", + "scripts": { + "dev": "vite", + "build": "vite build", + "preview": "vite preview" + }, + "dependencies": { + "@wailsio/runtime": "^3.0.0-alpha.79" + }, + "devDependencies": { + "vite": "^5.0.0" + } +} diff --git a/v3/test/dnd-npm-runtime/frontend/vite.config.js b/v3/test/dnd-npm-runtime/frontend/vite.config.js new file mode 100644 index 000000000..0098938b3 --- /dev/null +++ b/v3/test/dnd-npm-runtime/frontend/vite.config.js @@ -0,0 +1,8 @@ +import { defineConfig } from 'vite' + +export default defineConfig({ + build: { + outDir: 'dist', + emptyOutDir: true, + }, +}) diff --git a/v3/test/dnd-npm-runtime/main.go b/v3/test/dnd-npm-runtime/main.go new file mode 100644 index 000000000..043a35d93 --- /dev/null +++ b/v3/test/dnd-npm-runtime/main.go @@ -0,0 +1,60 @@ +package main + +import ( + "embed" + "log" + + "github.com/wailsapp/wails/v3/pkg/application" + "github.com/wailsapp/wails/v3/pkg/events" +) + +//go:embed frontend/dist +var assets embed.FS + +func main() { + app := application.New(application.Options{ + Name: "DND NPM Runtime Test", + Description: "Test drag and drop with npm @wailsio/runtime module", + Assets: application.AssetOptions{ + Handler: application.BundledAssetFileServer(assets), + }, + Mac: application.MacOptions{ + ApplicationShouldTerminateAfterLastWindowClosed: true, + }, + }) + + win := app.Window.NewWithOptions(application.WebviewWindowOptions{ + Title: "DND NPM Runtime Test", + Width: 800, + Height: 600, + EnableFileDrop: true, + Mac: application.MacWindow{ + Backdrop: application.MacBackdropTranslucent, + TitleBar: application.MacTitleBarHiddenInsetUnified, + InvisibleTitleBarHeight: 50, + }, + }) + + // Listen for file drop events + win.OnWindowEvent(events.Common.WindowFilesDropped, func(event *application.WindowEvent) { + files := event.Context().DroppedFiles() + details := event.Context().DropTargetDetails() + + log.Printf("Files dropped: %v", files) + if details != nil { + log.Printf("Drop target: id=%s, classes=%v, x=%d, y=%d", + details.ElementID, details.ClassList, details.X, details.Y) + } + + // Emit event to frontend + application.Get().Event.Emit("files-dropped", map[string]any{ + "files": files, + "details": details, + }) + }) + + err := app.Run() + if err != nil { + log.Fatal(err) + } +} diff --git a/v3/test/docker/Dockerfile.linux-arm64 b/v3/test/docker/Dockerfile.linux-arm64 new file mode 100644 index 000000000..f1a8a6ea7 --- /dev/null +++ b/v3/test/docker/Dockerfile.linux-arm64 @@ -0,0 +1,200 @@ +# syntax=docker/dockerfile:1 +# Build Linux binaries for Wails v3 examples using Ubuntu 24.04 (ARM64 native) +FROM ubuntu:24.04 + +# Avoid interactive prompts during package installation +ENV DEBIAN_FRONTEND=noninteractive + +# Install system dependencies for Wails v3 (ARM64 native) +# GTK4/WebKitGTK 6.0 is the default build target +# GTK3/WebKit2GTK 4.1 is available for legacy builds with -tags gtk3 +RUN apt-get update && apt-get install -y \ + --no-install-recommends \ + # Core build tools for ARM64 + build-essential \ + gcc \ + g++ \ + pkg-config \ + # GTK4 and WebKitGTK 6.0 dependencies (DEFAULT) + libgtk-4-dev \ + libwebkitgtk-6.0-dev \ + # GTK3 and WebKit2GTK 4.1 dependencies (LEGACY - for -tags gtk3) + libgtk-3-dev \ + libwebkit2gtk-4.1-dev \ + # Additional dependencies that might be needed + libayatana-appindicator3-dev \ + # Git for go mod operations + git \ + # CA certificates for HTTPS + ca-certificates \ + # wget for downloading Go + wget \ + # Clean up apt cache and lists + && rm -rf /var/lib/apt/lists/* \ + && apt-get clean + +# Install Go 1.24 ARM64 version +ENV GO_VERSION=1.24.0 +RUN cd /tmp && \ + wget https://go.dev/dl/go${GO_VERSION}.linux-arm64.tar.gz && \ + wget https://go.dev/dl/go${GO_VERSION}.linux-arm64.tar.gz.sha256 && \ + echo "$(cat go${GO_VERSION}.linux-arm64.tar.gz.sha256) go${GO_VERSION}.linux-arm64.tar.gz" | sha256sum -c - && \ + tar -C /usr/local -xzf go${GO_VERSION}.linux-arm64.tar.gz && \ + rm go${GO_VERSION}.linux-arm64.tar.gz go${GO_VERSION}.linux-arm64.tar.gz.sha256 + +# Set Go environment for ARM64 native compilation +ENV PATH="/usr/local/go/bin:${PATH}" +ENV GOPATH="/go" +ENV PATH="${GOPATH}/bin:${PATH}" +ENV CGO_ENABLED=1 +ENV GOOS=linux +ENV GOARCH=arm64 + +# Set working directory +WORKDIR /build + +# Copy the entire v3 directory structure +COPY . /build/ + +# Create build script for ARM64 native compilation +# hadolint ignore=DL1000 +RUN cat > /build/build-linux-arm64.sh << 'EOF' +#!/bin/bash +set -e + +# Colors for output +RED='\033[0;31m' +GREEN='\033[0;32m' +YELLOW='\033[1;33m' +NC='\033[0m' # No Color + +echo "🐧 Building Wails v3 examples for Linux ARM64 (Ubuntu 24.04)" +echo "Go version: $(go version)" +echo "Architecture: $(uname -m)" +echo "Build directory: $(pwd)" +echo "" + +# Function to build a single example +build_example() { + local example_name="$1" + local example_dir="/build/examples/$example_name" + + if [ ! -d "$example_dir" ]; then + echo -e "${RED}✗${NC} Example directory $example_name not found" + return 1 + fi + + if [ ! -f "$example_dir/main.go" ]; then + echo -e "${YELLOW}⚠${NC} Skipping $example_name (no main.go)" + return 0 + fi + + echo -e "Building ${YELLOW}$example_name${NC} for ARM64..." + cd "$example_dir" + + # Update go.mod for Docker environment + if [ -f go.mod ]; then + go mod edit -dropreplace github.com/wailsapp/wails/v3 2>/dev/null || true + go mod edit -replace github.com/wailsapp/wails/v3=/build + fi + + # Tidy dependencies + echo " Running go mod tidy..." + if ! go mod tidy; then + echo -e "${RED}✗${NC} go mod tidy failed for $example_name" + return 1 + fi + + # Build the example for ARM64 + # Use BUILD_TAGS environment variable for GTK3 legacy builds + local build_tags="${BUILD_TAGS:-}" + local suffix="linux-arm64" + if [ -n "$build_tags" ]; then + suffix="linux-arm64-${build_tags}" + echo " Compiling for ARM64 with tags: $build_tags..." + else + echo " Compiling for ARM64 (GTK4 default)..." + fi + + if go build ${build_tags:+-tags "$build_tags"} -o "testbuild-$example_name-$suffix"; then + echo -e "${GREEN}✓${NC} Successfully built $example_name for ARM64" + ls -la "testbuild-$example_name-$suffix" + return 0 + else + echo -e "${RED}✗${NC} Build failed for $example_name" + return 1 + fi +} + +# Main execution +if [ $# -eq 0 ]; then + # Build all examples + echo "Building all examples for ARM64..." + cd /build/examples + + failed_examples=() + successful_examples=() + skipped_examples=() + + for example_dir in */; do + example_name=$(basename "$example_dir") + + if build_example "$example_name"; then + if [ -f "/build/examples/$example_name/testbuild-$example_name-linux-arm64" ]; then + successful_examples+=("$example_name") + else + skipped_examples+=("$example_name") + fi + else + failed_examples+=("$example_name") + fi + + echo "" + done + + echo "==============================" + echo "🏗️ ARM64 BUILD SUMMARY" + echo "==============================" + echo -e "${GREEN}✓ Successful builds (${#successful_examples[@]}):${NC}" + for example in "${successful_examples[@]}"; do + echo " $example" + done + + if [ ${#skipped_examples[@]} -gt 0 ]; then + echo -e "${YELLOW}⚠ Skipped (${#skipped_examples[@]}):${NC}" + for example in "${skipped_examples[@]}"; do + echo " $example (no main.go)" + done + fi + + if [ ${#failed_examples[@]} -gt 0 ]; then + echo -e "${RED}✗ Failed builds (${#failed_examples[@]}):${NC}" + for example in "${failed_examples[@]}"; do + echo " $example" + done + fi + + echo "" + echo "Total: ${#successful_examples[@]} successful, ${#failed_examples[@]} failed, ${#skipped_examples[@]} skipped" + + if [ ${#failed_examples[@]} -eq 0 ]; then + echo -e "${GREEN}🎉 All buildable examples compiled successfully for ARM64!${NC}" + exit 0 + else + echo -e "${RED}❌ Some examples failed to build for ARM64${NC}" + exit 1 + fi + +else + # Build specific example + example_name="$1" + echo "Building specific example for ARM64: $example_name" + build_example "$example_name" +fi +EOF + +# Make the script executable +RUN chmod +x /build/build-linux-arm64.sh + +# Default command +CMD ["/build/build-linux-arm64.sh"] \ No newline at end of file diff --git a/v3/test/docker/Dockerfile.linux-x86_64 b/v3/test/docker/Dockerfile.linux-x86_64 new file mode 100644 index 000000000..0d6b318eb --- /dev/null +++ b/v3/test/docker/Dockerfile.linux-x86_64 @@ -0,0 +1,200 @@ +# syntax=docker/dockerfile:1 +# Build Linux binaries for Wails v3 examples using Ubuntu 24.04 (x86_64 native) +FROM --platform=linux/amd64 ubuntu:24.04 + +# Avoid interactive prompts during package installation +ENV DEBIAN_FRONTEND=noninteractive + +# Install system dependencies for Wails v3 (x86_64 native) +# GTK4/WebKitGTK 6.0 is the default build target +# GTK3/WebKit2GTK 4.1 is available for legacy builds with -tags gtk3 +RUN apt-get update && apt-get install -y \ + --no-install-recommends \ + # Core build tools for x86_64 + build-essential \ + gcc \ + g++ \ + pkg-config \ + # GTK4 and WebKitGTK 6.0 dependencies (DEFAULT) + libgtk-4-dev \ + libwebkitgtk-6.0-dev \ + # GTK3 and WebKit2GTK 4.1 dependencies (LEGACY - for -tags gtk3) + libgtk-3-dev \ + libwebkit2gtk-4.1-dev \ + # Additional dependencies that might be needed + libayatana-appindicator3-dev \ + # Git for go mod operations + git \ + # CA certificates for HTTPS + ca-certificates \ + # wget for downloading Go + wget \ + # Clean up apt cache and lists + && rm -rf /var/lib/apt/lists/* \ + && apt-get clean + +# Install Go 1.24 x86_64 version +ENV GO_VERSION=1.24.0 +RUN cd /tmp && \ + wget https://go.dev/dl/go${GO_VERSION}.linux-amd64.tar.gz && \ + wget https://go.dev/dl/go${GO_VERSION}.linux-amd64.tar.gz.sha256 && \ + echo "$(cat go${GO_VERSION}.linux-amd64.tar.gz.sha256) go${GO_VERSION}.linux-amd64.tar.gz" | sha256sum -c - && \ + tar -C /usr/local -xzf go${GO_VERSION}.linux-amd64.tar.gz && \ + rm go${GO_VERSION}.linux-amd64.tar.gz go${GO_VERSION}.linux-amd64.tar.gz.sha256 + +# Set Go environment for x86_64 native compilation +ENV PATH="/usr/local/go/bin:${PATH}" +ENV GOPATH="/go" +ENV PATH="${GOPATH}/bin:${PATH}" +ENV CGO_ENABLED=1 +ENV GOOS=linux +ENV GOARCH=amd64 + +# Set working directory +WORKDIR /build + +# Copy the entire v3 directory structure +COPY . /build/ + +# Create build script for x86_64 native compilation +# hadolint ignore=DL1000 +RUN cat > /build/build-linux-x86_64.sh << 'EOF' +#!/bin/bash +set -e + +# Colors for output +RED='\033[0;31m' +GREEN='\033[0;32m' +YELLOW='\033[1;33m' +NC='\033[0m' # No Color + +echo "🐧 Building Wails v3 examples for Linux x86_64 (Ubuntu 24.04)" +echo "Go version: $(go version)" +echo "Architecture: $(uname -m)" +echo "Build directory: $(pwd)" +echo "" + +# Function to build a single example +build_example() { + local example_name="$1" + local example_dir="/build/examples/$example_name" + + if [ ! -d "$example_dir" ]; then + echo -e "${RED}✗${NC} Example directory $example_name not found" + return 1 + fi + + if [ ! -f "$example_dir/main.go" ]; then + echo -e "${YELLOW}⚠${NC} Skipping $example_name (no main.go)" + return 0 + fi + + echo -e "Building ${YELLOW}$example_name${NC} for x86_64..." + cd "$example_dir" + + # Update go.mod for Docker environment + if [ -f go.mod ]; then + go mod edit -dropreplace github.com/wailsapp/wails/v3 2>/dev/null || true + go mod edit -replace github.com/wailsapp/wails/v3=/build + fi + + # Tidy dependencies + echo " Running go mod tidy..." + if ! go mod tidy; then + echo -e "${RED}✗${NC} go mod tidy failed for $example_name" + return 1 + fi + + # Build the example for x86_64 + # Use BUILD_TAGS environment variable for GTK3 legacy builds + local build_tags="${BUILD_TAGS:-}" + local suffix="linux-x86_64" + if [ -n "$build_tags" ]; then + suffix="linux-x86_64-${build_tags}" + echo " Compiling for x86_64 with tags: $build_tags..." + else + echo " Compiling for x86_64 (GTK4 default)..." + fi + + if go build ${build_tags:+-tags "$build_tags"} -o "testbuild-$example_name-$suffix"; then + echo -e "${GREEN}✓${NC} Successfully built $example_name for x86_64" + ls -la "testbuild-$example_name-$suffix" + return 0 + else + echo -e "${RED}✗${NC} Build failed for $example_name" + return 1 + fi +} + +# Main execution +if [ $# -eq 0 ]; then + # Build all examples + echo "Building all examples for x86_64..." + cd /build/examples + + failed_examples=() + successful_examples=() + skipped_examples=() + + for example_dir in */; do + example_name=$(basename "$example_dir") + + if build_example "$example_name"; then + if [ -f "/build/examples/$example_name/testbuild-$example_name-linux-x86_64" ]; then + successful_examples+=("$example_name") + else + skipped_examples+=("$example_name") + fi + else + failed_examples+=("$example_name") + fi + + echo "" + done + + echo "==============================" + echo "🏗️ x86_64 BUILD SUMMARY" + echo "==============================" + echo -e "${GREEN}✓ Successful builds (${#successful_examples[@]}):${NC}" + for example in "${successful_examples[@]}"; do + echo " $example" + done + + if [ ${#skipped_examples[@]} -gt 0 ]; then + echo -e "${YELLOW}⚠ Skipped (${#skipped_examples[@]}):${NC}" + for example in "${skipped_examples[@]}"; do + echo " $example (no main.go)" + done + fi + + if [ ${#failed_examples[@]} -gt 0 ]; then + echo -e "${RED}✗ Failed builds (${#failed_examples[@]}):${NC}" + for example in "${failed_examples[@]}"; do + echo " $example" + done + fi + + echo "" + echo "Total: ${#successful_examples[@]} successful, ${#failed_examples[@]} failed, ${#skipped_examples[@]} skipped" + + if [ ${#failed_examples[@]} -eq 0 ]; then + echo -e "${GREEN}🎉 All buildable examples compiled successfully for x86_64!${NC}" + exit 0 + else + echo -e "${RED}❌ Some examples failed to build for x86_64${NC}" + exit 1 + fi + +else + # Build specific example + example_name="$1" + echo "Building specific example for x86_64: $example_name" + build_example "$example_name" +fi +EOF + +# Make the script executable +RUN chmod +x /build/build-linux-x86_64.sh + +# Default command +CMD ["/build/build-linux-x86_64.sh"] \ No newline at end of file diff --git a/v3/test/manual/dialog/README.md b/v3/test/manual/dialog/README.md new file mode 100644 index 000000000..3859f5b2b --- /dev/null +++ b/v3/test/manual/dialog/README.md @@ -0,0 +1,211 @@ +# Dialog Manual Tests + +Comprehensive test suite for the GTK4 dialog implementation. + +## Building + +```bash +cd v3/test/manual/dialog +task build:all +``` + +Binaries are output to `bin/` directory with GTK3/GTK4 variants. + +## Test Categories + +### Message Dialogs + +#### 1. message-info + +Tests info/information dialogs. + +| Test | Expected Behavior | +|------|-------------------| +| Basic Info | Dialog with title and message | +| Title Only | Dialog with only title | +| Message Only | Dialog with only message | +| Custom Icon | Dialog displays custom Wails icon | +| Long Message | Text wraps properly | +| Attached to Window | Dialog is modal to main window | + +#### 2. message-question + +Tests question dialogs with buttons. + +| Test | Expected Behavior | +|------|-------------------| +| Two Buttons | Yes/No buttons, callbacks work | +| Three Buttons | Save/Don't Save/Cancel buttons | +| With Default Button | Default button highlighted, Enter selects it | +| With Cancel Button | Escape key triggers cancel button | +| Custom Icon | Dialog displays custom icon | +| Attached to Window | Dialog is modal to main window | +| Button Callbacks | Each button triggers correct callback | + +#### 3. message-warning + +Tests warning dialogs. + +| Test | Expected Behavior | +|------|-------------------| +| Basic Warning | Warning dialog with title and message | +| Title Only | Warning with only title | +| Message Only | Warning with only message | +| Custom Icon | Warning with custom icon | +| Long Warning | Text wraps properly | +| Attached to Window | Dialog is modal to main window | + +#### 4. message-error + +Tests error dialogs. + +| Test | Expected Behavior | +|------|-------------------| +| Basic Error | Error dialog with title and message | +| Title Only | Error with only title | +| Message Only | Error with only message | +| Custom Icon | Error with custom icon | +| Technical Error | Long error message wraps properly | +| Attached to Window | Dialog is modal to main window | + +### File Dialogs + +#### 5. file-open + +Tests single file open dialogs. + +| Test | Expected Behavior | +|------|-------------------| +| Basic Open | File picker opens, selection returned | +| With Title | Dialog has custom title | +| Show Hidden Files | Hidden files (.*) visible | +| Start in Home | Dialog opens in home directory | +| Start in /tmp | Dialog opens in /tmp | +| Filter: Text Files | Only .txt, .md, .log files shown | +| Filter: Images | Only image files shown | +| Multiple Filters | Filter dropdown with multiple options | +| Custom Button Text | Open button has custom text | +| Attached to Window | Dialog is modal to main window | + +#### 6. file-open-multi + +Tests multiple file selection. + +| Test | Expected Behavior | +|------|-------------------| +| Select Multiple Files | Can select multiple files with Ctrl+click | +| With Hidden Files | Hidden files visible in selection | +| Filter: Source Code | Only source files shown | +| Filter: Documents | Only document files shown | +| Attached to Window | Dialog is modal to main window | + +#### 7. file-save + +Tests save file dialogs. + +| Test | Expected Behavior | +|------|-------------------| +| Basic Save | Save dialog opens | +| With Message | Dialog has custom message | +| With Default Filename | Filename field pre-populated | +| Start in Home | Dialog opens in home directory | +| Start in /tmp | Dialog opens in /tmp | +| Show Hidden Files | Hidden files visible | +| Can Create Directories | New folder button works | +| Cannot Create Directories | New folder button hidden/disabled | +| Custom Button Text | Save button has custom text | +| Attached to Window | Dialog is modal to main window | + +#### 8. file-directory + +Tests directory selection dialogs. + +| Test | Expected Behavior | +|------|-------------------| +| Basic Directory | Can only select directories | +| Start in Home | Dialog opens in home directory | +| Start in / | Dialog opens at root | +| Can Create Directories | New folder button works | +| Show Hidden | Hidden directories visible | +| Resolve Aliases/Symlinks | Symlinks resolved to real paths | +| Custom Button Text | Open button has custom text | +| Multiple Directories | Can select multiple directories | +| Attached to Window | Dialog is modal to main window | + +## GTK Version Matrix + +| Test | GTK4 | GTK3 | +|------|------|------| +| message-info | | | +| message-question | | | +| message-warning | | | +| message-error | | | +| file-open | | | +| file-open-multi | | | +| file-save | | | +| file-directory | | | + +## Running Individual Tests + +```bash +# GTK4 (default) +./bin/message-info-gtk4 +./bin/message-question-gtk4 +./bin/message-warning-gtk4 +./bin/message-error-gtk4 +./bin/file-open-gtk4 +./bin/file-open-multi-gtk4 +./bin/file-save-gtk4 +./bin/file-directory-gtk4 + +# GTK3 +./bin/message-info-gtk3 +./bin/message-question-gtk3 +./bin/message-warning-gtk3 +./bin/message-error-gtk3 +./bin/file-open-gtk3 +./bin/file-open-multi-gtk3 +./bin/file-save-gtk3 +./bin/file-directory-gtk3 +``` + +## Checklist for Full Verification + +### Message Dialogs + +- [ ] Dialog appears centered or attached correctly +- [ ] Title displays correctly +- [ ] Message displays correctly +- [ ] Custom icons display correctly +- [ ] Long text wraps properly +- [ ] OK/Close button dismisses dialog +- [ ] Escape key closes dialog (where applicable) + +### Question Dialogs + +- [ ] All buttons display correctly +- [ ] Button callbacks fire correctly +- [ ] Default button is highlighted +- [ ] Enter key activates default button +- [ ] Escape key activates cancel button +- [ ] Multiple buttons layout correctly + +### File Dialogs + +- [ ] Dialog opens in correct directory +- [ ] Filters work correctly +- [ ] Hidden files toggle works +- [ ] Create directory works (where enabled) +- [ ] Cancel returns empty string +- [ ] Selection returns correct path(s) +- [ ] Multiple selection works (multi tests) +- [ ] Custom button text displays + +### Known Issues + +Document any issues found during testing: + +``` +[GTK Version] [Test] - Issue description +Example: GTK4 file-open - Filter dropdown not visible +``` diff --git a/v3/test/manual/dialog/Taskfile.yaml b/v3/test/manual/dialog/Taskfile.yaml new file mode 100644 index 000000000..b5bd97518 --- /dev/null +++ b/v3/test/manual/dialog/Taskfile.yaml @@ -0,0 +1,125 @@ +version: "3" + +vars: + BIN_DIR: "{{.ROOT_DIR}}/bin" + +tasks: + default: + desc: Build all dialog tests for GTK3 and GTK4 + cmds: + - task: build:all + + build:all: + desc: Build all tests for both GTK3 and GTK4 + deps: + - build:gtk4 + - build:gtk3 + + build:gtk4: + desc: Build all tests for GTK4 + cmds: + - task: build:message-info-gtk4 + - task: build:message-question-gtk4 + - task: build:message-warning-gtk4 + - task: build:message-error-gtk4 + - task: build:file-open-gtk4 + - task: build:file-open-multi-gtk4 + - task: build:file-save-gtk4 + - task: build:file-directory-gtk4 + + build:gtk3: + desc: Build all tests for GTK3 + cmds: + - task: build:message-info-gtk3 + - task: build:message-question-gtk3 + - task: build:message-warning-gtk3 + - task: build:message-error-gtk3 + - task: build:file-open-gtk3 + - task: build:file-open-multi-gtk3 + - task: build:file-save-gtk3 + - task: build:file-directory-gtk3 + + build:message-info-gtk4: + dir: message-info + cmds: + - go build -o "{{.BIN_DIR}}/message-info-gtk4" . + + build:message-info-gtk3: + dir: message-info + cmds: + - go build -tags gtk3 -o "{{.BIN_DIR}}/message-info-gtk3" . + + build:message-question-gtk4: + dir: message-question + cmds: + - go build -o "{{.BIN_DIR}}/message-question-gtk4" . + + build:message-question-gtk3: + dir: message-question + cmds: + - go build -tags gtk3 -o "{{.BIN_DIR}}/message-question-gtk3" . + + build:message-warning-gtk4: + dir: message-warning + cmds: + - go build -o "{{.BIN_DIR}}/message-warning-gtk4" . + + build:message-warning-gtk3: + dir: message-warning + cmds: + - go build -tags gtk3 -o "{{.BIN_DIR}}/message-warning-gtk3" . + + build:message-error-gtk4: + dir: message-error + cmds: + - go build -o "{{.BIN_DIR}}/message-error-gtk4" . + + build:message-error-gtk3: + dir: message-error + cmds: + - go build -tags gtk3 -o "{{.BIN_DIR}}/message-error-gtk3" . + + build:file-open-gtk4: + dir: file-open + cmds: + - go build -o "{{.BIN_DIR}}/file-open-gtk4" . + + build:file-open-gtk3: + dir: file-open + cmds: + - go build -tags gtk3 -o "{{.BIN_DIR}}/file-open-gtk3" . + + build:file-open-multi-gtk4: + dir: file-open-multi + cmds: + - go build -o "{{.BIN_DIR}}/file-open-multi-gtk4" . + + build:file-open-multi-gtk3: + dir: file-open-multi + cmds: + - go build -tags gtk3 -o "{{.BIN_DIR}}/file-open-multi-gtk3" . + + build:file-save-gtk4: + dir: file-save + cmds: + - go build -o "{{.BIN_DIR}}/file-save-gtk4" . + + build:file-save-gtk3: + dir: file-save + cmds: + - go build -tags gtk3 -o "{{.BIN_DIR}}/file-save-gtk3" . + + build:file-directory-gtk4: + dir: file-directory + cmds: + - go build -o "{{.BIN_DIR}}/file-directory-gtk4" . + + build:file-directory-gtk3: + dir: file-directory + cmds: + - go build -tags gtk3 -o "{{.BIN_DIR}}/file-directory-gtk3" . + + clean: + desc: Remove all built binaries + cmds: + - rm -rf "{{.BIN_DIR}}" diff --git a/v3/test/manual/dialog/bin/file-directory-gtk4 b/v3/test/manual/dialog/bin/file-directory-gtk4 new file mode 100755 index 000000000..4f0d2a45e Binary files /dev/null and b/v3/test/manual/dialog/bin/file-directory-gtk4 differ diff --git a/v3/test/manual/dialog/bin/file-directory-gtk4-debug b/v3/test/manual/dialog/bin/file-directory-gtk4-debug new file mode 100755 index 000000000..d20d8eb53 Binary files /dev/null and b/v3/test/manual/dialog/bin/file-directory-gtk4-debug differ diff --git a/v3/test/manual/dialog/bin/file-directory-gtk4-race b/v3/test/manual/dialog/bin/file-directory-gtk4-race new file mode 100755 index 000000000..8a7cb0d89 Binary files /dev/null and b/v3/test/manual/dialog/bin/file-directory-gtk4-race differ diff --git a/v3/test/manual/dialog/bin/file-open-gtk4 b/v3/test/manual/dialog/bin/file-open-gtk4 new file mode 100755 index 000000000..fb37c7872 Binary files /dev/null and b/v3/test/manual/dialog/bin/file-open-gtk4 differ diff --git a/v3/test/manual/dialog/bin/file-open-gtk4-race b/v3/test/manual/dialog/bin/file-open-gtk4-race new file mode 100755 index 000000000..b93b686af Binary files /dev/null and b/v3/test/manual/dialog/bin/file-open-gtk4-race differ diff --git a/v3/test/manual/dialog/bin/file-open-multi-gtk4 b/v3/test/manual/dialog/bin/file-open-multi-gtk4 new file mode 100755 index 000000000..eb7c88fd0 Binary files /dev/null and b/v3/test/manual/dialog/bin/file-open-multi-gtk4 differ diff --git a/v3/test/manual/dialog/bin/file-open-multi-gtk4-race b/v3/test/manual/dialog/bin/file-open-multi-gtk4-race new file mode 100755 index 000000000..df0d7eae9 Binary files /dev/null and b/v3/test/manual/dialog/bin/file-open-multi-gtk4-race differ diff --git a/v3/test/manual/dialog/bin/file-save-gtk4 b/v3/test/manual/dialog/bin/file-save-gtk4 new file mode 100755 index 000000000..9529d5f88 Binary files /dev/null and b/v3/test/manual/dialog/bin/file-save-gtk4 differ diff --git a/v3/test/manual/dialog/bin/file-save-gtk4-race b/v3/test/manual/dialog/bin/file-save-gtk4-race new file mode 100755 index 000000000..d53a800c0 Binary files /dev/null and b/v3/test/manual/dialog/bin/file-save-gtk4-race differ diff --git a/v3/test/manual/dialog/bin/message-error-gtk4 b/v3/test/manual/dialog/bin/message-error-gtk4 new file mode 100755 index 000000000..4abe345fd Binary files /dev/null and b/v3/test/manual/dialog/bin/message-error-gtk4 differ diff --git a/v3/test/manual/dialog/bin/message-error-gtk4-race b/v3/test/manual/dialog/bin/message-error-gtk4-race new file mode 100755 index 000000000..e874376c0 Binary files /dev/null and b/v3/test/manual/dialog/bin/message-error-gtk4-race differ diff --git a/v3/test/manual/dialog/bin/message-info-gtk4 b/v3/test/manual/dialog/bin/message-info-gtk4 new file mode 100755 index 000000000..9080df02c Binary files /dev/null and b/v3/test/manual/dialog/bin/message-info-gtk4 differ diff --git a/v3/test/manual/dialog/bin/message-info-gtk4-race b/v3/test/manual/dialog/bin/message-info-gtk4-race new file mode 100755 index 000000000..a79b85ce0 Binary files /dev/null and b/v3/test/manual/dialog/bin/message-info-gtk4-race differ diff --git a/v3/test/manual/dialog/bin/message-question-gtk4 b/v3/test/manual/dialog/bin/message-question-gtk4 new file mode 100755 index 000000000..aa9011e4f Binary files /dev/null and b/v3/test/manual/dialog/bin/message-question-gtk4 differ diff --git a/v3/test/manual/dialog/bin/message-question-gtk4-race b/v3/test/manual/dialog/bin/message-question-gtk4-race new file mode 100755 index 000000000..2848816b6 Binary files /dev/null and b/v3/test/manual/dialog/bin/message-question-gtk4-race differ diff --git a/v3/test/manual/dialog/bin/message-warning-gtk4 b/v3/test/manual/dialog/bin/message-warning-gtk4 new file mode 100755 index 000000000..03432c436 Binary files /dev/null and b/v3/test/manual/dialog/bin/message-warning-gtk4 differ diff --git a/v3/test/manual/dialog/bin/message-warning-gtk4-race b/v3/test/manual/dialog/bin/message-warning-gtk4-race new file mode 100755 index 000000000..6f03b2ef1 Binary files /dev/null and b/v3/test/manual/dialog/bin/message-warning-gtk4-race differ diff --git a/v3/test/manual/dialog/file-directory/main.go b/v3/test/manual/dialog/file-directory/main.go new file mode 100644 index 000000000..e7374703c --- /dev/null +++ b/v3/test/manual/dialog/file-directory/main.go @@ -0,0 +1,158 @@ +package main + +import ( + "log" + "os" + + "github.com/wailsapp/wails/v3/pkg/application" +) + +func main() { + app := application.New(application.Options{ + Name: "Dialog Test - Directory", + Assets: application.AlphaAssets, + }) + + menu := app.NewMenu() + + menu.Add("Basic Directory").OnClick(func(ctx *application.Context) { + result, err := app.Dialog.OpenFile(). + SetTitle("Select Directory"). + CanChooseDirectories(true). + CanChooseFiles(false). + PromptForSingleSelection() + showResult(app, "Basic Directory", result, err) + }) + + menu.Add("Start in Home").OnClick(func(ctx *application.Context) { + home, _ := os.UserHomeDir() + result, err := app.Dialog.OpenFile(). + SetTitle("Select from Home"). + SetDirectory(home). + CanChooseDirectories(true). + CanChooseFiles(false). + PromptForSingleSelection() + showResult(app, "Home Directory", result, err) + }) + + menu.Add("Start in /").OnClick(func(ctx *application.Context) { + result, err := app.Dialog.OpenFile(). + SetTitle("Select from Root"). + SetDirectory("/"). + CanChooseDirectories(true). + CanChooseFiles(false). + PromptForSingleSelection() + showResult(app, "Root Directory", result, err) + }) + + menu.Add("Can Create Directories").OnClick(func(ctx *application.Context) { + result, err := app.Dialog.OpenFile(). + SetTitle("Select Directory (Can Create)"). + CanChooseDirectories(true). + CanChooseFiles(false). + CanCreateDirectories(true). + PromptForSingleSelection() + showResult(app, "Create Dirs", result, err) + }) + + menu.Add("Show Hidden").OnClick(func(ctx *application.Context) { + result, err := app.Dialog.OpenFile(). + SetTitle("Select Directory (Hidden Visible)"). + CanChooseDirectories(true). + CanChooseFiles(false). + ShowHiddenFiles(true). + PromptForSingleSelection() + showResult(app, "Show Hidden", result, err) + }) + + menu.Add("Resolve Aliases/Symlinks").OnClick(func(ctx *application.Context) { + result, err := app.Dialog.OpenFile(). + SetTitle("Select Directory (Resolve Symlinks)"). + CanChooseDirectories(true). + CanChooseFiles(false). + ResolvesAliases(true). + PromptForSingleSelection() + showResult(app, "Resolve Aliases", result, err) + }) + + menu.Add("Custom Button Text").OnClick(func(ctx *application.Context) { + result, err := app.Dialog.OpenFile(). + SetTitle("Choose Project Folder"). + SetButtonText("Use This Folder"). + CanChooseDirectories(true). + CanChooseFiles(false). + PromptForSingleSelection() + showResult(app, "Custom Button", result, err) + }) + + menu.Add("Multiple Directories").OnClick(func(ctx *application.Context) { + results, err := app.Dialog.OpenFile(). + SetTitle("Select Multiple Directories"). + CanChooseDirectories(true). + CanChooseFiles(false). + PromptForMultipleSelection() + if err != nil { + log.Printf("[Multi Dir] Error: %v", err) + app.Dialog.Error().SetTitle("Error").SetMessage(err.Error()).Show() + return + } + if len(results) == 0 { + log.Printf("[Multi Dir] Cancelled") + app.Dialog.Info().SetTitle("Multi Dir").SetMessage("No directories selected").Show() + return + } + log.Printf("[Multi Dir] Selected %d directories", len(results)) + msg := "" + for _, r := range results { + msg += r + "\n" + } + app.Dialog.Info().SetTitle("Multi Dir").SetMessage(msg).Show() + }) + + menu.Add("Attached to Window").OnClick(func(ctx *application.Context) { + result, err := app.Dialog.OpenFile(). + SetTitle("Select Directory (Attached)"). + CanChooseDirectories(true). + CanChooseFiles(false). + AttachToWindow(app.Window.Current()). + PromptForSingleSelection() + showResult(app, "Attached", result, err) + }) + + menu.AddSeparator() + menu.Add("Quit").OnClick(func(ctx *application.Context) { + app.Quit() + }) + + window := app.Window.NewWithOptions(application.WebviewWindowOptions{ + Title: "Directory Dialog Tests", + Width: 400, + Height: 200, + Linux: application.LinuxWindow{ + MenuStyle: application.LinuxMenuStylePrimaryMenu, + }, + }) + window.SetMenu(menu) + + log.Println("Directory Dialog Tests") + log.Println("Use the Tests menu to run each test case") + + if err := app.Run(); err != nil { + log.Fatal(err) + } +} + +func showResult(app *application.App, test string, result string, err error) { + if err != nil { + log.Printf("[%s] Error: %v", test, err) + app.Dialog.Error().SetTitle("Error").SetMessage(err.Error()).Show() + return + } + if result == "" { + log.Printf("[%s] Cancelled", test) + app.Dialog.Info().SetTitle(test).SetMessage("No directory selected").Show() + return + } + log.Printf("[%s] Selected: %s", test, result) + app.Dialog.Info().SetTitle(test).SetMessage(result).Show() +} diff --git a/v3/test/manual/dialog/file-open-multi/main.go b/v3/test/manual/dialog/file-open-multi/main.go new file mode 100644 index 000000000..4cb27a446 --- /dev/null +++ b/v3/test/manual/dialog/file-open-multi/main.go @@ -0,0 +1,106 @@ +package main + +import ( + "fmt" + "log" + "strings" + + "github.com/wailsapp/wails/v3/pkg/application" +) + +func main() { + app := application.New(application.Options{ + Name: "Dialog Test - Open Multiple Files", + Assets: application.AlphaAssets, + }) + + menu := app.NewMenu() + + + + menu.Add("Select Multiple Files").OnClick(func(ctx *application.Context) { + results, err := app.Dialog.OpenFile(). + SetTitle("Select Multiple Files"). + CanChooseFiles(true). + PromptForMultipleSelection() + showResults(app, "Multi Select", results, err) + }) + + menu.Add("With Hidden Files").OnClick(func(ctx *application.Context) { + results, err := app.Dialog.OpenFile(). + SetTitle("Select Files (Hidden Visible)"). + CanChooseFiles(true). + ShowHiddenFiles(true). + PromptForMultipleSelection() + showResults(app, "Hidden Files", results, err) + }) + + menu.Add("Filter: Source Code").OnClick(func(ctx *application.Context) { + results, err := app.Dialog.OpenFile(). + SetTitle("Select Source Files"). + CanChooseFiles(true). + AddFilter("Go Files", "*.go"). + AddFilter("All Source", "*.go;*.js;*.ts;*.py;*.rs"). + PromptForMultipleSelection() + showResults(app, "Source Filter", results, err) + }) + + menu.Add("Filter: Documents").OnClick(func(ctx *application.Context) { + results, err := app.Dialog.OpenFile(). + SetTitle("Select Documents"). + CanChooseFiles(true). + AddFilter("Documents", "*.pdf;*.doc;*.docx;*.txt;*.md"). + PromptForMultipleSelection() + showResults(app, "Doc Filter", results, err) + }) + + menu.Add("Attached to Window").OnClick(func(ctx *application.Context) { + results, err := app.Dialog.OpenFile(). + SetTitle("Select Files (Attached)"). + CanChooseFiles(true). + AttachToWindow(app.Window.Current()). + PromptForMultipleSelection() + showResults(app, "Attached", results, err) + }) + + menu.AddSeparator() + menu.Add("Quit").OnClick(func(ctx *application.Context) { + app.Quit() + }) + + window := app.Window.NewWithOptions(application.WebviewWindowOptions{ + Title: "Open Multiple Files Tests", + Width: 400, + Height: 200, + Linux: application.LinuxWindow{ + MenuStyle: application.LinuxMenuStylePrimaryMenu, + }, + }) + window.SetMenu(menu) + + log.Println("Open Multiple Files Tests") + log.Println("Use the Tests menu to run each test case") + + if err := app.Run(); err != nil { + log.Fatal(err) + } +} + +func showResults(app *application.App, test string, results []string, err error) { + if err != nil { + log.Printf("[%s] Error: %v", test, err) + app.Dialog.Error().SetTitle("Error").SetMessage(err.Error()).Show() + return + } + if len(results) == 0 { + log.Printf("[%s] Cancelled", test) + app.Dialog.Info().SetTitle(test).SetMessage("No files selected").Show() + return + } + log.Printf("[%s] Selected %d files:", test, len(results)) + for _, r := range results { + log.Printf(" - %s", r) + } + msg := fmt.Sprintf("Selected %d files:\n%s", len(results), strings.Join(results, "\n")) + app.Dialog.Info().SetTitle(test).SetMessage(msg).Show() +} diff --git a/v3/test/manual/dialog/file-open/main.go b/v3/test/manual/dialog/file-open/main.go new file mode 100644 index 000000000..599f2e00a --- /dev/null +++ b/v3/test/manual/dialog/file-open/main.go @@ -0,0 +1,146 @@ +package main + +import ( + "log" + "os" + + "github.com/wailsapp/wails/v3/pkg/application" +) + +func main() { + app := application.New(application.Options{ + Name: "Dialog Test - Open File", + Assets: application.AlphaAssets, + }) + + menu := app.NewMenu() + + + + menu.Add("Basic Open").OnClick(func(ctx *application.Context) { + result, err := app.Dialog.OpenFile(). + CanChooseFiles(true). + PromptForSingleSelection() + showResult(app, "Basic Open", result, err) + }) + + menu.Add("With Title").OnClick(func(ctx *application.Context) { + result, err := app.Dialog.OpenFile(). + SetTitle("Select a File"). + CanChooseFiles(true). + PromptForSingleSelection() + showResult(app, "With Title", result, err) + }) + + menu.Add("Show Hidden Files").OnClick(func(ctx *application.Context) { + result, err := app.Dialog.OpenFile(). + SetTitle("Select File (Hidden Visible)"). + CanChooseFiles(true). + ShowHiddenFiles(true). + PromptForSingleSelection() + showResult(app, "Show Hidden", result, err) + }) + + menu.Add("Start in Home Directory").OnClick(func(ctx *application.Context) { + home, _ := os.UserHomeDir() + result, err := app.Dialog.OpenFile(). + SetTitle("Select from Home"). + SetDirectory(home). + CanChooseFiles(true). + PromptForSingleSelection() + showResult(app, "Home Directory", result, err) + }) + + menu.Add("Start in /tmp").OnClick(func(ctx *application.Context) { + result, err := app.Dialog.OpenFile(). + SetTitle("Select from /tmp"). + SetDirectory("/tmp"). + CanChooseFiles(true). + PromptForSingleSelection() + showResult(app, "/tmp Directory", result, err) + }) + + menu.Add("Filter: Text Files").OnClick(func(ctx *application.Context) { + result, err := app.Dialog.OpenFile(). + SetTitle("Select Text File"). + CanChooseFiles(true). + AddFilter("Text Files", "*.txt;*.md;*.log"). + PromptForSingleSelection() + showResult(app, "Text Filter", result, err) + }) + + menu.Add("Filter: Images").OnClick(func(ctx *application.Context) { + result, err := app.Dialog.OpenFile(). + SetTitle("Select Image"). + CanChooseFiles(true). + AddFilter("Images", "*.png;*.jpg;*.jpeg;*.gif;*.webp"). + PromptForSingleSelection() + showResult(app, "Image Filter", result, err) + }) + + menu.Add("Multiple Filters").OnClick(func(ctx *application.Context) { + result, err := app.Dialog.OpenFile(). + SetTitle("Select File"). + CanChooseFiles(true). + AddFilter("Documents", "*.txt;*.md;*.pdf"). + AddFilter("Images", "*.png;*.jpg;*.gif"). + AddFilter("All Files", "*"). + PromptForSingleSelection() + showResult(app, "Multi Filter", result, err) + }) + + menu.Add("Custom Button Text").OnClick(func(ctx *application.Context) { + result, err := app.Dialog.OpenFile(). + SetTitle("Select File"). + SetButtonText("Choose This One"). + CanChooseFiles(true). + PromptForSingleSelection() + showResult(app, "Custom Button", result, err) + }) + + menu.Add("Attached to Window").OnClick(func(ctx *application.Context) { + result, err := app.Dialog.OpenFile(). + SetTitle("Attached Dialog"). + CanChooseFiles(true). + AttachToWindow(app.Window.Current()). + PromptForSingleSelection() + showResult(app, "Attached", result, err) + }) + + menu.AddSeparator() + menu.Add("Quit").OnClick(func(ctx *application.Context) { + app.Quit() + }) + + window := app.Window.NewWithOptions(application.WebviewWindowOptions{ + Title: "Open File Dialog Tests", + Width: 400, + Height: 200, + Linux: application.LinuxWindow{ + MenuStyle: application.LinuxMenuStylePrimaryMenu, + }, + }) + window.SetMenu(menu) + + log.Println("Open File Dialog Tests") + log.Println("Use the Tests menu to run each test case") + + if err := app.Run(); err != nil { + log.Fatal(err) + } +} + +func showResult(app *application.App, test string, result string, err error) { + if err != nil { + log.Printf("[%s] Error: %v", test, err) + app.Dialog.Error().SetTitle("Error").SetMessage(err.Error()).Show() + return + } + if result == "" { + log.Printf("[%s] Cancelled", test) + app.Dialog.Info().SetTitle(test).SetMessage("No file selected").Show() + return + } + log.Printf("[%s] Selected: %s", test, result) + app.Dialog.Info().SetTitle(test).SetMessage(result).Show() +} diff --git a/v3/test/manual/dialog/file-save/main.go b/v3/test/manual/dialog/file-save/main.go new file mode 100644 index 000000000..0c922599a --- /dev/null +++ b/v3/test/manual/dialog/file-save/main.go @@ -0,0 +1,137 @@ +package main + +import ( + "log" + "os" + + "github.com/wailsapp/wails/v3/pkg/application" +) + +func main() { + app := application.New(application.Options{ + Name: "Dialog Test - Save File", + Assets: application.AlphaAssets, + }) + + menu := app.NewMenu() + + + + menu.Add("Basic Save").OnClick(func(ctx *application.Context) { + result, err := app.Dialog.SaveFile(). + PromptForSingleSelection() + showResult(app, "Basic Save", result, err) + }) + + menu.Add("With Message").OnClick(func(ctx *application.Context) { + result, err := app.Dialog.SaveFile(). + SetMessage("Save your file"). + PromptForSingleSelection() + showResult(app, "With Message", result, err) + }) + + menu.Add("With Default Filename").OnClick(func(ctx *application.Context) { + result, err := app.Dialog.SaveFile(). + SetMessage("Save Document"). + SetFilename("document.txt"). + PromptForSingleSelection() + showResult(app, "Default Filename", result, err) + }) + + menu.Add("Start in Home").OnClick(func(ctx *application.Context) { + home, _ := os.UserHomeDir() + result, err := app.Dialog.SaveFile(). + SetMessage("Save to Home"). + SetDirectory(home). + SetFilename("myfile.txt"). + PromptForSingleSelection() + showResult(app, "Home Directory", result, err) + }) + + menu.Add("Start in /tmp").OnClick(func(ctx *application.Context) { + result, err := app.Dialog.SaveFile(). + SetMessage("Save to /tmp"). + SetDirectory("/tmp"). + SetFilename("temp_file.txt"). + PromptForSingleSelection() + showResult(app, "/tmp Directory", result, err) + }) + + menu.Add("Show Hidden Files").OnClick(func(ctx *application.Context) { + result, err := app.Dialog.SaveFile(). + SetMessage("Save (Hidden Visible)"). + ShowHiddenFiles(true). + PromptForSingleSelection() + showResult(app, "Show Hidden", result, err) + }) + + menu.Add("Can Create Directories").OnClick(func(ctx *application.Context) { + result, err := app.Dialog.SaveFile(). + SetMessage("Save (Can Create Dirs)"). + CanCreateDirectories(true). + PromptForSingleSelection() + showResult(app, "Create Dirs", result, err) + }) + + menu.Add("Cannot Create Directories").OnClick(func(ctx *application.Context) { + result, err := app.Dialog.SaveFile(). + SetMessage("Save (No Create Dirs)"). + CanCreateDirectories(false). + PromptForSingleSelection() + showResult(app, "No Create Dirs", result, err) + }) + + menu.Add("Custom Button Text").OnClick(func(ctx *application.Context) { + result, err := app.Dialog.SaveFile(). + SetMessage("Export File"). + SetButtonText("Export"). + SetFilename("export.json"). + PromptForSingleSelection() + showResult(app, "Custom Button", result, err) + }) + + menu.Add("Attached to Window").OnClick(func(ctx *application.Context) { + result, err := app.Dialog.SaveFile(). + SetMessage("Save (Attached)"). + AttachToWindow(app.Window.Current()). + PromptForSingleSelection() + showResult(app, "Attached", result, err) + }) + + menu.AddSeparator() + menu.Add("Quit").OnClick(func(ctx *application.Context) { + app.Quit() + }) + + window := app.Window.NewWithOptions(application.WebviewWindowOptions{ + Title: "Save File Dialog Tests", + Width: 400, + Height: 200, + Linux: application.LinuxWindow{ + MenuStyle: application.LinuxMenuStylePrimaryMenu, + }, + }) + window.SetMenu(menu) + + log.Println("Save File Dialog Tests") + log.Println("Use the Tests menu to run each test case") + + if err := app.Run(); err != nil { + log.Fatal(err) + } +} + +func showResult(app *application.App, test string, result string, err error) { + if err != nil { + log.Printf("[%s] Error: %v", test, err) + app.Dialog.Error().SetTitle("Error").SetMessage(err.Error()).Show() + return + } + if result == "" { + log.Printf("[%s] Cancelled", test) + app.Dialog.Info().SetTitle(test).SetMessage("No file selected").Show() + return + } + log.Printf("[%s] Selected: %s", test, result) + app.Dialog.Info().SetTitle(test).SetMessage(result).Show() +} diff --git a/v3/test/manual/dialog/message-error/main.go b/v3/test/manual/dialog/message-error/main.go new file mode 100644 index 000000000..93f005099 --- /dev/null +++ b/v3/test/manual/dialog/message-error/main.go @@ -0,0 +1,85 @@ +package main + +import ( + "log" + + "github.com/wailsapp/wails/v3/pkg/application" + "github.com/wailsapp/wails/v3/pkg/icons" +) + +func main() { + app := application.New(application.Options{ + Name: "Dialog Test - Error", + Assets: application.AlphaAssets, + }) + + menu := app.NewMenu() + + + + menu.Add("Basic Error").OnClick(func(ctx *application.Context) { + app.Dialog.Error(). + SetTitle("Error"). + SetMessage("An error has occurred"). + Show() + }) + + menu.Add("Title Only").OnClick(func(ctx *application.Context) { + app.Dialog.Error(). + SetTitle("Error - Something went wrong"). + Show() + }) + + menu.Add("Message Only").OnClick(func(ctx *application.Context) { + app.Dialog.Error(). + SetMessage("Error message without a title"). + Show() + }) + + menu.Add("Custom Icon").OnClick(func(ctx *application.Context) { + app.Dialog.Error(). + SetTitle("Custom Error Icon"). + SetMessage("This error dialog has a custom icon"). + SetIcon(icons.WailsLogoBlack). + Show() + }) + + menu.Add("Technical Error").OnClick(func(ctx *application.Context) { + app.Dialog.Error(). + SetTitle("Connection Failed"). + SetMessage("Failed to connect to server at localhost:8080. " + + "Error: connection refused. " + + "Please check that the server is running and try again."). + Show() + }) + + menu.Add("Attached to Window").OnClick(func(ctx *application.Context) { + app.Dialog.Error(). + SetTitle("Attached Error"). + SetMessage("This error dialog is attached to the main window"). + AttachToWindow(app.Window.Current()). + Show() + }) + + menu.AddSeparator() + menu.Add("Quit").OnClick(func(ctx *application.Context) { + app.Quit() + }) + + window := app.Window.NewWithOptions(application.WebviewWindowOptions{ + Title: "Error Dialog Tests", + Width: 400, + Height: 200, + Linux: application.LinuxWindow{ + MenuStyle: application.LinuxMenuStylePrimaryMenu, + }, + }) + window.SetMenu(menu) + + log.Println("Error Dialog Tests") + log.Println("Use the Tests menu to run each test case") + + if err := app.Run(); err != nil { + log.Fatal(err) + } +} diff --git a/v3/test/manual/dialog/message-info/main.go b/v3/test/manual/dialog/message-info/main.go new file mode 100644 index 000000000..05577d952 --- /dev/null +++ b/v3/test/manual/dialog/message-info/main.go @@ -0,0 +1,85 @@ +package main + +import ( + "log" + + "github.com/wailsapp/wails/v3/pkg/application" + "github.com/wailsapp/wails/v3/pkg/icons" +) + +func main() { + app := application.New(application.Options{ + Name: "Dialog Test - Info", + Assets: application.AlphaAssets, + }) + + menu := app.NewMenu() + + + + menu.Add("Basic Info").OnClick(func(ctx *application.Context) { + app.Dialog.Info(). + SetTitle("Information"). + SetMessage("This is a basic info dialog"). + Show() + }) + + menu.Add("Title Only").OnClick(func(ctx *application.Context) { + app.Dialog.Info(). + SetTitle("Title Only - No Message"). + Show() + }) + + menu.Add("Message Only").OnClick(func(ctx *application.Context) { + app.Dialog.Info(). + SetMessage("Message only - no title set"). + Show() + }) + + menu.Add("Custom Icon").OnClick(func(ctx *application.Context) { + app.Dialog.Info(). + SetTitle("Custom Icon"). + SetMessage("This dialog has a custom icon"). + SetIcon(icons.WailsLogoBlackTransparent). + Show() + }) + + menu.Add("Long Message").OnClick(func(ctx *application.Context) { + app.Dialog.Info(). + SetTitle("Long Message Test"). + SetMessage("This is a very long message that should wrap properly in the dialog. " + + "It contains multiple sentences to test how the dialog handles longer content. " + + "The dialog should display this text in a readable manner without truncation."). + Show() + }) + + menu.Add("Attached to Window").OnClick(func(ctx *application.Context) { + app.Dialog.Info(). + SetTitle("Attached Dialog"). + SetMessage("This dialog is attached to the main window"). + AttachToWindow(app.Window.Current()). + Show() + }) + + menu.AddSeparator() + menu.Add("Quit").OnClick(func(ctx *application.Context) { + app.Quit() + }) + + window := app.Window.NewWithOptions(application.WebviewWindowOptions{ + Title: "Info Dialog Tests", + Width: 400, + Height: 200, + Linux: application.LinuxWindow{ + MenuStyle: application.LinuxMenuStylePrimaryMenu, + }, + }) + window.SetMenu(menu) + + log.Println("Info Dialog Tests") + log.Println("Use the Tests menu to run each test case") + + if err := app.Run(); err != nil { + log.Fatal(err) + } +} diff --git a/v3/test/manual/dialog/message-question/main.go b/v3/test/manual/dialog/message-question/main.go new file mode 100644 index 000000000..42dff6c06 --- /dev/null +++ b/v3/test/manual/dialog/message-question/main.go @@ -0,0 +1,134 @@ +package main + +import ( + "log" + + "github.com/wailsapp/wails/v3/pkg/application" + "github.com/wailsapp/wails/v3/pkg/icons" +) + +func main() { + app := application.New(application.Options{ + Name: "Dialog Test - Question", + Assets: application.AlphaAssets, + }) + + menu := app.NewMenu() + + testMenu := menu.AddSubmenu("Tests") + + testMenu.Add("Two Buttons").OnClick(func(ctx *application.Context) { + dialog := app.Dialog.Question(). + SetTitle("Question"). + SetMessage("Do you want to proceed?") + dialog.AddButton("Yes").OnClick(func() { + app.Dialog.Info().SetMessage("You clicked Yes").Show() + }) + dialog.AddButton("No").OnClick(func() { + app.Dialog.Info().SetMessage("You clicked No").Show() + }) + dialog.Show() + }) + + testMenu.Add("Three Buttons").OnClick(func(ctx *application.Context) { + dialog := app.Dialog.Question(). + SetTitle("Save Changes?"). + SetMessage("You have unsaved changes") + dialog.AddButton("Save").OnClick(func() { + app.Dialog.Info().SetMessage("Saving...").Show() + }) + dialog.AddButton("Don't Save").OnClick(func() { + app.Dialog.Info().SetMessage("Discarding changes").Show() + }) + dialog.AddButton("Cancel") + dialog.Show() + }) + + testMenu.Add("With Default Button").OnClick(func(ctx *application.Context) { + dialog := app.Dialog.Question(). + SetTitle("Confirm"). + SetMessage("Press Enter to select the default button") + dialog.AddButton("OK") + no := dialog.AddButton("Cancel") + dialog.SetDefaultButton(no) + dialog.Show() + }) + + testMenu.Add("With Cancel Button (Escape)").OnClick(func(ctx *application.Context) { + dialog := app.Dialog.Question(). + SetTitle("Escape Test"). + SetMessage("Press Escape to cancel") + ok := dialog.AddButton("OK").OnClick(func() { + app.Dialog.Info().SetMessage("OK clicked").Show() + }) + cancel := dialog.AddButton("Cancel").OnClick(func() { + app.Dialog.Info().SetMessage("Cancelled").Show() + }) + dialog.SetDefaultButton(ok) + dialog.SetCancelButton(cancel) + dialog.Show() + }) + + testMenu.Add("Custom Icon").OnClick(func(ctx *application.Context) { + dialog := app.Dialog.Question(). + SetTitle("Custom Icon"). + SetMessage("This question has a custom icon"). + SetIcon(icons.WailsLogoWhiteTransparent) + dialog.AddButton("Nice!").OnClick(func() { + app.Dialog.Info().SetMessage("Thanks!").Show() + }) + dialog.AddButton("Meh") + dialog.Show() + }) + + testMenu.Add("Attached to Window").OnClick(func(ctx *application.Context) { + dialog := app.Dialog.Question(). + SetTitle("Attached"). + SetMessage("This dialog is attached to the window"). + AttachToWindow(app.Window.Current()) + dialog.AddButton("OK") + dialog.AddButton("Cancel") + dialog.Show() + }) + + testMenu.Add("Button Callbacks").OnClick(func(ctx *application.Context) { + dialog := app.Dialog.Question(). + SetTitle("Callbacks"). + SetMessage("Each button has a callback") + dialog.AddButton("Option A").OnClick(func() { + log.Println("Option A selected") + app.Dialog.Info().SetMessage("You chose Option A").Show() + }) + dialog.AddButton("Option B").OnClick(func() { + log.Println("Option B selected") + app.Dialog.Info().SetMessage("You chose Option B").Show() + }) + dialog.AddButton("Option C").OnClick(func() { + log.Println("Option C selected") + app.Dialog.Info().SetMessage("You chose Option C").Show() + }) + dialog.Show() + }) + + testMenu.AddSeparator() + testMenu.Add("Quit").OnClick(func(ctx *application.Context) { + app.Quit() + }) + + window := app.Window.NewWithOptions(application.WebviewWindowOptions{ + Title: "Question Dialog Tests", + Width: 400, + Height: 200, + Linux: application.LinuxWindow{ + MenuStyle: application.LinuxMenuStylePrimaryMenu, + }, + }) + window.SetMenu(menu) + + log.Println("Question Dialog Tests") + log.Println("Use the Tests menu to run each test case") + + if err := app.Run(); err != nil { + log.Fatal(err) + } +} diff --git a/v3/test/manual/dialog/message-warning/main.go b/v3/test/manual/dialog/message-warning/main.go new file mode 100644 index 000000000..67e8f2623 --- /dev/null +++ b/v3/test/manual/dialog/message-warning/main.go @@ -0,0 +1,85 @@ +package main + +import ( + "log" + + "github.com/wailsapp/wails/v3/pkg/application" + "github.com/wailsapp/wails/v3/pkg/icons" +) + +func main() { + app := application.New(application.Options{ + Name: "Dialog Test - Warning", + Assets: application.AlphaAssets, + }) + + menu := app.NewMenu() + + + + menu.Add("Basic Warning").OnClick(func(ctx *application.Context) { + app.Dialog.Warning(). + SetTitle("Warning"). + SetMessage("This is a warning message"). + Show() + }) + + menu.Add("Title Only").OnClick(func(ctx *application.Context) { + app.Dialog.Warning(). + SetTitle("Warning - Title Only"). + Show() + }) + + menu.Add("Message Only").OnClick(func(ctx *application.Context) { + app.Dialog.Warning(). + SetMessage("Warning message without title"). + Show() + }) + + menu.Add("Custom Icon").OnClick(func(ctx *application.Context) { + app.Dialog.Warning(). + SetTitle("Custom Warning Icon"). + SetMessage("This warning has a custom icon"). + SetIcon(icons.ApplicationLightMode256). + Show() + }) + + menu.Add("Long Warning").OnClick(func(ctx *application.Context) { + app.Dialog.Warning(). + SetTitle("Important Warning"). + SetMessage("This is an important warning that contains a lot of text. " + + "You should read this carefully before proceeding. " + + "Ignoring this warning may result in unexpected behavior."). + Show() + }) + + menu.Add("Attached to Window").OnClick(func(ctx *application.Context) { + app.Dialog.Warning(). + SetTitle("Attached Warning"). + SetMessage("This warning is attached to the main window"). + AttachToWindow(app.Window.Current()). + Show() + }) + + menu.AddSeparator() + menu.Add("Quit").OnClick(func(ctx *application.Context) { + app.Quit() + }) + + window := app.Window.NewWithOptions(application.WebviewWindowOptions{ + Title: "Warning Dialog Tests", + Width: 400, + Height: 200, + Linux: application.LinuxWindow{ + MenuStyle: application.LinuxMenuStylePrimaryMenu, + }, + }) + window.SetMenu(menu) + + log.Println("Warning Dialog Tests") + log.Println("Use the Tests menu to run each test case") + + if err := app.Run(); err != nil { + log.Fatal(err) + } +} diff --git a/v3/test/manual/systray/.task/checksum/build-custom-handlers-gtk3 b/v3/test/manual/systray/.task/checksum/build-custom-handlers-gtk3 new file mode 100644 index 000000000..ac32ec4ce --- /dev/null +++ b/v3/test/manual/systray/.task/checksum/build-custom-handlers-gtk3 @@ -0,0 +1 @@ +56e330435e9c161841e231a8a3109528 diff --git a/v3/test/manual/systray/.task/checksum/build-custom-handlers-gtk4 b/v3/test/manual/systray/.task/checksum/build-custom-handlers-gtk4 new file mode 100644 index 000000000..ac32ec4ce --- /dev/null +++ b/v3/test/manual/systray/.task/checksum/build-custom-handlers-gtk4 @@ -0,0 +1 @@ +56e330435e9c161841e231a8a3109528 diff --git a/v3/test/manual/systray/.task/checksum/build-hide-options-gtk3 b/v3/test/manual/systray/.task/checksum/build-hide-options-gtk3 new file mode 100644 index 000000000..37796fa2a --- /dev/null +++ b/v3/test/manual/systray/.task/checksum/build-hide-options-gtk3 @@ -0,0 +1 @@ +ffabb1e7ef242fd5215ad8671c49b38b diff --git a/v3/test/manual/systray/.task/checksum/build-hide-options-gtk4 b/v3/test/manual/systray/.task/checksum/build-hide-options-gtk4 new file mode 100644 index 000000000..37796fa2a --- /dev/null +++ b/v3/test/manual/systray/.task/checksum/build-hide-options-gtk4 @@ -0,0 +1 @@ +ffabb1e7ef242fd5215ad8671c49b38b diff --git a/v3/test/manual/systray/.task/checksum/build-menu-only-gtk3 b/v3/test/manual/systray/.task/checksum/build-menu-only-gtk3 new file mode 100644 index 000000000..b4d246ba9 --- /dev/null +++ b/v3/test/manual/systray/.task/checksum/build-menu-only-gtk3 @@ -0,0 +1 @@ +88e3074cc3503a9aaade145c12213e8d diff --git a/v3/test/manual/systray/.task/checksum/build-menu-only-gtk4 b/v3/test/manual/systray/.task/checksum/build-menu-only-gtk4 new file mode 100644 index 000000000..b4d246ba9 --- /dev/null +++ b/v3/test/manual/systray/.task/checksum/build-menu-only-gtk4 @@ -0,0 +1 @@ +88e3074cc3503a9aaade145c12213e8d diff --git a/v3/test/manual/systray/.task/checksum/build-window-menu-gtk3 b/v3/test/manual/systray/.task/checksum/build-window-menu-gtk3 new file mode 100644 index 000000000..684a41ed2 --- /dev/null +++ b/v3/test/manual/systray/.task/checksum/build-window-menu-gtk3 @@ -0,0 +1 @@ +e8f8e8b2142681a880a3e91012f73f8d diff --git a/v3/test/manual/systray/.task/checksum/build-window-menu-gtk4 b/v3/test/manual/systray/.task/checksum/build-window-menu-gtk4 new file mode 100644 index 000000000..684a41ed2 --- /dev/null +++ b/v3/test/manual/systray/.task/checksum/build-window-menu-gtk4 @@ -0,0 +1 @@ +e8f8e8b2142681a880a3e91012f73f8d diff --git a/v3/test/manual/systray/.task/checksum/build-window-only-gtk3 b/v3/test/manual/systray/.task/checksum/build-window-only-gtk3 new file mode 100644 index 000000000..d4e432741 --- /dev/null +++ b/v3/test/manual/systray/.task/checksum/build-window-only-gtk3 @@ -0,0 +1 @@ +cc2cc0be9fcf830e23609d4bd8efff14 diff --git a/v3/test/manual/systray/.task/checksum/build-window-only-gtk4 b/v3/test/manual/systray/.task/checksum/build-window-only-gtk4 new file mode 100644 index 000000000..d4e432741 --- /dev/null +++ b/v3/test/manual/systray/.task/checksum/build-window-only-gtk4 @@ -0,0 +1 @@ +cc2cc0be9fcf830e23609d4bd8efff14 diff --git a/v3/test/manual/systray/README.md b/v3/test/manual/systray/README.md new file mode 100644 index 000000000..c802471c4 --- /dev/null +++ b/v3/test/manual/systray/README.md @@ -0,0 +1,157 @@ +# Systray Manual Tests + +Comprehensive test suite for the Systray API v2 implementation. + +## Building + +```bash +cd v3/test/manual/systray +task build:all +``` + +Binaries are output to `bin/` directory with GTK3/GTK4 variants. + +## Test Scenarios + +### 1. window-only + +Tests systray with only an attached window (no menu). + +| Action | Expected Behavior | +|--------|-------------------| +| Left-click | Toggle window visibility | +| Right-click | Nothing | +| Double-click | Nothing | + +### 2. menu-only + +Tests systray with only a menu (no attached window). + +| Action | Expected Behavior | +|--------|-------------------| +| Left-click | Nothing | +| Right-click | Show menu | +| Double-click | Nothing | + +### 3. window-menu + +Tests systray with both attached window and menu. + +| Action | Expected Behavior | +|--------|-------------------| +| Left-click | Toggle window visibility | +| Right-click | Show menu | +| Double-click | Nothing | + +### 4. custom-handlers + +Tests custom click handlers overriding smart defaults. Demonstrates that custom handlers +can add logging/analytics while still using the standard systray methods. + +| Action | Expected Behavior | +|--------|-------------------| +| Left-click | Custom handler logs + toggles window | +| Right-click | Custom handler logs + opens menu | +| Double-click | Logs to console | + +### 5. hide-options + +Tests `HideOnEscape` and `HideOnFocusLost` window options. + +| Action | Expected Behavior | +|--------|-------------------| +| Left-click systray | Toggle window | +| Press Escape | Hide window | +| Click outside | Hide window (standard WMs only) | + +## Platform Test Matrix + +### Desktop Environments + +| Test | GNOME | KDE | XFCE | Hyprland | Sway | i3 | +|------|-------|-----|------|----------|------|-----| +| window-only | | | | | | | +| menu-only | | | | | | | +| window-menu | | | | | | | +| custom-handlers | | | | | | | +| hide-options | | | | | | | + +### GTK Version Matrix + +| Test | GTK4 | GTK3 | +|------|------|------| +| window-only | | | +| menu-only | | | +| window-menu | | | +| custom-handlers | | | +| hide-options | | | + +## Focus-Follows-Mouse Behavior + +On tiling WMs with focus-follows-mouse (Hyprland, Sway, i3): + +- `HideOnFocusLost` is **automatically disabled** +- This prevents the window from hiding immediately when the mouse moves away +- `HideOnEscape` still works normally + +### Testing HideOnFocusLost + +1. **Standard WM (GNOME, KDE)**: + - Run `hide-options` test + - Click systray to show window + - Click anywhere outside the window + - Window should hide + +2. **Tiling WM (Hyprland, Sway, i3)**: + - Run `hide-options` test + - Click systray to show window + - Move mouse outside window + - Window should NOT hide (feature disabled) + - Press Escape to hide (still works) + +## Checklist for Full Verification + +### Per-Environment Checklist + +- [ ] Systray icon appears in system tray +- [ ] Left-click behavior matches expected +- [ ] Right-click behavior matches expected +- [ ] Window appears near systray icon (not random position) +- [ ] Window stays on top when shown +- [ ] Multiple show/hide cycles work correctly +- [ ] Menu items are clickable and work +- [ ] Application quits cleanly + +### Hide Options Specific + +- [ ] Escape key hides window +- [ ] Focus lost hides window (standard WMs) +- [ ] Focus lost does NOT hide window (tiling WMs) +- [ ] Re-clicking systray after hide works + +### Known Issues + +Document any issues found during testing: + +``` +[Environment] [GTK Version] [Test] - Issue description +Example: Hyprland GTK4 window-menu - Menu appears at wrong position +``` + +## Running Individual Tests + +```bash +# GTK4 (default) +./bin/window-only-gtk4 +./bin/menu-only-gtk4 +./bin/window-menu-gtk4 +./bin/custom-handlers-gtk4 +./bin/hide-options-gtk4 + +# GTK3 +./bin/window-only-gtk3 +./bin/menu-only-gtk3 +./bin/window-menu-gtk3 +./bin/custom-handlers-gtk3 +./bin/hide-options-gtk3 +``` diff --git a/v3/test/manual/systray/Taskfile.yaml b/v3/test/manual/systray/Taskfile.yaml new file mode 100644 index 000000000..603d4143e --- /dev/null +++ b/v3/test/manual/systray/Taskfile.yaml @@ -0,0 +1,99 @@ +version: "3" + +vars: + BIN_DIR: "{{.ROOT_DIR}}/bin" + +tasks: + default: + desc: Build all systray tests for GTK3 and GTK4 + cmds: + - task: build:all + + build:all: + desc: Build all tests for both GTK3 and GTK4 + deps: + - build:gtk4 + - build:gtk3 + + build:gtk4: + desc: Build all tests for GTK4 + cmds: + - task: build:window-only-gtk4 + - task: build:menu-only-gtk4 + - task: build:window-menu-gtk4 + - task: build:custom-handlers-gtk4 + - task: build:hide-options-gtk4 + + build:gtk3: + desc: Build all tests for GTK3 + cmds: + - task: build:window-only-gtk3 + - task: build:menu-only-gtk3 + - task: build:window-menu-gtk3 + - task: build:custom-handlers-gtk3 + - task: build:hide-options-gtk3 + + build:window-only-gtk4: + desc: Build window-only test (GTK4) + dir: window-only + cmds: + - go build -o "{{.BIN_DIR}}/window-only-gtk4" . + + build:window-only-gtk3: + desc: Build window-only test (GTK3) + dir: window-only + cmds: + - go build -tags gtk3 -o "{{.BIN_DIR}}/window-only-gtk3" . + + build:menu-only-gtk4: + desc: Build menu-only test (GTK4) + dir: menu-only + cmds: + - go build -o "{{.BIN_DIR}}/menu-only-gtk4" . + + build:menu-only-gtk3: + desc: Build menu-only test (GTK3) + dir: menu-only + cmds: + - go build -tags gtk3 -o "{{.BIN_DIR}}/menu-only-gtk3" . + + build:window-menu-gtk4: + desc: Build window-menu test (GTK4) + dir: window-menu + cmds: + - go build -o "{{.BIN_DIR}}/window-menu-gtk4" . + + build:window-menu-gtk3: + desc: Build window-menu test (GTK3) + dir: window-menu + cmds: + - go build -tags gtk3 -o "{{.BIN_DIR}}/window-menu-gtk3" . + + build:custom-handlers-gtk4: + desc: Build custom-handlers test (GTK4) + dir: custom-handlers + cmds: + - go build -o "{{.BIN_DIR}}/custom-handlers-gtk4" . + + build:custom-handlers-gtk3: + desc: Build custom-handlers test (GTK3) + dir: custom-handlers + cmds: + - go build -tags gtk3 -o "{{.BIN_DIR}}/custom-handlers-gtk3" . + + build:hide-options-gtk4: + desc: Build hide-options test (GTK4) + dir: hide-options + cmds: + - go build -o "{{.BIN_DIR}}/hide-options-gtk4" . + + build:hide-options-gtk3: + desc: Build hide-options test (GTK3) + dir: hide-options + cmds: + - go build -tags gtk3 -o "{{.BIN_DIR}}/hide-options-gtk3" . + + clean: + desc: Remove all built binaries + cmds: + - rm -rf "{{.BIN_DIR}}" diff --git a/v3/test/manual/systray/custom-handlers/main.go b/v3/test/manual/systray/custom-handlers/main.go new file mode 100644 index 000000000..b3d471b23 --- /dev/null +++ b/v3/test/manual/systray/custom-handlers/main.go @@ -0,0 +1,80 @@ +package main + +import ( + _ "embed" + "log" + "runtime" + + "github.com/wailsapp/wails/v3/pkg/application" + "github.com/wailsapp/wails/v3/pkg/events" + "github.com/wailsapp/wails/v3/pkg/icons" +) + +func main() { + app := application.New(application.Options{ + Name: "Systray Custom Handlers", + Description: "Tests systray with custom click handlers overriding defaults", + Assets: application.AlphaAssets, + Mac: application.MacOptions{ + ActivationPolicy: application.ActivationPolicyAccessory, + }, + }) + + systray := app.SystemTray.New() + + window := app.Window.NewWithOptions(application.WebviewWindowOptions{ + Width: 400, + Height: 300, + Name: "Custom Handlers Test", + Title: "Custom Handlers - Check console for click events", + Frameless: true, + AlwaysOnTop: true, + Hidden: true, + DisableResize: true, + Windows: application.WindowsWindow{ + HiddenOnTaskbar: true, + }, + }) + + window.RegisterHook(events.Common.WindowClosing, func(e *application.WindowEvent) { + window.Hide() + e.Cancel() + }) + + menu := app.Menu.New() + menu.Add("Quit").OnClick(func(ctx *application.Context) { + app.Quit() + }) + + if runtime.GOOS == "darwin" { + systray.SetTemplateIcon(icons.SystrayMacTemplate) + } + + systray.AttachWindow(window).WindowOffset(5).SetMenu(menu) + + systray.OnClick(func() { + log.Println("Custom left-click handler called!") + log.Println(" -> Toggling window (custom behavior with logging)") + systray.ToggleWindow() + }) + + systray.OnRightClick(func() { + log.Println("Custom right-click handler called!") + log.Println(" -> Opening menu (custom behavior)") + systray.OpenMenu() + }) + + systray.OnDoubleClick(func() { + log.Println("Double-click detected!") + }) + + log.Println("Custom handlers test started") + log.Println("Expected behavior:") + log.Println(" - Left-click: Custom handler logs + toggles window") + log.Println(" - Right-click: Custom handler logs + opens menu") + log.Println(" - Double-click: Logs to console") + + if err := app.Run(); err != nil { + log.Fatal(err) + } +} diff --git a/v3/test/manual/systray/hide-options/main.go b/v3/test/manual/systray/hide-options/main.go new file mode 100644 index 000000000..864b65b04 --- /dev/null +++ b/v3/test/manual/systray/hide-options/main.go @@ -0,0 +1,65 @@ +package main + +import ( + _ "embed" + "log" + "runtime" + + "github.com/wailsapp/wails/v3/pkg/application" + "github.com/wailsapp/wails/v3/pkg/events" + "github.com/wailsapp/wails/v3/pkg/icons" +) + +func main() { + app := application.New(application.Options{ + Name: "Systray Hide Options", + Description: "Tests HideOnEscape and HideOnFocusLost options", + Assets: application.AlphaAssets, + Mac: application.MacOptions{ + ActivationPolicy: application.ActivationPolicyAccessory, + }, + }) + + systray := app.SystemTray.New() + + window := app.Window.NewWithOptions(application.WebviewWindowOptions{ + Width: 400, + Height: 300, + Name: "Hide Options Test", + Title: "Press Escape or click outside to hide", + Frameless: true, + AlwaysOnTop: true, + Hidden: true, + DisableResize: true, + HideOnEscape: true, + HideOnFocusLost: true, + Windows: application.WindowsWindow{ + HiddenOnTaskbar: true, + }, + }) + + window.RegisterHook(events.Common.WindowClosing, func(e *application.WindowEvent) { + window.Hide() + e.Cancel() + }) + + if runtime.GOOS == "darwin" { + systray.SetTemplateIcon(icons.SystrayMacTemplate) + } + + systray.AttachWindow(window).WindowOffset(5) + + log.Println("Hide options test started") + log.Println("Expected behavior:") + log.Println(" - Left-click systray: Toggle window") + log.Println(" - Press Escape: Hide window (HideOnEscape)") + log.Println(" - Click outside window: Hide window (HideOnFocusLost)") + log.Println("") + log.Println("NOTE: On focus-follows-mouse WMs (Hyprland, Sway, i3),") + log.Println(" HideOnFocusLost is automatically disabled to prevent") + log.Println(" immediate hiding when mouse moves away.") + + if err := app.Run(); err != nil { + log.Fatal(err) + } +} diff --git a/v3/test/manual/systray/menu-only/main.go b/v3/test/manual/systray/menu-only/main.go new file mode 100644 index 000000000..b8af69e4d --- /dev/null +++ b/v3/test/manual/systray/menu-only/main.go @@ -0,0 +1,50 @@ +package main + +import ( + _ "embed" + "log" + "runtime" + + "github.com/wailsapp/wails/v3/pkg/application" + "github.com/wailsapp/wails/v3/pkg/icons" +) + +func main() { + app := application.New(application.Options{ + Name: "Systray Menu Only", + Description: "Tests systray with menu only (no attached window)", + Assets: application.AlphaAssets, + Mac: application.MacOptions{ + ActivationPolicy: application.ActivationPolicyAccessory, + }, + }) + + systray := app.SystemTray.New() + + menu := app.Menu.New() + menu.Add("Action 1").OnClick(func(ctx *application.Context) { + log.Println("Action 1 clicked") + }) + menu.Add("Action 2").OnClick(func(ctx *application.Context) { + log.Println("Action 2 clicked") + }) + menu.AddSeparator() + menu.Add("Quit").OnClick(func(ctx *application.Context) { + app.Quit() + }) + + if runtime.GOOS == "darwin" { + systray.SetTemplateIcon(icons.SystrayMacTemplate) + } + + systray.SetMenu(menu) + + log.Println("Menu-only test started") + log.Println("Expected behavior:") + log.Println(" - Left-click: Nothing (no window)") + log.Println(" - Right-click: Show menu") + + if err := app.Run(); err != nil { + log.Fatal(err) + } +} diff --git a/v3/test/manual/systray/window-menu/main.go b/v3/test/manual/systray/window-menu/main.go new file mode 100644 index 000000000..bbf208a2a --- /dev/null +++ b/v3/test/manual/systray/window-menu/main.go @@ -0,0 +1,70 @@ +package main + +import ( + _ "embed" + "log" + "runtime" + + "github.com/wailsapp/wails/v3/pkg/application" + "github.com/wailsapp/wails/v3/pkg/events" + "github.com/wailsapp/wails/v3/pkg/icons" +) + +func main() { + app := application.New(application.Options{ + Name: "Systray Window + Menu", + Description: "Tests systray with both attached window and menu", + Assets: application.AlphaAssets, + Mac: application.MacOptions{ + ActivationPolicy: application.ActivationPolicyAccessory, + }, + }) + + systray := app.SystemTray.New() + + window := app.Window.NewWithOptions(application.WebviewWindowOptions{ + Width: 400, + Height: 300, + Name: "Window Menu Test", + Title: "Window + Menu - Left-click toggles, Right-click shows menu", + Frameless: true, + AlwaysOnTop: true, + Hidden: true, + DisableResize: true, + Windows: application.WindowsWindow{ + HiddenOnTaskbar: true, + }, + }) + + window.RegisterHook(events.Common.WindowClosing, func(e *application.WindowEvent) { + window.Hide() + e.Cancel() + }) + + menu := app.Menu.New() + menu.Add("Show Window").OnClick(func(ctx *application.Context) { + systray.ShowWindow() + }) + menu.Add("Hide Window").OnClick(func(ctx *application.Context) { + systray.HideWindow() + }) + menu.AddSeparator() + menu.Add("Quit").OnClick(func(ctx *application.Context) { + app.Quit() + }) + + if runtime.GOOS == "darwin" { + systray.SetTemplateIcon(icons.SystrayMacTemplate) + } + + systray.AttachWindow(window).WindowOffset(5).SetMenu(menu) + + log.Println("Window + Menu test started") + log.Println("Expected behavior:") + log.Println(" - Left-click: Toggle window visibility") + log.Println(" - Right-click: Show menu") + + if err := app.Run(); err != nil { + log.Fatal(err) + } +} diff --git a/v3/test/manual/systray/window-only/main.go b/v3/test/manual/systray/window-only/main.go new file mode 100644 index 000000000..b645bfa9f --- /dev/null +++ b/v3/test/manual/systray/window-only/main.go @@ -0,0 +1,58 @@ +package main + +import ( + _ "embed" + "log" + "runtime" + + "github.com/wailsapp/wails/v3/pkg/application" + "github.com/wailsapp/wails/v3/pkg/events" + "github.com/wailsapp/wails/v3/pkg/icons" +) + +func main() { + app := application.New(application.Options{ + Name: "Systray Window Only", + Description: "Tests systray with attached window only (no menu)", + Assets: application.AlphaAssets, + Mac: application.MacOptions{ + ActivationPolicy: application.ActivationPolicyAccessory, + }, + }) + + systray := app.SystemTray.New() + + window := app.Window.NewWithOptions(application.WebviewWindowOptions{ + Width: 400, + Height: 300, + Name: "Window Only Test", + Title: "Window Only - Left-click systray to toggle", + Frameless: true, + AlwaysOnTop: true, + Hidden: true, + DisableResize: true, + Windows: application.WindowsWindow{ + HiddenOnTaskbar: true, + }, + }) + + window.RegisterHook(events.Common.WindowClosing, func(e *application.WindowEvent) { + window.Hide() + e.Cancel() + }) + + if runtime.GOOS == "darwin" { + systray.SetTemplateIcon(icons.SystrayMacTemplate) + } + + systray.AttachWindow(window).WindowOffset(5) + + log.Println("Window-only test started") + log.Println("Expected behavior:") + log.Println(" - Left-click: Toggle window visibility") + log.Println(" - Right-click: Nothing (no menu)") + + if err := app.Run(); err != nil { + log.Fatal(err) + } +} diff --git a/v3/tests/gtk4-benchmark/.gitignore b/v3/tests/gtk4-benchmark/.gitignore new file mode 100644 index 000000000..25759c424 --- /dev/null +++ b/v3/tests/gtk4-benchmark/.gitignore @@ -0,0 +1,3 @@ +# Compiled binaries +benchmark-gtk3 +benchmark-gtk4 diff --git a/v3/tests/gtk4-benchmark/README.md b/v3/tests/gtk4-benchmark/README.md new file mode 100644 index 000000000..1b8c421d9 --- /dev/null +++ b/v3/tests/gtk4-benchmark/README.md @@ -0,0 +1,75 @@ +# GTK3 vs GTK4 Benchmark + +This benchmark suite compares the performance of Wails applications running on GTK3 vs GTK4. + +## Building + +Build both versions: + +```bash +# Build GTK3 version (default) +go build -o benchmark-gtk3 . + +# Build GTK4 version (experimental) +go build -tags gtk4 -o benchmark-gtk4 . +``` + +## Running Benchmarks + +Run each version to generate a report: + +```bash +# Run GTK4 benchmark +./benchmark-gtk4 + +# Run GTK3 benchmark +./benchmark-gtk3 +``` + +Each run will: +1. Display results in the console +2. Save a JSON report file (e.g., `benchmark-GTK4-WebKitGTK-6.0-20240115-143052.json`) + +## Comparing Results + +Use the comparison tool to analyze two reports: + +```bash +go run compare.go benchmark-GTK3-*.json benchmark-GTK4-*.json +``` + +This will output a side-by-side comparison showing: +- Average times for each benchmark +- Percentage change between GTK3 and GTK4 +- Summary of improvements and regressions + +## Benchmarks Included + +| Benchmark | Description | +|-----------|-------------| +| Screen Enumeration | Query all connected screens | +| Primary Screen Query | Get the primary display | +| Window Create/Destroy | Create and close windows | +| Window SetSize | Resize window operations | +| Window SetTitle | Update window title | +| Window Size Query | Get current window dimensions | +| Window Position Query | Get current window position | +| Window Center | Center window on screen | +| Window Show/Hide | Toggle window visibility | +| Menu Creation (Simple) | Create basic menus | +| Menu Creation (Complex) | Create nested menu structures | +| Menu with Accelerators | Menus with keyboard shortcuts | +| Event Emit | Dispatch custom events | +| Event Emit+Receive | Round-trip event handling | +| Dialog Setup (Info) | Create info dialog | +| Dialog Setup (Question) | Create question dialog | + +## Expected Results + +GTK4 improvements typically include: +- Better Wayland support +- Improved GPU rendering pipeline +- More efficient event dispatch +- Better fractional scaling support + +Performance varies by operation - some may be faster in GTK4, others similar to GTK3. diff --git a/v3/tests/gtk4-benchmark/assets/index.html b/v3/tests/gtk4-benchmark/assets/index.html new file mode 100644 index 000000000..d247170bd --- /dev/null +++ b/v3/tests/gtk4-benchmark/assets/index.html @@ -0,0 +1,46 @@ + + + + + GTK Benchmark + + + +

                    GTK Benchmark Suite

                    +
                    +

                    Running benchmarks... Check console for results.

                    + + diff --git a/v3/tests/gtk4-benchmark/benchmark-GTK3-WebKit2GTK-4.1-20260111-222734.json b/v3/tests/gtk4-benchmark/benchmark-GTK3-WebKit2GTK-4.1-20260111-222734.json new file mode 100644 index 000000000..0fc38cc76 --- /dev/null +++ b/v3/tests/gtk4-benchmark/benchmark-GTK3-WebKit2GTK-4.1-20260111-222734.json @@ -0,0 +1,136 @@ +{ + "gtk_version": "GTK3 (WebKit2GTK 4.1)", + "platform": "linux/amd64", + "go_version": "go1.25.4", + "timestamp": "2026-01-11T22:27:34.842898202+11:00", + "results": [ + { + "name": "Screen Enumeration", + "iterations": 100, + "total_time_ns": 167481, + "avg_time_ns": 1674, + "min_time_ns": 50, + "max_time_ns": 161808 + }, + { + "name": "Primary Screen Query", + "iterations": 100, + "total_time_ns": 6710, + "avg_time_ns": 67, + "min_time_ns": 40, + "max_time_ns": 1422 + }, + { + "name": "Window Create/Destroy", + "iterations": 20, + "total_time_ns": 433715992, + "avg_time_ns": 21685799, + "min_time_ns": 21370109, + "max_time_ns": 22185831 + }, + { + "name": "Window SetSize", + "iterations": 50, + "total_time_ns": 6996039, + "avg_time_ns": 139920, + "min_time_ns": 104358, + "max_time_ns": 1173112 + }, + { + "name": "Window SetTitle", + "iterations": 100, + "total_time_ns": 3398274, + "avg_time_ns": 33982, + "min_time_ns": 30308, + "max_time_ns": 59092 + }, + { + "name": "Window Size Query", + "iterations": 100, + "total_time_ns": 2871777, + "avg_time_ns": 28717, + "min_time_ns": 26229, + "max_time_ns": 37732 + }, + { + "name": "Window Position Query", + "iterations": 100, + "total_time_ns": 3027183, + "avg_time_ns": 30271, + "min_time_ns": 26841, + "max_time_ns": 142271 + }, + { + "name": "Window Center", + "iterations": 50, + "total_time_ns": 1615738, + "avg_time_ns": 32314, + "min_time_ns": 29016, + "max_time_ns": 52470 + }, + { + "name": "Window Show/Hide", + "iterations": 20, + "total_time_ns": 276611193, + "avg_time_ns": 13830559, + "min_time_ns": 10472545, + "max_time_ns": 39370867 + }, + { + "name": "Menu Creation (Simple)", + "iterations": 50, + "total_time_ns": 129326, + "avg_time_ns": 2586, + "min_time_ns": 250, + "max_time_ns": 76175 + }, + { + "name": "Menu Creation (Complex)", + "iterations": 20, + "total_time_ns": 460375, + "avg_time_ns": 23018, + "min_time_ns": 16171, + "max_time_ns": 60314 + }, + { + "name": "Menu with Accelerators", + "iterations": 50, + "total_time_ns": 106064, + "avg_time_ns": 2121, + "min_time_ns": 1172, + "max_time_ns": 8597 + }, + { + "name": "Event Emit", + "iterations": 100, + "total_time_ns": 1142611, + "avg_time_ns": 11426, + "min_time_ns": 541, + "max_time_ns": 506173 + }, + { + "name": "Event Emit+Receive", + "iterations": 50, + "total_time_ns": 395172, + "avg_time_ns": 7903, + "min_time_ns": 1042, + "max_time_ns": 105200 + }, + { + "name": "Dialog Setup (Info)", + "iterations": 20, + "total_time_ns": 1352, + "avg_time_ns": 67, + "min_time_ns": 50, + "max_time_ns": 290 + }, + { + "name": "Dialog Setup (Question)", + "iterations": 20, + "total_time_ns": 1024, + "avg_time_ns": 51, + "min_time_ns": 50, + "max_time_ns": 71 + } + ] +} \ No newline at end of file diff --git a/v3/tests/gtk4-benchmark/benchmark-GTK4-WebKitGTK-6.0-20260111-222428.json b/v3/tests/gtk4-benchmark/benchmark-GTK4-WebKitGTK-6.0-20260111-222428.json new file mode 100644 index 000000000..53a5ce944 --- /dev/null +++ b/v3/tests/gtk4-benchmark/benchmark-GTK4-WebKitGTK-6.0-20260111-222428.json @@ -0,0 +1,136 @@ +{ + "gtk_version": "GTK4 (WebKitGTK 6.0)", + "platform": "linux/amd64", + "go_version": "go1.25.4", + "timestamp": "2026-01-11T22:24:28.770802311+11:00", + "results": [ + { + "name": "Screen Enumeration", + "iterations": 100, + "total_time_ns": 49065976, + "avg_time_ns": 490659, + "min_time_ns": 40, + "max_time_ns": 49060802 + }, + { + "name": "Primary Screen Query", + "iterations": 100, + "total_time_ns": 4778, + "avg_time_ns": 47, + "min_time_ns": 40, + "max_time_ns": 110 + }, + { + "name": "Window Create/Destroy", + "iterations": 20, + "total_time_ns": 3783355772, + "avg_time_ns": 189167788, + "min_time_ns": 82048294, + "max_time_ns": 359631289 + }, + { + "name": "Window SetSize", + "iterations": 50, + "total_time_ns": 189389209, + "avg_time_ns": 3787784, + "min_time_ns": 113717, + "max_time_ns": 148270567 + }, + { + "name": "Window SetTitle", + "iterations": 100, + "total_time_ns": 3940155, + "avg_time_ns": 39401, + "min_time_ns": 32061, + "max_time_ns": 127723 + }, + { + "name": "Window Size Query", + "iterations": 100, + "total_time_ns": 3187990, + "avg_time_ns": 31879, + "min_time_ns": 28244, + "max_time_ns": 95472 + }, + { + "name": "Window Position Query", + "iterations": 100, + "total_time_ns": 3157760, + "avg_time_ns": 31577, + "min_time_ns": 27572, + "max_time_ns": 52790 + }, + { + "name": "Window Center", + "iterations": 50, + "total_time_ns": 1670267, + "avg_time_ns": 33405, + "min_time_ns": 29256, + "max_time_ns": 51037 + }, + { + "name": "Window Show/Hide", + "iterations": 20, + "total_time_ns": 149208499897, + "avg_time_ns": 7460424994, + "min_time_ns": 10363207, + "max_time_ns": 145362924705 + }, + { + "name": "Menu Creation (Simple)", + "iterations": 50, + "total_time_ns": 115039, + "avg_time_ns": 2300, + "min_time_ns": 471, + "max_time_ns": 23715 + }, + { + "name": "Menu Creation (Complex)", + "iterations": 20, + "total_time_ns": 1340059, + "avg_time_ns": 67002, + "min_time_ns": 23926, + "max_time_ns": 634788 + }, + { + "name": "Menu with Accelerators", + "iterations": 50, + "total_time_ns": 131468, + "avg_time_ns": 2629, + "min_time_ns": 1513, + "max_time_ns": 11362 + }, + { + "name": "Event Emit", + "iterations": 100, + "total_time_ns": 688025, + "avg_time_ns": 6880, + "min_time_ns": 681, + "max_time_ns": 115830 + }, + { + "name": "Event Emit+Receive", + "iterations": 50, + "total_time_ns": 1186158, + "avg_time_ns": 23723, + "min_time_ns": 551, + "max_time_ns": 994422 + }, + { + "name": "Dialog Setup (Info)", + "iterations": 20, + "total_time_ns": 710, + "avg_time_ns": 35, + "min_time_ns": 20, + "max_time_ns": 160 + }, + { + "name": "Dialog Setup (Question)", + "iterations": 20, + "total_time_ns": 601, + "avg_time_ns": 30, + "min_time_ns": 20, + "max_time_ns": 90 + } + ] +} \ No newline at end of file diff --git a/v3/tests/gtk4-benchmark/compare.go b/v3/tests/gtk4-benchmark/compare.go new file mode 100644 index 000000000..f4793dfc6 --- /dev/null +++ b/v3/tests/gtk4-benchmark/compare.go @@ -0,0 +1,164 @@ +//go:build ignore + +package main + +import ( + "encoding/json" + "fmt" + "os" + "sort" + "strings" + "time" +) + +// BenchmarkResult mirrors the struct in main.go +type BenchmarkResult struct { + Name string `json:"name"` + Iterations int `json:"iterations"` + TotalTime time.Duration `json:"total_time_ns"` + AvgTime time.Duration `json:"avg_time_ns"` + MinTime time.Duration `json:"min_time_ns"` + MaxTime time.Duration `json:"max_time_ns"` +} + +// BenchmarkReport mirrors the struct in main.go +type BenchmarkReport struct { + GTKVersion string `json:"gtk_version"` + Platform string `json:"platform"` + GoVersion string `json:"go_version"` + Timestamp time.Time `json:"timestamp"` + Results []BenchmarkResult `json:"results"` +} + +func main() { + if len(os.Args) < 3 { + fmt.Println("Usage: go run compare.go ") + os.Exit(1) + } + + gtk3Report, err := loadReport(os.Args[1]) + if err != nil { + fmt.Fprintf(os.Stderr, "Error loading GTK3 report: %v\n", err) + os.Exit(1) + } + + gtk4Report, err := loadReport(os.Args[2]) + if err != nil { + fmt.Fprintf(os.Stderr, "Error loading GTK4 report: %v\n", err) + os.Exit(1) + } + + compareReports(gtk3Report, gtk4Report) +} + +func loadReport(filename string) (*BenchmarkReport, error) { + data, err := os.ReadFile(filename) + if err != nil { + return nil, err + } + + var report BenchmarkReport + if err := json.Unmarshal(data, &report); err != nil { + return nil, err + } + + return &report, nil +} + +func compareReports(gtk3, gtk4 *BenchmarkReport) { + fmt.Println("=" + strings.Repeat("=", 89)) + fmt.Println("GTK3 vs GTK4 Benchmark Comparison") + fmt.Println("=" + strings.Repeat("=", 89)) + fmt.Println() + + fmt.Println("Report Details:") + fmt.Printf(" GTK3: %s (%s)\n", gtk3.GTKVersion, gtk3.Timestamp.Format(time.RFC3339)) + fmt.Printf(" GTK4: %s (%s)\n", gtk4.GTKVersion, gtk4.Timestamp.Format(time.RFC3339)) + fmt.Printf(" Platform: %s\n", gtk3.Platform) + fmt.Println() + + // Build maps for easy lookup + gtk3Results := make(map[string]BenchmarkResult) + gtk4Results := make(map[string]BenchmarkResult) + + for _, r := range gtk3.Results { + gtk3Results[r.Name] = r + } + for _, r := range gtk4.Results { + gtk4Results[r.Name] = r + } + + // Get all benchmark names + names := make([]string, 0) + for name := range gtk3Results { + names = append(names, name) + } + sort.Strings(names) + + // Print comparison table + fmt.Printf("%-35s %12s %12s %12s %10s\n", "Benchmark", "GTK3 Avg", "GTK4 Avg", "Difference", "Change") + fmt.Println(strings.Repeat("-", 90)) + + var totalGTK3, totalGTK4 time.Duration + improvements := 0 + regressions := 0 + + for _, name := range names { + gtk3r, ok3 := gtk3Results[name] + gtk4r, ok4 := gtk4Results[name] + + if !ok3 || !ok4 { + continue + } + + diff := gtk4r.AvgTime - gtk3r.AvgTime + var pctChange float64 + if gtk3r.AvgTime > 0 { + pctChange = float64(diff) / float64(gtk3r.AvgTime) * 100 + } + + totalGTK3 += gtk3r.AvgTime + totalGTK4 += gtk4r.AvgTime + + changeSymbol := "" + if pctChange < -5 { + changeSymbol = "✓ FASTER" + improvements++ + } else if pctChange > 5 { + changeSymbol = "✗ SLOWER" + regressions++ + } else { + changeSymbol = "≈ SAME" + } + + fmt.Printf("%-35s %12v %12v %+12v %+9.1f%% %s\n", + name, gtk3r.AvgTime, gtk4r.AvgTime, diff, pctChange, changeSymbol) + } + + fmt.Println(strings.Repeat("-", 90)) + + // Summary + totalDiff := totalGTK4 - totalGTK3 + var totalPctChange float64 + if totalGTK3 > 0 { + totalPctChange = float64(totalDiff) / float64(totalGTK3) * 100 + } + + fmt.Printf("%-35s %12v %12v %+12v %+9.1f%%\n", + "TOTAL", totalGTK3, totalGTK4, totalDiff, totalPctChange) + + fmt.Println() + fmt.Println("Summary:") + fmt.Printf(" Improvements (>5%% faster): %d\n", improvements) + fmt.Printf(" Regressions (>5%% slower): %d\n", regressions) + fmt.Printf(" No significant change: %d\n", len(names)-improvements-regressions) + fmt.Println() + + if totalPctChange < 0 { + fmt.Printf("Overall: GTK4 is %.1f%% faster than GTK3\n", -totalPctChange) + } else if totalPctChange > 0 { + fmt.Printf("Overall: GTK4 is %.1f%% slower than GTK3\n", totalPctChange) + } else { + fmt.Println("Overall: No significant difference") + } +} diff --git a/v3/tests/gtk4-benchmark/main.go b/v3/tests/gtk4-benchmark/main.go new file mode 100644 index 000000000..381717f8d --- /dev/null +++ b/v3/tests/gtk4-benchmark/main.go @@ -0,0 +1,325 @@ +//go:build linux + +package main + +import ( + "embed" + "encoding/json" + "fmt" + "os" + "runtime" + "strings" + "time" + + "github.com/wailsapp/wails/v3/pkg/application" +) + +//go:embed assets/* +var assets embed.FS + +// BenchmarkResult holds the result of a single benchmark +type BenchmarkResult struct { + Name string `json:"name"` + Iterations int `json:"iterations"` + TotalTime time.Duration `json:"total_time_ns"` + AvgTime time.Duration `json:"avg_time_ns"` + MinTime time.Duration `json:"min_time_ns"` + MaxTime time.Duration `json:"max_time_ns"` +} + +// BenchmarkReport holds all benchmark results +type BenchmarkReport struct { + GTKVersion string `json:"gtk_version"` + Platform string `json:"platform"` + GoVersion string `json:"go_version"` + Timestamp time.Time `json:"timestamp"` + Results []BenchmarkResult `json:"results"` +} + +var ( + app *application.App + report BenchmarkReport +) + +func main() { + report = BenchmarkReport{ + Platform: runtime.GOOS + "/" + runtime.GOARCH, + GoVersion: runtime.Version(), + Timestamp: time.Now(), + Results: []BenchmarkResult{}, + } + + app = application.New(application.Options{ + Name: "GTK Benchmark", + Description: "Benchmark comparing GTK3 vs GTK4 performance", + Assets: application.AssetOptions{ + Handler: application.BundledAssetFileServer(assets), + }, + }) + + app.Window.NewWithOptions(application.WebviewWindowOptions{ + Title: "GTK Benchmark", + Width: 800, + Height: 600, + URL: "/", + }) + + // Run benchmarks after a short delay to ensure app is initialized + go func() { + time.Sleep(1 * time.Second) + runBenchmarks() + }() + + err := app.Run() + if err != nil { + fmt.Fprintf(os.Stderr, "Error: %v\n", err) + os.Exit(1) + } +} + +func runBenchmarks() { + // Give the app a moment to fully initialize + time.Sleep(500 * time.Millisecond) + + fmt.Println("=" + strings.Repeat("=", 59)) + fmt.Println("GTK Benchmark Suite") + fmt.Println("=" + strings.Repeat("=", 59)) + + // Detect GTK version + report.GTKVersion = getGTKVersionString() + fmt.Printf("GTK Version: %s\n", report.GTKVersion) + fmt.Printf("Platform: %s\n", report.Platform) + fmt.Printf("Go Version: %s\n", report.GoVersion) + fmt.Println() + + // Run all benchmarks + benchmarkScreenEnumeration() + benchmarkWindowCreation() + benchmarkWindowOperations() + benchmarkMenuCreation() + benchmarkEventDispatch() + benchmarkDialogSetup() + + // Print and save report + printReport() + saveReport() + + // Exit after benchmarks complete + time.Sleep(500 * time.Millisecond) + app.Quit() +} + +func benchmark(name string, iterations int, fn func()) BenchmarkResult { + fmt.Printf("Running: %s (%d iterations)...\n", name, iterations) + + var times []time.Duration + var totalTime time.Duration + + for i := 0; i < iterations; i++ { + start := time.Now() + fn() + elapsed := time.Since(start) + times = append(times, elapsed) + totalTime += elapsed + } + + minTime := times[0] + maxTime := times[0] + for _, t := range times { + if t < minTime { + minTime = t + } + if t > maxTime { + maxTime = t + } + } + + result := BenchmarkResult{ + Name: name, + Iterations: iterations, + TotalTime: totalTime, + AvgTime: totalTime / time.Duration(iterations), + MinTime: minTime, + MaxTime: maxTime, + } + + report.Results = append(report.Results, result) + fmt.Printf(" Average: %v\n", result.AvgTime) + + return result +} + +func benchmarkScreenEnumeration() { + benchmark("Screen Enumeration", 100, func() { + _ = app.Screen.GetAll() + }) + + benchmark("Primary Screen Query", 100, func() { + _ = app.Screen.GetPrimary() + }) +} + +func benchmarkWindowCreation() { + benchmark("Window Create/Destroy", 20, func() { + w := app.Window.NewWithOptions(application.WebviewWindowOptions{ + Title: "Benchmark Window", + Width: 400, + Height: 300, + Hidden: true, + }) + // Small delay to ensure window is created + time.Sleep(10 * time.Millisecond) + w.Close() + time.Sleep(10 * time.Millisecond) + }) +} + +func benchmarkWindowOperations() { + // Create a test window + testWindow := app.Window.NewWithOptions(application.WebviewWindowOptions{ + Title: "Operations Test", + Width: 400, + Height: 300, + }) + time.Sleep(100 * time.Millisecond) + + benchmark("Window SetSize", 50, func() { + testWindow.SetSize(500, 400) + testWindow.SetSize(400, 300) + }) + + benchmark("Window SetTitle", 100, func() { + testWindow.SetTitle("Test Title " + time.Now().String()) + }) + + benchmark("Window Size Query", 100, func() { + _, _ = testWindow.Size() + }) + + benchmark("Window Position Query", 100, func() { + _, _ = testWindow.Position() + }) + + benchmark("Window Center", 50, func() { + testWindow.Center() + }) + + benchmark("Window Show/Hide", 20, func() { + testWindow.Hide() + time.Sleep(5 * time.Millisecond) + testWindow.Show() + time.Sleep(5 * time.Millisecond) + }) + + testWindow.Close() +} + +func benchmarkMenuCreation() { + benchmark("Menu Creation (Simple)", 50, func() { + menu := app.Menu.New() + menu.Add("Item 1") + menu.Add("Item 2") + menu.Add("Item 3") + }) + + benchmark("Menu Creation (Complex)", 20, func() { + menu := app.Menu.New() + for i := 0; i < 5; i++ { + submenu := menu.AddSubmenu(fmt.Sprintf("Menu %d", i)) + for j := 0; j < 10; j++ { + submenu.Add(fmt.Sprintf("Item %d-%d", i, j)) + } + } + }) + + benchmark("Menu with Accelerators", 50, func() { + menu := app.Menu.New() + menu.Add("Cut").SetAccelerator("CmdOrCtrl+X") + menu.Add("Copy").SetAccelerator("CmdOrCtrl+C") + menu.Add("Paste").SetAccelerator("CmdOrCtrl+V") + }) +} + +func benchmarkEventDispatch() { + received := make(chan struct{}, 1000) + + app.Event.On("benchmark-event", func(event *application.CustomEvent) { + select { + case received <- struct{}{}: + default: + } + }) + + benchmark("Event Emit", 100, func() { + app.Event.Emit("benchmark-event", map[string]interface{}{ + "timestamp": time.Now().UnixNano(), + "data": "test payload", + }) + }) + + benchmark("Event Emit+Receive", 50, func() { + app.Event.Emit("benchmark-event", nil) + select { + case <-received: + case <-time.After(100 * time.Millisecond): + } + }) +} + +func benchmarkDialogSetup() { + // Dialog benchmarks - measure setup time only (Show() would block) + benchmark("Dialog Setup (Info)", 20, func() { + _ = app.Dialog.Info(). + SetTitle("Benchmark"). + SetMessage("Test message") + }) + + benchmark("Dialog Setup (Question)", 20, func() { + _ = app.Dialog.Question(). + SetTitle("Benchmark"). + SetMessage("Test question?") + }) +} + +func printReport() { + fmt.Println() + fmt.Println("=" + strings.Repeat("=", 59)) + fmt.Println("Benchmark Results") + fmt.Println("=" + strings.Repeat("=", 59)) + fmt.Printf("GTK Version: %s\n", report.GTKVersion) + fmt.Printf("Platform: %s\n", report.Platform) + fmt.Printf("Timestamp: %s\n", report.Timestamp.Format(time.RFC3339)) + fmt.Println() + + fmt.Printf("%-35s %10s %12s %12s\n", "Benchmark", "Iterations", "Avg Time", "Total Time") + fmt.Println(strings.Repeat("-", 75)) + + for _, r := range report.Results { + fmt.Printf("%-35s %10d %12v %12v\n", + r.Name, r.Iterations, r.AvgTime, r.TotalTime) + } + fmt.Println() +} + +func saveReport() { + filename := fmt.Sprintf("benchmark-%s-%s.json", + strings.ReplaceAll(report.GTKVersion, " ", "-"), + report.Timestamp.Format("20060102-150405")) + filename = strings.ReplaceAll(filename, "/", "-") + filename = strings.ReplaceAll(filename, "(", "") + filename = strings.ReplaceAll(filename, ")", "") + + data, err := json.MarshalIndent(report, "", " ") + if err != nil { + fmt.Fprintf(os.Stderr, "Error marshaling report: %v\n", err) + return + } + + err = os.WriteFile(filename, data, 0644) + if err != nil { + fmt.Fprintf(os.Stderr, "Error writing report: %v\n", err) + return + } + + fmt.Printf("Report saved to: %s\n", filename) +} diff --git a/v3/tests/gtk4-benchmark/version_gtk3.go b/v3/tests/gtk4-benchmark/version_gtk3.go new file mode 100644 index 000000000..ed7c49cef --- /dev/null +++ b/v3/tests/gtk4-benchmark/version_gtk3.go @@ -0,0 +1,7 @@ +//go:build linux && !gtk4 + +package main + +func getGTKVersionString() string { + return "GTK3 (WebKit2GTK 4.1)" +} diff --git a/v3/tests/gtk4-benchmark/version_gtk4.go b/v3/tests/gtk4-benchmark/version_gtk4.go new file mode 100644 index 000000000..aa7703abc --- /dev/null +++ b/v3/tests/gtk4-benchmark/version_gtk4.go @@ -0,0 +1,7 @@ +//go:build linux && gtk4 + +package main + +func getGTKVersionString() string { + return "GTK4 (WebKitGTK 6.0)" +} diff --git a/v3/tests/window-visibility-test/.gitignore b/v3/tests/window-visibility-test/.gitignore new file mode 100644 index 000000000..dc734a8b8 --- /dev/null +++ b/v3/tests/window-visibility-test/.gitignore @@ -0,0 +1,19 @@ +# Compiled binary +window-visibility-test +window-visibility-test.exe + +# Build artifacts +*.exe +*.exe~ +*.dll +*.so +*.dylib + +# Test binaries +*.test + +# Output of the go coverage tool +*.out + +# Go workspace file +go.work \ No newline at end of file diff --git a/v3/tests/window-visibility-test/README.md b/v3/tests/window-visibility-test/README.md new file mode 100644 index 000000000..04b4ec49e --- /dev/null +++ b/v3/tests/window-visibility-test/README.md @@ -0,0 +1,146 @@ +# Window Visibility Test - Issue #2861 + +This example demonstrates and tests the fixes implemented for [Wails v3 Issue #2861](https://github.com/wailsapp/wails/issues/2861) regarding application windows not showing on Windows 10 Pro due to efficiency mode. + +## Problem Background + +On Windows systems, the "efficiency mode" feature could prevent Wails applications from displaying windows properly. This occurred because: + +1. **WebView2 NavigationCompleted events** could be delayed or missed in efficiency mode +2. **Window visibility was gated** behind WebView2 navigation completion +3. **No fallback mechanisms** existed for delayed or failed navigation events + +## Solution Implemented + +The fix implements a **robust cross-platform window visibility pattern**: + +### Windows Improvements +- ✅ **Decouple window container from WebView state** - Windows show immediately +- ✅ **3-second timeout fallback** - Shows WebView if navigation is delayed +- ✅ **Efficiency mode prevention** - Sets WebView2 `IsVisible=true` per Microsoft guidance +- ✅ **Enhanced state tracking** - Proper visibility state management + +### Cross-Platform Consistency +- ✅ **macOS** - Already robust, documented best practices +- ✅ **Linux** - Added missing show/hide methods for both CGO and purego builds + +## Test Scenarios + +This example provides comprehensive testing for: + +### 1. **Basic Window Tests** +- **Normal Window**: Standard window creation - should appear immediately +- **Delayed Content Window**: Simulates heavy content loading (like Vue.js apps) +- **Hidden → Show Test**: Tests delayed showing after initial creation + +### 2. **Stress Tests** +- **Multiple Windows**: Creates 3 windows simultaneously +- **Rapid Creation**: Creates windows in quick succession + +### 3. **Critical Issue #2861 Test** +- **Efficiency Mode Test**: Specifically designed to reproduce and verify the fix +- Tests window container vs content loading timing +- Includes heavy content simulation + +## How to Run + +```bash +cd /path/to/wails/v3/examples/window-visibility-test +wails dev +``` + +## Testing Instructions + +### What to Look For +1. **Immediate Window Appearance** - Windows should appear within 100ms of clicking buttons +2. **Progressive Loading** - Content may load progressively, but window container visible immediately +3. **No Efficiency Mode Issues** - Windows appear even if Task Manager shows "efficiency mode" +4. **Consistent Cross-Platform Behavior** - Similar behavior on Windows, macOS, and Linux + +### How to Test +1. **Note the current time** displayed in the app +2. **Click any test button** or use menu items +3. **Immediately observe** if a window appears (should be within 100ms) +4. **Wait for content** to load and check reported timing +5. **Try multiple tests** in sequence to test robustness +6. **Test both buttons and menu items** for comprehensive coverage + +### Expected Results +- ✅ Window containers appear immediately upon button click +- ✅ Content loads progressively within 2-3 seconds +- ✅ No blank or invisible windows, even under efficiency mode +- ✅ Activity log shows sub-100ms window creation times +- ✅ All test scenarios work consistently + +## Manual Testing Checklist + +### Windows 10 Pro (Primary Target) +- [ ] Test with efficiency mode enabled in Task Manager +- [ ] Create windows while system is under load +- [ ] Test rapid window creation scenarios +- [ ] Verify WebView2 content loads after container appears +- [ ] Check activity log for sub-100ms creation times + +### Windows 11 +- [ ] Verify consistent behavior with Windows 10 Pro fixes +- [ ] Test efficiency mode scenarios +- [ ] Validate timeout fallback mechanisms + +### macOS +- [ ] Confirm existing robust behavior maintained +- [ ] Test all window creation scenarios +- [ ] Verify no regressions introduced + +### Linux +- [ ] Test both CGO and purego builds +- [ ] Verify new show/hide methods work correctly +- [ ] Test window positioning and timing + +## Technical Implementation Details + +### Window Creation Flow +``` +1. User clicks button → JavaScript calls Go backend +2. Go creates WebviewWindow → Sets properties +3. Go calls window.Show() → IMMEDIATE window container display +4. WebView2 starts navigation → Progressive content loading +5. Timeout fallback ensures WebView shows even if navigation delayed +``` + +### Key Code Changes +- **Windows**: `/v3/pkg/application/webview_window_windows.go` +- **macOS**: `/v3/pkg/application/webview_window_darwin.go` +- **Linux**: `/v3/pkg/application/webview_window_linux.go`, `linux_cgo.go`, `linux_purego.go` + +## Reporting Test Results + +When testing, please report: + +1. **Platform & OS Version** (e.g., "Windows 10 Pro 21H2", "macOS 13.1", "Ubuntu 22.04") +2. **Window Creation Timing** (from activity log) +3. **Any Delayed or Missing Windows** +4. **Efficiency Mode Status** (Windows only - check Task Manager) +5. **Content Loading Behavior** (immediate container vs progressive content) +6. **Any Error Messages** in activity log or console + +### Sample Test Report Format +``` +Platform: Windows 10 Pro 21H2 +Efficiency Mode: Enabled +Results: +- Normal Window: ✅ Appeared immediately (<50ms) +- Delayed Content: ✅ Container immediate, content loaded in 2.1s +- Multiple Windows: ✅ All 3 appeared simultaneously +- Critical Test: ✅ Window appeared immediately, content progressive +Notes: No issues observed, all windows visible immediately +``` + +## Architecture Notes + +This example demonstrates the **preferred window visibility pattern** for web-based desktop applications: + +1. **Separate Concerns**: Window container vs web content readiness +2. **Immediate Feedback**: Users see window immediately +3. **Progressive Enhancement**: Content loads and appears when ready +4. **Robust Fallbacks**: Multiple strategies for edge cases +5. **Cross-Platform Consistency**: Same behavior on all platforms diff --git a/v3/tests/window-visibility-test/TESTING_GUIDE.md b/v3/tests/window-visibility-test/TESTING_GUIDE.md new file mode 100644 index 000000000..dbb3bfd04 --- /dev/null +++ b/v3/tests/window-visibility-test/TESTING_GUIDE.md @@ -0,0 +1,159 @@ +# Testing Guide - Window Visibility Issue #2861 + +## Quick Start + +1. **Build and run the application:** + ```bash + cd v3/examples/window-visibility-test + ./build.sh + # OR + wails dev + ``` + +2. **Main testing interface:** + - The app opens with a comprehensive testing dashboard + - Contains multiple test scenarios accessible via buttons + - Also provides menu-based testing (File, Tests, Help menus) + - Real-time activity logging with precise timing + +## Critical Test Cases + +### 🎯 **Issue #2861 Reproduction Test** (Most Important) +**Button:** "Efficiency Mode Test" +**Expected:** Window container appears immediately, content loads progressively +**Watch for:** +- Window visible within 100ms of button click +- Content loading message appears initially +- Content completes loading after 2-3 seconds +- No blank or invisible windows + +### ⏳ **Delayed Content Simulation** +**Button:** "Create Delayed Content Window" +**Expected:** Tests navigation completion timing +**Watch for:** +- Window container appears immediately +- Loading spinner visible initially +- Content loads after 3-second delay +- Window remains visible throughout + +### 🔄 **Hidden → Show Robustness** +**Button:** "Hidden → Show Test" +**Expected:** Tests delayed show() calls +**Watch for:** +- Initial response in activity log +- Window appears after exactly 2 seconds +- No timing issues or failures + +## Platform-Specific Testing + +### Windows 10 Pro (Primary Target) +**Enable Efficiency Mode Testing:** +1. Open Task Manager → Processes tab +2. Find the test application process +3. Right-click → "Efficiency mode" (if available) +4. Run all test scenarios +5. Verify windows still appear immediately + +**Key Metrics:** +- Window creation: < 100ms +- Content loading: 2-3 seconds +- No invisible windows under any conditions + +### Windows 11 +**Similar to Windows 10 Pro but also test:** +- New Windows 11 efficiency features +- Multiple monitor scenarios +- High DPI scaling + +### macOS +**Focus on consistency:** +- All scenarios should work identical to Windows +- No regressions in existing robust behavior +- Test across different macOS versions if possible + +### Linux +**Test both build variants:** +```bash +# CGO build (default) +wails dev + +# Purego build +CGO_ENABLED=0 wails dev +``` +- Verify both variants behave identically +- Test across different Linux distributions + +## Success Criteria + +### ✅ **Pass Conditions** +- All windows appear within 100ms of button click +- Activity log shows consistent sub-100ms timing +- Content loads progressively without blocking window visibility +- No blank, invisible, or delayed windows under any test scenario +- Efficiency mode (Windows) does not prevent window appearance +- Menu and button testing yield identical results + +### ❌ **Fail Conditions** +- Any window takes >200ms to appear +- Blank or invisible windows under any condition +- Window visibility blocked by content loading +- Efficiency mode prevents window appearance +- Inconsistent behavior between test methods +- Platform-specific failures + +## Reporting Results + +**Please provide this information:** + +``` +Platform: [Windows 10 Pro/Windows 11/macOS/Linux distro + version] +Build Type: [CGO/Purego] (Linux only) +Efficiency Mode: [Enabled/Disabled/N/A] (Windows only) + +Test Results: +- Normal Window: [✅ Pass / ❌ Fail] - [timing in ms] +- Delayed Content: [✅ Pass / ❌ Fail] - [container timing / content timing] +- Hidden→Show: [✅ Pass / ❌ Fail] - [notes] +- Multiple Windows: [✅ Pass / ❌ Fail] - [notes] +- Efficiency Mode Test: [✅ Pass / ❌ Fail] - [critical timing results] + +Notes: +[Any additional observations, error messages, or unexpected behavior] +``` + +## Advanced Testing Scenarios + +### **Rapid Stress Testing** +1. Click "Rapid Creation Test" multiple times quickly +2. Use keyboard shortcuts to rapidly access menu items +3. Create multiple windows then close them rapidly +4. Test system under load (other applications running) + +### **Edge Case Testing** +1. Test during system startup (high load) +2. Test with multiple monitors +3. Test with different DPI scaling settings +4. Test while other WebView2 applications are running + +### **Timing Verification** +1. Use browser dev tools (F12) to check console timing +2. Compare activity log timing with system clock +3. Test on slower/older hardware if available +4. Verify timing consistency across multiple runs + +## Troubleshooting + +### **Common Issues** +- **Blank window**: Check activity log for error messages +- **Slow timing**: Verify system isn't under heavy load +- **Build failures**: Ensure Wails v3 CLI is latest version +- **Import errors**: Run `go mod tidy` in example directory + +### **Debug Information** +The application provides extensive logging: +- Browser console (F12) shows JavaScript timing +- Activity log shows backend call timing +- Go application logs show window creation details +- Check system Task Manager for process efficiency mode status + +This comprehensive testing should validate that the window visibility fixes successfully resolve issue #2861 across all supported platforms. \ No newline at end of file diff --git a/v3/tests/window-visibility-test/assets/index.html b/v3/tests/window-visibility-test/assets/index.html new file mode 100644 index 000000000..22023a5e3 --- /dev/null +++ b/v3/tests/window-visibility-test/assets/index.html @@ -0,0 +1,431 @@ + + + + + + Window Visibility Test - Issue #2861 + + + +
                    +
                    +

                    🪟 Window Visibility Test

                    +

                    Testing fixes for Wails v3 Issue #2861 - Windows 10 Pro Efficiency Mode

                    +
                    + Current Time: --:--:-- +
                    +
                    + +
                    +

                    Basic Window Tests

                    +

                    These tests verify that windows appear immediately when requested, regardless of WebView content loading state.

                    +
                    + + + +
                    +
                    + +
                    +

                    Stress Tests

                    +

                    These tests push the window system to verify robustness under load and timing edge cases.

                    +
                    + + +
                    +
                    + +
                    +

                    🔬Critical Issue #2861 Test

                    +

                    This test specifically targets the Windows efficiency mode bug where WebView2 NavigationCompleted events could be delayed or missed.

                    + +
                    +

                    Expected Behavior:

                    +
                      +
                    • Window container appears immediately upon button click
                    • +
                    • Content loads progressively (may take 2-3 seconds)
                    • +
                    • No blank or invisible windows, even under efficiency mode
                    • +
                    +
                    + +
                    + +
                    +
                    + +
                    +

                    📊Test Results & Timing

                    +

                    Monitor window creation timing and behavior. Each button click should result in immediate window visibility.

                    + +
                    +

                    Activity Log

                    +
                    +
                    Ready for testing... Click any button to begin.
                    +
                    +
                    +
                    + +
                    +

                    📝Testing Instructions

                    +
                    +

                    What to Look For:

                    +
                      +
                    • Immediate Window Appearance: Windows should appear within 100ms of clicking
                    • +
                    • Progressive Loading: Content may load progressively, but window container should be visible immediately
                    • +
                    • No Efficiency Mode Issues: On Windows, windows should still appear even if Task Manager shows "efficiency mode"
                    • +
                    • Consistent Behavior: All platforms (Windows, macOS, Linux) should behave similarly
                    • +
                    +
                    + +
                    +

                    How to Test:

                    +
                      +
                    1. Note the current time displayed above
                    2. +
                    3. Click any test button
                    4. +
                    5. Immediately observe if a window appears (should be within 100ms)
                    6. +
                    7. Wait for content to load and check the reported timing
                    8. +
                    9. Try multiple tests in sequence
                    10. +
                    11. Test both buttons and menu items
                    12. +
                    +
                    +
                    +
                    + + + + \ No newline at end of file diff --git a/v3/tests/window-visibility-test/go.mod b/v3/tests/window-visibility-test/go.mod new file mode 100644 index 000000000..bc824bdac --- /dev/null +++ b/v3/tests/window-visibility-test/go.mod @@ -0,0 +1,52 @@ +module window-visibility-test + +go 1.24 + +replace github.com/wailsapp/wails/v3 => ../../ + +require github.com/wailsapp/wails/v3 v3.0.0-alpha.62 + +require ( + dario.cat/mergo v1.0.2 // indirect + github.com/Microsoft/go-winio v0.6.2 // indirect + github.com/ProtonMail/go-crypto v1.3.0 // indirect + github.com/adrg/xdg v0.5.3 // indirect + github.com/bep/debounce v1.2.1 // indirect + github.com/cloudflare/circl v1.6.3 // indirect + github.com/coder/websocket v1.8.14 // indirect + github.com/cyphar/filepath-securejoin v0.6.1 // indirect + github.com/ebitengine/purego v0.9.1 // indirect + github.com/emirpasic/gods v1.18.1 // indirect + github.com/go-git/gcfg v1.5.1-0.20230307220236-3a3c6141e376 // indirect + github.com/go-git/go-billy/v5 v5.7.0 // indirect + github.com/go-git/go-git/v5 v5.16.4 // indirect + github.com/go-ole/go-ole v1.3.0 // indirect + github.com/godbus/dbus/v5 v5.2.2 // indirect + github.com/golang/groupcache v0.0.0-20241129210726-2c02b8208cf8 // indirect + github.com/google/uuid v1.6.0 // indirect + github.com/jbenet/go-context v0.0.0-20150711004518-d14ea06fba99 // indirect + github.com/jchv/go-winloader v0.0.0-20250406163304-c1995be93bd1 // indirect + github.com/kevinburke/ssh_config v1.4.0 // indirect + github.com/klauspost/cpuid/v2 v2.3.0 // indirect + github.com/leaanthony/go-ansi-parser v1.6.1 // indirect + github.com/leaanthony/u v1.1.1 // indirect + github.com/lmittmann/tint v1.1.2 // indirect + github.com/mattn/go-colorable v0.1.14 // indirect + github.com/mattn/go-isatty v0.0.20 // indirect + github.com/pjbgf/sha1cd v0.5.0 // indirect + github.com/pkg/browser v0.0.0-20240102092130-5ac0b6a4141c // indirect + github.com/rivo/uniseg v0.4.7 // indirect + github.com/samber/lo v1.52.0 // indirect + github.com/sergi/go-diff v1.4.0 // indirect + github.com/skeema/knownhosts v1.3.2 // indirect + github.com/wailsapp/go-webview2 v1.0.23 // indirect + github.com/xanzy/ssh-agent v0.3.3 // indirect + golang.org/x/crypto v0.47.0 // indirect + golang.org/x/net v0.49.0 // indirect + golang.org/x/sys v0.40.0 // indirect + golang.org/x/text v0.33.0 // indirect + gopkg.in/warnings.v0 v0.1.2 // indirect +) + +// Add any other dependencies that might be needed +// These will be resolved when the user runs go mod tidy diff --git a/v3/tests/window-visibility-test/go.sum b/v3/tests/window-visibility-test/go.sum new file mode 100644 index 000000000..56f1153ea --- /dev/null +++ b/v3/tests/window-visibility-test/go.sum @@ -0,0 +1,147 @@ +dario.cat/mergo v1.0.2 h1:85+piFYR1tMbRrLcDwR18y4UKJ3aH1Tbzi24VRW1TK8= +dario.cat/mergo v1.0.2/go.mod h1:E/hbnu0NxMFBjpMIE34DRGLWqDy0g5FuKDhCb31ngxA= +github.com/Microsoft/go-winio v0.5.2/go.mod h1:WpS1mjBmmwHBEWmogvA2mj8546UReBk4v8QkMxJ6pZY= +github.com/Microsoft/go-winio v0.6.2 h1:F2VQgta7ecxGYO8k3ZZz3RS8fVIXVxONVUPlNERoyfY= +github.com/Microsoft/go-winio v0.6.2/go.mod h1:yd8OoFMLzJbo9gZq8j5qaps8bJ9aShtEA8Ipt1oGCvU= +github.com/ProtonMail/go-crypto v1.3.0 h1:ILq8+Sf5If5DCpHQp4PbZdS1J7HDFRXz/+xKBiRGFrw= +github.com/ProtonMail/go-crypto v1.3.0/go.mod h1:9whxjD8Rbs29b4XWbB8irEcE8KHMqaR2e7GWU1R+/PE= +github.com/adrg/xdg v0.5.3 h1:xRnxJXne7+oWDatRhR1JLnvuccuIeCoBu2rtuLqQB78= +github.com/adrg/xdg v0.5.3/go.mod h1:nlTsY+NNiCBGCK2tpm09vRqfVzrc2fLmXGpBLF0zlTQ= +github.com/anmitsu/go-shlex v0.0.0-20200514113438-38f4b401e2be h1:9AeTilPcZAjCFIImctFaOjnTIavg87rW78vTPkQqLI8= +github.com/anmitsu/go-shlex v0.0.0-20200514113438-38f4b401e2be/go.mod h1:ySMOLuWl6zY27l47sB3qLNK6tF2fkHG55UZxx8oIVo4= +github.com/armon/go-socks5 v0.0.0-20160902184237-e75332964ef5 h1:0CwZNZbxp69SHPdPJAN/hZIm0C4OItdklCFmMRWYpio= +github.com/armon/go-socks5 v0.0.0-20160902184237-e75332964ef5/go.mod h1:wHh0iHkYZB8zMSxRWpUBQtwG5a7fFgvEO+odwuTv2gs= +github.com/bep/debounce v1.2.1 h1:v67fRdBA9UQu2NhLFXrSg0Brw7CexQekrBwDMM8bzeY= +github.com/bep/debounce v1.2.1/go.mod h1:H8yggRPQKLUhUoqrJC1bO2xNya7vanpDl7xR3ISbCJ0= +github.com/cloudflare/circl v1.6.3 h1:9GPOhQGF9MCYUeXyMYlqTR6a5gTrgR/fBLXvUgtVcg8= +github.com/cloudflare/circl v1.6.3/go.mod h1:2eXP6Qfat4O/Yhh8BznvKnJ+uzEoTQ6jVKJRn81BiS4= +github.com/coder/websocket v1.8.14 h1:9L0p0iKiNOibykf283eHkKUHHrpG7f65OE3BhhO7v9g= +github.com/coder/websocket v1.8.14/go.mod h1:NX3SzP+inril6yawo5CQXx8+fk145lPDC6pumgx0mVg= +github.com/cyphar/filepath-securejoin v0.6.1 h1:5CeZ1jPXEiYt3+Z6zqprSAgSWiggmpVyciv8syjIpVE= +github.com/cyphar/filepath-securejoin v0.6.1/go.mod h1:A8hd4EnAeyujCJRrICiOWqjS1AX0a9kM5XL+NwKoYSc= +github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= +github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c= +github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= +github.com/ebitengine/purego v0.9.1 h1:a/k2f2HQU3Pi399RPW1MOaZyhKJL9w/xFpKAg4q1s0A= +github.com/ebitengine/purego v0.9.1/go.mod h1:iIjxzd6CiRiOG0UyXP+V1+jWqUXVjPKLAI0mRfJZTmQ= +github.com/elazarl/goproxy v1.7.2 h1:Y2o6urb7Eule09PjlhQRGNsqRfPmYI3KKQLFpCAV3+o= +github.com/elazarl/goproxy v1.7.2/go.mod h1:82vkLNir0ALaW14Rc399OTTjyNREgmdL2cVoIbS6XaE= +github.com/emirpasic/gods v1.18.1 h1:FXtiHYKDGKCW2KzwZKx0iC0PQmdlorYgdFG9jPXJ1Bc= +github.com/emirpasic/gods v1.18.1/go.mod h1:8tpGGwCnJ5H4r6BWwaV6OrWmMoPhUl5jm/FMNAnJvWQ= +github.com/gliderlabs/ssh v0.3.8 h1:a4YXD1V7xMF9g5nTkdfnja3Sxy1PVDCj1Zg4Wb8vY6c= +github.com/gliderlabs/ssh v0.3.8/go.mod h1:xYoytBv1sV0aL3CavoDuJIQNURXkkfPA/wxQ1pL1fAU= +github.com/go-git/gcfg v1.5.1-0.20230307220236-3a3c6141e376 h1:+zs/tPmkDkHx3U66DAb0lQFJrpS6731Oaa12ikc+DiI= +github.com/go-git/gcfg v1.5.1-0.20230307220236-3a3c6141e376/go.mod h1:an3vInlBmSxCcxctByoQdvwPiA7DTK7jaaFDBTtu0ic= +github.com/go-git/go-billy/v5 v5.7.0 h1:83lBUJhGWhYp0ngzCMSgllhUSuoHP1iEWYjsPl9nwqM= +github.com/go-git/go-billy/v5 v5.7.0/go.mod h1:/1IUejTKH8xipsAcdfcSAlUlo2J7lkYV8GTKxAT/L3E= +github.com/go-git/go-git-fixtures/v4 v4.3.2-0.20231010084843-55a94097c399 h1:eMje31YglSBqCdIqdhKBW8lokaMrL3uTkpGYlE2OOT4= +github.com/go-git/go-git-fixtures/v4 v4.3.2-0.20231010084843-55a94097c399/go.mod h1:1OCfN199q1Jm3HZlxleg+Dw/mwps2Wbk9frAWm+4FII= +github.com/go-git/go-git/v5 v5.16.4 h1:7ajIEZHZJULcyJebDLo99bGgS0jRrOxzZG4uCk2Yb2Y= +github.com/go-git/go-git/v5 v5.16.4/go.mod h1:4Ge4alE/5gPs30F2H1esi2gPd69R0C39lolkucHBOp8= +github.com/go-json-experiment/json v0.0.0-20251027170946-4849db3c2f7e h1:Lf/gRkoycfOBPa42vU2bbgPurFong6zXeFtPoxholzU= +github.com/go-json-experiment/json v0.0.0-20251027170946-4849db3c2f7e/go.mod h1:uNVvRXArCGbZ508SxYYTC5v1JWoz2voff5pm25jU1Ok= +github.com/go-ole/go-ole v1.3.0 h1:Dt6ye7+vXGIKZ7Xtk4s6/xVdGDQynvom7xCFEdWr6uE= +github.com/go-ole/go-ole v1.3.0/go.mod h1:5LS6F96DhAwUc7C+1HLexzMXY1xGRSryjyPPKW6zv78= +github.com/godbus/dbus/v5 v5.2.2 h1:TUR3TgtSVDmjiXOgAAyaZbYmIeP3DPkld3jgKGV8mXQ= +github.com/godbus/dbus/v5 v5.2.2/go.mod h1:3AAv2+hPq5rdnr5txxxRwiGjPXamgoIHgz9FPBfOp3c= +github.com/golang/groupcache v0.0.0-20241129210726-2c02b8208cf8 h1:f+oWsMOmNPc8JmEHVZIycC7hBoQxHH9pNKQORJNozsQ= +github.com/golang/groupcache v0.0.0-20241129210726-2c02b8208cf8/go.mod h1:wcDNUvekVysuuOpQKo3191zZyTpiI6se1N1ULghS0sw= +github.com/google/go-cmp v0.7.0 h1:wk8382ETsv4JYUZwIsn6YpYiWiBsYLSJiTsyBybVuN8= +github.com/google/go-cmp v0.7.0/go.mod h1:pXiqmnSA92OHEEa9HXL2W4E7lf9JzCmGVUdgjX3N/iU= +github.com/google/uuid v1.6.0 h1:NIvaJDMOsjHA8n1jAhLSgzrAzy1Hgr+hNrb57e+94F0= +github.com/google/uuid v1.6.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo= +github.com/jbenet/go-context v0.0.0-20150711004518-d14ea06fba99 h1:BQSFePA1RWJOlocH6Fxy8MmwDt+yVQYULKfN0RoTN8A= +github.com/jbenet/go-context v0.0.0-20150711004518-d14ea06fba99/go.mod h1:1lJo3i6rXxKeerYnT8Nvf0QmHCRC1n8sfWVwXF2Frvo= +github.com/jchv/go-winloader v0.0.0-20250406163304-c1995be93bd1 h1:njuLRcjAuMKr7kI3D85AXWkw6/+v9PwtV6M6o11sWHQ= +github.com/jchv/go-winloader v0.0.0-20250406163304-c1995be93bd1/go.mod h1:alcuEEnZsY1WQsagKhZDsoPCRoOijYqhZvPwLG0kzVs= +github.com/kevinburke/ssh_config v1.4.0 h1:6xxtP5bZ2E4NF5tuQulISpTO2z8XbtH8cg1PWkxoFkQ= +github.com/kevinburke/ssh_config v1.4.0/go.mod h1:q2RIzfka+BXARoNexmF9gkxEX7DmvbW9P4hIVx2Kg4M= +github.com/klauspost/cpuid/v2 v2.3.0 h1:S4CRMLnYUhGeDFDqkGriYKdfoFlDnMtqTiI/sFzhA9Y= +github.com/klauspost/cpuid/v2 v2.3.0/go.mod h1:hqwkgyIinND0mEev00jJYCxPNVRVXFQeu1XKlok6oO0= +github.com/kr/pretty v0.1.0/go.mod h1:dAy3ld7l9f0ibDNOQOHHMYYIIbhfbHSm3C4ZsoJORNo= +github.com/kr/pretty v0.3.1 h1:flRD4NNwYAUpkphVc1HcthR4KEIFJ65n8Mw5qdRn3LE= +github.com/kr/pretty v0.3.1/go.mod h1:hoEshYVHaxMs3cyo3Yncou5ZscifuDolrwPKZanG3xk= +github.com/kr/pty v1.1.1/go.mod h1:pFQYn66WHrOpPYNljwOMqo10TkYh1fy3cYio2l3bCsQ= +github.com/kr/text v0.1.0/go.mod h1:4Jbv+DJW3UT/LiOwJeYQe1efqtUx/iVham/4vfdArNI= +github.com/kr/text v0.2.0 h1:5Nx0Ya0ZqY2ygV366QzturHI13Jq95ApcVaJBhpS+AY= +github.com/kr/text v0.2.0/go.mod h1:eLer722TekiGuMkidMxC/pM04lWEeraHUUmBw8l2grE= +github.com/leaanthony/go-ansi-parser v1.6.1 h1:xd8bzARK3dErqkPFtoF9F3/HgN8UQk0ed1YDKpEz01A= +github.com/leaanthony/go-ansi-parser v1.6.1/go.mod h1:+vva/2y4alzVmmIEpk9QDhA7vLC5zKDTRwfZGOp3IWU= +github.com/leaanthony/u v1.1.1 h1:TUFjwDGlNX+WuwVEzDqQwC2lOv0P4uhTQw7CMFdiK7M= +github.com/leaanthony/u v1.1.1/go.mod h1:9+o6hejoRljvZ3BzdYlVL0JYCwtnAsVuN9pVTQcaRfI= +github.com/lmittmann/tint v1.1.2 h1:2CQzrL6rslrsyjqLDwD11bZ5OpLBPU+g3G/r5LSfS8w= +github.com/lmittmann/tint v1.1.2/go.mod h1:HIS3gSy7qNwGCj+5oRjAutErFBl4BzdQP6cJZ0NfMwE= +github.com/matryer/is v1.4.0/go.mod h1:8I/i5uYgLzgsgEloJE1U6xx5HkBQpAZvepWuujKwMRU= +github.com/matryer/is v1.4.1 h1:55ehd8zaGABKLXQUe2awZ99BD/PTc2ls+KV/dXphgEQ= +github.com/matryer/is v1.4.1/go.mod h1:8I/i5uYgLzgsgEloJE1U6xx5HkBQpAZvepWuujKwMRU= +github.com/mattn/go-colorable v0.1.14 h1:9A9LHSqF/7dyVVX6g0U9cwm9pG3kP9gSzcuIPHPsaIE= +github.com/mattn/go-colorable v0.1.14/go.mod h1:6LmQG8QLFO4G5z1gPvYEzlUgJ2wF+stgPZH1UqBm1s8= +github.com/mattn/go-isatty v0.0.20 h1:xfD0iDuEKnDkl03q4limB+vH+GxLEtL/jb4xVJSWWEY= +github.com/mattn/go-isatty v0.0.20/go.mod h1:W+V8PltTTMOvKvAeJH7IuucS94S2C6jfK/D7dTCTo3Y= +github.com/onsi/gomega v1.34.1 h1:EUMJIKUjM8sKjYbtxQI9A4z2o+rruxnzNvpknOXie6k= +github.com/onsi/gomega v1.34.1/go.mod h1:kU1QgUvBDLXBJq618Xvm2LUX6rSAfRaFRTcdOeDLwwY= +github.com/pjbgf/sha1cd v0.5.0 h1:a+UkboSi1znleCDUNT3M5YxjOnN1fz2FhN48FlwCxs0= +github.com/pjbgf/sha1cd v0.5.0/go.mod h1:lhpGlyHLpQZoxMv8HcgXvZEhcGs0PG/vsZnEJ7H0iCM= +github.com/pkg/browser v0.0.0-20240102092130-5ac0b6a4141c h1:+mdjkGKdHQG3305AYmdv1U2eRNDiU2ErMBj1gwrq8eQ= +github.com/pkg/browser v0.0.0-20240102092130-5ac0b6a4141c/go.mod h1:7rwL4CYBLnjLxUqIJNnCWiEdr3bn6IUYi15bNlnbCCU= +github.com/pkg/errors v0.9.1 h1:FEBLx1zS214owpjy7qsBeixbURkuhQAwrK5UwLGTwt4= +github.com/pkg/errors v0.9.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0= +github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM= +github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= +github.com/rivo/uniseg v0.2.0/go.mod h1:J6wj4VEh+S6ZtnVlnTBMWIodfgj8LQOQFoIToxlJtxc= +github.com/rivo/uniseg v0.4.7 h1:WUdvkW8uEhrYfLC4ZzdpI2ztxP1I582+49Oc5Mq64VQ= +github.com/rivo/uniseg v0.4.7/go.mod h1:FN3SvrM+Zdj16jyLfmOkMNblXMcoc8DfTHruCPUcx88= +github.com/rogpeppe/go-internal v1.14.1 h1:UQB4HGPB6osV0SQTLymcB4TgvyWu6ZyliaW0tI/otEQ= +github.com/rogpeppe/go-internal v1.14.1/go.mod h1:MaRKkUm5W0goXpeCfT7UZI6fk/L7L7so1lCWt35ZSgc= +github.com/samber/lo v1.52.0 h1:Rvi+3BFHES3A8meP33VPAxiBZX/Aws5RxrschYGjomw= +github.com/samber/lo v1.52.0/go.mod h1:4+MXEGsJzbKGaUEQFKBq2xtfuznW9oz/WrgyzMzRoM0= +github.com/sergi/go-diff v1.4.0 h1:n/SP9D5ad1fORl+llWyN+D6qoUETXNZARKjyY2/KVCw= +github.com/sergi/go-diff v1.4.0/go.mod h1:A0bzQcvG0E7Rwjx0REVgAGH58e96+X0MeOfepqsbeW4= +github.com/sirupsen/logrus v1.7.0/go.mod h1:yWOB1SBYBC5VeMP7gHvWumXLIWorT60ONWic61uBYv0= +github.com/skeema/knownhosts v1.3.2 h1:EDL9mgf4NzwMXCTfaxSD/o/a5fxDw/xL9nkU28JjdBg= +github.com/skeema/knownhosts v1.3.2/go.mod h1:bEg3iQAuw+jyiw+484wwFJoKSLwcfd7fqRy+N0QTiow= +github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME= +github.com/stretchr/testify v1.2.2/go.mod h1:a8OnRcib4nhh0OaRAV+Yts87kKdq0PP7pXfy6kDkUVs= +github.com/stretchr/testify v1.4.0/go.mod h1:j7eGeouHqKxXV5pUuKE4zz7dFj8WfuZ+81PSLYec5m4= +github.com/stretchr/testify v1.11.1 h1:7s2iGBzp5EwR7/aIZr8ao5+dra3wiQyKjjFuvgVKu7U= +github.com/stretchr/testify v1.11.1/go.mod h1:wZwfW3scLgRK+23gO65QZefKpKQRnfz6sD981Nm4B6U= +github.com/wailsapp/go-webview2 v1.0.23 h1:jmv8qhz1lHibCc79bMM/a/FqOnnzOGEisLav+a0b9P0= +github.com/wailsapp/go-webview2 v1.0.23/go.mod h1:qJmWAmAmaniuKGZPWwne+uor3AHMB5PFhqiK0Bbj8kc= +github.com/xanzy/ssh-agent v0.3.3 h1:+/15pJfg/RsTxqYcX6fHqOXZwwMP+2VyYWJeWM2qQFM= +github.com/xanzy/ssh-agent v0.3.3/go.mod h1:6dzNDKs0J9rVPHPhaGCukekBHKqfl+L3KghI1Bc68Uw= +golang.org/x/crypto v0.0.0-20220622213112-05595931fe9d/go.mod h1:IxCIyHEi3zRg3s0A5j5BB6A9Jmi73HwBIUl50j+osU4= +golang.org/x/crypto v0.47.0 h1:V6e3FRj+n4dbpw86FJ8Fv7XVOql7TEwpHapKoMJ/GO8= +golang.org/x/crypto v0.47.0/go.mod h1:ff3Y9VzzKbwSSEzWqJsJVBnWmRwRSHt/6Op5n9bQc4A= +golang.org/x/exp v0.0.0-20260112195511-716be5621a96 h1:Z/6YuSHTLOHfNFdb8zVZomZr7cqNgTJvA8+Qz75D8gU= +golang.org/x/exp v0.0.0-20260112195511-716be5621a96/go.mod h1:nzimsREAkjBCIEFtHiYkrJyT+2uy9YZJB7H1k68CXZU= +golang.org/x/net v0.0.0-20211112202133-69e39bad7dc2/go.mod h1:9nx3DQGgdP8bBQD5qxJ1jj9UTztislL4KSBs9R2vV5Y= +golang.org/x/net v0.49.0 h1:eeHFmOGUTtaaPSGNmjBKpbng9MulQsJURQUAfUwY++o= +golang.org/x/net v0.49.0/go.mod h1:/ysNB2EvaqvesRkuLAyjI1ycPZlQHM3q01F02UY/MV8= +golang.org/x/sys v0.0.0-20191026070338-33540a1f6037/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20200810151505-1b9f1253b3ed/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20201119102817-f84b799fce68/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20210124154548-22da62e12c0c/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20210423082822-04245dca01da/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20210615035016-665e8c7367d1/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.0.0-20220715151400-c0bba94af5f8/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.1.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.6.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.40.0 h1:DBZZqJ2Rkml6QMQsZywtnjnnGvHza6BTfYFWY9kjEWQ= +golang.org/x/sys v0.40.0/go.mod h1:OgkHotnGiDImocRcuBABYBEXf8A9a87e/uXjp9XT3ks= +golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo= +golang.org/x/term v0.39.0 h1:RclSuaJf32jOqZz74CkPA9qFuVTX7vhLlpfj/IGWlqY= +golang.org/x/term v0.39.0/go.mod h1:yxzUCTP/U+FzoxfdKmLaA0RV1WgE0VY7hXBwKtY/4ww= +golang.org/x/text v0.3.6/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ= +golang.org/x/text v0.33.0 h1:B3njUFyqtHDUI5jMn1YIr5B0IE2U0qck04r6d4KPAxE= +golang.org/x/text v0.33.0/go.mod h1:LuMebE6+rBincTi9+xWTY8TztLzKHc/9C1uBCG27+q8= +golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ= +gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= +gopkg.in/check.v1 v1.0.0-20190902080502-41f04d3bba15/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= +gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c h1:Hei/4ADfdWqJk1ZMxUNpqntNwaWcugrBjAiHlqqRiVk= +gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c/go.mod h1:JHkPIbrfpd72SG/EVd6muEfDQjcINNoR0C8j2r3qZ4Q= +gopkg.in/warnings.v0 v0.1.2 h1:wFXVbFY8DY5/xOe1ECiWdKCzZlxgshcYVNkBHstARME= +gopkg.in/warnings.v0 v0.1.2/go.mod h1:jksf8JmL6Qr/oQM2OXTHunEvvTAsrWBLb6OOjuVWRNI= +gopkg.in/yaml.v2 v2.2.2/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI= +gopkg.in/yaml.v2 v2.4.0/go.mod h1:RDklbk79AGWmwhnvt/jBztapEOGDOx6ZbXqjP6csGnQ= +gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA= +gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= diff --git a/v3/tests/window-visibility-test/main.go b/v3/tests/window-visibility-test/main.go new file mode 100644 index 000000000..247c1035c --- /dev/null +++ b/v3/tests/window-visibility-test/main.go @@ -0,0 +1,308 @@ +package main + +import ( + "embed" + "fmt" + "log" + "time" + + "github.com/wailsapp/wails/v3/pkg/application" +) + +// WindowTestService provides methods for testing window visibility scenarios +type WindowTestService struct { + app *application.App +} + +// NewWindowTestService creates a new window test service +func NewWindowTestService() *WindowTestService { + return &WindowTestService{} +} + +// SetApp sets the application reference (internal method, not exposed to frontend) +func (w *WindowTestService) setApp(app *application.App) { + w.app = app +} + +// CreateNormalWindow creates a standard window - should show immediately +func (w *WindowTestService) CreateNormalWindow() string { + log.Println("Creating normal window...") + + w.app.Window.NewWithOptions(application.WebviewWindowOptions{ + Title: "Normal Window - Should Show Immediately", + Width: 600, + Height: 400, + X: 100, + Y: 100, + HTML: "Normal Window

                    ✅ Normal Window

                    This window should have appeared immediately after clicking the button.

                    Timestamp: " + time.Now().Format("15:04:05") + "

                    ", + }) + + return "Normal window created" +} + +// CreateDelayedContentWindow creates a window with delayed content to test navigation timing +func (w *WindowTestService) CreateDelayedContentWindow() string { + log.Println("Creating delayed content window...") + + // Use HTML that will take time to load (simulates heavy Vue app) + delayedHTML := ` + + + Delayed Content + + + +

                    ⏳ Delayed Content Window

                    +

                    This window tests navigation completion timing.

                    +
                    +

                    Loading... (simulates heavy content)

                    + +

                    Window container should be visible immediately, even during load.

                    + + ` + + w.app.Window.NewWithOptions(application.WebviewWindowOptions{ + Title: "Delayed Content Window - Test Navigation Timing", + Width: 600, + Height: 400, + X: 150, + Y: 150, + HTML: delayedHTML, + }) + + return "Delayed content window created" +} + +// CreateHiddenThenShowWindow creates a hidden window then shows it after delay +func (w *WindowTestService) CreateHiddenThenShowWindow() string { + log.Println("Creating hidden then show window...") + + window := w.app.Window.NewWithOptions(application.WebviewWindowOptions{ + Title: "Hidden Then Show Window - Test Show() Robustness", + Width: 600, + Height: 400, + X: 200, + Y: 200, + HTML: "Hidden Then Show

                    🔄 Hidden Then Show Window

                    This window was created hidden and then shown after 2 seconds.

                    Should test the robustness of the show() method.

                    Created at: " + time.Now().Format("15:04:05") + "

                    ", + Hidden: true, // Start hidden + }) + + // Show after 2 seconds to test delayed showing + go func() { + time.Sleep(2 * time.Second) + log.Println("Showing previously hidden window...") + window.Show() + }() + + return "Hidden window created, will show in 2 seconds" +} + +// CreateMultipleWindows creates multiple windows simultaneously to test performance +func (w *WindowTestService) CreateMultipleWindows() string { + log.Println("Creating multiple windows...") + + for i := 0; i < 3; i++ { + bgColors := []string{"#ff9a9e,#fecfef", "#a18cd1,#fbc2eb", "#fad0c4,#ffd1ff"} + content := fmt.Sprintf(` + + + Batch Window %d + + + +

                    🔢 Batch Window %d

                    +

                    Part of multiple windows stress test

                    +

                    All windows should appear quickly and simultaneously

                    +

                    Created at: %s

                    + + `, i+1, bgColors[i], i+1, time.Now().Format("15:04:05")) + + w.app.Window.NewWithOptions(application.WebviewWindowOptions{ + Title: fmt.Sprintf("Batch Window %d - Stress Test", i+1), + Width: 400, + Height: 300, + X: 250 + (i * 50), + Y: 250 + (i * 50), + HTML: content, + }) + } + + return "Created 3 windows simultaneously" +} + +// CreateEfficiencyModeTestWindow creates a window designed to trigger efficiency mode issues +func (w *WindowTestService) CreateEfficiencyModeTestWindow() string { + log.Println("Creating efficiency mode test window...") + + // Create content that might trigger efficiency mode or WebView2 delays + heavyHTML := ` + + + Efficiency Mode Test + + + +

                    ⚡ Efficiency Mode Test Window

                    +

                    This window tests the fix for Windows 10 Pro efficiency mode issue #2861

                    + +
                    +

                    Window Container Status

                    +

                    ✅ Window container is visible (this text proves it)

                    +
                    + +
                    +

                    WebView2 Status

                    +

                    ⏳ WebView2 navigation in progress...

                    + +
                    + +
                    +

                    Heavy Content (simulates Vue.js app)

                    +
                    + Loading heavy content... +
                    +
                    + + + + ` + + w.app.Window.NewWithOptions(application.WebviewWindowOptions{ + Title: "Efficiency Mode Test - Issue #2861 Reproduction", + Width: 700, + Height: 500, + X: 300, + Y: 300, + HTML: heavyHTML, + }) + + return "Efficiency mode test window created" +} + +// GetWindowCount returns the current number of windows +func (w *WindowTestService) GetWindowCount() int { + // This would need to be implemented based on the app's window tracking + // For now, return a placeholder + return 1 // Main window +} + +//go:embed assets/* +var assets embed.FS + +func main() { + // Create the service + service := NewWindowTestService() + + // Create application with menu + app := application.New(application.Options{ + Name: "Window Visibility Test", + Description: "Test application for window visibility robustness (Issue #2861)", + Services: []application.Service{ + application.NewService(service), + }, + Assets: application.AssetOptions{ + Handler: application.BundledAssetFileServer(assets), + }, + }) + + // Set app reference in service + service.setApp(app) + + // Create application menu + menu := app.NewMenu() + + // File menu + fileMenu := menu.AddSubmenu("File") + fileMenu.Add("New Normal Window").OnClick(func(ctx *application.Context) { + service.CreateNormalWindow() + }) + fileMenu.Add("New Delayed Content Window").OnClick(func(ctx *application.Context) { + service.CreateDelayedContentWindow() + }) + fileMenu.AddSeparator() + fileMenu.Add("Quit").OnClick(func(ctx *application.Context) { + app.Quit() + }) + + // Test menu + testMenu := menu.AddSubmenu("Tests") + testMenu.Add("Hidden Then Show Window").OnClick(func(ctx *application.Context) { + service.CreateHiddenThenShowWindow() + }) + testMenu.Add("Multiple Windows Stress Test").OnClick(func(ctx *application.Context) { + service.CreateMultipleWindows() + }) + testMenu.Add("Efficiency Mode Test").OnClick(func(ctx *application.Context) { + service.CreateEfficiencyModeTestWindow() + }) + + // Help menu + helpMenu := menu.AddSubmenu("Help") + helpMenu.Add("About").OnClick(func(ctx *application.Context) { + app.Window.NewWithOptions(application.WebviewWindowOptions{ + Title: "About Window Visibility Test", + Width: 500, + Height: 400, + X: 400, + Y: 300, + HTML: "About

                    Window Visibility Test

                    This application tests the fixes for Wails v3 issue #2861

                    Windows 10 Pro Efficiency Mode Fix

                    Tests window container vs WebView content visibility


                    Created for testing robust window visibility patterns

                    ", + }) + }) + + app.Menu.Set(menu) + + // Create main window + app.Window.NewWithOptions(application.WebviewWindowOptions{ + Title: "Window Visibility Test - Issue #2861", + Width: 800, + Height: 600, + X: 50, + Y: 50, + URL: "/index.html", + }) + + err := app.Run() + if err != nil { + log.Fatal(err) + } +} diff --git a/v3/verify-ios-setup.sh b/v3/verify-ios-setup.sh new file mode 100644 index 000000000..1a6e345c2 --- /dev/null +++ b/v3/verify-ios-setup.sh @@ -0,0 +1,78 @@ +#!/bin/bash + +echo "=== iOS Build System Verification ===" +echo +echo "Checking iOS build assets..." +echo + +# Check if files exist +echo "1. Checking build_assets/ios directory:" +if [ -d "internal/commands/build_assets/ios" ]; then + echo " ✅ iOS build_assets directory exists" + ls -la internal/commands/build_assets/ios/ +else + echo " ❌ iOS build_assets directory missing" +fi +echo + +echo "2. Checking updatable_build_assets/ios directory:" +if [ -d "internal/commands/updatable_build_assets/ios" ]; then + echo " ✅ iOS updatable_build_assets directory exists" + ls -la internal/commands/updatable_build_assets/ios/ +else + echo " ❌ iOS updatable_build_assets directory missing" +fi +echo + +echo "3. Checking iOS implementation files:" +for file in pkg/application/application_ios.go pkg/application/application_ios.h pkg/application/application_ios.m; do + if [ -f "$file" ]; then + echo " ✅ $file exists" + else + echo " ❌ $file missing" + fi +done +echo + +echo "4. Checking iOS example:" +if [ -d "examples/ios-poc" ]; then + echo " ✅ ios-poc example exists" + ls -la examples/ios-poc/ +else + echo " ❌ ios-poc example missing" +fi +echo + +echo "5. Checking main Taskfile includes iOS:" +if grep -q "ios:" internal/templates/_common/Taskfile.tmpl.yml 2>/dev/null; then + echo " ✅ iOS included in main Taskfile template" +else + echo " ❌ iOS not included in main Taskfile template" +fi +echo + +echo "6. Checking Xcode tools:" +if command -v xcrun &> /dev/null; then + echo " ✅ xcrun available" + echo " SDK Path: $(xcrun --sdk iphonesimulator --show-sdk-path 2>/dev/null || echo 'Not found')" +else + echo " ❌ xcrun not available" +fi +echo + +echo "7. iOS Build System Summary:" +echo " - Static assets: internal/commands/build_assets/ios/" +echo " - Templates: internal/commands/updatable_build_assets/ios/" +echo " - Implementation: pkg/application/application_ios.*" +echo " - Example: examples/ios-poc/" +echo " - Build script: build_ios.sh" +echo + +echo "=== Verification Complete ===" +echo +echo "The iOS build system structure is in place and ready for:" +echo "1. Creating new iOS projects with 'wails3 init'" +echo "2. Building with 'task ios:build'" +echo "3. Running with 'task ios:run'" +echo +echo "Note: Full compilation requires iOS development environment setup." \ No newline at end of file diff --git a/v3/wep/README.md b/v3/wep/README.md new file mode 100644 index 000000000..63ea57c98 --- /dev/null +++ b/v3/wep/README.md @@ -0,0 +1,69 @@ +# Wails Enhancement Proposal (WEP) Process + +## Introduction + +Welcome to the Wails Enhancement Proposal (WEP) process. This guide outlines the steps for proposing, discussing, and implementing feature enhancements in Wails. The process is divided into two main parts: + +1. **Submission of Proposal**: This part involves documenting your idea, submitting it for review, and discussing it with the community to gather feedback and refine the proposal. +2. **Implementation of Proposal**: Once a proposal is accepted, the implementation phase begins. This involves developing the feature, submitting a PR for the implementation, and iterating based on feedback until the feature is merged and documented. + +Following this structured approach ensures transparency, community involvement, and efficient enhancement of the Wails project. + +**NOTE**: This process is for proposing new functionality. For bug fixes, documentation improvements, and other minor changes, please follow the standard PR process. + +## Submission of Proposal + +### 1. Idea Initiation + +- **Document Your Idea**: + - Create a new directory: `v3/wep/proposals/` with the name of your proposal. + - Copy the WEP template located in `v3/wep/WEP_TEMPLATE.md` into `v3/wep/proposals//proposal.md`. + - Include any additional resources (images, diagrams, etc.) in the proposal directory. + - Fill in the template with the details of your proposal. Do not remove any sections. + +### 2. Submit Proposal + +- **Open a DRAFT PR**: + - Submit a DRAFT Pull Request (PR) for the proposal with the title `[WEP] `. + - It should only contain the proposal file and any additional resources (images, diagrams, etc.). + - Add a summary of the proposal in the PR description. + +### 3. Community Discussion + +- **Share Your Proposal**: Present your proposal to the Wails community. Try to get support for the proposal to increase the chances of acceptance. If you are on the discord server, create a post in the [`#enhancement-proposals`](https://discord.gg/TA8kbQds95) channel. +- **Gather Feedback**: Refine your proposal based on community input. All feedback should be added as comments in the PR. +- **Show Support**: Agreement with the proposal should be indicated by adding a thumbs-up emoji to the PR. The more thumbs-up emojis, the more likely the proposal will be accepted. +- **Iterate**: Make changes to the proposal based on feedback. +- **Agree on an Implementor**: To avoid stagnant proposals, we require someone agree to implement it. This could be the proposer. +- **Ready for Review**: Once the proposal is ready for review, change the PR status to `Ready for Review`. + +A minimum of 2 weeks should be given for community feedback and discussion. + +### 4. Final Decision + +- **Decision**: The Wails maintainers will make a final decision on the proposal based on community feedback and the proposal's merits. + - If accepted, the proposal will be assigned a WEP number and the PR merged. + - If rejected, the reasons will be provided in the PR comments. + +*NOTE*: If a proposal has not met the required support or has been inactive for more than a month, it may be closed. + +## Implementation of Proposal + +Once a proposal has been accepted and an implementation plan has been decided, the focus shifts to bringing the feature to life. This phase encompasses the actual development, review, and integration of the new feature. Here are the steps involved in the implementation process: + +### 1. Develop the Feature + +- **Follow Standards**: Implement the feature following Wails coding standards. +- **Document the Feature**: Ensure the feature is well-documented during the development process. +- **Submit a PR**: Once implemented, submit a PR for the feature. + +### 2. Feedback and Iteration + +- **Gather Feedback**: Collect feedback from the community. +- **Iterate**: Make improvements based on feedback. + +### 3. Merging + +- **Review of PR**: Address any review comments. +- **Merge**: The PR will be merged after satisfactory review. +The WEP process ensures structured and collaborative enhancement of Wails. Adhere to this guide to contribute effectively to the project's growth. \ No newline at end of file diff --git a/v3/wep/WEP_TEMPLATE.md b/v3/wep/WEP_TEMPLATE.md new file mode 100644 index 000000000..c822c2361 --- /dev/null +++ b/v3/wep/WEP_TEMPLATE.md @@ -0,0 +1,50 @@ +# Wails Enhancement Proposal (WEP) + +## Title + +**Author**: [Your Name] +**Created**: [YYYY-MM-DD] + +## Summary + +Provide a concise summary of the proposal. + +## Motivation + +Explain the problem this proposal aims to solve and why it is necessary. + +## Detailed Design + +Provide a detailed description of the proposed feature, including: + +- Technical details +- Implementation steps +- Potential impact on existing functionality + +## Pros/Cons + +List the pros and cons of the proposed solution. + +## Alternatives Considered + +Discuss alternative solutions or approaches that were considered. + +## Backwards Compatibility + +Address any potential backward compatibility issues. + +## Test Plan + +Outline a testing strategy to ensure the feature works as expected. + +## Reference Implementation + +If applicable, include a link to a reference implementation or prototype. + +## Maintenance Plan + +Describe how the feature will be maintained and supported in the long term. + +## Conclusion + +Summarize the benefits of the proposal and any final considerations. diff --git a/v3/wep/proposals/.gitkeep b/v3/wep/proposals/.gitkeep new file mode 100644 index 000000000..e69de29bb diff --git a/v3/wep/proposals/titlebar-buttons/proposal.md b/v3/wep/proposals/titlebar-buttons/proposal.md new file mode 100644 index 000000000..8bd6b8c4f --- /dev/null +++ b/v3/wep/proposals/titlebar-buttons/proposal.md @@ -0,0 +1,137 @@ +# Wails Enhancement Proposal (WEP) + +## Customising Window Controls in Wails + +**Author**: Lea Anthony +**Created**: 2024-05-20 + +## Summary + +This is a proposal for an API to control the appearance and functionality of window controls in Wails. +This will only be available on Windows and macOS. + +## Motivation + +We currently do not fully support the ability to customise window controls. + +## Detailed Design + +### Controlling Button State + +1. A new enum will be added: + +```go + type ButtonState int + + const ( + ButtonEnabled ButtonState = 0 + ButtonDisabled ButtonState = 1 + ButtonHidden ButtonState = 2 + ) +``` + +2. These options will be added to the `WebviewWindowOptions` option struct: + +```go + MinimiseButtonState ButtonState + MaximiseButtonState ButtonState + CloseButtonState ButtonState +``` + +3. These options will be removed from the current Windows/Mac options: + +- DisableMinimiseButton +- DisableMaximiseButton +- DisableCloseButton + +4. These methods will be added to the `Window` interface: + +```go + SetMinimizeButtonState(state ButtonState) + SetMaximizeButtonState(state ButtonState) + SetCloseButtonState(state ButtonState) +``` + +The settings translate to the following functionality on each platform: + +| | Windows | Mac | +|-----------------------|------------------------|------------------------| +| Disable Min/Max/Close | Disables Min/Max/Close | Disables Min/Max/Close | +| Hide Min | Disables Min | Hides Min button | +| Hide Max | Disables Max | Hides Max button | +| Hide Close | Hides all controls | Hides Close | + +Note: On Windows, it is not possible to hide the Min/Max buttons individually. +However, disabling both will hide both of the controls and only show the +close button. + +### Controlling Window Style (Windows) + +As Windows currently does not have much in the way of controlling the style of the +titlebar, a new option will be added to the `WebviewWindowOptions` option struct: + +```go + ExStyle int +``` + +If this is set, then the new Window will use the style specified in the `ExStyle` field. + +Example: +```go +package main + +import ( + "github.com/wailsapp/wails/v3/pkg/application" + "github.com/wailsapp/wails/v3/pkg/w32" +) + +func main() { + app := application.New(application.Options{ + Name: "My Application", + }) + + app.NewWebviewWindowWithOptions(application.WebviewWindowOptions{ + Windows: application.WindowsWindow{ + ExStyle: w32.WS_EX_TOOLWINDOW | w32.WS_EX_NOREDIRECTIONBITMAP | w32.WS_EX_TOPMOST, + }, + }) + + app.Run() +} +``` + +## Pros/Cons + +### Pros + +- We bring much needed customisation capabilities to both macOS and Windows + +### Cons + +- Windows works slightly different to macOS +- No Linux support (doesn't look like it's possible regardless of the solution) + +## Alternatives Considered + +The alternative is to draw your own titlebar, but this is a lot of work and often doesn't look good. + +## Backwards Compatibility + +This is not backwards compatible as we remove the old "disable button" options. + +## Test Plan + +As part of the implementation, the window example will be updated to test the functionality. + +## Reference Implementation + +There is a reference implementation as part of this proposal. + +## Maintenance Plan + +This feature will be maintained and supported by the Wails developers. + +## Conclusion + +This API would be a leap forward in giving developers greater control over their application window appearances. + diff --git a/website/blog/2025-03-16-security-incident-response.mdx b/website/blog/2025-03-16-security-incident-response.mdx deleted file mode 100644 index e9903c570..000000000 --- a/website/blog/2025-03-16-security-incident-response.mdx +++ /dev/null @@ -1,89 +0,0 @@ ---- -slug: security-incident-response-march-2025 -title: Proactive Security Response - GitHub Actions Supply Chain Attack -authors: [leaanthony] -tags: [wails, security] ---- - -<div class="text--center"> - <img - src={require("@site/static/img/blog/shield.png").default} - width="150" - alt="Security Shield" - /> -</div> -<br /> - -:::note TL;DR -**Good news! Wails was NOT affected by this security incident.** Our thorough investigation confirmed that no secrets were leaked, and the Wails codebase and releases remain completely secure. We've already taken proactive measures to further strengthen our security posture. -::: - -## Introduction - -On 15th March 2025 (AEST), the Wails team was alerted to a security incident involving the `tj-actions/changed-files` GitHub Action. This widely-used action (with over 23,000 repositories depending on it) was compromised in a supply chain attack. While this action was used in some of our CI/CD workflows, we're pleased to confirm that Wails remained fully protected throughout. - -This post shares the details of the incident, our response, and the additional safeguards we've implemented to ensure the continued security of the Wails project. - -## Incident Details - -The security company StepSecurity [reported](https://www.stepsecurity.io/blog/harden-runner-detection-tj-actions-changed-files-action-is-compromised) that the `tj-actions/changed-files` GitHub Action was compromised beginning around 9:00 AM March 14th, 2025 Pacific Time (4:00 PM UTC). - -In this attack, malicious code was injected into the action that attempted to dump CI/CD secrets from GitHub Actions runner processes into public logs. The attackers modified the action's code and retroactively updated multiple version tags to reference the malicious commit. - -## Our Proactive Assessment - -Upon learning this, we immediately launched a comprehensive assessment of our systems: - -1. We identified the following Wails workflows that were using the action: - - For Wails v2: `pr-v2.yml` and `upload-source-documents.yml` - - For Wails v3: `pr-v3.yml`, `publish-npm.yml`, and `upload-source-documents.yml` - -2. Our security team conducted a thorough review of all workflow logs for the affected actions during the time period of the compromise. - -3. We're happy to confirm that **no secrets were leaked** in any of our workflow logs, and the Wails codebase remained completely secure. - -## Action Taken - -We took immediate steps to address this situation: - -1. We swiftly replaced all instances of the affected `tj-actions/changed-files` action with the secure alternative `step-security/changed-files` provided by StepSecurity. - -2. As an extra precautionary measure, we temporarily removed all secrets from our GitHub Actions workflows. - -## What This Means for You - -We want to reassure our community that: - -1. The Wails codebase was never compromised in any way. -2. No malicious code was introduced into any Wails releases. -3. This situation only potentially affected our CI/CD pipeline, not the actual Wails source code or releases. -4. No sensitive information or secrets were exposed during this time. - -**In short: All Wails releases remain secure and trustworthy, and no action is required on your part.** - -## Strengthening Our Security Posture - -To minimise exposure to similar potential incidents in the future, we're enhancing our security practices by: - -1. Implementing stricter version pinning for all third-party actions used in our workflows, preferably pinning to specific commit hashes rather than version tags. - -2. Establishing a regular security review process for our CI/CD pipelines and dependencies. - -3. Exploring the use of additional security tools like StepSecurity's Harden-Runner to provide enhanced protection for our GitHub Actions workflows. - -4. Developing a more comprehensive security incident response plan to ensure we can respond quickly and effectively to any future security concerns. - -It's worth noting that the Wails project already employs several security tools as part of our development process: - -- **Semgrep**: We use Semgrep for static code analysis to identify potential security vulnerabilities and code quality issues. -- **Snyk**: We employ Snyk to continuously monitor our dependencies for known vulnerabilities and receive alerts when security patches are needed. - -These existing security measures, combined with our enhanced preventative steps, demonstrate our ongoing commitment to maintaining the security and integrity of the Wails project. - -## Moving Forward - -The security of the Wails project and the trust of our community are our highest priorities. We remain committed to transparency and will continue to promptly address any security concerns that arise. - -We would like to thank StepSecurity for their quick response in identifying this issue and providing a secure alternative action. - -If you have any questions or concerns about this, please don't hesitate to reach out to us on [GitHub](https://github.com/wailsapp/wails) or [Discord](https://discord.gg/JDdSxwjhGf). We're always here to help. diff --git a/website/bun.lockb b/website/bun.lockb deleted file mode 100644 index 63ed1b159..000000000 Binary files a/website/bun.lockb and /dev/null differ diff --git a/website/docs/community/showcase/clustta.mdx b/website/docs/community/showcase/clustta.mdx deleted file mode 100644 index 7da3195df..000000000 --- a/website/docs/community/showcase/clustta.mdx +++ /dev/null @@ -1,27 +0,0 @@ ---- -title: Clustta -description: File manager and project management tool for creative professionals. -slug: /community/showcase/clustta -image: /img/showcase/clustta.png ---- - -<div className="text--center"> - <img src="/img/showcase/clustta.png" alt="Clustta screenshot" loading="lazy" /> -</div> - -[Clustta](https://clustta.com) is a file manager and project management tool designed for creative professionals. Built with Wails, it simplifies file management, collaboration, and version control for creative workflows. - -## Features - -- **File Management**: Track all projects and files with easy access even months after completion. -- **Version Control**: Save unlimited revisions with descriptive notes, without duplicating files. -- **Collaboration**: Share files or entire projects securely through simple user tags with fine-grained permissions. -- **Recovery**: Restore corrupted files from saved checkpoints if your software crashes. -- **Templates**: Quick start with preset project and task templates. -- **Kanban Boards**: Visual task tracking to keep tasks organized. -- **Dependencies**: Track and version project resources and dependencies. -- **Checkpoints**: Create memorable milestones and explore alternate creative directions non-destructively. -- **Search & Filters**: Powerful instant search with metadata filtering (task types, tags, status, file extensions). -- **Workspaces**: Save search and filter combinations for easy access to specific task sets. -- **Integrations**: Connect with creative software packages and production management tools like Blender and Kitsu. -- **Self-Hosting**: Host private instances for teams or studios on your own servers. diff --git a/website/docs/community/showcase/gamestacker.mdx b/website/docs/community/showcase/gamestacker.mdx deleted file mode 100644 index 46245e146..000000000 --- a/website/docs/community/showcase/gamestacker.mdx +++ /dev/null @@ -1,19 +0,0 @@ ---- -title: GameStacker -description: A modern, console-like interface that unifies your game libraries. -slug: /community/showcase/gamestacker -image: /img/showcase/gamestacker.webp ---- - -<div className="text--center"> - <img src="/img/showcase/gamestacker.webp" alt="GameStacker main dashboard" loading="lazy" /> -</div> - -[GameStacker](https://gamestacker.io) is a modern, elegant console-like interface that unifies your entire game collection into one beautiful dashboard. - -## Features - -- **Unified Library**: Automatically detects and imports games from external libraries (such as Steam, LaunchBox, and RetroBat), bringing your modern and retro collections into a single, cohesive interface. -- **True Console Experience**: Built for controllers with responsive navigation, UI sound effects, and a dedicated in-game "Guide" overlay to control music and manage your session without alt-tabbing. -- **Achievement Integration**: Tracks your progress across supported services, allowing you to view unlocks and Gamerscore directly from the dashboard. -- **Multi-Profile Support**: Create unique profiles with custom avatars and specific color themes for a personalized experience. diff --git a/website/docs/community/showcase/grpcmd-gui.mdx b/website/docs/community/showcase/grpcmd-gui.mdx deleted file mode 100644 index 891350290..000000000 --- a/website/docs/community/showcase/grpcmd-gui.mdx +++ /dev/null @@ -1,10 +0,0 @@ -# grpcmd-gui - -```mdx-code-block -<p style={{ "text-align": "center" }}> - <img src={require("@site/static/img/showcase/grpcmd-gui.webp").default} /> - <br /> -</p> -``` - -[grpcmd-gui](https://grpc.md/gui) is a modern cross-platform desktop app and API client for gRPC development and testing. diff --git a/website/docs/community/showcase/kafka-king.mdx b/website/docs/community/showcase/kafka-king.mdx deleted file mode 100644 index 0ba78a6ad..000000000 --- a/website/docs/community/showcase/kafka-king.mdx +++ /dev/null @@ -1,22 +0,0 @@ -# Kafka-King - -```mdx-code-block -<p style={{ "text-align": "center" }}> - <img src={require("@site/static/img/showcase/kafka-King-img_3.webp").default} /> - <br /> -</p> -``` - -[Kafka-King](https://github.com/Bronya0/Kafka-King) is a kafka GUI client that supports various systems and is compact and easy to use. -This is made of Wails+vue3 - -# Kafka-King function list -- [x] View the cluster node list, support dynamic configuration of broker and topic configuration items -- [x] Supports consumer clients, consumes the specified topic, size, and timeout according to the specified group, and displays the message information in various dimensions in a table -- [x] Supports PLAIN, SSL, SASL, kerberos, sasl_plaintext, etc. etc. -- [x] Create topics (support batches), delete topics, specify replicas, partitions -- [x] Support statistics of the total number of messages, total number of submissions, and backlog for each topic based on consumer groups -- [x] Support viewing topics Detailed information (offset) of the partition, and support adding additional partitions -- [x] Support simulated producers, batch sending messages, specify headers, partitions -- [x] Health check -- [x] Support viewing consumer groups , Consumer- …… diff --git a/website/docs/community/showcase/marasi.mdx b/website/docs/community/showcase/marasi.mdx deleted file mode 100644 index 5ff137523..000000000 --- a/website/docs/community/showcase/marasi.mdx +++ /dev/null @@ -1,22 +0,0 @@ -# Marasi - -```mdx-code-block -<p style={{ "text-align": "center" }}> - <img src={require("@site/static/img/showcase/marasi.webp").default} /> - <br /> -</p> -``` - -[Marasi](https://marasi.app/) is an open source application security testing proxy, it lets you intercept, inspect, modify, and extend requests as they flow through your applications. Read more about it on the [blog](https://marasi.app/blog/2025/introducing_marasi/). - -## Features - -- Desktop GUI Interface: Cross-platform desktop application built with Wails -- HTTP/HTTPS Proxy: TLS-capable proxy server with certificate management -- Request/Response Interception: Modify traffic in real-time with an intuitive interface -- Lua Extensions: Scriptable proxy behavior with built-in extensions -- Project Management: SQLite-based storage for all proxy data (requests, responses, metadata) -- Launchpad: Replay and modify HTTP requests -- Scope Management: Filter traffic with inclusion/exclusion rules -- Waypoints: Override hostnames for request routing -- Chrome Integration: Auto-configure Chrome with proxy settings \ No newline at end of file diff --git a/website/docs/community/showcase/minesweeper-xp.mdx b/website/docs/community/showcase/minesweeper-xp.mdx deleted file mode 100644 index f127a005f..000000000 --- a/website/docs/community/showcase/minesweeper-xp.mdx +++ /dev/null @@ -1,10 +0,0 @@ -# Minesweeper XP - -```mdx-code-block -<p style={{ "text-align": "center" }}> - <img src={require("@site/static/img/showcase/minesweeper-xp.webp").default} /> - <br /> -</p> -``` - -[Minesweeper-XP](https://git.new/Minesweeper-XP) allows you to experience the classic Minesweeper XP (+ 98 and 3.1) on macOS, Windows, and Linux! diff --git a/website/docs/community/showcase/resizem.mdx b/website/docs/community/showcase/resizem.mdx deleted file mode 100644 index 27f168f48..000000000 --- a/website/docs/community/showcase/resizem.mdx +++ /dev/null @@ -1,10 +0,0 @@ -# Resizem - -```mdx-code-block -<p style={{ "text-align": "center" }}> - <img src={require("@site/static/img/showcase/resizem.webp").default} /> - <br /> -</p> -``` - -[Resizem](https://github.com/barats/resizem) - is an app designed for bulk image process. It is particularly useful for users who need to resize, convert, and manage large numbers of image files at once. diff --git a/website/docs/community/showcase/upbeat.mdx b/website/docs/community/showcase/upbeat.mdx deleted file mode 100644 index 2f85b6cce..000000000 --- a/website/docs/community/showcase/upbeat.mdx +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: UpBeat -description: An RSS/Atom Feed Reader that filters out negative news with locally run ML models. -slug: /community/showcase/upbeat -image: /img/showcase/upbeat.png ---- - -<div className="text--center"> - <img src="/img/showcase/upbeat.png" alt="UpBeat screenshot" loading="lazy" /> -</div> - -[UpBeat](https://upbeat.mitchelltechnologies.co.uk) is An RSS/Atom Feed Reader for macOS that filters out negative news with locally running ML models. - -## Features - -- **Local ML**: UpBeat runs a transformer-based sentiment analysis model directly on your Mac's hardware. No waiting for a Cloud GPU to spin up before you can decide what you want to read -- **Apple Neural Engine Enabled**: UpBeat runs its ML models directly on the Neural Engine of Macs. That means you get super-fast inference, but without burning through your battery or electricity bill. -- **Widely Compatible**: Works with the vast majority of RSS + Atom versions. diff --git a/website/docs/community/showcase/wailsterm.mdx b/website/docs/community/showcase/wailsterm.mdx deleted file mode 100644 index 9924dace5..000000000 --- a/website/docs/community/showcase/wailsterm.mdx +++ /dev/null @@ -1,10 +0,0 @@ -# WailsTerm - -```mdx-code-block -<p style={{ "text-align": "center" }}> - <img src={require("@site/static/img/showcase/wailsterm.webp").default} /> - <br /> -</p> -``` - -[WailsTerm](https://github.com/rlshukhov/wailsterm) is a simple translucent terminal app powered by Wails and Xterm.js. diff --git a/website/docs/community/templates.mdx b/website/docs/community/templates.mdx index 3b020b60b..446896849 100644 --- a/website/docs/community/templates.mdx +++ b/website/docs/community/templates.mdx @@ -27,8 +27,6 @@ If you are unsure about a template, inspect `package.json` and `wails.json` for - [wails-template-quasar-js](https://github.com/sgosiaco/wails-template-quasar-js) - A template using JavaScript + Quasar V2 (Vue 3, Vite, Sass, Pinia, ESLint, Prettier) - [wails-template-quasar-ts](https://github.com/sgosiaco/wails-template-quasar-ts) - A template using TypeScript + Quasar V2 (Vue 3, Vite, Sass, Pinia, ESLint, Prettier, Composition API with <script setup>) - [wails-template-naive](https://github.com/tk103331/wails-template-naive) - Wails template based on Naive UI (A Vue 3 Component Library) -- [wails-template-primevue-sakai](https://github.com/TekWizely/wails-template-primevue-sakai) - Wails starter using [PrimeVue's Sakai Application Template](https://sakai.primevue.org) (Vite, Vue, PrimeVue, TailwindCSS, Vue Router, Themes, Dark Mode, UI Components, and more) -- [wails-template-tdesign-js](https://github.com/tongque0/wails-template-tdesign-js) - Wails template based on TDesign UI (a Vue 3 UI library by Tencent), using Vite, Pinia, Vue Router, ESLint, and Prettier. ## Angular @@ -42,20 +40,15 @@ If you are unsure about a template, inspect `package.json` and `wails.json` for - [wails-template-nextjs](https://github.com/LGiki/wails-template-nextjs) - A template using Next.js and TypeScript - [wails-template-nextjs-app-router](https://github.com/thisisvk-in/wails-template-nextjs-app-router) - A template using Next.js and TypeScript with App router - [wails-vite-react-ts-tailwind-template](https://github.com/hotafrika/wails-vite-react-ts-tailwind-template) - A template for React + TypeScript + Vite + TailwindCSS -- [Wails-vite-ts-tailwindcss-shadcn-template-2025](https://github.com/darkb0ts/Wails-vite-ts-tailwindcss-shadcn-template-2025) - A template for React + TypeScript + Vite - [wails-vite-react-ts-tailwind-shadcnui-template](https://github.com/Mahcks/wails-vite-react-tailwind-shadcnui-ts) - A template with Vite, React, TypeScript, TailwindCSS, and shadcn/ui -- [wails-nextjs-tailwind-template](https://github.com/kairo913/wails-nextjs-tailwind-template) - A template using Next.js and Typescript with TailwindCSS ## Svelte - [wails-svelte-template](https://github.com/raitonoberu/wails-svelte-template) - A template using Svelte - [wails-vite-svelte-template](https://github.com/BillBuilt/wails-vite-svelte-template) - A template using Svelte and Vite -- [wails-vite-svelte-ts-tailwind-template](https://github.com/xvertile/wails-vite-svelte-tailwind-template) - A template using Wails, Svelte, Vite, TypeScript, and TailwindCSS v3 - [wails-vite-svelte-tailwind-template](https://github.com/BillBuilt/wails-vite-svelte-tailwind-template) - A template using Svelte and Vite with TailwindCSS v3 - [wails-svelte-tailwind-vite-template](https://github.com/PylotLight/wails-vite-svelte-tailwind-template/tree/master) - An updated template using Svelte v4.2.0 and Vite with TailwindCSS v3.3.3 - [wails-sveltekit-template](https://github.com/h8gi/wails-sveltekit-template) - A template using SvelteKit -- [wails-template-sveltekit-less-prettier-eslint](https://github.com/Alex6357/wails-template-sveltekit-less-prettier-eslint) - A template using SvelteKit with less, Prettier and ESlint -- [wails-template-svelte-ts-less-prettier-eslint-vite](https://github.com/Alex6357/wails-template-svelte-ts-less-prettier-eslint-vite) - A template using Svelte5 + TypeScript + less + Prettier + ESlint + Vite ## Solid @@ -69,7 +62,6 @@ If you are unsure about a template, inspect `package.json` and `wails.json` for ## HTMX -- [wails-htmx-tailwind-daisyui-template](https://github.com/ltcovalt/wails-htmx-tailwind-daisyui-template) - HTMX template using Tailwind CSS + daisyUI for styling and the Go standard library for routing and HTML templating - [wails-htmx-templ-chi-tailwind](https://github.com/PylotLight/wails-hmtx-templ-template) - Use a unique combination of pure htmx for interactivity plus templ for creating components and forms ## Pure JavaScript (Vanilla) diff --git a/website/docs/gettingstarted/firstproject.mdx b/website/docs/gettingstarted/firstproject.mdx index 5cf4dff58..05f98c2d3 100644 --- a/website/docs/gettingstarted/firstproject.mdx +++ b/website/docs/gettingstarted/firstproject.mdx @@ -8,6 +8,10 @@ sidebar_position: 2 Now that the CLI is installed, you can generate a new project by using the `wails init` command. +:::tip[Performance Tip for Windows 11 Users] +Consider using [Dev Drive](https://learn.microsoft.com/en-us/windows/dev-drive/) to store your projects. Dev Drives are optimized for developer workloads and can significantly improve build times and disk access speeds by up to 30% compared to regular NTFS drives. +::: + Pick your favourite framework: ```mdx-code-block @@ -128,3 +132,5 @@ The `frontend` directory has nothing specific to Wails and can be any frontend p The `build` directory is used during the build process. These files may be updated to customise your builds. If files are removed from the build directory, default versions will be regenerated. + +The default module name in `go.mod` is "changeme". You should change this to something more appropriate. diff --git a/website/docs/gettingstarted/installation.mdx b/website/docs/gettingstarted/installation.mdx index 6189c6d83..2fa095904 100644 --- a/website/docs/gettingstarted/installation.mdx +++ b/website/docs/gettingstarted/installation.mdx @@ -7,7 +7,7 @@ sidebar_position: 1 ## Supported Platforms - Windows 10/11 AMD64/ARM64 -- MacOS 10.15+ AMD64 for development, MacOS 10.13+ for release +- MacOS 10.13+ AMD64 - MacOS 11.0+ ARM64 - Linux AMD64/ARM64 @@ -15,7 +15,7 @@ sidebar_position: 1 Wails has a number of common dependencies that are required before installation: -- Go 1.21+ (macOS 15+ requires Go 1.23.3+) +- Go 1.20+ - NPM (Node 15+) ### Go @@ -55,17 +55,11 @@ import TabItem from "@theme/TabItem"; </TabItem> <TabItem value="Windows"> Wails requires that the <a href="https://developer.microsoft.com/en-us/microsoft-edge/webview2/">WebView2</a> runtime is installed. Some Windows installations will already have this installed. You can check using the <code>wails doctor</code> command. + <br/><br/> + <strong>Performance Tip:</strong> For Windows 11 users, consider using <a href="https://learn.microsoft.com/en-us/windows/dev-drive/">Dev Drive</a> to store your projects. Dev Drives are optimized for developer workloads and can significantly improve build times and disk access speeds by up to 30% compared to regular NTFS drives. </TabItem> <TabItem value={"Linux"}> Linux requires the standard <code>gcc</code> build tools plus <code>libgtk3</code> and <code>libwebkit</code>. Rather than list a ton of commands for different distros, Wails can try to determine what the installation commands are for your specific distribution. Run <code>wails doctor</code> after installation to be shown how to install the dependencies. If your distro/package manager is not supported, please consult the <a href={"/docs/guides/linux-distro-support"}>Add Linux Distro</a> guide. - <br/><strong>Note:</strong><br/> - If you are using latest Linux version (example: Ubuntu 24.04) and it is not supporting <code>libwebkit2gtk-4.0-dev</code>, then you might encounter an issue in <code>wails doctor</code>: <code>libwebkit</code> not found. To resolve this issue you can install <code>libwebkit2gtk-4.1-dev</code> and during your build use the tag <code>-tags webkit2_41</code>. - <br/><br/> - After installing Wails via Go, ensure you run the following commands to update your PATH: - <br/> - <code>export PATH=$PATH:$(go env GOPATH)/bin</code> - <br/> - <code>source ~/.bashrc</code> or <code>source ~/.zshrc</code> </TabItem> </Tabs> ``` @@ -84,9 +78,7 @@ Note: If you get an error similar to this: ```shell ....\Go\pkg\mod\github.com\wailsapp\wails\v2@v2.1.0\pkg\templates\templates.go:28:12: pattern all:ides/*: no matching files found ``` - please check you have Go 1.18+ installed: - ```shell go version ``` diff --git a/website/docs/guides/application-development.mdx b/website/docs/guides/application-development.mdx index adefa4b04..78a6df3bc 100644 --- a/website/docs/guides/application-development.mdx +++ b/website/docs/guides/application-development.mdx @@ -10,10 +10,6 @@ The pattern used by the default templates are that `main.go` is used for configu The `app.go` file will define a struct that has 2 methods which act as hooks into the main application: ```go title="app.go" -import ( - "context" -) - type App struct { ctx context.Context } @@ -32,7 +28,7 @@ func (a *App) shutdown(ctx context.Context) { - The startup method is called as soon as Wails allocates the resources it needs and is a good place for creating resources, setting up event listeners and anything else the application needs at startup. - It is given a [`context.Context`](https://pkg.go.dev/context) which is usually saved in a struct field. This context is needed for calling the + It is given a `context.Context` which is usually saved in a struct field. This context is needed for calling the [runtime](../reference/runtime/intro.mdx). If this method returns an error, the application will terminate. In dev mode, the error will be output to the console. @@ -59,6 +55,7 @@ func main() { log.Fatal(err) } } + ``` More information on application lifecycle hooks can be found [here](../howdoesitwork.mdx#application-lifecycle-callbacks). @@ -68,12 +65,7 @@ More information on application lifecycle hooks can be found [here](../howdoesit It is likely that you will want to call Go methods from the frontend. This is normally done by adding public methods to the already defined struct in `app.go`: -```go {3,21-23} title="app.go" -import ( - "context" - "fmt" -) - +```go {16-18} title="app.go" type App struct { ctx context.Context } @@ -90,7 +82,7 @@ func (a *App) shutdown(ctx context.Context) { } func (a *App) Greet(name string) string { - return fmt.Sprintf("Hello %s!", name) + return fmt.Sprintf("Hello %s!", name) } ``` @@ -107,14 +99,15 @@ func main() { Height: 600, OnStartup: app.startup, OnShutdown: app.shutdown, - Bind: []interface{}{ - app, - }, + Bind: []interface{}{ + app, + }, }) if err != nil { log.Fatal(err) } } + ``` This will bind all public methods in our `App` struct (it will never bind the startup and shutdown methods). @@ -140,10 +133,10 @@ func main() { otherStruct.SetContext(ctx) }, OnShutdown: app.shutdown, - Bind: []interface{}{ - app, + Bind: []interface{}{ + app, otherStruct - }, + }, }) if err != nil { log.Fatal(err) @@ -194,17 +187,18 @@ func main() { Height: 600, OnStartup: app.startup, OnShutdown: app.shutdown, - Bind: []interface{}{ - app, - }, - EnumBind: []interface{}{ - AllWeekdays, - }, + Bind: []interface{}{ + app, + }, + EnumBind: []interface{}{ + AllWeekdays, + }, }) if err != nil { log.Fatal(err) } } + ``` This will add missing enums to your `model.ts` file. @@ -229,14 +223,15 @@ func main() { OnStartup: app.startup, OnShutdown: app.shutdown, Menu: app.menu(), - Bind: []interface{}{ - app, - }, + Bind: []interface{}{ + app, + }, }) if err != nil { log.Fatal(err) } } + ``` ## Assets @@ -263,7 +258,7 @@ create files on the fly or process POST/PUT requests. GET requests are always first handled by the `assets` FS. If the FS doesn't find the requested file the request will be forwarded to the `http.Handler` for serving. Any requests other than GET will be directly processed by the `AssetsHandler` if specified. -It's also possible to only use the `AssetsHandler` by specifying `nil` as the `Assets` option. +It's also possible to only use the `AssetsHandler` by specifiy `nil` as the `Assets` option. ## Built in Dev Server diff --git a/website/docs/guides/crossplatform-build.mdx b/website/docs/guides/crossplatform-build.mdx index f6fbc0f06..a9afc6161 100644 --- a/website/docs/guides/crossplatform-build.mdx +++ b/website/docs/guides/crossplatform-build.mdx @@ -60,6 +60,6 @@ jobs: This example offers opportunities for various enhancements, including: - Caching dependencies - Code signing -- Uploading to platforms like S3, Supabase, etc. +- Uploading to platforms like S3, Supbase, etc. - Injecting secrets as environment variables - Utilizing environment variables as build variables (such as version variable extracted from the current Git tag) diff --git a/website/docs/guides/custom-protocol-schemes.mdx b/website/docs/guides/custom-protocol-schemes.mdx index 216fb7100..c56634f0e 100644 --- a/website/docs/guides/custom-protocol-schemes.mdx +++ b/website/docs/guides/custom-protocol-schemes.mdx @@ -59,24 +59,6 @@ func main() { } ``` -If you want to handle universal links as well, follow this [guide](https://developer.apple.com/documentation/xcode/supporting-universal-links-in-your-app) to add required entitlements, add required keys to Info.plist and configure `apple-app-site-association` on your website. - -Here is example for Info.plist: -```xml -<key>NSUserActivityTypes</key> -<array> - <string>NSUserActivityTypeBrowsingWeb</string> -</array> -``` - -And for entitlements.plist -```xml -<key>com.apple.developer.associated-domains</key> -<array> - <string>applinks:myawesomeapp.com</string> -</array> -``` - ### Windows On Windows Custom Protocol Schemes is supported only with NSIS installer. During installation, the installer will create a diff --git a/website/docs/guides/frontend.mdx b/website/docs/guides/frontend.mdx index 2c3c78e42..1384087da 100644 --- a/website/docs/guides/frontend.mdx +++ b/website/docs/guides/frontend.mdx @@ -45,7 +45,7 @@ The options are as follows: | noautoinjectipc | Disable the autoinjection of `/wails/ipc.js` | | noautoinject | Disable all autoinjection of scripts | -Multiple options may be used provided they are comma separated. +Multiple options may be used provided they are comma seperated. This code is perfectly valid and operates the same as the autoinjection version: diff --git a/website/docs/guides/linux-distro-support.mdx b/website/docs/guides/linux-distro-support.mdx index b64ed0c03..3cf73a7ae 100644 --- a/website/docs/guides/linux-distro-support.mdx +++ b/website/docs/guides/linux-distro-support.mdx @@ -108,3 +108,86 @@ Take a look at the other package managers code to get an idea how this works. If you add support for a new package manager, don't forget to also update this page! ::: + +## Runtime Dependencies + +When distributing your Wails application, end users need the GTK3 and WebKit2GTK runtime libraries installed. +The package names vary by distribution: + +| Distribution | GTK3 | WebKit2GTK | ABI | Installation Command | +|--------------|------|------------|-----|---------------------| +| Debian 12 / Ubuntu 22.04+ | libgtk-3-0 | libwebkit2gtk-4.1-0 | 4.1 | `apt install libgtk-3-0 libwebkit2gtk-4.1-0` | +| Debian 11 / Ubuntu 20.04 | libgtk-3-0 | libwebkit2gtk-4.0-37 | 4.0 | `apt install libgtk-3-0 libwebkit2gtk-4.0-37` | +| Fedora 40+ | gtk3 | webkit2gtk4.1 | 4.1 | `dnf install gtk3 webkit2gtk4.1` | +| RHEL / CentOS / AlmaLinux / Rocky 8-9 | gtk3 | webkit2gtk3 | 4.0 | `dnf install gtk3 webkit2gtk3` | +| openSUSE Leap / Tumbleweed | libgtk-3-0 | libwebkit2gtk-4_1-0 | 4.1 | `zypper install libgtk-3-0 libwebkit2gtk-4_1-0` | +| Arch Linux / Manjaro | gtk3 | webkit2gtk-4.1 | 4.1 | `pacman -S gtk3 webkit2gtk-4.1` | + +### WebKit2GTK ABI Versions + +WebKit2GTK has two ABI versions: +- **ABI 4.1** - Modern version, used by most current distributions +- **ABI 4.0** - Legacy version, required for older distributions (Debian 11, Ubuntu 20.04, RHEL/CentOS 8-9) + +When building your application, use the appropriate build tag: +- `-tags webkit2_41` for distributions with ABI 4.1 (default for most modern distros) +- `-tags webkit2_40` for RHEL-based systems and older Debian/Ubuntu + +### Notes + +- openSUSE provides both WebKitGTK 4.0 and 4.1; use `libwebkit2gtk-4_1-0` for the modern ABI +- Fedora only has `webkit2gtk4.1` starting from version 40; earlier versions use 4.0 +- On RHEL/AlmaLinux/Rocky/CentOS 8-9, `webkit2gtk3` corresponds to ABI 4.0; 4.1 is not available +- Arch Linux offers both `webkit2gtk` (4.0) and `webkit2gtk-4.1`; use the latter for modern ABI + +## Packaging with nfpm + +When creating Linux packages with [nfpm](https://nfpm.goreleaser.com/), you need to specify the correct dependencies for each distribution. + +### For Debian 12 / Ubuntu 22.04+ / openSUSE / Arch Linux (ABI 4.1) + +```yaml +depends: + - libgtk-3-0 + - libwebkit2gtk-4.1-0 +overrides: + rpm: + depends: + - libgtk-3-0 + - libwebkit2gtk-4_1-0 + archlinux: + depends: + - gtk3 + - webkit2gtk-4.1 +``` + +### For RHEL / CentOS / AlmaLinux / Rocky and older Debian/Ubuntu (ABI 4.0) + +```yaml +depends: + - gtk3 + - webkit2gtk3 +overrides: + deb: + depends: + - libgtk-3-0 + - libwebkit2gtk-4.0-37 + archlinux: + depends: + - gtk3 + - webkit2gtk +``` + +### For Fedora 40+ + +```yaml +depends: + - gtk3 + - webkit2gtk4.1 +``` + +:::tip + +To support multiple distributions, you may need separate nfpm configuration files for different ABI versions. + +::: diff --git a/website/docs/guides/linux.mdx b/website/docs/guides/linux.mdx index 2cfc2e62a..1b55297b5 100644 --- a/website/docs/guides/linux.mdx +++ b/website/docs/guides/linux.mdx @@ -70,57 +70,3 @@ If the added package does not resolve the issue, additional GStreamer dependenci - This issue impacts [Tauri apps](https://tauri.app/). Source: [developomp](https://github.com/developomp) on the [Tauri discussion board](https://github.com/tauri-apps/tauri/issues/4642#issuecomment-1643229562). - -## Panic Recovery / Signal Handling Issues - -### App crashes with "non-Go code set up signal handler without SA_ONSTACK flag" - -On Linux, if your application crashes with an error like: - -``` -signal 11 received but handler not on signal stack -fatal error: non-Go code set up signal handler without SA_ONSTACK flag -``` - -This occurs because WebKit (used for the webview) installs signal handlers that interfere with Go's panic recovery mechanism. -Normally, Go can convert signals like SIGSEGV (from nil pointer dereferences) into recoverable panics, but WebKit's signal -handlers prevent this. - -### Solution - -Use the `runtime.ResetSignalHandlers()` function immediately before code that might panic: - -```go -import "github.com/wailsapp/wails/v2/pkg/runtime" - -go func() { - defer func() { - if err := recover(); err != nil { - log.Printf("Recovered from panic: %v", err) - } - }() - // Reset signal handlers right before potentially dangerous code - runtime.ResetSignalHandlers() - - // Your code that might panic... -}() -``` - -:::warning Important - -- Call `ResetSignalHandlers()` in each goroutine where you need panic recovery -- Call it immediately before the code that might panic, as WebKit may reset the handlers at any time -- This is only necessary on Linux - the function is a no-op on other platforms - -::: - -### Why This Happens - -WebKit installs its own signal handlers for garbage collection and other internal processes. These handlers don't include -the `SA_ONSTACK` flag that Go requires to properly handle signals on the correct stack. When a signal like SIGSEGV occurs, -Go's runtime can't recover because the signal is being handled on the wrong stack. - -The `ResetSignalHandlers()` function adds the `SA_ONSTACK` flag to the signal handlers for SIGSEGV, SIGBUS, SIGFPE, and -SIGABRT, allowing Go's panic recovery to work correctly. - -Source: [GitHub Issue #3965](https://github.com/wailsapp/wails/issues/3965) diff --git a/website/docs/guides/mac-appstore.mdx b/website/docs/guides/mac-appstore.mdx index 708528987..d2c3a9458 100644 --- a/website/docs/guides/mac-appstore.mdx +++ b/website/docs/guides/mac-appstore.mdx @@ -62,7 +62,7 @@ This is an example entitlements file from the [RiftShare](https://github.com/ach ``` **Add the Embedded Provisioning Profile** -The Provisioning Profile created above needs to be added to the root of the application. It needs to be named embedded.provisionprofile. +The Provisioning Profile created above needs to be added to the root of the applicaton. It needs to be named embedded.provisionprofile. #### Build and Sign the App Package @@ -81,9 +81,9 @@ wails build -platform darwin/universal -clean cp ./embedded.provisionprofile "./build/bin/$APP_NAME.app/Contents" -codesign --timestamp --options=runtime -s "$APP_CERTIFICATE" -v --entitlements ./build/darwin/entitlements.plist "./build/bin/$APP_NAME.app" +codesign --timestamp --options=runtime -s "$APP_CERTIFICATE" -v --entitlements ./build/darwin/entitlements.plist ./build/bin/$APP_NAME.app -productbuild --sign "$PKG_CERTIFICATE" --component "./build/bin/$APP_NAME.app" /Applications "./$APP_NAME.pkg" +productbuild --sign "$PKG_CERTIFICATE" --component ./build/bin/$APP_NAME.app /Applications ./$APP_NAME.pkg ``` #### Upload App Bundle diff --git a/website/docs/guides/mobile.mdx b/website/docs/guides/mobile.mdx new file mode 100644 index 000000000..630af624e --- /dev/null +++ b/website/docs/guides/mobile.mdx @@ -0,0 +1,342 @@ +# Mobile Support + +:::danger EXPERIMENTAL +Mobile support in Wails v3 is currently **EXPERIMENTAL**. The API and build process may change significantly before the final release. Use at your own risk in production environments. +::: + +Wails v3 introduces experimental support for building native mobile applications for iOS and Android platforms. This allows you to use the same Go codebase and web frontend across desktop and mobile platforms. + +## Overview + +Mobile support enables you to build native iOS and Android applications using: +- **Go** for business logic and services +- **Web technologies** (HTML/CSS/JavaScript) for the UI +- Native WebView components for rendering + +### Architecture + +| Platform | WebView | Bridge Technology | Build Output | +|----------|---------|-------------------|--------------| +| iOS | WKWebView | CGO (C headers) | .app / .ipa | +| Android | Android WebView | JNI | .apk | + +## Prerequisites + +### iOS Development + +:::warning macOS Required +iOS development requires macOS with Xcode installed. +::: + +- **macOS** 12.0 or later +- **Xcode** 14.0 or later +- **Go** 1.21+ with CGO support +- **iOS SDK** (included with Xcode) + +### Android Development + +Android development is supported on macOS, Linux, and Windows. + +**Required Components:** +- **Go** 1.21+ with CGO support +- **Android SDK** with: + - Platform Tools (adb) + - Build Tools + - Android Emulator (optional, for testing) +- **Android NDK** r26d or later +- **Java JDK** 11+ + +### Environment Setup + +#### Android Environment Variables + +Add these to your shell profile (`~/.bashrc`, `~/.zshrc`, etc.): + +```bash +# macOS +export ANDROID_HOME="$HOME/Library/Android/sdk" + +# Linux +export ANDROID_HOME="$HOME/Android/Sdk" + +# NDK (adjust version as needed) +export ANDROID_NDK_HOME="$ANDROID_HOME/ndk/29.0.14206865" + +# Add tools to PATH +export PATH=$PATH:$ANDROID_HOME/platform-tools +export PATH=$PATH:$ANDROID_HOME/emulator +``` + +#### Installing Android SDK + +You can install the Android SDK through: +- **Android Studio** (easiest method - includes all tools) +- **Command line tools** from [developer.android.com](https://developer.android.com/studio#command-tools) + +After installing, use SDK Manager to install: +- Android SDK Platform (API 34 or later) +- Android SDK Build-Tools +- Android NDK (if not already included) + +## Building for Mobile + +### iOS Build + +```bash +# Build for iOS +task ios:build + +# Build and run on simulator +task ios:run + +# Build for device (requires code signing) +task ios:build:device +``` + +The build process will: +1. Compile Go code as a static library (`.a` file) +2. Generate Xcode project +3. Build the app using `xcodebuild` +4. Create an `.app` bundle (or `.ipa` for distribution) + +### Android Build + +```bash +# Build for Android (default: arm64 for device) +task android:build + +# Build for emulator (x86_64) +task android:build ARCH=x86_64 + +# Build for all architectures +task android:compile:go:all-archs + +# Package APK +task android:package + +# Run on emulator/device +task android:run + +# View logs +task android:logs +``` + +The build process will: +1. Compile Go code as a shared library (`.so` file) +2. Build Java/Kotlin code using Gradle +3. Package everything into an APK + +### Build Architectures + +**iOS:** +- `arm64` - iPhone 5s and later, all iPads with Apple Silicon + +**Android:** +| Architecture | Use Case | GOARCH | +|--------------|----------|---------| +| arm64-v8a | Modern devices (most common) | arm64 | +| x86_64 | Emulator | amd64 | +| armeabi-v7a | Older devices (optional) | arm | +| x86 | Older emulators (optional) | 386 | + +## Platform-Specific Configuration + +### iOS Options + +```go +app := application.New(application.Options{ + Name: "My App", + iOS: application.IOSOptions{ + // Disable bounce scroll effect + DisableBounce: true, + + // Enable zoom gestures + EnableZoom: false, + + // Custom user agent + UserAgent: "MyApp/1.0", + + // Background color + BackgroundColour: application.NewRGB(255, 255, 255), + }, +}) +``` + +### Android Options + +```go +app := application.New(application.Options{ + Name: "My App", + Android: application.AndroidOptions{ + // Disable scrolling + DisableScroll: false, + + // Disable overscroll bounce effect + DisableOverscroll: true, + + // Enable pinch-to-zoom + EnableZoom: false, + + // Custom user agent + UserAgent: "MyApp/1.0", + + // Background color + BackgroundColour: application.NewRGB(255, 255, 255), + + // Disable hardware acceleration (not recommended) + DisableHardwareAcceleration: false, + }, +}) +``` + +## Testing + +### iOS Testing + +```bash +# List available simulators +xcrun simctl list devices + +# Run on specific simulator +task ios:run SIMULATOR="iPhone 15 Pro" +``` + +### Android Testing + +```bash +# List available emulators +emulator -list-avds + +# Start emulator +emulator -avd Pixel_7_API_34 + +# Install and run +task android:run +``` + +## Platform Detection + +Your frontend JavaScript can detect the platform: + +```javascript +const platform = window.wails.System.Platform(); + +if (platform === 'ios') { + // iOS-specific code +} else if (platform === 'android') { + // Android-specific code +} else { + // Desktop code +} +``` + +## Limitations + +:::warning Current Limitations +The following features are not yet fully implemented on mobile platforms: +::: + +### iOS Limitations +- System tray/menu bar (not applicable) +- Multiple windows (single full-screen window only) +- File dialogs (limited by iOS sandboxing) +- Window manipulation (position, size, etc.) + +### Android Limitations +- System tray (not applicable) +- Multiple windows (single full-screen window only) +- File dialogs (use Storage Access Framework) +- Window manipulation (fullscreen only) +- Clipboard operations (partial support) + +## Architecture Documentation + +For detailed technical information about the mobile implementations: + +- **Android Architecture**: See [`ANDROID_ARCHITECTURE.md`](https://github.com/wailsapp/wails/blob/v3-alpha/v3/ANDROID_ARCHITECTURE.md) in the repository +- **iOS Architecture**: See [`IOS_ARCHITECTURE.md`](https://github.com/wailsapp/wails/blob/v3-alpha/v3/IOS_ARCHITECTURE.md) in the repository + +These documents provide comprehensive information about: +- Architecture and design patterns +- Build system internals +- Bridge implementations (JNI for Android, CGO for iOS) +- Asset serving mechanisms +- JavaScript bridge details +- Security considerations + +## Troubleshooting + +### iOS Issues + +**"Code signing required"** +- You need an Apple Developer account to run on physical devices +- Simulators don't require code signing + +**"Command Line Tools not found"** +```bash +# Install Xcode Command Line Tools +xcode-select --install +``` + +### Android Issues + +**"NDK not found"** +```bash +# Verify NDK installation +ls $ANDROID_HOME/ndk + +# Set NDK path explicitly +export ANDROID_NDK_HOME=$ANDROID_HOME/ndk/26.1.10909125 +``` + +**"UnsatisfiedLinkError: dlopen failed"** +- Architecture mismatch between Go library and device +- Rebuild for correct architecture (arm64 for device, x86_64 for emulator) + +**Blank WebView** +1. Enable WebView debugging (in development builds) +2. Use Chrome DevTools: `chrome://inspect/#devices` +3. Check asset serving in logcat: `task android:logs` + +### Build Issues + +**"cannot find package"** +```bash +# Clear and rebuild Go modules +go clean -modcache +go mod tidy +go mod download +``` + +**"CGO_ENABLED required"** +```bash +# Ensure CGO is enabled +export CGO_ENABLED=1 +``` + +## Examples + +Check out the example projects in the Wails repository: + +- **iOS Example**: `v3/examples/ios/` +- **Android Example**: `v3/examples/android/` + +These examples demonstrate: +- Basic app structure +- Service integration +- Event handling +- Asset serving +- Platform-specific features + +## Getting Help + +If you encounter issues with mobile support: + +1. Check the [GitHub Issues](https://github.com/wailsapp/wails/issues) for known problems +2. Review the architecture documentation linked above +3. Ask in the [Wails Discord](https://discord.gg/BrRSWTaxVK) #mobile channel +4. Report bugs with detailed logs and environment information + +:::info Feedback Welcome +Mobile support is actively being developed. Your feedback and bug reports are valuable for improving the implementation. Please share your experiences on GitHub or Discord! +::: diff --git a/website/docs/guides/nixos-font.mdx b/website/docs/guides/nixos-font.mdx index 02188562e..141e4d68c 100644 --- a/website/docs/guides/nixos-font.mdx +++ b/website/docs/guides/nixos-font.mdx @@ -1,6 +1,6 @@ # NixOS FontSize Bug -NixOS/Wayland can cause a bug where the `font-size` css property doesn't affect the rendered page. To fix this add the following to your devShell. +NixOS/Wayland can cause a bug where the `font-size` css property doesnt affect the rendered page. To fix this add the following to your devShell. ```shell shellHook = with pkgs; '' diff --git a/website/docs/guides/signing.mdx b/website/docs/guides/signing.mdx index 4ce5fd4b2..57b51806a 100644 --- a/website/docs/guides/signing.mdx +++ b/website/docs/guides/signing.mdx @@ -254,7 +254,7 @@ Now we need to configure some gon config files in our `build/darwin` directory: "bundle_id": "app.myapp", "apple_id": { "username": "my-appleid@email.com", - "password": "your-app-specific-password", + "password": "@env:APPLE_PASSWORD", "provider": "ABCDE12345" }, "sign": { @@ -268,13 +268,11 @@ Here is a brief break down of the above fields: - `source`: The location of your wails binary to be signed - `apple_id`: - `username`: Your Apple ID email address - - `password`: Your app-specific password + - `password`: Your app-specific password, referenced using Gon's environment variable syntax - `provider`: Your team ID for your App Store Connect account - `sign`: - `application_identity`: Your Apple developer identity -The (https://developer.apple.com/documentation/technotes/tn3147-migrating-to-the-latest-notarization-tool)[deprecated Apple's altool]'s syntax supporting `@env:` is no longer available since Apple has migrated to the new notarytool. - Your developer identity and team ID can both by found on macOS by running the following command: ```bash @@ -422,3 +420,5 @@ jobs: # End notes This guide inspired by the RiftShare project and its workflow, which is highly recommended to check out [here](https://github.com/achhabra2/riftshare/blob/main/.github/workflows/build.yaml). + +For another excellent guide on macOS code signing and notarization, see [Signing and Notarizing macOS Apps](https://armaan.cc/blog/signing-and-notarizing-macos) by Armaan. diff --git a/website/docs/guides/sveltekit.mdx b/website/docs/guides/sveltekit.mdx index afb67f630..e0357ca3c 100644 --- a/website/docs/guides/sveltekit.mdx +++ b/website/docs/guides/sveltekit.mdx @@ -1,7 +1,7 @@ # SvelteKit This guide will go into: -1. Minimal Installation Steps - The steps needed to get a minimum Wails setup working for SvelteKit. +1. Miminal Installation Steps - The steps needed to get a minimum Wails setup working for SvelteKit. 2. Install Script - Bash script for accomplishing the Minimal Installation Steps with optional Wails branding. 3. Important Notes - Issues that can be encountered when using SvelteKit + Wails and fixes. @@ -14,8 +14,8 @@ This guide will go into: - Navigate into your newly created myapp folder. - Delete the folder named "frontend" -##### While in the Wails project root. Use the Svelte CLI to create a SvelteKit project as the new frontend. Follow the prompts, nothing Wails specific is needed here. -- `npx sv create frontend` +##### While in the Wails project root. Use your favorite package manager and install SvelteKit as the new frontend. Follow the prompts. +- `npm create svelte@latest frontend` ##### Modify wails.json. - Add `"wailsjsdir": "./frontend/src/lib",` Do note that this is where your Go and runtime functions will appear. @@ -108,7 +108,7 @@ wails dev ``` See https://wails.io/docs/guides/frontend for more information. -##### Initial data can be loaded and refreshed from +page.ts/+page.js to +page.svelte. +##### Inital data can be loaded and refreshed from +page.ts/+page.js to +page.svelte. - +page.ts/+page.js works well with load() https://kit.svelte.dev/docs/load#page-data - invalidateAll() in +page.svelte will call load() from +page.ts/+page.js https://kit.svelte.dev/docs/load#rerunning-load-functions-manual-invalidation. diff --git a/website/docs/howdoesitwork.mdx b/website/docs/howdoesitwork.mdx index 405930492..48243f4eb 100644 --- a/website/docs/howdoesitwork.mdx +++ b/website/docs/howdoesitwork.mdx @@ -63,17 +63,17 @@ func main() { type App struct { - ctx context.Context + ctx context.Context } func (b *App) startup(ctx context.Context) { - b.ctx = ctx + b.ctx = ctx } func (b *App) shutdown(ctx context.Context) {} func (b *App) Greet(name string) string { - return fmt.Sprintf("Hello %s!", name) + return fmt.Sprintf("Hello %s!", name) } ``` @@ -178,18 +178,18 @@ func main() { type App struct { - ctx context.Context + ctx context.Context } func (a *App) Greet(name string) string { - return fmt.Sprintf("Hello %s!", name) + return fmt.Sprintf("Hello %s!", name) } ``` You may bind as many structs as you like. Just make sure you create an instance of it and pass it in `Bind`: ```go {10-12} - //... + //... err := wails.Run(&options.App{ Title: "Basic Demo", Width: 1024, @@ -203,6 +203,7 @@ You may bind as many structs as you like. Just make sure you create an instance &mystruct2{}, }, }) + ``` You may bind enums types as well. @@ -235,8 +236,8 @@ var AllWeekdays = []struct { } ``` -```go {14-16} - //... +```go {10-12} + //... err := wails.Run(&options.App{ Title: "Basic Demo", Width: 1024, @@ -249,10 +250,11 @@ var AllWeekdays = []struct { &mystruct1{}, &mystruct2{}, }, - EnumBind: []interface{}{ - AllWeekdays, - }, + EnumBind: []interface{}{ + AllWeekdays, + }, }) + ``` When you run `wails dev` (or `wails generate module`), a frontend module will be generated containing the following: diff --git a/website/docs/reference/cli.mdx b/website/docs/reference/cli.mdx index 1a85be22f..9bb41d10c 100644 --- a/website/docs/reference/cli.mdx +++ b/website/docs/reference/cli.mdx @@ -69,11 +69,10 @@ If you are unsure about a template, inspect `package.json` and `wails.json` for | -nsis | Generate NSIS installer for Windows | | | -o filename | Output filename | | | -obfuscated | Obfuscate the application using [garble](https://github.com/burrowers/garble) | | -| -platform | Build for the given (comma delimited) [platforms](../reference/cli.mdx#platforms) eg. `windows/arm64`. Note, if you do not give the architecture, `runtime.GOARCH` is used. | platform = `GOOS` environment variable if given else `runtime.GOOS`.<br/>arch = `GOARCH` environment variable if given else `runtime.GOARCH`. | +| -platform | Build for the given (comma delimited) [platforms](../reference/cli.mdx#platforms) eg. `windows/arm64`. Note, if you do not give the architecture, `runtime.GOARCH` is used. | platform = `GOOS` environment variable if given else `runtime.GOOS`.<br/>arch = `GOARCH` envrionment variable if given else `runtime.GOARCH`. | | -race | Build with Go's race detector | | | -s | Skip building the frontend | | | -skipbindings | Skip bindings generation | | -| -skipembedcreate | Skip automatic creation of non-existent embed directories and gitkeep files | | | -tags "extra tags" | Build tags to pass to Go compiler. Must be quoted. Space or comma (but not both) separated | | | -trimpath | Remove all file system paths from the resulting executable. | | | -u | Updates your project's `go.mod` to use the same version of Wails as the CLI | | @@ -104,13 +103,6 @@ There are [issues](https://github.com/upx/upx/issues/446) with using UPX with Ap ::: -:::info Set minimal version for MacOS - -You can override default [minimal version](../gettingstarted/installation#supported-platforms) of macOS for your app by providing version via `CGO_CFLAGS` and `CGO_LDFLAGS` environment variables. -e.g. `CGO_CFLAGS=-mmacosx-version-min=10.15.0 CGO_LDFLAGS=-mmacosx-version-min=10.15.0 wails build` - -::: - :::info UPX on Windows Some Antivirus vendors false positively mark `upx` compressed binaries as virus, see [issue](https://github.com/upx/upx/issues/437). @@ -194,7 +186,6 @@ Your system is ready for Wails development! | -extensions | Extensions to trigger rebuilds (comma separated) | go | | -forcebuild | Force build of application | | | -frontenddevserverurl "url" | Use 3rd party dev server url to serve assets, EG Vite | "" | -| -viteservertimeout | The timeout in seconds for Vite server detection when frontend dev server url is set to 'auto' | 10 | | -ldflags "flags" | Additional ldflags to pass to the compiler | | | -loglevel "loglevel" | Loglevel to use - Trace, Debug, Info, Warning, Error | Debug | | -nocolour | Turn off colour cli output | false | @@ -203,9 +194,8 @@ Your system is ready for Wails development! | -race | Build with Go's race detector | false | | -reloaddirs | Additional directories to trigger reloads (comma separated) | Value in `wails.json` | | -s | Skip building the frontend | false | -| -save | Saves the given `assetdir`, `reloaddirs`, `wailsjsdir`, `debounce`, `devserver`, `frontenddevserverurl` and `viteservertimeout` flags in `wails.json` to become the defaults for subsequent invocations. | | +| -save | Saves the given `assetdir`, `reloaddirs`, `wailsjsdir`, `debounce`, `devserver` and `frontenddevserverurl` flags in `wails.json` to become the defaults for subsequent invocations. | | | -skipbindings | Skip bindings generation | | -| -skipembedcreate | Skip automatic creation of non-existent embed directories and gitkeep files | | | -tags "extra tags" | Build tags to pass to compiler (quoted and space separated) | | | -v | Verbosity level (0 - silent, 1 - standard, 2 - verbose) | 1 | | -wailsjsdir | The directory to generate the generated Wails JS modules | Value in `wails.json` | diff --git a/website/docs/reference/menus.mdx b/website/docs/reference/menus.mdx index 52f399f0b..7af0bf38f 100644 --- a/website/docs/reference/menus.mdx +++ b/website/docs/reference/menus.mdx @@ -8,41 +8,22 @@ It is possible to add an application menu to Wails projects. This is achieved by setting it in the [`Menu`](../reference/options.mdx#menu) application config, or by calling the runtime method [MenuSetApplicationMenu](../reference/runtime/menu.mdx#menusetapplicationmenu). -An example of how to create a menu, using [the `NewApp` scaffold](../guides/application-development.mdx): +An example of how to create a menu: -```go title="main.go" -package main +```go -import ( - "log" - "runtime" - - "github.com/wailsapp/wails/v2" - "github.com/wailsapp/wails/v2/pkg/menu" - "github.com/wailsapp/wails/v2/pkg/menu/keys" - "github.com/wailsapp/wails/v2/pkg/options" - rt "github.com/wailsapp/wails/v2/pkg/runtime" -) - -func main() { app := NewApp() AppMenu := menu.NewMenu() - if runtime.GOOS == "darwin" { - AppMenu.Append(menu.AppMenu()) // On macOS platform, this must be done right after `NewMenu()` - } FileMenu := AppMenu.AddSubmenu("File") - FileMenu.AddText("&Open", keys.CmdOrCtrl("o"), func(_ *menu.CallbackData) { - // do something - }) + FileMenu.AddText("&Open", keys.CmdOrCtrl("o"), openFile) FileMenu.AddSeparator() FileMenu.AddText("Quit", keys.CmdOrCtrl("q"), func(_ *menu.CallbackData) { - // `rt` is an alias of "github.com/wailsapp/wails/v2/pkg/runtime" to prevent collision with standard package - rt.Quit(app.ctx) + runtime.Quit(app.ctx) }) if runtime.GOOS == "darwin" { - AppMenu.Append(menu.EditMenu()) // On macOS platform, EditMenu should be appended to enable Cmd+C, Cmd+V, Cmd+Z... shortcuts + AppMenu.Append(menu.EditMenu()) // on macos platform, we should append EditMenu to enable Cmd+C,Cmd+V,Cmd+Z... shortcut } err := wails.Run(&options.App{ @@ -53,11 +34,8 @@ func main() { Bind: []interface{}{ app, }, - }) - if err != nil { - log.Fatal(err) - } -} + ) + // ... ``` It is also possible to dynamically update the menu, by updating the menu struct and calling diff --git a/website/docs/reference/options.mdx b/website/docs/reference/options.mdx index 8651a3205..a6026f126 100644 --- a/website/docs/reference/options.mdx +++ b/website/docs/reference/options.mdx @@ -73,9 +73,8 @@ func main() { Windows: &windows.Options{ WebviewIsTransparent: false, WindowIsTranslucent: false, - ContentProtection: false, BackdropType: windows.Mica, - DisablePinchZoom: false, + DisablePinchZoom: false, DisableWindowIcon: false, DisableFramelessWindowDecorations: false, WebviewUserDataPath: "", @@ -100,9 +99,7 @@ func main() { // OnResume is called when Windows resumes from low power mode OnResume: func(), // Disable GPU hardware acceleration for the webview - WebviewGpuDisabled: false, - // Class name for the window. If empty, 'wailsWindow' will be used. - WindowClassName: "MyWindow", + WebviewGpuDisabled: false, }, Mac: &mac.Options{ TitleBar: &mac.TitleBar{ @@ -118,7 +115,6 @@ func main() { Appearance: mac.NSAppearanceNameDarkAqua, WebviewIsTransparent: true, WindowIsTranslucent: false, - ContentProtection: false, About: &mac.AboutInfo{ Title: "My Application", Message: "© 2021 Me", @@ -134,7 +130,6 @@ func main() { Debug: options.Debug{ OpenInspectorOnStartup: false, }, - BindingsAllowedOrigins: "https://my.topapp,https://*.wails.isgreat", }) if err != nil { @@ -327,7 +322,7 @@ If not defined, the result is the following in cases where the Handler would hav :::info -This does not work with vite v5.0.0+ and wails v2 due to changes in vite. +This does not work with vite v5.0.0+ and wails v2 due to changes in vite. Changes are planned in v3 to support similar functionality under vite v5.0.0+. If you need this feature, stay with vite v4.0.0+. See [issue 3240](https://github.com/wailsapp/wails/issues/3240) for details @@ -490,13 +485,21 @@ services of Apple and Microsoft. Name: EnableFraudulentWebsiteDetection<br/> Type: `bool` -### DisablePanicRecovery +### ZoomFactor -DisablePanicRecovery disables the automatic recovery from panics in message processing. By default, Wails will recover from panics in message processing and log the error. If you want to handle panics yourself, set this to `true`. +Name: ZoomFactor<br/> +Type: `float64` -Name: DisablePanicRecovery<br/> +This defines the zoom factor for the WebView2. This is the option matching the Edge user activated zoom in or out. + +### IsZoomControlEnabled + +Name: IsZoomControlEnabled<br/> Type: `bool` +This enables the zoom factor to be changed by the user. Please note that the zoom factor can be set in the options while +disallowing the user to change it at runtime (f.e. for a kiosk application or similar). + ### Bind A slice of struct instances defining methods that need to be bound to the frontend. @@ -616,17 +619,6 @@ by Windows. To configure this, use the [BackdropType](#BackdropType) option. Name: WindowIsTranslucent<br/> Type: `bool` -#### ContentProtection - -Prevents window contents from being captured by other applications. - -On Windows it calls SetWindowDisplayAffinity with `WDA_EXCLUDEFROMCAPTURE`. -For Windows 10 version 2004 and later the window will be completely removed from capture. -Older Windows versions will call SetWindowDisplayAffinity with `WDA_MONITOR`, capturing a black window. - -Name: ContentProtection<br/> -Type: `bool` - #### BackdropType :::note @@ -650,21 +642,6 @@ The value can be one of the following: | Mica | Use [Mica](https://learn.microsoft.com/en-us/windows/apps/design/style/mica) effect | | Tabbed | Use Tabbed. This is a backdrop that is similar to Mica. | -#### ZoomFactor - -Name: ZoomFactor<br/> -Type: `float64` - -This defines the zoom factor for the WebView2. This is the option matching the Edge user activated zoom in or out. - -#### IsZoomControlEnabled - -Name: IsZoomControlEnabled<br/> -Type: `bool` - -This enables the zoom factor to be changed by the user. Please note that the zoom factor can be set in the options while -disallowing the user to change it at runtime (f.e. for a kiosk application or similar). - #### DisablePinchZoom Setting this to `true` will disable pinch zoom gestures. @@ -827,13 +804,6 @@ Setting this to `true` will enable swipe gestures for the webview. Name: EnableSwipeGestures<br/> Type: `bool` -#### WindowClassName - -Class name for the window. If empty, 'wailsWindow' will be used. - -Name: WindowClassName<br/> -Type: `string` - ### Mac This defines [Mac specific options](#mac). @@ -937,15 +907,6 @@ with [WebviewIsTransparent](#WebviewIsTransparent) to make frosty-looking applic Name: WindowIsTranslucent<br/> Type: `bool` -#### ContentProtection - -Prevents window contents from being captured by other applications. - -On MacOS it sets the NSWindow's sharingType to NSWindowSharingNone, removing the window from capture entirely. - -Name: ContentProtection<br/> -Type: `bool` - #### OnFileOpen Callback that is called when a file is opened with the application. @@ -1130,12 +1091,3 @@ Setting this to `true` will open the WebInspector on startup of the application. Name: OpenInspectorOnStartup<br/> Type: `bool` - -### BindingsAllowedOrigins - -Comma-separated list of additional allowed origins for JS ↔ Go bindings. -Supports “*” wildcards in hostnames for subdomain matching. -Example: `"https://*.myapp.com, https://example.com"` - -Name: BindingsAllowedOrigins<br/> -Type: `string`<br/> diff --git a/website/docs/reference/project-config.mdx b/website/docs/reference/project-config.mdx index a9f8785fa..3a6f09495 100644 --- a/website/docs/reference/project-config.mdx +++ b/website/docs/reference/project-config.mdx @@ -18,8 +18,6 @@ The project config resides in the `wails.json` file in the project directory. Th "reloaddirs": "", // The directory where the build files reside. Defaults to 'build' "build:dir": "", - // Additional tags to include at build time regardless of environment - "build:tags": "", // Relative path to the frontend directory. Defaults to 'frontend' "frontend:dir": "", // The command to install node dependencies, run in the frontend directory - often `npm install` @@ -36,8 +34,6 @@ The project config resides in the `wails.json` file in the project directory. Th "frontend:dev:watcher": "", // URL to a 3rd party dev server to be used to serve assets, EG Vite. \nIf this is set to 'auto' then the devServerUrl will be inferred from the Vite output "frontend:dev:serverUrl": "", - // The timeout in seconds for Vite server detection when frontend:dev:serverUrl is set to 'auto'. Default: 10 - "viteServerTimeout": 10, // Relative path to the directory that the auto-generated JS modules will be created "wailsjsdir": "", // The name of the binary @@ -128,7 +124,7 @@ The project config resides in the `wails.json` file in the project directory. Th This file is read by the Wails CLI when running `wails build` or `wails dev`. -The `assetdir`, `reloaddirs`, `wailsjsdir`, `debounceMS`, `devserver`, `frontenddevserverurl` and `viteservertimeout` flags in `wails build/dev` will update the project config +The `assetdir`, `reloaddirs`, `wailsjsdir`, `debounceMS`, `devserver` and `frontenddevserverurl` flags in `wails build/dev` will update the project config and thus become defaults for subsequent runs. The JSON Schema for this file is located [here](https://wails.io/schemas/config.v2.json). diff --git a/website/docs/reference/runtime/events.mdx b/website/docs/reference/runtime/events.mdx index 909cb79e9..138e03d73 100644 --- a/website/docs/reference/runtime/events.mdx +++ b/website/docs/reference/runtime/events.mdx @@ -18,18 +18,11 @@ JS: `EventsOn(eventName string, callback function(optionalData?: any)): () => vo ### EventsOff -This method unregisters the listener for the given event name, optionally multiple listeners can be unregistered via `additionalEventNames`. +This method unregisters the listener for the given event name, optionally multiple listeneres can be unregistered via `additionalEventNames`. Go: `EventsOff(ctx context.Context, eventName string, additionalEventNames ...string)`<br/> JS: `EventsOff(eventName string, ...additionalEventNames)` -### EventsOffAll - -This method unregisters all event listeners. - -Go: `EventsOffAll(ctx context.Context)`<br/> -JS: `EventsOffAll()` - ### EventsOnce This method sets up a listener for the given event name, but will only trigger once. It returns a function to cancel diff --git a/website/docs/reference/runtime/intro.mdx b/website/docs/reference/runtime/intro.mdx index d67e76c64..3c491ecf0 100644 --- a/website/docs/reference/runtime/intro.mdx +++ b/website/docs/reference/runtime/intro.mdx @@ -98,46 +98,3 @@ interface EnvironmentInfo { arch: string; } ``` - -### ResetSignalHandlers - -Resets signal handlers to allow panic recovery from nil pointer dereferences and other memory access violations. - -Go: `ResetSignalHandlers()` - -:::info Linux Only - -This function only has an effect on Linux. On macOS and Windows, it is a no-op. - -On Linux, WebKit (used for the webview) may install signal handlers without the `SA_ONSTACK` flag, which prevents -Go from properly recovering from panics caused by nil pointer dereferences (SIGSEGV) or other memory access violations. - -Call this function immediately before code that might panic to ensure the signal handlers are properly configured -for Go's panic recovery mechanism. - -::: - -#### Example - -```go -go func() { - defer func() { - if err := recover(); err != nil { - log.Printf("Recovered from panic: %v", err) - } - }() - // Reset signal handlers right before potentially dangerous code - runtime.ResetSignalHandlers() - - // Code that might cause a nil pointer dereference... - var t *time.Time - fmt.Println(t.Unix()) // This would normally crash on Linux -}() -``` - -:::warning - -This function must be called in each goroutine where you want panic recovery to work, and should be called -immediately before the code that might panic, as WebKit may reset the signal handlers at any time. - -::: diff --git a/website/docs/reference/runtime/window.mdx b/website/docs/reference/runtime/window.mdx index 4e20f510e..625cd5e44 100644 --- a/website/docs/reference/runtime/window.mdx +++ b/website/docs/reference/runtime/window.mdx @@ -235,7 +235,7 @@ JS: `WindowSetBackgroundColour(R, G, B, A)` ### WindowPrint -Opens the native print dialog. +Opens tha native print dialog. Go: `WindowPrint(ctx context.Context)`<br/> JS: `WindowPrint()` diff --git a/website/docusaurus.config.js b/website/docusaurus.config.js index 16a289a5d..737218f07 100644 --- a/website/docusaurus.config.js +++ b/website/docusaurus.config.js @@ -1,9 +1,8 @@ // @ts-check // Note: type annotations allow type checking and IDEs autocompletion -const { themes } = require("prism-react-renderer"); -const lightCodeTheme = themes.github; -const darkCodeTheme = themes.dracula; +const lightCodeTheme = require("prism-react-renderer/themes/github"); +const darkCodeTheme = require("prism-react-renderer/themes/dracula"); const { getTranslationProgress } = require("./src/api/crowdin.js"); @@ -15,16 +14,28 @@ module.exports = async function configCreatorAsync() { url: "https://wails.io", baseUrl: "/", onBrokenLinks: "warn", + onBrokenMarkdownLinks: "warn", favicon: "img/favicon.ico", organizationName: "wailsapp", projectName: "wails", - markdown: { - hooks: { - onBrokenMarkdownLinks: "warn", - }, + webpack: { + jsLoader: (isServer) => ({ + loader: require.resolve("swc-loader"), + options: { + jsc: { + parser: { + syntax: "typescript", + tsx: true, + }, + target: "es2017", + }, + module: { + type: isServer ? "commonjs" : "es6", + }, + }, + }), }, - i18n: { defaultLocale: "en", locales: ["en", "zh-Hans", "ja", "ru", "ko", "fr", "pt"], diff --git a/website/i18n/ar/docusaurus-plugin-content-docs/current/community/showcase/grpcmd-gui.mdx b/website/i18n/ar/docusaurus-plugin-content-docs/current/community/showcase/grpcmd-gui.mdx deleted file mode 100644 index 891350290..000000000 --- a/website/i18n/ar/docusaurus-plugin-content-docs/current/community/showcase/grpcmd-gui.mdx +++ /dev/null @@ -1,10 +0,0 @@ -# grpcmd-gui - -```mdx-code-block -<p style={{ "text-align": "center" }}> - <img src={require("@site/static/img/showcase/grpcmd-gui.webp").default} /> - <br /> -</p> -``` - -[grpcmd-gui](https://grpc.md/gui) is a modern cross-platform desktop app and API client for gRPC development and testing. diff --git a/website/i18n/ar/docusaurus-plugin-content-docs/current/community/showcase/kafka-king.mdx b/website/i18n/ar/docusaurus-plugin-content-docs/current/community/showcase/kafka-king.mdx deleted file mode 100644 index 9876cd9a0..000000000 --- a/website/i18n/ar/docusaurus-plugin-content-docs/current/community/showcase/kafka-king.mdx +++ /dev/null @@ -1,23 +0,0 @@ -# Kafka-King - -```mdx-code-block -<p style={{ "text-align": "center" }}> - <img src={require("@site/static/img/showcase/kafka-King-img_3.webp").default} /> - <br /> -</p> -``` - -[Kafka-King](https://github.com/Bronya0/Kafka-King) is a kafka GUI client that supports various systems and is compact and easy to use. -This is made of Wails+vue3 - -# Kafka-King function list - -- [x] View the cluster node list, support dynamic configuration of broker and topic configuration items -- [x] Supports consumer clients, consumes the specified topic, size, and timeout according to the specified group, and displays the message information in various dimensions in a table -- [x] Supports PLAIN, SSL, SASL, kerberos, sasl_plaintext, etc. etc. -- [x] Create topics (support batches), delete topics, specify replicas, partitions -- [x] Support statistics of the total number of messages, total number of submissions, and backlog for each topic based on consumer groups -- [x] Support viewing topics Detailed information (offset) of the partition, and support adding additional partitions -- [x] Support simulated producers, batch sending messages, specify headers, partitions -- [x] Health check -- [x] Support viewing consumer groups , Consumer- …… diff --git a/website/i18n/ar/docusaurus-plugin-content-docs/current/community/showcase/minesweeper-xp.mdx b/website/i18n/ar/docusaurus-plugin-content-docs/current/community/showcase/minesweeper-xp.mdx deleted file mode 100644 index f127a005f..000000000 --- a/website/i18n/ar/docusaurus-plugin-content-docs/current/community/showcase/minesweeper-xp.mdx +++ /dev/null @@ -1,10 +0,0 @@ -# Minesweeper XP - -```mdx-code-block -<p style={{ "text-align": "center" }}> - <img src={require("@site/static/img/showcase/minesweeper-xp.webp").default} /> - <br /> -</p> -``` - -[Minesweeper-XP](https://git.new/Minesweeper-XP) allows you to experience the classic Minesweeper XP (+ 98 and 3.1) on macOS, Windows, and Linux! diff --git a/website/i18n/ar/docusaurus-plugin-content-docs/current/community/showcase/resizem.mdx b/website/i18n/ar/docusaurus-plugin-content-docs/current/community/showcase/resizem.mdx deleted file mode 100644 index 27f168f48..000000000 --- a/website/i18n/ar/docusaurus-plugin-content-docs/current/community/showcase/resizem.mdx +++ /dev/null @@ -1,10 +0,0 @@ -# Resizem - -```mdx-code-block -<p style={{ "text-align": "center" }}> - <img src={require("@site/static/img/showcase/resizem.webp").default} /> - <br /> -</p> -``` - -[Resizem](https://github.com/barats/resizem) - is an app designed for bulk image process. It is particularly useful for users who need to resize, convert, and manage large numbers of image files at once. diff --git a/website/i18n/ar/docusaurus-plugin-content-docs/current/community/showcase/wailsterm.mdx b/website/i18n/ar/docusaurus-plugin-content-docs/current/community/showcase/wailsterm.mdx deleted file mode 100644 index 9924dace5..000000000 --- a/website/i18n/ar/docusaurus-plugin-content-docs/current/community/showcase/wailsterm.mdx +++ /dev/null @@ -1,10 +0,0 @@ -# WailsTerm - -```mdx-code-block -<p style={{ "text-align": "center" }}> - <img src={require("@site/static/img/showcase/wailsterm.webp").default} /> - <br /> -</p> -``` - -[WailsTerm](https://github.com/rlshukhov/wailsterm) is a simple translucent terminal app powered by Wails and Xterm.js. diff --git a/website/i18n/ar/docusaurus-plugin-content-docs/current/community/templates.mdx b/website/i18n/ar/docusaurus-plugin-content-docs/current/community/templates.mdx index fb95b8ad9..65f46a9e1 100644 --- a/website/i18n/ar/docusaurus-plugin-content-docs/current/community/templates.mdx +++ b/website/i18n/ar/docusaurus-plugin-content-docs/current/community/templates.mdx @@ -26,7 +26,6 @@ If you are unsure about a template, inspect `package.json` and `wails.json` for - [wails-template-quasar-js](https://github.com/sgosiaco/wails-template-quasar-js) - A template using JavaScript + Quasar V2 (Vue 3, Vite, Sass, Pinia, ESLint, Prettier) - [wails-template-quasar-ts](https://github.com/sgosiaco/wails-template-quasar-ts) - A template using TypeScript + Quasar V2 (Vue 3, Vite, Sass, Pinia, ESLint, Prettier, Composition API with <script setup>) - [wails-template-naive](https://github.com/tk103331/wails-template-naive) - Wails template based on Naive UI (A Vue 3 Component Library) -- [wails-template-tdesign-js](https://github.com/tongque0/wails-template-tdesign-js) - Wails template based on TDesign UI (a Vue 3 UI library by Tencent), using Vite, Pinia, Vue Router, ESLint, and Prettier. ## Angular @@ -41,13 +40,11 @@ If you are unsure about a template, inspect `package.json` and `wails.json` for - [wails-template-nextjs-app-router](https://github.com/thisisvk-in/wails-template-nextjs-app-router) - A template using Next.js and TypeScript with App router - [wails-vite-react-ts-tailwind-template](https://github.com/hotafrika/wails-vite-react-ts-tailwind-template) - A template for React + TypeScript + Vite + TailwindCSS - [wails-vite-react-ts-tailwind-shadcnui-template](https://github.com/Mahcks/wails-vite-react-tailwind-shadcnui-ts) - A template with Vite, React, TypeScript, TailwindCSS, and shadcn/ui -- [wails-nextjs-tailwind-template](https://github.com/kairo913/wails-nextjs-tailwind-template) - A template using Next.js and Typescript with TailwindCSS ## Svelte - [wails-svelte-template](https://github.com/raitonoberu/wails-svelte-template) - A template using Svelte - [wails-vite-svelte-template](https://github.com/BillBuilt/wails-vite-svelte-template) - A template using Svelte and Vite -- [wails-vite-svelte-ts-tailwind-template](https://github.com/xvertile/wails-vite-svelte-tailwind-template) - A template using Wails, Svelte, Vite, TypeScript, and TailwindCSS v3 - [wails-vite-svelte-tailwind-template](https://github.com/BillBuilt/wails-vite-svelte-tailwind-template) - A template using Svelte and Vite with TailwindCSS v3 - [wails-svelte-tailwind-vite-template](https://github.com/PylotLight/wails-vite-svelte-tailwind-template/tree/master) - An updated template using Svelte v4.2.0 and Vite with TailwindCSS v3.3.3 - [wails-sveltekit-template](https://github.com/h8gi/wails-sveltekit-template) - A template using SvelteKit diff --git a/website/i18n/ar/docusaurus-plugin-content-docs/current/gettingstarted/firstproject.mdx b/website/i18n/ar/docusaurus-plugin-content-docs/current/gettingstarted/firstproject.mdx index e7cc86163..62ee97c84 100644 --- a/website/i18n/ar/docusaurus-plugin-content-docs/current/gettingstarted/firstproject.mdx +++ b/website/i18n/ar/docusaurus-plugin-content-docs/current/gettingstarted/firstproject.mdx @@ -126,3 +126,5 @@ Wails projects have the following layout: The `frontend` directory has nothing specific to Wails and can be any frontend project of your choosing. The `build` directory is used during the build process. These files may be updated to customise your builds. If files are removed from the build directory, default versions will be regenerated. + +The default module name in `go.mod` is "changeme". You should change this to something more appropriate. diff --git a/website/i18n/ar/docusaurus-plugin-content-docs/current/gettingstarted/installation.mdx b/website/i18n/ar/docusaurus-plugin-content-docs/current/gettingstarted/installation.mdx index 028b167da..401d26789 100644 --- a/website/i18n/ar/docusaurus-plugin-content-docs/current/gettingstarted/installation.mdx +++ b/website/i18n/ar/docusaurus-plugin-content-docs/current/gettingstarted/installation.mdx @@ -7,7 +7,7 @@ sidebar_position: 1 ## Supported Platforms - Windows 10/11 AMD64/ARM64 -- MacOS 10.15+ AMD64 for development, MacOS 10.13+ for release +- MacOS 10.13+ AMD64 - MacOS 11.0+ ARM64 - Linux AMD64/ARM64 @@ -15,7 +15,7 @@ sidebar_position: 1 Wails has a number of common dependencies that are required before installation: -- Go 1.21+ (macOS 15+ requires Go 1.23.3+) +- Go 1.20+ - NPM (Node 15+) ### Go @@ -58,8 +58,6 @@ import TabItem from "@theme/TabItem"; </TabItem> <TabItem value={"Linux"}> Linux requires the standard <code>gcc</code> build tools plus <code>libgtk3</code> and <code>libwebkit</code>. Rather than list a ton of commands for different distros, Wails can try to determine what the installation commands are for your specific distribution. Run <code>wails doctor</code> after installation to be shown how to install the dependencies. If your distro/package manager is not supported, please consult the <a href={"/docs/guides/linux-distro-support"}>Add Linux Distro</a> guide. - <br/><strong>Note:</strong><br/> - If you are using latest Linux version (example: Ubuntu 24.04) and it is not supporting <code>libwebkit2gtk-4.0-dev</code>, then you might encounter an issue in <code>wails doctor</code>: <code>libwebkit</code> not found. To resolve this issue you can install <code>libwebkit2gtk-4.1-dev</code> and during your build use the tag <code>-tags webkit2_41</code>. </TabItem> </Tabs> ``` diff --git a/website/i18n/ar/docusaurus-plugin-content-docs/current/guides/application-development.mdx b/website/i18n/ar/docusaurus-plugin-content-docs/current/guides/application-development.mdx index 687b89791..8ad521116 100644 --- a/website/i18n/ar/docusaurus-plugin-content-docs/current/guides/application-development.mdx +++ b/website/i18n/ar/docusaurus-plugin-content-docs/current/guides/application-development.mdx @@ -235,7 +235,7 @@ If these 2 keys aren't given, then Wails does absolutely nothing with the fronte ### AssetsHandler -A Wails v2 app can optionally define a `http.Handler` in the `options.App`, which allows hooking into the AssetServer to create files on the fly or process POST/PUT requests. GET requests are always first handled by the `assets` FS. If the FS doesn't find the requested file the request will be forwarded to the `http.Handler` for serving. Any requests other than GET will be directly processed by the `AssetsHandler` if specified. It's also possible to only use the `AssetsHandler` by specifying `nil` as the `Assets` option. +A Wails v2 app can optionally define a `http.Handler` in the `options.App`, which allows hooking into the AssetServer to create files on the fly or process POST/PUT requests. GET requests are always first handled by the `assets` FS. If the FS doesn't find the requested file the request will be forwarded to the `http.Handler` for serving. Any requests other than GET will be directly processed by the `AssetsHandler` if specified. It's also possible to only use the `AssetsHandler` by specifiy `nil` as the `Assets` option. ## Built in Dev Server diff --git a/website/i18n/ar/docusaurus-plugin-content-docs/current/guides/crossplatform-build.mdx b/website/i18n/ar/docusaurus-plugin-content-docs/current/guides/crossplatform-build.mdx index e7ea6dfc8..ff217c845 100644 --- a/website/i18n/ar/docusaurus-plugin-content-docs/current/guides/crossplatform-build.mdx +++ b/website/i18n/ar/docusaurus-plugin-content-docs/current/guides/crossplatform-build.mdx @@ -61,6 +61,6 @@ This example offers opportunities for various enhancements, including: - Caching dependencies - Code signing -- Uploading to platforms like S3, Supabase, etc. +- Uploading to platforms like S3, Supbase, etc. - Injecting secrets as environment variables - Utilizing environment variables as build variables (such as version variable extracted from the current Git tag) diff --git a/website/i18n/ar/docusaurus-plugin-content-docs/current/guides/frontend.mdx b/website/i18n/ar/docusaurus-plugin-content-docs/current/guides/frontend.mdx index f057056c1..ac087ee45 100644 --- a/website/i18n/ar/docusaurus-plugin-content-docs/current/guides/frontend.mdx +++ b/website/i18n/ar/docusaurus-plugin-content-docs/current/guides/frontend.mdx @@ -44,7 +44,7 @@ The options are as follows: | noautoinjectipc | Disable the autoinjection of `/wails/ipc.js` | | noautoinject | Disable all autoinjection of scripts | -Multiple options may be used provided they are comma separated. +Multiple options may be used provided they are comma seperated. This code is perfectly valid and operates the same as the autoinjection version: diff --git a/website/i18n/ar/docusaurus-plugin-content-docs/current/guides/mac-appstore.mdx b/website/i18n/ar/docusaurus-plugin-content-docs/current/guides/mac-appstore.mdx index 4b6d3a1ab..961595711 100644 --- a/website/i18n/ar/docusaurus-plugin-content-docs/current/guides/mac-appstore.mdx +++ b/website/i18n/ar/docusaurus-plugin-content-docs/current/guides/mac-appstore.mdx @@ -61,7 +61,7 @@ This is an example entitlements file from the [RiftShare](https://github.com/ach </plist> ``` -**Add the Embedded Provisioning Profile** The Provisioning Profile created above needs to be added to the root of the application. It needs to be named embedded.provisionprofile. +**Add the Embedded Provisioning Profile** The Provisioning Profile created above needs to be added to the root of the applicaton. It needs to be named embedded.provisionprofile. #### Build and Sign the App Package @@ -80,9 +80,9 @@ wails build -platform darwin/universal -clean cp ./embedded.provisionprofile "./build/bin/$APP_NAME.app/Contents" -codesign --timestamp --options=runtime -s "$APP_CERTIFICATE" -v --entitlements ./build/darwin/entitlements.plist "./build/bin/$APP_NAME.app" +codesign --timestamp --options=runtime -s "$APP_CERTIFICATE" -v --entitlements ./build/darwin/entitlements.plist ./build/bin/$APP_NAME.app -productbuild --sign "$PKG_CERTIFICATE" --component "./build/bin/$APP_NAME.app" /Applications "./$APP_NAME.pkg" +productbuild --sign "$PKG_CERTIFICATE" --component ./build/bin/$APP_NAME.app /Applications ./$APP_NAME.pkg ``` #### Upload App Bundle diff --git a/website/i18n/ar/docusaurus-plugin-content-docs/current/guides/nixos-font.mdx b/website/i18n/ar/docusaurus-plugin-content-docs/current/guides/nixos-font.mdx index 02188562e..141e4d68c 100644 --- a/website/i18n/ar/docusaurus-plugin-content-docs/current/guides/nixos-font.mdx +++ b/website/i18n/ar/docusaurus-plugin-content-docs/current/guides/nixos-font.mdx @@ -1,6 +1,6 @@ # NixOS FontSize Bug -NixOS/Wayland can cause a bug where the `font-size` css property doesn't affect the rendered page. To fix this add the following to your devShell. +NixOS/Wayland can cause a bug where the `font-size` css property doesnt affect the rendered page. To fix this add the following to your devShell. ```shell shellHook = with pkgs; '' diff --git a/website/i18n/ar/docusaurus-plugin-content-docs/current/guides/signing.mdx b/website/i18n/ar/docusaurus-plugin-content-docs/current/guides/signing.mdx index 67ed0810a..49b82d94c 100644 --- a/website/i18n/ar/docusaurus-plugin-content-docs/current/guides/signing.mdx +++ b/website/i18n/ar/docusaurus-plugin-content-docs/current/guides/signing.mdx @@ -232,7 +232,7 @@ Now we need to configure some gon config files in our `build/darwin` directory: "bundle_id": "app.myapp", "apple_id": { "username": "my-appleid@email.com", - "password": "your-app-specific-password", + "password": "@env:APPLE_PASSWORD", "provider": "ABCDE12345" }, "sign": { @@ -246,13 +246,11 @@ Here is a brief break down of the above fields: - `source`: The location of your wails binary to be signed - `apple_id`: - `username`: Your Apple ID email address - - `password`: Your app-specific password + - `password`: Your app-specific password, referenced using Gon's environment variable syntax - `provider`: Your team ID for your App Store Connect account - `sign`: - `application_identity`: Your Apple developer identity -The (https://developer.apple.com/documentation/technotes/tn3147-migrating-to-the-latest-notarization-tool)[deprecated Apple's altool]'s syntax supporting `@env:` is no longer available since Apple has migrated to the new notarytool. - Your developer identity and team ID can both by found on macOS by running the following command: ```bash diff --git a/website/i18n/ar/docusaurus-plugin-content-docs/current/guides/sveltekit.mdx b/website/i18n/ar/docusaurus-plugin-content-docs/current/guides/sveltekit.mdx index 56bbdd703..7de133a8a 100644 --- a/website/i18n/ar/docusaurus-plugin-content-docs/current/guides/sveltekit.mdx +++ b/website/i18n/ar/docusaurus-plugin-content-docs/current/guides/sveltekit.mdx @@ -2,7 +2,7 @@ This guide will go into: -1. Minimal Installation Steps - The steps needed to get a minimum Wails setup working for SvelteKit. +1. Miminal Installation Steps - The steps needed to get a minimum Wails setup working for SvelteKit. 2. Install Script - Bash script for accomplishing the Minimal Installation Steps with optional Wails branding. 3. Important Notes - Issues that can be encountered when using SvelteKit + Wails and fixes. @@ -17,9 +17,9 @@ This guide will go into: - Navigate into your newly created myapp folder. - Delete the folder named "frontend" -##### While in the Wails project root. Use the Svelte CLI to create a SvelteKit project as the new frontend. Follow the prompts, nothing Wails specific is needed here. +##### While in the Wails project root. Use your favorite package manager and install SvelteKit as the new frontend. Follow the prompts. -- `npx sv create frontend` +- `npm create svelte@latest frontend` ##### Modify wails.json. @@ -124,7 +124,7 @@ wails dev See https://wails.io/docs/guides/frontend for more information. -##### Initial data can be loaded and refreshed from +page.ts/+page.js to +page.svelte. +##### Inital data can be loaded and refreshed from +page.ts/+page.js to +page.svelte. - \+page.ts/+page.js works well with load() https://kit.svelte.dev/docs/load#page-data - invalidateAll() in +page.svelte will call load() from +page.ts/+page.js https://kit.svelte.dev/docs/load#rerunning-load-functions-manual-invalidation. diff --git a/website/i18n/ar/docusaurus-plugin-content-docs/current/reference/cli.mdx b/website/i18n/ar/docusaurus-plugin-content-docs/current/reference/cli.mdx index 9c595c4f8..3e0388750 100644 --- a/website/i18n/ar/docusaurus-plugin-content-docs/current/reference/cli.mdx +++ b/website/i18n/ar/docusaurus-plugin-content-docs/current/reference/cli.mdx @@ -66,7 +66,7 @@ If you are unsure about a template, inspect `package.json` and `wails.json` for | -nsis | Generate NSIS installer for Windows | | | -o filename | Output filename | | | -obfuscated | Obfuscate the application using [garble](https://github.com/burrowers/garble) | | -| -platform | Build for the given (comma delimited) [platforms](../reference/cli.mdx#platforms) eg. `windows/arm64`. Note, if you do not give the architecture, `runtime.GOARCH` is used. | platform = `GOOS` environment variable if given else `runtime.GOOS`.<br/>arch = `GOARCH` environment variable if given else `runtime.GOARCH`. | +| -platform | Build for the given (comma delimited) [platforms](../reference/cli.mdx#platforms) eg. `windows/arm64`. Note, if you do not give the architecture, `runtime.GOARCH` is used. | platform = `GOOS` environment variable if given else `runtime.GOOS`.<br/>arch = `GOARCH` envrionment variable if given else `runtime.GOARCH`. | | -race | Build with Go's race detector | | | -s | Skip building the frontend | | | -skipbindings | Skip bindings generation | | @@ -99,12 +99,6 @@ There are [issues](https://github.com/upx/upx/issues/446) with using UPX with Ap ::: -:::info Set minimal version for MacOS - -You can override default [minimal version](../gettingstarted/installation#supported-platforms) of macOS for your app by providing version via `CGO_CFLAGS` and `CGO_LDFLAGS` environment variables. e.g. `CGO_CFLAGS=-mmacosx-version-min=10.15.0 CGO_LDFLAGS=-mmacosx-version-min=10.15.0 wails build` - -::: - :::info UPX on Windows Some Antivirus vendors false positively mark `upx` compressed binaries as virus, see [issue](https://github.com/upx/upx/issues/437). diff --git a/website/i18n/ar/docusaurus-plugin-content-docs/current/reference/menus.mdx b/website/i18n/ar/docusaurus-plugin-content-docs/current/reference/menus.mdx index bcf0f2344..ff9a24422 100644 --- a/website/i18n/ar/docusaurus-plugin-content-docs/current/reference/menus.mdx +++ b/website/i18n/ar/docusaurus-plugin-content-docs/current/reference/menus.mdx @@ -13,21 +13,15 @@ An example of how to create a menu: app := NewApp() AppMenu := menu.NewMenu() - if runtime.GOOS == "darwin" { - AppMenu.Append(menu.AppMenu()) // On macOS platform, this must be done right after `NewMenu()` - } FileMenu := AppMenu.AddSubmenu("File") - FileMenu.AddText("&Open", keys.CmdOrCtrl("o"), func(_ *menu.CallbackData) { - // do something - }) + FileMenu.AddText("&Open", keys.CmdOrCtrl("o"), openFile) FileMenu.AddSeparator() FileMenu.AddText("Quit", keys.CmdOrCtrl("q"), func(_ *menu.CallbackData) { - // `rt` is an alias of "github.com/wailsapp/wails/v2/pkg/runtime" to prevent collision with standard package - rt.Quit(app.ctx) + runtime.Quit(app.ctx) }) if runtime.GOOS == "darwin" { - AppMenu.Append(menu.EditMenu()) // On macOS platform, EditMenu should be appended to enable Cmd+C, Cmd+V, Cmd+Z... shortcuts + AppMenu.Append(menu.EditMenu()) // on macos platform, we should append EditMenu to enable Cmd+C,Cmd+V,Cmd+Z... shortcut } err := wails.Run(&options.App{ diff --git a/website/i18n/ar/docusaurus-plugin-content-docs/current/reference/options.mdx b/website/i18n/ar/docusaurus-plugin-content-docs/current/reference/options.mdx index 6626b5717..8bcf42047 100644 --- a/website/i18n/ar/docusaurus-plugin-content-docs/current/reference/options.mdx +++ b/website/i18n/ar/docusaurus-plugin-content-docs/current/reference/options.mdx @@ -98,9 +98,7 @@ func main() { // OnResume is called when Windows resumes from low power mode OnResume: func(), // Disable GPU hardware acceleration for the webview - WebviewGpuDisabled: false, - // Class name for the window. If empty, 'wailsWindow' will be used. - WindowClassName: "MyWindow", + WebviewGpuDisabled: false, }, Mac: &mac.Options{ TitleBar: &mac.TitleBar{ @@ -422,6 +420,18 @@ EnableFraudulentWebsiteDetection enables scan services for fraudulent content, s Name: EnableFraudulentWebsiteDetection<br/> Type: `bool` +### ZoomFactor + +Name: ZoomFactor<br/> Type: `float64` + +This defines the zoom factor for the WebView2. This is the option matching the Edge user activated zoom in or out. + +### IsZoomControlEnabled + +Name: IsZoomControlEnabled<br/> Type: `bool` + +This enables the zoom factor to be changed by the user. Please note that the zoom factor can be set in the options while disallowing the user to change it at runtime (f.e. for a kiosk application or similar). + ### Bind A slice of struct instances defining methods that need to be bound to the frontend. @@ -536,18 +546,6 @@ The value can be one of the following: | Mica | Use [Mica](https://learn.microsoft.com/en-us/windows/apps/design/style/mica) effect | | Tabbed | Use Tabbed. This is a backdrop that is similar to Mica. | -#### ZoomFactor - -Name: ZoomFactor<br/> Type: `float64` - -This defines the zoom factor for the WebView2. This is the option matching the Edge user activated zoom in or out. - -#### IsZoomControlEnabled - -Name: IsZoomControlEnabled<br/> Type: `bool` - -This enables the zoom factor to be changed by the user. Please note that the zoom factor can be set in the options while disallowing the user to change it at runtime (f.e. for a kiosk application or similar). - #### DisablePinchZoom Setting this to `true` will disable pinch zoom gestures. @@ -692,12 +690,6 @@ Setting this to `true` will enable swipe gestures for the webview. Name: EnableSwipeGestures<br/> Type: `bool` -#### WindowClassName - -Class name for the window. If empty, 'wailsWindow' will be used. - -Name: WindowClassName<br/> Type: `string` - ### Mac This defines [Mac specific options](#mac). diff --git a/website/i18n/ar/docusaurus-plugin-content-docs/current/reference/runtime/events.mdx b/website/i18n/ar/docusaurus-plugin-content-docs/current/reference/runtime/events.mdx index 7a2ebda7e..856ba6f0c 100644 --- a/website/i18n/ar/docusaurus-plugin-content-docs/current/reference/runtime/events.mdx +++ b/website/i18n/ar/docusaurus-plugin-content-docs/current/reference/runtime/events.mdx @@ -14,7 +14,7 @@ Go: `EventsOn(ctx context.Context, eventName string, callback func(optionalData ### EventsOff -This method unregisters the listener for the given event name, optionally multiple listeners can be unregistered via `additionalEventNames`. +This method unregisters the listener for the given event name, optionally multiple listeneres can be unregistered via `additionalEventNames`. Go: `EventsOff(ctx context.Context, eventName string, additionalEventNames ...string)`<br/> JS: `EventsOff(eventName string, ...additionalEventNames)` diff --git a/website/i18n/ar/docusaurus-plugin-content-docs/current/reference/runtime/window.mdx b/website/i18n/ar/docusaurus-plugin-content-docs/current/reference/runtime/window.mdx index f7cdae99f..b2ae6deba 100644 --- a/website/i18n/ar/docusaurus-plugin-content-docs/current/reference/runtime/window.mdx +++ b/website/i18n/ar/docusaurus-plugin-content-docs/current/reference/runtime/window.mdx @@ -202,7 +202,7 @@ Go: `WindowSetBackgroundColour(ctx context.Context, R, G, B, A uint8)`<br/> JS: ### WindowPrint -Opens the native print dialog. +Opens tha native print dialog. Go: `WindowPrint(ctx context.Context)`<br/> JS: `WindowPrint()` diff --git a/website/i18n/ar/docusaurus-plugin-content-docs/version-v2.10.json b/website/i18n/ar/docusaurus-plugin-content-docs/version-v2.10.json deleted file mode 100644 index deb213d1a..000000000 --- a/website/i18n/ar/docusaurus-plugin-content-docs/version-v2.10.json +++ /dev/null @@ -1,38 +0,0 @@ -{ - "version.label": { - "message": "v2.10", - "description": "The label for version v2.10" - }, - "sidebar.docs.category.Getting Started": { - "message": "Getting Started", - "description": "The label for category Getting Started in sidebar docs" - }, - "sidebar.docs.category.Reference": { - "message": "Reference", - "description": "The label for category Reference in sidebar docs" - }, - "sidebar.docs.category.Runtime": { - "message": "Runtime", - "description": "The label for category Runtime in sidebar docs" - }, - "sidebar.docs.category.Community": { - "message": "Community", - "description": "The label for category Community in sidebar docs" - }, - "sidebar.docs.category.Showcase": { - "message": "Showcase", - "description": "The label for category Showcase in sidebar docs" - }, - "sidebar.docs.category.Guides": { - "message": "Guides", - "description": "The label for category Guides in sidebar docs" - }, - "sidebar.docs.category.Tutorials": { - "message": "Tutorials", - "description": "The label for category Tutorials in sidebar docs" - }, - "sidebar.docs.link.Contributing": { - "message": "Contributing", - "description": "The label for link Contributing in sidebar docs, linking to /community-guide#ways-of-contributing" - } -} diff --git a/website/i18n/ar/docusaurus-plugin-content-pages/changelog.mdx b/website/i18n/ar/docusaurus-plugin-content-pages/changelog.mdx index 4efaca467..d8d1039ac 100644 --- a/website/i18n/ar/docusaurus-plugin-content-pages/changelog.mdx +++ b/website/i18n/ar/docusaurus-plugin-content-pages/changelog.mdx @@ -13,79 +13,6 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), ## [Unreleased] -### Changed -- Updated recommendation for Svelte router in [#4085](https://github.com/wailsapp/wails/pull/4085) by [@benmccann](https://github.com/benmccann) - -### Added -- Added "Branding" section to `wails doctor` to correctly identify Windows 11 [#3891](https://github.com/wailsapp/wails/pull/3891) by [@ronen25](https://github.com/ronen25) - - -## v2.10.1 - 2025-02-24 - -### Fixed -- Fixed [listenerOff issue](https://github.com/wailsapp/wails/issues/3850) by @leaanthony. -- Fixed issues building with `darwin/universal` target by @leaanthony. - -## v2.10 - 2025-02-15 - -### Added -- Added option to set window class name on Windows. Added in [PR](https://github.com/wailsapp/wails/pull/3828) by @APshenkin - -### Fixed -- Fixed dev mode logging bug by @attperac in [#3972](https://wailsapp/wails/pull/3972) -- Fixed `reloaddirs` wails.json config options by @atterpac in [#4005](https//github.com/wailsapp/wails/pull/4005) -- Fixed cross compilation failed with CGO [PR](https://github.com/wailsapp/wails/pull/3795) by [@fcying](https://github.com/fcying) -- Using go-webview2 v0.1.17 to fix native webview2loader issue, by @leaanthony -- Fixed example for macOS menu by @takuyahara in [PR](https://github.com/wailsapp/wails/pull/3847) -- Fixed typo by @takuyahara in [PR](https://github.com/wailsapp/wails/pull/3846) -- Fixed incorrect TS definition of `WindowSetSize` by @leaanthony -- Ensure showHiddenFiles works with directory dialog by @leaanthony in [PR](https://github.com/wailsapp/wails/pull/3904) -- chore: fix some comments in [PR](https://github.com/wailsapp/wails/pull/3932) by @lvyaoting -- [windows] Fixed frameless window flickering when minimizing/restoring by preventing unnecessary redraws [#3951](https://github.com/wailsapp/wails/issues/3951) -- Fixed failed models.ts build due to non-json-encodable Go types [PR](https://github.com/wailsapp/wails/pull/3975) by [@pbnjay](https://github.com/pbnjay) -- Fixed more binding and typescript export bugs [PR](https://github.com/wailsapp/wails/pull/3978) by [@pbnjay](https://github.com/pbnjay) -- Fixed Dispatcher.ProcessMessage crash process instead of return error [PR](https://github.com/wailsapp/wails/pull/4016) [#4015](https://github.com/wailsapp/wails/issues/4015) by [@ronaldinho_x86](https://github.com/RonaldinhoL) -- Fixed Windows SaveDialog crash by [@leaanthony](https://github.com/leaanthony) -- Fixed `buildvcs` errors by [@leaanthony](https://github.com/leaanthony) -- Fixed updating menus on MacOS by [@stffabi](https://github.com/stffabi) -- Fixed a build error on macOS that occurred when the `outputfilename` and `name` fields in wails.json were different. Fixed in [PR](https://github.com/wailsapp/wails/pull/3789) by [@nickisworking](https://github.com/nickisworking) - -### Changed -- Removed documentation references for 'The default module name in go.mod is "changeme". You should change this to something more appropriate.' as it appears to be no longer relevant. -- Update script in Mac App Store guide to support app names containing spaces by @cristianrgreco -- Allow to specify macos-min-version externally. Implemented by @APshenkin in [PR](https://github.com/wailsapp/wails/pull/3756) -- Updated installation docs for latest linux os version and libwebkit issue [PR](https://github.com/wailsapp/wails/pull/3806) by [@pratikmota](https://github.com/pratikmota) - - - -## v2.9.3 - 2025-02-13 - -### Added -- Go 1.24 support by [@leaanthony](https://github.com/leaanthony) - -### Fixed -- Now using `-buildvcs=false` build tag by default to remove `error obtaining VCS status: exit status 128` errors by [@leaanthony](https://github.com/leaanthony) - -## v2.9.2 - 2024-09-18 - -### Fixed -- Fixed CGO memory issue on Darwin by @leaanthony in [PR](https://github.com/wailsapp/wails/pull/3590) -- Fixed an error that occurred when an author name contains a string that is not suitable for JSON. Fixed by @taiseiotsuka in [PR](https://github.com/wailsapp/wails/pull/3638) -- Fixed MacOS build to use `outputfilename` from wails.json. [#3200](https://github.com/wailsapp/wails/issues/3200) -- Fixed file drop events on windows. Fixed in [PR](https://github.com/wailsapp/wails/pull/3595) by @FrancescoLuzzi -- Fixed doctor command not finding pkg-config on Solus. [PR #3670](https://github.com/wailsapp/wails/pull/3670) by [@ianmjones](https://github.com/ianmjones) -- Fixed binding for struct fields that were exported but had no json tags. [PR #3678](https://github.com/wailsapp/wails/pull/3678) -- Fixed file drop events on Windows in [PR](https://github.com/wailsapp/wails/pull/3595) by @FrancescoLuzzi -- Modified `ZoomFactor` and `IsZoomControlEnabled` options to be Windows-only options in PR[#3644](https://github.com/wailsapp/wails/pull/3644) by @levinit -- Added nil check for Drag-n-Drop on Windows. Fixed by in [PR](https://github.com/wailsapp/wails/pull/3597) by @leaanthony based on the suggestion by @Alpa-1 in [#3596](https://github.com/wailsapp/wails/issues/3596). -- Fixed typos in various .mdx files. [PR #3628](https://github.com/wailsapp/wails/pull/3628) by [@deining](https://github.com/deining) -- Fixed `notifyListeners()` race condition when terminated mid-emission [PR](https://github.com/wailsapp/wails/pull/3695) by [@mrf345](https://github.com/mrf345) -- Fixed dialogs in Windows when using Go 1.23 in [PR](https://github.com/wailsapp/wails/pull/3707) by [@leaanthony](https://github.com/leaanthony) -- More syscall fixes for Go 1.23 support in [PR](https://github.com/wailsapp/wails/pull/3713) by [@leaanthony](https://github.com/leaanthony) -- Fixed drag and drop missing cursor icon [PR](https://github.com/wailsapp/wails/pull/3703) by [@mrf345](https://github.com/mrf345) - -### Changed -- Modified docs to reflect the correct password syntax for the `gon-sign.json` file [PR](https://github.com/wailsapp/wails/pull/3620) by [@ignasbernotas](github.com/ignasbernotas) ## v2.9.1 - 2024-06-18 ### Fixed diff --git a/website/i18n/ar/docusaurus-plugin-content-pages/credits.mdx b/website/i18n/ar/docusaurus-plugin-content-pages/credits.mdx index 7d12dca6a..a46ca16e9 100644 --- a/website/i18n/ar/docusaurus-plugin-content-pages/credits.mdx +++ b/website/i18n/ar/docusaurus-plugin-content-pages/credits.mdx @@ -6,7 +6,6 @@ - [Atterpac](https://github.com/atterpac) - Developer, support guru, powerhouse - [Simon Thomas](mailto:enquiries@wails.io) - Growth Hacker - [Lyimmi](https://github.com/Lyimmi) - All things Linux -- [fbbdev](https://github.com/fbbdev) - Bindings Generator guru & core contributor ## Sponsors <img src="/img/sponsors.svg" style={{"width":"85%","max-width":"800px;"}} /> @@ -39,7 +38,7 @@ </tr> <tr> <td align="center" valign="top" width="12.5%"><a href="https://github.com/k-muchmore"><img src="https://avatars.githubusercontent.com/u/16393095?v=4?s=75" width="75px;" alt="k-muchmore"/><br /><sub><b>k-muchmore</b></sub></a><br /><a href="https://github.com/wailsapp/wails/commits?author=k-muchmore" title="Code">💻</a></td> - <td align="center" valign="top" width="12.5%"><a href="https://github.com/Snider"><img src="https://avatars.githubusercontent.com/u/631881?v=4?s=75" width="75px;" alt="Snider"/><br /><sub><b>Snider</b></sub></a><br /><a href="https://github.com/wailsapp/wails/commits?author=Snider" title="Code">💻</a> <a href="#ideas-Snider" title="Ideas, Planning, & Feedback">🤔</a> <a href="https://github.com/wailsapp/wails/commits?author=Snider" title="Documentation">📖</a> <a href="#financial-Snider" title="Financial">💵</a><a href="https://github.com/dappServer/wails-build-action" title="Tools">🔧</a></td> + <td align="center" valign="top" width="12.5%"><a href="https://peakd.com/@snider"><img src="https://avatars.githubusercontent.com/u/631881?v=4?s=75" width="75px;" alt="Snider"/><br /><sub><b>Snider</b></sub></a><br /><a href="https://github.com/wailsapp/wails/commits?author=Snider" title="Code">💻</a> <a href="#ideas-Snider" title="Ideas, Planning, & Feedback">🤔</a> <a href="https://github.com/wailsapp/wails/commits?author=Snider" title="Documentation">📖</a> <a href="#financial-Snider" title="Financial">💵</a></td> <td align="center" valign="top" width="12.5%"><a href="https://github.com/albert-sun"><img src="https://avatars.githubusercontent.com/u/54585592?v=4?s=75" width="75px;" alt="Albert Sun"/><br /><sub><b>Albert Sun</b></sub></a><br /><a href="https://github.com/wailsapp/wails/commits?author=albert-sun" title="Code">💻</a> <a href="https://github.com/wailsapp/wails/commits?author=albert-sun" title="Tests">⚠️</a></td> <td align="center" valign="top" width="12.5%"><a href="https://github.com/adalessa"><img src="https://avatars.githubusercontent.com/u/7914601?v=4?s=75" width="75px;" alt="Ariel"/><br /><sub><b>Ariel</b></sub></a><br /><a href="https://github.com/wailsapp/wails/commits?author=adalessa" title="Code">💻</a> <a href="https://github.com/wailsapp/wails/issues?q=author%3Aadalessa" title="Bug reports">🐛</a></td> <td align="center" valign="top" width="12.5%"><a href="https://triplebits.com/"><img src="https://avatars.githubusercontent.com/u/4365245?v=4?s=75" width="75px;" alt="Ilgıt Yıldırım"/><br /><sub><b>Ilgıt Yıldırım</b></sub></a><br /><a href="https://github.com/wailsapp/wails/commits?author=ilgityildirim" title="Code">💻</a> <a href="https://github.com/wailsapp/wails/issues?q=author%3Ailgityildirim" title="Bug reports">🐛</a> <a href="#financial-ilgityildirim" title="Financial">💵</a></td> @@ -266,5 +265,5 @@ - [Byron Chris](https://github.com/bh90210) - For his long term contributions to this project. - [Dustin Krysak](https://wiki.ubuntu.com/bashfulrobot) - His support and feedback has been invaluable. - [Justen Walker](https://github.com/justenwalker/) - For helping wrangle COM issues which got v2 over the line. -- [Wang, Chi](https://github.com/branchseer) - The DeskGap project was a huge influence on the direction of Wails v2. +- [Wang, Chi](https://github.com/patr0nus/) - The DeskGap project was a huge influence on the direction of Wails v2. - [Serge Zaitsev](https://github.com/zserge) - Whilst Wails does not use the Webview project, it is still a source of inspiration. diff --git a/website/i18n/ar/docusaurus-theme-classic/footer.json b/website/i18n/ar/docusaurus-theme-classic/footer.json index 48e57df44..dd6667908 100644 --- a/website/i18n/ar/docusaurus-theme-classic/footer.json +++ b/website/i18n/ar/docusaurus-theme-classic/footer.json @@ -44,7 +44,7 @@ "description": "The label of footer link with label=Blog linking to /blog" }, "copyright": { - "message": "Copyright © 2025 Lea Anthony", + "message": "Copyright © 2022 Lea Anthony", "description": "The footer copyright" }, "link.item.label.Awesome": { diff --git a/website/i18n/de/code.json b/website/i18n/de/code.json deleted file mode 100644 index c3b0bdfeb..000000000 --- a/website/i18n/de/code.json +++ /dev/null @@ -1,431 +0,0 @@ -{ - "homepage.Features.Title1": { - "message": "Feature Rich" - }, - "homepage.Features.Description1": { - "message": "Build comprehensive cross-platform applications using native UI elements such as menus and dialogs." - }, - "homepage.Features.Title2": { - "message": "Familiar" - }, - "homepage.Features.Description2": { - "message": "Use the technologies you already know to build amazing applications." - }, - "homepage.Features.Title3": { - "message": "Fast" - }, - "homepage.Features.Description3": { - "message": "Quickly generate, build and package your projects using the Wails CLI." - }, - "homepage.Tagline": { - "message": "Build beautiful cross-platform applications using Go" - }, - "homepage.ButtonText": { - "message": "Get Started" - }, - "homepage.LearnMoreButtonText": { - "message": "Learn More" - }, - "theme.ErrorPageContent.title": { - "message": "This page crashed.", - "description": "The title of the fallback page when the page crashed" - }, - "theme.ErrorPageContent.tryAgain": { - "message": "Try again", - "description": "The label of the button to try again rendering when the React error boundary captures an error" - }, - "theme.NotFound.title": { - "message": "Page Not Found", - "description": "The title of the 404 page" - }, - "theme.NotFound.p1": { - "message": "We could not find what you were looking for.", - "description": "The first paragraph of the 404 page" - }, - "theme.NotFound.p2": { - "message": "Please contact the owner of the site that linked you to the original URL and let them know their link is broken.", - "description": "The 2nd paragraph of the 404 page" - }, - "theme.AnnouncementBar.closeButtonAriaLabel": { - "message": "Close", - "description": "The ARIA label for close button of announcement bar" - }, - "theme.blog.archive.title": { - "message": "Archive", - "description": "The page & hero title of the blog archive page" - }, - "theme.blog.archive.description": { - "message": "Archive", - "description": "The page & hero description of the blog archive page" - }, - "theme.BackToTopButton.buttonAriaLabel": { - "message": "Scroll back to top", - "description": "The ARIA label for the back to top button" - }, - "theme.blog.paginator.navAriaLabel": { - "message": "Blog list page navigation", - "description": "The ARIA label for the blog pagination" - }, - "theme.blog.paginator.newerEntries": { - "message": "Newer Entries", - "description": "The label used to navigate to the newer blog posts page (previous page)" - }, - "theme.blog.paginator.olderEntries": { - "message": "Older Entries", - "description": "The label used to navigate to the older blog posts page (next page)" - }, - "theme.blog.post.readingTime.plurals": { - "message": "One min read|{readingTime} min read", - "description": "Pluralized label for \"{readingTime} min read\". Use as much plural forms (separated by \"|\") as your language support (see https://www.unicode.org/cldr/cldr-aux/charts/34/supplemental/language_plural_rules.html)" - }, - "theme.blog.post.readMoreLabel": { - "message": "Read more about {title}", - "description": "The ARIA label for the link to full blog posts from excerpts" - }, - "theme.blog.post.readMore": { - "message": "Read More", - "description": "The label used in blog post item excerpts to link to full blog posts" - }, - "theme.blog.post.paginator.navAriaLabel": { - "message": "Blog post page navigation", - "description": "The ARIA label for the blog posts pagination" - }, - "theme.blog.post.paginator.newerPost": { - "message": "Newer Post", - "description": "The blog post button label to navigate to the newer/previous post" - }, - "theme.blog.post.paginator.olderPost": { - "message": "Older Post", - "description": "The blog post button label to navigate to the older/next post" - }, - "theme.blog.sidebar.navAriaLabel": { - "message": "Blog recent posts navigation", - "description": "The ARIA label for recent posts in the blog sidebar" - }, - "theme.blog.post.plurals": { - "message": "One post|{count} posts", - "description": "Pluralized label for \"{count} posts\". Use as much plural forms (separated by \"|\") as your language support (see https://www.unicode.org/cldr/cldr-aux/charts/34/supplemental/language_plural_rules.html)" - }, - "theme.blog.tagTitle": { - "message": "{nPosts} tagged with \"{tagName}\"", - "description": "The title of the page for a blog tag" - }, - "theme.tags.tagsPageLink": { - "message": "View All Tags", - "description": "The label of the link targeting the tag list page" - }, - "theme.CodeBlock.copyButtonAriaLabel": { - "message": "Copy code to clipboard", - "description": "The ARIA label for copy code blocks button" - }, - "theme.CodeBlock.copied": { - "message": "Copied", - "description": "The copied button label on code blocks" - }, - "theme.CodeBlock.copy": { - "message": "Copy", - "description": "The copy button label on code blocks" - }, - "theme.colorToggle.ariaLabel": { - "message": "Switch between dark and light mode (currently {mode})", - "description": "The ARIA label for the navbar color mode toggle" - }, - "theme.colorToggle.ariaLabel.mode.dark": { - "message": "dark mode", - "description": "The name for the dark color mode" - }, - "theme.colorToggle.ariaLabel.mode.light": { - "message": "light mode", - "description": "The name for the light color mode" - }, - "theme.docs.DocCard.categoryDescription": { - "message": "{count} items", - "description": "The default description for a category card in the generated index about how many items this category includes" - }, - "theme.docs.sidebar.expandButtonTitle": { - "message": "Expand sidebar", - "description": "The ARIA label and title attribute for expand button of doc sidebar" - }, - "theme.docs.sidebar.expandButtonAriaLabel": { - "message": "Expand sidebar", - "description": "The ARIA label and title attribute for expand button of doc sidebar" - }, - "theme.docs.paginator.navAriaLabel": { - "message": "Docs pages navigation", - "description": "The ARIA label for the docs pagination" - }, - "theme.docs.paginator.previous": { - "message": "Previous", - "description": "The label used to navigate to the previous doc" - }, - "theme.docs.paginator.next": { - "message": "Next", - "description": "The label used to navigate to the next doc" - }, - "theme.docs.sidebar.collapseButtonTitle": { - "message": "Collapse sidebar", - "description": "The title attribute for collapse button of doc sidebar" - }, - "theme.docs.sidebar.collapseButtonAriaLabel": { - "message": "Collapse sidebar", - "description": "The title attribute for collapse button of doc sidebar" - }, - "theme.DocSidebarItem.toggleCollapsedCategoryAriaLabel": { - "message": "Toggle the collapsible sidebar category '{label}'", - "description": "The ARIA label to toggle the collapsible sidebar category" - }, - "theme.docs.tagDocListPageTitle.nDocsTagged": { - "message": "One doc tagged|{count} docs tagged", - "description": "Pluralized label for \"{count} docs tagged\". Use as much plural forms (separated by \"|\") as your language support (see https://www.unicode.org/cldr/cldr-aux/charts/34/supplemental/language_plural_rules.html)" - }, - "theme.docs.tagDocListPageTitle": { - "message": "{nDocsTagged} with \"{tagName}\"", - "description": "The title of the page for a docs tag" - }, - "theme.docs.versionBadge.label": { - "message": "Version: {versionLabel}" - }, - "theme.docs.versions.unreleasedVersionLabel": { - "message": "This is unreleased documentation for {siteTitle} {versionLabel} version.", - "description": "The label used to tell the user that he's browsing an unreleased doc version" - }, - "theme.docs.versions.unmaintainedVersionLabel": { - "message": "This is documentation for {siteTitle} {versionLabel}, which is no longer actively maintained.", - "description": "The label used to tell the user that he's browsing an unmaintained doc version" - }, - "theme.docs.versions.latestVersionSuggestionLabel": { - "message": "For up-to-date documentation, see the {latestVersionLink} ({versionLabel}).", - "description": "The label used to tell the user to check the latest version" - }, - "theme.docs.versions.latestVersionLinkLabel": { - "message": "latest version", - "description": "The label used for the latest version suggestion link label" - }, - "theme.common.editThisPage": { - "message": "Edit this page", - "description": "The link label to edit the current page" - }, - "theme.common.headingLinkTitle": { - "message": "Direct link to heading", - "description": "Title for link to heading" - }, - "theme.lastUpdated.atDate": { - "message": " on {date}", - "description": "The words used to describe on which date a page has been last updated" - }, - "theme.lastUpdated.byUser": { - "message": " by {user}", - "description": "The words used to describe by who the page has been last updated" - }, - "theme.lastUpdated.lastUpdatedAtBy": { - "message": "Last updated{atDate}{byUser}", - "description": "The sentence used to display when a page has been last updated, and by who" - }, - "theme.navbar.mobileSidebarSecondaryMenu.backButtonLabel": { - "message": "← Back to main menu", - "description": "The label of the back button to return to main menu, inside the mobile navbar sidebar secondary menu (notably used to display the docs sidebar)" - }, - "theme.navbar.mobileVersionsDropdown.label": { - "message": "Versions", - "description": "The label for the navbar versions dropdown on mobile view" - }, - "theme.common.skipToMainContent": { - "message": "Skip to main content", - "description": "The skip to content label used for accessibility, allowing to rapidly navigate to main content with keyboard tab/enter navigation" - }, - "theme.tags.tagsListLabel": { - "message": "Tags:", - "description": "The label alongside a tag list" - }, - "theme.TOCCollapsible.toggleButtonLabel": { - "message": "On this page", - "description": "The label used by the button on the collapsible TOC component" - }, - "theme.navbar.mobileLanguageDropdown.label": { - "message": "Languages", - "description": "The label for the mobile language switcher dropdown" - }, - "theme.SearchBar.seeAll": { - "message": "See all {count} results" - }, - "theme.SearchBar.label": { - "message": "Search", - "description": "The ARIA label and placeholder for search button" - }, - "theme.SearchPage.documentsFound.plurals": { - "message": "One document found|{count} documents found", - "description": "Pluralized label for \"{count} documents found\". Use as much plural forms (separated by \"|\") as your language support (see https://www.unicode.org/cldr/cldr-aux/charts/34/supplemental/language_plural_rules.html)" - }, - "theme.SearchPage.existingResultsTitle": { - "message": "Search results for \"{query}\"", - "description": "The search page title for non-empty query" - }, - "theme.SearchPage.emptyResultsTitle": { - "message": "Search the documentation", - "description": "The search page title for empty query" - }, - "theme.SearchPage.inputPlaceholder": { - "message": "Type your search here", - "description": "The placeholder for search page input" - }, - "theme.SearchPage.inputLabel": { - "message": "Search", - "description": "The ARIA label for search page input" - }, - "theme.SearchPage.algoliaLabel": { - "message": "Search by Algolia", - "description": "The ARIA label for Algolia mention" - }, - "theme.SearchPage.noResultsText": { - "message": "No results were found", - "description": "The paragraph for empty search result" - }, - "theme.SearchPage.fetchingNewResults": { - "message": "Fetching new results...", - "description": "The paragraph for fetching new search results" - }, - "theme.tags.tagsPageTitle": { - "message": "Tags", - "description": "The title of the tag list page" - }, - "theme.docs.breadcrumbs.home": { - "message": "Home page", - "description": "The ARIA label for the home page in the breadcrumbs" - }, - "theme.docs.breadcrumbs.navAriaLabel": { - "message": "Breadcrumbs", - "description": "The ARIA label for the breadcrumbs" - }, - "theme.CodeBlock.wordWrapToggle": { - "message": "Toggle word wrap", - "description": "The title attribute for toggle word wrapping button of code block lines" - }, - "theme.admonition.note": { - "message": "note", - "description": "The default label used for the Note admonition (:::note)" - }, - "theme.admonition.tip": { - "message": "tip", - "description": "The default label used for the Tip admonition (:::tip)" - }, - "theme.admonition.danger": { - "message": "danger", - "description": "The default label used for the Danger admonition (:::danger)" - }, - "theme.admonition.info": { - "message": "info", - "description": "The default label used for the Info admonition (:::info)" - }, - "theme.admonition.caution": { - "message": "caution", - "description": "The default label used for the Caution admonition (:::caution)" - }, - "theme.SearchModal.searchBox.resetButtonTitle": { - "message": "Clear the query", - "description": "The label and ARIA label for search box reset button" - }, - "theme.SearchModal.searchBox.cancelButtonText": { - "message": "Cancel", - "description": "The label and ARIA label for search box cancel button" - }, - "theme.SearchModal.startScreen.recentSearchesTitle": { - "message": "Recent", - "description": "The title for recent searches" - }, - "theme.SearchModal.startScreen.noRecentSearchesText": { - "message": "No recent searches", - "description": "The text when no recent searches" - }, - "theme.SearchModal.startScreen.saveRecentSearchButtonTitle": { - "message": "Save this search", - "description": "The label for save recent search button" - }, - "theme.SearchModal.startScreen.removeRecentSearchButtonTitle": { - "message": "Remove this search from history", - "description": "The label for remove recent search button" - }, - "theme.SearchModal.startScreen.favoriteSearchesTitle": { - "message": "Favorite", - "description": "The title for favorite searches" - }, - "theme.SearchModal.startScreen.removeFavoriteSearchButtonTitle": { - "message": "Remove this search from favorites", - "description": "The label for remove favorite search button" - }, - "theme.SearchModal.errorScreen.titleText": { - "message": "Unable to fetch results", - "description": "The title for error screen of search modal" - }, - "theme.SearchModal.errorScreen.helpText": { - "message": "You might want to check your network connection.", - "description": "The help text for error screen of search modal" - }, - "theme.SearchModal.footer.selectText": { - "message": "to select", - "description": "The explanatory text of the action for the enter key" - }, - "theme.SearchModal.footer.selectKeyAriaLabel": { - "message": "Enter key", - "description": "The ARIA label for the Enter key button that makes the selection" - }, - "theme.SearchModal.footer.navigateText": { - "message": "to navigate", - "description": "The explanatory text of the action for the Arrow up and Arrow down key" - }, - "theme.SearchModal.footer.navigateUpKeyAriaLabel": { - "message": "Arrow up", - "description": "The ARIA label for the Arrow up key button that makes the navigation" - }, - "theme.SearchModal.footer.navigateDownKeyAriaLabel": { - "message": "Arrow down", - "description": "The ARIA label for the Arrow down key button that makes the navigation" - }, - "theme.SearchModal.footer.closeText": { - "message": "to close", - "description": "The explanatory text of the action for Escape key" - }, - "theme.SearchModal.footer.closeKeyAriaLabel": { - "message": "Escape key", - "description": "The ARIA label for the Escape key button that close the modal" - }, - "theme.SearchModal.footer.searchByText": { - "message": "Search by", - "description": "The text explain that the search is making by Algolia" - }, - "theme.SearchModal.noResultsScreen.noResultsText": { - "message": "No results for", - "description": "The text explains that there are no results for the following search" - }, - "theme.SearchModal.noResultsScreen.suggestedQueryText": { - "message": "Try searching for", - "description": "The text for the suggested query when no results are found for the following search" - }, - "theme.SearchModal.noResultsScreen.reportMissingResultsText": { - "message": "Believe this query should return results?", - "description": "The text for the question where the user thinks there are missing results" - }, - "theme.SearchModal.noResultsScreen.reportMissingResultsLinkText": { - "message": "Let us know.", - "description": "The text for the link to report missing results" - }, - "theme.SearchModal.placeholder": { - "message": "Search docs", - "description": "The placeholder of the input of the DocSearch pop-up modal" - }, - "theme.docs.sidebar.closeSidebarButtonAriaLabel": { - "message": "Close navigation bar", - "description": "The ARIA label for close button of mobile sidebar" - }, - "theme.docs.sidebar.toggleSidebarButtonAriaLabel": { - "message": "Toggle navigation bar", - "description": "The ARIA label for hamburger menu button of mobile navigation" - }, - "theme.NavBar.navAriaLabel": { - "message": "Main", - "description": "The ARIA label for the main navigation" - }, - "theme.docs.sidebar.navAriaLabel": { - "message": "Docs sidebar", - "description": "The ARIA label for the sidebar navigation" - } -} diff --git a/website/i18n/de/docusaurus-plugin-content-blog/2021-09-27-v2-beta1-release-notes.mdx b/website/i18n/de/docusaurus-plugin-content-blog/2021-09-27-v2-beta1-release-notes.mdx deleted file mode 100644 index d01b542b1..000000000 --- a/website/i18n/de/docusaurus-plugin-content-blog/2021-09-27-v2-beta1-release-notes.mdx +++ /dev/null @@ -1,161 +0,0 @@ ---- -slug: wails-v2-beta-for-windows -title: Wails v2 Beta for Windows -authors: - - leaanthony -tags: - - wails - - v2 ---- - -```mdx-code-block -<div class="text--center"> - <img - src={require("@site/static/img/wails.webp").default} - width="40%" - class="screenshot" - /> -</div> -<br /> -``` - -When I first announced Wails on Reddit, just over 2 years ago from a train in Sydney, I did not expect it to get much attention. A few days later, a prolific tech vlogger released a tutorial video, gave it a positive review and from that point on, interest in the project has skyrocketed. - -It was clear that people were excited about adding web frontends to their Go projects, and almost immediately pushed the project beyond the proof of concept that I had created. At the time, Wails used the [webview](https://github.com/webview/webview) project to handle the frontend, and the only option for Windows was the IE11 renderer. Many bug reports were rooted in this limitation: poor JavaScript/CSS support and no dev tools to debug it. This was a frustrating development experience but there wasn't much that could have been done to rectify it. - -For a long time, I'd firmly believed that Microsoft would eventually have to sort out their browser situation. The world was moving on, frontend development was booming and IE wasn't cutting it. When Microsoft announced the move to using Chromium as the basis for their new browser direction, I knew it was only a matter of time until Wails could use it, and move the Windows developer experience to the next level. - -Today, I am pleased to announce: **Wails v2 Beta for Windows**! There's a huge amount to unpack in this release, so grab a drink, take a seat and we'll begin... - -### No CGO Dependency! - -No, I'm not joking: _No_ _CGO_ _dependency_ 🤯! The thing about Windows is that, unlike MacOS and Linux, it doesn't come with a default compiler. In addition, CGO requires a mingw compiler and there's a ton of different installation options. Removing the CGO requirement has massively simplified setup, as well as making debugging an awful lot easier. Whilst I have put a fair bit of effort in getting this working, the majority of the credit should go to [John Chadwick](https://github.com/jchv) for not only starting a couple of projects to make this possible, but also being open to someone taking those projects and building on them. Credit also to [Tad Vizbaras](https://github.com/tadvi) whose [winc](https://github.com/tadvi/winc) project started me down this path. - -### WebView2 Chromium Renderer - -```mdx-code-block -<div class="text--center"> - <img - src={require("@site/static/img/devtools.png").default} - width="75%" - class="screenshot" - /> -</div> -<br /> -``` - -Finally, Windows developers get a first class rendering engine for their applications! Gone are the days of contorting your frontend code to work on Windows. On top of that, you get a first-class developer tools experience! - -The WebView2 component does, however, have a requirement to have the `WebView2Loader.dll` sitting alongside the binary. This makes distribution just that little bit more painful than we gophers are used to. All solutions and libraries (that I know of) that use WebView2 have this dependency. - -However, I'm really excited to announce that Wails applications _have no such requirement_! Thanks to the wizardry of [John Chadwick](https://github.com/jchv), we are able to bundle this dll inside the binary and get Windows to load it as if it were present on disk. - -Gophers rejoice! The single binary dream lives on! - -### New Features - -```mdx-code-block -<div class="text--center"> - <img - src={require("@site/static/img/wails-menus.webp").default} - width="60%" - class="screenshot" - /> -</div> -<br /> -``` - -There were a lot of requests for native menu support. Wails has finally got you covered. Application menus are now available and include support for most native menu features. This includes standard menu items, checkboxes, radio groups, submenus and separators. - -There were a huge number of requests in v1 for the ability to have greater control of the window itself. I'm happy to announce that there's new runtime APIs specifically for this. It's feature-rich and supports multi-monitor configurations. There is also an improved dialogs API: Now, you can have modern, native dialogs with rich configuration to cater for all your dialog needs. - -There is now the option to generate IDE configuration along with your project. This means that if you open your project in a supported IDE, it will already be configured for building and debugging your application. Currently VSCode is supported but we hope to support other IDEs such as Goland soon. - -```mdx-code-block -<div class="text--center"> - <img - src={require("@site/static/img/vscode.webp").default} - width="100%" - class="screenshot" - /> -</div> -<br /> -``` - -### No requirement to bundle assets - -A huge pain-point of v1 was the need to condense your entire application down to single JS & CSS files. I'm happy to announce that for v2, there is no requirement to bundle assets, in any way, shape or form. Want to load a local image? Use an `<img>` tag with a local src path. Want to use a cool font? Copy it in and add the path to it in your CSS. - -> Wow, that sounds like a webserver... - -Yes, it works just like a webserver, except it isn't. - -> So how do I include my assets? - -You just pass a single `embed.FS` that contains all your assets into your application configuration. They don't even need to be in the top directory - Wails will just work it out for you. - -### New Development Experience - -```mdx-code-block -<div class="text--center"> - <img - src={require("@site/static/img/browser.webp").default} - width="60%" - class="screenshot" - /> -</div> -<br /> -``` - -Now that assets don't need to be bundled, it's enabled a whole new development experience. The new `wails dev` command will build and run your application, but instead of using the assets in the `embed.FS`, it loads them directly from disk. - -It also provides the additional features: - -- Hot reload - Any changes to frontend assets will trigger and auto reload of the application frontend -- Auto rebuild - Any changes to your Go code will rebuild and relaunch your application - -In addition to this, a webserver will start on port 34115. This will serve your application to any browser that connects to it. All connected web browsers will respond to system events like hot reload on asset change. - -In Go, we are used to dealing with structs in our applications. It's often useful to send structs to our frontend and use them as state in our application. In v1, this was a very manual process and a bit of a burden on the developer. I'm happy to announce that in v2, any application run in dev mode will automatically generate TypeScript models for all structs that are input or output parameters to bound methods. This enables seamless interchange of data models between the two worlds. - -In addition to this, another JS module is dynamically generated wrapping all your bound methods. This provides JSDoc for your methods, providing code completion and hinting in your IDE. It's really cool when you get data models auto-imported when hitting tab in an auto-generated module wrapping your Go code! - -### Remote Templates - -```mdx-code-block -<div class="text--center"> - <img - src={require("@site/static/img/remote.webp").default} - width="60%" - class="screenshot" - /> -</div> -<br /> -``` - -Getting an application up and running quickly was always a key goal for the Wails project. When we launched, we tried to cover a lot of the modern frameworks at the time: react, vue and angular. The world of frontend development is very opinionated, fast moving and hard to keep on top of! As a result, we found our base templates getting out of date pretty quickly and this caused a maintenance headache. It also meant that we didn't have cool modern templates for the latest and greatest tech stacks. - -With v2, I wanted to empower the community by giving you the ability to create and host templates yourselves, rather than rely on the Wails project. So now you can create projects using community supported templates! I hope this will inspire developers to create a vibrant ecosystem of project templates. I'm really quite excited about what our developer community can create! - -### In Conclusion - -Wails v2 represents a new foundation for the project. The aim of this release is to get feedback on the new approach, and to iron out any bugs before a full release. Your input would be most welcome. Please direct any feedback to the [v2 Beta](https://github.com/wailsapp/wails/discussions/828) discussion board. - -There were many twists and turns, pivots and u-turns to get to this point. This was due partly to early technical decisions that needed changing, and partly because some core problems we had spent time building workarounds for were fixed upstream: Go’s embed feature is a good example. Fortunately, everything came together at the right time, and today we have the very best solution that we can have. I believe the wait has been worth it - this would not have been possible even 2 months ago. - -I also need to give a huge thank you :pray: to the following people because without them, this release just wouldn't exist: - -- [Misite Bao](https://github.com/misitebao) - An absolute workhorse on the Chinese translations and an incredible bug finder. -- [John Chadwick](https://github.com/jchv) - His amazing work on [go-webview2](https://github.com/jchv/go-webview2) and [go-winloader](https://github.com/jchv/go-winloader) have made the Windows version we have today possible. -- [Tad Vizbaras](https://github.com/tadvi) - Experimenting with his [winc](https://github.com/tadvi/winc) project was the first step down the path to a pure Go Wails. -- [Mat Ryer](https://github.com/matryer) - His support, encouragement and feedback has really helped drive the project forward. - -And finally, I'd like to give a special thank you to all the [project sponsors](/credits#sponsors), including [JetBrains](https://www.jetbrains.com?from=Wails), whose support drive the project in many ways behind the scenes. - -I look forward to seeing what people build with Wails in this next exciting phase of the project! - -Lea. - -PS: MacOS and Linux users need not feel left out - porting to this new foundation is actively under way and most of the hard work has already been done. Hang in there! - -PPS: If you or your company find Wails useful, please consider [sponsoring the project](https://github.com/sponsors/leaanthony). Thanks! diff --git a/website/i18n/de/docusaurus-plugin-content-blog/2021-11-08-v2-beta2-release-notes.mdx b/website/i18n/de/docusaurus-plugin-content-blog/2021-11-08-v2-beta2-release-notes.mdx deleted file mode 100644 index 86d44616f..000000000 --- a/website/i18n/de/docusaurus-plugin-content-blog/2021-11-08-v2-beta2-release-notes.mdx +++ /dev/null @@ -1,170 +0,0 @@ ---- -slug: wails-v2-beta-for-mac -title: Wails v2 Beta for MacOS -authors: - - leaanthony -tags: - - wails - - v2 ---- - -```mdx-code-block -<div class="text--center"> - <img - src={require("@site/static/img/wails-mac.webp").default} - width="60%" - class="screenshot" - /> -</div> -<br /> -``` - -Today marks the first beta release of Wails v2 for Mac! It's taken quite a while to get to this point and I'm hoping that today's release will give you something that's reasonably useful. There have been a number of twists and turns to get to this point and I'm hoping, with your help, to iron out the crinkles and get the Mac port polished for the final v2 release. - -You mean this isn't ready for production? For your use case, it may well be ready, but there are still a number of known issues so keep your eye on [this project board](https://github.com/wailsapp/wails/projects/7) and if you would like to contribute, you'd be very welcome! - -So what's new for Wails v2 for Mac vs v1? Hint: It's pretty similar to the Windows Beta :wink: - -### New Features - -```mdx-code-block -<div class="text--center"> - <img - src={require("@site/static/img/wails-menus-mac.webp").default} - width="80%" - class="screenshot" - /> -</div> -<br /> -``` - -There were a lot of requests for native menu support. Wails has finally got you covered. Application menus are now available and include support for most native menu features. This includes standard menu items, checkboxes, radio groups, submenus and separators. - -There were a huge number of requests in v1 for the ability to have greater control of the window itself. I'm happy to announce that there's new runtime APIs specifically for this. It's feature-rich and supports multi-monitor configurations. There is also an improved dialogs API: Now, you can have modern, native dialogs with rich configuration to cater for all your dialog needs. - -### Mac Specific Options - -In addition to the normal application options, Wails v2 for Mac also brings some Mac extras: - -- Make your window all funky and translucent, like all the pretty swift apps! -- Highly customisable titlebar -- We support the NSAppearance options for the application -- Simple config to auto-create an "About" menu - -### No requirement to bundle assets - -A huge pain-point of v1 was the need to condense your entire application down to single JS & CSS files. I'm happy to announce that for v2, there is no requirement to bundle assets, in any way, shape or form. Want to load a local image? Use an `<img>` tag with a local src path. Want to use a cool font? Copy it in and add the path to it in your CSS. - -> Wow, that sounds like a webserver... - -Yes, it works just like a webserver, except it isn't. - -> So how do I include my assets? - -You just pass a single `embed.FS` that contains all your assets into your application configuration. They don't even need to be in the top directory - Wails will just work it out for you. - -### New Development Experience - -Now that assets don't need to be bundled, it's enabled a whole new development experience. The new `wails dev` command will build and run your application, but instead of using the assets in the `embed.FS`, it loads them directly from disk. - -It also provides the additional features: - -- Hot reload - Any changes to frontend assets will trigger and auto reload of the application frontend -- Auto rebuild - Any changes to your Go code will rebuild and relaunch your application - -In addition to this, a webserver will start on port 34115. This will serve your application to any browser that connects to it. All connected web browsers will respond to system events like hot reload on asset change. - -In Go, we are used to dealing with structs in our applications. It's often useful to send structs to our frontend and use them as state in our application. In v1, this was a very manual process and a bit of a burden on the developer. I'm happy to announce that in v2, any application run in dev mode will automatically generate TypeScript models for all structs that are input or output parameters to bound methods. This enables seamless interchange of data models between the two worlds. - -In addition to this, another JS module is dynamically generated wrapping all your bound methods. This provides JSDoc for your methods, providing code completion and hinting in your IDE. It's really cool when you get data models auto-imported when hitting tab in an auto-generated module wrapping your Go code! - -### Remote Templates - -```mdx-code-block -<div class="text--center"> - <img - src={require("@site/static/img/remote-mac.webp").default} - width="80%" - class="screenshot" - /> -</div> -<br /> -``` - -Getting an application up and running quickly was always a key goal for the Wails project. When we launched, we tried to cover a lot of the modern frameworks at the time: react, vue and angular. The world of frontend development is very opinionated, fast moving and hard to keep on top of! As a result, we found our base templates getting out of date pretty quickly and this caused a maintenance headache. It also meant that we didn't have cool modern templates for the latest and greatest tech stacks. - -With v2, I wanted to empower the community by giving you the ability to create and host templates yourselves, rather than rely on the Wails project. So now you can create projects using community supported templates! I hope this will inspire developers to create a vibrant ecosystem of project templates. I'm really quite excited about what our developer community can create! - -### Native M1 Support - -Thanks to the amazing support of [Mat Ryer](https://github.com/matryer/), the Wails project now supports M1 native builds: - -```mdx-code-block -<div class="text--center"> - <img - src={require("@site/static/img/build-darwin-arm.webp").default} - width="80%" - class="screenshot" - /> -</div> -<br /> -``` - -You can also specify `darwin/amd64` as a target too: - -```mdx-code-block -<div class="text--center"> - <img - src={require("@site/static/img/build-darwin-amd.webp").default} - width="80%" - class="screenshot" - /> -</div> -<br /> -``` - -Oh, I almost forgot.... you can also do `darwin/universal`.... :wink: - -```mdx-code-block -<div class="text--center"> - <img - src={require("@site/static/img/build-darwin-universal.webp").default} - width="80%" - class="screenshot" - /> -</div> -<br /> -``` - -### Cross Compilation to Windows - -Because Wails v2 for Windows is pure Go, you can target Windows builds without docker. - -```mdx-code-block -<div class="text--center"> - <img - src={require("@site/static/img/build-cross-windows.webp").default} - width="80%" - class="screenshot" - /> -</div> -<br /> -``` - -### WKWebView Renderer - -V1 relied on a (now deprecated) WebView component. V2 uses the most recent WKWebKit component so expect the latest and greatest from Apple. - -### In Conclusion - -As I'd said in the Windows release notes, Wails v2 represents a new foundation for the project. The aim of this release is to get feedback on the new approach, and to iron out any bugs before a full release. Your input would be most welcome! Please direct any feedback to the [v2 Beta](https://github.com/wailsapp/wails/discussions/828) discussion board. - -And finally, I'd like to give a special thank you to all the [project sponsors](/credits#sponsors), including [JetBrains](https://www.jetbrains.com?from=Wails), whose support drive the project in many ways behind the scenes. - -I look forward to seeing what people build with Wails in this next exciting phase of the project! - -Lea. - -PS: Linux users, you're next! - -PPS: If you or your company find Wails useful, please consider [sponsoring the project](https://github.com/sponsors/leaanthony). Thanks! diff --git a/website/i18n/de/docusaurus-plugin-content-blog/2022-02-22-v2-beta3-release-notes.mdx b/website/i18n/de/docusaurus-plugin-content-blog/2022-02-22-v2-beta3-release-notes.mdx deleted file mode 100644 index b405953cf..000000000 --- a/website/i18n/de/docusaurus-plugin-content-blog/2022-02-22-v2-beta3-release-notes.mdx +++ /dev/null @@ -1,114 +0,0 @@ ---- -slug: wails-v2-beta-for-linux -title: Wails v2 Beta for Linux -authors: - - leaanthony -tags: - - wails - - v2 ---- - -```mdx-code-block -<div class="text--center"> - <img - src={require("@site/static/img/wails-linux.webp").default} - width="40%" - class="screenshot" - /> -</div> -<br /> -``` - -I'm pleased to finally announce that Wails v2 is now in beta for Linux! It is somewhat ironic that the very first experiments with v2 was on Linux and yet it has ended up as the last release. That being said, the v2 we have today is very different from those first experiments. So without further ado, let's go over the new features: - -### New Features - -```mdx-code-block -<div class="text--center"> - <img - src={require("@site/static/img/wails-menus-linux.webp").default} - width="50%" - class="screenshot" - /> -</div> -<br /> -``` - -There were a lot of requests for native menu support. Wails has finally got you covered. Application menus are now available and include support for most native menu features. This includes standard menu items, checkboxes, radio groups, submenus and separators. - -There were a huge number of requests in v1 for the ability to have greater control of the window itself. I'm happy to announce that there's new runtime APIs specifically for this. It's feature-rich and supports multi-monitor configurations. There is also an improved dialogs API: Now, you can have modern, native dialogs with rich configuration to cater for all your dialog needs. - -### No requirement to bundle assets - -A huge pain-point of v1 was the need to condense your entire application down to single JS & CSS files. I'm happy to announce that for v2, there is no requirement to bundle assets, in any way, shape or form. Want to load a local image? Use an `<img>` tag with a local src path. Want to use a cool font? Copy it in and add the path to it in your CSS. - -> Wow, that sounds like a webserver... - -Yes, it works just like a webserver, except it isn't. - -> So how do I include my assets? - -You just pass a single `embed.FS` that contains all your assets into your application configuration. They don't even need to be in the top directory - Wails will just work it out for you. - -### New Development Experience - -Now that assets don't need to be bundled, it's enabled a whole new development experience. The new `wails dev` command will build and run your application, but instead of using the assets in the `embed.FS`, it loads them directly from disk. - -It also provides the additional features: - -- Hot reload - Any changes to frontend assets will trigger and auto reload of the application frontend -- Auto rebuild - Any changes to your Go code will rebuild and relaunch your application - -In addition to this, a webserver will start on port 34115. This will serve your application to any browser that connects to it. All connected web browsers will respond to system events like hot reload on asset change. - -In Go, we are used to dealing with structs in our applications. It's often useful to send structs to our frontend and use them as state in our application. In v1, this was a very manual process and a bit of a burden on the developer. I'm happy to announce that in v2, any application run in dev mode will automatically generate TypeScript models for all structs that are input or output parameters to bound methods. This enables seamless interchange of data models between the two worlds. - -In addition to this, another JS module is dynamically generated wrapping all your bound methods. This provides JSDoc for your methods, providing code completion and hinting in your IDE. It's really cool when you get data models auto-imported when hitting tab in an auto-generated module wrapping your Go code! - -### Remote Templates - -```mdx-code-block -<div class="text--center"> - <img - src={require("@site/static/img/remote-linux.webp").default} - width="80%" - class="screenshot" - /> -</div> -<br /> -``` - -Getting an application up and running quickly was always a key goal for the Wails project. When we launched, we tried to cover a lot of the modern frameworks at the time: react, vue and angular. The world of frontend development is very opinionated, fast moving and hard to keep on top of! As a result, we found our base templates getting out of date pretty quickly and this caused a maintenance headache. It also meant that we didn't have cool modern templates for the latest and greatest tech stacks. - -With v2, I wanted to empower the community by giving you the ability to create and host templates yourselves, rather than rely on the Wails project. So now you can create projects using community supported templates! I hope this will inspire developers to create a vibrant ecosystem of project templates. I'm really quite excited about what our developer community can create! - -### Cross Compilation to Windows - -Because Wails v2 for Windows is pure Go, you can target Windows builds without docker. - -```mdx-code-block -<div class="text--center"> - <img - src={require("@site/static/img/linux-build-cross-windows.webp").default} - width="80%" - class="screenshot" - /> -</div> -<br /> -``` - -### In Conclusion - -As I'd said in the Windows release notes, Wails v2 represents a new foundation for the project. The aim of this release is to get feedback on the new approach, and to iron out any bugs before a full release. Your input would be most welcome! Please direct any feedback to the [v2 Beta](https://github.com/wailsapp/wails/discussions/828) discussion board. - -Linux is **hard** to support. We expect there to be a number of quirks with the beta. Please help us to help you by filing detailed bug reports! - -Finally, I'd like to give a special thank you to all the [project sponsors](/credits#sponsors) whose support drive the project in many ways behind the scenes. - -I look forward to seeing what people build with Wails in this next exciting phase of the project! - -Lea. - -PS: The v2 release isn't far off now! - -PPS: If you or your company find Wails useful, please consider [sponsoring the project](https://github.com/sponsors/leaanthony). Thanks! diff --git a/website/i18n/de/docusaurus-plugin-content-blog/2022-09-22-v2-release-notes.mdx b/website/i18n/de/docusaurus-plugin-content-blog/2022-09-22-v2-release-notes.mdx deleted file mode 100644 index c321f5042..000000000 --- a/website/i18n/de/docusaurus-plugin-content-blog/2022-09-22-v2-release-notes.mdx +++ /dev/null @@ -1,98 +0,0 @@ ---- -slug: wails-v2-released -title: Wails v2 Released -authors: - - leaanthony -tags: - - wails - - v2 ---- - -```mdx-code-block -<div class="text--center"> - <img - src={require("@site/static/img/blog/montage.png").default} - width="75%" - /> -</div> -<br /> -``` - -# It's here! - -Today marks the release of [Wails](https://wails.io) v2. It's been about 18 months since the first v2 alpha and about a year from the first beta release. I'm truly grateful to everyone involved in the evolution of the project. - -Part of the reason it took that long was due to wanting to get to some definition of completeness before officially calling it v2. The truth is, there's never a perfect time to tag a release - there's always outstanding issues or "just one more" feature to squeeze in. What tagging an imperfect major release does do, however, is to provide a bit of stability for users of the project, as well as a bit of a reset for the developers. - -This release is more than I'd ever expected it to be. I hope it gives you as much pleasure as it has given us to develop it. - -# What _is_ Wails? - -If you are unfamiliar with Wails, it is a project that enables Go programmers to provide rich frontends for their Go programs using familiar web technologies. It's a lightweight, Go alternative to Electron. Much more information can be found on the [official site](https://wails.io/docs/introduction). - -# What's new? - -The v2 release is a huge leap forward for the project, addressing many of the pain points of v1. If you have not read any of the blog posts on the Beta releases for [macOS](/blog/wails-v2-beta-for-mac), [Windows](/blog/wails-v2-beta-for-windows) or [Linux](/blog/wails-v2-beta-for-linux), then I encourage you to do so as it covers all the major changes in more detail. In summary: - -- Webview2 component for Windows that supports modern web standards and debugging capabilities. -- [Dark / Light theme](/docs/reference/options#theme) + [custom theming](/docs/reference/options#customtheme) on Windows. -- Windows now has no CGO requirements. -- Out-of-the-box support for Svelte, Vue, React, Preact, Lit & Vanilla project templates. -- [Vite](https://vitejs.dev/) integration providing a hot-reload development environment for your application. -- Native application [menus](/docs/guides/application-development#application-menu) and [dialogs](/docs/reference/runtime/dialog). -- Native window translucency effects for [Windows](/docs/reference/options#windowistranslucent) and [macOS](/docs/reference/options#windowistranslucent-1). Support for Mica & Acrylic backdrops. -- Easily generate an [NSIS installer](/docs/guides/windows-installer) for Windows deployments. -- A rich [runtime library](/docs/reference/runtime/intro) providing utility methods for window manipulation, eventing, dialogs, menus and logging. -- Support for [obfuscating](/docs/guides/obfuscated) your application using [garble](https://github.com/burrowers/garble). -- Support for compressing your application using [UPX](https://upx.github.io/). -- Automatic TypeScript generation of Go structs. More info [here](/docs/howdoesitwork#calling-bound-go-methods). -- No extra libraries or DLLs are required to be shipped with your application. For any platform. -- No requirement to bundle frontend assets. Just develop your application like any other web application. - -# Credit & Thanks - -Getting to v2 has been a huge effort. There have been ~2.2K commits by 89 contributors between the initial alpha and the release today, and many, many more that have provided translations, testing, feedback and help on the discussion forums as well as the issue tracker. I'm so unbelievably grateful to each one of you. I'd also like to give an extra special thank you to all the project sponsors who have provided guidance, advice and feedback. Everything you do is hugely appreciated. - -There are a few people I'd like to give special mention to: - -Firstly, a **huge** thank you to [@stffabi](https://github.com/stffabi) who has provided so many contributions which we all benefit from, as well as providing a lot of support on many issues. He has provided some key features such as the external dev server support which transformed our dev mode offering by allowing us to hook into [Vite](https://vitejs.dev/)'s superpowers. It's fair to say that Wails v2 would be a far less exciting release without his [incredible contributions](https://github.com/wailsapp/wails/commits?author=stffabi&since=2020-01-04). Thank you so much @stffabi! - -I'd also like to give a huge shout-out to [@misitebao](https://github.com/misitebao) who has tirelessly been maintaining the website, as well as providing Chinese translations, managing Crowdin and helping new translators get up to speed. This is a hugely important task, and I'm extremely grateful for all the time and effort put into this! You rock! - -Last, but not least, a huge thank you to Mat Ryer who has provided advice and support during the development of v2. Writing xBar together using an early Alpha of v2 was helpful in shaping the direction of v2, as well as give me an understanding of some design flaws in the early releases. I'm happy to announce that as of today, we will start to port xBar to Wails v2, and it will become the flagship application for the project. Cheers Mat! - -# Lessons Learnt - -There are a number of lessons learnt in getting to v2 that will shape development moving forward. - -## Smaller, Quicker, Focused Releases - -In the course of developing v2, there were many features and bug fixes that were developed on an ad-hoc basis. This led to longer release cycles and were harder to debug. Moving forward, we are going to create releases more often that will include a reduced number of features. A release will involve updates to documentation as well as thorough testing. Hopefully, these smaller, quicker, focussed releases will lead to fewer regressions and better quality documentation. - -## Encourage Engagement - -When starting this project, I wanted to immediately help everyone who had a problem. Issues were "personal" and I wanted them resolved as quickly as possible. This is unsustainable and ultimately works against the longevity of the project. Moving forward, I will be giving more space for people to get involved in answering questions and triaging issues. It would be good to get some tooling to help with this so if you have any suggestions, please join in the discussion [here](https://github.com/wailsapp/wails/discussions/1855). - -## Learning to say No - -The more people that engage with an Open Source project, the more requests there will be for additional features that may or may not be useful to the majority of people. These features will take an initial amount of time to develop and debug, and incur an ongoing maintenance cost from that point on. I myself am the most guilty of this, often wanting to "boil the sea" rather than provide the minimum viable feature. Moving forward, we will need to say "No" a bit more to adding core features and focus our energies on a way to empower developers to provide that functionality themselves. We are looking seriously into plugins for this scenario. This will allow anyone to extend the project as they see fit, as well as providing an easy way to contribute towards the project. - -# Looking to the Future - -There are so many core features we are looking at to add to Wails in the next major development cycle already. The [roadmap](https://github.com/wailsapp/wails/discussions/1484) is full of interesting ideas, and I'm keen to start work on them. One of the big asks has been for multiple window support. It's a tricky one and to do it right, and we may need to look at providing an alternative API, as the current one was not designed with this in mind. Based on some preliminary ideas and feedback, I think you'll like where we're looking to go with it. - -I'm personally very excited at the prospect of getting Wails apps running on mobile. We already have a demo project showing that it is possible to run a Wails app on Android, so I'm really keen to explore where we can go with this! - -A final point I'd like to raise is that of feature parity. It has long been a core principle that we wouldn't add anything to the project without there being full cross-platform support for it. Whilst this has proven to be (mainly) achievable so far, it has really held the project back in releasing new features. Moving forward, we will be adopting a slightly different approach: any new feature that cannot be immediately released for all platforms will be released under an experimental configuration or API. This allows early adopters on certain platforms to try the feature and provide feedback that will feed into the final design of the feature. This, of course, means that there are no guarantees of API stability until it is fully supported by all the platforms it can be supported on, but at least it will unblock development. - -# Final Words - -I'm really proud of what we've been able to achieve with the V2 release. It's amazing to see what people have already been able to build using the beta releases so far. Quality applications like [Varly](https://varly.app/), [Surge](https://getsurge.io/) and [October](https://october.utf9k.net/). I encourage you to check them out. - -This release was achieved through the hard work of many contributors. Whilst it is free to download and use, it has not come about through zero cost. Make no mistakes, this project has come at considerable cost. It has not only been my time and the time of each and every contributor, but also the cost of absence from friends and families of each of those people too. That's why I'm extremely grateful for every second that has been dedicated to making this project happen. The more contributors we have, the more this effort can be spread out and the more we can achieve together. I'd like to encourage you all to pick one thing that you can contribute, whether it is confirming someone's bug, suggesting a fix, making a documentation change or helping out someone who needs it. All of these small things have such a huge impact! It would be so awesome if you too were part of the story in getting to v3. - -Enjoy! - -‐ Lea - -PS: If you or your company find Wails useful, please consider [sponsoring the project](https://github.com/sponsors/leaanthony). Thanks! diff --git a/website/i18n/de/docusaurus-plugin-content-blog/2023-01-17-v3-roadmap.mdx b/website/i18n/de/docusaurus-plugin-content-blog/2023-01-17-v3-roadmap.mdx deleted file mode 100644 index 9a137d09a..000000000 --- a/website/i18n/de/docusaurus-plugin-content-blog/2023-01-17-v3-roadmap.mdx +++ /dev/null @@ -1,184 +0,0 @@ ---- -slug: the-road-to-wails-v3 -title: The Road to Wails v3 -authors: - - leaanthony -tags: - - wails - - v3 ---- - -```mdx-code-block -<div class="text--center"> - <img - src={require("@site/static/img/blog/multiwindow.webp").default} - width="90%" - /> -</div> -<br /> -``` - -# Introduction - -Wails is a project that simplifies the ability to write cross-platform desktop applications using Go. It uses native webview components for the frontend (not embedded browsers), bringing the power of the world's most popular UI system to Go, whilst remaining lightweight. - -Version 2 was released on the 22nd of September 2022 and brought with it a lot of enhancements including: - -- Live development, leveraging the popular Vite project -- Rich functionality for managing windows and creating menus -- Microsoft's WebView2 component -- Generation of Typescript models that mirror your Go structs -- Creating of NSIS Installer -- Obfuscated builds - -Right now, Wails v2 provides powerful tooling for creating rich, cross-platform desktop applications. - -This blog post aims to look at where the project is at right now and what we can improve on moving forward. - -# Where are we now? - -It's been incredible to see the popularity of Wails rising since the v2 release. I'm constantly amazed by the creativity of the community and the wonderful things that are being built with it. With more popularity, comes more eyes on the project. And with that, more feature requests and bug reports. - -Over time, I've been able to identify some of the most pressing issues facing the project. I've also been able to identify some of the things that are holding the project back. - -## Current issues - -I've identified the following areas that I feel are holding the project back: - -- The API -- Bindings generation -- The Build System - -### The API - -The API to build a Wails application currently consists of 2 parts: - -- The Application API -- The Runtime API - -The Application API famously has only 1 function: `Run()` which takes a heap of options which govern how the application will work. Whilst this is very simple to use, it is also very limiting. It is a "declarative" approach which hides a lot of the underlying complexity. For instance, there is no handle to the main window, so you can't interact with it directly. For that, you need to use the Runtime API. This is a problem when you start to want to do more complex things like create multiple windows. - -The Runtime API provides a lot of utility functions for the developer. This includes: - -- Window management -- Dialogs -- Menus -- Events -- Logs - -There are a number of things I am not happy with the Runtime API. The first is that it requires a "context" to be passed around. This is both frustrating and confusing for new developers who pass in a context and then get a runtime error. - -The biggest issue with the Runtime API is that it was designed for applications that only use a single window. Over time, the demand for multiple windows has grown and the API is not well suited to this. - -### Thoughts on the v3 API - -Wouldn't it be great if we could do something like this? - -```go -func main() { - app := wails.NewApplication(options.App{}) - myWindow := app.NewWindow(options.Window{}) - myWindow.SetTitle("My Window") - myWindow.On(events.Window.Close, func() { - app.Quit() - }) - app.Run() -} -``` - -This programmatic approach is far more intuitive and allows the developer to interact with the application elements directly. All current runtime methods for windows would simply be methods on the window object. For the other runtime methods, we could move them to the application object like so: - -```go -app := wails.NewApplication(options.App{}) -app.NewInfoDialog(options.InfoDialog{}) -app.Log.Info("Hello World") -``` - -This is a much more powerful API which will allow for more complex applications to be built. It also allows for the creation of multiple windows, [the most up-voted feature on GitHub](https://github.com/wailsapp/wails/issues/1480): - -```go -func main() { - app := wails.NewApplication(options.App{}) - myWindow := app.NewWindow(options.Window{}) - myWindow.SetTitle("My Window") - myWindow.On(events.Window.Close, func() { - app.Quit() - }) - myWindow2 := app.NewWindow(options.Window{}) - myWindow2.SetTitle("My Window 2") - myWindow2.On(events.Window.Close, func() { - app.Quit() - }) - app.Run() -} -``` - -### Bindings generation - -One of the key features of Wails is generating bindings for your Go methods so they may be called from Javascript. The current method for doing this is a bit of a hack. It involves building the application with a special flag and then running the resultant binary which uses reflection to determine what has been bound. This leads to a bit of a chicken and egg situation: You can't build the application without the bindings and you can't generate the bindings without building the application. There are many ways around this but the best one would be not to use this approach at all. - -There was a number of attempts at writing a static analyser for Wails projects but they didn't get very far. In more recent times, it has become slightly easier to do this with more material available on the subject. - -Compared to reflection, the AST approach is much faster however it is significantly more complicated. To start with, we may need to impose certain constraints on how to specify bindings in the code. The goal is to support the most common use cases and then expand it later on. - -### The Build System - -Like the declarative approach to the API, the build system was created to hide the complexities of building a desktop application. When you run `wails build`, it does a lot of things behind the scenes: -- Builds the backend binary for bindings and generates the bindings -- Installs the frontend dependencies -- Builds the frontend assets -- Determines if the application icon is present and if so, embeds it -- Builds the final binary -- If the build is for `darwin/universal` it builds 2 binaries, one for `darwin/amd64` and one for `darwin/arm64` and then creates a fat binary using `lipo` -- If compression is required, it compresses the binary with UPX -- Determines if this binary is to be packaged and if so: - - Ensures the icon and application manifest are compiled into the binary (Windows) - - Builds out the application bundle, generates the icon bundle and copies it, the binary and Info.plist to the application bundle (Mac) -- If an NSIS installer is required, it builds it - -This entire process, whilst very powerful, is also very opaque. It is very difficult to customise it and it is very difficult to debug. - -To address this in v3, I would like to move to a build system that exists outside of Wails. After using [Task](https://taskfile.dev/) for a while, I am a big fan of it. It is a great tool for configuring build systems and should be reasonably familiar to anyone who has used Makefiles. - -The build system would be configured using a `Taskfile.yml` file which would be generated by default with any of the supported templates. This would have all of the steps required to do all the current tasks, such as building or packaging the application, allowing for easy customisation. - -There will be no external requirement for this tooling as it would form part of the Wails CLI. This means that you can still use `wails build` and it will do all the things it does today. However, if you want to customise the build process, you can do so by editing the `Taskfile.yml` file. It also means you can easily understand the build steps and use your own build system if you wish. - -The missing piece in the build puzzle is the atomic operations in the build process, such as icon generation, compression and packaging. To require a bunch of external tooling would not be a great experience for the developer. To address this, the Wails CLI will provide all these capabilities as part of the CLI. This means that the builds still work as expected, with no extra external tooling, however you can replace any step of the build with any tool you like. - -This will be a much more transparent build system which will allow for easier customisation and address a lot of the issues that have been raised around it. - -## The Payoff - -These positive changes will be a huge benefit to the project: -- The new API will be much more intuitive and will allow for more complex applications to be built. -- Using static analysis for bindings generation will be much faster and reduce a lot of the complexity around the current process. -- Using an established, external build system will make the build process completely transparent, allowing for powerful customisation. - -Benefits to the project maintainers are: - -- The new API will be much easier to maintain and adapt to new features and platforms. -- The new build system will be much easier to maintain and extend. I hope this will lead to a new ecosystem of community driven build pipelines. -- Better separation of concerns within the project. This will make it easier to add new features and platforms. - -## The Plan - -A lot of the experimentation for this has already been done and it's looking good. There is no current timeline for this work but I'm hoping by the end of Q1 2023, there will be an alpha release for Mac to allow the community to test, experiment with and provide feedback. - -## Summary - -- The v2 API is declarative, hides a lot from the developer and not suitable for features such as multiple windows. A new API will be created which will be simpler, intuitive and more powerful. -- The build system is opaque and difficult to customise so we will move to an external build system which will open it all up. -- The bindings generation is slow and complex so we will move to static analysis which will remove a lot of the complexity the current method has. - -There has been a lot of work put into the guts of v2 and it's solid. It's now time to address the layer on top of it and make it a much better experience for the developer. - -I hope you are as excited about this as I am. I'm looking forward to hearing your thoughts and feedback. - -Regards, - -‐ Lea - -PS: If you or your company find Wails useful, please consider [sponsoring the project](https://github.com/sponsors/leaanthony). Thanks! - -PPS: Yes, that's a genuine screenshot of a multi-window application built with Wails. It's not a mockup. It's real. It's awesome. It's coming soon. \ No newline at end of file diff --git a/website/i18n/de/docusaurus-plugin-content-blog/authors.yml b/website/i18n/de/docusaurus-plugin-content-blog/authors.yml deleted file mode 100644 index a1621fab6..000000000 --- a/website/i18n/de/docusaurus-plugin-content-blog/authors.yml +++ /dev/null @@ -1,10 +0,0 @@ -leaanthony: - name: Lea Anthony - title: Maintainer of Wails - url: https://github.com/leaanthony - image_url: https://github.com/leaanthony.png -misitebao: - name: Misite Bao - title: Architect - url: https://github.com/misitebao - image_url: https://github.com/misitebao.png diff --git a/website/i18n/de/docusaurus-plugin-content-blog/options.json b/website/i18n/de/docusaurus-plugin-content-blog/options.json deleted file mode 100644 index 9239ff706..000000000 --- a/website/i18n/de/docusaurus-plugin-content-blog/options.json +++ /dev/null @@ -1,14 +0,0 @@ -{ - "title": { - "message": "Blog", - "description": "The title for the blog used in SEO" - }, - "description": { - "message": "Blog", - "description": "The description for the blog used in SEO" - }, - "sidebar.title": { - "message": "Recent posts", - "description": "The label for the left sidebar" - } -} diff --git a/website/i18n/de/docusaurus-plugin-content-docs/current.json b/website/i18n/de/docusaurus-plugin-content-docs/current.json deleted file mode 100644 index b4e63124d..000000000 --- a/website/i18n/de/docusaurus-plugin-content-docs/current.json +++ /dev/null @@ -1,38 +0,0 @@ -{ - "version.label": { - "message": "Next Version 🚧", - "description": "The label for version current" - }, - "sidebar.docs.category.Getting Started": { - "message": "Getting Started", - "description": "The label for category Getting Started in sidebar docs" - }, - "sidebar.docs.category.Reference": { - "message": "Reference", - "description": "The label for category Reference in sidebar docs" - }, - "sidebar.docs.category.Runtime": { - "message": "Runtime", - "description": "The label for category Runtime in sidebar docs" - }, - "sidebar.docs.category.Community": { - "message": "Community", - "description": "The label for category Community in sidebar docs" - }, - "sidebar.docs.category.Showcase": { - "message": "Showcase", - "description": "The label for category Showcase in sidebar docs" - }, - "sidebar.docs.category.Guides": { - "message": "Guides", - "description": "The label for category Guides in sidebar docs" - }, - "sidebar.docs.category.Tutorials": { - "message": "Tutorials", - "description": "The label for category Tutorials in sidebar docs" - }, - "sidebar.docs.link.Contributing": { - "message": "Contributing", - "description": "The label for link Contributing in sidebar docs, linking to /community-guide#ways-of-contributing" - } -} diff --git a/website/i18n/de/docusaurus-plugin-content-docs/current/community/links.mdx b/website/i18n/de/docusaurus-plugin-content-docs/current/community/links.mdx deleted file mode 100644 index e36a6edfe..000000000 --- a/website/i18n/de/docusaurus-plugin-content-docs/current/community/links.mdx +++ /dev/null @@ -1,26 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Links - -This page serves as a list for community related links. Please submit a PR (click `Edit this page` at the bottom) to submit links. - -## Awesome Wails - -The [definitive list](https://github.com/wailsapp/awesome-wails) of links related to Wails. - -## Support Channels - -- [Wails Discord Server](https://discord.gg/JDdSxwjhGf) -- [Github Issues](https://github.com/wailsapp/wails/issues) -- [v2 Beta Discussion Board](https://github.com/wailsapp/wails/discussions/828) - -## Social Media - -- [Twitter](https://twitter.com/wailsapp) -- [Wails Chinese Community QQ Group](https://qm.qq.com/cgi-bin/qm/qr?k=PmIURne5hFGNd7QWzW5qd6FV-INEjNJv&jump_from=webapi) - Group number: 1067173054 - -## Other Tutorials and Articles - -- [Building of Bulletin Board](https://blog.customct.com/building-bulletin-board) diff --git a/website/i18n/de/docusaurus-plugin-content-docs/current/community/showcase/filehound.mdx b/website/i18n/de/docusaurus-plugin-content-docs/current/community/showcase/filehound.mdx deleted file mode 100644 index bc569c3fe..000000000 --- a/website/i18n/de/docusaurus-plugin-content-docs/current/community/showcase/filehound.mdx +++ /dev/null @@ -1,16 +0,0 @@ -# FileHound Export Utility - -```mdx-code-block -<p style={{ "text-align": "center" }}> - <img src={require("@site/static/img/showcase/filehound.webp").default} /> - <br /> -</p> -``` - -[FileHound Export Utility](https://www.filehound.co.uk/) FileHound is a cloud document management platform made for secure file retention, business process automation and SmartCapture capabilities. - -The FileHound Export Utility allows FileHound Administrators the ability to run a secure document and data extraction tasks for alternative back-up and recovery purposes. This application will download all documents and/or meta data saved in FileHound based on the filters you choose. The metadata will be exported in both JSON and XML formats. - -Backend built with: Go 1.15 Wails 1.11.0 go-sqlite3 1.14.6 go-linq 3.2 - -Frontend with: Vue 2.6.11 Vuex 3.4.0 TypeScript Tailwind 1.9.6 diff --git a/website/i18n/de/docusaurus-plugin-content-docs/current/community/showcase/grpcmd-gui.mdx b/website/i18n/de/docusaurus-plugin-content-docs/current/community/showcase/grpcmd-gui.mdx deleted file mode 100644 index 891350290..000000000 --- a/website/i18n/de/docusaurus-plugin-content-docs/current/community/showcase/grpcmd-gui.mdx +++ /dev/null @@ -1,10 +0,0 @@ -# grpcmd-gui - -```mdx-code-block -<p style={{ "text-align": "center" }}> - <img src={require("@site/static/img/showcase/grpcmd-gui.webp").default} /> - <br /> -</p> -``` - -[grpcmd-gui](https://grpc.md/gui) is a modern cross-platform desktop app and API client for gRPC development and testing. diff --git a/website/i18n/de/docusaurus-plugin-content-docs/current/community/showcase/hiposter.mdx b/website/i18n/de/docusaurus-plugin-content-docs/current/community/showcase/hiposter.mdx deleted file mode 100644 index 87e5837d3..000000000 --- a/website/i18n/de/docusaurus-plugin-content-docs/current/community/showcase/hiposter.mdx +++ /dev/null @@ -1,10 +0,0 @@ -# hiposter - -```mdx-code-block -<p style={{ "text-align": "center" }}> - <img src={require("@site/static/img/showcase/hiposter.webp").default} /> - <br /> -</p> -``` - -[hiposter](https://github.com/obity/hiposter) is a simple and efficient http API testing client tool. Based on Wails, Go and sveltejs. diff --git a/website/i18n/de/docusaurus-plugin-content-docs/current/community/showcase/kafka-king.mdx b/website/i18n/de/docusaurus-plugin-content-docs/current/community/showcase/kafka-king.mdx deleted file mode 100644 index 9876cd9a0..000000000 --- a/website/i18n/de/docusaurus-plugin-content-docs/current/community/showcase/kafka-king.mdx +++ /dev/null @@ -1,23 +0,0 @@ -# Kafka-King - -```mdx-code-block -<p style={{ "text-align": "center" }}> - <img src={require("@site/static/img/showcase/kafka-King-img_3.webp").default} /> - <br /> -</p> -``` - -[Kafka-King](https://github.com/Bronya0/Kafka-King) is a kafka GUI client that supports various systems and is compact and easy to use. -This is made of Wails+vue3 - -# Kafka-King function list - -- [x] View the cluster node list, support dynamic configuration of broker and topic configuration items -- [x] Supports consumer clients, consumes the specified topic, size, and timeout according to the specified group, and displays the message information in various dimensions in a table -- [x] Supports PLAIN, SSL, SASL, kerberos, sasl_plaintext, etc. etc. -- [x] Create topics (support batches), delete topics, specify replicas, partitions -- [x] Support statistics of the total number of messages, total number of submissions, and backlog for each topic based on consumer groups -- [x] Support viewing topics Detailed information (offset) of the partition, and support adding additional partitions -- [x] Support simulated producers, batch sending messages, specify headers, partitions -- [x] Health check -- [x] Support viewing consumer groups , Consumer- …… diff --git a/website/i18n/de/docusaurus-plugin-content-docs/current/community/showcase/minesweeper-xp.mdx b/website/i18n/de/docusaurus-plugin-content-docs/current/community/showcase/minesweeper-xp.mdx deleted file mode 100644 index f127a005f..000000000 --- a/website/i18n/de/docusaurus-plugin-content-docs/current/community/showcase/minesweeper-xp.mdx +++ /dev/null @@ -1,10 +0,0 @@ -# Minesweeper XP - -```mdx-code-block -<p style={{ "text-align": "center" }}> - <img src={require("@site/static/img/showcase/minesweeper-xp.webp").default} /> - <br /> -</p> -``` - -[Minesweeper-XP](https://git.new/Minesweeper-XP) allows you to experience the classic Minesweeper XP (+ 98 and 3.1) on macOS, Windows, and Linux! diff --git a/website/i18n/de/docusaurus-plugin-content-docs/current/community/showcase/resizem.mdx b/website/i18n/de/docusaurus-plugin-content-docs/current/community/showcase/resizem.mdx deleted file mode 100644 index 27f168f48..000000000 --- a/website/i18n/de/docusaurus-plugin-content-docs/current/community/showcase/resizem.mdx +++ /dev/null @@ -1,10 +0,0 @@ -# Resizem - -```mdx-code-block -<p style={{ "text-align": "center" }}> - <img src={require("@site/static/img/showcase/resizem.webp").default} /> - <br /> -</p> -``` - -[Resizem](https://github.com/barats/resizem) - is an app designed for bulk image process. It is particularly useful for users who need to resize, convert, and manage large numbers of image files at once. diff --git a/website/i18n/de/docusaurus-plugin-content-docs/current/community/showcase/wailsterm.mdx b/website/i18n/de/docusaurus-plugin-content-docs/current/community/showcase/wailsterm.mdx deleted file mode 100644 index 9924dace5..000000000 --- a/website/i18n/de/docusaurus-plugin-content-docs/current/community/showcase/wailsterm.mdx +++ /dev/null @@ -1,10 +0,0 @@ -# WailsTerm - -```mdx-code-block -<p style={{ "text-align": "center" }}> - <img src={require("@site/static/img/showcase/wailsterm.webp").default} /> - <br /> -</p> -``` - -[WailsTerm](https://github.com/rlshukhov/wailsterm) is a simple translucent terminal app powered by Wails and Xterm.js. diff --git a/website/i18n/de/docusaurus-plugin-content-docs/current/community/showcase/warmine.mdx b/website/i18n/de/docusaurus-plugin-content-docs/current/community/showcase/warmine.mdx deleted file mode 100644 index 950dc3f3d..000000000 --- a/website/i18n/de/docusaurus-plugin-content-docs/current/community/showcase/warmine.mdx +++ /dev/null @@ -1,19 +0,0 @@ -# Minecraft launcher for WarMine - -```mdx-code-block -<p style={{ "text-align": "center" }}> - <img - src={require("@site/static/img/showcase/warmine1.png").default} - /> - <img - src={require("@site/static/img/showcase/warmine2.png").default} - /> - <br /> -</p> -``` - -[Minecraft launcher for WarMine](https://warmine.ru/) is a Wails application, that allows you to easily join modded game servers and manage your game accounts. - -The Launcher downloads the game files, checks their integrity and launches the game with a wide range of customization options for the launch arguments from the backend. - -Frontend is written in Svelte, whole launcher fits in 9MB and supports Windows 7-11. diff --git a/website/i18n/de/docusaurus-plugin-content-docs/current/community/templates.mdx b/website/i18n/de/docusaurus-plugin-content-docs/current/community/templates.mdx deleted file mode 100644 index fb95b8ad9..000000000 --- a/website/i18n/de/docusaurus-plugin-content-docs/current/community/templates.mdx +++ /dev/null @@ -1,76 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Templates - -This page serves as a list for community supported templates. Please submit a PR (click `Edit this page` at the bottom) to include your templates. To build your own template, please see the [Templates](../guides/templates.mdx) guide. - -To use these templates, run `wails init -n "Your Project Name" -t [the link below[@version]]` - -If there is no version suffix, the main branch code template is used by default. If there is a version suffix, the code template corresponding to the tag of this version is used. - -Example: `wails init -n "Your Project Name" -t https://github.com/misitebao/wails-template-vue` - -:::warning Attention - -**The Wails project does not maintain, is not responsible nor liable for 3rd party templates!** - -If you are unsure about a template, inspect `package.json` and `wails.json` for what scripts are run and what packages are installed. - -::: - -## Vue - -- [wails-template-vue](https://github.com/misitebao/wails-template-vue) - Wails template based on Vue ecology (Integrated TypeScript, Dark theme, Internationalization, Single page routing, TailwindCSS) -- [wails-template-quasar-js](https://github.com/sgosiaco/wails-template-quasar-js) - A template using JavaScript + Quasar V2 (Vue 3, Vite, Sass, Pinia, ESLint, Prettier) -- [wails-template-quasar-ts](https://github.com/sgosiaco/wails-template-quasar-ts) - A template using TypeScript + Quasar V2 (Vue 3, Vite, Sass, Pinia, ESLint, Prettier, Composition API with <script setup>) -- [wails-template-naive](https://github.com/tk103331/wails-template-naive) - Wails template based on Naive UI (A Vue 3 Component Library) -- [wails-template-tdesign-js](https://github.com/tongque0/wails-template-tdesign-js) - Wails template based on TDesign UI (a Vue 3 UI library by Tencent), using Vite, Pinia, Vue Router, ESLint, and Prettier. - -## Angular - -- [wails-template-angular](https://github.com/mateothegreat/wails-template-angular) - Angular 15+ action packed & ready to roll to production. -- [wails-angular-template](https://github.com/TAINCER/wails-angular-template) - Angular with TypeScript, Sass, Hot-Reload, Code-Splitting and i18n - -## React - -- [wails-react-template](https://github.com/AlienRecall/wails-react-template) - A template using reactjs -- [wails-react-template](https://github.com/flin7/wails-react-template) - A minimal template for React that supports live development -- [wails-template-nextjs](https://github.com/LGiki/wails-template-nextjs) - A template using Next.js and TypeScript -- [wails-template-nextjs-app-router](https://github.com/thisisvk-in/wails-template-nextjs-app-router) - A template using Next.js and TypeScript with App router -- [wails-vite-react-ts-tailwind-template](https://github.com/hotafrika/wails-vite-react-ts-tailwind-template) - A template for React + TypeScript + Vite + TailwindCSS -- [wails-vite-react-ts-tailwind-shadcnui-template](https://github.com/Mahcks/wails-vite-react-tailwind-shadcnui-ts) - A template with Vite, React, TypeScript, TailwindCSS, and shadcn/ui -- [wails-nextjs-tailwind-template](https://github.com/kairo913/wails-nextjs-tailwind-template) - A template using Next.js and Typescript with TailwindCSS - -## Svelte - -- [wails-svelte-template](https://github.com/raitonoberu/wails-svelte-template) - A template using Svelte -- [wails-vite-svelte-template](https://github.com/BillBuilt/wails-vite-svelte-template) - A template using Svelte and Vite -- [wails-vite-svelte-ts-tailwind-template](https://github.com/xvertile/wails-vite-svelte-tailwind-template) - A template using Wails, Svelte, Vite, TypeScript, and TailwindCSS v3 -- [wails-vite-svelte-tailwind-template](https://github.com/BillBuilt/wails-vite-svelte-tailwind-template) - A template using Svelte and Vite with TailwindCSS v3 -- [wails-svelte-tailwind-vite-template](https://github.com/PylotLight/wails-vite-svelte-tailwind-template/tree/master) - An updated template using Svelte v4.2.0 and Vite with TailwindCSS v3.3.3 -- [wails-sveltekit-template](https://github.com/h8gi/wails-sveltekit-template) - A template using SvelteKit - -## Solid - -- [wails-template-vite-solid-ts](https://github.com/xijaja/wails-template-solid-ts) - A template using Solid + Ts + Vite -- [wails-template-vite-solid-js](https://github.com/xijaja/wails-template-solid-js) - A template using Solid + Js + Vite - -## Elm - -- [wails-elm-template](https://github.com/benjamin-thomas/wails-elm-template) - Develop your GUI app with functional programming and a **snappy** hot-reload setup :tada: :rocket: -- [wails-template-elm-tailwind](https://github.com/rnice01/wails-template-elm-tailwind) - Combine the powers :muscle: of Elm + Tailwind CSS + Wails! Hot reloading supported. - -## HTMX - -- [wails-htmx-templ-chi-tailwind](https://github.com/PylotLight/wails-hmtx-templ-template) - Use a unique combination of pure htmx for interactivity plus templ for creating components and forms - -## Pure JavaScript (Vanilla) - -- [wails-pure-js-template](https://github.com/KiddoV/wails-pure-js-template) - A template with nothing but just basic JavaScript, HTML, and CSS - - -## Lit (web components) - -- [wails-lit-shoelace-esbuild-template](https://github.com/Braincompiler/wails-lit-shoelace-esbuild-template) - Wails template providing frontend with lit, Shoelace component library + pre-configured prettier and typescript. diff --git a/website/i18n/de/docusaurus-plugin-content-docs/current/gettingstarted/building.mdx b/website/i18n/de/docusaurus-plugin-content-docs/current/gettingstarted/building.mdx deleted file mode 100644 index 6dbe1cfd0..000000000 --- a/website/i18n/de/docusaurus-plugin-content-docs/current/gettingstarted/building.mdx +++ /dev/null @@ -1,26 +0,0 @@ ---- -sidebar_position: 6 ---- - -# Compiling your Project - -From the project directory, run `wails build`. This will compile your project and save the production-ready binary in the `build/bin` directory. - -:::info Linux -If you are using a Linux distribution that does not have webkit2gtk-4.0 (such as Ubuntu 24.04), you will need to add `-tags webkit2_41`. -::: - -If you run the binary, you should see the default application: - -```mdx-code-block -<div class="text--center"> - <img - src={require("@site/static/img/defaultproject.webp").default} - width="50%" - class="screenshot" - /> -</div> -<br /> -``` - -For more details on compilation options, please refer to the [CLI Reference](../reference/cli.mdx#build). diff --git a/website/i18n/de/docusaurus-plugin-content-docs/current/gettingstarted/firstproject.mdx b/website/i18n/de/docusaurus-plugin-content-docs/current/gettingstarted/firstproject.mdx deleted file mode 100644 index e7cc86163..000000000 --- a/website/i18n/de/docusaurus-plugin-content-docs/current/gettingstarted/firstproject.mdx +++ /dev/null @@ -1,128 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Creating a Project - -## Project Generation - -Now that the CLI is installed, you can generate a new project by using the `wails init` command. - -Pick your favourite framework: - -```mdx-code-block -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; - -<Tabs - defaultValue="Svelte" - values={[ - {label: "Svelte", value: "Svelte"}, - {label: "React", value: "React"}, - {label: "Vue", value: "Vue"}, - {label: "Preact", value: "Preact"}, - {label: "Lit", value: "Lit"}, - {label: "Vanilla", value: "Vanilla"}, - ]} -> -<TabItem value="Svelte"> - Generate a <a href={"https://svelte.dev/"}>Svelte</a> project using JavaScript with:<br/><br/> - - wails init -n myproject -t svelte - -If you would rather use TypeScript:<br/> - - wails init -n myproject -t svelte-ts - -</TabItem> -<TabItem value="React"> - Generate a <a href={"https://reactjs.org/"}>React</a> project using JavaScript with:<br/><br/> - - wails init -n myproject -t react - -If you would rather use TypeScript:<br/> - - wails init -n myproject -t react-ts - -</TabItem> -<TabItem value="Vue"> - Generate a <a href={"https://vuejs.org/"}>Vue</a> project using JavaScript with:<br/><br/> - - wails init -n myproject -t vue - -If you would rather use TypeScript:<br/> - - wails init -n myproject -t vue-ts - -</TabItem> -<TabItem value="Preact"> - Generate a <a href={"https://preactjs.com/"}>Preact</a> project using JavaScript with:<br/><br/> - - wails init -n myproject -t preact - -If you would rather use TypeScript:<br/> - - wails init -n myproject -t preact-ts - -</TabItem> -<TabItem value="Lit"> - Generate a <a href={"https://lit.dev/"}>Lit</a> project using JavaScript with:<br/><br/> - - wails init -n myproject -t lit - -If you would rather use TypeScript:<br/> - - wails init -n myproject -t lit-ts - -</TabItem> -<TabItem value="Vanilla"> - Generate a Vanilla project using JavaScript with:<br/><br/> - - wails init -n myproject -t vanilla - -If you would rather use TypeScript:<br/> - - wails init -n myproject -t vanilla-ts - -</TabItem> -</Tabs> -``` - -<hr /> - -There are also [community templates](../community/templates.mdx) available that offer different capabilities and frameworks. - -To see the other options available, you can run `wails init -help`. More details can be found in the [CLI Reference](../reference/cli.mdx#init). - -## Project Layout - -Wails projects have the following layout: - -``` -. -├── build/ -│ ├── appicon.png -│ ├── darwin/ -│ └── windows/ -├── frontend/ -├── go.mod -├── go.sum -├── main.go -└── wails.json -``` - -### Project structure rundown - -- `/main.go` - The main application -- `/frontend/` - Frontend project files -- `/build/` - Project build directory -- `/build/appicon.png` - The application icon -- `/build/darwin/` - Mac specific project files -- `/build/windows/` - Windows specific project files -- `/wails.json` - The project configuration -- `/go.mod` - Go module file -- `/go.sum` - Go module checksum file - -The `frontend` directory has nothing specific to Wails and can be any frontend project of your choosing. - -The `build` directory is used during the build process. These files may be updated to customise your builds. If files are removed from the build directory, default versions will be regenerated. diff --git a/website/i18n/de/docusaurus-plugin-content-docs/current/gettingstarted/installation.mdx b/website/i18n/de/docusaurus-plugin-content-docs/current/gettingstarted/installation.mdx deleted file mode 100644 index 028b167da..000000000 --- a/website/i18n/de/docusaurus-plugin-content-docs/current/gettingstarted/installation.mdx +++ /dev/null @@ -1,92 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Installation - -## Supported Platforms - -- Windows 10/11 AMD64/ARM64 -- MacOS 10.15+ AMD64 for development, MacOS 10.13+ for release -- MacOS 11.0+ ARM64 -- Linux AMD64/ARM64 - -## Dependencies - -Wails has a number of common dependencies that are required before installation: - -- Go 1.21+ (macOS 15+ requires Go 1.23.3+) -- NPM (Node 15+) - -### Go - -Download Go from the [Go Downloads Page](https://go.dev/dl/). - -Ensure that you follow the official [Go installation instructions](https://go.dev/doc/install). You will also need to ensure that your `PATH` environment variable also includes the path to your `~/go/bin` directory. Restart your terminal and do the following checks: - -- Check Go is installed correctly: `go version` -- Check "~/go/bin" is in your PATH variable: `echo $PATH | grep go/bin` - -### NPM - -Download NPM from the [Node Downloads Page](https://nodejs.org/en/download/). It is best to use the latest release as that is what we generally test against. - -Run `npm --version` to verify. - -## Platform Specific Dependencies - -You will also need to install platform specific dependencies: - -```mdx-code-block -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; - -<Tabs - defaultValue="Windows" - values={[ - { label: "Windows", value: "Windows" }, - { label: "MacOS", value: "MacOS" }, - { label: "Linux", value: "Linux" }, - ]} -> - <TabItem value="MacOS"> - Wails requires that the xcode command line tools are installed. This can be - done by running <code>xcode-select --install</code>. - </TabItem> - <TabItem value="Windows"> - Wails requires that the <a href="https://developer.microsoft.com/en-us/microsoft-edge/webview2/">WebView2</a> runtime is installed. Some Windows installations will already have this installed. You can check using the <code>wails doctor</code> command. - </TabItem> - <TabItem value={"Linux"}> - Linux requires the standard <code>gcc</code> build tools plus <code>libgtk3</code> and <code>libwebkit</code>. Rather than list a ton of commands for different distros, Wails can try to determine what the installation commands are for your specific distribution. Run <code>wails doctor</code> after installation to be shown how to install the dependencies. If your distro/package manager is not supported, please consult the <a href={"/docs/guides/linux-distro-support"}>Add Linux Distro</a> guide. - <br/><strong>Note:</strong><br/> - If you are using latest Linux version (example: Ubuntu 24.04) and it is not supporting <code>libwebkit2gtk-4.0-dev</code>, then you might encounter an issue in <code>wails doctor</code>: <code>libwebkit</code> not found. To resolve this issue you can install <code>libwebkit2gtk-4.1-dev</code> and during your build use the tag <code>-tags webkit2_41</code>. - </TabItem> -</Tabs> -``` - -## Optional Dependencies - -- [UPX](https://upx.github.io/) for compressing your applications. -- [NSIS](https://wails.io/docs/guides/windows-installer/) for generating Windows installers. - -## Installing Wails - -Run `go install github.com/wailsapp/wails/v2/cmd/wails@latest` to install the Wails CLI. - -Note: If you get an error similar to this: - -```shell -....\Go\pkg\mod\github.com\wailsapp\wails\v2@v2.1.0\pkg\templates\templates.go:28:12: pattern all:ides/*: no matching files found -``` -please check you have Go 1.18+ installed: -```shell -go version -``` - -## System Check - -Running `wails doctor` will check if you have the correct dependencies installed. If not, it will advise on what is missing and help on how to rectify any problems. - -## The `wails` command appears to be missing? - -If your system is reporting that the `wails` command is missing, make sure you have followed the Go installation guide correctly. Normally, it means that the `go/bin` directory in your User's home directory is not in the `PATH` environment variable. You will also normally need to close and reopen any open command prompts so that changes to the environment made by the installer are reflected at the command prompt. diff --git a/website/i18n/de/docusaurus-plugin-content-docs/current/guides/angular.mdx b/website/i18n/de/docusaurus-plugin-content-docs/current/guides/angular.mdx deleted file mode 100644 index 2b6c5a845..000000000 --- a/website/i18n/de/docusaurus-plugin-content-docs/current/guides/angular.mdx +++ /dev/null @@ -1,14 +0,0 @@ -# Angular - -Whilst Wails does not have an Angular template, it is possible to use Angular with Wails. - -## Dev Mode - -To get dev mode working with Angular, you need to add the following to your `wails.json`: - -```json - "frontend:build": "npx ng build", - "frontend:install": "npm install", - "frontend:dev:watcher": "npx ng serve", - "frontend:dev:serverUrl": "http://localhost:4200", -``` \ No newline at end of file diff --git a/website/i18n/de/docusaurus-plugin-content-docs/current/guides/application-development.mdx b/website/i18n/de/docusaurus-plugin-content-docs/current/guides/application-development.mdx deleted file mode 100644 index 687b89791..000000000 --- a/website/i18n/de/docusaurus-plugin-content-docs/current/guides/application-development.mdx +++ /dev/null @@ -1,273 +0,0 @@ -# Application Development - -There are no hard and fast rules for developing applications with Wails, but there are some basic guidelines. - -## Application Setup - -The pattern used by the default templates are that `main.go` is used for configuring and running the application, whilst `app.go` is used for defining the application logic. - -The `app.go` file will define a struct that has 2 methods which act as hooks into the main application: - -```go title="app.go" -type App struct { - ctx context.Context -} - -func NewApp() *App { - return &App{} -} - -func (a *App) startup(ctx context.Context) { - a.ctx = ctx -} - -func (a *App) shutdown(ctx context.Context) { -} -``` - -- The startup method is called as soon as Wails allocates the resources it needs and is a good place for creating resources, setting up event listeners and anything else the application needs at startup. It is given a `context.Context` which is usually saved in a struct field. This context is needed for calling the [runtime](../reference/runtime/intro.mdx). If this method returns an error, the application will terminate. In dev mode, the error will be output to the console. - -- The shutdown method will be called by Wails right at the end of the shutdown process. This is a good place to deallocate memory and perform any shutdown tasks. - -The `main.go` file generally consists of a single call to `wails.Run()`, which accepts the application configuration. The pattern used by the templates is that before the call to `wails.Run()`, an instance of the struct we defined in `app.go` is created and saved in a variable called `app`. This configuration is where we add our callbacks: - -```go {3,9,10} title="main.go" -func main() { - - app := NewApp() - - err := wails.Run(&options.App{ - Title: "My App", - Width: 800, - Height: 600, - OnStartup: app.startup, - OnShutdown: app.shutdown, - }) - if err != nil { - log.Fatal(err) - } -} - -``` - -More information on application lifecycle hooks can be found [here](../howdoesitwork.mdx#application-lifecycle-callbacks). - -## Binding Methods - -It is likely that you will want to call Go methods from the frontend. This is normally done by adding public methods to the already defined struct in `app.go`: - -```go {16-18} title="app.go" -type App struct { - ctx context.Context -} - -func NewApp() *App { - return &App{} -} - -func (a *App) startup(ctx context.Context) { - a.ctx = ctx -} - -func (a *App) shutdown(ctx context.Context) { -} - -func (a *App) Greet(name string) string { - return fmt.Sprintf("Hello %s!", name) -} -``` - -In the main application configuration, the `Bind` key is where we can tell Wails what we want to bind: - -```go {11-13} title="main.go" -func main() { - - app := NewApp() - - err := wails.Run(&options.App{ - Title: "My App", - Width: 800, - Height: 600, - OnStartup: app.startup, - OnShutdown: app.shutdown, - Bind: []interface{}{ - app, - }, - }) - if err != nil { - log.Fatal(err) - } -} - -``` - -This will bind all public methods in our `App` struct (it will never bind the startup and shutdown methods). - -### Dealing with context when binding multiple structs - -If you want to bind methods for multiple structs but want each struct to keep a reference to the context so that you can use the runtime functions, a good pattern is to pass the context from the `OnStartup` method to your struct instances : - -```go -func main() { - - app := NewApp() - otherStruct := NewOtherStruct() - - err := wails.Run(&options.App{ - Title: "My App", - Width: 800, - Height: 600, - OnStartup: func(ctx context.Context){ - app.SetContext(ctx) - otherStruct.SetContext(ctx) - }, - OnShutdown: app.shutdown, - Bind: []interface{}{ - app, - otherStruct - }, - }) - if err != nil { - log.Fatal(err) - } -} -``` - -Also you might want to use Enums in your structs and have models for them on frontend. In that case you should create array that will contain all possible enum values, instrument enum type and bind it to the app: - -```go {16-18} title="app.go" -type Weekday string - -const ( - Sunday Weekday = "Sunday" - Monday Weekday = "Monday" - Tuesday Weekday = "Tuesday" - Wednesday Weekday = "Wednesday" - Thursday Weekday = "Thursday" - Friday Weekday = "Friday" - Saturday Weekday = "Saturday" -) - -var AllWeekdays = []struct { - Value Weekday - TSName string -}{ - {Sunday, "SUNDAY"}, - {Monday, "MONDAY"}, - {Tuesday, "TUESDAY"}, - {Wednesday, "WEDNESDAY"}, - {Thursday, "THURSDAY"}, - {Friday, "FRIDAY"}, - {Saturday, "SATURDAY"}, -} -``` - -In the main application configuration, the `EnumBind` key is where we can tell Wails what we want to bind enums as well: - -```go {11-13} title="main.go" -func main() { - - app := NewApp() - - err := wails.Run(&options.App{ - Title: "My App", - Width: 800, - Height: 600, - OnStartup: app.startup, - OnShutdown: app.shutdown, - Bind: []interface{}{ - app, - }, - EnumBind: []interface{}{ - AllWeekdays, - }, - }) - if err != nil { - log.Fatal(err) - } -} - -``` - -This will add missing enums to your `model.ts` file. - -More information on Binding can be found [here](../howdoesitwork.mdx#method-binding). - -## Application Menu - -Wails supports adding a menu to your application. This is done by passing a [Menu](../reference/menus.mdx#menu) struct to application config. It's common to use a method that returns a Menu, and even more common for that to be a method on the `App` struct used for the lifecycle hooks. - -```go {11} title="main.go" -func main() { - - app := NewApp() - - err := wails.Run(&options.App{ - Title: "My App", - Width: 800, - Height: 600, - OnStartup: app.startup, - OnShutdown: app.shutdown, - Menu: app.menu(), - Bind: []interface{}{ - app, - }, - }) - if err != nil { - log.Fatal(err) - } -} - -``` - -## Assets - -The great thing about the way Wails v2 handles assets is that it doesn't! The only thing you need to give Wails is an `embed.FS`. How you get to that is entirely up to you. You can use vanilla html/css/js files like the vanilla template. You could have some complicated build system, it doesn't matter. - -When `wails build` is run, it will check the `wails.json` project file at the project root. There are 2 keys in the project file that are read: - -- "frontend:install" -- "frontend:build" - -The first, if given, will be executed in the `frontend` directory to install the node modules. The second, if given, will be executed in the `frontend` directory to build the frontend project. - -If these 2 keys aren't given, then Wails does absolutely nothing with the frontend. It is only expecting that `embed.FS`. - -### AssetsHandler - -A Wails v2 app can optionally define a `http.Handler` in the `options.App`, which allows hooking into the AssetServer to create files on the fly or process POST/PUT requests. GET requests are always first handled by the `assets` FS. If the FS doesn't find the requested file the request will be forwarded to the `http.Handler` for serving. Any requests other than GET will be directly processed by the `AssetsHandler` if specified. It's also possible to only use the `AssetsHandler` by specifying `nil` as the `Assets` option. - -## Built in Dev Server - -Running `wails dev` will start the built in dev server which will start a file watcher in your project directory. By default, if any file changes, wails checks if it was an application file (default: `.go`, configurable with `-e` flag). If it was, then it will rebuild your application and relaunch it. If the changed file was in the assets, it will issue a reload after a short amount of time. - -The dev server uses a technique called "debouncing" which means it doesn't reload straight away, as there may be multiple files changed in a short amount of time. When a trigger occurs, it waits for a set amount of time before issuing a reload. If another trigger happens, it resets to the wait time again. By default this value is `100ms`. If this value doesn't work for your project, it can be configured using the `-debounce` flag. If used, this value will be saved to your project config and become the default. - -## External Dev Server - -Some frameworks come with their own live-reloading server, however they will not be able to take advantage of the Wails Go bindings. In this scenario, it is best to run a watcher script that rebuilds the project into the build directory, which Wails will be watching. For an example, see the default svelte template that uses [rollup](https://rollupjs.org/guide/en/). - -### Create React App - -The process for a Create-React-App project is slightly more complicated. In order to support live frontend reloading the following configuration needs to be added to your `wails.json`: - -```json - "frontend:dev:watcher": "yarn start", - "frontend:dev:serverUrl": "http://localhost:3000", -``` - -The `frontend:dev:watcher` command will start the Create-React-App development server (hosted on port `3000` typically). The `frontend:dev:serverUrl` command then instructs Wails to serve assets from the development server when loading the frontend rather than from the build folder. In addition to the above, the `index.html` needs to be updated with the following: - -```html - <head> - <meta name="wails-options" content="noautoinject" /> - <script src="/wails/ipc.js"></script> - <script src="/wails/runtime.js"></script> - </head> -``` - -This is required as the watcher command that rebuilds the frontend prevents Wails from injecting the required scripts. This circumvents that issue by ensuring the scripts are always injected. With this configuration, `wails dev` can be run which will appropriately build the frontend and backend with hot-reloading enabled. Additionally, when accessing the application from a browser the React developer tools can now be used on a non-minified version of the application for straightforward debugging. Finally, for faster builds, `wails dev -s` can be run to skip the default building of the frontend by Wails as this is an unnecessary step. - -## Go Module - -The default Wails templates generate a `go.mod` file that contains the module name "changeme". You should change this to something more appropriate after project generation. diff --git a/website/i18n/de/docusaurus-plugin-content-docs/current/guides/crossplatform-build.mdx b/website/i18n/de/docusaurus-plugin-content-docs/current/guides/crossplatform-build.mdx deleted file mode 100644 index e7ea6dfc8..000000000 --- a/website/i18n/de/docusaurus-plugin-content-docs/current/guides/crossplatform-build.mdx +++ /dev/null @@ -1,66 +0,0 @@ -# Crossplatform build with Github Actions - -To build a Wails project for all the available platforms, you need to create an application build for each operating system. One effective method to achieve this is by utilizing GitHub Actions. - -An action that facilitates building a Wails app is available at: -https://github.com/dAppServer/wails-build-action - -In case the existing action doesn't fulfill your requirements, you can select only the necessary steps from the source: -https://github.com/dAppServer/wails-build-action/blob/main/action.yml - -Below is a comprehensive example that demonstrates building an app upon the creation of a new Git tag and subsequently uploading it to the Actions artifacts: - -```yaml -name: Wails build - -on: - push: - tags: - # Match any new tag - - '*' - -env: - # Necessary for most environments as build failure can occur due to OOM issues - NODE_OPTIONS: "--max-old-space-size=4096" - -jobs: - build: - strategy: - # Failure in one platform build won't impact the others - fail-fast: false - matrix: - build: - - name: 'App' - platform: 'linux/amd64' - os: 'ubuntu-latest' - - name: 'App' - platform: 'windows/amd64' - os: 'windows-latest' - - name: 'App' - platform: 'darwin/universal' - os: 'macos-latest' - - runs-on: ${{ matrix.build.os }} - steps: - - name: Checkout - uses: actions/checkout@v2 - with: - submodules: recursive - - - name: Build wails - uses: dAppServer/wails-build-action@v2.2 - id: build - with: - build-name: ${{ matrix.build.name }} - build-platform: ${{ matrix.build.platform }} - package: false - go-version: '1.20' -``` - -This example offers opportunities for various enhancements, including: - -- Caching dependencies -- Code signing -- Uploading to platforms like S3, Supabase, etc. -- Injecting secrets as environment variables -- Utilizing environment variables as build variables (such as version variable extracted from the current Git tag) diff --git a/website/i18n/de/docusaurus-plugin-content-docs/current/guides/custom-protocol-schemes.mdx b/website/i18n/de/docusaurus-plugin-content-docs/current/guides/custom-protocol-schemes.mdx deleted file mode 100644 index 3dccf4e3c..000000000 --- a/website/i18n/de/docusaurus-plugin-content-docs/current/guides/custom-protocol-schemes.mdx +++ /dev/null @@ -1,204 +0,0 @@ -# Custom Protocol Scheme association - -Custom Protocols feature allows you to associate specific custom protocol with your app so that when users open links with this protocol, -your app is launched to handle them. This can be particularly useful to connect your desktop app with your web app. -In this guide, we'll walk through the steps to implement custom protocols in Wails app. - -## Set Up Custom Protocol Schemes Association: - -To set up custom protocol, you need to modify your application's wails.json file. -In "info" section add a "protocols" section specifying the protocols your app should be associated with. - -For example: - -```json -{ - "info": { - "protocols": [ - { - "scheme": "myapp", - "description": "My App Protocol", - "role": "Editor" - } - ] - } -} -``` - -| Property | Description | -| :---------- | :------------------------------------------------------------------------------------ | -| scheme | Custom Protocol scheme. e.g. myapp | -| description | Windows-only. The description. | -| role | macOS-only. The app’s role with respect to the type. Corresponds to CFBundleTypeRole. | - -## Platform Specifics: - -### macOS - -When you open custom protocol with your app, the system will launch your app and call the `OnUrlOpen` function in your Wails app. Example: - -```go title="main.go" -func main() { - // Create application with options - err := wails.Run(&options.App{ - Title: "wails-open-file", - Width: 1024, - Height: 768, - AssetServer: &assetserver.Options{ - Assets: assets, - }, - BackgroundColour: &options.RGBA{R: 27, G: 38, B: 54, A: 1}, - Mac: &mac.Options{ - OnUrlOpen: func(url string) { println(url) }, - }, - Bind: []interface{}{ - app, - }, - }) - - if err != nil { - println("Error:", err.Error()) - } -} -``` - -### Windows - -On Windows Custom Protocol Schemes is supported only with NSIS installer. During installation, the installer will create a -registry entry for your schemes. When you open url with your app, new instance of app is launched and url is passed -as argument to your app. To handle this you should parse command line arguments in your app. Example: - -```go title="main.go" -func main() { - argsWithoutProg := os.Args[1:] - - if len(argsWithoutProg) != 0 { - println("launchArgs", argsWithoutProg) - } -} -``` - -You also can enable single instance lock for your app. In this case, when you open url with your app, new instance of app is not launched -and arguments are passed to already running instance. Check single instance lock guide for details. Example: - -```go title="main.go" -func main() { - // Create application with options - err := wails.Run(&options.App{ - Title: "wails-open-file", - Width: 1024, - Height: 768, - AssetServer: &assetserver.Options{ - Assets: assets, - }, - BackgroundColour: &options.RGBA{R: 27, G: 38, B: 54, A: 1}, - SingleInstanceLock: &options.SingleInstanceLock{ - UniqueId: "e3984e08-28dc-4e3d-b70a-45e961589cdc", - OnSecondInstanceLaunch: app.onSecondInstanceLaunch, - }, - Bind: []interface{}{ - app, - }, - }) -} -``` - -### Linux - -Currently, Wails doesn't support bundling for Linux. So, you need to create file associations manually. -For example if you distribute your app as a .deb package, you can create file associations by adding required files in you bundle. -You can use [nfpm](https://nfpm.goreleaser.com/) to create .deb package for your app. - -1. Create a .desktop file for your app and specify file associations there (note that `%u` is important in Exec). Example: - -```ini -[Desktop Entry] -Categories=Office -Exec=/usr/bin/wails-open-file %u -Icon=wails-open-file.png -Name=wails-open-file -Terminal=false -Type=Application -MimeType=x-scheme-handler/myapp; -``` - -2. Prepare postInstall/postRemove scripts for your package. Example: - -```sh -# reload desktop database to load app in list of available -update-desktop-database /usr/share/applications -``` - -3. Configure nfpm to use your scripts and files. Example: - -```yaml -name: "wails-open-file" -arch: "arm64" -platform: "linux" -version: "1.0.0" -section: "default" -priority: "extra" -maintainer: "FooBarCorp <FooBarCorp@gmail.com>" -description: "Sample Package" -vendor: "FooBarCorp" -homepage: "http://example.com" -license: "MIT" -contents: -- src: ../bin/wails-open-file - dst: /usr/bin/wails-open-file -- src: ./main.desktop - dst: /usr/share/applications/wails-open-file.desktop -- src: ../appicon.svg - dst: /usr/share/icons/hicolor/scalable/apps/wails-open-file.svg -# copy icons to Yaru theme as well. For some reason Ubuntu didn't pick up fileicons from hicolor theme -- src: ../appicon.svg - dst: /usr/share/icons/Yaru/scalable/apps/wails-open-file.svg -scripts: - postinstall: ./postInstall.sh - postremove: ./postRemove.sh -``` - -6. Build your .deb package using nfpm: - -```sh -nfpm pkg --packager deb --target . -``` - -7. Now when your package is installed, your app will be associated with custom protocol scheme. When you open url with your app, - new instance of app is launched and file path is passed as argument to your app. - To handle this you should parse command line arguments in your app. Example: - -```go title="main.go" -func main() { - argsWithoutProg := os.Args[1:] - - if len(argsWithoutProg) != 0 { - println("launchArgs", argsWithoutProg) - } -} -``` - -You also can enable single instance lock for your app. In this case, when you open url with your app, new instance of app is not launched -and arguments are passed to already running instance. Check single instance lock guide for details. Example: - -```go title="main.go" -func main() { - // Create application with options - err := wails.Run(&options.App{ - Title: "wails-open-file", - Width: 1024, - Height: 768, - AssetServer: &assetserver.Options{ - Assets: assets, - }, - BackgroundColour: &options.RGBA{R: 27, G: 38, B: 54, A: 1}, - SingleInstanceLock: &options.SingleInstanceLock{ - UniqueId: "e3984e08-28dc-4e3d-b70a-45e961589cdc", - OnSecondInstanceLaunch: app.onSecondInstanceLaunch, - }, - Bind: []interface{}{ - app, - }, - }) -} -``` diff --git a/website/i18n/de/docusaurus-plugin-content-docs/current/guides/dynamic-assets.mdx b/website/i18n/de/docusaurus-plugin-content-docs/current/guides/dynamic-assets.mdx deleted file mode 100644 index 242276641..000000000 --- a/website/i18n/de/docusaurus-plugin-content-docs/current/guides/dynamic-assets.mdx +++ /dev/null @@ -1,142 +0,0 @@ -# Dynamic Assets - -:::info - -This does not work with vite v5.0.0+ and wails v2 due to changes in vite. Changes are planned in v3 to support similar functionality under vite v5.0.0+. If you need this feature, stay with vite v4.0.0+. See [issue 3240](https://github.com/wailsapp/wails/issues/3240) for details - -::: - -If you want to load or generate assets for your frontend dynamically, you can achieve that using the [AssetsHandler](../reference/options#assetshandler) option. The AssetsHandler is a generic `http.Handler` which will be called for any non GET request on the assets server and for GET requests which can not be served from the bundled assets because the file is not found. - -By installing a custom AssetsHandler, you can serve your own assets using a custom asset server. - -## Example - -In our example project, we will create a simple assets handler which will load files off disk: - -```go title=main.go {17-36,49} -package main - -import ( - "embed" - "fmt" - "github.com/wailsapp/wails/v2" - "github.com/wailsapp/wails/v2/pkg/options" - "github.com/wailsapp/wails/v2/pkg/options/assetserver" - "net/http" - "os" - "strings" -) - -//go:embed all:frontend/dist -var assets embed.FS - -type FileLoader struct { - http.Handler -} - -func NewFileLoader() *FileLoader { - return &FileLoader{} -} - -func (h *FileLoader) ServeHTTP(res http.ResponseWriter, req *http.Request) { - var err error - requestedFilename := strings.TrimPrefix(req.URL.Path, "/") - println("Requesting file:", requestedFilename) - fileData, err := os.ReadFile(requestedFilename) - if err != nil { - res.WriteHeader(http.StatusBadRequest) - res.Write([]byte(fmt.Sprintf("Could not load file %s", requestedFilename))) - } - - res.Write(fileData) -} - -func main() { - // Create an instance of the app structure - app := NewApp() - - // Create application with options - err := wails.Run(&options.App{ - Title: "helloworld", - Width: 1024, - Height: 768, - AssetServer: &assetserver.Options{ - Assets: assets, - Handler: NewFileLoader(), - }, - BackgroundColour: &options.RGBA{R: 27, G: 38, B: 54, A: 255}, - OnStartup: app.startup, - Bind: []interface{}{ - app, - }, - }) - - if err != nil { - println("Error:", err) - } -} -``` - -When we run the application in dev mode using `wails dev`, we will see the following output: - -``` -DEB | [ExternalAssetHandler] Loading 'http://localhost:3001/favicon.ico' -DEB | [ExternalAssetHandler] Loading 'http://localhost:3001/favicon.ico' failed, using AssetHandler -Requesting file: favicon.ico -``` - -As you can see, the assets handler is called when the default assets server is unable to serve the `favicon.ico` file. - -If you right click the main application and select "inspect" to bring up the devtools, you can test this feature out by typing the following into the console: - -``` -let response = await fetch('does-not-exist.txt'); -``` - -This will generate an error in the devtools. We can see that the error is what we expect, returned by our custom assets handler: - -```mdx-code-block -<p className="text--center"> - <img - src={require("@site/static/img/assetshandler-does-not-exist.webp").default} - /> -</p> -``` - -However, if we request `go.mod`, we will see the following output: - -```mdx-code-block -<p className="text--center"> - <img src={require("@site/static/img/assetshandler-go-mod.webp").default} /> -</p> -``` - -This technique can be used to load images directly into the page. If we updated our default vanilla template and replaced the logo image: - -```html -<img id="logo" class="logo" /> -``` - -with: - -```html -<img src="build/appicon.png" style="width: 300px" /> -``` - -Then we would see the following: - -```mdx-code-block -<p className="text--center"> - <img - src={require("@site/static/img/assetshandler-image.webp").default} - style={{ width: "75%" }} - /> -</p> -``` - -:::warning - -Exposing your filesystem in this way is a security risk. It is recommended that you properly manage access to your filesystem. - -::: diff --git a/website/i18n/de/docusaurus-plugin-content-docs/current/guides/file-association.mdx b/website/i18n/de/docusaurus-plugin-content-docs/current/guides/file-association.mdx deleted file mode 100644 index 15c6bbfcf..000000000 --- a/website/i18n/de/docusaurus-plugin-content-docs/current/guides/file-association.mdx +++ /dev/null @@ -1,244 +0,0 @@ -# File Association - -File association feature allows you to associate specific file types with your app so that when users open those files, -your app is launched to handle them. This can be particularly useful for text editors, image viewers, or any application -that works with specific file formats. In this guide, we'll walk through the steps to implement file association in Wails app. - -## Set Up File Association: - -To set up file association, you need to modify your application's wails.json file. -In "info" section add a "fileAssociations" section specifying the file types your app should be associated with. - -For example: - -```json -{ - "info": { - "fileAssociations": [ - { - "ext": "wails", - "name": "Wails", - "description": "Wails Application File", - "iconName": "wailsFileIcon", - "role": "Editor" - }, - { - "ext": "jpg", - "name": "JPEG", - "description": "Image File", - "iconName": "jpegFileIcon", - "role": "Editor" - } - ] - } -} -``` - -| Property | Description | -| :---------- | :------------------------------------------------------------------------------------------------------------------------------------------------- | -| ext | The extension (minus the leading period). e.g. png | -| name | The name. e.g. PNG File | -| iconName | The icon name without extension. Icons should be located in build folder. Proper icons will be generated from .png file for both macOS and Windows | -| description | Windows-only. The description. It is displayed on the `Type` column on Windows Explorer. | -| role | macOS-only. The app’s role with respect to the type. Corresponds to CFBundleTypeRole. | - -## Platform Specifics: - -### macOS - -When you open file (or files) with your app, the system will launch your app and call the `OnFileOpen` function in your Wails app. Example: - -```go title="main.go" -func main() { - // Create application with options - err := wails.Run(&options.App{ - Title: "wails-open-file", - Width: 1024, - Height: 768, - AssetServer: &assetserver.Options{ - Assets: assets, - }, - BackgroundColour: &options.RGBA{R: 27, G: 38, B: 54, A: 1}, - Mac: &mac.Options{ - OnFileOpen: func(filePaths []string) { println(filestring) }, - }, - Bind: []interface{}{ - app, - }, - }) - - if err != nil { - println("Error:", err.Error()) - } -} -``` - -### Windows - -On Windows file association is supported only with NSIS installer. During installation, the installer will create a -registry entry for your file associations. When you open file with your app, new instance of app is launched and file path is passed -as argument to your app. To handle this you should parse command line arguments in your app. Example: - -```go title="main.go" -func main() { - argsWithoutProg := os.Args[1:] - - if len(argsWithoutProg) != 0 { - println("launchArgs", argsWithoutProg) - } -} -``` - -You also can enable single instance lock for your app. In this case, when you open file with your app, new instance of app is not launched -and arguments are passed to already running instance. Check single instance lock guide for details. Example: - -```go title="main.go" -func main() { - // Create application with options - err := wails.Run(&options.App{ - Title: "wails-open-file", - Width: 1024, - Height: 768, - AssetServer: &assetserver.Options{ - Assets: assets, - }, - BackgroundColour: &options.RGBA{R: 27, G: 38, B: 54, A: 1}, - SingleInstanceLock: &options.SingleInstanceLock{ - UniqueId: "e3984e08-28dc-4e3d-b70a-45e961589cdc", - OnSecondInstanceLaunch: app.onSecondInstanceLaunch, - }, - Bind: []interface{}{ - app, - }, - }) -} -``` - -### Linux - -Currently, Wails doesn't support bundling for Linux. So, you need to create file associations manually. -For example if you distribute your app as a .deb package, you can create file associations by adding required files in you bundle. -You can use [nfpm](https://nfpm.goreleaser.com/) to create .deb package for your app. - -1. Create a .desktop file for your app and specify file associations there. Example: - -```ini -[Desktop Entry] -Categories=Office -Exec=/usr/bin/wails-open-file %u -Icon=wails-open-file.png -Name=wails-open-file -Terminal=false -Type=Application -MimeType=application/x-wails;application/x-test -``` - -2. Create mime types file. Example: - -```xml -<?xml version="1.0" encoding="UTF-8"?> -<mime-info xmlns="http://www.freedesktop.org/standards/shared-mime-info"> - <mime-type type="application/x-wails"> - <comment>Wails Application File</comment> - <glob pattern="*.wails"/> - </mime-type> -</mime-info> -``` - -3. Create icons for your file types. SVG icons are recommended. -4. Prepare postInstall/postRemove scripts for your package. Example: - -```sh -# reload mime types to register file associations -update-mime-database /usr/share/mime -# reload desktop database to load app in list of available -update-desktop-database /usr/share/applications -# update icons -update-icon-caches /usr/share/icons/* -``` - -5. Configure nfpm to use your scripts and files. Example: - -```yaml -name: "wails-open-file" -arch: "arm64" -platform: "linux" -version: "1.0.0" -section: "default" -priority: "extra" -maintainer: "FooBarCorp <FooBarCorp@gmail.com>" -description: "Sample Package" -vendor: "FooBarCorp" -homepage: "http://example.com" -license: "MIT" -contents: -- src: ../bin/wails-open-file - dst: /usr/bin/wails-open-file -- src: ./main.desktop - dst: /usr/share/applications/wails-open-file.desktop -- src: ./application-wails-mime.xml - dst: /usr/share/mime/packages/application-x-wails.xml -- src: ./application-test-mime.xml - dst: /usr/share/mime/packages/application-x-test.xml -- src: ../appicon.svg - dst: /usr/share/icons/hicolor/scalable/apps/wails-open-file.svg -- src: ../wailsFileIcon.svg - dst: /usr/share/icons/hicolor/scalable/mimetypes/application-x-wails.svg -- src: ../testFileIcon.svg - dst: /usr/share/icons/hicolor/scalable/mimetypes/application-x-test.svg -# copy icons to Yaru theme as well. For some reason Ubuntu didn't pick up fileicons from hicolor theme -- src: ../appicon.svg - dst: /usr/share/icons/Yaru/scalable/apps/wails-open-file.svg -- src: ../wailsFileIcon.svg - dst: /usr/share/icons/Yaru/scalable/mimetypes/application-x-wails.svg -- src: ../testFileIcon.svg - dst: /usr/share/icons/Yaru/scalable/mimetypes/application-x-test.svg -scripts: - postinstall: ./postInstall.sh - postremove: ./postRemove.sh -``` - -6. Build your .deb package using nfpm: - -```sh -nfpm pkg --packager deb --target . -``` - -7. Now when your package is installed, your app will be associated with specified file types. When you open file with your app, - new instance of app is launched and file path is passed as argument to your app. - To handle this you should parse command line arguments in your app. Example: - -```go title="main.go" -func main() { - argsWithoutProg := os.Args[1:] - - if len(argsWithoutProg) != 0 { - println("launchArgs", argsWithoutProg) - } -} -``` - -You also can enable single instance lock for your app. In this case, when you open file with your app, new instance of app is not launched -and arguments are passed to already running instance. Check single instance lock guide for details. Example: - -```go title="main.go" -func main() { - // Create application with options - err := wails.Run(&options.App{ - Title: "wails-open-file", - Width: 1024, - Height: 768, - AssetServer: &assetserver.Options{ - Assets: assets, - }, - BackgroundColour: &options.RGBA{R: 27, G: 38, B: 54, A: 1}, - SingleInstanceLock: &options.SingleInstanceLock{ - UniqueId: "e3984e08-28dc-4e3d-b70a-45e961589cdc", - OnSecondInstanceLaunch: app.onSecondInstanceLaunch, - }, - Bind: []interface{}{ - app, - }, - }) -} -``` diff --git a/website/i18n/de/docusaurus-plugin-content-docs/current/guides/frameless.mdx b/website/i18n/de/docusaurus-plugin-content-docs/current/guides/frameless.mdx deleted file mode 100644 index 3845736f4..000000000 --- a/website/i18n/de/docusaurus-plugin-content-docs/current/guides/frameless.mdx +++ /dev/null @@ -1,87 +0,0 @@ -# Frameless Applications - -Wails supports application that have no frames. This can be achieved by using the [frameless](../reference/options.mdx#frameless) field in [Application Options](../reference/options.mdx#application-options). - -Wails offers a simple solution for dragging the window: Any HTML element that has the CSS style `--wails-draggable:drag` will act as a "drag handle". This property applies to all child elements. If you need to indicate that a nested element should not drag, then use the attribute '--wails-draggable:no-drag' on that element. - -```html -<html> - <head> - <link rel="stylesheet" href="/main.css" /> - </head> - - <body style="--wails-draggable:drag"> - <div id="logo"></div> - <div id="input" style="--wails-draggable:no-drag"> - <input id="name" type="text" /> - <button onclick="greet()">Greet</button> - </div> - <div id="result"></div> - - <script src="/main.js"></script> - </body> -</html> -``` - -For some projects, using a CSS variable may not be possible due to dynamic styling. In this case, you can use the `CSSDragProperty` and `CSSDragValue` application options to define a property and value that will be used to indicate draggable regions: - -```go title=main.go -package main - -import ( - "embed" - - "github.com/wailsapp/wails/v2" - "github.com/wailsapp/wails/v2/pkg/options" - "github.com/wailsapp/wails/v2/pkg/options/assetserver" -) - -//go:embed all:frontend/dist -var assets embed.FS - -func main() { - // Create an instance of the app structure - app := NewApp() - - // Create application with options - err := wails.Run(&options.App{ - Title: "alwaysontop", - Width: 1024, - Height: 768, - AssetServer: &assetserver.Options{ - Assets: assets, - }, - Frameless: true, - CSSDragProperty: "widows", - CSSDragValue: "1", - Bind: []interface{}{ - app, - }, - }) - - if err != nil { - println("Error:", err) - } -} -``` - -```html title=index.html -<!DOCTYPE html> -<html lang="en"> - <head> - <meta charset="UTF-8" /> - <meta content="width=device-width, initial-scale=1.0" name="viewport" /> - <title>alwaysontop - - -
                    - - - -``` - -:::info Fullscreen - -If you allow your application to go fullscreen, this drag functionality will be disabled. - -::: diff --git a/website/i18n/de/docusaurus-plugin-content-docs/current/guides/frontend.mdx b/website/i18n/de/docusaurus-plugin-content-docs/current/guides/frontend.mdx deleted file mode 100644 index f057056c1..000000000 --- a/website/i18n/de/docusaurus-plugin-content-docs/current/guides/frontend.mdx +++ /dev/null @@ -1,72 +0,0 @@ -# Frontend - -## Script Injection - -When Wails serves your `index.html`, by default, it will inject 2 script entries into the `` tag to load `/wails/ipc.js` and `/wails/runtime.js`. These files install the bindings and runtime respectively. - -The code below shows where these are injected by default: - -```html - - - injection example - - - - - - - -
                    Please enter your name below 👇
                    -
                    - - -
                    - - - - -``` - -### Overriding Default Script Injection - -To provide more flexibility to developers, there is a meta tag that may be used to customise this behaviour: - -```html - -``` - -The options are as follows: - -| Value | Description | -| ------------------- | ------------------------------------------------ | -| noautoinjectruntime | Disable the autoinjection of `/wails/runtime.js` | -| noautoinjectipc | Disable the autoinjection of `/wails/ipc.js` | -| noautoinject | Disable all autoinjection of scripts | - -Multiple options may be used provided they are comma separated. - -This code is perfectly valid and operates the same as the autoinjection version: - -```html - - - injection example - - - - - - -
                    Please enter your name below 👇
                    -
                    - - -
                    - - - - - - -``` diff --git a/website/i18n/de/docusaurus-plugin-content-docs/current/guides/ides.mdx b/website/i18n/de/docusaurus-plugin-content-docs/current/guides/ides.mdx deleted file mode 100644 index e59e144ee..000000000 --- a/website/i18n/de/docusaurus-plugin-content-docs/current/guides/ides.mdx +++ /dev/null @@ -1,127 +0,0 @@ -# IDEs - -Wails aims to provide a great development experience. To that aim, we now support generating IDE specific configuration to provide smoother project setup. - -Currently, we support [Visual Studio Code](https://code.visualstudio.com/) and [Goland](https://www.jetbrains.com/go/). - -## Visual Studio Code - -```mdx-code-block -

                    - -

                    -``` - -When generating a project using the `-ide vscode` flags, IDE files will be created alongside the other project files. These files are placed into the `.vscode` directory and provide the correct configuration for debugging your application. - -The 2 files generated are `tasks.json` and `launch.json`. Below are the files generated for the default vanilla project: - -```json title="tasks.json" -{ - "version": "2.0.0", - "tasks": [ - { - "label": "build", - "type": "shell", - "options": { - "cwd": "${workspaceFolder}" - }, - "command": "go", - "args": [ - "build", - "-tags", - "dev", - "-gcflags", - "all=-N -l", - "-o", - "build/bin/myproject.exe" - ] - } - ] -} -``` - -```json title="launch.json" -{ - "version": "0.2.0", - "configurations": [ - { - "name": "Wails: Debug myproject", - "type": "go", - "request": "launch", - "mode": "exec", - "program": "${workspaceFolder}/build/bin/myproject.exe", - "preLaunchTask": "build", - "cwd": "${workspaceFolder}", - "env": {} - } - ] -} -``` - -### Configuring the install and build steps - -The `tasks.json` file is simple for the default project as there is no `npm install` or `npm run build` step needed. For projects that have a frontend build step, such as the svelte template, we would need to edit `tasks.json` to add the install and build steps: - -```json title="tasks.json" -{ - "version": "2.0.0", - "tasks": [ - { - "label": "npm install", - "type": "npm", - "script": "install", - "options": { - "cwd": "${workspaceFolder}/frontend" - }, - "presentation": { - "clear": true, - "panel": "shared", - "showReuseMessage": false - }, - "problemMatcher": [] - }, - { - "label": "npm run build", - "type": "npm", - "script": "build", - "options": { - "cwd": "${workspaceFolder}/frontend" - }, - "presentation": { - "clear": true, - "panel": "shared", - "showReuseMessage": false - }, - "problemMatcher": [] - }, - { - "label": "build", - "type": "shell", - "options": { - "cwd": "${workspaceFolder}" - }, - "command": "go", - "args": [ - "build", - "-tags", - "dev", - "-gcflags", - "all=-N -l", - "-o", - "build/bin/vscode.exe" - ], - "dependsOn": ["npm install", "npm run build"] - } - ] -} -``` - -:::info Future Enhancement - -In the future, we hope to generate a `tasks.json` that includes the install and build steps automatically. - -::: diff --git a/website/i18n/de/docusaurus-plugin-content-docs/current/guides/linux-distro-support.mdx b/website/i18n/de/docusaurus-plugin-content-docs/current/guides/linux-distro-support.mdx deleted file mode 100644 index 8b25c1575..000000000 --- a/website/i18n/de/docusaurus-plugin-content-docs/current/guides/linux-distro-support.mdx +++ /dev/null @@ -1,103 +0,0 @@ -# Linux Distro Support - -## Overview - -Wails offers Linux support but providing installation instructions for all available distributions is an impossible task. Instead, Wails tries to determine if the packages you need to develop applications are available via your system's package manager. Currently, we support the following package managers: - -- apt -- dnf -- emerge -- eopkg -- nixpkgs -- pacman -- zypper - -## Adding package names - -There may be circumstances where your distro uses one of the supported package managers but the package name is different. For example, you may use an Ubuntu derivative, but the package name for gtk may be different. Wails attempts to find the correct package by iterating through a list of package names. The list of packages are stored in the packagemanager specific file in the `v2/internal/system/packagemanager` directory. In our example, this would be `v2/internal/system/packagemanager/apt.go`. - -In this file, the list of packages are defined by the `Packages()` method: - -```go -func (a *Apt) Packages() packagemap { - return packagemap{ - "libgtk-3": []*Package{ - {Name: "libgtk-3-dev", SystemPackage: true, Library: true}, - }, - "libwebkit": []*Package{ - {Name: "libwebkit2gtk-4.0-dev", SystemPackage: true, Library: true}, - }, - "gcc": []*Package{ - {Name: "build-essential", SystemPackage: true}, - }, - "pkg-config": []*Package{ - {Name: "pkg-config", SystemPackage: true}, - }, - "npm": []*Package{ - {Name: "npm", SystemPackage: true}, - }, - "docker": []*Package{ - {Name: "docker.io", SystemPackage: true, Optional: true}, - }, - } -} -``` - -Let's assume that in our linux distro, `libgtk-3` is packaged under the name `lib-gtk3-dev`. We could add support for this by adding the following line: - -```go {5} -func (a *Apt) Packages() packagemap { - return packagemap{ - "libgtk-3": []*Package{ - {Name: "libgtk-3-dev", SystemPackage: true, Library: true}, - {Name: "lib-gtk3-dev", SystemPackage: true, Library: true}, - }, - "libwebkit": []*Package{ - {Name: "libwebkit2gtk-4.0-dev", SystemPackage: true, Library: true}, - }, - "gcc": []*Package{ - {Name: "build-essential", SystemPackage: true}, - }, - "pkg-config": []*Package{ - {Name: "pkg-config", SystemPackage: true}, - }, - "npm": []*Package{ - {Name: "npm", SystemPackage: true}, - }, - "docker": []*Package{ - {Name: "docker.io", SystemPackage: true, Optional: true}, - }, - } -} -``` - -## Adding new package managers - -To add a new package manager, perform the following steps: - -- Create a new file in `v2/internal/system/packagemanager` called `.go`, where `` is the name of the package manager. -- Define a struct that conforms to the package manager interface defined in `pm.go`: - -```go -type PackageManager interface { - Name() string - Packages() packagemap - PackageInstalled(*Package) (bool, error) - PackageAvailable(*Package) (bool, error) - InstallCommand(*Package) string -} -``` - -- `Name()` should return the name of the package manager -- `Packages()` should return a `packagemap`, that provides candidate filenames for dependencies -- `PackageInstalled()` should return `true` if the given package is installed -- `PackageAvailable()` should return `true` if the given package is not installed but available for installation -- `InstallCommand()` should return the exact command to install the given package name - -Take a look at the other package managers code to get an idea how this works. - -:::info Remember - -If you add support for a new package manager, don't forget to also update this page! - -::: diff --git a/website/i18n/de/docusaurus-plugin-content-docs/current/guides/linux.mdx b/website/i18n/de/docusaurus-plugin-content-docs/current/guides/linux.mdx deleted file mode 100644 index f833ceffa..000000000 --- a/website/i18n/de/docusaurus-plugin-content-docs/current/guides/linux.mdx +++ /dev/null @@ -1,70 +0,0 @@ -# Linux - -This page has miscellaneous guides related to developing Wails applications for Linux. - -## Video tag doesn't fire "ended" event - -When using a video tag, the "ended" event is not fired when the video is finished playing. This is a bug in WebkitGTK, however you can use the following workaround to fix it: - -```js -videoTag.addEventListener("timeupdate", (event) => { - if (event.target.duration - event.target.currentTime < 0.2) { - let ended = new Event("ended"); - event.target.dispatchEvent(ended); - } -}); -``` - -Source: [Lyimmi](https://github.com/Lyimmi) on the [discussions board](https://github.com/wailsapp/wails/issues/1729#issuecomment-1212291275) - -## GStreamer error when using Audio or Video elements - -If you are seeing the following error when including `