wails/v3/examples/single-instance
Lea Anthony 3087ba0bdc
Refactor Manager API to use singular naming convention (#4367)
* Refactor Manager API to use singular naming convention

This is a RENAME-ONLY exercise that converts the Wails v3 Manager API from plural to singular naming for better consistency and clarity.

## Changes Applied

### API Transformations:
- `app.Windows.*` → `app.Window.*`
- `app.Events.*` → `app.Event.*`
- `app.ContextMenus.*` → `app.ContextMenu.*`
- `app.KeyBindings.*` → `app.KeyBinding.*`
- `app.Dialogs.*` → `app.Dialog.*`
- `app.Menus.*` → `app.Menu.*`
- `app.Screens.*` → `app.Screen.*`

### Files Updated:
- **Core Application**: 22 files in `v3/pkg/application/`
- **Examples**: 43+ files in `v3/examples/`
- **Documentation**: 13 files in `docs/src/content/docs/`
- **CLI Tests**: 1 file in `v3/internal/commands/`

### Critical Constraints Preserved:
-  Event string constants unchanged (e.g., "windows:WindowShow")
-  Platform event names preserved (events.Windows, events.Mac, etc.)
-  TypeScript API remains compatible
-  All functionality intact

### Verification:
-  All examples build successfully (`task test:examples` passes)
-  Application package compiles without errors
-  Documentation reflects new API patterns

## Benefits

- **Improved Clarity**: Singular names are more intuitive (`app.Window` vs `app.Windows`)
- **Better Consistency**: Aligns with Go naming conventions
- **Enhanced Developer Experience**: Clearer autocomplete and API discovery

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>

* Fix generator testcases and add cross-platform test cleanup

- Update 28 generator testcase files to use singular API (app.Window.New() vs app.Windows.New())
- Add cross-platform cleanup system with Go script to remove test artifacts
- Add test:all task with comprehensive testing and automatic cleanup
- Fix cleanup to target files vs directories correctly (preserves source directories)

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>

* Fix remaining Windows CI failures by updating all plural API usage to singular

Fixed the last remaining instances of old plural Manager API usage:
- tests/window-visibility-test/main.go: Updated all app.Windows -> app.Window and app.Menus -> app.Menu
- internal/templates/_common/main.go.tmpl: Updated app.Windows -> app.Window and app.Events -> app.Event
- pkg/services/badge/badge_windows.go: Updated app.Windows -> app.Window (Windows-specific fix)

These fixes address the Windows CI failures where platform-specific files still used the old API.
The tests didn't catch this locally because Windows-specific files only compile on Windows.

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>

---------

Co-authored-by: Claude <noreply@anthropic.com>
2025-06-22 12:19:14 +10:00
..
assets Single Instance feature. 2024-12-30 21:02:43 +11:00
main.go Refactor Manager API to use singular naming convention (#4367) 2025-06-22 12:19:14 +10:00
README.md Single Instance feature. 2024-12-30 21:02:43 +11:00

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:

    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:

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