deblan-mirror/wails
1
0
Fork 0
mirror of https://github.com/wailsapp/wails.git synced 2026-03-16 15:45:50 +01:00
Code Issues Projects Releases Packages Wiki Activity
wails/v3/examples/notifications
History
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
..
build Update v3/examples/notifications/build/windows/nsis/wails_tools.nsh 2025-04-12 13:21:58 +10:00
frontend update example 2025-03-24 16:05:57 -07:00
go.mod feat: Complete App API restructuring with organized manager pattern (#4359) 2025-06-21 19:51:14 +10:00
go.sum feat: Complete App API restructuring with organized manager pattern (#4359) 2025-06-21 19:51:14 +10:00
main.go Refactor Manager API to use singular naming convention (#4367) 2025-06-22 12:19:14 +10:00
README.md update example 2025-03-24 16:05:57 -07:00
Taskfile.yml update example 2025-03-24 16:05:57 -07:00

README.md

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 for in-depth guides and API references.

  4. Join the community: Have questions or want to share your progress? Join the Wails Discord or visit the Wails discussions on GitHub.

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.