mirror of
https://github.com/wailsapp/wails.git
synced 2026-03-14 14:45:49 +01:00
c84506a8a8
This commit represents a complete redesign of the Wails v3 documentation structure and includes all recent v3-alpha updates. ## Major Changes ### Documentation Restructure - Migrated from /learn to organized /features, /guides, /reference structure - Created new Quick Start section with installation and first app guides - Added comprehensive Concepts section explaining architecture and lifecycle - Reorganized Contributing section with detailed guides for different contribution types - Added complete API Reference with separate pages for each major component ### New Documentation - Custom URL Protocols guide with NSIS automatic registration - Windows Packaging guide with NSIS, MSI, and MSIX options - Typed Events system with TypeScript binding generation - Complete menu documentation (Application, Context, System Tray) - Comprehensive dialog documentation (File, Message, Custom) - Window management guides (Basics, Events, Frameless, Multiple Windows) - Bindings documentation (Services, Methods, Models, Best Practices) - New tutorials: Todo app and Notes app (vanilla JS) ### v3-alpha API Updates - Typed Events: RegisterEvent[T] with strict mode and binding generation - Custom Protocols: NSIS macros for automatic Windows protocol registration - System Tray: Windows Show/Hide now fully functional with tooltip limits - Window Hidden: Fixed white flash on Windows when creating hidden windows - Notifications: Corrected import path to pkg/services/notifications - Frontend Runtime: Events.Emit now returns Promise<boolean> for cancellation ### Documentation Improvements - Updated all code examples to use @wailsio/runtime imports - Added platform-specific event tables and examples - Created comprehensive event reference with use cases - Added security best practices and validation patterns - Improved code examples with real-world use cases - Added troubleshooting sections and common patterns ### Files - Created: 60+ new documentation pages - Deleted: Old /learn structure (13 files) - Modified: 15 existing files for v3-alpha compatibility - Added: Tutorial assets and showcase images
93 lines
2.5 KiB
Text
93 lines
2.5 KiB
Text
# Binaries for programs and plugins
|
|
*.exe
|
|
*.exe~
|
|
*.dll
|
|
*.so
|
|
*.dylib
|
|
|
|
# Test binary, build with `go test -c`
|
|
*.test
|
|
|
|
# Output of the go coverage tool, specifically when used with LiteIDE
|
|
*.out
|
|
|
|
examples/**/example*
|
|
!examples/**/*.*
|
|
cmd/wails/wails
|
|
.DS_Store
|
|
tmp
|
|
node_modules/
|
|
package.json.md5
|
|
v2/test/**/frontend/dist
|
|
v2/test/**/build/
|
|
v2/test/frameless/icon.png
|
|
v2/test/hidden/icon.png
|
|
v2/test/kitchensink/frontend/public/bundle.*
|
|
v2/pkg/parser/testproject/frontend/wails
|
|
v2/test/kitchensink/frontend/public
|
|
v2/test/kitchensink/build/darwin/desktop/kitchensink
|
|
v2/test/kitchensink/frontend/package.json.md5
|
|
.idea/
|
|
v2/cmd/wails/internal/commands/initialise/templates/testtemplates/
|
|
.env
|
|
/website/static/img/.cache.json
|
|
|
|
/v3/.task
|
|
/v3/examples/build/bin/testapp
|
|
/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
|
|
/docs/site
|
|
.aider*
|
|
.cache
|
|
.local
|