Skip to content

Change Window Type from WebviewWindow to Window - #4829

Merged
leaanthony merged 4 commits into
wailsapp:v3-alphafrom
ndianabasi:patch-4
Jan 19, 2026
Merged

leaanthony merged 4 commits into
wailsapp:v3-alphafrom
ndianabasi:patch-4

Conversation

@ndianabasi

@ndianabasi ndianabasi commented Dec 22, 2025 •

Copy link
Copy Markdown
Contributor

Description

This PR updates the docs page for keyboard shortcuts and corrects the type of the callback parameter for KeyBinding.Add.

Fixes # (issue)

Type of change

Please select the option that is relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration using wails doctor.

  • Windows
  • macOS
  • Linux

If you checked Linux, please specify the distro and version.

Test Configuration

Please paste the output of wails doctor. If you are unable to run this command, please describe your environment in as much detail as possible.

Checklist:

  • I have updated website/src/pages/changelog.mdx with details of this PR
  • My code follows the general coding style of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes

Summary by CodeRabbit

  • Documentation
    • Updated keyboard shortcuts docs to standardize the window callback parameter shown in code examples across basic, platform-specific, context-aware, dynamic, and complete sections, improving clarity for implementing keyboard bindings.
  • Chores
    • Updated unreleased changelog entry to note the documentation correction.

✏️ Tip: You can customize this high-level summary in your review settings.

@coderabbitai

coderabbitai Bot commented Dec 22, 2025 •

Copy link
Copy Markdown
Contributor

Caution

Review failed

The pull request is closed.

Walkthrough

Documentation updated: example callback/window parameter types changed from *application.WebviewWindow to application.Window in the keyboard shortcuts guide; an unreleased changelog entry was added recording the correction.

Changes

Cohort / File(s) Summary
Keyboard shortcuts documentation
docs/src/content/docs/features/keyboard/shortcuts.mdx
Replaced *application.WebviewWindow parameter types with application.Window in KeyBinding.Add callbacks and related example function signatures (e.g., openFile, showKeyboardShortcuts, exitEditModeHandler) across basic, platform-specific, context-aware, dynamic, complete, and best-practices examples.
Changelog
v3/UNRELEASED_CHANGELOG.md
Added an entry noting the documentation correction for keyboard shortcuts callback parameter types.

Sequence Diagram(s)

(omitted — changes are documentation-only and do not introduce new multi-component control flow)

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

Suggested labels

Documentation, v3-alpha, size:L, lgtm

Poem

🐇 I hopped through snippets, clean and quick,
Swapped types with care—no logic to pick,
Shortcuts now sing with a tidier name,
Docs pranced along, unchanged in their game,
🥕✨

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately summarizes the main change: updating the window type parameter from WebviewWindow to Window in the keyboard shortcuts documentation.
Description check ✅ Passed The description covers the main purpose and classifies the change type correctly as a documentation update. However, the 'Fixes' field is incomplete with no issue number referenced, and testing details are not provided.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Fix all issues with AI agents
In `@v3/UNRELEASED_CHANGELOG.md`:
- Line 26: Edit the UNRELEASED_CHANGELOG.md entry that currently reads "Update
the docs page for keyboard shortcuts and corrects the type of the callback
parameter for `KeyBinding.Add` by `@ndianabasi`" to use parallel tense and include
the PR reference: change "corrects" to "correct" so it reads "Update the docs
page for keyboard shortcuts and correct the type of the callback parameter for
`KeyBinding.Add`" and append the PR number in parentheses after the author (for
example "by `@ndianabasi` (`#4829`)").


## Fixed
<!-- Bug fixes -->
- Update the docs page for keyboard shortcuts and corrects the type of the callback parameter for `KeyBinding.Add` by @ndianabasi

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Fix parallel tense and add PR reference.

“Update … and corrects” mixes tenses; consider “Update … and correct …”. Also add the PR reference (e.g., #4829) per the file’s guidelines.

🔧 Suggested edit
-- Update the docs page for keyboard shortcuts and corrects the type of the callback parameter for `KeyBinding.Add` by `@ndianabasi`
+- Update the docs page for keyboard shortcuts and correct the type of the callback parameter for `KeyBinding.Add` (`#4829`) by `@ndianabasi`
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
- Update the docs page for keyboard shortcuts and corrects the type of the callback parameter for `KeyBinding.Add` by @ndianabasi
- Update the docs page for keyboard shortcuts and correct the type of the callback parameter for `KeyBinding.Add` (`#4829`) by `@ndianabasi`
🤖 Prompt for AI Agents
In `@v3/UNRELEASED_CHANGELOG.md` at line 26, Edit the UNRELEASED_CHANGELOG.md
entry that currently reads "Update the docs page for keyboard shortcuts and
corrects the type of the callback parameter for `KeyBinding.Add` by `@ndianabasi`"
to use parallel tense and include the PR reference: change "corrects" to
"correct" so it reads "Update the docs page for keyboard shortcuts and correct
the type of the callback parameter for `KeyBinding.Add`" and append the PR
number in parentheses after the author (for example "by `@ndianabasi` (`#4829`)").

@leaanthony
leaanthony merged commit 8598034 into wailsapp:v3-alpha Jan 19, 2026
14 of 16 checks passed
@sonarqubecloud

Copy link
Copy Markdown

Grantmartin2002 pushed a commit to Grantmartin2002/wails that referenced this pull request Apr 29, 2026
* fix: change window type from WebviewWindow to Window

* docs: update `UNRELEASED_CHANGELOG`

---------

Co-authored-by: Lea Anthony <lea.anthony@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants