mirror of
https://github.com/wailsapp/wails.git
synced 2026-03-14 14:45:49 +01:00
No description
- Go 66.2%
- JavaScript 11.9%
- HTML 10.5%
- Objective-C 4.2%
- NSIS 1.8%
- Other 5.4%
47ebe47090* docs: comprehensive audit and fix of hallucinated v3 documentation Three-pass audit of all v3 documentation against source code on v3-alpha, fixing hundreds of hallucinated API patterns, fabricated CLI flags, wrong method signatures, and incorrect struct fields across 59 files. Pass 1: Pattern-matched sweep for known wrong API names Pass 2: Source-code-first specialist agents (6 agents by area) Pass 3: Deep field-by-field verification (7 specialist agents) Key fixes: - Removed fabricated OnStartup/OnBeforeClose hooks, replaced with ServiceStartup interface, ShouldQuit, RegisterHook patterns - Removed fabricated window convenience methods (OnClose, OnFocus, etc.), replaced with OnWindowEvent(events.Common.*, ...) pattern - Removed fabricated CLI flags (-platform, -o, -ldflags, -icon, etc.), documented actual Taskfile-based build system with GOOS/GOARCH - Fixed package-level dialog functions to Manager API - Fixed JS runtime imports (OnEvent/Emit -> Events.On/Events.Emit) - Fixed platform option struct names (MacOptions->MacWindow, etc.) - Fixed Screen struct fields, WebviewWindowOptions fields - Added missing documentation for 20+ window methods, 30+ platform option fields, complete Application Options table, missing CLI commands - Fixed event callback signatures, event constant names - Fixed ServiceShutdown signature, OnClick callback signatures Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * docs: apply PR review principles - JS event objects, directives, lifecycle Address feedback from PR #4975 review by fbbdev and Copilot: JS event callbacks (Principle 3 - 14 fixes across 10 files): - All JS event callbacks now correctly receive event object, access payload via event.data instead of receiving data directly - Fixed in: reference/window, concepts/bridge, concepts/architecture, migration/v2-to-v3, guides/gin-routing, guides/gin-services, features/dialogs/custom, features/bindings/best-practices Wails directives (Principle 2 - 2 files): - Fixed //wails:internal semantics: IS exported to frontend but kept module-private (not re-exported from index), NOT "prevents export" - Fixed //wails:ignore description: completely excluded from JS bindings - Added new "Internal + Inject Pattern" section with real SQLite service example showing how //wails:internal + //wails:inject work together ContextMenu.Update() (Principle 5): - Added missing Update() call in guides/menus.mdx image gallery example Lifecycle patterns verified correct - ServiceStartup usage is for business logic init, not lifecycle hooks. EventManager.Emit confirmed to return bool per source (Principle 4 in audit doc was incorrect). Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * docs: fix lifecycle docs - use events not services for lifecycle hooks ServiceStartup is for service resource initialization (DB, config), NOT for application lifecycle hooks. Application lifecycle events (events.Common.ApplicationStarted, ThemeChanged) are the correct mechanism for reacting to lifecycle stages. - architecture.mdx: replace misleading "Lifecycle hooks" section - lifecycle.mdx: add Application Lifecycle Events section (new §3) - lifecycle.mdx: rename "Service Startup" to "Service Initialisation" - lifecycle.mdx: categorize reference table (events/services/options) - lifecycle.mdx: update d2 diagram with ApplicationStarted stage - lifecycle.mdx: update best practices to distinguish init vs lifecycle Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * docs: fix issues from PR review comments - menus.mdx: add Update() call after adding items to context menu snippet - application.mdx: fix Emit() signature — remove fabricated bool return - events-reference.mdx: fix files-dropped JS example to account for variadic wrapping (event.data[0] is the files array) - bridge.mdx: fix progress event example — use variadic args directly and destructure event.data array in JS Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> --------- Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com> |
||
|---|---|---|
| .github | ||
| assets/images | ||
| docs | ||
| mkdocs-website/docs/en | ||
| scripts | ||
| v2 | ||
| v3 | ||
| website | ||
| .all-contributorsrc | ||
| .coderabbit.yaml | ||
| .gitignore | ||
| .prettierignore | ||
| .prettierrc.yml | ||
| .tool-versions | ||
| AGENTS.md | ||
| astro.config.mjs | ||
| CHANGELOG.md | ||
| CNAME | ||
| CONTRIBUTING.md | ||
| CONTRIBUTORS.md | ||
| DEVELOPER_GUIDE.md | ||
| DND_ANALYSIS.md | ||
| DND_ISSUES.md | ||
| LICENSE | ||
| package-lock.json | ||
| package.json | ||
| qodana.yaml | ||
| README.de.md | ||
| README.es.md | ||
| README.fr.md | ||
| README.ja.md | ||
| README.ko.md | ||
| README.md | ||
| README.pt-br.md | ||
| README.ru.md | ||
| README.tr.md | ||
| README.uz.md | ||
| README.zh-Hans.md | ||
| SECURITY.md | ||
| Taskfile.yaml | ||
| test-changelog-extraction.sh | ||
| test-version-logic.sh | ||
| test-workflow.md | ||
Build desktop applications using Go & Web Technologies.
Table of Contents
- Table of Contents
- Introduction
- Features
- Getting Started
- Sponsors
- FAQ
- Stargazers over time
- Contributors
- License
- Inspiration
Introduction
The traditional method of providing web interfaces to Go programs is via a built-in web server. Wails offers a different approach: it provides the ability to wrap both Go code and a web frontend into a single binary. Tools are provided to make this easy for you by handling project creation, compilation and bundling. All you have to do is get creative!
Features
- Use standard Go for the backend
- Use any frontend technology you are already familiar with to build your UI
- Quickly create rich frontends for your Go programs using pre-built templates
- Easily call Go methods from Javascript
- Auto-generated Typescript definitions for your Go structs and methods
- Native Dialogs & Menus
- Native Dark / Light mode support
- Supports modern translucency and "frosted window" effects
- Unified eventing system between Go and Javascript
- Powerful cli tool to quickly generate and build your projects
- Multiplatform
- Uses native rendering engines - no embedded browser!
Roadmap
The project roadmap may be found here. Please consult it before creating an enhancement request.
Getting Started
The installation instructions are on the official website.
Sponsors
This project is supported by these kind people / companies:
FAQ
-
Is this an alternative to Electron?
Depends on your requirements. It's designed to make it easy for Go programmers to make lightweight desktop applications or add a frontend to their existing applications. Wails does offer native elements such as menus and dialogs, so it could be considered a lightweight electron alternative.
-
Who is this project aimed at?
Go programmers who want to bundle an HTML/JS/CSS frontend with their applications, without resorting to creating a server and opening a browser to view it.
-
What's with the name?
When I saw WebView, I thought "What I really want is tooling around building a WebView app, a bit like Rails is to Ruby". So initially it was a play on words (Webview on Rails). It just so happened to also be a homophone of the English name for the Country I am from. So it stuck.
Stargazers over time
Contributors
The contributors list is getting too big for the readme! All the amazing people who have contributed to this project have their own page here.
License
Inspiration
This project was mainly coded to the following albums:
- Manic Street Preachers - Resistance Is Futile
- Manic Street Preachers - This Is My Truth, Tell Me Yours
- The Midnight - Endless Summer
- Gary Newman - Savage (Songs from a Broken World)
- Steve Vai - Passion & Warfare
- Ben Howard - Every Kingdom
- Ben Howard - Noonday Dream
- Adwaith - Melyn
- Gwidaith Hen Fran - Cedors Hen Wrach
- Metallica - Metallica
- Bloc Party - Silent Alarm
- Maxthor - Another World
- Alun Tan Lan - Y Distawrwydd