No description
  • Go 66.2%
  • JavaScript 11.9%
  • HTML 10.5%
  • Objective-C 4.2%
  • NSIS 1.8%
  • Other 5.4%
Find a file
Lea Anthony ab33eb594e
docs: fix custom protocol association documentation (#4825)
* docs: fix custom protocol association documentation

The documentation was incorrectly referencing `wails.json` with JSON format
when the actual configuration file is `build/config.yml` using YAML format.

Changes:
- Update config file reference from `wails.json` to `build/config.yml`
- Change format from JSON to YAML in code examples
- Fix structure: `protocols` is at root level, not nested under `info`
- Correct template variable references from `{{.Info.Protocols}}` to `{{.Protocols}}`
- Update Info.plist example to show actual generated format (`wails.com.scheme`)
- Add note about running `wails3 task common:update:build-assets` after changes
- Clean up redundant file path references in platform-specific sections

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

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

* docs: consolidate custom protocol docs and add Universal Links

- Remove duplicate custom-protocol-association.mdx
- Add Universal Links section to macOS tab
- Add Web-to-App Linking section to Windows tab
- Keep the more comprehensive distribution/custom-protocols.mdx

Addresses review comment about duplicate documentation.

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

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

* feat(windows): add custom protocol support to MSIX packaging

- Add uap3 namespace and protocol extension to MSIX template
- Protocols defined in build/config.yml are now automatically
  registered when building MSIX packages
- Update docs with MSIX section and clarify Web-to-App linking
  requires manual manifest configuration

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

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

---------

Co-authored-by: Claude <noreply@anthropic.com>
2025-12-27 09:52:26 +11:00
.github fix(ci): always run v3 tests for PRs targeting v3-alpha 2025-12-07 17:41:02 +11:00
assets/images [ImgBot] Optimize images (#1812) 2022-09-12 21:57:07 +10:00
docs docs: fix custom protocol association documentation (#4825) 2025-12-27 09:52:26 +11:00
mkdocs-website/docs/en [V3] feat: add Windows getAccentColor implementation (#4427) 2025-07-25 21:46:05 +10:00
scripts Add issue management automation tools 2025-05-14 20:47:45 +10:00
v2 Dependency updates 2025-05-15 06:26:20 +10:00
v3 docs: fix custom protocol association documentation (#4825) 2025-12-27 09:52:26 +11:00
website docs: add Linux runtime dependencies and nfpm packaging guide (#4779) 2025-12-13 10:59:33 +11:00
.all-contributorsrc [v3] Add starlight website (#3917) 2024-12-08 12:09:13 +11:00
.coderabbit.yaml Add code rabbit for alpha 2024-07-29 20:46:15 +10:00
.gitignore Merge Android support from v3-alpha-feature/android-support 2025-12-10 18:37:24 +11:00
.prettierignore chore: add Prettier as format tool (#2689) 2023-05-30 07:40:54 +10:00
.prettierrc.yml [v3] Add starlight website (#3917) 2024-12-08 12:09:13 +11:00
AGENTS.md fix: resolve merge conflict in AndroidOptions and add AGENTS.md 2025-12-10 21:15:15 +11:00
CHANGELOG.md chore: sort out files (#1776) 2022-08-22 20:02:27 +10:00
CNAME Add CNAME 2023-10-29 09:48:37 +11:00
CONTRIBUTING.md chore: sort out files (#1776) 2022-08-22 20:02:27 +10:00
CONTRIBUTORS.md Fix BackgroundColour documentation. Update changelog. Move contributors into website. Create changelog link. 2022-07-25 20:11:04 +10:00
IOS_ARCHITECTURE.md Merge iOS support from v3-alpha-feature/ios-support 2025-12-10 18:34:21 +11:00
LICENSE Update license and readme 2019-04-08 19:18:39 +10:00
qodana.yaml Add status table to docs. 2023-09-06 20:59:45 +10:00
README.de.md German Readme (#3483) 2024-06-08 21:15:42 +10:00
README.es.md German Readme (#3483) 2024-06-08 21:15:42 +10:00
README.fr.md German Readme (#3483) 2024-06-08 21:15:42 +10:00
README.ja.md German Readme (#3483) 2024-06-08 21:15:42 +10:00
README.ko.md German Readme (#3483) 2024-06-08 21:15:42 +10:00
README.md German Readme (#3483) 2024-06-08 21:15:42 +10:00
README.pt-br.md German Readme (#3483) 2024-06-08 21:15:42 +10:00
README.ru.md Update README.ru.md (#3544) 2024-06-17 18:40:22 +10:00
README.tr.md Added README.tr.md for supporting turkish language (#3528) 2024-06-08 09:51:35 +10:00
README.uz.md German Readme (#3483) 2024-06-08 21:15:42 +10:00
README.zh-Hans.md German Readme (#3483) 2024-06-08 21:15:42 +10:00
SECURITY.md Update SECURITY.md 2024-02-14 18:15:24 +11:00
Taskfile.yaml Docs change 2024-12-13 22:00:25 +11:00
test-changelog-extraction.sh Add test workflow for nightly releases 2025-07-06 06:59:28 +10:00
test-ios-compile.sh Merge iOS support from v3-alpha-feature/ios-support 2025-12-10 18:34:21 +11:00
test-version-logic.sh Add test workflow for nightly releases 2025-07-06 06:59:28 +10:00
test-workflow.md Add test workflow for nightly releases 2025-07-06 06:59:28 +10:00


Build desktop applications using Go & Web Technologies.

GitHub Go Reference CodeFactor Awesome Discord
Build GitHub tag (latest SemVer pre-release)

Table of Contents

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

Star History Chart

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

FOSSA Status

Inspiration

This project was mainly coded to the following albums: