mirror of
https://github.com/wailsapp/wails.git
synced 2026-03-14 14:45:49 +01:00
* All the documentation files have been updated. Here's a summary of the changes I made:
## Summary of Documentation Updates
### Key API Corrections Made:
1. **Dialog Creation**:
- Changed `app.InfoDialog()` → `application.InfoDialog()` (package-level functions)
- Also documented `app.Dialog.Info()` via DialogManager
2. **Question Dialog Buttons**:
- Removed non-existent `SetButtons("Save", "Don't Save", "Cancel")` method
- Now uses `AddButton("label")` which returns a `*Button`
- Button callbacks via `button.OnClick(func() { ... })`
3. **Default/Cancel Buttons**:
- Changed `SetDefaultButton("Cancel")` (string) → `SetDefaultButton(cancelBtn)` (`*Button`)
- Changed `SetCancelButton("Cancel")` (string) → `SetCancelButton(cancelBtn)` (`*Button`)
- Also documented fluent `SetAsDefault()` and `SetAsCancel()` methods on Button
4. **File Dialog Filters**:
- Changed `SetFilters([]application.FileFilter{...})` → `AddFilter("Display Name", "*.ext;*.ext2")`
5. **Save Dialog Filename**:
- Changed `SetDefaultFilename()` → `SetFilename()`
6. **Folder Selection**:
- Removed non-existent `app.SelectFolderDialog()`
- Now uses `application.OpenFileDialog().CanChooseDirectories(true).CanChooseFiles(false)`
7. **Show() Return Value**:
- Removed incorrect `result, err := dialog.Show()` pattern
- `Show()` returns nothing - responses are handled via button callbacks
### Files Modified:
- `docs/src/content/docs/features/dialogs/message.mdx` - Complete rewrite of question dialog examples
- `docs/src/content/docs/features/dialogs/overview.mdx` - Updated all code examples
- `docs/src/content/docs/features/dialogs/file.mdx` - Updated file dialog examples
- `v3/UNRELEASED_CHANGELOG.md` - Added changelog entry
* All changes are complete. Here's a summary of what was updated:
## Summary
I've updated the Wails v3 dialogs documentation to match the actual API. The documentation now consistently uses:
### DialogManager Pattern (Recommended)
- `app.Dialog.Info()`, `app.Dialog.Question()`, `app.Dialog.Warning()`, `app.Dialog.Error()`
- `app.Dialog.OpenFile()`, `app.Dialog.SaveFile()`
This is consistent with other runtime features like `app.Window`, `app.Event`, etc.
### Key API Corrections
1. **Dialog Creation**: Both `app.Dialog.*()` (DialogManager) and `application.*Dialog()` (package-level) are documented
2. **Question Dialog Buttons**: Use `AddButton("label")` which returns `*Button`, then `button.OnClick(callback)`
3. **Default/Cancel Buttons**: `SetDefaultButton(button)` and `SetCancelButton(button)` take `*Button` pointers
4. **File Filters**: Use `AddFilter("Display Name", "*.ext")` instead of `SetFilters()`
5. **Save Dialog Filename**: Use `SetFilename()` instead of `SetDefaultFilename()`
6. **Folder Selection**: Use `app.Dialog.OpenFile().CanChooseDirectories(true).CanChooseFiles(false)`
### Files Modified
- `docs/src/content/docs/features/dialogs/overview.mdx`
- `docs/src/content/docs/features/dialogs/message.mdx`
- `docs/src/content/docs/features/dialogs/file.mdx`
- `v3/UNRELEASED_CHANGELOG.md`
* Audit complete! All documentation files now consistently use `app.Dialog.*` for all code examples. Here's the summary:
## Audit Complete
All dialog documentation has been updated to consistently use the `app.Dialog.*` pattern:
### Changes Made:
**message.mdx:**
- All examples now use `app.Dialog.Info()`, `app.Dialog.Question()`, `app.Dialog.Warning()`, `app.Dialog.Error()`
- Function signatures updated to accept `app *application.App` parameter
- Nested dialog calls within callbacks also updated
**file.mdx:**
- All examples now use `app.Dialog.OpenFile()`, `app.Dialog.SaveFile()`
- Function signatures updated to accept `app *application.App` parameter
- All error/info dialogs within file operations also updated
**overview.mdx:**
- Already consistent from earlier edits
### Documentation Structure:
Each file now properly documents both approaches in a dedicated section:
```go
// Via DialogManager (recommended when you have an app instance):
app.Dialog.Info()
app.Dialog.OpenFile()
// Package-level functions (useful in callbacks or when app isn't in scope):
application.InfoDialog()
application.OpenFileDialog()
```
But all code examples use the `app.Dialog.*` pattern for consistency with other runtime features like `app.Window`, `app.Event`, etc.
* docs: Fix reference/dialogs.mdx and reference/application.mdx API documentation
Updated docs to match actual Wails v3 Dialogs API:
- reference/dialogs.mdx: Complete rewrite with correct API
- Use `app.Dialog.OpenFile()` and `app.Dialog.SaveFile()` instead of `app.OpenFileDialog()`
- Use `AddFilter("name", "pattern")` instead of `SetFilters([]FileFilter{...})`
- Use `SetFilename()` instead of `SetDefaultFilename()`
- Use `SetDirectory()` instead of `SetDefaultDirectory()`
- Remove non-existent `SelectFolderDialog()` - use `OpenFile().CanChooseDirectories(true).CanChooseFiles(false)`
- Use `AddButton()` with callbacks instead of `SetButtons()`
- Use `SetDefaultButton(*Button)` instead of `SetDefaultButton(int)`
- Document that `Show()` returns nothing, use callbacks
- reference/application.mdx: Fix Dialog Methods section
- Use `app.Dialog.*` manager pattern
- Show correct Question dialog with button callbacks
- Fix file dialog examples with `AddFilter()`
- Remove `SelectFolderDialog()` reference
🤖 Generated with [Claude Code](https://claude.com/claude-code)
Co-Authored-By: Claude <noreply@anthropic.com>
* docs: Remove package-level dialog function references
Remove all references to package-level dialog functions
(application.InfoDialog(), application.OpenFileDialog(), etc.)
from documentation. Only the app.Dialog manager pattern
should be used.
Updated files:
- reference/dialogs.mdx
- features/dialogs/overview.mdx
- features/dialogs/message.mdx
- features/dialogs/file.mdx
🤖 Generated with [Claude Code](https://claude.com/claude-code)
Co-Authored-By: Claude <noreply@anthropic.com>
* refactor: Remove package-level dialog functions in favor of app.Dialog manager
BREAKING CHANGE: Remove package-level dialog functions. Use app.Dialog manager instead.
Removed functions:
- application.InfoDialog()
- application.QuestionDialog()
- application.WarningDialog()
- application.ErrorDialog()
- application.OpenFileDialog()
- application.SaveFileDialog()
Use the Dialog manager pattern instead:
- app.Dialog.Info()
- app.Dialog.Question()
- app.Dialog.Warning()
- app.Dialog.Error()
- app.Dialog.OpenFile()
- app.Dialog.SaveFile()
This aligns dialogs with other runtime managers like app.Window and app.Event.
Updated files:
- v3/pkg/application/application.go - Remove exported dialog functions
- v3/pkg/application/dialog_manager.go - Use internal newMessageDialog/newOpenFileDialog
- v3/pkg/application/messageprocessor_dialog.go - Use internal dialog constructors
- v3/examples/* - Update all examples to use app.Dialog pattern
- v3/internal/commands/appimage_testfiles/main.go - Update test file
- v3/UNRELEASED_CHANGELOG.md - Document breaking change
🤖 Generated with [Claude Code](https://claude.com/claude-code)
Co-Authored-By: Claude <noreply@anthropic.com>
* fix: Use application.Get() in dialogs-basic example and correct filter docs
- Update dialogs-basic helper functions to use application.Get() instead
of passing app through function parameters
- Fix incorrect documentation claiming space/comma delimiters work for
filter patterns (only semicolons are supported)
🤖 Generated with [Claude Code](https://claude.com/claude-code)
Co-Authored-By: Claude <noreply@anthropic.com>
---------
Co-authored-by: Claude <noreply@anthropic.com>
126 lines
3.2 KiB
Go
126 lines
3.2 KiB
Go
package application
|
|
|
|
import (
|
|
"runtime"
|
|
|
|
"github.com/wailsapp/wails/v3/pkg/errs"
|
|
)
|
|
|
|
const (
|
|
DialogInfo = 0
|
|
DialogWarning = 1
|
|
DialogError = 2
|
|
DialogQuestion = 3
|
|
DialogOpenFile = 4
|
|
DialogSaveFile = 5
|
|
)
|
|
|
|
var dialogMethodNames = map[int]string{
|
|
DialogInfo: "Info",
|
|
DialogWarning: "Warning",
|
|
DialogError: "Error",
|
|
DialogQuestion: "Question",
|
|
DialogOpenFile: "OpenFile",
|
|
DialogSaveFile: "SaveFile",
|
|
}
|
|
|
|
func (m *MessageProcessor) processDialogMethod(req *RuntimeRequest, window Window) (any, error) {
|
|
args := req.Args.AsMap()
|
|
|
|
switch req.Method {
|
|
case DialogInfo, DialogWarning, DialogError, DialogQuestion:
|
|
var options MessageDialogOptions
|
|
err := req.Args.ToStruct(&options)
|
|
if err != nil {
|
|
return nil, errs.WrapInvalidDialogCallErrorf(err, "error parsing dialog options")
|
|
}
|
|
if len(options.Buttons) == 0 {
|
|
switch runtime.GOOS {
|
|
case "darwin":
|
|
options.Buttons = []*Button{{Label: "OK", IsDefault: true}}
|
|
}
|
|
}
|
|
var dialog *MessageDialog
|
|
switch req.Method {
|
|
case DialogInfo:
|
|
dialog = newMessageDialog(InfoDialogType)
|
|
case DialogWarning:
|
|
dialog = newMessageDialog(WarningDialogType)
|
|
case DialogError:
|
|
dialog = newMessageDialog(ErrorDialogType)
|
|
case DialogQuestion:
|
|
dialog = newMessageDialog(QuestionDialogType)
|
|
}
|
|
var detached = args.Bool("Detached")
|
|
if detached == nil || !*detached {
|
|
dialog.AttachToWindow(window)
|
|
}
|
|
|
|
dialog.SetTitle(options.Title)
|
|
dialog.SetMessage(options.Message)
|
|
|
|
resp := make(chan string, 1)
|
|
for _, button := range options.Buttons {
|
|
label := button.Label
|
|
button.OnClick(func() {
|
|
select {
|
|
case resp <- label:
|
|
default:
|
|
}
|
|
})
|
|
}
|
|
dialog.AddButtons(options.Buttons)
|
|
dialog.Show()
|
|
|
|
response := <-resp
|
|
return response, nil
|
|
|
|
case DialogOpenFile:
|
|
var options OpenFileDialogOptions
|
|
err := req.Args.ToStruct(&options)
|
|
if err != nil {
|
|
return nil, errs.WrapInvalidDialogCallErrorf(err, "error parsing dialog options")
|
|
}
|
|
var detached = args.Bool("Detached")
|
|
if detached == nil || !*detached {
|
|
options.Window = window
|
|
}
|
|
dialog := globalApplication.Dialog.OpenFileWithOptions(&options)
|
|
|
|
if options.AllowsMultipleSelection {
|
|
files, err := dialog.PromptForMultipleSelection()
|
|
if err != nil {
|
|
return nil, errs.WrapInvalidDialogCallErrorf(err, "Dialog.OpenFile failed: error getting selection")
|
|
}
|
|
|
|
return files, nil
|
|
} else {
|
|
file, err := dialog.PromptForSingleSelection()
|
|
if err != nil {
|
|
return nil, errs.WrapInvalidDialogCallErrorf(err, "Dialog.OpenFile failed, error getting selection")
|
|
}
|
|
return file, nil
|
|
}
|
|
|
|
case DialogSaveFile:
|
|
var options SaveFileDialogOptions
|
|
err := req.Args.ToStruct(&options)
|
|
if err != nil {
|
|
return nil, errs.WrapInvalidDialogCallErrorf(err, "error parsing dialog options")
|
|
}
|
|
var detached = args.Bool("Detached")
|
|
if detached == nil || !*detached {
|
|
options.Window = window
|
|
}
|
|
dialog := globalApplication.Dialog.SaveFileWithOptions(&options)
|
|
|
|
file, err := dialog.PromptForSingleSelection()
|
|
if err != nil {
|
|
return nil, errs.WrapInvalidDialogCallErrorf(err, "Dialog.SaveFile failed: error getting selection")
|
|
}
|
|
return file, nil
|
|
|
|
default:
|
|
return nil, errs.NewInvalidDialogCallErrorf("unknown method: %d", req.Method)
|
|
}
|
|
}
|