[V3/Docs] Add Events documentation #3867
Conversation
atterpac
force-pushed
the
v3/docs-update
branch
from
56898cf
to
7708491
Compare
WalkthroughThe changes in this pull request introduce a comprehensive update to the event handling system within the application. New functions for registering and managing events are added, existing function signatures are modified, and extensive documentation is provided for application and window events. Additionally, new event types are documented across various platforms, including Linux, macOS, and Windows. The configuration file for documentation is also updated to enhance the navigation and markdown capabilities. Changes
Possibly related PRs
Suggested reviewers
Poem
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
Documentation and Community
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 13
🧹 Outside diff range and nitpick comments (16)
mkdocs-website/docs/en/API/events_linux.md (2)
5-10: Enhance event documentation and fix markdown formatting.While the events are well-defined, consider these improvements:
- Add more detailed descriptions, including:
- When exactly the ApplicationStartup event fires in the application lifecycle
- What data (if any) is included with these events
- Common use cases or examples
- Fix the markdown definition list syntax
Apply this formatting fix:
-`events.Linux.ApplicationStartup` -: Triggered when the application starts +`events.Linux.ApplicationStartup`: +: Triggered when the application starts. This event fires during the application initialization phase. -`events.Linux.SystemThemeChanged` -: Triggered when the system theme changes +`events.Linux.SystemThemeChanged`: +: Triggered when the system theme changes. This event includes the new theme information.🧰 Tools
🪛 LanguageTool
[uncategorized] ~5-~5: Loose punctuation mark.
Context: ...entsevents.Linux.ApplicationStartup: Triggered when the application starts...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~8-~8: Loose punctuation mark.
Context: ...artsevents.Linux.SystemThemeChanged: Triggered when the system theme chang...(UNLIKELY_OPENING_PUNCTUATION)
[grammar] ~9-~9: Did you mean “themes”?
Context: ...eChanged: Triggered when the system theme changes ##### Window Eventsevents.L...(WRB_DT_NN_VB)
11-33: Enhance window events documentation with more details.The window events would benefit from more comprehensive documentation:
- Add information about event data payloads
- Clarify which events are cancelable (especially WindowDeleteEvent)
- Include common use cases or examples
- Document the order of events for related actions (e.g., resize/move)
Example improvement for one event:
-`events.Linux.WindowDeleteEvent` -: Triggered when the window is deleted +`events.Linux.WindowDeleteEvent`: +: Triggered when the window is about to be deleted. This event can be canceled by returning `false` +from the event handler to prevent window closure. The event handler receives no additional data. + +Example usage: +```go +runtime.EventsOn("events.Linux.WindowDeleteEvent", func(data ...interface{}) { + // Prevent window closure + return false +}) +```🧰 Tools
🪛 LanguageTool
[uncategorized] ~13-~13: Loose punctuation mark.
Context: ...ventsevents.Linux.WindowLoadChanged: Triggered when the window load change...(UNLIKELY_OPENING_PUNCTUATION)
[grammar] ~14-~14: Did you mean “loads”?
Context: ...dChanged: Triggered when the window load changesevents.Linux.WindowDeleteEven...(WRB_DT_NN_VB)
[uncategorized] ~16-~16: Loose punctuation mark.
Context: ...angesevents.Linux.WindowDeleteEvent: Triggered when the window is deleted ...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~19-~19: Loose punctuation mark.
Context: ...s deletedevents.Linux.WindowDidMove: Triggered when the window is moved `...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~22-~22: Loose punctuation mark.
Context: ...s movedevents.Linux.WindowDidResize: Triggered when the window is resized ...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~25-~25: Loose punctuation mark.
Context: ...resizedevents.Linux.WindowDidResize: Triggered when the window is resized ...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~28-~28: Loose punctuation mark.
Context: ...s resizedevents.Linux.WindowFocusIn: Triggered when the window gains focus...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~31-~31: Loose punctuation mark.
Context: ...ns focusevents.Linux.WindowFocusOut: Triggered when the window loses focus...(UNLIKELY_OPENING_PUNCTUATION)
mkdocs-website/docs/en/API/application_events.md (4)
1-8: Enhance OnEvent documentation with more details.The documentation would be more helpful with additional information about:
- The return value function and how it's used for cleanup
- The structure of CustomEvent and its properties
- A practical example demonstrating usage
Add the following content:
### OnEvent API: `OnEvent(name string, callback func(event *CustomEvent)) func()` `OnEvent()` registers an event listener for specific application events. The callback function provided will be triggered when the corresponding event occurs. + +The function returns a cleanup function that can be called to remove the event listener. + +The `CustomEvent` structure contains: +- `Data`: The data passed with the event + +Example: +```go +cleanup := app.OnEvent("user-login", func(event *CustomEvent) { + userData := event.Data.(UserData) + fmt.Printf("User logged in: %s\n", userData.Username) +}) + +// Later when done listening +cleanup() +```
15-20: Add details about OnMultipleEvent behavior.The documentation should clarify:
- What happens after the counter reaches zero (auto-cleanup?)
- Whether the cleanup function can be called before the counter is reached
- How negative counter values are handled
- Include an example showing practical usage
Add the following content:
`OnMultipleEvent()` registers an event listener for X number of Events. The callback function provided will be triggered `counter` times when the corresponding event occurs. + +The event listener is automatically removed after being triggered `counter` times. The returned +cleanup function can be called earlier to remove the listener before reaching the counter limit. + +Example: +```go +// Listen for the first 3 save events +cleanup := app.OnMultipleEvent("document-save", func(event *CustomEvent) { + fmt.Printf("Document saved: %s\n", event.Data.(string)) +}, 3) +```
22-26: Expand ResetEvents documentation with usage guidance.The documentation should clarify:
- Whether it affects both event hooks and listeners
- Its impact on application events vs custom events
- Use cases for when to use this vs individual cleanup functions
- Any performance considerations for large applications
Add the following content:
`ResetEvents()` removes all event listeners for all application events. + +This function: +- Removes all custom event listeners registered via OnEvent +- Does not affect hooks registered via RegisterApplicationEventHook + +Use this function when you need to: +- Clean up all event listeners during application shutdown +- Reset the application state +- Remove all listeners before setting up a new configuration
35-39: Clarify the relationship between hooks and event listeners.The documentation should:
- Explain the difference between hooks and event listeners
- Provide clear use cases for when to use each
- Include examples showing the execution order
Add the following content:
`RegisterApplicationEventHook()` registers a callback to be triggered based on specific application events. + +Hooks differ from event listeners in several ways: +- Hooks are executed before event listeners +- Hooks are typically used for critical system operations +- Hooks should be used sparingly and for essential operations only + +Example showing execution order: +```go +// This hook executes first +app.RegisterApplicationEventHook(events.ApplicationStarted, func(event *ApplicationEvent) { + fmt.Println("1. Hook: Application is starting...") +}) + +// This listener executes second +app.OnApplicationEvent(events.ApplicationStarted, func(event *ApplicationEvent) { + fmt.Println("2. Listener: Application has started!") +}) +```mkdocs-website/docs/en/API/events_windows.md (1)
1-79: Consider enhancing the documentation with additional details.To make this documentation more valuable for developers, consider adding:
- Code examples showing how to subscribe to and handle these events
- Event payload/data structure documentation where applicable
- Information about event ordering and lifecycle (e.g., which events fire in sequence during window state changes)
Would you like me to help generate example code snippets and additional documentation sections?
🧰 Tools
🪛 LanguageTool
[uncategorized] ~5-~5: Loose punctuation mark.
Context: ...ntsevents.Windows.AppicationStarted: Triggered when the application starts...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~8-~8: Loose punctuation mark.
Context: ...sevents.Windows.SystemThemeChanged: Triggered when the system theme chang...(UNLIKELY_OPENING_PUNCTUATION)
[grammar] ~9-~9: Did you mean “themes”?
Context: ...Changed: Triggered when the system theme changesevents.Windows.APMPowerStatus...(WRB_DT_NN_VB)
[uncategorized] ~11-~11: Loose punctuation mark.
Context: ...events.Windows.APMPowerStatusChange: Triggered when the system power statu...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~14-~14: Loose punctuation mark.
Context: ...s changesevents.Windows.APMSuspend: Triggered when the system suspends `...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~17-~17: Loose punctuation mark.
Context: ...dsevents.Windows.APMResumeAutomatic: Triggered when the system resumes aft...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~20-~20: Loose punctuation mark.
Context: ...leepevents.Windows.APMResumeSuspent: Triggered when the system resumes aft...(UNLIKELY_OPENING_PUNCTUATION)
[grammar] ~21-~21: The verb ‘suspend’ does not usually follow articles like ‘a’. Check that ‘suspend’ is spelled correctly; using ‘suspend’ as a noun may be non-standard.
Context: ...Triggered when the system resumes after a suspend and resume was triggered by the user #...(A_INFINITIVE)
[uncategorized] ~25-~25: Loose punctuation mark.
Context: ...nts.Windows.WebviewNavigationCompleted` : Triggered when the webview navigation...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~28-~28: Loose punctuation mark.
Context: ...pletedevents.Windows.WIndowInactive: Triggered when the window is inactive...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~31-~31: Loose punctuation mark.
Context: ...inactiveevents.Windows.WindowActive: Triggered when the window is active ...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~34-~34: Loose punctuation mark.
Context: ...is activeevents.Windows.ClickActive: Triggered when the window is actived ...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~37-~37: Loose punctuation mark.
Context: ... clickevents.Windows.MaximiseActive: Triggered when the window is maximise...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~40-~40: Loose punctuation mark.
Context: ... maximisedevents.Windows.UnMaximise: Triggered when the window is unmaximi...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~43-~43: Loose punctuation mark.
Context: ...nmaximisedevents.Windows.Fullscreen: Triggered when the window is set to f...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~46-~46: Loose punctuation mark.
Context: ...llscreenevents.Windows.UnFullscreen: Triggered when the window is unfullsc...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~49-~49: Loose punctuation mark.
Context: ...creenedevents.Windows.WindowRestore: Triggered when the window is restored...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~52-~52: Loose punctuation mark.
Context: ...storedevents.Windows.WindowMinimise: Triggered when the window is minimise...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~55-~55: Loose punctuation mark.
Context: ...isedevents.Windows.WindowUnminimise: Triggered when the window is unminimi...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~58-~58: Loose punctuation mark.
Context: ...minimisedevents.Windows.WindowClose: Triggered before the window closes `e...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~63-~63: Loose punctuation mark.
Context: ...focusevents.Windows.WindowKillFocus: Triggered when the window loses keybo...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~66-~66: Loose punctuation mark.
Context: ...focusevents.Windows.Window.DragDrop: Triggered when files are dropped on t...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~69-~69: Loose punctuation mark.
Context: ...indowevents.Windows.WindowDragEnter: Triggered when a drag enters the wind...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~72-~72: Loose punctuation mark.
Context: ...indowevents.Windows.WindowDragLeave: Triggered when a drag leaves the wind...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~75-~75: Loose punctuation mark.
Context: ...windowevents.Windows.WindowDragOver: Triggered when a drag is over the win...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~78-~78: Loose punctuation mark.
Context: ... windowevents.Windows.WindowDidMove: Triggered after a window has moved(UNLIKELY_OPENING_PUNCTUATION)
mkdocs-website/docs/en/API/event_hooks.md (4)
4-4: Fix typo in commentThere's a typo in the comment: "Notifcation" should be "Notification"
-// Notifcation of application start +// Notification of application start
42-46: Improve formatting consistency in event descriptionsRemove extra spaces before colons in event descriptions for better formatting consistency.
-`events.Common.ApplicationStarted` : Triggered when the application starts +`events.Common.ApplicationStarted`: Triggered when the application starts -`events.Common.ThemeChanged` : Triggered when the application theme changes +`events.Common.ThemeChanged`: Triggered when the application theme changes🧰 Tools
🪛 LanguageTool
[uncategorized] ~42-~42: Loose punctuation mark.
Context: ...e.events.Common.ApplicationStarted` : Triggered when the application starts...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~45-~45: Loose punctuation mark.
Context: ...on startsevents.Common.ThemeChanged: Triggered when the application theme ...(UNLIKELY_OPENING_PUNCTUATION)
[grammar] ~46-~46: Did you mean “themes”?
Context: ...ged: Triggered when the application theme changes ### Window Eventsevents.Co...(WRB_DT_NN_VB)
114-114: Fix hyphenation in headingFor technical writing consistency, "OS-Specific" should be hyphenated when used as a modifier.
-### OS Specific Events +### OS-Specific Events🧰 Tools
🪛 LanguageTool
[uncategorized] ~114-~114: When ‘OS-Specific’ is used as a modifier, it is usually spelled with a hyphen.
Context: ...iggered when the window is resized ### OS Specific Events --8<-- ./docs/en/API/events_linu...(SPECIFIC_HYPHEN)
1-119: Consider enhancing documentation with more detailsThe documentation could be more helpful by including:
- Event payload information for each event type
- Common use cases or scenarios for each event
- Platform-specific behavior notes where applicable
- Code examples showing how to access event data
This would help developers better understand how to effectively use these events in their applications.
Would you like me to provide a template for the enhanced documentation structure?
🧰 Tools
🪛 LanguageTool
[uncategorized] ~42-~42: Loose punctuation mark.
Context: ...e.events.Common.ApplicationStarted` : Triggered when the application starts...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~45-~45: Loose punctuation mark.
Context: ...on startsevents.Common.ThemeChanged: Triggered when the application theme ...(UNLIKELY_OPENING_PUNCTUATION)
[grammar] ~46-~46: Did you mean “themes”?
Context: ...ged: Triggered when the application theme changes ### Window Eventsevents.Co...(WRB_DT_NN_VB)
[uncategorized] ~51-~51: Loose punctuation mark.
Context: ...ventsevents.Common.WindowMaximised: Triggered when the window is maximise...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~54-~54: Loose punctuation mark.
Context: ...isedevents.Common.WindowUnmaximised: Triggered when the window is unmaximi...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~57-~57: Loose punctuation mark.
Context: ...misedevents.Common.WindowMinimised: Triggered when the window is minimise...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~60-~60: Loose punctuation mark.
Context: ...isedevents.Common.WindowUnminimised: Triggered when the window is unminimi...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~63-~63: Loose punctuation mark.
Context: ...misedevents.Common.WindowFullscreen: Triggered when the window is set to f...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~66-~66: Loose punctuation mark.
Context: ...eenevents.Common.WindowUnfullscreen: Triggered when the window is unfullsc...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~69-~69: Loose punctuation mark.
Context: ...creenedevents.Common.WindowRestored: Triggered when the window is restored...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~72-~72: Loose punctuation mark.
Context: ...restoredevents.Common.WindowClosing: Triggered before the window closes `...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~75-~75: Loose punctuation mark.
Context: ...dow closesevents.Common.WindowZoom: Triggered when the window is zoomed ...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~78-~78: Loose punctuation mark.
Context: ...s zoomedevents.Common.WindowZoomOut: Triggered when the window is zoomed o...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~81-~81: Loose punctuation mark.
Context: ...omed outevents.Common.WindowZoomIn: Triggered when the window is zoomed i...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~84-~84: Loose punctuation mark.
Context: ...med inevents.Common.WindowZoomReset: Triggered when the window zoom is res...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~87-~87: Loose punctuation mark.
Context: ... is resetevents.Common.WindowFocus: Triggered when the window gains focus...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~90-~90: Loose punctuation mark.
Context: ...focusevents.Common.WindowLostFocus: Triggered when the window loses focus...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~93-~93: Loose punctuation mark.
Context: ...loses focusevents.Common.WindowShow: Triggered when the window is shown `...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~96-~96: Loose punctuation mark.
Context: ...w is shownevents.Common.WindowHide: Triggered when the window is hidden ...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~99-~99: Loose punctuation mark.
Context: ...iddenevents.Common.WindowDPIChanged: Triggered when the window DPI changes...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~102-~102: Loose punctuation mark.
Context: ...gesevents.Common.WindowFilesDropped: Triggered when files are dropped on t...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~105-~105: Loose punctuation mark.
Context: ...dowevents.Common.WindowRuntimeReady: Triggered when the window runtime is ...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~108-~108: Loose punctuation mark.
Context: ...s readyevents.Common.WindowDidMove: Triggered when the window is moved `...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~111-~111: Loose punctuation mark.
Context: ...movedevents.Common.WindowDidResize:Triggered when the window is resized ##...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~114-~114: When ‘OS-Specific’ is used as a modifier, it is usually spelled with a hyphen.
Context: ...iggered when the window is resized ### OS Specific Events --8<-- ./docs/en/API/events_linu...(SPECIFIC_HYPHEN)
mkdocs-website/docs/en/API/events.md (2)
1-8: Consider adding a brief introduction to the Events sectionThe documentation would benefit from a short introduction explaining what events are and their role in the Wails framework before diving into specific sections.
69-71: Clarify event removal documentationThe explanation about event removal methods could be clearer and more structured.
-There are a few ways to remove events that are registered. All of the registration functions return a function that can be called to remove the event listeneer -in the frontend. There are additional functions provided to help remove events as well. +Events can be removed in two ways: +1. Using the cleanup function returned by event registration methods in the frontend +2. Using dedicated event removal functions available in both frontend and backend🧰 Tools
🪛 LanguageTool
[style] ~69-~69: Consider removing “of” to be more concise
Context: ...s to remove events that are registered. All of the registration functions return a functio...(ALL_OF_THE)
mkdocs-website/docs/en/API/events_mac.md (3)
1-4: Update branding: Use "macOS" instead of "MacOS".According to Apple's branding guidelines, the operating system should be written as "macOS" rather than "MacOS".
-#### MacOS Events +#### macOS Events🧰 Tools
🪛 LanguageTool
[grammar] ~1-~1: The operating system from Apple is written “macOS”.
Context: #### MacOS Events ##### Application Events `even...(MAC_OS)
229-234: Use consistent hyphenation for screen-related terms.For better readability and adherence to common technical writing practices, "off screen" and "on screen" should be hyphenated when used as compound modifiers.
-: Triggered when the window is ordered off screen +: Triggered when the window is ordered off-screen -: Triggered when the window is ordered on screen +: Triggered when the window is ordered on-screen🧰 Tools
🪛 LanguageTool
[uncategorized] ~229-~229: Loose punctuation mark.
Context: ...devents.Mac.WindowDidOrderOffScreen: Triggered when the window is ordered ...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~230-~230: The adjective or adverb “off-screen” is spelled with a hyphen.
Context: ... Triggered when the window is ordered off screenevents.Mac.WindowDidOrderOnScreen: ...(ON_OFF_SCREEN_HYPHEN)
[uncategorized] ~232-~232: Loose punctuation mark.
Context: ...enevents.Mac.WindowDidOrderOnScreen: Triggered when the window is ordered ...(UNLIKELY_OPENING_PUNCTUATION)
310-315: Use consistent hyphenation for screen-related terms.For better readability and adherence to common technical writing practices, "off screen" and "on screen" should be hyphenated when used as compound modifiers.
-: Triggered when the window will order off screen +: Triggered when the window will order off-screen -: Triggered when the window will order on screen +: Triggered when the window will order on-screen🧰 Tools
🪛 LanguageTool
[uncategorized] ~310-~310: Loose punctuation mark.
Context: ...events.Mac.WindowWillOrderOffScreen: Triggered when the window will order ...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~311-~311: The adjective or adverb “off-screen” is spelled with a hyphen.
Context: ... Triggered when the window will order off screenevents.Mac.WindowWillOrderOnScreen:...(ON_OFF_SCREEN_HYPHEN)
[uncategorized] ~313-~313: Loose punctuation mark.
Context: ...nevents.Mac.WindowWillOrderOnScreen: Triggered when the window will order ...(UNLIKELY_OPENING_PUNCTUATION)
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
📒 Files selected for processing (8)
mkdocs-website/docs/en/API/application_events.md(1 hunks)mkdocs-website/docs/en/API/event_hooks.md(1 hunks)mkdocs-website/docs/en/API/events.md(1 hunks)mkdocs-website/docs/en/API/events_linux.md(1 hunks)mkdocs-website/docs/en/API/events_mac.md(1 hunks)mkdocs-website/docs/en/API/events_windows.md(1 hunks)mkdocs-website/docs/en/changelog.md(1 hunks)mkdocs-website/mkdocs.yml(2 hunks)
🧰 Additional context used
🪛 LanguageTool
mkdocs-website/docs/en/API/event_hooks.md
[uncategorized] ~42-~42: Loose punctuation mark.
Context: ...e. events.Common.ApplicationStarted` : Triggered when the application starts...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~45-~45: Loose punctuation mark.
Context: ...on starts events.Common.ThemeChanged : Triggered when the application theme ...
(UNLIKELY_OPENING_PUNCTUATION)
[grammar] ~46-~46: Did you mean “themes”?
Context: ...ged: Triggered when the application theme changes ### Window Events events.Co...
(WRB_DT_NN_VB)
[uncategorized] ~51-~51: Loose punctuation mark.
Context: ...vents events.Common.WindowMaximised : Triggered when the window is maximise...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~54-~54: Loose punctuation mark.
Context: ...ised events.Common.WindowUnmaximised : Triggered when the window is unmaximi...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~57-~57: Loose punctuation mark.
Context: ...mised events.Common.WindowMinimised : Triggered when the window is minimise...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~60-~60: Loose punctuation mark.
Context: ...ised events.Common.WindowUnminimised : Triggered when the window is unminimi...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~63-~63: Loose punctuation mark.
Context: ...mised events.Common.WindowFullscreen : Triggered when the window is set to f...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~66-~66: Loose punctuation mark.
Context: ...een events.Common.WindowUnfullscreen : Triggered when the window is unfullsc...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~69-~69: Loose punctuation mark.
Context: ...creened events.Common.WindowRestored : Triggered when the window is restored...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~72-~72: Loose punctuation mark.
Context: ...restored events.Common.WindowClosing : Triggered before the window closes `...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~75-~75: Loose punctuation mark.
Context: ...dow closes events.Common.WindowZoom : Triggered when the window is zoomed ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~78-~78: Loose punctuation mark.
Context: ...s zoomed events.Common.WindowZoomOut : Triggered when the window is zoomed o...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~81-~81: Loose punctuation mark.
Context: ...omed out events.Common.WindowZoomIn : Triggered when the window is zoomed i...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~84-~84: Loose punctuation mark.
Context: ...med in events.Common.WindowZoomReset : Triggered when the window zoom is res...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~87-~87: Loose punctuation mark.
Context: ... is reset events.Common.WindowFocus : Triggered when the window gains focus...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~90-~90: Loose punctuation mark.
Context: ...focus events.Common.WindowLostFocus : Triggered when the window loses focus...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~93-~93: Loose punctuation mark.
Context: ...loses focus events.Common.WindowShow : Triggered when the window is shown `...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~96-~96: Loose punctuation mark.
Context: ...w is shown events.Common.WindowHide : Triggered when the window is hidden ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~99-~99: Loose punctuation mark.
Context: ...idden events.Common.WindowDPIChanged : Triggered when the window DPI changes...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~102-~102: Loose punctuation mark.
Context: ...ges events.Common.WindowFilesDropped : Triggered when files are dropped on t...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~105-~105: Loose punctuation mark.
Context: ...dow events.Common.WindowRuntimeReady : Triggered when the window runtime is ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~108-~108: Loose punctuation mark.
Context: ...s ready events.Common.WindowDidMove : Triggered when the window is moved `...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~111-~111: Loose punctuation mark.
Context: ...moved events.Common.WindowDidResize :Triggered when the window is resized ##...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~114-~114: When ‘OS-Specific’ is used as a modifier, it is usually spelled with a hyphen.
Context: ...iggered when the window is resized ### OS Specific Events --8<-- ./docs/en/API/events_linu...
(SPECIFIC_HYPHEN)
mkdocs-website/docs/en/API/events.md
[style] ~11-~11: As a shorter alternative for ‘able to’, consider using “can”.
Context: ... both the frontend and backend. Events are able to emitted at both the application and the...
(BE_ABLE_TO)
[uncategorized] ~36-~36: Loose punctuation mark.
Context: ...on.EmitEvent(name string, data ...any)` : Emits an event from the application i...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~39-~39: Loose punctuation mark.
Context: ...ow.EmitEvent(name string, data ...any)` : Emits an event from the window instan...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~42-~42: Loose punctuation mark.
Context: ...nts.Emit(event:wails.Events.EventData)` : Emits an event from the frontend send...
(UNLIKELY_OPENING_PUNCTUATION)
[duplication] ~45-~45: Possible typo: you repeated a word
Context: ...escript type WailsEvent ### Receiving Events Events can be received on the application inst...
(ENGLISH_WORD_REPEAT_RULE)
[grammar] ~46-~46: The verb ‘depend’ requires the preposition ‘on’ (or ‘upon’).
Context: ...frontend with varying levels of control depending how you chose to recieve them Golang ...
(DEPEND_ON)
[uncategorized] ~51-~51: Loose punctuation mark.
Context: ...ame string, handler func(data ...any))` : Registers an event on the application...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~54-~54: Loose punctuation mark.
Context: ... handler func(data ...any), count int)` : Registers an event on the application...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~59-~59: Loose punctuation mark.
Context: ...ts.On(name: string, callback: ()=>void)`, : Registers an event on the frontend...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~62-~62: Loose punctuation mark.
Context: ....Once(name: string, callback: ()=>void)`, : Registers an event on the frontend...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~65-~65: Loose punctuation mark.
Context: ...ing, callback: ()=>void, count: number)`, : Registers an event on the frontend...
(UNLIKELY_OPENING_PUNCTUATION)
[style] ~69-~69: Consider removing “of” to be more concise
Context: ...s to remove events that are registered. All of the registration functions return a functio...
(ALL_OF_THE)
[uncategorized] ~74-~74: Loose punctuation mark.
Context: ...ame string, ...additionalNames string)` : Removes an event listener with the sp...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~77-~77: Loose punctuation mark.
Context: ...ficed name application.ResetEvents() : Removes all registered events and hoo...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~82-~82: Loose punctuation mark.
Context: ...ooks Frontend wails.Events.OffAll() : Removes all registered events `waill...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~85-~85: Loose punctuation mark.
Context: ...ents waills.Events.Off(name: string) : Removes an event listener with the sp...
(UNLIKELY_OPENING_PUNCTUATION)
mkdocs-website/docs/en/API/events_linux.md
[uncategorized] ~5-~5: Loose punctuation mark.
Context: ...ents events.Linux.ApplicationStartup : Triggered when the application starts...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~8-~8: Loose punctuation mark.
Context: ...arts events.Linux.SystemThemeChanged : Triggered when the system theme chang...
(UNLIKELY_OPENING_PUNCTUATION)
[grammar] ~9-~9: Did you mean “themes”?
Context: ...eChanged: Triggered when the system theme changes ##### Window Events events.L...
(WRB_DT_NN_VB)
[uncategorized] ~13-~13: Loose punctuation mark.
Context: ...vents events.Linux.WindowLoadChanged : Triggered when the window load change...
(UNLIKELY_OPENING_PUNCTUATION)
[grammar] ~14-~14: Did you mean “loads”?
Context: ...dChanged: Triggered when the window load changes events.Linux.WindowDeleteEven...
(WRB_DT_NN_VB)
[uncategorized] ~16-~16: Loose punctuation mark.
Context: ...anges events.Linux.WindowDeleteEvent : Triggered when the window is deleted ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~19-~19: Loose punctuation mark.
Context: ...s deleted events.Linux.WindowDidMove : Triggered when the window is moved `...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~22-~22: Loose punctuation mark.
Context: ...s moved events.Linux.WindowDidResize : Triggered when the window is resized ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~25-~25: Loose punctuation mark.
Context: ...resized events.Linux.WindowDidResize : Triggered when the window is resized ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~28-~28: Loose punctuation mark.
Context: ...s resized events.Linux.WindowFocusIn : Triggered when the window gains focus...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~31-~31: Loose punctuation mark.
Context: ...ns focus events.Linux.WindowFocusOut : Triggered when the window loses focus...
(UNLIKELY_OPENING_PUNCTUATION)
mkdocs-website/docs/en/API/events_mac.md
[grammar] ~1-~1: The operating system from Apple is written “macOS”.
Context: #### MacOS Events ##### Application Events `even...
(MAC_OS)
[uncategorized] ~5-~5: Loose punctuation mark.
Context: ...events.Mac.ApplicationDidBecomeActive : Triggered when the application become...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~8-~8: Loose punctuation mark.
Context: ....ApplicationDidChangeBackingProperties` : Triggered when the application change...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~11-~11: Loose punctuation mark.
Context: ...AppicationDidChangeEffectiveAppearance` : Triggered when the application change...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~14-~14: Loose punctuation mark.
Context: ... events.Mac.ApplicationDidChangeIcon : Triggered when the application change...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~17-~17: Loose punctuation mark.
Context: ...Mac.ApplicationDidChangeOcclusionState` : Triggered when the application change...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~20-~20: Loose punctuation mark.
Context: ...c.ApplicationDidChangeScreenParameters` : Triggered when the application change...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~23-~23: Loose punctuation mark.
Context: ...Mac.ApplicationDidChangeStatusBarFrame` : Triggered when the application change...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~26-~26: Loose punctuation mark.
Context: ...licationDidChangeStatusBarOrientation` : Triggered when the application change...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~29-~29: Loose punctuation mark.
Context: ...ents.Mac.ApplicationDidFinishLaunching` : Triggered when the application finish...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~32-~32: Loose punctuation mark.
Context: ...ApplicationDidResignActiveNotification` : Triggered when the application is no ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~35-~35: Loose punctuation mark.
Context: ...active events.Mac.ApplicationDidHide : Triggered when the application is hid...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~38-~38: Loose punctuation mark.
Context: ...dden events.Mac.ApplicationDidUpdate : Triggered when the application update...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~41-~41: Loose punctuation mark.
Context: ...events.Mac.ApplicationWillBecomeActive` : Triggered when the application is abo...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~44-~44: Loose punctuation mark.
Context: ...nts.Mac.ApplicationWillFinishLaunching` : Triggered when the application is abo...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~47-~47: Loose punctuation mark.
Context: ...ching events.Mac.ApplicationWillHide : Triggered when the application is abo...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~50-~50: Loose punctuation mark.
Context: ...events.Mac.ApplicationWillResignActive` : Triggered when the application is abo...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~53-~53: Loose punctuation mark.
Context: ... events.Mac.ApplicationWillTerminate : Triggered when the application is abo...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~56-~56: Loose punctuation mark.
Context: ...ate events.Mac.ApplicationWillUnhide : Triggered when the application is abo...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~59-~59: Loose punctuation mark.
Context: ...de events.Mac.ApplicationWillUpdate : Triggered when the application is abo...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~62-~62: Loose punctuation mark.
Context: ...events.Mac.ApplicationDidChangeTheme : Triggered when the application change...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~65-~65: Loose punctuation mark.
Context: ...hanges theme events.Mac.MenuWillOpen : Triggered when the menu is about to o...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~68-~68: Loose punctuation mark.
Context: ...about to open events.Mac.MenuDidOpen : Triggered when the menu opens `event...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~71-~71: Loose punctuation mark.
Context: ...e menu opens events.Mac.MenuDidClose : Triggered when the menu closes `even...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~74-~74: Loose punctuation mark.
Context: ...closes events.Mac.MenuWillSendAction : Triggered when the menu is about to s...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~77-~77: Loose punctuation mark.
Context: ... action events.Mac.MenuDidSendAction : Triggered when the menu sends an acti...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~80-~80: Loose punctuation mark.
Context: ...ion events.Mac.MenuWillHighlightItem : Triggered when the menu is about to h...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~83-~83: Loose punctuation mark.
Context: ...item events.Mac.MenuDidHighlightItem : Triggered when the menu highlights an...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~86-~86: Loose punctuation mark.
Context: ... item events.Mac.MenuWillDisplayItem : Triggered when the menu is about to d...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~89-~89: Loose punctuation mark.
Context: ...n item events.Mac.MenuDidDisplayItem : Triggered when the menu displays an i...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~92-~92: Loose punctuation mark.
Context: ...s an item events.Mac.MenuWillAddItem : Triggered when the menu is about to a...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~95-~95: Loose punctuation mark.
Context: ...dd an item events.Mac.MenuDidAddItem : Triggered when the menu adds an item ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~98-~98: Loose punctuation mark.
Context: ...n item events.Mac.MenuWillRemoveItem : Triggered when the menu is about to r...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~101-~101: Loose punctuation mark.
Context: ...an item events.Mac.MenuDidRemoveItem : Triggered when the menu removes an it...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~104-~104: Loose punctuation mark.
Context: ...tem events.Mac.MenuWillBeginTracking : Triggered when the menu is about to b...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~107-~107: Loose punctuation mark.
Context: ...king events.Mac.MenuDidBeginTracking : Triggered when the menu begins tracki...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~110-~110: Loose punctuation mark.
Context: ...cking events.Mac.MenuWillEndTracking : Triggered when the menu is about to e...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~113-~113: Loose punctuation mark.
Context: ...acking events.Mac.MenuDidEndTracking : Triggered when the menu ends tracking...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~116-~116: Loose punctuation mark.
Context: ...s tracking events.Mac.MenuWillUpdate : Triggered when the menu is about to u...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~119-~119: Loose punctuation mark.
Context: ...t to update events.Mac.MenuDidUpdate : Triggered when the menu updates `eve...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~122-~122: Loose punctuation mark.
Context: ...enu updates events.Mac.MenuWillPopUp : Triggered when the menu is about to p...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~125-~125: Loose punctuation mark.
Context: ...ut to pop up events.Mac.MenuDidPopUp : Triggered when the menu pops up `eve...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~128-~128: Loose punctuation mark.
Context: ... events.Mac.MenuWillSendActionToItem : Triggered when the menu is about to s...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~131-~131: Loose punctuation mark.
Context: ...m events.Mac.MenuDidSendActionToItem : Triggered when the menu sends an acti...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~136-~136: Loose punctuation mark.
Context: ...Events events.Mac.WindowDidBecomeKey : Triggered when the window becomes key...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~139-~139: Loose punctuation mark.
Context: ...s key events.Mac.WindowDidBecomeMain : Triggered when the window becomes mai...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~142-~142: Loose punctuation mark.
Context: ... main events.Mac.WindowDidBeginSheet : Triggered when the window begins a sh...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~145-~145: Loose punctuation mark.
Context: ...heet events.Mac.WindowDidChangeAlpha : Triggered when the window alpha chang...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~148-~148: Loose punctuation mark.
Context: ...nts.Mac.WindowDidChangeBackingLocation` : Triggered when the window backing loc...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~151-~151: Loose punctuation mark.
Context: ...s.Mac.WindowDidChangeBackingProperties` : Triggered when the window backing pro...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~154-~154: Loose punctuation mark.
Context: ....Mac.WindowDidChangeCollectionBehavior` : Triggered when the window collection ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~157-~157: Loose punctuation mark.
Context: ...Mac.WindowDidChangeEffectiveAppearance` : Triggered when the window effective a...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~160-~160: Loose punctuation mark.
Context: ...ents.Mac.WindowDidChangeOcclusionState` : Triggered when the window occlusion s...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~163-~163: Loose punctuation mark.
Context: ...events.Mac.WindowDidChangeOrderingMode` : Triggered when the window ordering mo...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~166-~166: Loose punctuation mark.
Context: ...ges events.Mac.WindowDidChangeScreen : Triggered when the window screen chan...
(UNLIKELY_OPENING_PUNCTUATION)
[grammar] ~167-~167: Did you mean “screens”?
Context: ...geScreen: Triggered when the window screen changes events.Mac.WindowDidChangeScr...
(WRB_DT_NN_VB)
[uncategorized] ~169-~169: Loose punctuation mark.
Context: ...ts.Mac.WindowDidChangeScreenParameters` : Triggered when the window screen para...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~172-~172: Loose punctuation mark.
Context: ...vents.Mac.WindowDidChangeScreenProfile` : Triggered when the window screen prof...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~175-~175: Loose punctuation mark.
Context: ...events.Mac.WindowDidChangeScreenSpace : Triggered when the window screen spac...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~178-~178: Loose punctuation mark.
Context: ...c.WindowDidChangeScreenSpaceProperties` : Triggered when the window screen spac...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~181-~181: Loose punctuation mark.
Context: ...events.Mac.WindowDidChangeSharingType : Triggered when the window sharing typ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~184-~184: Loose punctuation mark.
Context: ...nges events.Mac.WindowDidChangeSpace : Triggered when the window space chang...
(UNLIKELY_OPENING_PUNCTUATION)
[grammar] ~185-~185: Did you mean “spaces”?
Context: ...ngeSpace: Triggered when the window space changes events.Mac.WindowDidChangeSpa...
(WRB_DT_NN_VB)
[uncategorized] ~187-~187: Loose punctuation mark.
Context: ...s.Mac.WindowDidChangeSpaceOrderingMode` : Triggered when the window space order...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~190-~190: Loose punctuation mark.
Context: ...nges events.Mac.WindowDidChangeTitle : Triggered when the window title chang...
(UNLIKELY_OPENING_PUNCTUATION)
[grammar] ~191-~191: Did you mean “titles”?
Context: ...ngeTitle: Triggered when the window title changes events.Mac.WindowDidChangeToo...
(WRB_DT_NN_VB)
[uncategorized] ~193-~193: Loose punctuation mark.
Context: ...es events.Mac.WindowDidChangeToolbar : Triggered when the window toolbar cha...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~196-~196: Loose punctuation mark.
Context: ... events.Mac.WindowDidChangeVisibility : Triggered when the window visibility ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~199-~199: Loose punctuation mark.
Context: ...es events.Mac.WindowDidDeminiaturize : Triggered when the window is deminiat...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~202-~202: Loose punctuation mark.
Context: ...turized events.Mac.WindowDidEndSheet : Triggered when the window ends a shee...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~205-~205: Loose punctuation mark.
Context: ... events.Mac.WindowDidEnterFullScreen : Triggered when the window enters full...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~208-~208: Loose punctuation mark.
Context: ...vents.Mac.WindowDidEnterVersionBrowser` : Triggered when the window enters vers...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~211-~211: Loose punctuation mark.
Context: ...r events.Mac.WindowDidExitFullScreen : Triggered when the window exits fulls...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~214-~214: Loose punctuation mark.
Context: ...events.Mac.WindowDidExitVersionBrowser` : Triggered when the window exits versi...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~217-~217: Loose punctuation mark.
Context: ...n browser events.Mac.WindowDidExpose : Triggered when the window is exposed ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~220-~220: Loose punctuation mark.
Context: ...is exposed events.Mac.WindowDidFocus : Triggered when the window is focused ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~223-~223: Loose punctuation mark.
Context: ...used events.Mac.WindowDidMiniaturize : Triggered when the window is miniatur...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~226-~226: Loose punctuation mark.
Context: ...iniaturized events.Mac.WindowDidMove : Triggered when the window is moved `...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~229-~229: Loose punctuation mark.
Context: ...d events.Mac.WindowDidOrderOffScreen : Triggered when the window is ordered ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~230-~230: The adjective or adverb “off-screen” is spelled with a hyphen.
Context: ... Triggered when the window is ordered off screen events.Mac.WindowDidOrderOnScreen : ...
(ON_OFF_SCREEN_HYPHEN)
[uncategorized] ~232-~232: Loose punctuation mark.
Context: ...en events.Mac.WindowDidOrderOnScreen : Triggered when the window is ordered ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~235-~235: Loose punctuation mark.
Context: ...screen events.Mac.WindowDidResignKey : Triggered when the window resigns key...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~238-~238: Loose punctuation mark.
Context: ...s key events.Mac.WindowDidResignMain : Triggered when the window resigns mai...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~241-~241: Loose punctuation mark.
Context: ...igns main events.Mac.WindowDidResize : Triggered when the window is resized ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~244-~244: Loose punctuation mark.
Context: ...s resized events.Mac.WindowDidUpdate : Triggered when the window updates `e...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~247-~247: Loose punctuation mark.
Context: ...ates events.Mac.WindowDidUpdateAlpha : Triggered when the window alpha updat...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~250-~250: Loose punctuation mark.
Context: ....Mac.WindowDidUpdateCollectionBehavior` : Triggered when the window collection ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~253-~253: Loose punctuation mark.
Context: ...ac.WindowDidUpdateCollectionProperties` : Triggered when the window collection ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~256-~256: Loose punctuation mark.
Context: ...ate events.Mac.WindowDidUpdateShadow : Triggered when the window shadow upda...
(UNLIKELY_OPENING_PUNCTUATION)
[grammar] ~257-~257: Did you mean “shadows”?
Context: ...teShadow: Triggered when the window shadow updates events.Mac.WindowDidUpdateTit...
(WRB_DT_NN_VB)
[uncategorized] ~259-~259: Loose punctuation mark.
Context: ...ates events.Mac.WindowDidUpdateTitle : Triggered when the window title updat...
(UNLIKELY_OPENING_PUNCTUATION)
[grammar] ~260-~260: Did you mean “titles”?
Context: ...ateTitle: Triggered when the window title updates events.Mac.WindowDidUpdateToo...
(WRB_DT_NN_VB)
[uncategorized] ~262-~262: Loose punctuation mark.
Context: ...es events.Mac.WindowDidUpdateToolbar : Triggered when the window toolbar upd...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~265-~265: Loose punctuation mark.
Context: ... events.Mac.WindowDidUpdateVisibility : Triggered when the window visibility ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~268-~268: Loose punctuation mark.
Context: ...updates events.Mac.WindowShouldClose : Triggered when the window should clos...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~271-~271: Loose punctuation mark.
Context: ...close events.Mac.WindowWillBecomeKey : Triggered when the window will become...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~274-~274: Loose punctuation mark.
Context: ... key events.Mac.WindowWillBecomeMain : Triggered when the window will become...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~277-~277: Loose punctuation mark.
Context: ...main events.Mac.WindowWillBeginSheet : Triggered when the window will begin ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~280-~280: Loose punctuation mark.
Context: ...vents.Mac.WindowWillChangeOrderingMode` : Triggered when the window will change...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~283-~283: Loose punctuation mark.
Context: ...ring mode events.Mac.WindowWillClose : Triggered when the window will close ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~286-~286: Loose punctuation mark.
Context: ...e events.Mac.WindowWillDeminiaturize : Triggered when the window will demini...
(UNLIKELY_OPENING_PUNCTUATION)
[grammar] ~287-~287: Did you mean “wills”?
Context: ...iaturize: Triggered when the window will deminiaturize events.Mac.WindowWillEn...
(WRB_DT_NN_VB)
[uncategorized] ~289-~289: Loose punctuation mark.
Context: ... events.Mac.WindowWillEnterFullScreen : Triggered when the window will enter ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~292-~292: Loose punctuation mark.
Context: ...ents.Mac.WindowWillEnterVersionBrowser` : Triggered when the window will enter ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~295-~295: Loose punctuation mark.
Context: ... events.Mac.WindowWillExitFullScreen : Triggered when the window will exit f...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~298-~298: Loose punctuation mark.
Context: ...vents.Mac.WindowWillExitVersionBrowser` : Triggered when the window will exit v...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~301-~301: Loose punctuation mark.
Context: ...n browser events.Mac.WindowWillFocus : Triggered when the window will focus ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~304-~304: Loose punctuation mark.
Context: ...cus events.Mac.WindowWillMiniaturize : Triggered when the window will miniat...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~307-~307: Loose punctuation mark.
Context: ...iniaturize events.Mac.WindowWillMove : Triggered when the window will move ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~310-~310: Loose punctuation mark.
Context: ... events.Mac.WindowWillOrderOffScreen : Triggered when the window will order ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~311-~311: The adjective or adverb “off-screen” is spelled with a hyphen.
Context: ... Triggered when the window will order off screen events.Mac.WindowWillOrderOnScreen :...
(ON_OFF_SCREEN_HYPHEN)
[uncategorized] ~313-~313: Loose punctuation mark.
Context: ...n events.Mac.WindowWillOrderOnScreen : Triggered when the window will order ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~316-~316: Loose punctuation mark.
Context: ...een events.Mac.WindowWillResignMain` : Triggered when the window will resign...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~319-~319: Loose punctuation mark.
Context: ...ign main events.Mac.WindowWillResize : Triggered when the window will resize...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~322-~322: Loose punctuation mark.
Context: ... resize events.Mac.WindowWillUnfocus : Triggered when the window will unfocu...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~325-~325: Loose punctuation mark.
Context: ...unfocus events.Mac.WindowWillUpdate` : Triggered when the window will update...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~328-~328: Loose punctuation mark.
Context: ...ate events.Mac.WindowWillUpdateAlpha : Triggered when the window will update...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~331-~331: Loose punctuation mark.
Context: ...Mac.WindowWillUpdateCollectionBehavior` : Triggered when the window will update...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~334-~334: Loose punctuation mark.
Context: ...c.WindowWillUpdateCollectionProperties` : Triggered when the window will update...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~337-~337: Loose punctuation mark.
Context: ...es events.Mac.WindowWillUpdateShadow : Triggered when the window will update...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~340-~340: Loose punctuation mark.
Context: ...dow events.Mac.WindowWillUpdateTitle : Triggered when the window will update...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~343-~343: Loose punctuation mark.
Context: ...e events.Mac.WindowWillUpdateToolbar : Triggered when the window will update...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~346-~346: Loose punctuation mark.
Context: ...events.Mac.WindowWillUpdateVisibility : Triggered when the window will update...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~349-~349: Loose punctuation mark.
Context: ...events.Mac.WindowWillUseStandardFrame : Triggered when the window will use st...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~352-~352: Loose punctuation mark.
Context: ...c.WebviewDidStartProvisionalNavigation` : Triggered when the webview starts a p...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~355-~355: Loose punctuation mark.
Context: ...ServerRedirectForProvisionalNavigation` : Triggered when the webview receives a...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~358-~358: Loose punctuation mark.
Context: ...events.Mac.WebviewDidFinishNavigation : Triggered when the webview finishes n...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~361-~361: Loose punctuation mark.
Context: ...events.Mac.WebviewDidCommitNavigation : Triggered when the webview commits na...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~364-~364: Loose punctuation mark.
Context: ... events.Mac.WindowFileDraggingEntered : Triggered when files are dragged into...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~367-~367: Loose punctuation mark.
Context: ...events.Mac.WindowFileDraggingPerformed` : Triggered when files are dragged in t...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~370-~370: Loose punctuation mark.
Context: ... events.Mac.WindowFileDraggingExited : Triggered when files are dragged out ...
(UNLIKELY_OPENING_PUNCTUATION)
mkdocs-website/docs/en/API/events_windows.md
[uncategorized] ~5-~5: Loose punctuation mark.
Context: ...nts events.Windows.AppicationStarted : Triggered when the application starts...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~8-~8: Loose punctuation mark.
Context: ...s events.Windows.SystemThemeChanged : Triggered when the system theme chang...
(UNLIKELY_OPENING_PUNCTUATION)
[grammar] ~9-~9: Did you mean “themes”?
Context: ...Changed : Triggered when the system theme changes events.Windows.APMPowerStatus...
(WRB_DT_NN_VB)
[uncategorized] ~11-~11: Loose punctuation mark.
Context: ... events.Windows.APMPowerStatusChange : Triggered when the system power statu...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~14-~14: Loose punctuation mark.
Context: ...s changes events.Windows.APMSuspend : Triggered when the system suspends `...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~17-~17: Loose punctuation mark.
Context: ...ds events.Windows.APMResumeAutomatic : Triggered when the system resumes aft...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~20-~20: Loose punctuation mark.
Context: ...leep events.Windows.APMResumeSuspent : Triggered when the system resumes aft...
(UNLIKELY_OPENING_PUNCTUATION)
[grammar] ~21-~21: The verb ‘suspend’ does not usually follow articles like ‘a’. Check that ‘suspend’ is spelled correctly; using ‘suspend’ as a noun may be non-standard.
Context: ...Triggered when the system resumes after a suspend and resume was triggered by the user #...
(A_INFINITIVE)
[uncategorized] ~25-~25: Loose punctuation mark.
Context: ...nts.Windows.WebviewNavigationCompleted` : Triggered when the webview navigation...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~28-~28: Loose punctuation mark.
Context: ...pleted events.Windows.WIndowInactive : Triggered when the window is inactive...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~31-~31: Loose punctuation mark.
Context: ...inactive events.Windows.WindowActive : Triggered when the window is active ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~34-~34: Loose punctuation mark.
Context: ...is active events.Windows.ClickActive : Triggered when the window is actived ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~37-~37: Loose punctuation mark.
Context: ... click events.Windows.MaximiseActive : Triggered when the window is maximise...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~40-~40: Loose punctuation mark.
Context: ... maximised events.Windows.UnMaximise : Triggered when the window is unmaximi...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~43-~43: Loose punctuation mark.
Context: ...nmaximised events.Windows.Fullscreen : Triggered when the window is set to f...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~46-~46: Loose punctuation mark.
Context: ...llscreen events.Windows.UnFullscreen : Triggered when the window is unfullsc...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~49-~49: Loose punctuation mark.
Context: ...creened events.Windows.WindowRestore : Triggered when the window is restored...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~52-~52: Loose punctuation mark.
Context: ...stored events.Windows.WindowMinimise : Triggered when the window is minimise...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~55-~55: Loose punctuation mark.
Context: ...ised events.Windows.WindowUnminimise : Triggered when the window is unminimi...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~58-~58: Loose punctuation mark.
Context: ...minimised events.Windows.WindowClose : Triggered before the window closes `e...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~63-~63: Loose punctuation mark.
Context: ...focus events.Windows.WindowKillFocus : Triggered when the window loses keybo...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~66-~66: Loose punctuation mark.
Context: ...focus events.Windows.Window.DragDrop : Triggered when files are dropped on t...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~69-~69: Loose punctuation mark.
Context: ...indow events.Windows.WindowDragEnter : Triggered when a drag enters the wind...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~72-~72: Loose punctuation mark.
Context: ...indow events.Windows.WindowDragLeave : Triggered when a drag leaves the wind...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~75-~75: Loose punctuation mark.
Context: ...window events.Windows.WindowDragOver : Triggered when a drag is over the win...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~78-~78: Loose punctuation mark.
Context: ... window events.Windows.WindowDidMove : Triggered after a window has moved
(UNLIKELY_OPENING_PUNCTUATION)
🪛 Markdownlint
mkdocs-website/docs/en/API/events.md
95-95: Column: 1
Hard tabs
(MD010, no-hard-tabs)
96-96: Column: 1
Hard tabs
(MD010, no-hard-tabs)
97-97: Column: 1
Hard tabs
(MD010, no-hard-tabs)
108-108: Column: 1
Hard tabs
(MD010, no-hard-tabs)
109-109: Column: 1
Hard tabs
(MD010, no-hard-tabs)
122-122: Column: 1
Hard tabs
(MD010, no-hard-tabs)
123-123: Column: 1
Hard tabs
(MD010, no-hard-tabs)
124-124: Column: 1
Hard tabs
(MD010, no-hard-tabs)
125-125: Column: 1
Hard tabs
(MD010, no-hard-tabs)
93-93: Expected: indented; Actual: fenced
Code block style
(MD046, code-block-style)
106-106: Expected: indented; Actual: fenced
Code block style
(MD046, code-block-style)
120-120: Expected: indented; Actual: fenced
Code block style
(MD046, code-block-style)
🔇 Additional comments (8)
mkdocs-website/docs/en/API/events_linux.md (1)
1-4: LGTM! Clear and well-structured headers.
The documentation structure follows proper markdown hierarchy and organization.
mkdocs-website/docs/en/API/events_windows.md (1)
1-4: LGTM!
The document structure follows proper markdown hierarchy and organization.
mkdocs-website/mkdocs.yml (2)
69-69: LGTM: Good addition of definition list support.
The def_list extension is a valuable addition that enhances the markdown capabilities, allowing for better structured documentation with definition lists.
160-160: LGTM: Well-placed Events documentation entry.
The Events documentation is logically placed in the API section, maintaining a coherent structure with other API-related documentation. This aligns well with the PR's objective to add comprehensive Events documentation.
mkdocs-website/docs/en/API/events_mac.md (3)
65-133: LGTM! Menu Events are well-documented.
The Menu Events section is comprehensive, well-organized, and follows a consistent pattern in both naming and descriptions.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~65-~65: Loose punctuation mark.
Context: ...hanges theme events.Mac.MenuWillOpen : Triggered when the menu is about to o...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~68-~68: Loose punctuation mark.
Context: ...about to open events.Mac.MenuDidOpen : Triggered when the menu opens `event...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~71-~71: Loose punctuation mark.
Context: ...e menu opens events.Mac.MenuDidClose : Triggered when the menu closes `even...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~74-~74: Loose punctuation mark.
Context: ...closes events.Mac.MenuWillSendAction : Triggered when the menu is about to s...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~77-~77: Loose punctuation mark.
Context: ... action events.Mac.MenuDidSendAction : Triggered when the menu sends an acti...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~80-~80: Loose punctuation mark.
Context: ...ion events.Mac.MenuWillHighlightItem : Triggered when the menu is about to h...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~83-~83: Loose punctuation mark.
Context: ...item events.Mac.MenuDidHighlightItem : Triggered when the menu highlights an...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~86-~86: Loose punctuation mark.
Context: ... item events.Mac.MenuWillDisplayItem : Triggered when the menu is about to d...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~89-~89: Loose punctuation mark.
Context: ...n item events.Mac.MenuDidDisplayItem : Triggered when the menu displays an i...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~92-~92: Loose punctuation mark.
Context: ...s an item events.Mac.MenuWillAddItem : Triggered when the menu is about to a...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~95-~95: Loose punctuation mark.
Context: ...dd an item events.Mac.MenuDidAddItem : Triggered when the menu adds an item ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~98-~98: Loose punctuation mark.
Context: ...n item events.Mac.MenuWillRemoveItem : Triggered when the menu is about to r...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~101-~101: Loose punctuation mark.
Context: ...an item events.Mac.MenuDidRemoveItem : Triggered when the menu removes an it...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~104-~104: Loose punctuation mark.
Context: ...tem events.Mac.MenuWillBeginTracking : Triggered when the menu is about to b...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~107-~107: Loose punctuation mark.
Context: ...king events.Mac.MenuDidBeginTracking : Triggered when the menu begins tracki...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~110-~110: Loose punctuation mark.
Context: ...cking events.Mac.MenuWillEndTracking : Triggered when the menu is about to e...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~113-~113: Loose punctuation mark.
Context: ...acking events.Mac.MenuDidEndTracking : Triggered when the menu ends tracking...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~116-~116: Loose punctuation mark.
Context: ...s tracking events.Mac.MenuWillUpdate : Triggered when the menu is about to u...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~119-~119: Loose punctuation mark.
Context: ...t to update events.Mac.MenuDidUpdate : Triggered when the menu updates `eve...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~122-~122: Loose punctuation mark.
Context: ...enu updates events.Mac.MenuWillPopUp : Triggered when the menu is about to p...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~125-~125: Loose punctuation mark.
Context: ...ut to pop up events.Mac.MenuDidPopUp : Triggered when the menu pops up `eve...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~128-~128: Loose punctuation mark.
Context: ... events.Mac.MenuWillSendActionToItem : Triggered when the menu is about to s...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~131-~131: Loose punctuation mark.
Context: ...m events.Mac.MenuDidSendActionToItem : Triggered when the menu sends an acti...
(UNLIKELY_OPENING_PUNCTUATION)
134-371: LGTM! Window Events are comprehensive.
The Window Events section provides extensive coverage of window-related events with clear descriptions. The documentation will be valuable for developers implementing window management features.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~136-~136: Loose punctuation mark.
Context: ...Events events.Mac.WindowDidBecomeKey : Triggered when the window becomes key...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~139-~139: Loose punctuation mark.
Context: ...s key events.Mac.WindowDidBecomeMain : Triggered when the window becomes mai...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~142-~142: Loose punctuation mark.
Context: ... main events.Mac.WindowDidBeginSheet : Triggered when the window begins a sh...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~145-~145: Loose punctuation mark.
Context: ...heet events.Mac.WindowDidChangeAlpha : Triggered when the window alpha chang...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~148-~148: Loose punctuation mark.
Context: ...nts.Mac.WindowDidChangeBackingLocation` : Triggered when the window backing loc...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~151-~151: Loose punctuation mark.
Context: ...s.Mac.WindowDidChangeBackingProperties` : Triggered when the window backing pro...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~154-~154: Loose punctuation mark.
Context: ....Mac.WindowDidChangeCollectionBehavior` : Triggered when the window collection ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~157-~157: Loose punctuation mark.
Context: ...Mac.WindowDidChangeEffectiveAppearance` : Triggered when the window effective a...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~160-~160: Loose punctuation mark.
Context: ...ents.Mac.WindowDidChangeOcclusionState` : Triggered when the window occlusion s...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~163-~163: Loose punctuation mark.
Context: ...events.Mac.WindowDidChangeOrderingMode` : Triggered when the window ordering mo...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~166-~166: Loose punctuation mark.
Context: ...ges events.Mac.WindowDidChangeScreen : Triggered when the window screen chan...
(UNLIKELY_OPENING_PUNCTUATION)
[grammar] ~167-~167: Did you mean “screens”?
Context: ...geScreen: Triggered when the window screen changes events.Mac.WindowDidChangeScr...
(WRB_DT_NN_VB)
[uncategorized] ~169-~169: Loose punctuation mark.
Context: ...ts.Mac.WindowDidChangeScreenParameters` : Triggered when the window screen para...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~172-~172: Loose punctuation mark.
Context: ...vents.Mac.WindowDidChangeScreenProfile` : Triggered when the window screen prof...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~175-~175: Loose punctuation mark.
Context: ...events.Mac.WindowDidChangeScreenSpace : Triggered when the window screen spac...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~178-~178: Loose punctuation mark.
Context: ...c.WindowDidChangeScreenSpaceProperties` : Triggered when the window screen spac...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~181-~181: Loose punctuation mark.
Context: ...events.Mac.WindowDidChangeSharingType : Triggered when the window sharing typ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~184-~184: Loose punctuation mark.
Context: ...nges events.Mac.WindowDidChangeSpace : Triggered when the window space chang...
(UNLIKELY_OPENING_PUNCTUATION)
[grammar] ~185-~185: Did you mean “spaces”?
Context: ...ngeSpace: Triggered when the window space changes events.Mac.WindowDidChangeSpa...
(WRB_DT_NN_VB)
[uncategorized] ~187-~187: Loose punctuation mark.
Context: ...s.Mac.WindowDidChangeSpaceOrderingMode` : Triggered when the window space order...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~190-~190: Loose punctuation mark.
Context: ...nges events.Mac.WindowDidChangeTitle : Triggered when the window title chang...
(UNLIKELY_OPENING_PUNCTUATION)
[grammar] ~191-~191: Did you mean “titles”?
Context: ...ngeTitle: Triggered when the window title changes events.Mac.WindowDidChangeToo...
(WRB_DT_NN_VB)
[uncategorized] ~193-~193: Loose punctuation mark.
Context: ...es events.Mac.WindowDidChangeToolbar : Triggered when the window toolbar cha...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~196-~196: Loose punctuation mark.
Context: ... events.Mac.WindowDidChangeVisibility : Triggered when the window visibility ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~199-~199: Loose punctuation mark.
Context: ...es events.Mac.WindowDidDeminiaturize : Triggered when the window is deminiat...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~202-~202: Loose punctuation mark.
Context: ...turized events.Mac.WindowDidEndSheet : Triggered when the window ends a shee...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~205-~205: Loose punctuation mark.
Context: ... events.Mac.WindowDidEnterFullScreen : Triggered when the window enters full...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~208-~208: Loose punctuation mark.
Context: ...vents.Mac.WindowDidEnterVersionBrowser` : Triggered when the window enters vers...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~211-~211: Loose punctuation mark.
Context: ...r events.Mac.WindowDidExitFullScreen : Triggered when the window exits fulls...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~214-~214: Loose punctuation mark.
Context: ...events.Mac.WindowDidExitVersionBrowser` : Triggered when the window exits versi...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~217-~217: Loose punctuation mark.
Context: ...n browser events.Mac.WindowDidExpose : Triggered when the window is exposed ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~220-~220: Loose punctuation mark.
Context: ...is exposed events.Mac.WindowDidFocus : Triggered when the window is focused ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~223-~223: Loose punctuation mark.
Context: ...used events.Mac.WindowDidMiniaturize : Triggered when the window is miniatur...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~226-~226: Loose punctuation mark.
Context: ...iniaturized events.Mac.WindowDidMove : Triggered when the window is moved `...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~229-~229: Loose punctuation mark.
Context: ...d events.Mac.WindowDidOrderOffScreen : Triggered when the window is ordered ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~230-~230: The adjective or adverb “off-screen” is spelled with a hyphen.
Context: ... Triggered when the window is ordered off screen events.Mac.WindowDidOrderOnScreen : ...
(ON_OFF_SCREEN_HYPHEN)
[uncategorized] ~232-~232: Loose punctuation mark.
Context: ...en events.Mac.WindowDidOrderOnScreen : Triggered when the window is ordered ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~235-~235: Loose punctuation mark.
Context: ...screen events.Mac.WindowDidResignKey : Triggered when the window resigns key...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~238-~238: Loose punctuation mark.
Context: ...s key events.Mac.WindowDidResignMain : Triggered when the window resigns mai...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~241-~241: Loose punctuation mark.
Context: ...igns main events.Mac.WindowDidResize : Triggered when the window is resized ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~244-~244: Loose punctuation mark.
Context: ...s resized events.Mac.WindowDidUpdate : Triggered when the window updates `e...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~247-~247: Loose punctuation mark.
Context: ...ates events.Mac.WindowDidUpdateAlpha : Triggered when the window alpha updat...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~250-~250: Loose punctuation mark.
Context: ....Mac.WindowDidUpdateCollectionBehavior` : Triggered when the window collection ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~253-~253: Loose punctuation mark.
Context: ...ac.WindowDidUpdateCollectionProperties` : Triggered when the window collection ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~256-~256: Loose punctuation mark.
Context: ...ate events.Mac.WindowDidUpdateShadow : Triggered when the window shadow upda...
(UNLIKELY_OPENING_PUNCTUATION)
[grammar] ~257-~257: Did you mean “shadows”?
Context: ...teShadow: Triggered when the window shadow updates events.Mac.WindowDidUpdateTit...
(WRB_DT_NN_VB)
[uncategorized] ~259-~259: Loose punctuation mark.
Context: ...ates events.Mac.WindowDidUpdateTitle : Triggered when the window title updat...
(UNLIKELY_OPENING_PUNCTUATION)
[grammar] ~260-~260: Did you mean “titles”?
Context: ...ateTitle: Triggered when the window title updates events.Mac.WindowDidUpdateToo...
(WRB_DT_NN_VB)
[uncategorized] ~262-~262: Loose punctuation mark.
Context: ...es events.Mac.WindowDidUpdateToolbar : Triggered when the window toolbar upd...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~265-~265: Loose punctuation mark.
Context: ... events.Mac.WindowDidUpdateVisibility : Triggered when the window visibility ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~268-~268: Loose punctuation mark.
Context: ...updates events.Mac.WindowShouldClose : Triggered when the window should clos...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~271-~271: Loose punctuation mark.
Context: ...close events.Mac.WindowWillBecomeKey : Triggered when the window will become...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~274-~274: Loose punctuation mark.
Context: ... key events.Mac.WindowWillBecomeMain : Triggered when the window will become...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~277-~277: Loose punctuation mark.
Context: ...main events.Mac.WindowWillBeginSheet : Triggered when the window will begin ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~280-~280: Loose punctuation mark.
Context: ...vents.Mac.WindowWillChangeOrderingMode` : Triggered when the window will change...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~283-~283: Loose punctuation mark.
Context: ...ring mode events.Mac.WindowWillClose : Triggered when the window will close ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~286-~286: Loose punctuation mark.
Context: ...e events.Mac.WindowWillDeminiaturize : Triggered when the window will demini...
(UNLIKELY_OPENING_PUNCTUATION)
[grammar] ~287-~287: Did you mean “wills”?
Context: ...iaturize: Triggered when the window will deminiaturize events.Mac.WindowWillEn...
(WRB_DT_NN_VB)
[uncategorized] ~289-~289: Loose punctuation mark.
Context: ... events.Mac.WindowWillEnterFullScreen : Triggered when the window will enter ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~292-~292: Loose punctuation mark.
Context: ...ents.Mac.WindowWillEnterVersionBrowser` : Triggered when the window will enter ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~295-~295: Loose punctuation mark.
Context: ... events.Mac.WindowWillExitFullScreen : Triggered when the window will exit f...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~298-~298: Loose punctuation mark.
Context: ...vents.Mac.WindowWillExitVersionBrowser` : Triggered when the window will exit v...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~301-~301: Loose punctuation mark.
Context: ...n browser events.Mac.WindowWillFocus : Triggered when the window will focus ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~304-~304: Loose punctuation mark.
Context: ...cus events.Mac.WindowWillMiniaturize : Triggered when the window will miniat...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~307-~307: Loose punctuation mark.
Context: ...iniaturize events.Mac.WindowWillMove : Triggered when the window will move ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~310-~310: Loose punctuation mark.
Context: ... events.Mac.WindowWillOrderOffScreen : Triggered when the window will order ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~311-~311: The adjective or adverb “off-screen” is spelled with a hyphen.
Context: ... Triggered when the window will order off screen events.Mac.WindowWillOrderOnScreen :...
(ON_OFF_SCREEN_HYPHEN)
[uncategorized] ~313-~313: Loose punctuation mark.
Context: ...n events.Mac.WindowWillOrderOnScreen : Triggered when the window will order ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~316-~316: Loose punctuation mark.
Context: ...een events.Mac.WindowWillResignMain` : Triggered when the window will resign...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~319-~319: Loose punctuation mark.
Context: ...ign main events.Mac.WindowWillResize : Triggered when the window will resize...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~322-~322: Loose punctuation mark.
Context: ... resize events.Mac.WindowWillUnfocus : Triggered when the window will unfocu...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~325-~325: Loose punctuation mark.
Context: ...unfocus events.Mac.WindowWillUpdate` : Triggered when the window will update...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~328-~328: Loose punctuation mark.
Context: ...ate events.Mac.WindowWillUpdateAlpha : Triggered when the window will update...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~331-~331: Loose punctuation mark.
Context: ...Mac.WindowWillUpdateCollectionBehavior` : Triggered when the window will update...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~334-~334: Loose punctuation mark.
Context: ...c.WindowWillUpdateCollectionProperties` : Triggered when the window will update...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~337-~337: Loose punctuation mark.
Context: ...es events.Mac.WindowWillUpdateShadow : Triggered when the window will update...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~340-~340: Loose punctuation mark.
Context: ...dow events.Mac.WindowWillUpdateTitle : Triggered when the window will update...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~343-~343: Loose punctuation mark.
Context: ...e events.Mac.WindowWillUpdateToolbar : Triggered when the window will update...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~346-~346: Loose punctuation mark.
Context: ...events.Mac.WindowWillUpdateVisibility : Triggered when the window will update...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~349-~349: Loose punctuation mark.
Context: ...events.Mac.WindowWillUseStandardFrame : Triggered when the window will use st...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~352-~352: Loose punctuation mark.
Context: ...c.WebviewDidStartProvisionalNavigation` : Triggered when the webview starts a p...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~355-~355: Loose punctuation mark.
Context: ...ServerRedirectForProvisionalNavigation` : Triggered when the webview receives a...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~358-~358: Loose punctuation mark.
Context: ...events.Mac.WebviewDidFinishNavigation : Triggered when the webview finishes n...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~361-~361: Loose punctuation mark.
Context: ...events.Mac.WebviewDidCommitNavigation : Triggered when the webview commits na...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~364-~364: Loose punctuation mark.
Context: ... events.Mac.WindowFileDraggingEntered : Triggered when files are dragged into...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~367-~367: Loose punctuation mark.
Context: ...events.Mac.WindowFileDraggingPerformed` : Triggered when files are dragged in t...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~370-~370: Loose punctuation mark.
Context: ... events.Mac.WindowFileDraggingExited : Triggered when files are dragged out ...
(UNLIKELY_OPENING_PUNCTUATION)
1-371: Excellent documentation of macOS events.
The documentation provides a comprehensive overview of all available macOS events in the Wails framework. The organization into Application, Menu, and Window events makes it easy for developers to find relevant events. The descriptions are clear and concise.
While there are some minor formatting and grammar issues to address, the technical content is accurate and valuable.
🧰 Tools
🪛 LanguageTool
[grammar] ~1-~1: The operating system from Apple is written “macOS”.
Context: #### MacOS Events ##### Application Events `even...
(MAC_OS)
[uncategorized] ~5-~5: Loose punctuation mark.
Context: ...events.Mac.ApplicationDidBecomeActive : Triggered when the application become...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~8-~8: Loose punctuation mark.
Context: ....ApplicationDidChangeBackingProperties` : Triggered when the application change...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~11-~11: Loose punctuation mark.
Context: ...AppicationDidChangeEffectiveAppearance` : Triggered when the application change...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~14-~14: Loose punctuation mark.
Context: ... events.Mac.ApplicationDidChangeIcon : Triggered when the application change...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~17-~17: Loose punctuation mark.
Context: ...Mac.ApplicationDidChangeOcclusionState` : Triggered when the application change...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~20-~20: Loose punctuation mark.
Context: ...c.ApplicationDidChangeScreenParameters` : Triggered when the application change...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~23-~23: Loose punctuation mark.
Context: ...Mac.ApplicationDidChangeStatusBarFrame` : Triggered when the application change...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~26-~26: Loose punctuation mark.
Context: ...licationDidChangeStatusBarOrientation` : Triggered when the application change...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~29-~29: Loose punctuation mark.
Context: ...ents.Mac.ApplicationDidFinishLaunching` : Triggered when the application finish...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~32-~32: Loose punctuation mark.
Context: ...ApplicationDidResignActiveNotification` : Triggered when the application is no ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~35-~35: Loose punctuation mark.
Context: ...active events.Mac.ApplicationDidHide : Triggered when the application is hid...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~38-~38: Loose punctuation mark.
Context: ...dden events.Mac.ApplicationDidUpdate : Triggered when the application update...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~41-~41: Loose punctuation mark.
Context: ...events.Mac.ApplicationWillBecomeActive` : Triggered when the application is abo...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~44-~44: Loose punctuation mark.
Context: ...nts.Mac.ApplicationWillFinishLaunching` : Triggered when the application is abo...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~47-~47: Loose punctuation mark.
Context: ...ching events.Mac.ApplicationWillHide : Triggered when the application is abo...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~50-~50: Loose punctuation mark.
Context: ...events.Mac.ApplicationWillResignActive` : Triggered when the application is abo...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~53-~53: Loose punctuation mark.
Context: ... events.Mac.ApplicationWillTerminate : Triggered when the application is abo...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~56-~56: Loose punctuation mark.
Context: ...ate events.Mac.ApplicationWillUnhide : Triggered when the application is abo...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~59-~59: Loose punctuation mark.
Context: ...de events.Mac.ApplicationWillUpdate : Triggered when the application is abo...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~62-~62: Loose punctuation mark.
Context: ...events.Mac.ApplicationDidChangeTheme : Triggered when the application change...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~65-~65: Loose punctuation mark.
Context: ...hanges theme events.Mac.MenuWillOpen : Triggered when the menu is about to o...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~68-~68: Loose punctuation mark.
Context: ...about to open events.Mac.MenuDidOpen : Triggered when the menu opens `event...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~71-~71: Loose punctuation mark.
Context: ...e menu opens events.Mac.MenuDidClose : Triggered when the menu closes `even...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~74-~74: Loose punctuation mark.
Context: ...closes events.Mac.MenuWillSendAction : Triggered when the menu is about to s...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~77-~77: Loose punctuation mark.
Context: ... action events.Mac.MenuDidSendAction : Triggered when the menu sends an acti...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~80-~80: Loose punctuation mark.
Context: ...ion events.Mac.MenuWillHighlightItem : Triggered when the menu is about to h...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~83-~83: Loose punctuation mark.
Context: ...item events.Mac.MenuDidHighlightItem : Triggered when the menu highlights an...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~86-~86: Loose punctuation mark.
Context: ... item events.Mac.MenuWillDisplayItem : Triggered when the menu is about to d...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~89-~89: Loose punctuation mark.
Context: ...n item events.Mac.MenuDidDisplayItem : Triggered when the menu displays an i...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~92-~92: Loose punctuation mark.
Context: ...s an item events.Mac.MenuWillAddItem : Triggered when the menu is about to a...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~95-~95: Loose punctuation mark.
Context: ...dd an item events.Mac.MenuDidAddItem : Triggered when the menu adds an item ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~98-~98: Loose punctuation mark.
Context: ...n item events.Mac.MenuWillRemoveItem : Triggered when the menu is about to r...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~101-~101: Loose punctuation mark.
Context: ...an item events.Mac.MenuDidRemoveItem : Triggered when the menu removes an it...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~104-~104: Loose punctuation mark.
Context: ...tem events.Mac.MenuWillBeginTracking : Triggered when the menu is about to b...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~107-~107: Loose punctuation mark.
Context: ...king events.Mac.MenuDidBeginTracking : Triggered when the menu begins tracki...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~110-~110: Loose punctuation mark.
Context: ...cking events.Mac.MenuWillEndTracking : Triggered when the menu is about to e...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~113-~113: Loose punctuation mark.
Context: ...acking events.Mac.MenuDidEndTracking : Triggered when the menu ends tracking...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~116-~116: Loose punctuation mark.
Context: ...s tracking events.Mac.MenuWillUpdate : Triggered when the menu is about to u...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~119-~119: Loose punctuation mark.
Context: ...t to update events.Mac.MenuDidUpdate : Triggered when the menu updates `eve...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~122-~122: Loose punctuation mark.
Context: ...enu updates events.Mac.MenuWillPopUp : Triggered when the menu is about to p...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~125-~125: Loose punctuation mark.
Context: ...ut to pop up events.Mac.MenuDidPopUp : Triggered when the menu pops up `eve...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~128-~128: Loose punctuation mark.
Context: ... events.Mac.MenuWillSendActionToItem : Triggered when the menu is about to s...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~131-~131: Loose punctuation mark.
Context: ...m events.Mac.MenuDidSendActionToItem : Triggered when the menu sends an acti...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~136-~136: Loose punctuation mark.
Context: ...Events events.Mac.WindowDidBecomeKey : Triggered when the window becomes key...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~139-~139: Loose punctuation mark.
Context: ...s key events.Mac.WindowDidBecomeMain : Triggered when the window becomes mai...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~142-~142: Loose punctuation mark.
Context: ... main events.Mac.WindowDidBeginSheet : Triggered when the window begins a sh...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~145-~145: Loose punctuation mark.
Context: ...heet events.Mac.WindowDidChangeAlpha : Triggered when the window alpha chang...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~148-~148: Loose punctuation mark.
Context: ...nts.Mac.WindowDidChangeBackingLocation` : Triggered when the window backing loc...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~151-~151: Loose punctuation mark.
Context: ...s.Mac.WindowDidChangeBackingProperties` : Triggered when the window backing pro...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~154-~154: Loose punctuation mark.
Context: ....Mac.WindowDidChangeCollectionBehavior` : Triggered when the window collection ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~157-~157: Loose punctuation mark.
Context: ...Mac.WindowDidChangeEffectiveAppearance` : Triggered when the window effective a...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~160-~160: Loose punctuation mark.
Context: ...ents.Mac.WindowDidChangeOcclusionState` : Triggered when the window occlusion s...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~163-~163: Loose punctuation mark.
Context: ...events.Mac.WindowDidChangeOrderingMode` : Triggered when the window ordering mo...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~166-~166: Loose punctuation mark.
Context: ...ges events.Mac.WindowDidChangeScreen : Triggered when the window screen chan...
(UNLIKELY_OPENING_PUNCTUATION)
[grammar] ~167-~167: Did you mean “screens”?
Context: ...geScreen: Triggered when the window screen changes events.Mac.WindowDidChangeScr...
(WRB_DT_NN_VB)
[uncategorized] ~169-~169: Loose punctuation mark.
Context: ...ts.Mac.WindowDidChangeScreenParameters` : Triggered when the window screen para...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~172-~172: Loose punctuation mark.
Context: ...vents.Mac.WindowDidChangeScreenProfile` : Triggered when the window screen prof...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~175-~175: Loose punctuation mark.
Context: ...events.Mac.WindowDidChangeScreenSpace : Triggered when the window screen spac...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~178-~178: Loose punctuation mark.
Context: ...c.WindowDidChangeScreenSpaceProperties` : Triggered when the window screen spac...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~181-~181: Loose punctuation mark.
Context: ...events.Mac.WindowDidChangeSharingType : Triggered when the window sharing typ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~184-~184: Loose punctuation mark.
Context: ...nges events.Mac.WindowDidChangeSpace : Triggered when the window space chang...
(UNLIKELY_OPENING_PUNCTUATION)
[grammar] ~185-~185: Did you mean “spaces”?
Context: ...ngeSpace: Triggered when the window space changes events.Mac.WindowDidChangeSpa...
(WRB_DT_NN_VB)
[uncategorized] ~187-~187: Loose punctuation mark.
Context: ...s.Mac.WindowDidChangeSpaceOrderingMode` : Triggered when the window space order...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~190-~190: Loose punctuation mark.
Context: ...nges events.Mac.WindowDidChangeTitle : Triggered when the window title chang...
(UNLIKELY_OPENING_PUNCTUATION)
[grammar] ~191-~191: Did you mean “titles”?
Context: ...ngeTitle: Triggered when the window title changes events.Mac.WindowDidChangeToo...
(WRB_DT_NN_VB)
[uncategorized] ~193-~193: Loose punctuation mark.
Context: ...es events.Mac.WindowDidChangeToolbar : Triggered when the window toolbar cha...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~196-~196: Loose punctuation mark.
Context: ... events.Mac.WindowDidChangeVisibility : Triggered when the window visibility ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~199-~199: Loose punctuation mark.
Context: ...es events.Mac.WindowDidDeminiaturize : Triggered when the window is deminiat...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~202-~202: Loose punctuation mark.
Context: ...turized events.Mac.WindowDidEndSheet : Triggered when the window ends a shee...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~205-~205: Loose punctuation mark.
Context: ... events.Mac.WindowDidEnterFullScreen : Triggered when the window enters full...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~208-~208: Loose punctuation mark.
Context: ...vents.Mac.WindowDidEnterVersionBrowser` : Triggered when the window enters vers...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~211-~211: Loose punctuation mark.
Context: ...r events.Mac.WindowDidExitFullScreen : Triggered when the window exits fulls...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~214-~214: Loose punctuation mark.
Context: ...events.Mac.WindowDidExitVersionBrowser` : Triggered when the window exits versi...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~217-~217: Loose punctuation mark.
Context: ...n browser events.Mac.WindowDidExpose : Triggered when the window is exposed ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~220-~220: Loose punctuation mark.
Context: ...is exposed events.Mac.WindowDidFocus : Triggered when the window is focused ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~223-~223: Loose punctuation mark.
Context: ...used events.Mac.WindowDidMiniaturize : Triggered when the window is miniatur...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~226-~226: Loose punctuation mark.
Context: ...iniaturized events.Mac.WindowDidMove : Triggered when the window is moved `...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~229-~229: Loose punctuation mark.
Context: ...d events.Mac.WindowDidOrderOffScreen : Triggered when the window is ordered ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~230-~230: The adjective or adverb “off-screen” is spelled with a hyphen.
Context: ... Triggered when the window is ordered off screen events.Mac.WindowDidOrderOnScreen : ...
(ON_OFF_SCREEN_HYPHEN)
[uncategorized] ~232-~232: Loose punctuation mark.
Context: ...en events.Mac.WindowDidOrderOnScreen : Triggered when the window is ordered ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~235-~235: Loose punctuation mark.
Context: ...screen events.Mac.WindowDidResignKey : Triggered when the window resigns key...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~238-~238: Loose punctuation mark.
Context: ...s key events.Mac.WindowDidResignMain : Triggered when the window resigns mai...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~241-~241: Loose punctuation mark.
Context: ...igns main events.Mac.WindowDidResize : Triggered when the window is resized ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~244-~244: Loose punctuation mark.
Context: ...s resized events.Mac.WindowDidUpdate : Triggered when the window updates `e...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~247-~247: Loose punctuation mark.
Context: ...ates events.Mac.WindowDidUpdateAlpha : Triggered when the window alpha updat...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~250-~250: Loose punctuation mark.
Context: ....Mac.WindowDidUpdateCollectionBehavior` : Triggered when the window collection ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~253-~253: Loose punctuation mark.
Context: ...ac.WindowDidUpdateCollectionProperties` : Triggered when the window collection ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~256-~256: Loose punctuation mark.
Context: ...ate events.Mac.WindowDidUpdateShadow : Triggered when the window shadow upda...
(UNLIKELY_OPENING_PUNCTUATION)
[grammar] ~257-~257: Did you mean “shadows”?
Context: ...teShadow: Triggered when the window shadow updates events.Mac.WindowDidUpdateTit...
(WRB_DT_NN_VB)
[uncategorized] ~259-~259: Loose punctuation mark.
Context: ...ates events.Mac.WindowDidUpdateTitle : Triggered when the window title updat...
(UNLIKELY_OPENING_PUNCTUATION)
[grammar] ~260-~260: Did you mean “titles”?
Context: ...ateTitle: Triggered when the window title updates events.Mac.WindowDidUpdateToo...
(WRB_DT_NN_VB)
[uncategorized] ~262-~262: Loose punctuation mark.
Context: ...es events.Mac.WindowDidUpdateToolbar : Triggered when the window toolbar upd...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~265-~265: Loose punctuation mark.
Context: ... events.Mac.WindowDidUpdateVisibility : Triggered when the window visibility ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~268-~268: Loose punctuation mark.
Context: ...updates events.Mac.WindowShouldClose : Triggered when the window should clos...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~271-~271: Loose punctuation mark.
Context: ...close events.Mac.WindowWillBecomeKey : Triggered when the window will become...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~274-~274: Loose punctuation mark.
Context: ... key events.Mac.WindowWillBecomeMain : Triggered when the window will become...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~277-~277: Loose punctuation mark.
Context: ...main events.Mac.WindowWillBeginSheet : Triggered when the window will begin ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~280-~280: Loose punctuation mark.
Context: ...vents.Mac.WindowWillChangeOrderingMode` : Triggered when the window will change...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~283-~283: Loose punctuation mark.
Context: ...ring mode events.Mac.WindowWillClose : Triggered when the window will close ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~286-~286: Loose punctuation mark.
Context: ...e events.Mac.WindowWillDeminiaturize : Triggered when the window will demini...
(UNLIKELY_OPENING_PUNCTUATION)
[grammar] ~287-~287: Did you mean “wills”?
Context: ...iaturize: Triggered when the window will deminiaturize events.Mac.WindowWillEn...
(WRB_DT_NN_VB)
[uncategorized] ~289-~289: Loose punctuation mark.
Context: ... events.Mac.WindowWillEnterFullScreen : Triggered when the window will enter ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~292-~292: Loose punctuation mark.
Context: ...ents.Mac.WindowWillEnterVersionBrowser` : Triggered when the window will enter ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~295-~295: Loose punctuation mark.
Context: ... events.Mac.WindowWillExitFullScreen : Triggered when the window will exit f...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~298-~298: Loose punctuation mark.
Context: ...vents.Mac.WindowWillExitVersionBrowser` : Triggered when the window will exit v...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~301-~301: Loose punctuation mark.
Context: ...n browser events.Mac.WindowWillFocus : Triggered when the window will focus ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~304-~304: Loose punctuation mark.
Context: ...cus events.Mac.WindowWillMiniaturize : Triggered when the window will miniat...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~307-~307: Loose punctuation mark.
Context: ...iniaturize events.Mac.WindowWillMove : Triggered when the window will move ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~310-~310: Loose punctuation mark.
Context: ... events.Mac.WindowWillOrderOffScreen : Triggered when the window will order ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~311-~311: The adjective or adverb “off-screen” is spelled with a hyphen.
Context: ... Triggered when the window will order off screen events.Mac.WindowWillOrderOnScreen :...
(ON_OFF_SCREEN_HYPHEN)
[uncategorized] ~313-~313: Loose punctuation mark.
Context: ...n events.Mac.WindowWillOrderOnScreen : Triggered when the window will order ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~316-~316: Loose punctuation mark.
Context: ...een events.Mac.WindowWillResignMain` : Triggered when the window will resign...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~319-~319: Loose punctuation mark.
Context: ...ign main events.Mac.WindowWillResize : Triggered when the window will resize...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~322-~322: Loose punctuation mark.
Context: ... resize events.Mac.WindowWillUnfocus : Triggered when the window will unfocu...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~325-~325: Loose punctuation mark.
Context: ...unfocus events.Mac.WindowWillUpdate` : Triggered when the window will update...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~328-~328: Loose punctuation mark.
Context: ...ate events.Mac.WindowWillUpdateAlpha : Triggered when the window will update...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~331-~331: Loose punctuation mark.
Context: ...Mac.WindowWillUpdateCollectionBehavior` : Triggered when the window will update...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~334-~334: Loose punctuation mark.
Context: ...c.WindowWillUpdateCollectionProperties` : Triggered when the window will update...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~337-~337: Loose punctuation mark.
Context: ...es events.Mac.WindowWillUpdateShadow : Triggered when the window will update...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~340-~340: Loose punctuation mark.
Context: ...dow events.Mac.WindowWillUpdateTitle : Triggered when the window will update...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~343-~343: Loose punctuation mark.
Context: ...e events.Mac.WindowWillUpdateToolbar : Triggered when the window will update...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~346-~346: Loose punctuation mark.
Context: ...events.Mac.WindowWillUpdateVisibility : Triggered when the window will update...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~349-~349: Loose punctuation mark.
Context: ...events.Mac.WindowWillUseStandardFrame : Triggered when the window will use st...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~352-~352: Loose punctuation mark.
Context: ...c.WebviewDidStartProvisionalNavigation` : Triggered when the webview starts a p...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~355-~355: Loose punctuation mark.
Context: ...ServerRedirectForProvisionalNavigation` : Triggered when the webview receives a...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~358-~358: Loose punctuation mark.
Context: ...events.Mac.WebviewDidFinishNavigation : Triggered when the webview finishes n...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~361-~361: Loose punctuation mark.
Context: ...events.Mac.WebviewDidCommitNavigation : Triggered when the webview commits na...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~364-~364: Loose punctuation mark.
Context: ... events.Mac.WindowFileDraggingEntered : Triggered when files are dragged into...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~367-~367: Loose punctuation mark.
Context: ...events.Mac.WindowFileDraggingPerformed` : Triggered when files are dragged in t...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~370-~370: Loose punctuation mark.
Context: ... events.Mac.WindowFileDraggingExited : Triggered when files are dragged out ...
(UNLIKELY_OPENING_PUNCTUATION)
mkdocs-website/docs/en/changelog.md (1)
21-21: LGTM! Changelog entry is well-formatted and accurate.
The entry follows the proper changelog format, correctly attributes the author, and accurately reflects the PR's purpose of adding Events documentation.
| `events.Linux.WindowDidResize` | ||
| : Triggered when the window is resized | ||
|
|
||
| `events.Linux.WindowDidResize` | ||
| : Triggered when the window is resized | ||
|
|
There was a problem hiding this comment.
Remove duplicate WindowDidResize event documentation.
The WindowDidResize event is documented twice with identical descriptions.
Remove the duplicate entry:
`events.Linux.WindowDidResize`
: Triggered when the window is resized
-`events.Linux.WindowDidResize`
-: Triggered when the window is resized📝 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.
| `events.Linux.WindowDidResize` | |
| : Triggered when the window is resized | |
| `events.Linux.WindowDidResize` | |
| : Triggered when the window is resized | |
| `events.Linux.WindowDidResize` | |
| : Triggered when the window is resized | |
🧰 Tools
🪛 LanguageTool
[uncategorized] ~22-~22: Loose punctuation mark.
Context: ...s moved events.Linux.WindowDidResize : Triggered when the window is resized ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~25-~25: Loose punctuation mark.
Context: ...resized events.Linux.WindowDidResize : Triggered when the window is resized ...
(UNLIKELY_OPENING_PUNCTUATION)
| ### OnApplicationEvent | ||
| API: | ||
| `OnApplicationEvent(eventType events.ApplicationEventType, callback func(event *ApplicationEvent)) func()` | ||
|
|
||
| `OnApplicationEvent()` registers an event listener for specific application events. | ||
| The `eventType` is based on events.ApplicationEventType. See [ApplicationEventType](MICHAEL PUT A LINK HERE WHEN IT EXISTS) |
There was a problem hiding this comment.
Fix broken link and enhance OnApplicationEvent documentation.
- The link placeholder "[ApplicationEventType](MICHAEL PUT A LINK HERE WHEN IT EXISTS)" needs to be updated
- Documentation needs expansion with available event types and usage examples
Add the following content:
`OnApplicationEvent()` registers an event listener for specific application events.
-The `eventType` is based on events.ApplicationEventType. See [ApplicationEventType](MICHAEL PUT A LINK HERE WHEN IT EXISTS)
+The `eventType` is based on events.ApplicationEventType. Available types include:
+
+- `events.ApplicationStarted` - Triggered when the application has started
+- `events.ApplicationStopping` - Triggered when the application is about to stop
+- `events.ThemeChanged` - Triggered when the system theme changes
+
+The `ApplicationEvent` structure contains event-specific data based on the event type.
+
+Example:
+```go
+app.OnApplicationEvent(events.ThemeChanged, func(event *ApplicationEvent) {
+ fmt.Printf("Theme changed to: %s\n", event.Theme)
+})
+```
+
+Note: Application event listeners are executed after any registered hooks for the same event type.| ### OffEvent | ||
| API: | ||
| `OffEvent(name string)` | ||
|
|
||
| `OffEvent()` removes an event listener for a specific application event. |
There was a problem hiding this comment.
💡 Codebase verification
Based on the implementation details found, I can now provide the final response:
Clarify OffEvent behavior details in documentation
The documentation should specify:
- OffEvent removes all listeners for the given event name (not just the most recent one)
- If the event name doesn't exist, the operation is a no-op (silently succeeds)
- This method is independent of the cleanup function returned by OnEvent - both mechanisms can be used to remove event listeners
Evidence from codebase:
unRegisterListenerimplementation shows it removes all listeners for the event name usingdelete(e.listeners, eventName)- The operation is wrapped in a mutex lock, ensuring thread-safe removal
- No error checking is performed for non-existent event names
🔗 Analysis chain
Clarify OffEvent behavior details.
The documentation should specify:
- What happens if the event name doesn't exist
- Whether it removes all listeners for that event or just the most recent one
- Its relationship with the cleanup function returned by OnEvent
Let me verify the behavior in the codebase:
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Search for OffEvent implementation to understand its behavior
ast-grep --pattern 'func $_(name string) {
$$$
}'
Length of output: 53
Script:
#!/bin/bash
# Search for OffEvent implementation with a more specific pattern
ast-grep --pattern 'OffEvent($$$) {
$$$
}'
# Also search for any mentions of OffEvent in the codebase
rg "OffEvent" -A 5
Length of output: 1738
Script:
#!/bin/bash
# Let's check the implementation of the Off method in the event processor
rg "func.*Off.*string.*{" -A 10
# Also check if there are any tests that might reveal the behavior
rg "TestOff" -A 10
Length of output: 156
Script:
#!/bin/bash
# Fix the regex syntax and search for Off implementation
rg "func.*Off.*string" -A 10
# Search for the event processor implementation
rg "type.*EventProcessor" -A 20
# Search for Off method implementation
ast-grep --pattern 'Off(name string) {
$$$
}'
Length of output: 22386
Script:
#!/bin/bash
# Let's check the unRegisterListener implementation
rg "func.*unRegisterListener" -A 10
# Also check for any related test files
rg "TestEventProcessor" -A 10
Length of output: 1484
| app.OnEvent("event1", func(e *application.CustomEvent) { | ||
| app.Logger.Info("[Go] CustomEvent received", "name", e.Name, "data", e.Data, "sender", e.Sender, "cancelled", e.Cancelled) | ||
| app.Logger.Info("[Go]", e.Data[0].(string)) // Logs "Hello from JS" to the terminal | ||
| }) |
There was a problem hiding this comment.
Add type assertion safety check
The type assertion e.Data[0].(string) could panic if the data is not a string or the slice is empty. Consider adding a safety check.
-app.Logger.Info("[Go]", e.Data[0].(string))
+if len(e.Data) > 0 {
+ if str, ok := e.Data[0].(string); ok {
+ app.Logger.Info("[Go]", str)
+ }
+}📝 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.
| app.OnEvent("event1", func(e *application.CustomEvent) { | |
| app.Logger.Info("[Go] CustomEvent received", "name", e.Name, "data", e.Data, "sender", e.Sender, "cancelled", e.Cancelled) | |
| app.Logger.Info("[Go]", e.Data[0].(string)) // Logs "Hello from JS" to the terminal | |
| }) | |
| app.OnEvent("event1", func(e *application.CustomEvent) { | |
| app.Logger.Info("[Go] CustomEvent received", "name", e.Name, "data", e.Data, "sender", e.Sender, "cancelled", e.Cancelled) | |
| if len(e.Data) > 0 { | |
| if str, ok := e.Data[0].(string); ok { | |
| app.Logger.Info("[Go]", str) | |
| } | |
| } | |
| }) |
atterpac
force-pushed
the
v3/docs-update
branch
2 times, most recently
from
cb400cf
to
7c203cb
Compare
There was a problem hiding this comment.
Actionable comments posted: 7
🧹 Outside diff range and nitpick comments (11)
mkdocs-website/docs/en/API/events_linux.md (2)
5-10: Consider enhancing Application Events documentation.While the descriptions are clear, consider adding:
- Example usage code snippets
- More detailed trigger conditions
- Platform-specific considerations
Example enhancement:
`events.Linux.ApplicationStartup` -: Triggered when the application starts +: Triggered when the application starts. This event is fired after the application window + is created but before it's shown to the user. + + Example usage: + ```go + runtime.EventsOn("events.Linux.ApplicationStartup", func(data ...interface{}) { + // Perform initialization + }) + ```🧰 Tools
🪛 LanguageTool
[uncategorized] ~5-~5: Loose punctuation mark.
Context: ...entsevents.Linux.ApplicationStartup: Triggered when the application starts...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~8-~8: Loose punctuation mark.
Context: ...artsevents.Linux.SystemThemeChanged: Triggered when the system theme chang...(UNLIKELY_OPENING_PUNCTUATION)
[grammar] ~9-~9: Did you mean “themes”?
Context: ...eChanged: Triggered when the system theme changes ##### Window Eventsevents.L...(WRB_DT_NN_VB)
16-29: Consider documenting event relationships and order.The window events could benefit from documentation about their relationship and firing order. For example:
- Does WindowDeleteEvent fire before or after window closure?
- Is WindowFocusOut guaranteed to fire before WindowDeleteEvent?
- What's the sequence of events during window movement (WindowDidMove) and resize (WindowDidResize)?
Consider adding a section about event ordering and relationships, similar to:
#### Event Relationships - Window creation: ApplicationStartup → WindowFocusIn - Window closure: WindowFocusOut → WindowDeleteEvent - Window movement/resize: These events may fire rapidly during user interaction🧰 Tools
🪛 LanguageTool
[uncategorized] ~16-~16: Loose punctuation mark.
Context: ...angesevents.Linux.WindowDeleteEvent: Triggered when the window is deleted ...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~19-~19: Loose punctuation mark.
Context: ...s deletedevents.Linux.WindowDidMove: Triggered when the window is moved `...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~22-~22: Loose punctuation mark.
Context: ...s movedevents.Linux.WindowDidResize: Triggered when the window is resized ...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~25-~25: Loose punctuation mark.
Context: ...s resizedevents.Linux.WindowFocusIn: Triggered when the window gains focus...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~28-~28: Loose punctuation mark.
Context: ...ns focusevents.Linux.WindowFocusOut: Triggered when the window loses focus...(UNLIKELY_OPENING_PUNCTUATION)
mkdocs-website/docs/en/API/events_windows.md (2)
5-22: Standardize Application Events descriptions.Please enhance the descriptions for consistency and clarity:
- Add periods at the end of all descriptions.
- Improve grammar in the APMResumeSuspend description.
Apply this diff:
`events.Windows.ApplicationStarted` -: Triggered when the application starts +: Triggered when the application starts. `events.Windows.SystemThemeChanged` -: Triggered when the system theme changes +: Triggered when the system theme changes. `events.Windows.APMPowerStatusChange` -: Triggered when the system power status changes +: Triggered when the system power status changes. `events.Windows.APMSuspend` -: Triggered when the system suspends +: Triggered when the system suspends. `events.Windows.APMResumeAutomatic` -: Triggered when the system resumes after a sleep +: Triggered when the system resumes after a sleep. `events.Windows.APMResumeSuspend` -: Triggered when the system resumes after a suspend and resume was triggered by the user +: Triggered when the system resumes after being suspended, where the resume was initiated by the user.🧰 Tools
🪛 LanguageTool
[uncategorized] ~5-~5: Loose punctuation mark.
Context: ...tsevents.Windows.ApplicationStarted: Triggered when the application starts...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~8-~8: Loose punctuation mark.
Context: ...sevents.Windows.SystemThemeChanged: Triggered when the system theme chang...(UNLIKELY_OPENING_PUNCTUATION)
[grammar] ~9-~9: Did you mean “themes”?
Context: ...Changed: Triggered when the system theme changesevents.Windows.APMPowerStatus...(WRB_DT_NN_VB)
[uncategorized] ~11-~11: Loose punctuation mark.
Context: ...events.Windows.APMPowerStatusChange: Triggered when the system power statu...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~14-~14: Loose punctuation mark.
Context: ...s changesevents.Windows.APMSuspend: Triggered when the system suspends `...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~17-~17: Loose punctuation mark.
Context: ...dsevents.Windows.APMResumeAutomatic: Triggered when the system resumes aft...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~20-~20: Loose punctuation mark.
Context: ...leepevents.Windows.APMResumeSuspend: Triggered when the system resumes aft...(UNLIKELY_OPENING_PUNCTUATION)
[grammar] ~21-~21: The verb ‘suspend’ does not usually follow articles like ‘a’. Check that ‘suspend’ is spelled correctly; using ‘suspend’ as a noun may be non-standard.
Context: ...Triggered when the system resumes after a suspend and resume was triggered by the user #...(A_INFINITIVE)
25-79: Fix typos and standardize Window Events descriptions.Please address the following:
- Fix typo in UnFullscreen event description ("fullscreene" → "fullscreen")
- Standardize to American English spelling:
- "maximised" → "maximized"
- "minimised" → "minimized"
- Add periods at the end of all descriptions
- Improve clarity of UnFullscreen event description
Apply this diff:
`events.Windows.WebviewNavigationCompleted` -: Triggered when the webview navigation is completed +: Triggered when the webview navigation is completed. `events.Windows.WindowInactive` -: Triggered when the window is inactive +: Triggered when the window is inactive. `events.Windows.WindowActive` -: Triggered when the window is active +: Triggered when the window is active. `events.Windows.ClickActive` -: Triggered when the window is activated via a click +: Triggered when the window is activated via a click. `events.Windows.MaximiseActive` -: Triggered when the window is maximised +: Triggered when the window is maximized. `events.Windows.UnMaximise` -: Triggered when the window is unmaximised +: Triggered when the window is unmaximized. `events.Windows.Fullscreen` -: Triggered when the window is set to fullscreen +: Triggered when the window is set to fullscreen. `events.Windows.UnFullscreen` -: Triggered when the window is exited from fullscreene +: Triggered when the window exits fullscreen mode. `events.Windows.WindowRestore` -: Triggered when the window is restored +: Triggered when the window is restored. `events.Windows.WindowMinimise` -: Triggered when the window is minimised +: Triggered when the window is minimized. `events.Windows.WindowUnminimise` -: Triggered when the window is unminimised +: Triggered when the window is unminimized. `events.Windows.WindowClose` -: Triggered before the window closes +: Triggered before the window closes. `events.Windows.WindowSetFocus` -: Triggered when the window gains keyboard focus +: Triggered when the window gains keyboard focus. `events.Windows.WindowKillFocus` -: Triggered when the window loses keyboard focus +: Triggered when the window loses keyboard focus. `events.Windows.WindowDragDrop` -: Triggered when files are dropped on the window +: Triggered when files are dropped on the window. `events.Windows.WindowDragEnter` -: Triggered when a drag enters the window +: Triggered when a drag enters the window. `events.Windows.WindowDragLeave` -: Triggered when a drag leaves the window +: Triggered when a drag leaves the window. `events.Windows.WindowDragOver` -: Triggered when a drag is over the window +: Triggered when a drag is over the window. `events.Windows.WindowDidMove` -: Triggered after a window has moved +: Triggered after a window has moved.🧰 Tools
🪛 LanguageTool
[uncategorized] ~25-~25: Loose punctuation mark.
Context: ...nts.Windows.WebviewNavigationCompleted` : Triggered when the webview navigation...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~28-~28: Loose punctuation mark.
Context: ...pletedevents.Windows.WindowInactive: Triggered when the window is inactive...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~31-~31: Loose punctuation mark.
Context: ...inactiveevents.Windows.WindowActive: Triggered when the window is active ...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~34-~34: Loose punctuation mark.
Context: ...is activeevents.Windows.ClickActive: Triggered when the window is activate...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~37-~37: Loose punctuation mark.
Context: ... clickevents.Windows.MaximiseActive: Triggered when the window is maximise...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~40-~40: Loose punctuation mark.
Context: ... maximisedevents.Windows.UnMaximise: Triggered when the window is unmaximi...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~43-~43: Loose punctuation mark.
Context: ...nmaximisedevents.Windows.Fullscreen: Triggered when the window is set to f...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~46-~46: Loose punctuation mark.
Context: ...llscreenevents.Windows.UnFullscreen: Triggered when the window is exited f...(UNLIKELY_OPENING_PUNCTUATION)
[style] ~47-~47: This phrase is redundant. Consider writing “exited”.
Context: ...creen: Triggered when the window is exited from fullscreeneevents.Windows.WindowRest...(EXIT_FROM)
[uncategorized] ~49-~49: Loose punctuation mark.
Context: ...screeneevents.Windows.WindowRestore: Triggered when the window is restored...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~52-~52: Loose punctuation mark.
Context: ...storedevents.Windows.WindowMinimise: Triggered when the window is minimise...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~55-~55: Loose punctuation mark.
Context: ...isedevents.Windows.WindowUnminimise: Triggered when the window is unminimi...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~58-~58: Loose punctuation mark.
Context: ...minimisedevents.Windows.WindowClose: Triggered before the window closes `e...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~63-~63: Loose punctuation mark.
Context: ...focusevents.Windows.WindowKillFocus: Triggered when the window loses keybo...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~66-~66: Loose punctuation mark.
Context: ... focusevents.Windows.WindowDragDrop: Triggered when files are dropped on t...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~69-~69: Loose punctuation mark.
Context: ...indowevents.Windows.WindowDragEnter: Triggered when a drag enters the wind...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~72-~72: Loose punctuation mark.
Context: ...indowevents.Windows.WindowDragLeave: Triggered when a drag leaves the wind...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~75-~75: Loose punctuation mark.
Context: ...windowevents.Windows.WindowDragOver: Triggered when a drag is over the win...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~78-~78: Loose punctuation mark.
Context: ... windowevents.Windows.WindowDidMove: Triggered after a window has moved(UNLIKELY_OPENING_PUNCTUATION)
mkdocs-website/docs/en/API/events.md (4)
46-48: Improve documentation clarity and grammarThe current text has several issues that affect readability and professionalism.
Apply these improvements:
-Events can be received on the application instance and the frontend with a couple options of how -you chose to receive them. You can register a single event listener that will trigger every time the event is emitted -or you can register an event listener that will only trigger a specific number of times. +Events can be received on both the application instance and the frontend with several options for +handling them. You can either register a single event listener that triggers every time the event is emitted, +or register an event listener that triggers a specific number of times.🧰 Tools
🪛 LanguageTool
[grammar] ~46-~46: Using ‘couple’ without ‘of’ is considered to be informal.
Context: ...cation instance and the frontend with a couple options of how you chose to receive them. You ...(PLENTY_OF_NOUNS)
[uncategorized] ~47-~47: Use a comma before ‘or’ if it connects two independent clauses (unless they are closely connected and short).
Context: ... trigger every time the event is emitted or you can register an event listener that...(COMMA_COMPOUND_SENTENCE)
119-120: Fix typo and improve sentence structure in CustomEvent descriptionThe description contains a spelling error and could be structured better.
Apply these improvements:
-CustomEvent is returned when an event is being recieved it includes the name of the event, the data that was sent with the event, -the sender of the event, application or a specific window. +CustomEvent is returned when an event is received. It includes the event name, the associated data, +and the sender (either the application or a specific window).
34-88: Enhance API documentation with important implementation detailsThe API documentation would benefit from additional information about:
- Error handling: What happens if an event handler panics?
- Thread safety: Are these methods safe for concurrent use?
- Order of execution: Are events processed in order?
Consider adding a new section addressing these implementation details to help developers better understand the behavior and limitations of the event system.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~36-~36: Loose punctuation mark.
Context: ...on.EmitEvent(name string, data ...any)` : Emits an event from the application i...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~39-~39: Loose punctuation mark.
Context: ...ow.EmitEvent(name string, data ...any)` : Emits an event from the window instan...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~42-~42: Loose punctuation mark.
Context: ...nts.Emit(event:wails.Events.EventData)` : Emits an event from the frontend send...(UNLIKELY_OPENING_PUNCTUATION)
[duplication] ~45-~45: Possible typo: you repeated a word
Context: ...escript type WailsEvent ### Receiving Events Events can be received on the application inst...(ENGLISH_WORD_REPEAT_RULE)
[grammar] ~46-~46: Using ‘couple’ without ‘of’ is considered to be informal.
Context: ...cation instance and the frontend with a couple options of how you chose to receive them. You ...(PLENTY_OF_NOUNS)
[uncategorized] ~47-~47: Use a comma before ‘or’ if it connects two independent clauses (unless they are closely connected and short).
Context: ... trigger every time the event is emitted or you can register an event listener that...(COMMA_COMPOUND_SENTENCE)
[uncategorized] ~52-~52: Loose punctuation mark.
Context: ...ame string, handler func(data ...any))` : Registers an event on the application...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~55-~55: Loose punctuation mark.
Context: ... handler func(data ...any), count int)` : Registers an event on the application...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~60-~60: Loose punctuation mark.
Context: ...ts.On(name: string, callback: ()=>void)`, : Registers an event on the frontend...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~63-~63: Loose punctuation mark.
Context: ....Once(name: string, callback: ()=>void)`, : Registers an event on the frontend...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~66-~66: Loose punctuation mark.
Context: ...ing, callback: ()=>void, count: number)`, : Registers an event on the frontend...(UNLIKELY_OPENING_PUNCTUATION)
[style] ~70-~70: Consider removing “of” to be more concise
Context: ...s to remove events that are registered. All of the registration functions return a functio...(ALL_OF_THE)
[uncategorized] ~75-~75: Loose punctuation mark.
Context: ...ame string, ...additionalNames string)` : Removes an event listener with the sp...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~78-~78: Loose punctuation mark.
Context: ...ficed nameapplication.ResetEvents(): Removes all registered events and hoo...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~83-~83: Loose punctuation mark.
Context: ...ooks Frontendwails.Events.OffAll(): Removes all registered events `wails...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~86-~86: Loose punctuation mark.
Context: ...ventswails.Events.Off(name: string): Removes an event listener with the sp...(UNLIKELY_OPENING_PUNCTUATION)
14-32: Add more comprehensive code examplesWhile the current examples demonstrate basic usage, consider adding examples that show:
- Error handling patterns
- Common use cases (e.g., window management, application lifecycle)
- Best practices for event naming and data structure
Would you like me to help generate additional code examples covering these scenarios?
mkdocs-website/docs/en/API/events_mac.md (3)
352-363: Consider adding parameter documentation for WebView events.The WebView events might include important parameters that developers need to handle. Consider documenting:
- Navigation URL
- Error conditions
- Redirect information
- Navigation type
Example enhancement for WebviewDidStartProvisionalNavigation:
`events.Mac.WebviewDidStartProvisionalNavigation` -: Triggered when the webview starts a provisional navigation +: Triggered when the webview starts a provisional navigation. The event handler receives: + - `url`: The URL being loaded + - `navigationType`: The type of navigation (link click, form submit, etc.)🧰 Tools
🪛 LanguageTool
[uncategorized] ~352-~352: Loose punctuation mark.
Context: ...c.WebviewDidStartProvisionalNavigation` : Triggered when the webview starts a p...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~355-~355: Loose punctuation mark.
Context: ...ServerRedirectForProvisionalNavigation` : Triggered when the webview receives a...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~358-~358: Loose punctuation mark.
Context: ...events.Mac.WebviewDidFinishNavigation: Triggered when the webview finishes n...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~361-~361: Loose punctuation mark.
Context: ...events.Mac.WebviewDidCommitNavigation: Triggered when the webview commits na...(UNLIKELY_OPENING_PUNCTUATION)
364-371: Enhance file dragging events documentation.The file dragging events would benefit from additional details about:
- The file information available to event handlers
- Handling multiple files
- Supported file types
Example enhancement:
`events.Mac.WindowFileDraggingEntered` -: Triggered when files are dragged into the window` +: Triggered when files are dragged into the window. The event handler receives: + - `files`: Array of file paths or file objects + - `types`: Array of file UTIs (Uniform Type Identifiers) + Note: Use this event to validate file types and provide visual feedback.🧰 Tools
🪛 LanguageTool
[uncategorized] ~364-~364: Loose punctuation mark.
Context: ...events.Mac.WindowFileDraggingEntered: Triggered when files are dragged into...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~367-~367: Loose punctuation mark.
Context: ...events.Mac.WindowFileDraggingPerformed` : Triggered when files are dragged in t...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~370-~370: Loose punctuation mark.
Context: ...events.Mac.WindowFileDraggingExited: Triggered when files are dragged out ...(UNLIKELY_OPENING_PUNCTUATION)
1-371: LGTM! Documentation structure is clear and comprehensive.The documentation provides a well-organized and thorough reference for macOS-specific events in the Wails framework. The events are logically grouped into Application, Menu, Window, WebView, and File Dragging categories, making it easy for developers to find relevant events.
Consider adding:
- Cross-references to related documentation sections
- Code examples showing common event handling patterns
- Best practices for event handling
🧰 Tools
🪛 LanguageTool
[grammar] ~1-~1: The operating system from Apple is written “macOS”.
Context: #### MacOS Events ##### Application Events `even...(MAC_OS)
[uncategorized] ~5-~5: Loose punctuation mark.
Context: ...events.Mac.ApplicationDidBecomeActive: Triggered when the application become...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~8-~8: Loose punctuation mark.
Context: ....ApplicationDidChangeBackingProperties` : Triggered when the application change...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~11-~11: Loose punctuation mark.
Context: ...pplicationDidChangeEffectiveAppearance` : Triggered when the application change...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~14-~14: Loose punctuation mark.
Context: ...events.Mac.ApplicationDidChangeIcon: Triggered when the application change...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~17-~17: Loose punctuation mark.
Context: ...Mac.ApplicationDidChangeOcclusionState` : Triggered when the application change...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~20-~20: Loose punctuation mark.
Context: ...c.ApplicationDidChangeScreenParameters` : Triggered when the application change...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~23-~23: Loose punctuation mark.
Context: ...Mac.ApplicationDidChangeStatusBarFrame` : Triggered when the application change...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~26-~26: Loose punctuation mark.
Context: ...licationDidChangeStatusBarOrientation` : Triggered when the application change...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~29-~29: Loose punctuation mark.
Context: ...ents.Mac.ApplicationDidFinishLaunching` : Triggered when the application finish...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~32-~32: Loose punctuation mark.
Context: ...ApplicationDidResignActiveNotification` : Triggered when the application is no ...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~35-~35: Loose punctuation mark.
Context: ...activeevents.Mac.ApplicationDidHide: Triggered when the application is hid...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~38-~38: Loose punctuation mark.
Context: ...ddenevents.Mac.ApplicationDidUpdate: Triggered when the application update...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~41-~41: Loose punctuation mark.
Context: ...events.Mac.ApplicationWillBecomeActive` : Triggered when the application is abo...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~44-~44: Loose punctuation mark.
Context: ...nts.Mac.ApplicationWillFinishLaunching` : Triggered when the application is abo...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~47-~47: Loose punctuation mark.
Context: ...chingevents.Mac.ApplicationWillHide: Triggered when the application is abo...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~50-~50: Loose punctuation mark.
Context: ...events.Mac.ApplicationWillResignActive` : Triggered when the application is abo...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~53-~53: Loose punctuation mark.
Context: ...events.Mac.ApplicationWillTerminate: Triggered when the application is abo...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~56-~56: Loose punctuation mark.
Context: ...ateevents.Mac.ApplicationWillUnhide: Triggered when the application is abo...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~59-~59: Loose punctuation mark.
Context: ...deevents.Mac.ApplicationWillUpdate: Triggered when the application is abo...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~62-~62: Loose punctuation mark.
Context: ...events.Mac.ApplicationDidChangeTheme: Triggered when the application change...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~65-~65: Loose punctuation mark.
Context: ...hanges themeevents.Mac.MenuWillOpen: Triggered when the menu is about to o...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~68-~68: Loose punctuation mark.
Context: ...about to openevents.Mac.MenuDidOpen: Triggered when the menu opens `event...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~71-~71: Loose punctuation mark.
Context: ...e menu opensevents.Mac.MenuDidClose: Triggered when the menu closes `even...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~74-~74: Loose punctuation mark.
Context: ...closesevents.Mac.MenuWillSendAction: Triggered when the menu is about to s...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~77-~77: Loose punctuation mark.
Context: ... actionevents.Mac.MenuDidSendAction: Triggered when the menu sends an acti...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~80-~80: Loose punctuation mark.
Context: ...ionevents.Mac.MenuWillHighlightItem: Triggered when the menu is about to h...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~83-~83: Loose punctuation mark.
Context: ...itemevents.Mac.MenuDidHighlightItem: Triggered when the menu highlights an...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~86-~86: Loose punctuation mark.
Context: ... itemevents.Mac.MenuWillDisplayItem: Triggered when the menu is about to d...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~89-~89: Loose punctuation mark.
Context: ...n itemevents.Mac.MenuDidDisplayItem: Triggered when the menu displays an i...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~92-~92: Loose punctuation mark.
Context: ...s an itemevents.Mac.MenuWillAddItem: Triggered when the menu is about to a...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~95-~95: Loose punctuation mark.
Context: ...dd an itemevents.Mac.MenuDidAddItem: Triggered when the menu adds an item ...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~98-~98: Loose punctuation mark.
Context: ...n itemevents.Mac.MenuWillRemoveItem: Triggered when the menu is about to r...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~101-~101: Loose punctuation mark.
Context: ...an itemevents.Mac.MenuDidRemoveItem: Triggered when the menu removes an it...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~104-~104: Loose punctuation mark.
Context: ...temevents.Mac.MenuWillBeginTracking: Triggered when the menu is about to b...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~107-~107: Loose punctuation mark.
Context: ...kingevents.Mac.MenuDidBeginTracking: Triggered when the menu begins tracki...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~110-~110: Loose punctuation mark.
Context: ...ckingevents.Mac.MenuWillEndTracking: Triggered when the menu is about to e...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~113-~113: Loose punctuation mark.
Context: ...ackingevents.Mac.MenuDidEndTracking: Triggered when the menu ends tracking...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~116-~116: Loose punctuation mark.
Context: ...s trackingevents.Mac.MenuWillUpdate: Triggered when the menu is about to u...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~119-~119: Loose punctuation mark.
Context: ...t to updateevents.Mac.MenuDidUpdate: Triggered when the menu updates `eve...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~122-~122: Loose punctuation mark.
Context: ...enu updatesevents.Mac.MenuWillPopUp: Triggered when the menu is about to p...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~125-~125: Loose punctuation mark.
Context: ...ut to pop upevents.Mac.MenuDidPopUp: Triggered when the menu pops up `eve...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~128-~128: Loose punctuation mark.
Context: ...events.Mac.MenuWillSendActionToItem: Triggered when the menu is about to s...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~131-~131: Loose punctuation mark.
Context: ...mevents.Mac.MenuDidSendActionToItem: Triggered when the menu sends an acti...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~136-~136: Loose punctuation mark.
Context: ...Eventsevents.Mac.WindowDidBecomeKey: Triggered when the window becomes key...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~139-~139: Loose punctuation mark.
Context: ...s keyevents.Mac.WindowDidBecomeMain: Triggered when the window becomes mai...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~142-~142: Loose punctuation mark.
Context: ... mainevents.Mac.WindowDidBeginSheet: Triggered when the window begins a sh...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~145-~145: Loose punctuation mark.
Context: ...heetevents.Mac.WindowDidChangeAlpha: Triggered when the window alpha chang...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~148-~148: Loose punctuation mark.
Context: ...nts.Mac.WindowDidChangeBackingLocation` : Triggered when the window backing loc...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~151-~151: Loose punctuation mark.
Context: ...s.Mac.WindowDidChangeBackingProperties` : Triggered when the window backing pro...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~154-~154: Loose punctuation mark.
Context: ....Mac.WindowDidChangeCollectionBehavior` : Triggered when the window collection ...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~157-~157: Loose punctuation mark.
Context: ...Mac.WindowDidChangeEffectiveAppearance` : Triggered when the window effective a...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~160-~160: Loose punctuation mark.
Context: ...ents.Mac.WindowDidChangeOcclusionState` : Triggered when the window occlusion s...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~163-~163: Loose punctuation mark.
Context: ...events.Mac.WindowDidChangeOrderingMode` : Triggered when the window ordering mo...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~166-~166: Loose punctuation mark.
Context: ...gesevents.Mac.WindowDidChangeScreen: Triggered when the window screen chan...(UNLIKELY_OPENING_PUNCTUATION)
[grammar] ~167-~167: Did you mean “screens”?
Context: ...geScreen: Triggered when the window screen changesevents.Mac.WindowDidChangeScr...(WRB_DT_NN_VB)
[uncategorized] ~169-~169: Loose punctuation mark.
Context: ...ts.Mac.WindowDidChangeScreenParameters` : Triggered when the window screen para...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~172-~172: Loose punctuation mark.
Context: ...vents.Mac.WindowDidChangeScreenProfile` : Triggered when the window screen prof...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~175-~175: Loose punctuation mark.
Context: ...events.Mac.WindowDidChangeScreenSpace: Triggered when the window screen spac...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~178-~178: Loose punctuation mark.
Context: ...c.WindowDidChangeScreenSpaceProperties` : Triggered when the window screen spac...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~181-~181: Loose punctuation mark.
Context: ...events.Mac.WindowDidChangeSharingType: Triggered when the window sharing typ...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~184-~184: Loose punctuation mark.
Context: ...ngesevents.Mac.WindowDidChangeSpace: Triggered when the window space chang...(UNLIKELY_OPENING_PUNCTUATION)
[grammar] ~185-~185: Did you mean “spaces”?
Context: ...ngeSpace: Triggered when the window space changesevents.Mac.WindowDidChangeSpa...(WRB_DT_NN_VB)
[uncategorized] ~187-~187: Loose punctuation mark.
Context: ...s.Mac.WindowDidChangeSpaceOrderingMode` : Triggered when the window space order...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~190-~190: Loose punctuation mark.
Context: ...ngesevents.Mac.WindowDidChangeTitle: Triggered when the window title chang...(UNLIKELY_OPENING_PUNCTUATION)
[grammar] ~191-~191: Did you mean “titles”?
Context: ...ngeTitle: Triggered when the window title changesevents.Mac.WindowDidChangeToo...(WRB_DT_NN_VB)
[uncategorized] ~193-~193: Loose punctuation mark.
Context: ...esevents.Mac.WindowDidChangeToolbar: Triggered when the window toolbar cha...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~196-~196: Loose punctuation mark.
Context: ...events.Mac.WindowDidChangeVisibility: Triggered when the window visibility ...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~199-~199: Loose punctuation mark.
Context: ...esevents.Mac.WindowDidDeminiaturize: Triggered when the window is deminiat...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~202-~202: Loose punctuation mark.
Context: ...turizedevents.Mac.WindowDidEndSheet: Triggered when the window ends a shee...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~205-~205: Loose punctuation mark.
Context: ...events.Mac.WindowDidEnterFullScreen: Triggered when the window enters full...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~208-~208: Loose punctuation mark.
Context: ...vents.Mac.WindowDidEnterVersionBrowser` : Triggered when the window enters vers...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~211-~211: Loose punctuation mark.
Context: ...revents.Mac.WindowDidExitFullScreen: Triggered when the window exits fulls...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~214-~214: Loose punctuation mark.
Context: ...events.Mac.WindowDidExitVersionBrowser` : Triggered when the window exits versi...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~217-~217: Loose punctuation mark.
Context: ...n browserevents.Mac.WindowDidExpose: Triggered when the window is exposed ...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~220-~220: Loose punctuation mark.
Context: ...is exposedevents.Mac.WindowDidFocus: Triggered when the window is focused ...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~223-~223: Loose punctuation mark.
Context: ...usedevents.Mac.WindowDidMiniaturize: Triggered when the window is miniatur...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~226-~226: Loose punctuation mark.
Context: ...iniaturizedevents.Mac.WindowDidMove: Triggered when the window is moved `...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~229-~229: Loose punctuation mark.
Context: ...devents.Mac.WindowDidOrderOffScreen: Triggered when the window is ordered ...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~230-~230: The adjective or adverb “off-screen” is spelled with a hyphen.
Context: ... Triggered when the window is ordered off screenevents.Mac.WindowDidOrderOnScreen: ...(ON_OFF_SCREEN_HYPHEN)
[uncategorized] ~232-~232: Loose punctuation mark.
Context: ...enevents.Mac.WindowDidOrderOnScreen: Triggered when the window is ordered ...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~235-~235: Loose punctuation mark.
Context: ...screenevents.Mac.WindowDidResignKey: Triggered when the window resigns key...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~238-~238: Loose punctuation mark.
Context: ...s keyevents.Mac.WindowDidResignMain: Triggered when the window resigns mai...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~241-~241: Loose punctuation mark.
Context: ...igns mainevents.Mac.WindowDidResize: Triggered when the window is resized ...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~244-~244: Loose punctuation mark.
Context: ...s resizedevents.Mac.WindowDidUpdate: Triggered when the window updates `e...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~247-~247: Loose punctuation mark.
Context: ...atesevents.Mac.WindowDidUpdateAlpha: Triggered when the window alpha updat...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~250-~250: Loose punctuation mark.
Context: ....Mac.WindowDidUpdateCollectionBehavior` : Triggered when the window collection ...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~253-~253: Loose punctuation mark.
Context: ...ac.WindowDidUpdateCollectionProperties` : Triggered when the window collection ...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~256-~256: Loose punctuation mark.
Context: ...ateevents.Mac.WindowDidUpdateShadow: Triggered when the window shadow upda...(UNLIKELY_OPENING_PUNCTUATION)
[grammar] ~257-~257: Did you mean “shadows”?
Context: ...teShadow: Triggered when the window shadow updatesevents.Mac.WindowDidUpdateTit...(WRB_DT_NN_VB)
[uncategorized] ~259-~259: Loose punctuation mark.
Context: ...atesevents.Mac.WindowDidUpdateTitle: Triggered when the window title updat...(UNLIKELY_OPENING_PUNCTUATION)
[grammar] ~260-~260: Did you mean “titles”?
Context: ...ateTitle: Triggered when the window title updatesevents.Mac.WindowDidUpdateToo...(WRB_DT_NN_VB)
[uncategorized] ~262-~262: Loose punctuation mark.
Context: ...esevents.Mac.WindowDidUpdateToolbar: Triggered when the window toolbar upd...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~265-~265: Loose punctuation mark.
Context: ...events.Mac.WindowDidUpdateVisibility: Triggered when the window visibility ...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~268-~268: Loose punctuation mark.
Context: ...updatesevents.Mac.WindowShouldClose: Triggered when the window should clos...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~271-~271: Loose punctuation mark.
Context: ...closeevents.Mac.WindowWillBecomeKey: Triggered when the window will become...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~274-~274: Loose punctuation mark.
Context: ... keyevents.Mac.WindowWillBecomeMain: Triggered when the window will become...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~277-~277: Loose punctuation mark.
Context: ...mainevents.Mac.WindowWillBeginSheet: Triggered when the window will begin ...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~280-~280: Loose punctuation mark.
Context: ...vents.Mac.WindowWillChangeOrderingMode` : Triggered when the window will change...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~283-~283: Loose punctuation mark.
Context: ...ring modeevents.Mac.WindowWillClose: Triggered when the window will close ...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~286-~286: Loose punctuation mark.
Context: ...eevents.Mac.WindowWillDeminiaturize: Triggered when the window will demini...(UNLIKELY_OPENING_PUNCTUATION)
[grammar] ~287-~287: Did you mean “wills”?
Context: ...iaturize: Triggered when the window will deminiaturizeevents.Mac.WindowWillEn...(WRB_DT_NN_VB)
[uncategorized] ~289-~289: Loose punctuation mark.
Context: ...events.Mac.WindowWillEnterFullScreen: Triggered when the window will enter ...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~292-~292: Loose punctuation mark.
Context: ...ents.Mac.WindowWillEnterVersionBrowser` : Triggered when the window will enter ...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~295-~295: Loose punctuation mark.
Context: ...events.Mac.WindowWillExitFullScreen: Triggered when the window will exit f...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~298-~298: Loose punctuation mark.
Context: ...vents.Mac.WindowWillExitVersionBrowser` : Triggered when the window will exit v...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~301-~301: Loose punctuation mark.
Context: ...n browserevents.Mac.WindowWillFocus: Triggered when the window will focus ...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~304-~304: Loose punctuation mark.
Context: ...cusevents.Mac.WindowWillMiniaturize: Triggered when the window will miniat...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~307-~307: Loose punctuation mark.
Context: ...iniaturizeevents.Mac.WindowWillMove: Triggered when the window will move ...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~310-~310: Loose punctuation mark.
Context: ...events.Mac.WindowWillOrderOffScreen: Triggered when the window will order ...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~311-~311: The adjective or adverb “off-screen” is spelled with a hyphen.
Context: ... Triggered when the window will order off screenevents.Mac.WindowWillOrderOnScreen:...(ON_OFF_SCREEN_HYPHEN)
[uncategorized] ~313-~313: Loose punctuation mark.
Context: ...nevents.Mac.WindowWillOrderOnScreen: Triggered when the window will order ...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~316-~316: Loose punctuation mark.
Context: ...eenevents.Mac.WindowWillResignMain` : Triggered when the window will resign...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~319-~319: Loose punctuation mark.
Context: ...ign mainevents.Mac.WindowWillResize: Triggered when the window will resize...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~322-~322: Loose punctuation mark.
Context: ... resizeevents.Mac.WindowWillUnfocus: Triggered when the window will unfocu...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~325-~325: Loose punctuation mark.
Context: ...unfocusevents.Mac.WindowWillUpdate` : Triggered when the window will update...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~328-~328: Loose punctuation mark.
Context: ...ateevents.Mac.WindowWillUpdateAlpha: Triggered when the window will update...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~331-~331: Loose punctuation mark.
Context: ...Mac.WindowWillUpdateCollectionBehavior` : Triggered when the window will update...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~334-~334: Loose punctuation mark.
Context: ...c.WindowWillUpdateCollectionProperties` : Triggered when the window will update...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~337-~337: Loose punctuation mark.
Context: ...esevents.Mac.WindowWillUpdateShadow: Triggered when the window will update...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~340-~340: Loose punctuation mark.
Context: ...dowevents.Mac.WindowWillUpdateTitle: Triggered when the window will update...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~343-~343: Loose punctuation mark.
Context: ...eevents.Mac.WindowWillUpdateToolbar: Triggered when the window will update...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~346-~346: Loose punctuation mark.
Context: ...events.Mac.WindowWillUpdateVisibility: Triggered when the window will update...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~349-~349: Loose punctuation mark.
Context: ...events.Mac.WindowWillUseStandardFrame: Triggered when the window will use st...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~352-~352: Loose punctuation mark.
Context: ...c.WebviewDidStartProvisionalNavigation` : Triggered when the webview starts a p...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~355-~355: Loose punctuation mark.
Context: ...ServerRedirectForProvisionalNavigation` : Triggered when the webview receives a...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~358-~358: Loose punctuation mark.
Context: ...events.Mac.WebviewDidFinishNavigation: Triggered when the webview finishes n...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~361-~361: Loose punctuation mark.
Context: ...events.Mac.WebviewDidCommitNavigation: Triggered when the webview commits na...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~364-~364: Loose punctuation mark.
Context: ...events.Mac.WindowFileDraggingEntered: Triggered when files are dragged into...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~367-~367: Loose punctuation mark.
Context: ...events.Mac.WindowFileDraggingPerformed` : Triggered when files are dragged in t...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~370-~370: Loose punctuation mark.
Context: ...events.Mac.WindowFileDraggingExited: Triggered when files are dragged out ...(UNLIKELY_OPENING_PUNCTUATION)
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
📒 Files selected for processing (8)
mkdocs-website/docs/en/API/application_events.md(1 hunks)mkdocs-website/docs/en/API/event_hooks.md(1 hunks)mkdocs-website/docs/en/API/events.md(1 hunks)mkdocs-website/docs/en/API/events_linux.md(1 hunks)mkdocs-website/docs/en/API/events_mac.md(1 hunks)mkdocs-website/docs/en/API/events_windows.md(1 hunks)mkdocs-website/docs/en/changelog.md(1 hunks)mkdocs-website/mkdocs.yml(2 hunks)
🚧 Files skipped from review as they are similar to previous changes (3)
- mkdocs-website/docs/en/API/application_events.md
- mkdocs-website/docs/en/changelog.md
- mkdocs-website/mkdocs.yml
🧰 Additional context used
🪛 LanguageTool
mkdocs-website/docs/en/API/event_hooks.md
[uncategorized] ~42-~42: Loose punctuation mark.
Context: ...e. events.Common.ApplicationStarted` : Triggered when the application starts...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~45-~45: Loose punctuation mark.
Context: ...on starts events.Common.ThemeChanged : Triggered when the application theme ...
(UNLIKELY_OPENING_PUNCTUATION)
[grammar] ~46-~46: Did you mean “themes”?
Context: ...ged: Triggered when the application theme changes ### Window Events events.Co...
(WRB_DT_NN_VB)
[uncategorized] ~51-~51: Loose punctuation mark.
Context: ...vents events.Common.WindowMaximised : Triggered when the window is maximise...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~54-~54: Loose punctuation mark.
Context: ...ised events.Common.WindowUnmaximised : Triggered when the window is unmaximi...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~57-~57: Loose punctuation mark.
Context: ...mised events.Common.WindowMinimised : Triggered when the window is minimise...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~60-~60: Loose punctuation mark.
Context: ...ised events.Common.WindowUnminimised : Triggered when the window is unminimi...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~63-~63: Loose punctuation mark.
Context: ...mised events.Common.WindowFullscreen : Triggered when the window is set to f...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~66-~66: Loose punctuation mark.
Context: ...een events.Common.WindowUnfullscreen : Triggered when the window is unfullsc...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~69-~69: Loose punctuation mark.
Context: ...creened events.Common.WindowRestored : Triggered when the window is restored...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~72-~72: Loose punctuation mark.
Context: ...restored events.Common.WindowClosing : Triggered before the window closes `...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~75-~75: Loose punctuation mark.
Context: ...dow closes events.Common.WindowZoom : Triggered when the window is zoomed ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~78-~78: Loose punctuation mark.
Context: ...s zoomed events.Common.WindowZoomOut : Triggered when the window is zoomed o...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~81-~81: Loose punctuation mark.
Context: ...omed out events.Common.WindowZoomIn : Triggered when the window is zoomed i...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~84-~84: Loose punctuation mark.
Context: ...med in events.Common.WindowZoomReset : Triggered when the window zoom is res...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~87-~87: Loose punctuation mark.
Context: ... is reset events.Common.WindowFocus : Triggered when the window gains focus...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~90-~90: Loose punctuation mark.
Context: ...focus events.Common.WindowLostFocus : Triggered when the window loses focus...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~93-~93: Loose punctuation mark.
Context: ...loses focus events.Common.WindowShow : Triggered when the window is shown `...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~96-~96: Loose punctuation mark.
Context: ...w is shown events.Common.WindowHide : Triggered when the window is hidden ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~99-~99: Loose punctuation mark.
Context: ...idden events.Common.WindowDPIChanged : Triggered when the window DPI changes...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~102-~102: Loose punctuation mark.
Context: ...ges events.Common.WindowFilesDropped : Triggered when files are dropped on t...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~105-~105: Loose punctuation mark.
Context: ...dow events.Common.WindowRuntimeReady : Triggered when the window runtime is ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~108-~108: Loose punctuation mark.
Context: ...s ready events.Common.WindowDidMove : Triggered when the window is moved `...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~111-~111: Loose punctuation mark.
Context: ...moved events.Common.WindowDidResize :Triggered when the window is resized ##...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~114-~114: When ‘OS-Specific’ is used as a modifier, it is usually spelled with a hyphen.
Context: ...iggered when the window is resized ### OS Specific Events --8<-- ./docs/en/API/events_linu...
(SPECIFIC_HYPHEN)
mkdocs-website/docs/en/API/events.md
[style] ~11-~11: As a shorter alternative for ‘able to’, consider using “can”.
Context: ... both the frontend and backend. Events are able to emitted at both the application and the...
(BE_ABLE_TO)
[uncategorized] ~36-~36: Loose punctuation mark.
Context: ...on.EmitEvent(name string, data ...any)` : Emits an event from the application i...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~39-~39: Loose punctuation mark.
Context: ...ow.EmitEvent(name string, data ...any)` : Emits an event from the window instan...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~42-~42: Loose punctuation mark.
Context: ...nts.Emit(event:wails.Events.EventData)` : Emits an event from the frontend send...
(UNLIKELY_OPENING_PUNCTUATION)
[duplication] ~45-~45: Possible typo: you repeated a word
Context: ...escript type WailsEvent ### Receiving Events Events can be received on the application inst...
(ENGLISH_WORD_REPEAT_RULE)
[grammar] ~46-~46: Using ‘couple’ without ‘of’ is considered to be informal.
Context: ...cation instance and the frontend with a couple options of how you chose to receive them. You ...
(PLENTY_OF_NOUNS)
[uncategorized] ~47-~47: Use a comma before ‘or’ if it connects two independent clauses (unless they are closely connected and short).
Context: ... trigger every time the event is emitted or you can register an event listener that...
(COMMA_COMPOUND_SENTENCE)
[uncategorized] ~52-~52: Loose punctuation mark.
Context: ...ame string, handler func(data ...any))` : Registers an event on the application...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~55-~55: Loose punctuation mark.
Context: ... handler func(data ...any), count int)` : Registers an event on the application...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~60-~60: Loose punctuation mark.
Context: ...ts.On(name: string, callback: ()=>void)`, : Registers an event on the frontend...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~63-~63: Loose punctuation mark.
Context: ....Once(name: string, callback: ()=>void)`, : Registers an event on the frontend...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~66-~66: Loose punctuation mark.
Context: ...ing, callback: ()=>void, count: number)`, : Registers an event on the frontend...
(UNLIKELY_OPENING_PUNCTUATION)
[style] ~70-~70: Consider removing “of” to be more concise
Context: ...s to remove events that are registered. All of the registration functions return a functio...
(ALL_OF_THE)
[uncategorized] ~75-~75: Loose punctuation mark.
Context: ...ame string, ...additionalNames string)` : Removes an event listener with the sp...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~78-~78: Loose punctuation mark.
Context: ...ficed name application.ResetEvents() : Removes all registered events and hoo...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~83-~83: Loose punctuation mark.
Context: ...ooks Frontend wails.Events.OffAll() : Removes all registered events `wails...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~86-~86: Loose punctuation mark.
Context: ...vents wails.Events.Off(name: string) : Removes an event listener with the sp...
(UNLIKELY_OPENING_PUNCTUATION)
mkdocs-website/docs/en/API/events_linux.md
[uncategorized] ~5-~5: Loose punctuation mark.
Context: ...ents events.Linux.ApplicationStartup : Triggered when the application starts...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~8-~8: Loose punctuation mark.
Context: ...arts events.Linux.SystemThemeChanged : Triggered when the system theme chang...
(UNLIKELY_OPENING_PUNCTUATION)
[grammar] ~9-~9: Did you mean “themes”?
Context: ...eChanged: Triggered when the system theme changes ##### Window Events events.L...
(WRB_DT_NN_VB)
[uncategorized] ~13-~13: Loose punctuation mark.
Context: ...vents events.Linux.WindowLoadChanged : Triggered when the window load change...
(UNLIKELY_OPENING_PUNCTUATION)
[grammar] ~14-~14: Did you mean “loads”?
Context: ...dChanged: Triggered when the window load changes events.Linux.WindowDeleteEven...
(WRB_DT_NN_VB)
[uncategorized] ~16-~16: Loose punctuation mark.
Context: ...anges events.Linux.WindowDeleteEvent : Triggered when the window is deleted ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~19-~19: Loose punctuation mark.
Context: ...s deleted events.Linux.WindowDidMove : Triggered when the window is moved `...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~22-~22: Loose punctuation mark.
Context: ...s moved events.Linux.WindowDidResize : Triggered when the window is resized ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~25-~25: Loose punctuation mark.
Context: ...s resized events.Linux.WindowFocusIn : Triggered when the window gains focus...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~28-~28: Loose punctuation mark.
Context: ...ns focus events.Linux.WindowFocusOut : Triggered when the window loses focus...
(UNLIKELY_OPENING_PUNCTUATION)
mkdocs-website/docs/en/API/events_mac.md
[grammar] ~1-~1: The operating system from Apple is written “macOS”.
Context: #### MacOS Events ##### Application Events `even...
(MAC_OS)
[uncategorized] ~5-~5: Loose punctuation mark.
Context: ...events.Mac.ApplicationDidBecomeActive : Triggered when the application become...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~8-~8: Loose punctuation mark.
Context: ....ApplicationDidChangeBackingProperties` : Triggered when the application change...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~11-~11: Loose punctuation mark.
Context: ...pplicationDidChangeEffectiveAppearance` : Triggered when the application change...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~14-~14: Loose punctuation mark.
Context: ... events.Mac.ApplicationDidChangeIcon : Triggered when the application change...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~17-~17: Loose punctuation mark.
Context: ...Mac.ApplicationDidChangeOcclusionState` : Triggered when the application change...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~20-~20: Loose punctuation mark.
Context: ...c.ApplicationDidChangeScreenParameters` : Triggered when the application change...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~23-~23: Loose punctuation mark.
Context: ...Mac.ApplicationDidChangeStatusBarFrame` : Triggered when the application change...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~26-~26: Loose punctuation mark.
Context: ...licationDidChangeStatusBarOrientation` : Triggered when the application change...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~29-~29: Loose punctuation mark.
Context: ...ents.Mac.ApplicationDidFinishLaunching` : Triggered when the application finish...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~32-~32: Loose punctuation mark.
Context: ...ApplicationDidResignActiveNotification` : Triggered when the application is no ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~35-~35: Loose punctuation mark.
Context: ...active events.Mac.ApplicationDidHide : Triggered when the application is hid...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~38-~38: Loose punctuation mark.
Context: ...dden events.Mac.ApplicationDidUpdate : Triggered when the application update...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~41-~41: Loose punctuation mark.
Context: ...events.Mac.ApplicationWillBecomeActive` : Triggered when the application is abo...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~44-~44: Loose punctuation mark.
Context: ...nts.Mac.ApplicationWillFinishLaunching` : Triggered when the application is abo...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~47-~47: Loose punctuation mark.
Context: ...ching events.Mac.ApplicationWillHide : Triggered when the application is abo...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~50-~50: Loose punctuation mark.
Context: ...events.Mac.ApplicationWillResignActive` : Triggered when the application is abo...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~53-~53: Loose punctuation mark.
Context: ... events.Mac.ApplicationWillTerminate : Triggered when the application is abo...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~56-~56: Loose punctuation mark.
Context: ...ate events.Mac.ApplicationWillUnhide : Triggered when the application is abo...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~59-~59: Loose punctuation mark.
Context: ...de events.Mac.ApplicationWillUpdate : Triggered when the application is abo...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~62-~62: Loose punctuation mark.
Context: ...events.Mac.ApplicationDidChangeTheme : Triggered when the application change...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~65-~65: Loose punctuation mark.
Context: ...hanges theme events.Mac.MenuWillOpen : Triggered when the menu is about to o...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~68-~68: Loose punctuation mark.
Context: ...about to open events.Mac.MenuDidOpen : Triggered when the menu opens `event...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~71-~71: Loose punctuation mark.
Context: ...e menu opens events.Mac.MenuDidClose : Triggered when the menu closes `even...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~74-~74: Loose punctuation mark.
Context: ...closes events.Mac.MenuWillSendAction : Triggered when the menu is about to s...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~77-~77: Loose punctuation mark.
Context: ... action events.Mac.MenuDidSendAction : Triggered when the menu sends an acti...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~80-~80: Loose punctuation mark.
Context: ...ion events.Mac.MenuWillHighlightItem : Triggered when the menu is about to h...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~83-~83: Loose punctuation mark.
Context: ...item events.Mac.MenuDidHighlightItem : Triggered when the menu highlights an...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~86-~86: Loose punctuation mark.
Context: ... item events.Mac.MenuWillDisplayItem : Triggered when the menu is about to d...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~89-~89: Loose punctuation mark.
Context: ...n item events.Mac.MenuDidDisplayItem : Triggered when the menu displays an i...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~92-~92: Loose punctuation mark.
Context: ...s an item events.Mac.MenuWillAddItem : Triggered when the menu is about to a...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~95-~95: Loose punctuation mark.
Context: ...dd an item events.Mac.MenuDidAddItem : Triggered when the menu adds an item ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~98-~98: Loose punctuation mark.
Context: ...n item events.Mac.MenuWillRemoveItem : Triggered when the menu is about to r...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~101-~101: Loose punctuation mark.
Context: ...an item events.Mac.MenuDidRemoveItem : Triggered when the menu removes an it...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~104-~104: Loose punctuation mark.
Context: ...tem events.Mac.MenuWillBeginTracking : Triggered when the menu is about to b...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~107-~107: Loose punctuation mark.
Context: ...king events.Mac.MenuDidBeginTracking : Triggered when the menu begins tracki...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~110-~110: Loose punctuation mark.
Context: ...cking events.Mac.MenuWillEndTracking : Triggered when the menu is about to e...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~113-~113: Loose punctuation mark.
Context: ...acking events.Mac.MenuDidEndTracking : Triggered when the menu ends tracking...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~116-~116: Loose punctuation mark.
Context: ...s tracking events.Mac.MenuWillUpdate : Triggered when the menu is about to u...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~119-~119: Loose punctuation mark.
Context: ...t to update events.Mac.MenuDidUpdate : Triggered when the menu updates `eve...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~122-~122: Loose punctuation mark.
Context: ...enu updates events.Mac.MenuWillPopUp : Triggered when the menu is about to p...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~125-~125: Loose punctuation mark.
Context: ...ut to pop up events.Mac.MenuDidPopUp : Triggered when the menu pops up `eve...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~128-~128: Loose punctuation mark.
Context: ... events.Mac.MenuWillSendActionToItem : Triggered when the menu is about to s...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~131-~131: Loose punctuation mark.
Context: ...m events.Mac.MenuDidSendActionToItem : Triggered when the menu sends an acti...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~136-~136: Loose punctuation mark.
Context: ...Events events.Mac.WindowDidBecomeKey : Triggered when the window becomes key...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~139-~139: Loose punctuation mark.
Context: ...s key events.Mac.WindowDidBecomeMain : Triggered when the window becomes mai...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~142-~142: Loose punctuation mark.
Context: ... main events.Mac.WindowDidBeginSheet : Triggered when the window begins a sh...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~145-~145: Loose punctuation mark.
Context: ...heet events.Mac.WindowDidChangeAlpha : Triggered when the window alpha chang...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~148-~148: Loose punctuation mark.
Context: ...nts.Mac.WindowDidChangeBackingLocation` : Triggered when the window backing loc...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~151-~151: Loose punctuation mark.
Context: ...s.Mac.WindowDidChangeBackingProperties` : Triggered when the window backing pro...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~154-~154: Loose punctuation mark.
Context: ....Mac.WindowDidChangeCollectionBehavior` : Triggered when the window collection ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~157-~157: Loose punctuation mark.
Context: ...Mac.WindowDidChangeEffectiveAppearance` : Triggered when the window effective a...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~160-~160: Loose punctuation mark.
Context: ...ents.Mac.WindowDidChangeOcclusionState` : Triggered when the window occlusion s...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~163-~163: Loose punctuation mark.
Context: ...events.Mac.WindowDidChangeOrderingMode` : Triggered when the window ordering mo...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~166-~166: Loose punctuation mark.
Context: ...ges events.Mac.WindowDidChangeScreen : Triggered when the window screen chan...
(UNLIKELY_OPENING_PUNCTUATION)
[grammar] ~167-~167: Did you mean “screens”?
Context: ...geScreen: Triggered when the window screen changes events.Mac.WindowDidChangeScr...
(WRB_DT_NN_VB)
[uncategorized] ~169-~169: Loose punctuation mark.
Context: ...ts.Mac.WindowDidChangeScreenParameters` : Triggered when the window screen para...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~172-~172: Loose punctuation mark.
Context: ...vents.Mac.WindowDidChangeScreenProfile` : Triggered when the window screen prof...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~175-~175: Loose punctuation mark.
Context: ...events.Mac.WindowDidChangeScreenSpace : Triggered when the window screen spac...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~178-~178: Loose punctuation mark.
Context: ...c.WindowDidChangeScreenSpaceProperties` : Triggered when the window screen spac...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~181-~181: Loose punctuation mark.
Context: ...events.Mac.WindowDidChangeSharingType : Triggered when the window sharing typ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~184-~184: Loose punctuation mark.
Context: ...nges events.Mac.WindowDidChangeSpace : Triggered when the window space chang...
(UNLIKELY_OPENING_PUNCTUATION)
[grammar] ~185-~185: Did you mean “spaces”?
Context: ...ngeSpace: Triggered when the window space changes events.Mac.WindowDidChangeSpa...
(WRB_DT_NN_VB)
[uncategorized] ~187-~187: Loose punctuation mark.
Context: ...s.Mac.WindowDidChangeSpaceOrderingMode` : Triggered when the window space order...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~190-~190: Loose punctuation mark.
Context: ...nges events.Mac.WindowDidChangeTitle : Triggered when the window title chang...
(UNLIKELY_OPENING_PUNCTUATION)
[grammar] ~191-~191: Did you mean “titles”?
Context: ...ngeTitle: Triggered when the window title changes events.Mac.WindowDidChangeToo...
(WRB_DT_NN_VB)
[uncategorized] ~193-~193: Loose punctuation mark.
Context: ...es events.Mac.WindowDidChangeToolbar : Triggered when the window toolbar cha...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~196-~196: Loose punctuation mark.
Context: ... events.Mac.WindowDidChangeVisibility : Triggered when the window visibility ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~199-~199: Loose punctuation mark.
Context: ...es events.Mac.WindowDidDeminiaturize : Triggered when the window is deminiat...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~202-~202: Loose punctuation mark.
Context: ...turized events.Mac.WindowDidEndSheet : Triggered when the window ends a shee...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~205-~205: Loose punctuation mark.
Context: ... events.Mac.WindowDidEnterFullScreen : Triggered when the window enters full...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~208-~208: Loose punctuation mark.
Context: ...vents.Mac.WindowDidEnterVersionBrowser` : Triggered when the window enters vers...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~211-~211: Loose punctuation mark.
Context: ...r events.Mac.WindowDidExitFullScreen : Triggered when the window exits fulls...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~214-~214: Loose punctuation mark.
Context: ...events.Mac.WindowDidExitVersionBrowser` : Triggered when the window exits versi...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~217-~217: Loose punctuation mark.
Context: ...n browser events.Mac.WindowDidExpose : Triggered when the window is exposed ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~220-~220: Loose punctuation mark.
Context: ...is exposed events.Mac.WindowDidFocus : Triggered when the window is focused ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~223-~223: Loose punctuation mark.
Context: ...used events.Mac.WindowDidMiniaturize : Triggered when the window is miniatur...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~226-~226: Loose punctuation mark.
Context: ...iniaturized events.Mac.WindowDidMove : Triggered when the window is moved `...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~229-~229: Loose punctuation mark.
Context: ...d events.Mac.WindowDidOrderOffScreen : Triggered when the window is ordered ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~230-~230: The adjective or adverb “off-screen” is spelled with a hyphen.
Context: ... Triggered when the window is ordered off screen events.Mac.WindowDidOrderOnScreen : ...
(ON_OFF_SCREEN_HYPHEN)
[uncategorized] ~232-~232: Loose punctuation mark.
Context: ...en events.Mac.WindowDidOrderOnScreen : Triggered when the window is ordered ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~235-~235: Loose punctuation mark.
Context: ...screen events.Mac.WindowDidResignKey : Triggered when the window resigns key...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~238-~238: Loose punctuation mark.
Context: ...s key events.Mac.WindowDidResignMain : Triggered when the window resigns mai...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~241-~241: Loose punctuation mark.
Context: ...igns main events.Mac.WindowDidResize : Triggered when the window is resized ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~244-~244: Loose punctuation mark.
Context: ...s resized events.Mac.WindowDidUpdate : Triggered when the window updates `e...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~247-~247: Loose punctuation mark.
Context: ...ates events.Mac.WindowDidUpdateAlpha : Triggered when the window alpha updat...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~250-~250: Loose punctuation mark.
Context: ....Mac.WindowDidUpdateCollectionBehavior` : Triggered when the window collection ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~253-~253: Loose punctuation mark.
Context: ...ac.WindowDidUpdateCollectionProperties` : Triggered when the window collection ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~256-~256: Loose punctuation mark.
Context: ...ate events.Mac.WindowDidUpdateShadow : Triggered when the window shadow upda...
(UNLIKELY_OPENING_PUNCTUATION)
[grammar] ~257-~257: Did you mean “shadows”?
Context: ...teShadow: Triggered when the window shadow updates events.Mac.WindowDidUpdateTit...
(WRB_DT_NN_VB)
[uncategorized] ~259-~259: Loose punctuation mark.
Context: ...ates events.Mac.WindowDidUpdateTitle : Triggered when the window title updat...
(UNLIKELY_OPENING_PUNCTUATION)
[grammar] ~260-~260: Did you mean “titles”?
Context: ...ateTitle: Triggered when the window title updates events.Mac.WindowDidUpdateToo...
(WRB_DT_NN_VB)
[uncategorized] ~262-~262: Loose punctuation mark.
Context: ...es events.Mac.WindowDidUpdateToolbar : Triggered when the window toolbar upd...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~265-~265: Loose punctuation mark.
Context: ... events.Mac.WindowDidUpdateVisibility : Triggered when the window visibility ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~268-~268: Loose punctuation mark.
Context: ...updates events.Mac.WindowShouldClose : Triggered when the window should clos...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~271-~271: Loose punctuation mark.
Context: ...close events.Mac.WindowWillBecomeKey : Triggered when the window will become...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~274-~274: Loose punctuation mark.
Context: ... key events.Mac.WindowWillBecomeMain : Triggered when the window will become...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~277-~277: Loose punctuation mark.
Context: ...main events.Mac.WindowWillBeginSheet : Triggered when the window will begin ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~280-~280: Loose punctuation mark.
Context: ...vents.Mac.WindowWillChangeOrderingMode` : Triggered when the window will change...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~283-~283: Loose punctuation mark.
Context: ...ring mode events.Mac.WindowWillClose : Triggered when the window will close ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~286-~286: Loose punctuation mark.
Context: ...e events.Mac.WindowWillDeminiaturize : Triggered when the window will demini...
(UNLIKELY_OPENING_PUNCTUATION)
[grammar] ~287-~287: Did you mean “wills”?
Context: ...iaturize: Triggered when the window will deminiaturize events.Mac.WindowWillEn...
(WRB_DT_NN_VB)
[uncategorized] ~289-~289: Loose punctuation mark.
Context: ... events.Mac.WindowWillEnterFullScreen : Triggered when the window will enter ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~292-~292: Loose punctuation mark.
Context: ...ents.Mac.WindowWillEnterVersionBrowser` : Triggered when the window will enter ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~295-~295: Loose punctuation mark.
Context: ... events.Mac.WindowWillExitFullScreen : Triggered when the window will exit f...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~298-~298: Loose punctuation mark.
Context: ...vents.Mac.WindowWillExitVersionBrowser` : Triggered when the window will exit v...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~301-~301: Loose punctuation mark.
Context: ...n browser events.Mac.WindowWillFocus : Triggered when the window will focus ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~304-~304: Loose punctuation mark.
Context: ...cus events.Mac.WindowWillMiniaturize : Triggered when the window will miniat...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~307-~307: Loose punctuation mark.
Context: ...iniaturize events.Mac.WindowWillMove : Triggered when the window will move ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~310-~310: Loose punctuation mark.
Context: ... events.Mac.WindowWillOrderOffScreen : Triggered when the window will order ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~311-~311: The adjective or adverb “off-screen” is spelled with a hyphen.
Context: ... Triggered when the window will order off screen events.Mac.WindowWillOrderOnScreen :...
(ON_OFF_SCREEN_HYPHEN)
[uncategorized] ~313-~313: Loose punctuation mark.
Context: ...n events.Mac.WindowWillOrderOnScreen : Triggered when the window will order ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~316-~316: Loose punctuation mark.
Context: ...een events.Mac.WindowWillResignMain` : Triggered when the window will resign...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~319-~319: Loose punctuation mark.
Context: ...ign main events.Mac.WindowWillResize : Triggered when the window will resize...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~322-~322: Loose punctuation mark.
Context: ... resize events.Mac.WindowWillUnfocus : Triggered when the window will unfocu...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~325-~325: Loose punctuation mark.
Context: ...unfocus events.Mac.WindowWillUpdate` : Triggered when the window will update...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~328-~328: Loose punctuation mark.
Context: ...ate events.Mac.WindowWillUpdateAlpha : Triggered when the window will update...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~331-~331: Loose punctuation mark.
Context: ...Mac.WindowWillUpdateCollectionBehavior` : Triggered when the window will update...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~334-~334: Loose punctuation mark.
Context: ...c.WindowWillUpdateCollectionProperties` : Triggered when the window will update...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~337-~337: Loose punctuation mark.
Context: ...es events.Mac.WindowWillUpdateShadow : Triggered when the window will update...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~340-~340: Loose punctuation mark.
Context: ...dow events.Mac.WindowWillUpdateTitle : Triggered when the window will update...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~343-~343: Loose punctuation mark.
Context: ...e events.Mac.WindowWillUpdateToolbar : Triggered when the window will update...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~346-~346: Loose punctuation mark.
Context: ...events.Mac.WindowWillUpdateVisibility : Triggered when the window will update...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~349-~349: Loose punctuation mark.
Context: ...events.Mac.WindowWillUseStandardFrame : Triggered when the window will use st...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~352-~352: Loose punctuation mark.
Context: ...c.WebviewDidStartProvisionalNavigation` : Triggered when the webview starts a p...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~355-~355: Loose punctuation mark.
Context: ...ServerRedirectForProvisionalNavigation` : Triggered when the webview receives a...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~358-~358: Loose punctuation mark.
Context: ...events.Mac.WebviewDidFinishNavigation : Triggered when the webview finishes n...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~361-~361: Loose punctuation mark.
Context: ...events.Mac.WebviewDidCommitNavigation : Triggered when the webview commits na...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~364-~364: Loose punctuation mark.
Context: ... events.Mac.WindowFileDraggingEntered : Triggered when files are dragged into...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~367-~367: Loose punctuation mark.
Context: ...events.Mac.WindowFileDraggingPerformed` : Triggered when files are dragged in t...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~370-~370: Loose punctuation mark.
Context: ... events.Mac.WindowFileDraggingExited : Triggered when files are dragged out ...
(UNLIKELY_OPENING_PUNCTUATION)
mkdocs-website/docs/en/API/events_windows.md
[uncategorized] ~5-~5: Loose punctuation mark.
Context: ...ts events.Windows.ApplicationStarted : Triggered when the application starts...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~8-~8: Loose punctuation mark.
Context: ...s events.Windows.SystemThemeChanged : Triggered when the system theme chang...
(UNLIKELY_OPENING_PUNCTUATION)
[grammar] ~9-~9: Did you mean “themes”?
Context: ...Changed : Triggered when the system theme changes events.Windows.APMPowerStatus...
(WRB_DT_NN_VB)
[uncategorized] ~11-~11: Loose punctuation mark.
Context: ... events.Windows.APMPowerStatusChange : Triggered when the system power statu...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~14-~14: Loose punctuation mark.
Context: ...s changes events.Windows.APMSuspend : Triggered when the system suspends `...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~17-~17: Loose punctuation mark.
Context: ...ds events.Windows.APMResumeAutomatic : Triggered when the system resumes aft...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~20-~20: Loose punctuation mark.
Context: ...leep events.Windows.APMResumeSuspend : Triggered when the system resumes aft...
(UNLIKELY_OPENING_PUNCTUATION)
[grammar] ~21-~21: The verb ‘suspend’ does not usually follow articles like ‘a’. Check that ‘suspend’ is spelled correctly; using ‘suspend’ as a noun may be non-standard.
Context: ...Triggered when the system resumes after a suspend and resume was triggered by the user #...
(A_INFINITIVE)
[uncategorized] ~25-~25: Loose punctuation mark.
Context: ...nts.Windows.WebviewNavigationCompleted` : Triggered when the webview navigation...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~28-~28: Loose punctuation mark.
Context: ...pleted events.Windows.WindowInactive : Triggered when the window is inactive...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~31-~31: Loose punctuation mark.
Context: ...inactive events.Windows.WindowActive : Triggered when the window is active ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~34-~34: Loose punctuation mark.
Context: ...is active events.Windows.ClickActive : Triggered when the window is activate...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~37-~37: Loose punctuation mark.
Context: ... click events.Windows.MaximiseActive : Triggered when the window is maximise...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~40-~40: Loose punctuation mark.
Context: ... maximised events.Windows.UnMaximise : Triggered when the window is unmaximi...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~43-~43: Loose punctuation mark.
Context: ...nmaximised events.Windows.Fullscreen : Triggered when the window is set to f...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~46-~46: Loose punctuation mark.
Context: ...llscreen events.Windows.UnFullscreen : Triggered when the window is exited f...
(UNLIKELY_OPENING_PUNCTUATION)
[style] ~47-~47: This phrase is redundant. Consider writing “exited”.
Context: ...creen: Triggered when the window is exited from fullscreene events.Windows.WindowRest...
(EXIT_FROM)
[uncategorized] ~49-~49: Loose punctuation mark.
Context: ...screene events.Windows.WindowRestore : Triggered when the window is restored...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~52-~52: Loose punctuation mark.
Context: ...stored events.Windows.WindowMinimise : Triggered when the window is minimise...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~55-~55: Loose punctuation mark.
Context: ...ised events.Windows.WindowUnminimise : Triggered when the window is unminimi...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~58-~58: Loose punctuation mark.
Context: ...minimised events.Windows.WindowClose : Triggered before the window closes `e...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~63-~63: Loose punctuation mark.
Context: ...focus events.Windows.WindowKillFocus : Triggered when the window loses keybo...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~66-~66: Loose punctuation mark.
Context: ... focus events.Windows.WindowDragDrop : Triggered when files are dropped on t...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~69-~69: Loose punctuation mark.
Context: ...indow events.Windows.WindowDragEnter : Triggered when a drag enters the wind...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~72-~72: Loose punctuation mark.
Context: ...indow events.Windows.WindowDragLeave : Triggered when a drag leaves the wind...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~75-~75: Loose punctuation mark.
Context: ...window events.Windows.WindowDragOver : Triggered when a drag is over the win...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~78-~78: Loose punctuation mark.
Context: ... window events.Windows.WindowDidMove : Triggered after a window has moved
(UNLIKELY_OPENING_PUNCTUATION)
🪛 Markdownlint
mkdocs-website/docs/en/API/events.md
96-96: Column: 1
Hard tabs
(MD010, no-hard-tabs)
97-97: Column: 1
Hard tabs
(MD010, no-hard-tabs)
98-98: Column: 1
Hard tabs
(MD010, no-hard-tabs)
109-109: Column: 1
Hard tabs
(MD010, no-hard-tabs)
110-110: Column: 1
Hard tabs
(MD010, no-hard-tabs)
123-123: Column: 1
Hard tabs
(MD010, no-hard-tabs)
124-124: Column: 1
Hard tabs
(MD010, no-hard-tabs)
125-125: Column: 1
Hard tabs
(MD010, no-hard-tabs)
126-126: Column: 1
Hard tabs
(MD010, no-hard-tabs)
94-94: Expected: indented; Actual: fenced
Code block style
(MD046, code-block-style)
107-107: Expected: indented; Actual: fenced
Code block style
(MD046, code-block-style)
121-121: Expected: indented; Actual: fenced
Code block style
(MD046, code-block-style)
🔇 Additional comments (2)
mkdocs-website/docs/en/API/events_linux.md (1)
13-15: Clarify WindowLoadChanged event description.
The current description "Triggered when the window load changes" is ambiguous. Please specify:
- What constitutes a "load change"
- Common scenarios when this event fires
- Any relationship with other window events
Let's check how this event is used in the codebase:
✅ Verification successful
Let me search for more specific implementation details about the WindowLoadChanged event:
Based on the implementation details found, I can now provide a clear explanation of the WindowLoadChanged event:
Improve WindowLoadChanged event description with implementation details
The WindowLoadChanged event is triggered when the window's content has finished loading. This event is specifically used to:
- Execute any custom JavaScript defined in the window options
- Apply any custom CSS styles to the window
- Initialize the Wails runtime core functionality
This event is important for developers who need to perform initialization tasks after the window content is fully loaded.
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Search for WindowLoadChanged usage in the source code
rg -A 5 "WindowLoadChanged"
Length of output: 148923
Script:
#!/bin/bash
# Search for WindowLoadChanged implementation details
rg -A 10 "WindowLoadChanged" v3/pkg/application/
Length of output: 2492
🧰 Tools
🪛 LanguageTool
[uncategorized] ~13-~13: Loose punctuation mark.
Context: ...vents events.Linux.WindowLoadChanged : Triggered when the window load change...
(UNLIKELY_OPENING_PUNCTUATION)
[grammar] ~14-~14: Did you mean “loads”?
Context: ...dChanged: Triggered when the window load changes events.Linux.WindowDeleteEven...
(WRB_DT_NN_VB)
mkdocs-website/docs/en/API/events_windows.md (1)
1-4: LGTM! Well-structured documentation.
The document is properly organized with clear section headers using appropriate markdown heading levels.
Also applies to: 23-24
| wails3 provides an event system that allows for hooking into application and window events | ||
|
|
||
| ```go | ||
| // Notifcation of application start |
There was a problem hiding this comment.
Fix typo in comment
There's a typo in the comment.
-// Notifcation of application start
+// Notification of application start📝 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.
| // Notifcation of application start | |
| // Notification of application start |
| `events.Common.WindowDidResize` | ||
| :Triggered when the window is resized | ||
|
|
||
| ### OS Specific Events |
There was a problem hiding this comment.
Fix hyphenation in heading
When used as a compound modifier, "OS-Specific" should be hyphenated.
-### OS Specific Events
+### OS-Specific Events📝 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.
| ### OS Specific Events | |
| ### OS-Specific Events |
🧰 Tools
🪛 LanguageTool
[uncategorized] ~114-~114: When ‘OS-Specific’ is used as a modifier, it is usually spelled with a hyphen.
Context: ...iggered when the window is resized ### OS Specific Events --8<-- ./docs/en/API/events_linu...
(SPECIFIC_HYPHEN)
| // Notification of window focus | ||
| window.OnWindowEvent(events.Common.WindowFocus, func(e *application.WindowEvent) { |
There was a problem hiding this comment.
Use consistent method naming pattern
For consistency with other examples, use RegisterWindowEventHook instead of OnWindowEvent.
-window.OnWindowEvent(events.Common.WindowFocus, func(e *application.WindowEvent) {
+window.RegisterWindowEventHook(events.Common.WindowFocus, func(e *application.WindowEvent) {Committable suggestion was skipped due to low confidence.
| `events.Common.ApplicationStarted` | ||
| : Triggered when the application starts | ||
|
|
||
| `events.Common.ThemeChanged` | ||
| : Triggered when the application theme changes |
There was a problem hiding this comment.
Fix markdown definition list formatting
The spacing around colons in the definition list is inconsistent. According to markdown syntax, there should be no space before the colon and one space after.
-`events.Common.ApplicationStarted`
-: Triggered when the application starts
+`events.Common.ApplicationStarted`: Triggered when the application starts
-`events.Common.ThemeChanged`
-: Triggered when the application theme changes
+`events.Common.ThemeChanged`: Triggered when the application theme changes📝 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.
| `events.Common.ApplicationStarted` | |
| : Triggered when the application starts | |
| `events.Common.ThemeChanged` | |
| : Triggered when the application theme changes | |
| `events.Common.ApplicationStarted`: Triggered when the application starts | |
| `events.Common.ThemeChanged`: Triggered when the application theme changes |
🧰 Tools
🪛 LanguageTool
[uncategorized] ~42-~42: Loose punctuation mark.
Context: ...e. events.Common.ApplicationStarted` : Triggered when the application starts...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~45-~45: Loose punctuation mark.
Context: ...on starts events.Common.ThemeChanged : Triggered when the application theme ...
(UNLIKELY_OPENING_PUNCTUATION)
[grammar] ~46-~46: Did you mean “themes”?
Context: ...ged: Triggered when the application theme changes ### Window Events events.Co...
(WRB_DT_NN_VB)
| `events.Common.WindowMaximised` | ||
| : Triggered when the window is maximised | ||
|
|
||
| `events.Common.WindowUnmaximised` | ||
| : Triggered when the window is unmaximised | ||
|
|
||
| `events.Common.WindowMinimised` | ||
| : Triggered when the window is minimised | ||
|
|
||
| `events.Common.WindowUnminimised` | ||
| : Triggered when the window is unminimised | ||
|
|
||
| `events.Common.WindowFullscreen` | ||
| : Triggered when the window is set to fullscreen | ||
|
|
||
| `events.Common.WindowUnfullscreen` | ||
| : Triggered when the window is unfullscreened | ||
|
|
||
| `events.Common.WindowRestored` | ||
| : Triggered when the window is restored | ||
|
|
||
| `events.Common.WindowClosing` | ||
| : Triggered before the window closes | ||
|
|
||
| `events.Common.WindowZoom` | ||
| : Triggered when the window is zoomed | ||
|
|
||
| `events.Common.WindowZoomOut` | ||
| : Triggered when the window is zoomed out | ||
|
|
||
| `events.Common.WindowZoomIn` | ||
| : Triggered when the window is zoomed in | ||
|
|
||
| `events.Common.WindowZoomReset` | ||
| : Triggered when the window zoom is reset | ||
|
|
||
| `events.Common.WindowFocus` | ||
| : Triggered when the window gains focus | ||
|
|
||
| `events.Common.WindowLostFocus` | ||
| : Triggered when the window loses focus | ||
|
|
||
| `events.Common.WindowShow` | ||
| : Triggered when the window is shown | ||
|
|
||
| `events.Common.WindowHide` | ||
| : Triggered when the window is hidden | ||
|
|
||
| `events.Common.WindowDPIChanged` | ||
| : Triggered when the window DPI changes | ||
|
|
||
| `events.Common.WindowFilesDropped` | ||
| : Triggered when files are dropped on the window | ||
|
|
||
| `events.Common.WindowRuntimeReady` | ||
| : Triggered when the window runtime is ready | ||
|
|
||
| `events.Common.WindowDidMove` | ||
| : Triggered when the window is moved |
There was a problem hiding this comment.
Fix markdown definition list formatting throughout Window Events section
The spacing around colons in the definition list is inconsistent throughout the section. According to markdown syntax, there should be no space before the colon and one space after.
Example fix (apply similar changes to all events):
-`events.Common.WindowMaximised`
-: Triggered when the window is maximised
+`events.Common.WindowMaximised`: Triggered when the window is maximisedCommittable suggestion was skipped due to low confidence.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~51-~51: Loose punctuation mark.
Context: ...vents events.Common.WindowMaximised : Triggered when the window is maximise...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~54-~54: Loose punctuation mark.
Context: ...ised events.Common.WindowUnmaximised : Triggered when the window is unmaximi...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~57-~57: Loose punctuation mark.
Context: ...mised events.Common.WindowMinimised : Triggered when the window is minimise...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~60-~60: Loose punctuation mark.
Context: ...ised events.Common.WindowUnminimised : Triggered when the window is unminimi...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~63-~63: Loose punctuation mark.
Context: ...mised events.Common.WindowFullscreen : Triggered when the window is set to f...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~66-~66: Loose punctuation mark.
Context: ...een events.Common.WindowUnfullscreen : Triggered when the window is unfullsc...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~69-~69: Loose punctuation mark.
Context: ...creened events.Common.WindowRestored : Triggered when the window is restored...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~72-~72: Loose punctuation mark.
Context: ...restored events.Common.WindowClosing : Triggered before the window closes `...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~75-~75: Loose punctuation mark.
Context: ...dow closes events.Common.WindowZoom : Triggered when the window is zoomed ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~78-~78: Loose punctuation mark.
Context: ...s zoomed events.Common.WindowZoomOut : Triggered when the window is zoomed o...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~81-~81: Loose punctuation mark.
Context: ...omed out events.Common.WindowZoomIn : Triggered when the window is zoomed i...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~84-~84: Loose punctuation mark.
Context: ...med in events.Common.WindowZoomReset : Triggered when the window zoom is res...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~87-~87: Loose punctuation mark.
Context: ... is reset events.Common.WindowFocus : Triggered when the window gains focus...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~90-~90: Loose punctuation mark.
Context: ...focus events.Common.WindowLostFocus : Triggered when the window loses focus...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~93-~93: Loose punctuation mark.
Context: ...loses focus events.Common.WindowShow : Triggered when the window is shown `...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~96-~96: Loose punctuation mark.
Context: ...w is shown events.Common.WindowHide : Triggered when the window is hidden ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~99-~99: Loose punctuation mark.
Context: ...idden events.Common.WindowDPIChanged : Triggered when the window DPI changes...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~102-~102: Loose punctuation mark.
Context: ...ges events.Common.WindowFilesDropped : Triggered when files are dropped on t...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~105-~105: Loose punctuation mark.
Context: ...dow events.Common.WindowRuntimeReady : Triggered when the window runtime is ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~108-~108: Loose punctuation mark.
Context: ...s ready events.Common.WindowDidMove : Triggered when the window is moved `...
(UNLIKELY_OPENING_PUNCTUATION)
| `events.Mac.WindowDidOrderOffScreen` | ||
| : Triggered when the window is ordered off screen |
There was a problem hiding this comment.
Fix hyphenation in technical terms.
The term "off screen" should be hyphenated as "off-screen" when used as a compound modifier.
-: Triggered when the window is ordered off screen
+: Triggered when the window is ordered off-screen-: Triggered when the window will order off screen
+: Triggered when the window will order off-screenAlso applies to: 310-311
🧰 Tools
🪛 LanguageTool
[uncategorized] ~229-~229: Loose punctuation mark.
Context: ...d events.Mac.WindowDidOrderOffScreen : Triggered when the window is ordered ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~230-~230: The adjective or adverb “off-screen” is spelled with a hyphen.
Context: ... Triggered when the window is ordered off screen events.Mac.WindowDidOrderOnScreen : ...
(ON_OFF_SCREEN_HYPHEN)
| @@ -0,0 +1,371 @@ | |||
| #### MacOS Events | |||
There was a problem hiding this comment.
Fix operating system branding.
The operating system name should be "macOS" instead of "MacOS" to align with Apple's branding guidelines.
-#### MacOS Events
+#### macOS Events📝 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.
| #### MacOS Events | |
| #### macOS Events |
🧰 Tools
🪛 LanguageTool
[grammar] ~1-~1: The operating system from Apple is written “macOS”.
Context: #### MacOS Events ##### Application Events `even...
(MAC_OS)
fix function fix nav changelog.md fix broken link appease the rabbit spell check and cleanup
atterpac
force-pushed
the
v3/docs-update
branch
from
7c203cb
to
38741c5
Compare
|
There was a problem hiding this comment.
Actionable comments posted: 5
🧹 Outside diff range and nitpick comments (7)
mkdocs-website/docs/en/API/events_linux.md (1)
5-10: Consider enhancing event descriptions with more context.While the descriptions are clear, they could be more helpful by including:
- For ApplicationStartup: When exactly in the startup sequence this fires
- For SystemThemeChanged: What theme values are possible and how to handle them
Example enhancement:
`events.Linux.ApplicationStartup` -: Triggered when the application starts +: Triggered when the application starts, after the runtime is initialized but before the main window is shown `events.Linux.SystemThemeChanged` -: Triggered when the system theme changes +: Triggered when the system theme changes between light/dark modes. Use this to dynamically update your application's appearance.🧰 Tools
🪛 LanguageTool
[uncategorized] ~5-~5: Loose punctuation mark.
Context: ...entsevents.Linux.ApplicationStartup: Triggered when the application starts...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~8-~8: Loose punctuation mark.
Context: ...artsevents.Linux.SystemThemeChanged: Triggered when the system theme chang...(UNLIKELY_OPENING_PUNCTUATION)
[grammar] ~9-~9: Did you mean “themes”?
Context: ...eChanged: Triggered when the system theme changes ##### Window Eventsevents.L...(WRB_DT_NN_VB)
mkdocs-website/docs/en/API/events_windows.md (2)
5-21: Standardize event descriptions and fix grammar.Please standardize the descriptions by:
- Adding periods at the end of each description
- Fixing grammar in the APMResumeSuspend description
Apply this diff:
`events.Windows.ApplicationStarted` -: Triggered when the application starts +: Triggered when the application starts. `events.Windows.SystemThemeChanged` -: Triggered when the system theme changes +: Triggered when the system theme changes. `events.Windows.APMPowerStatusChange` -: Triggered when the system power status changes +: Triggered when the system power status changes. `events.Windows.APMSuspend` -: Triggered when the system suspends +: Triggered when the system suspends. `events.Windows.APMResumeAutomatic` -: Triggered when the system resumes after a sleep +: Triggered when the system resumes after a sleep. `events.Windows.APMResumeSuspend` -: Triggered when the system resumes after a suspend and resume was triggered by the user +: Triggered when the system resumes from suspension triggered by the user.🧰 Tools
🪛 LanguageTool
[uncategorized] ~5-~5: Loose punctuation mark.
Context: ...tsevents.Windows.ApplicationStarted: Triggered when the application starts...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~8-~8: Loose punctuation mark.
Context: ...sevents.Windows.SystemThemeChanged: Triggered when the system theme chang...(UNLIKELY_OPENING_PUNCTUATION)
[grammar] ~9-~9: Did you mean “themes”?
Context: ...Changed: Triggered when the system theme changesevents.Windows.APMPowerStatus...(WRB_DT_NN_VB)
[uncategorized] ~11-~11: Loose punctuation mark.
Context: ...events.Windows.APMPowerStatusChange: Triggered when the system power statu...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~14-~14: Loose punctuation mark.
Context: ...s changesevents.Windows.APMSuspend: Triggered when the system suspends `...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~17-~17: Loose punctuation mark.
Context: ...dsevents.Windows.APMResumeAutomatic: Triggered when the system resumes aft...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~20-~20: Loose punctuation mark.
Context: ...leepevents.Windows.APMResumeSuspend: Triggered when the system resumes aft...(UNLIKELY_OPENING_PUNCTUATION)
[grammar] ~21-~21: The verb ‘suspend’ does not usually follow articles like ‘a’. Check that ‘suspend’ is spelled correctly; using ‘suspend’ as a noun may be non-standard.
Context: ...Triggered when the system resumes after a suspend and resume was triggered by the user #...(A_INFINITIVE)
25-79: Standardize spelling, fix typos, and improve clarity.Several issues need to be addressed:
- Standardize to American spelling (e.g., "maximized" instead of "maximised")
- Fix typo in "fullscreene"
- Add periods at the end of descriptions
- Improve clarity of some descriptions
Apply this diff:
`events.Windows.WebviewNavigationCompleted` -: Triggered when the webview navigation is completed +: Triggered when the webview navigation is completed. `events.Windows.WindowInactive` -: Triggered when the window is inactive +: Triggered when the window is inactive. `events.Windows.WindowActive` -: Triggered when the window is active +: Triggered when the window is active. `events.Windows.ClickActive` -: Triggered when the window is activated via a click +: Triggered when the window is activated via a click. `events.Windows.MaximiseActive` -: Triggered when the window is maximised +: Triggered when the window is maximized. `events.Windows.UnMaximise` -: Triggered when the window is unmaximised +: Triggered when the window is unmaximized. `events.Windows.Fullscreen` -: Triggered when the window is set to fullscreen +: Triggered when the window enters fullscreen mode. `events.Windows.UnFullscreen` -: Triggered when the window is exited from fullscreene +: Triggered when the window exits fullscreen mode. `events.Windows.WindowRestore` -: Triggered when the window is restored +: Triggered when the window is restored to its previous size and position. `events.Windows.WindowMinimise` -: Triggered when the window is minimised +: Triggered when the window is minimized. `events.Windows.WindowUnminimise` -: Triggered when the window is unminimised +: Triggered when the window is unminimized. `events.Windows.WindowClose` -: Triggered before the window closes +: Triggered before the window closes. `events.Windows.WindowSetFocus` -: Triggered when the window gains keyboard focus +: Triggered when the window gains keyboard focus. `events.Windows.WindowKillFocus` -: Triggered when the window loses keyboard focus +: Triggered when the window loses keyboard focus. `events.Windows.WindowDragDrop` -: Triggered when files are dropped on the window +: Triggered when files are dropped on the window. `events.Windows.WindowDragEnter` -: Triggered when a drag enters the window +: Triggered when a drag operation enters the window area. `events.Windows.WindowDragLeave` -: Triggered when a drag leaves the window +: Triggered when a drag operation leaves the window area. `events.Windows.WindowDragOver` -: Triggered when a drag is over the window +: Triggered when a drag operation is over the window area. `events.Windows.WindowDidMove` -: Triggered after a window has moved +: Triggered after a window has moved to a new position.🧰 Tools
🪛 LanguageTool
[uncategorized] ~25-~25: Loose punctuation mark.
Context: ...nts.Windows.WebviewNavigationCompleted` : Triggered when the webview navigation...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~28-~28: Loose punctuation mark.
Context: ...pletedevents.Windows.WindowInactive: Triggered when the window is inactive...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~31-~31: Loose punctuation mark.
Context: ...inactiveevents.Windows.WindowActive: Triggered when the window is active ...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~34-~34: Loose punctuation mark.
Context: ...is activeevents.Windows.ClickActive: Triggered when the window is activate...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~37-~37: Loose punctuation mark.
Context: ... clickevents.Windows.MaximiseActive: Triggered when the window is maximise...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~40-~40: Loose punctuation mark.
Context: ... maximisedevents.Windows.UnMaximise: Triggered when the window is unmaximi...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~43-~43: Loose punctuation mark.
Context: ...nmaximisedevents.Windows.Fullscreen: Triggered when the window is set to f...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~46-~46: Loose punctuation mark.
Context: ...llscreenevents.Windows.UnFullscreen: Triggered when the window is exited f...(UNLIKELY_OPENING_PUNCTUATION)
[style] ~47-~47: This phrase is redundant. Consider writing “exited”.
Context: ...creen: Triggered when the window is exited from fullscreeneevents.Windows.WindowRest...(EXIT_FROM)
[uncategorized] ~49-~49: Loose punctuation mark.
Context: ...screeneevents.Windows.WindowRestore: Triggered when the window is restored...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~52-~52: Loose punctuation mark.
Context: ...storedevents.Windows.WindowMinimise: Triggered when the window is minimise...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~55-~55: Loose punctuation mark.
Context: ...isedevents.Windows.WindowUnminimise: Triggered when the window is unminimi...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~58-~58: Loose punctuation mark.
Context: ...minimisedevents.Windows.WindowClose: Triggered before the window closes `e...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~63-~63: Loose punctuation mark.
Context: ...focusevents.Windows.WindowKillFocus: Triggered when the window loses keybo...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~66-~66: Loose punctuation mark.
Context: ... focusevents.Windows.WindowDragDrop: Triggered when files are dropped on t...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~69-~69: Loose punctuation mark.
Context: ...indowevents.Windows.WindowDragEnter: Triggered when a drag enters the wind...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~72-~72: Loose punctuation mark.
Context: ...indowevents.Windows.WindowDragLeave: Triggered when a drag leaves the wind...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~75-~75: Loose punctuation mark.
Context: ...windowevents.Windows.WindowDragOver: Triggered when a drag is over the win...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~78-~78: Loose punctuation mark.
Context: ... windowevents.Windows.WindowDidMove: Triggered after a window has moved(UNLIKELY_OPENING_PUNCTUATION)
mkdocs-website/docs/en/API/events.md (3)
11-12: Fix grammar in the overview textThe sentence structure needs improvement:
-Events are able to emitted at both the application and the window level. The receiver of the event gets data of where the +Events can be emitted at both the application and window levels. The receiver of the event gets data about where the🧰 Tools
🪛 LanguageTool
[style] ~11-~11: As a shorter alternative for ‘able to’, consider using “can”.
Context: ... both the frontend and backend. Events are able to emitted at both the application and the...(BE_ABLE_TO)
46-48: Improve grammar and clarity in event reception descriptionThe text needs several improvements:
-Events can be received on the application instance and the frontend with a couple options of how -you chose to receive them. You can register a single event listener that will trigger every time the event is emitted +Events can be received on both the application instance and frontend with several options for how +you choose to receive them. You can register a single event listener that will trigger every time the event is emitted,🧰 Tools
🪛 LanguageTool
[grammar] ~46-~46: Using ‘couple’ without ‘of’ is considered to be informal.
Context: ...cation instance and the frontend with a couple options of how you chose to receive them. You ...(PLENTY_OF_NOUNS)
[uncategorized] ~47-~47: Use a comma before ‘or’ if it connects two independent clauses (unless they are closely connected and short).
Context: ... trigger every time the event is emitted or you can register an event listener that...(COMMA_COMPOUND_SENTENCE)
119-120: Fix spelling and improve CustomEvent description-CustomEvent is returned when an event is being recieved it includes the name of the event, the data that was sent with the event, -the sender of the event, application or a specific window. The event can be cancelled by calling the `Cancel()` method on the event. +CustomEvent is returned when an event is received. It includes the name of the event, the data that was sent with the event, +and the sender of the event (either application or a specific window). The event can be cancelled by calling the `Cancel()` method.mkdocs-website/docs/en/API/events_mac.md (1)
5-371: Consider enhancing event descriptions for clarity and consistency.Some event descriptions could be more informative and consistent in their tense usage. Consider:
- Adding more context about when these events are typically used
- Maintaining consistent tense in descriptions (e.g., "Triggered when the window becomes..." vs "Triggered when the window will become...")
- Including parameter information if these events pass any data to handlers
Would you like me to provide specific examples of enhanced descriptions?
🧰 Tools
🪛 LanguageTool
[uncategorized] ~5-~5: Loose punctuation mark.
Context: ...events.Mac.ApplicationDidBecomeActive: Triggered when the application become...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~8-~8: Loose punctuation mark.
Context: ....ApplicationDidChangeBackingProperties` : Triggered when the application change...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~11-~11: Loose punctuation mark.
Context: ...pplicationDidChangeEffectiveAppearance` : Triggered when the application change...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~14-~14: Loose punctuation mark.
Context: ...events.Mac.ApplicationDidChangeIcon: Triggered when the application change...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~17-~17: Loose punctuation mark.
Context: ...Mac.ApplicationDidChangeOcclusionState` : Triggered when the application change...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~20-~20: Loose punctuation mark.
Context: ...c.ApplicationDidChangeScreenParameters` : Triggered when the application change...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~23-~23: Loose punctuation mark.
Context: ...Mac.ApplicationDidChangeStatusBarFrame` : Triggered when the application change...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~26-~26: Loose punctuation mark.
Context: ...licationDidChangeStatusBarOrientation` : Triggered when the application change...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~29-~29: Loose punctuation mark.
Context: ...ents.Mac.ApplicationDidFinishLaunching` : Triggered when the application finish...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~32-~32: Loose punctuation mark.
Context: ...ApplicationDidResignActiveNotification` : Triggered when the application is no ...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~35-~35: Loose punctuation mark.
Context: ...activeevents.Mac.ApplicationDidHide: Triggered when the application is hid...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~38-~38: Loose punctuation mark.
Context: ...ddenevents.Mac.ApplicationDidUpdate: Triggered when the application update...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~41-~41: Loose punctuation mark.
Context: ...events.Mac.ApplicationWillBecomeActive` : Triggered when the application is abo...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~44-~44: Loose punctuation mark.
Context: ...nts.Mac.ApplicationWillFinishLaunching` : Triggered when the application is abo...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~47-~47: Loose punctuation mark.
Context: ...chingevents.Mac.ApplicationWillHide: Triggered when the application is abo...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~50-~50: Loose punctuation mark.
Context: ...events.Mac.ApplicationWillResignActive` : Triggered when the application is abo...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~53-~53: Loose punctuation mark.
Context: ...events.Mac.ApplicationWillTerminate: Triggered when the application is abo...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~56-~56: Loose punctuation mark.
Context: ...ateevents.Mac.ApplicationWillUnhide: Triggered when the application is abo...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~59-~59: Loose punctuation mark.
Context: ...deevents.Mac.ApplicationWillUpdate: Triggered when the application is abo...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~62-~62: Loose punctuation mark.
Context: ...events.Mac.ApplicationDidChangeTheme: Triggered when the application change...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~65-~65: Loose punctuation mark.
Context: ...hanges themeevents.Mac.MenuWillOpen: Triggered when the menu is about to o...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~68-~68: Loose punctuation mark.
Context: ...about to openevents.Mac.MenuDidOpen: Triggered when the menu opens `event...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~71-~71: Loose punctuation mark.
Context: ...e menu opensevents.Mac.MenuDidClose: Triggered when the menu closes `even...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~74-~74: Loose punctuation mark.
Context: ...closesevents.Mac.MenuWillSendAction: Triggered when the menu is about to s...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~77-~77: Loose punctuation mark.
Context: ... actionevents.Mac.MenuDidSendAction: Triggered when the menu sends an acti...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~80-~80: Loose punctuation mark.
Context: ...ionevents.Mac.MenuWillHighlightItem: Triggered when the menu is about to h...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~83-~83: Loose punctuation mark.
Context: ...itemevents.Mac.MenuDidHighlightItem: Triggered when the menu highlights an...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~86-~86: Loose punctuation mark.
Context: ... itemevents.Mac.MenuWillDisplayItem: Triggered when the menu is about to d...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~89-~89: Loose punctuation mark.
Context: ...n itemevents.Mac.MenuDidDisplayItem: Triggered when the menu displays an i...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~92-~92: Loose punctuation mark.
Context: ...s an itemevents.Mac.MenuWillAddItem: Triggered when the menu is about to a...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~95-~95: Loose punctuation mark.
Context: ...dd an itemevents.Mac.MenuDidAddItem: Triggered when the menu adds an item ...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~98-~98: Loose punctuation mark.
Context: ...n itemevents.Mac.MenuWillRemoveItem: Triggered when the menu is about to r...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~101-~101: Loose punctuation mark.
Context: ...an itemevents.Mac.MenuDidRemoveItem: Triggered when the menu removes an it...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~104-~104: Loose punctuation mark.
Context: ...temevents.Mac.MenuWillBeginTracking: Triggered when the menu is about to b...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~107-~107: Loose punctuation mark.
Context: ...kingevents.Mac.MenuDidBeginTracking: Triggered when the menu begins tracki...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~110-~110: Loose punctuation mark.
Context: ...ckingevents.Mac.MenuWillEndTracking: Triggered when the menu is about to e...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~113-~113: Loose punctuation mark.
Context: ...ackingevents.Mac.MenuDidEndTracking: Triggered when the menu ends tracking...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~116-~116: Loose punctuation mark.
Context: ...s trackingevents.Mac.MenuWillUpdate: Triggered when the menu is about to u...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~119-~119: Loose punctuation mark.
Context: ...t to updateevents.Mac.MenuDidUpdate: Triggered when the menu updates `eve...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~122-~122: Loose punctuation mark.
Context: ...enu updatesevents.Mac.MenuWillPopUp: Triggered when the menu is about to p...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~125-~125: Loose punctuation mark.
Context: ...ut to pop upevents.Mac.MenuDidPopUp: Triggered when the menu pops up `eve...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~128-~128: Loose punctuation mark.
Context: ...events.Mac.MenuWillSendActionToItem: Triggered when the menu is about to s...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~131-~131: Loose punctuation mark.
Context: ...mevents.Mac.MenuDidSendActionToItem: Triggered when the menu sends an acti...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~136-~136: Loose punctuation mark.
Context: ...Eventsevents.Mac.WindowDidBecomeKey: Triggered when the window becomes key...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~139-~139: Loose punctuation mark.
Context: ...s keyevents.Mac.WindowDidBecomeMain: Triggered when the window becomes mai...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~142-~142: Loose punctuation mark.
Context: ... mainevents.Mac.WindowDidBeginSheet: Triggered when the window begins a sh...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~145-~145: Loose punctuation mark.
Context: ...heetevents.Mac.WindowDidChangeAlpha: Triggered when the window alpha chang...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~148-~148: Loose punctuation mark.
Context: ...nts.Mac.WindowDidChangeBackingLocation` : Triggered when the window backing loc...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~151-~151: Loose punctuation mark.
Context: ...s.Mac.WindowDidChangeBackingProperties` : Triggered when the window backing pro...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~154-~154: Loose punctuation mark.
Context: ....Mac.WindowDidChangeCollectionBehavior` : Triggered when the window collection ...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~157-~157: Loose punctuation mark.
Context: ...Mac.WindowDidChangeEffectiveAppearance` : Triggered when the window effective a...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~160-~160: Loose punctuation mark.
Context: ...ents.Mac.WindowDidChangeOcclusionState` : Triggered when the window occlusion s...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~163-~163: Loose punctuation mark.
Context: ...events.Mac.WindowDidChangeOrderingMode` : Triggered when the window ordering mo...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~166-~166: Loose punctuation mark.
Context: ...gesevents.Mac.WindowDidChangeScreen: Triggered when the window screen chan...(UNLIKELY_OPENING_PUNCTUATION)
[grammar] ~167-~167: Did you mean “screens”?
Context: ...geScreen: Triggered when the window screen changesevents.Mac.WindowDidChangeScr...(WRB_DT_NN_VB)
[uncategorized] ~169-~169: Loose punctuation mark.
Context: ...ts.Mac.WindowDidChangeScreenParameters` : Triggered when the window screen para...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~172-~172: Loose punctuation mark.
Context: ...vents.Mac.WindowDidChangeScreenProfile` : Triggered when the window screen prof...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~175-~175: Loose punctuation mark.
Context: ...events.Mac.WindowDidChangeScreenSpace: Triggered when the window screen spac...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~178-~178: Loose punctuation mark.
Context: ...c.WindowDidChangeScreenSpaceProperties` : Triggered when the window screen spac...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~181-~181: Loose punctuation mark.
Context: ...events.Mac.WindowDidChangeSharingType: Triggered when the window sharing typ...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~184-~184: Loose punctuation mark.
Context: ...ngesevents.Mac.WindowDidChangeSpace: Triggered when the window space chang...(UNLIKELY_OPENING_PUNCTUATION)
[grammar] ~185-~185: Did you mean “spaces”?
Context: ...ngeSpace: Triggered when the window space changesevents.Mac.WindowDidChangeSpa...(WRB_DT_NN_VB)
[uncategorized] ~187-~187: Loose punctuation mark.
Context: ...s.Mac.WindowDidChangeSpaceOrderingMode` : Triggered when the window space order...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~190-~190: Loose punctuation mark.
Context: ...ngesevents.Mac.WindowDidChangeTitle: Triggered when the window title chang...(UNLIKELY_OPENING_PUNCTUATION)
[grammar] ~191-~191: Did you mean “titles”?
Context: ...ngeTitle: Triggered when the window title changesevents.Mac.WindowDidChangeToo...(WRB_DT_NN_VB)
[uncategorized] ~193-~193: Loose punctuation mark.
Context: ...esevents.Mac.WindowDidChangeToolbar: Triggered when the window toolbar cha...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~196-~196: Loose punctuation mark.
Context: ...events.Mac.WindowDidChangeVisibility: Triggered when the window visibility ...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~199-~199: Loose punctuation mark.
Context: ...esevents.Mac.WindowDidDeminiaturize: Triggered when the window is deminiat...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~202-~202: Loose punctuation mark.
Context: ...turizedevents.Mac.WindowDidEndSheet: Triggered when the window ends a shee...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~205-~205: Loose punctuation mark.
Context: ...events.Mac.WindowDidEnterFullScreen: Triggered when the window enters full...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~208-~208: Loose punctuation mark.
Context: ...vents.Mac.WindowDidEnterVersionBrowser` : Triggered when the window enters vers...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~211-~211: Loose punctuation mark.
Context: ...revents.Mac.WindowDidExitFullScreen: Triggered when the window exits fulls...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~214-~214: Loose punctuation mark.
Context: ...events.Mac.WindowDidExitVersionBrowser` : Triggered when the window exits versi...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~217-~217: Loose punctuation mark.
Context: ...n browserevents.Mac.WindowDidExpose: Triggered when the window is exposed ...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~220-~220: Loose punctuation mark.
Context: ...is exposedevents.Mac.WindowDidFocus: Triggered when the window is focused ...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~223-~223: Loose punctuation mark.
Context: ...usedevents.Mac.WindowDidMiniaturize: Triggered when the window is miniatur...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~226-~226: Loose punctuation mark.
Context: ...iniaturizedevents.Mac.WindowDidMove: Triggered when the window is moved `...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~229-~229: Loose punctuation mark.
Context: ...devents.Mac.WindowDidOrderOffScreen: Triggered when the window is ordered ...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~232-~232: Loose punctuation mark.
Context: ...enevents.Mac.WindowDidOrderOnScreen: Triggered when the window is ordered ...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~235-~235: Loose punctuation mark.
Context: ...screenevents.Mac.WindowDidResignKey: Triggered when the window resigns key...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~238-~238: Loose punctuation mark.
Context: ...s keyevents.Mac.WindowDidResignMain: Triggered when the window resigns mai...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~241-~241: Loose punctuation mark.
Context: ...igns mainevents.Mac.WindowDidResize: Triggered when the window is resized ...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~244-~244: Loose punctuation mark.
Context: ...s resizedevents.Mac.WindowDidUpdate: Triggered when the window updates `e...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~247-~247: Loose punctuation mark.
Context: ...atesevents.Mac.WindowDidUpdateAlpha: Triggered when the window alpha updat...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~250-~250: Loose punctuation mark.
Context: ....Mac.WindowDidUpdateCollectionBehavior` : Triggered when the window collection ...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~253-~253: Loose punctuation mark.
Context: ...ac.WindowDidUpdateCollectionProperties` : Triggered when the window collection ...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~256-~256: Loose punctuation mark.
Context: ...ateevents.Mac.WindowDidUpdateShadow: Triggered when the window shadow upda...(UNLIKELY_OPENING_PUNCTUATION)
[grammar] ~257-~257: Did you mean “shadows”?
Context: ...teShadow: Triggered when the window shadow updatesevents.Mac.WindowDidUpdateTit...(WRB_DT_NN_VB)
[uncategorized] ~259-~259: Loose punctuation mark.
Context: ...atesevents.Mac.WindowDidUpdateTitle: Triggered when the window title updat...(UNLIKELY_OPENING_PUNCTUATION)
[grammar] ~260-~260: Did you mean “titles”?
Context: ...ateTitle: Triggered when the window title updatesevents.Mac.WindowDidUpdateToo...(WRB_DT_NN_VB)
[uncategorized] ~262-~262: Loose punctuation mark.
Context: ...esevents.Mac.WindowDidUpdateToolbar: Triggered when the window toolbar upd...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~265-~265: Loose punctuation mark.
Context: ...events.Mac.WindowDidUpdateVisibility: Triggered when the window visibility ...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~268-~268: Loose punctuation mark.
Context: ...updatesevents.Mac.WindowShouldClose: Triggered when the window should clos...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~271-~271: Loose punctuation mark.
Context: ...closeevents.Mac.WindowWillBecomeKey: Triggered when the window will become...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~274-~274: Loose punctuation mark.
Context: ... keyevents.Mac.WindowWillBecomeMain: Triggered when the window will become...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~277-~277: Loose punctuation mark.
Context: ...mainevents.Mac.WindowWillBeginSheet: Triggered when the window will begin ...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~280-~280: Loose punctuation mark.
Context: ...vents.Mac.WindowWillChangeOrderingMode` : Triggered when the window will change...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~283-~283: Loose punctuation mark.
Context: ...ring modeevents.Mac.WindowWillClose: Triggered when the window will close ...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~286-~286: Loose punctuation mark.
Context: ...eevents.Mac.WindowWillDeminiaturize: Triggered when the window will demini...(UNLIKELY_OPENING_PUNCTUATION)
[grammar] ~287-~287: Did you mean “wills”?
Context: ...iaturize: Triggered when the window will deminiaturizeevents.Mac.WindowWillEn...(WRB_DT_NN_VB)
[uncategorized] ~289-~289: Loose punctuation mark.
Context: ...events.Mac.WindowWillEnterFullScreen: Triggered when the window will enter ...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~292-~292: Loose punctuation mark.
Context: ...ents.Mac.WindowWillEnterVersionBrowser` : Triggered when the window will enter ...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~295-~295: Loose punctuation mark.
Context: ...events.Mac.WindowWillExitFullScreen: Triggered when the window will exit f...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~298-~298: Loose punctuation mark.
Context: ...vents.Mac.WindowWillExitVersionBrowser` : Triggered when the window will exit v...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~301-~301: Loose punctuation mark.
Context: ...n browserevents.Mac.WindowWillFocus: Triggered when the window will focus ...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~304-~304: Loose punctuation mark.
Context: ...cusevents.Mac.WindowWillMiniaturize: Triggered when the window will miniat...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~307-~307: Loose punctuation mark.
Context: ...iniaturizeevents.Mac.WindowWillMove: Triggered when the window will move ...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~310-~310: Loose punctuation mark.
Context: ...events.Mac.WindowWillOrderOffScreen: Triggered when the window will order ...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~313-~313: Loose punctuation mark.
Context: ...nevents.Mac.WindowWillOrderOnScreen: Triggered when the window will order ...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~316-~316: Loose punctuation mark.
Context: ...eenevents.Mac.WindowWillResignMain` : Triggered when the window will resign...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~319-~319: Loose punctuation mark.
Context: ...ign mainevents.Mac.WindowWillResize: Triggered when the window will resize...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~322-~322: Loose punctuation mark.
Context: ... resizeevents.Mac.WindowWillUnfocus: Triggered when the window will unfocu...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~325-~325: Loose punctuation mark.
Context: ...unfocusevents.Mac.WindowWillUpdate` : Triggered when the window will update...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~328-~328: Loose punctuation mark.
Context: ...ateevents.Mac.WindowWillUpdateAlpha: Triggered when the window will update...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~331-~331: Loose punctuation mark.
Context: ...Mac.WindowWillUpdateCollectionBehavior` : Triggered when the window will update...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~334-~334: Loose punctuation mark.
Context: ...c.WindowWillUpdateCollectionProperties` : Triggered when the window will update...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~337-~337: Loose punctuation mark.
Context: ...esevents.Mac.WindowWillUpdateShadow: Triggered when the window will update...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~340-~340: Loose punctuation mark.
Context: ...dowevents.Mac.WindowWillUpdateTitle: Triggered when the window will update...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~343-~343: Loose punctuation mark.
Context: ...eevents.Mac.WindowWillUpdateToolbar: Triggered when the window will update...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~346-~346: Loose punctuation mark.
Context: ...events.Mac.WindowWillUpdateVisibility: Triggered when the window will update...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~349-~349: Loose punctuation mark.
Context: ...events.Mac.WindowWillUseStandardFrame: Triggered when the window will use st...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~352-~352: Loose punctuation mark.
Context: ...c.WebviewDidStartProvisionalNavigation` : Triggered when the webview starts a p...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~355-~355: Loose punctuation mark.
Context: ...ServerRedirectForProvisionalNavigation` : Triggered when the webview receives a...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~358-~358: Loose punctuation mark.
Context: ...events.Mac.WebviewDidFinishNavigation: Triggered when the webview finishes n...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~361-~361: Loose punctuation mark.
Context: ...events.Mac.WebviewDidCommitNavigation: Triggered when the webview commits na...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~364-~364: Loose punctuation mark.
Context: ...events.Mac.WindowFileDraggingEntered: Triggered when files are dragged into...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~367-~367: Loose punctuation mark.
Context: ...events.Mac.WindowFileDraggingPerformed` : Triggered when files are dragged in t...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~370-~370: Loose punctuation mark.
Context: ...events.Mac.WindowFileDraggingExited: Triggered when files are dragged out ...(UNLIKELY_OPENING_PUNCTUATION)
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
📒 Files selected for processing (8)
mkdocs-website/docs/en/API/application_events.md(1 hunks)mkdocs-website/docs/en/API/event_hooks.md(1 hunks)mkdocs-website/docs/en/API/events.md(1 hunks)mkdocs-website/docs/en/API/events_linux.md(1 hunks)mkdocs-website/docs/en/API/events_mac.md(1 hunks)mkdocs-website/docs/en/API/events_windows.md(1 hunks)mkdocs-website/docs/en/changelog.md(1 hunks)mkdocs-website/mkdocs.yml(2 hunks)
🚧 Files skipped from review as they are similar to previous changes (3)
- mkdocs-website/docs/en/API/application_events.md
- mkdocs-website/docs/en/changelog.md
- mkdocs-website/mkdocs.yml
🧰 Additional context used
🪛 LanguageTool
mkdocs-website/docs/en/API/event_hooks.md
[uncategorized] ~42-~42: Loose punctuation mark.
Context: ...e. events.Common.ApplicationStarted` : Triggered when the application starts...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~45-~45: Loose punctuation mark.
Context: ...on starts events.Common.ThemeChanged : Triggered when the application theme ...
(UNLIKELY_OPENING_PUNCTUATION)
[grammar] ~46-~46: Did you mean “themes”?
Context: ...ged: Triggered when the application theme changes ### Window Events events.Co...
(WRB_DT_NN_VB)
[uncategorized] ~51-~51: Loose punctuation mark.
Context: ...vents events.Common.WindowMaximised : Triggered when the window is maximise...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~54-~54: Loose punctuation mark.
Context: ...ised events.Common.WindowUnmaximised : Triggered when the window is unmaximi...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~57-~57: Loose punctuation mark.
Context: ...mised events.Common.WindowMinimised : Triggered when the window is minimise...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~60-~60: Loose punctuation mark.
Context: ...ised events.Common.WindowUnminimised : Triggered when the window is unminimi...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~63-~63: Loose punctuation mark.
Context: ...mised events.Common.WindowFullscreen : Triggered when the window is set to f...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~66-~66: Loose punctuation mark.
Context: ...een events.Common.WindowUnfullscreen : Triggered when the window is unfullsc...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~69-~69: Loose punctuation mark.
Context: ...creened events.Common.WindowRestored : Triggered when the window is restored...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~72-~72: Loose punctuation mark.
Context: ...restored events.Common.WindowClosing : Triggered before the window closes `...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~75-~75: Loose punctuation mark.
Context: ...dow closes events.Common.WindowZoom : Triggered when the window is zoomed ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~78-~78: Loose punctuation mark.
Context: ...s zoomed events.Common.WindowZoomOut : Triggered when the window is zoomed o...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~81-~81: Loose punctuation mark.
Context: ...omed out events.Common.WindowZoomIn : Triggered when the window is zoomed i...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~84-~84: Loose punctuation mark.
Context: ...med in events.Common.WindowZoomReset : Triggered when the window zoom is res...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~87-~87: Loose punctuation mark.
Context: ... is reset events.Common.WindowFocus : Triggered when the window gains focus...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~90-~90: Loose punctuation mark.
Context: ...focus events.Common.WindowLostFocus : Triggered when the window loses focus...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~93-~93: Loose punctuation mark.
Context: ...loses focus events.Common.WindowShow : Triggered when the window is shown `...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~96-~96: Loose punctuation mark.
Context: ...w is shown events.Common.WindowHide : Triggered when the window is hidden ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~99-~99: Loose punctuation mark.
Context: ...idden events.Common.WindowDPIChanged : Triggered when the window DPI changes...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~102-~102: Loose punctuation mark.
Context: ...ges events.Common.WindowFilesDropped : Triggered when files are dropped on t...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~105-~105: Loose punctuation mark.
Context: ...dow events.Common.WindowRuntimeReady : Triggered when the window runtime is ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~108-~108: Loose punctuation mark.
Context: ...s ready events.Common.WindowDidMove : Triggered when the window is moved `...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~111-~111: Loose punctuation mark.
Context: ...moved events.Common.WindowDidResize : Triggered when the window is resized ...
(UNLIKELY_OPENING_PUNCTUATION)
mkdocs-website/docs/en/API/events.md
[style] ~11-~11: As a shorter alternative for ‘able to’, consider using “can”.
Context: ... both the frontend and backend. Events are able to emitted at both the application and the...
(BE_ABLE_TO)
[uncategorized] ~36-~36: Loose punctuation mark.
Context: ...on.EmitEvent(name string, data ...any)` : Emits an event from the application i...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~39-~39: Loose punctuation mark.
Context: ...ow.EmitEvent(name string, data ...any)` : Emits an event from the window instan...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~42-~42: Loose punctuation mark.
Context: ...nts.Emit(event:wails.Events.EventData)` : Emits an event from the frontend send...
(UNLIKELY_OPENING_PUNCTUATION)
[duplication] ~45-~45: Possible typo: you repeated a word
Context: ...escript type WailsEvent ### Receiving Events Events can be received on the application inst...
(ENGLISH_WORD_REPEAT_RULE)
[grammar] ~46-~46: Using ‘couple’ without ‘of’ is considered to be informal.
Context: ...cation instance and the frontend with a couple options of how you chose to receive them. You ...
(PLENTY_OF_NOUNS)
[uncategorized] ~47-~47: Use a comma before ‘or’ if it connects two independent clauses (unless they are closely connected and short).
Context: ... trigger every time the event is emitted or you can register an event listener that...
(COMMA_COMPOUND_SENTENCE)
[uncategorized] ~52-~52: Loose punctuation mark.
Context: ...ame string, handler func(data ...any))` : Registers an event on the application...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~55-~55: Loose punctuation mark.
Context: ... handler func(data ...any), count int)` : Registers an event on the application...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~60-~60: Loose punctuation mark.
Context: ...ts.On(name: string, callback: ()=>void)`, : Registers an event on the frontend...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~63-~63: Loose punctuation mark.
Context: ....Once(name: string, callback: ()=>void)`, : Registers an event on the frontend...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~66-~66: Loose punctuation mark.
Context: ...ing, callback: ()=>void, count: number)`, : Registers an event on the frontend...
(UNLIKELY_OPENING_PUNCTUATION)
[style] ~70-~70: Consider removing “of” to be more concise
Context: ...s to remove events that are registered. All of the registration functions return a functio...
(ALL_OF_THE)
[uncategorized] ~75-~75: Loose punctuation mark.
Context: ...ame string, ...additionalNames string)` : Removes an event listener with the sp...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~78-~78: Loose punctuation mark.
Context: ...ficed name application.ResetEvents() : Removes all registered events and hoo...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~83-~83: Loose punctuation mark.
Context: ...ooks Frontend wails.Events.OffAll() : Removes all registered events `wails...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~86-~86: Loose punctuation mark.
Context: ...vents wails.Events.Off(name: string) : Removes an event listener with the sp...
(UNLIKELY_OPENING_PUNCTUATION)
mkdocs-website/docs/en/API/events_linux.md
[uncategorized] ~5-~5: Loose punctuation mark.
Context: ...ents events.Linux.ApplicationStartup : Triggered when the application starts...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~8-~8: Loose punctuation mark.
Context: ...arts events.Linux.SystemThemeChanged : Triggered when the system theme chang...
(UNLIKELY_OPENING_PUNCTUATION)
[grammar] ~9-~9: Did you mean “themes”?
Context: ...eChanged: Triggered when the system theme changes ##### Window Events events.L...
(WRB_DT_NN_VB)
[uncategorized] ~13-~13: Loose punctuation mark.
Context: ...vents events.Linux.WindowLoadChanged : Triggered when the window load change...
(UNLIKELY_OPENING_PUNCTUATION)
[grammar] ~14-~14: Did you mean “loads”?
Context: ...dChanged: Triggered when the window load changes events.Linux.WindowDeleteEven...
(WRB_DT_NN_VB)
[uncategorized] ~16-~16: Loose punctuation mark.
Context: ...anges events.Linux.WindowDeleteEvent : Triggered when the window is deleted ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~19-~19: Loose punctuation mark.
Context: ...s deleted events.Linux.WindowDidMove : Triggered when the window is moved `...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~22-~22: Loose punctuation mark.
Context: ...s moved events.Linux.WindowDidResize : Triggered when the window is resized ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~25-~25: Loose punctuation mark.
Context: ...s resized events.Linux.WindowFocusIn : Triggered when the window gains focus...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~28-~28: Loose punctuation mark.
Context: ...ns focus events.Linux.WindowFocusOut : Triggered when the window loses focus...
(UNLIKELY_OPENING_PUNCTUATION)
mkdocs-website/docs/en/API/events_mac.md
[uncategorized] ~5-~5: Loose punctuation mark.
Context: ...events.Mac.ApplicationDidBecomeActive : Triggered when the application become...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~8-~8: Loose punctuation mark.
Context: ....ApplicationDidChangeBackingProperties` : Triggered when the application change...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~11-~11: Loose punctuation mark.
Context: ...pplicationDidChangeEffectiveAppearance` : Triggered when the application change...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~14-~14: Loose punctuation mark.
Context: ... events.Mac.ApplicationDidChangeIcon : Triggered when the application change...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~17-~17: Loose punctuation mark.
Context: ...Mac.ApplicationDidChangeOcclusionState` : Triggered when the application change...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~20-~20: Loose punctuation mark.
Context: ...c.ApplicationDidChangeScreenParameters` : Triggered when the application change...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~23-~23: Loose punctuation mark.
Context: ...Mac.ApplicationDidChangeStatusBarFrame` : Triggered when the application change...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~26-~26: Loose punctuation mark.
Context: ...licationDidChangeStatusBarOrientation` : Triggered when the application change...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~29-~29: Loose punctuation mark.
Context: ...ents.Mac.ApplicationDidFinishLaunching` : Triggered when the application finish...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~32-~32: Loose punctuation mark.
Context: ...ApplicationDidResignActiveNotification` : Triggered when the application is no ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~35-~35: Loose punctuation mark.
Context: ...active events.Mac.ApplicationDidHide : Triggered when the application is hid...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~38-~38: Loose punctuation mark.
Context: ...dden events.Mac.ApplicationDidUpdate : Triggered when the application update...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~41-~41: Loose punctuation mark.
Context: ...events.Mac.ApplicationWillBecomeActive` : Triggered when the application is abo...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~44-~44: Loose punctuation mark.
Context: ...nts.Mac.ApplicationWillFinishLaunching` : Triggered when the application is abo...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~47-~47: Loose punctuation mark.
Context: ...ching events.Mac.ApplicationWillHide : Triggered when the application is abo...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~50-~50: Loose punctuation mark.
Context: ...events.Mac.ApplicationWillResignActive` : Triggered when the application is abo...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~53-~53: Loose punctuation mark.
Context: ... events.Mac.ApplicationWillTerminate : Triggered when the application is abo...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~56-~56: Loose punctuation mark.
Context: ...ate events.Mac.ApplicationWillUnhide : Triggered when the application is abo...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~59-~59: Loose punctuation mark.
Context: ...de events.Mac.ApplicationWillUpdate : Triggered when the application is abo...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~62-~62: Loose punctuation mark.
Context: ...events.Mac.ApplicationDidChangeTheme : Triggered when the application change...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~65-~65: Loose punctuation mark.
Context: ...hanges theme events.Mac.MenuWillOpen : Triggered when the menu is about to o...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~68-~68: Loose punctuation mark.
Context: ...about to open events.Mac.MenuDidOpen : Triggered when the menu opens `event...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~71-~71: Loose punctuation mark.
Context: ...e menu opens events.Mac.MenuDidClose : Triggered when the menu closes `even...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~74-~74: Loose punctuation mark.
Context: ...closes events.Mac.MenuWillSendAction : Triggered when the menu is about to s...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~77-~77: Loose punctuation mark.
Context: ... action events.Mac.MenuDidSendAction : Triggered when the menu sends an acti...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~80-~80: Loose punctuation mark.
Context: ...ion events.Mac.MenuWillHighlightItem : Triggered when the menu is about to h...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~83-~83: Loose punctuation mark.
Context: ...item events.Mac.MenuDidHighlightItem : Triggered when the menu highlights an...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~86-~86: Loose punctuation mark.
Context: ... item events.Mac.MenuWillDisplayItem : Triggered when the menu is about to d...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~89-~89: Loose punctuation mark.
Context: ...n item events.Mac.MenuDidDisplayItem : Triggered when the menu displays an i...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~92-~92: Loose punctuation mark.
Context: ...s an item events.Mac.MenuWillAddItem : Triggered when the menu is about to a...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~95-~95: Loose punctuation mark.
Context: ...dd an item events.Mac.MenuDidAddItem : Triggered when the menu adds an item ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~98-~98: Loose punctuation mark.
Context: ...n item events.Mac.MenuWillRemoveItem : Triggered when the menu is about to r...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~101-~101: Loose punctuation mark.
Context: ...an item events.Mac.MenuDidRemoveItem : Triggered when the menu removes an it...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~104-~104: Loose punctuation mark.
Context: ...tem events.Mac.MenuWillBeginTracking : Triggered when the menu is about to b...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~107-~107: Loose punctuation mark.
Context: ...king events.Mac.MenuDidBeginTracking : Triggered when the menu begins tracki...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~110-~110: Loose punctuation mark.
Context: ...cking events.Mac.MenuWillEndTracking : Triggered when the menu is about to e...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~113-~113: Loose punctuation mark.
Context: ...acking events.Mac.MenuDidEndTracking : Triggered when the menu ends tracking...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~116-~116: Loose punctuation mark.
Context: ...s tracking events.Mac.MenuWillUpdate : Triggered when the menu is about to u...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~119-~119: Loose punctuation mark.
Context: ...t to update events.Mac.MenuDidUpdate : Triggered when the menu updates `eve...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~122-~122: Loose punctuation mark.
Context: ...enu updates events.Mac.MenuWillPopUp : Triggered when the menu is about to p...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~125-~125: Loose punctuation mark.
Context: ...ut to pop up events.Mac.MenuDidPopUp : Triggered when the menu pops up `eve...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~128-~128: Loose punctuation mark.
Context: ... events.Mac.MenuWillSendActionToItem : Triggered when the menu is about to s...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~131-~131: Loose punctuation mark.
Context: ...m events.Mac.MenuDidSendActionToItem : Triggered when the menu sends an acti...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~136-~136: Loose punctuation mark.
Context: ...Events events.Mac.WindowDidBecomeKey : Triggered when the window becomes key...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~139-~139: Loose punctuation mark.
Context: ...s key events.Mac.WindowDidBecomeMain : Triggered when the window becomes mai...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~142-~142: Loose punctuation mark.
Context: ... main events.Mac.WindowDidBeginSheet : Triggered when the window begins a sh...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~145-~145: Loose punctuation mark.
Context: ...heet events.Mac.WindowDidChangeAlpha : Triggered when the window alpha chang...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~148-~148: Loose punctuation mark.
Context: ...nts.Mac.WindowDidChangeBackingLocation` : Triggered when the window backing loc...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~151-~151: Loose punctuation mark.
Context: ...s.Mac.WindowDidChangeBackingProperties` : Triggered when the window backing pro...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~154-~154: Loose punctuation mark.
Context: ....Mac.WindowDidChangeCollectionBehavior` : Triggered when the window collection ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~157-~157: Loose punctuation mark.
Context: ...Mac.WindowDidChangeEffectiveAppearance` : Triggered when the window effective a...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~160-~160: Loose punctuation mark.
Context: ...ents.Mac.WindowDidChangeOcclusionState` : Triggered when the window occlusion s...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~163-~163: Loose punctuation mark.
Context: ...events.Mac.WindowDidChangeOrderingMode` : Triggered when the window ordering mo...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~166-~166: Loose punctuation mark.
Context: ...ges events.Mac.WindowDidChangeScreen : Triggered when the window screen chan...
(UNLIKELY_OPENING_PUNCTUATION)
[grammar] ~167-~167: Did you mean “screens”?
Context: ...geScreen: Triggered when the window screen changes events.Mac.WindowDidChangeScr...
(WRB_DT_NN_VB)
[uncategorized] ~169-~169: Loose punctuation mark.
Context: ...ts.Mac.WindowDidChangeScreenParameters` : Triggered when the window screen para...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~172-~172: Loose punctuation mark.
Context: ...vents.Mac.WindowDidChangeScreenProfile` : Triggered when the window screen prof...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~175-~175: Loose punctuation mark.
Context: ...events.Mac.WindowDidChangeScreenSpace : Triggered when the window screen spac...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~178-~178: Loose punctuation mark.
Context: ...c.WindowDidChangeScreenSpaceProperties` : Triggered when the window screen spac...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~181-~181: Loose punctuation mark.
Context: ...events.Mac.WindowDidChangeSharingType : Triggered when the window sharing typ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~184-~184: Loose punctuation mark.
Context: ...nges events.Mac.WindowDidChangeSpace : Triggered when the window space chang...
(UNLIKELY_OPENING_PUNCTUATION)
[grammar] ~185-~185: Did you mean “spaces”?
Context: ...ngeSpace: Triggered when the window space changes events.Mac.WindowDidChangeSpa...
(WRB_DT_NN_VB)
[uncategorized] ~187-~187: Loose punctuation mark.
Context: ...s.Mac.WindowDidChangeSpaceOrderingMode` : Triggered when the window space order...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~190-~190: Loose punctuation mark.
Context: ...nges events.Mac.WindowDidChangeTitle : Triggered when the window title chang...
(UNLIKELY_OPENING_PUNCTUATION)
[grammar] ~191-~191: Did you mean “titles”?
Context: ...ngeTitle: Triggered when the window title changes events.Mac.WindowDidChangeToo...
(WRB_DT_NN_VB)
[uncategorized] ~193-~193: Loose punctuation mark.
Context: ...es events.Mac.WindowDidChangeToolbar : Triggered when the window toolbar cha...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~196-~196: Loose punctuation mark.
Context: ... events.Mac.WindowDidChangeVisibility : Triggered when the window visibility ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~199-~199: Loose punctuation mark.
Context: ...es events.Mac.WindowDidDeminiaturize : Triggered when the window is deminiat...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~202-~202: Loose punctuation mark.
Context: ...turized events.Mac.WindowDidEndSheet : Triggered when the window ends a shee...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~205-~205: Loose punctuation mark.
Context: ... events.Mac.WindowDidEnterFullScreen : Triggered when the window enters full...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~208-~208: Loose punctuation mark.
Context: ...vents.Mac.WindowDidEnterVersionBrowser` : Triggered when the window enters vers...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~211-~211: Loose punctuation mark.
Context: ...r events.Mac.WindowDidExitFullScreen : Triggered when the window exits fulls...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~214-~214: Loose punctuation mark.
Context: ...events.Mac.WindowDidExitVersionBrowser` : Triggered when the window exits versi...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~217-~217: Loose punctuation mark.
Context: ...n browser events.Mac.WindowDidExpose : Triggered when the window is exposed ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~220-~220: Loose punctuation mark.
Context: ...is exposed events.Mac.WindowDidFocus : Triggered when the window is focused ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~223-~223: Loose punctuation mark.
Context: ...used events.Mac.WindowDidMiniaturize : Triggered when the window is miniatur...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~226-~226: Loose punctuation mark.
Context: ...iniaturized events.Mac.WindowDidMove : Triggered when the window is moved `...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~229-~229: Loose punctuation mark.
Context: ...d events.Mac.WindowDidOrderOffScreen : Triggered when the window is ordered ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~232-~232: Loose punctuation mark.
Context: ...en events.Mac.WindowDidOrderOnScreen : Triggered when the window is ordered ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~235-~235: Loose punctuation mark.
Context: ...screen events.Mac.WindowDidResignKey : Triggered when the window resigns key...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~238-~238: Loose punctuation mark.
Context: ...s key events.Mac.WindowDidResignMain : Triggered when the window resigns mai...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~241-~241: Loose punctuation mark.
Context: ...igns main events.Mac.WindowDidResize : Triggered when the window is resized ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~244-~244: Loose punctuation mark.
Context: ...s resized events.Mac.WindowDidUpdate : Triggered when the window updates `e...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~247-~247: Loose punctuation mark.
Context: ...ates events.Mac.WindowDidUpdateAlpha : Triggered when the window alpha updat...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~250-~250: Loose punctuation mark.
Context: ....Mac.WindowDidUpdateCollectionBehavior` : Triggered when the window collection ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~253-~253: Loose punctuation mark.
Context: ...ac.WindowDidUpdateCollectionProperties` : Triggered when the window collection ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~256-~256: Loose punctuation mark.
Context: ...ate events.Mac.WindowDidUpdateShadow : Triggered when the window shadow upda...
(UNLIKELY_OPENING_PUNCTUATION)
[grammar] ~257-~257: Did you mean “shadows”?
Context: ...teShadow: Triggered when the window shadow updates events.Mac.WindowDidUpdateTit...
(WRB_DT_NN_VB)
[uncategorized] ~259-~259: Loose punctuation mark.
Context: ...ates events.Mac.WindowDidUpdateTitle : Triggered when the window title updat...
(UNLIKELY_OPENING_PUNCTUATION)
[grammar] ~260-~260: Did you mean “titles”?
Context: ...ateTitle: Triggered when the window title updates events.Mac.WindowDidUpdateToo...
(WRB_DT_NN_VB)
[uncategorized] ~262-~262: Loose punctuation mark.
Context: ...es events.Mac.WindowDidUpdateToolbar : Triggered when the window toolbar upd...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~265-~265: Loose punctuation mark.
Context: ... events.Mac.WindowDidUpdateVisibility : Triggered when the window visibility ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~268-~268: Loose punctuation mark.
Context: ...updates events.Mac.WindowShouldClose : Triggered when the window should clos...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~271-~271: Loose punctuation mark.
Context: ...close events.Mac.WindowWillBecomeKey : Triggered when the window will become...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~274-~274: Loose punctuation mark.
Context: ... key events.Mac.WindowWillBecomeMain : Triggered when the window will become...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~277-~277: Loose punctuation mark.
Context: ...main events.Mac.WindowWillBeginSheet : Triggered when the window will begin ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~280-~280: Loose punctuation mark.
Context: ...vents.Mac.WindowWillChangeOrderingMode` : Triggered when the window will change...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~283-~283: Loose punctuation mark.
Context: ...ring mode events.Mac.WindowWillClose : Triggered when the window will close ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~286-~286: Loose punctuation mark.
Context: ...e events.Mac.WindowWillDeminiaturize : Triggered when the window will demini...
(UNLIKELY_OPENING_PUNCTUATION)
[grammar] ~287-~287: Did you mean “wills”?
Context: ...iaturize: Triggered when the window will deminiaturize events.Mac.WindowWillEn...
(WRB_DT_NN_VB)
[uncategorized] ~289-~289: Loose punctuation mark.
Context: ... events.Mac.WindowWillEnterFullScreen : Triggered when the window will enter ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~292-~292: Loose punctuation mark.
Context: ...ents.Mac.WindowWillEnterVersionBrowser` : Triggered when the window will enter ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~295-~295: Loose punctuation mark.
Context: ... events.Mac.WindowWillExitFullScreen : Triggered when the window will exit f...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~298-~298: Loose punctuation mark.
Context: ...vents.Mac.WindowWillExitVersionBrowser` : Triggered when the window will exit v...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~301-~301: Loose punctuation mark.
Context: ...n browser events.Mac.WindowWillFocus : Triggered when the window will focus ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~304-~304: Loose punctuation mark.
Context: ...cus events.Mac.WindowWillMiniaturize : Triggered when the window will miniat...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~307-~307: Loose punctuation mark.
Context: ...iniaturize events.Mac.WindowWillMove : Triggered when the window will move ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~310-~310: Loose punctuation mark.
Context: ... events.Mac.WindowWillOrderOffScreen : Triggered when the window will order ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~313-~313: Loose punctuation mark.
Context: ...n events.Mac.WindowWillOrderOnScreen : Triggered when the window will order ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~316-~316: Loose punctuation mark.
Context: ...een events.Mac.WindowWillResignMain` : Triggered when the window will resign...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~319-~319: Loose punctuation mark.
Context: ...ign main events.Mac.WindowWillResize : Triggered when the window will resize...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~322-~322: Loose punctuation mark.
Context: ... resize events.Mac.WindowWillUnfocus : Triggered when the window will unfocu...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~325-~325: Loose punctuation mark.
Context: ...unfocus events.Mac.WindowWillUpdate` : Triggered when the window will update...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~328-~328: Loose punctuation mark.
Context: ...ate events.Mac.WindowWillUpdateAlpha : Triggered when the window will update...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~331-~331: Loose punctuation mark.
Context: ...Mac.WindowWillUpdateCollectionBehavior` : Triggered when the window will update...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~334-~334: Loose punctuation mark.
Context: ...c.WindowWillUpdateCollectionProperties` : Triggered when the window will update...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~337-~337: Loose punctuation mark.
Context: ...es events.Mac.WindowWillUpdateShadow : Triggered when the window will update...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~340-~340: Loose punctuation mark.
Context: ...dow events.Mac.WindowWillUpdateTitle : Triggered when the window will update...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~343-~343: Loose punctuation mark.
Context: ...e events.Mac.WindowWillUpdateToolbar : Triggered when the window will update...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~346-~346: Loose punctuation mark.
Context: ...events.Mac.WindowWillUpdateVisibility : Triggered when the window will update...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~349-~349: Loose punctuation mark.
Context: ...events.Mac.WindowWillUseStandardFrame : Triggered when the window will use st...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~352-~352: Loose punctuation mark.
Context: ...c.WebviewDidStartProvisionalNavigation` : Triggered when the webview starts a p...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~355-~355: Loose punctuation mark.
Context: ...ServerRedirectForProvisionalNavigation` : Triggered when the webview receives a...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~358-~358: Loose punctuation mark.
Context: ...events.Mac.WebviewDidFinishNavigation : Triggered when the webview finishes n...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~361-~361: Loose punctuation mark.
Context: ...events.Mac.WebviewDidCommitNavigation : Triggered when the webview commits na...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~364-~364: Loose punctuation mark.
Context: ... events.Mac.WindowFileDraggingEntered : Triggered when files are dragged into...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~367-~367: Loose punctuation mark.
Context: ...events.Mac.WindowFileDraggingPerformed` : Triggered when files are dragged in t...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~370-~370: Loose punctuation mark.
Context: ... events.Mac.WindowFileDraggingExited : Triggered when files are dragged out ...
(UNLIKELY_OPENING_PUNCTUATION)
mkdocs-website/docs/en/API/events_windows.md
[uncategorized] ~5-~5: Loose punctuation mark.
Context: ...ts events.Windows.ApplicationStarted : Triggered when the application starts...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~8-~8: Loose punctuation mark.
Context: ...s events.Windows.SystemThemeChanged : Triggered when the system theme chang...
(UNLIKELY_OPENING_PUNCTUATION)
[grammar] ~9-~9: Did you mean “themes”?
Context: ...Changed : Triggered when the system theme changes events.Windows.APMPowerStatus...
(WRB_DT_NN_VB)
[uncategorized] ~11-~11: Loose punctuation mark.
Context: ... events.Windows.APMPowerStatusChange : Triggered when the system power statu...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~14-~14: Loose punctuation mark.
Context: ...s changes events.Windows.APMSuspend : Triggered when the system suspends `...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~17-~17: Loose punctuation mark.
Context: ...ds events.Windows.APMResumeAutomatic : Triggered when the system resumes aft...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~20-~20: Loose punctuation mark.
Context: ...leep events.Windows.APMResumeSuspend : Triggered when the system resumes aft...
(UNLIKELY_OPENING_PUNCTUATION)
[grammar] ~21-~21: The verb ‘suspend’ does not usually follow articles like ‘a’. Check that ‘suspend’ is spelled correctly; using ‘suspend’ as a noun may be non-standard.
Context: ...Triggered when the system resumes after a suspend and resume was triggered by the user #...
(A_INFINITIVE)
[uncategorized] ~25-~25: Loose punctuation mark.
Context: ...nts.Windows.WebviewNavigationCompleted` : Triggered when the webview navigation...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~28-~28: Loose punctuation mark.
Context: ...pleted events.Windows.WindowInactive : Triggered when the window is inactive...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~31-~31: Loose punctuation mark.
Context: ...inactive events.Windows.WindowActive : Triggered when the window is active ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~34-~34: Loose punctuation mark.
Context: ...is active events.Windows.ClickActive : Triggered when the window is activate...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~37-~37: Loose punctuation mark.
Context: ... click events.Windows.MaximiseActive : Triggered when the window is maximise...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~40-~40: Loose punctuation mark.
Context: ... maximised events.Windows.UnMaximise : Triggered when the window is unmaximi...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~43-~43: Loose punctuation mark.
Context: ...nmaximised events.Windows.Fullscreen : Triggered when the window is set to f...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~46-~46: Loose punctuation mark.
Context: ...llscreen events.Windows.UnFullscreen : Triggered when the window is exited f...
(UNLIKELY_OPENING_PUNCTUATION)
[style] ~47-~47: This phrase is redundant. Consider writing “exited”.
Context: ...creen: Triggered when the window is exited from fullscreene events.Windows.WindowRest...
(EXIT_FROM)
[uncategorized] ~49-~49: Loose punctuation mark.
Context: ...screene events.Windows.WindowRestore : Triggered when the window is restored...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~52-~52: Loose punctuation mark.
Context: ...stored events.Windows.WindowMinimise : Triggered when the window is minimise...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~55-~55: Loose punctuation mark.
Context: ...ised events.Windows.WindowUnminimise : Triggered when the window is unminimi...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~58-~58: Loose punctuation mark.
Context: ...minimised events.Windows.WindowClose : Triggered before the window closes `e...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~63-~63: Loose punctuation mark.
Context: ...focus events.Windows.WindowKillFocus : Triggered when the window loses keybo...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~66-~66: Loose punctuation mark.
Context: ... focus events.Windows.WindowDragDrop : Triggered when files are dropped on t...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~69-~69: Loose punctuation mark.
Context: ...indow events.Windows.WindowDragEnter : Triggered when a drag enters the wind...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~72-~72: Loose punctuation mark.
Context: ...indow events.Windows.WindowDragLeave : Triggered when a drag leaves the wind...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~75-~75: Loose punctuation mark.
Context: ...window events.Windows.WindowDragOver : Triggered when a drag is over the win...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~78-~78: Loose punctuation mark.
Context: ... window events.Windows.WindowDidMove : Triggered after a window has moved
(UNLIKELY_OPENING_PUNCTUATION)
🪛 Markdownlint
mkdocs-website/docs/en/API/events.md
109-109: Column: 1
Hard tabs
(MD010, no-hard-tabs)
110-110: Column: 1
Hard tabs
(MD010, no-hard-tabs)
123-123: Column: 1
Hard tabs
(MD010, no-hard-tabs)
124-124: Column: 1
Hard tabs
(MD010, no-hard-tabs)
125-125: Column: 1
Hard tabs
(MD010, no-hard-tabs)
126-126: Column: 1
Hard tabs
(MD010, no-hard-tabs)
94-94: Expected: indented; Actual: fenced
Code block style
(MD046, code-block-style)
107-107: Expected: indented; Actual: fenced
Code block style
(MD046, code-block-style)
121-121: Expected: indented; Actual: fenced
Code block style
(MD046, code-block-style)
🔇 Additional comments (9)
mkdocs-website/docs/en/API/events_linux.md (1)
1-4: LGTM! Clear and well-structured headers.
The document structure follows markdown best practices with proper header hierarchy.
mkdocs-website/docs/en/API/event_hooks.md (2)
114-119: LGTM! Well-structured documentation organization
Good use of markdown-include syntax to organize platform-specific event documentation.
4-4:
Fix typo in comment
There's a typo in the comment.
-// Notification of application start
+// Notification of application startLikely invalid or redundant comment.
mkdocs-website/docs/en/API/events.md (4)
16-19: Add safety checks for type assertion
The previous review comment about adding type assertion safety checks is still valid. Please refer to the existing comment for the suggested fix.
75-77: Fix spelling in API documentation
The previous review comment about the spelling error "specificed" is still valid. Please refer to the existing comment for the suggested fix.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~75-~75: Loose punctuation mark.
Context: ...ame string, ...additionalNames string)` : Removes an event listener with the sp...
(UNLIKELY_OPENING_PUNCTUATION)
109-111: Fix struct indentation
The previous review comment about using spaces instead of tabs for struct indentation is still valid. Please refer to the existing comment for the suggested fix.
Also applies to: 123-126
🧰 Tools
🪛 Markdownlint
109-109: Column: 1
Hard tabs
(MD010, no-hard-tabs)
110-110: Column: 1
Hard tabs
(MD010, no-hard-tabs)
1-131: Documentation structure and content look good!
The documentation provides a comprehensive overview of the Events API with clear examples and explanations. The structure is well-organized, making it easy for developers to understand and implement event handling in their applications.
🧰 Tools
🪛 LanguageTool
[style] ~11-~11: As a shorter alternative for ‘able to’, consider using “can”.
Context: ... both the frontend and backend. Events are able to emitted at both the application and the...
(BE_ABLE_TO)
[uncategorized] ~36-~36: Loose punctuation mark.
Context: ...on.EmitEvent(name string, data ...any)` : Emits an event from the application i...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~39-~39: Loose punctuation mark.
Context: ...ow.EmitEvent(name string, data ...any)` : Emits an event from the window instan...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~42-~42: Loose punctuation mark.
Context: ...nts.Emit(event:wails.Events.EventData)` : Emits an event from the frontend send...
(UNLIKELY_OPENING_PUNCTUATION)
[duplication] ~45-~45: Possible typo: you repeated a word
Context: ...escript type WailsEvent ### Receiving Events Events can be received on the application inst...
(ENGLISH_WORD_REPEAT_RULE)
[grammar] ~46-~46: Using ‘couple’ without ‘of’ is considered to be informal.
Context: ...cation instance and the frontend with a couple options of how you chose to receive them. You ...
(PLENTY_OF_NOUNS)
[uncategorized] ~47-~47: Use a comma before ‘or’ if it connects two independent clauses (unless they are closely connected and short).
Context: ... trigger every time the event is emitted or you can register an event listener that...
(COMMA_COMPOUND_SENTENCE)
[uncategorized] ~52-~52: Loose punctuation mark.
Context: ...ame string, handler func(data ...any))` : Registers an event on the application...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~55-~55: Loose punctuation mark.
Context: ... handler func(data ...any), count int)` : Registers an event on the application...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~60-~60: Loose punctuation mark.
Context: ...ts.On(name: string, callback: ()=>void)`, : Registers an event on the frontend...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~63-~63: Loose punctuation mark.
Context: ....Once(name: string, callback: ()=>void)`, : Registers an event on the frontend...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~66-~66: Loose punctuation mark.
Context: ...ing, callback: ()=>void, count: number)`, : Registers an event on the frontend...
(UNLIKELY_OPENING_PUNCTUATION)
[style] ~70-~70: Consider removing “of” to be more concise
Context: ...s to remove events that are registered. All of the registration functions return a functio...
(ALL_OF_THE)
[uncategorized] ~75-~75: Loose punctuation mark.
Context: ...ame string, ...additionalNames string)` : Removes an event listener with the sp...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~78-~78: Loose punctuation mark.
Context: ...ficed name application.ResetEvents() : Removes all registered events and hoo...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~83-~83: Loose punctuation mark.
Context: ...ooks Frontend wails.Events.OffAll() : Removes all registered events `wails...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~86-~86: Loose punctuation mark.
Context: ...vents wails.Events.Off(name: string) : Removes an event listener with the sp...
(UNLIKELY_OPENING_PUNCTUATION)
🪛 Markdownlint
109-109: Column: 1
Hard tabs
(MD010, no-hard-tabs)
110-110: Column: 1
Hard tabs
(MD010, no-hard-tabs)
123-123: Column: 1
Hard tabs
(MD010, no-hard-tabs)
124-124: Column: 1
Hard tabs
(MD010, no-hard-tabs)
125-125: Column: 1
Hard tabs
(MD010, no-hard-tabs)
126-126: Column: 1
Hard tabs
(MD010, no-hard-tabs)
94-94: Expected: indented; Actual: fenced
Code block style
(MD046, code-block-style)
107-107: Expected: indented; Actual: fenced
Code block style
(MD046, code-block-style)
121-121: Expected: indented; Actual: fenced
Code block style
(MD046, code-block-style)
mkdocs-website/docs/en/API/events_mac.md (2)
1-371: Well-structured documentation with clear organization.
The documentation is logically organized into distinct sections (Application, Menu, and Window events) with consistent formatting throughout.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~5-~5: Loose punctuation mark.
Context: ...events.Mac.ApplicationDidBecomeActive : Triggered when the application become...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~8-~8: Loose punctuation mark.
Context: ....ApplicationDidChangeBackingProperties` : Triggered when the application change...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~11-~11: Loose punctuation mark.
Context: ...pplicationDidChangeEffectiveAppearance` : Triggered when the application change...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~14-~14: Loose punctuation mark.
Context: ... events.Mac.ApplicationDidChangeIcon : Triggered when the application change...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~17-~17: Loose punctuation mark.
Context: ...Mac.ApplicationDidChangeOcclusionState` : Triggered when the application change...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~20-~20: Loose punctuation mark.
Context: ...c.ApplicationDidChangeScreenParameters` : Triggered when the application change...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~23-~23: Loose punctuation mark.
Context: ...Mac.ApplicationDidChangeStatusBarFrame` : Triggered when the application change...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~26-~26: Loose punctuation mark.
Context: ...licationDidChangeStatusBarOrientation` : Triggered when the application change...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~29-~29: Loose punctuation mark.
Context: ...ents.Mac.ApplicationDidFinishLaunching` : Triggered when the application finish...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~32-~32: Loose punctuation mark.
Context: ...ApplicationDidResignActiveNotification` : Triggered when the application is no ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~35-~35: Loose punctuation mark.
Context: ...active events.Mac.ApplicationDidHide : Triggered when the application is hid...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~38-~38: Loose punctuation mark.
Context: ...dden events.Mac.ApplicationDidUpdate : Triggered when the application update...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~41-~41: Loose punctuation mark.
Context: ...events.Mac.ApplicationWillBecomeActive` : Triggered when the application is abo...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~44-~44: Loose punctuation mark.
Context: ...nts.Mac.ApplicationWillFinishLaunching` : Triggered when the application is abo...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~47-~47: Loose punctuation mark.
Context: ...ching events.Mac.ApplicationWillHide : Triggered when the application is abo...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~50-~50: Loose punctuation mark.
Context: ...events.Mac.ApplicationWillResignActive` : Triggered when the application is abo...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~53-~53: Loose punctuation mark.
Context: ... events.Mac.ApplicationWillTerminate : Triggered when the application is abo...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~56-~56: Loose punctuation mark.
Context: ...ate events.Mac.ApplicationWillUnhide : Triggered when the application is abo...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~59-~59: Loose punctuation mark.
Context: ...de events.Mac.ApplicationWillUpdate : Triggered when the application is abo...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~62-~62: Loose punctuation mark.
Context: ...events.Mac.ApplicationDidChangeTheme : Triggered when the application change...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~65-~65: Loose punctuation mark.
Context: ...hanges theme events.Mac.MenuWillOpen : Triggered when the menu is about to o...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~68-~68: Loose punctuation mark.
Context: ...about to open events.Mac.MenuDidOpen : Triggered when the menu opens `event...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~71-~71: Loose punctuation mark.
Context: ...e menu opens events.Mac.MenuDidClose : Triggered when the menu closes `even...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~74-~74: Loose punctuation mark.
Context: ...closes events.Mac.MenuWillSendAction : Triggered when the menu is about to s...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~77-~77: Loose punctuation mark.
Context: ... action events.Mac.MenuDidSendAction : Triggered when the menu sends an acti...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~80-~80: Loose punctuation mark.
Context: ...ion events.Mac.MenuWillHighlightItem : Triggered when the menu is about to h...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~83-~83: Loose punctuation mark.
Context: ...item events.Mac.MenuDidHighlightItem : Triggered when the menu highlights an...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~86-~86: Loose punctuation mark.
Context: ... item events.Mac.MenuWillDisplayItem : Triggered when the menu is about to d...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~89-~89: Loose punctuation mark.
Context: ...n item events.Mac.MenuDidDisplayItem : Triggered when the menu displays an i...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~92-~92: Loose punctuation mark.
Context: ...s an item events.Mac.MenuWillAddItem : Triggered when the menu is about to a...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~95-~95: Loose punctuation mark.
Context: ...dd an item events.Mac.MenuDidAddItem : Triggered when the menu adds an item ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~98-~98: Loose punctuation mark.
Context: ...n item events.Mac.MenuWillRemoveItem : Triggered when the menu is about to r...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~101-~101: Loose punctuation mark.
Context: ...an item events.Mac.MenuDidRemoveItem : Triggered when the menu removes an it...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~104-~104: Loose punctuation mark.
Context: ...tem events.Mac.MenuWillBeginTracking : Triggered when the menu is about to b...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~107-~107: Loose punctuation mark.
Context: ...king events.Mac.MenuDidBeginTracking : Triggered when the menu begins tracki...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~110-~110: Loose punctuation mark.
Context: ...cking events.Mac.MenuWillEndTracking : Triggered when the menu is about to e...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~113-~113: Loose punctuation mark.
Context: ...acking events.Mac.MenuDidEndTracking : Triggered when the menu ends tracking...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~116-~116: Loose punctuation mark.
Context: ...s tracking events.Mac.MenuWillUpdate : Triggered when the menu is about to u...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~119-~119: Loose punctuation mark.
Context: ...t to update events.Mac.MenuDidUpdate : Triggered when the menu updates `eve...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~122-~122: Loose punctuation mark.
Context: ...enu updates events.Mac.MenuWillPopUp : Triggered when the menu is about to p...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~125-~125: Loose punctuation mark.
Context: ...ut to pop up events.Mac.MenuDidPopUp : Triggered when the menu pops up `eve...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~128-~128: Loose punctuation mark.
Context: ... events.Mac.MenuWillSendActionToItem : Triggered when the menu is about to s...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~131-~131: Loose punctuation mark.
Context: ...m events.Mac.MenuDidSendActionToItem : Triggered when the menu sends an acti...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~136-~136: Loose punctuation mark.
Context: ...Events events.Mac.WindowDidBecomeKey : Triggered when the window becomes key...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~139-~139: Loose punctuation mark.
Context: ...s key events.Mac.WindowDidBecomeMain : Triggered when the window becomes mai...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~142-~142: Loose punctuation mark.
Context: ... main events.Mac.WindowDidBeginSheet : Triggered when the window begins a sh...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~145-~145: Loose punctuation mark.
Context: ...heet events.Mac.WindowDidChangeAlpha : Triggered when the window alpha chang...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~148-~148: Loose punctuation mark.
Context: ...nts.Mac.WindowDidChangeBackingLocation` : Triggered when the window backing loc...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~151-~151: Loose punctuation mark.
Context: ...s.Mac.WindowDidChangeBackingProperties` : Triggered when the window backing pro...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~154-~154: Loose punctuation mark.
Context: ....Mac.WindowDidChangeCollectionBehavior` : Triggered when the window collection ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~157-~157: Loose punctuation mark.
Context: ...Mac.WindowDidChangeEffectiveAppearance` : Triggered when the window effective a...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~160-~160: Loose punctuation mark.
Context: ...ents.Mac.WindowDidChangeOcclusionState` : Triggered when the window occlusion s...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~163-~163: Loose punctuation mark.
Context: ...events.Mac.WindowDidChangeOrderingMode` : Triggered when the window ordering mo...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~166-~166: Loose punctuation mark.
Context: ...ges events.Mac.WindowDidChangeScreen : Triggered when the window screen chan...
(UNLIKELY_OPENING_PUNCTUATION)
[grammar] ~167-~167: Did you mean “screens”?
Context: ...geScreen: Triggered when the window screen changes events.Mac.WindowDidChangeScr...
(WRB_DT_NN_VB)
[uncategorized] ~169-~169: Loose punctuation mark.
Context: ...ts.Mac.WindowDidChangeScreenParameters` : Triggered when the window screen para...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~172-~172: Loose punctuation mark.
Context: ...vents.Mac.WindowDidChangeScreenProfile` : Triggered when the window screen prof...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~175-~175: Loose punctuation mark.
Context: ...events.Mac.WindowDidChangeScreenSpace : Triggered when the window screen spac...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~178-~178: Loose punctuation mark.
Context: ...c.WindowDidChangeScreenSpaceProperties` : Triggered when the window screen spac...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~181-~181: Loose punctuation mark.
Context: ...events.Mac.WindowDidChangeSharingType : Triggered when the window sharing typ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~184-~184: Loose punctuation mark.
Context: ...nges events.Mac.WindowDidChangeSpace : Triggered when the window space chang...
(UNLIKELY_OPENING_PUNCTUATION)
[grammar] ~185-~185: Did you mean “spaces”?
Context: ...ngeSpace: Triggered when the window space changes events.Mac.WindowDidChangeSpa...
(WRB_DT_NN_VB)
[uncategorized] ~187-~187: Loose punctuation mark.
Context: ...s.Mac.WindowDidChangeSpaceOrderingMode` : Triggered when the window space order...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~190-~190: Loose punctuation mark.
Context: ...nges events.Mac.WindowDidChangeTitle : Triggered when the window title chang...
(UNLIKELY_OPENING_PUNCTUATION)
[grammar] ~191-~191: Did you mean “titles”?
Context: ...ngeTitle: Triggered when the window title changes events.Mac.WindowDidChangeToo...
(WRB_DT_NN_VB)
[uncategorized] ~193-~193: Loose punctuation mark.
Context: ...es events.Mac.WindowDidChangeToolbar : Triggered when the window toolbar cha...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~196-~196: Loose punctuation mark.
Context: ... events.Mac.WindowDidChangeVisibility : Triggered when the window visibility ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~199-~199: Loose punctuation mark.
Context: ...es events.Mac.WindowDidDeminiaturize : Triggered when the window is deminiat...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~202-~202: Loose punctuation mark.
Context: ...turized events.Mac.WindowDidEndSheet : Triggered when the window ends a shee...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~205-~205: Loose punctuation mark.
Context: ... events.Mac.WindowDidEnterFullScreen : Triggered when the window enters full...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~208-~208: Loose punctuation mark.
Context: ...vents.Mac.WindowDidEnterVersionBrowser` : Triggered when the window enters vers...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~211-~211: Loose punctuation mark.
Context: ...r events.Mac.WindowDidExitFullScreen : Triggered when the window exits fulls...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~214-~214: Loose punctuation mark.
Context: ...events.Mac.WindowDidExitVersionBrowser` : Triggered when the window exits versi...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~217-~217: Loose punctuation mark.
Context: ...n browser events.Mac.WindowDidExpose : Triggered when the window is exposed ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~220-~220: Loose punctuation mark.
Context: ...is exposed events.Mac.WindowDidFocus : Triggered when the window is focused ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~223-~223: Loose punctuation mark.
Context: ...used events.Mac.WindowDidMiniaturize : Triggered when the window is miniatur...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~226-~226: Loose punctuation mark.
Context: ...iniaturized events.Mac.WindowDidMove : Triggered when the window is moved `...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~229-~229: Loose punctuation mark.
Context: ...d events.Mac.WindowDidOrderOffScreen : Triggered when the window is ordered ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~232-~232: Loose punctuation mark.
Context: ...en events.Mac.WindowDidOrderOnScreen : Triggered when the window is ordered ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~235-~235: Loose punctuation mark.
Context: ...screen events.Mac.WindowDidResignKey : Triggered when the window resigns key...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~238-~238: Loose punctuation mark.
Context: ...s key events.Mac.WindowDidResignMain : Triggered when the window resigns mai...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~241-~241: Loose punctuation mark.
Context: ...igns main events.Mac.WindowDidResize : Triggered when the window is resized ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~244-~244: Loose punctuation mark.
Context: ...s resized events.Mac.WindowDidUpdate : Triggered when the window updates `e...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~247-~247: Loose punctuation mark.
Context: ...ates events.Mac.WindowDidUpdateAlpha : Triggered when the window alpha updat...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~250-~250: Loose punctuation mark.
Context: ....Mac.WindowDidUpdateCollectionBehavior` : Triggered when the window collection ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~253-~253: Loose punctuation mark.
Context: ...ac.WindowDidUpdateCollectionProperties` : Triggered when the window collection ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~256-~256: Loose punctuation mark.
Context: ...ate events.Mac.WindowDidUpdateShadow : Triggered when the window shadow upda...
(UNLIKELY_OPENING_PUNCTUATION)
[grammar] ~257-~257: Did you mean “shadows”?
Context: ...teShadow: Triggered when the window shadow updates events.Mac.WindowDidUpdateTit...
(WRB_DT_NN_VB)
[uncategorized] ~259-~259: Loose punctuation mark.
Context: ...ates events.Mac.WindowDidUpdateTitle : Triggered when the window title updat...
(UNLIKELY_OPENING_PUNCTUATION)
[grammar] ~260-~260: Did you mean “titles”?
Context: ...ateTitle: Triggered when the window title updates events.Mac.WindowDidUpdateToo...
(WRB_DT_NN_VB)
[uncategorized] ~262-~262: Loose punctuation mark.
Context: ...es events.Mac.WindowDidUpdateToolbar : Triggered when the window toolbar upd...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~265-~265: Loose punctuation mark.
Context: ... events.Mac.WindowDidUpdateVisibility : Triggered when the window visibility ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~268-~268: Loose punctuation mark.
Context: ...updates events.Mac.WindowShouldClose : Triggered when the window should clos...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~271-~271: Loose punctuation mark.
Context: ...close events.Mac.WindowWillBecomeKey : Triggered when the window will become...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~274-~274: Loose punctuation mark.
Context: ... key events.Mac.WindowWillBecomeMain : Triggered when the window will become...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~277-~277: Loose punctuation mark.
Context: ...main events.Mac.WindowWillBeginSheet : Triggered when the window will begin ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~280-~280: Loose punctuation mark.
Context: ...vents.Mac.WindowWillChangeOrderingMode` : Triggered when the window will change...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~283-~283: Loose punctuation mark.
Context: ...ring mode events.Mac.WindowWillClose : Triggered when the window will close ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~286-~286: Loose punctuation mark.
Context: ...e events.Mac.WindowWillDeminiaturize : Triggered when the window will demini...
(UNLIKELY_OPENING_PUNCTUATION)
[grammar] ~287-~287: Did you mean “wills”?
Context: ...iaturize: Triggered when the window will deminiaturize events.Mac.WindowWillEn...
(WRB_DT_NN_VB)
[uncategorized] ~289-~289: Loose punctuation mark.
Context: ... events.Mac.WindowWillEnterFullScreen : Triggered when the window will enter ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~292-~292: Loose punctuation mark.
Context: ...ents.Mac.WindowWillEnterVersionBrowser` : Triggered when the window will enter ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~295-~295: Loose punctuation mark.
Context: ... events.Mac.WindowWillExitFullScreen : Triggered when the window will exit f...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~298-~298: Loose punctuation mark.
Context: ...vents.Mac.WindowWillExitVersionBrowser` : Triggered when the window will exit v...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~301-~301: Loose punctuation mark.
Context: ...n browser events.Mac.WindowWillFocus : Triggered when the window will focus ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~304-~304: Loose punctuation mark.
Context: ...cus events.Mac.WindowWillMiniaturize : Triggered when the window will miniat...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~307-~307: Loose punctuation mark.
Context: ...iniaturize events.Mac.WindowWillMove : Triggered when the window will move ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~310-~310: Loose punctuation mark.
Context: ... events.Mac.WindowWillOrderOffScreen : Triggered when the window will order ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~313-~313: Loose punctuation mark.
Context: ...n events.Mac.WindowWillOrderOnScreen : Triggered when the window will order ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~316-~316: Loose punctuation mark.
Context: ...een events.Mac.WindowWillResignMain` : Triggered when the window will resign...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~319-~319: Loose punctuation mark.
Context: ...ign main events.Mac.WindowWillResize : Triggered when the window will resize...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~322-~322: Loose punctuation mark.
Context: ... resize events.Mac.WindowWillUnfocus : Triggered when the window will unfocu...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~325-~325: Loose punctuation mark.
Context: ...unfocus events.Mac.WindowWillUpdate` : Triggered when the window will update...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~328-~328: Loose punctuation mark.
Context: ...ate events.Mac.WindowWillUpdateAlpha : Triggered when the window will update...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~331-~331: Loose punctuation mark.
Context: ...Mac.WindowWillUpdateCollectionBehavior` : Triggered when the window will update...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~334-~334: Loose punctuation mark.
Context: ...c.WindowWillUpdateCollectionProperties` : Triggered when the window will update...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~337-~337: Loose punctuation mark.
Context: ...es events.Mac.WindowWillUpdateShadow : Triggered when the window will update...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~340-~340: Loose punctuation mark.
Context: ...dow events.Mac.WindowWillUpdateTitle : Triggered when the window will update...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~343-~343: Loose punctuation mark.
Context: ...e events.Mac.WindowWillUpdateToolbar : Triggered when the window will update...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~346-~346: Loose punctuation mark.
Context: ...events.Mac.WindowWillUpdateVisibility : Triggered when the window will update...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~349-~349: Loose punctuation mark.
Context: ...events.Mac.WindowWillUseStandardFrame : Triggered when the window will use st...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~352-~352: Loose punctuation mark.
Context: ...c.WebviewDidStartProvisionalNavigation` : Triggered when the webview starts a p...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~355-~355: Loose punctuation mark.
Context: ...ServerRedirectForProvisionalNavigation` : Triggered when the webview receives a...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~358-~358: Loose punctuation mark.
Context: ...events.Mac.WebviewDidFinishNavigation : Triggered when the webview finishes n...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~361-~361: Loose punctuation mark.
Context: ...events.Mac.WebviewDidCommitNavigation : Triggered when the webview commits na...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~364-~364: Loose punctuation mark.
Context: ... events.Mac.WindowFileDraggingEntered : Triggered when files are dragged into...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~367-~367: Loose punctuation mark.
Context: ...events.Mac.WindowFileDraggingPerformed` : Triggered when files are dragged in t...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~370-~370: Loose punctuation mark.
Context: ... events.Mac.WindowFileDraggingExited : Triggered when files are dragged out ...
(UNLIKELY_OPENING_PUNCTUATION)
1-371: Verify completeness of macOS event coverage.
The documented events align well with macOS AppKit notifications. However, let's verify that we haven't missed any critical events.
✅ Verification successful
Based on the search results, I can now generate the final response:
The macOS events documentation is comprehensive and technically accurate
The documented events in events_mac.md provide thorough coverage of the essential macOS AppKit notifications and delegate methods. The search results confirm that all critical window, application, menu, and webview events are already included in the documentation. The implementation files show delegate methods that correspond to the documented events, such as:
- Application lifecycle events (termination, window closing)
- Window behavior events (fullscreen, collection behavior)
- Window delegate notifications
- Webview delegate methods
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Search for any additional AppKit notification constants that might be relevant
rg -i "NSWindow|NSApplication|NSMenu" | grep -i "notification\|delegate" | grep -v "events.Mac"
Length of output: 3249
🧰 Tools
🪛 LanguageTool
[uncategorized] ~5-~5: Loose punctuation mark.
Context: ...events.Mac.ApplicationDidBecomeActive : Triggered when the application become...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~8-~8: Loose punctuation mark.
Context: ....ApplicationDidChangeBackingProperties` : Triggered when the application change...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~11-~11: Loose punctuation mark.
Context: ...pplicationDidChangeEffectiveAppearance` : Triggered when the application change...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~14-~14: Loose punctuation mark.
Context: ... events.Mac.ApplicationDidChangeIcon : Triggered when the application change...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~17-~17: Loose punctuation mark.
Context: ...Mac.ApplicationDidChangeOcclusionState` : Triggered when the application change...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~20-~20: Loose punctuation mark.
Context: ...c.ApplicationDidChangeScreenParameters` : Triggered when the application change...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~23-~23: Loose punctuation mark.
Context: ...Mac.ApplicationDidChangeStatusBarFrame` : Triggered when the application change...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~26-~26: Loose punctuation mark.
Context: ...licationDidChangeStatusBarOrientation` : Triggered when the application change...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~29-~29: Loose punctuation mark.
Context: ...ents.Mac.ApplicationDidFinishLaunching` : Triggered when the application finish...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~32-~32: Loose punctuation mark.
Context: ...ApplicationDidResignActiveNotification` : Triggered when the application is no ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~35-~35: Loose punctuation mark.
Context: ...active events.Mac.ApplicationDidHide : Triggered when the application is hid...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~38-~38: Loose punctuation mark.
Context: ...dden events.Mac.ApplicationDidUpdate : Triggered when the application update...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~41-~41: Loose punctuation mark.
Context: ...events.Mac.ApplicationWillBecomeActive` : Triggered when the application is abo...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~44-~44: Loose punctuation mark.
Context: ...nts.Mac.ApplicationWillFinishLaunching` : Triggered when the application is abo...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~47-~47: Loose punctuation mark.
Context: ...ching events.Mac.ApplicationWillHide : Triggered when the application is abo...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~50-~50: Loose punctuation mark.
Context: ...events.Mac.ApplicationWillResignActive` : Triggered when the application is abo...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~53-~53: Loose punctuation mark.
Context: ... events.Mac.ApplicationWillTerminate : Triggered when the application is abo...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~56-~56: Loose punctuation mark.
Context: ...ate events.Mac.ApplicationWillUnhide : Triggered when the application is abo...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~59-~59: Loose punctuation mark.
Context: ...de events.Mac.ApplicationWillUpdate : Triggered when the application is abo...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~62-~62: Loose punctuation mark.
Context: ...events.Mac.ApplicationDidChangeTheme : Triggered when the application change...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~65-~65: Loose punctuation mark.
Context: ...hanges theme events.Mac.MenuWillOpen : Triggered when the menu is about to o...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~68-~68: Loose punctuation mark.
Context: ...about to open events.Mac.MenuDidOpen : Triggered when the menu opens `event...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~71-~71: Loose punctuation mark.
Context: ...e menu opens events.Mac.MenuDidClose : Triggered when the menu closes `even...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~74-~74: Loose punctuation mark.
Context: ...closes events.Mac.MenuWillSendAction : Triggered when the menu is about to s...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~77-~77: Loose punctuation mark.
Context: ... action events.Mac.MenuDidSendAction : Triggered when the menu sends an acti...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~80-~80: Loose punctuation mark.
Context: ...ion events.Mac.MenuWillHighlightItem : Triggered when the menu is about to h...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~83-~83: Loose punctuation mark.
Context: ...item events.Mac.MenuDidHighlightItem : Triggered when the menu highlights an...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~86-~86: Loose punctuation mark.
Context: ... item events.Mac.MenuWillDisplayItem : Triggered when the menu is about to d...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~89-~89: Loose punctuation mark.
Context: ...n item events.Mac.MenuDidDisplayItem : Triggered when the menu displays an i...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~92-~92: Loose punctuation mark.
Context: ...s an item events.Mac.MenuWillAddItem : Triggered when the menu is about to a...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~95-~95: Loose punctuation mark.
Context: ...dd an item events.Mac.MenuDidAddItem : Triggered when the menu adds an item ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~98-~98: Loose punctuation mark.
Context: ...n item events.Mac.MenuWillRemoveItem : Triggered when the menu is about to r...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~101-~101: Loose punctuation mark.
Context: ...an item events.Mac.MenuDidRemoveItem : Triggered when the menu removes an it...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~104-~104: Loose punctuation mark.
Context: ...tem events.Mac.MenuWillBeginTracking : Triggered when the menu is about to b...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~107-~107: Loose punctuation mark.
Context: ...king events.Mac.MenuDidBeginTracking : Triggered when the menu begins tracki...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~110-~110: Loose punctuation mark.
Context: ...cking events.Mac.MenuWillEndTracking : Triggered when the menu is about to e...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~113-~113: Loose punctuation mark.
Context: ...acking events.Mac.MenuDidEndTracking : Triggered when the menu ends tracking...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~116-~116: Loose punctuation mark.
Context: ...s tracking events.Mac.MenuWillUpdate : Triggered when the menu is about to u...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~119-~119: Loose punctuation mark.
Context: ...t to update events.Mac.MenuDidUpdate : Triggered when the menu updates `eve...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~122-~122: Loose punctuation mark.
Context: ...enu updates events.Mac.MenuWillPopUp : Triggered when the menu is about to p...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~125-~125: Loose punctuation mark.
Context: ...ut to pop up events.Mac.MenuDidPopUp : Triggered when the menu pops up `eve...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~128-~128: Loose punctuation mark.
Context: ... events.Mac.MenuWillSendActionToItem : Triggered when the menu is about to s...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~131-~131: Loose punctuation mark.
Context: ...m events.Mac.MenuDidSendActionToItem : Triggered when the menu sends an acti...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~136-~136: Loose punctuation mark.
Context: ...Events events.Mac.WindowDidBecomeKey : Triggered when the window becomes key...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~139-~139: Loose punctuation mark.
Context: ...s key events.Mac.WindowDidBecomeMain : Triggered when the window becomes mai...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~142-~142: Loose punctuation mark.
Context: ... main events.Mac.WindowDidBeginSheet : Triggered when the window begins a sh...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~145-~145: Loose punctuation mark.
Context: ...heet events.Mac.WindowDidChangeAlpha : Triggered when the window alpha chang...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~148-~148: Loose punctuation mark.
Context: ...nts.Mac.WindowDidChangeBackingLocation` : Triggered when the window backing loc...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~151-~151: Loose punctuation mark.
Context: ...s.Mac.WindowDidChangeBackingProperties` : Triggered when the window backing pro...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~154-~154: Loose punctuation mark.
Context: ....Mac.WindowDidChangeCollectionBehavior` : Triggered when the window collection ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~157-~157: Loose punctuation mark.
Context: ...Mac.WindowDidChangeEffectiveAppearance` : Triggered when the window effective a...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~160-~160: Loose punctuation mark.
Context: ...ents.Mac.WindowDidChangeOcclusionState` : Triggered when the window occlusion s...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~163-~163: Loose punctuation mark.
Context: ...events.Mac.WindowDidChangeOrderingMode` : Triggered when the window ordering mo...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~166-~166: Loose punctuation mark.
Context: ...ges events.Mac.WindowDidChangeScreen : Triggered when the window screen chan...
(UNLIKELY_OPENING_PUNCTUATION)
[grammar] ~167-~167: Did you mean “screens”?
Context: ...geScreen: Triggered when the window screen changes events.Mac.WindowDidChangeScr...
(WRB_DT_NN_VB)
[uncategorized] ~169-~169: Loose punctuation mark.
Context: ...ts.Mac.WindowDidChangeScreenParameters` : Triggered when the window screen para...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~172-~172: Loose punctuation mark.
Context: ...vents.Mac.WindowDidChangeScreenProfile` : Triggered when the window screen prof...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~175-~175: Loose punctuation mark.
Context: ...events.Mac.WindowDidChangeScreenSpace : Triggered when the window screen spac...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~178-~178: Loose punctuation mark.
Context: ...c.WindowDidChangeScreenSpaceProperties` : Triggered when the window screen spac...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~181-~181: Loose punctuation mark.
Context: ...events.Mac.WindowDidChangeSharingType : Triggered when the window sharing typ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~184-~184: Loose punctuation mark.
Context: ...nges events.Mac.WindowDidChangeSpace : Triggered when the window space chang...
(UNLIKELY_OPENING_PUNCTUATION)
[grammar] ~185-~185: Did you mean “spaces”?
Context: ...ngeSpace: Triggered when the window space changes events.Mac.WindowDidChangeSpa...
(WRB_DT_NN_VB)
[uncategorized] ~187-~187: Loose punctuation mark.
Context: ...s.Mac.WindowDidChangeSpaceOrderingMode` : Triggered when the window space order...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~190-~190: Loose punctuation mark.
Context: ...nges events.Mac.WindowDidChangeTitle : Triggered when the window title chang...
(UNLIKELY_OPENING_PUNCTUATION)
[grammar] ~191-~191: Did you mean “titles”?
Context: ...ngeTitle: Triggered when the window title changes events.Mac.WindowDidChangeToo...
(WRB_DT_NN_VB)
[uncategorized] ~193-~193: Loose punctuation mark.
Context: ...es events.Mac.WindowDidChangeToolbar : Triggered when the window toolbar cha...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~196-~196: Loose punctuation mark.
Context: ... events.Mac.WindowDidChangeVisibility : Triggered when the window visibility ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~199-~199: Loose punctuation mark.
Context: ...es events.Mac.WindowDidDeminiaturize : Triggered when the window is deminiat...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~202-~202: Loose punctuation mark.
Context: ...turized events.Mac.WindowDidEndSheet : Triggered when the window ends a shee...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~205-~205: Loose punctuation mark.
Context: ... events.Mac.WindowDidEnterFullScreen : Triggered when the window enters full...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~208-~208: Loose punctuation mark.
Context: ...vents.Mac.WindowDidEnterVersionBrowser` : Triggered when the window enters vers...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~211-~211: Loose punctuation mark.
Context: ...r events.Mac.WindowDidExitFullScreen : Triggered when the window exits fulls...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~214-~214: Loose punctuation mark.
Context: ...events.Mac.WindowDidExitVersionBrowser` : Triggered when the window exits versi...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~217-~217: Loose punctuation mark.
Context: ...n browser events.Mac.WindowDidExpose : Triggered when the window is exposed ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~220-~220: Loose punctuation mark.
Context: ...is exposed events.Mac.WindowDidFocus : Triggered when the window is focused ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~223-~223: Loose punctuation mark.
Context: ...used events.Mac.WindowDidMiniaturize : Triggered when the window is miniatur...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~226-~226: Loose punctuation mark.
Context: ...iniaturized events.Mac.WindowDidMove : Triggered when the window is moved `...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~229-~229: Loose punctuation mark.
Context: ...d events.Mac.WindowDidOrderOffScreen : Triggered when the window is ordered ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~232-~232: Loose punctuation mark.
Context: ...en events.Mac.WindowDidOrderOnScreen : Triggered when the window is ordered ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~235-~235: Loose punctuation mark.
Context: ...screen events.Mac.WindowDidResignKey : Triggered when the window resigns key...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~238-~238: Loose punctuation mark.
Context: ...s key events.Mac.WindowDidResignMain : Triggered when the window resigns mai...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~241-~241: Loose punctuation mark.
Context: ...igns main events.Mac.WindowDidResize : Triggered when the window is resized ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~244-~244: Loose punctuation mark.
Context: ...s resized events.Mac.WindowDidUpdate : Triggered when the window updates `e...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~247-~247: Loose punctuation mark.
Context: ...ates events.Mac.WindowDidUpdateAlpha : Triggered when the window alpha updat...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~250-~250: Loose punctuation mark.
Context: ....Mac.WindowDidUpdateCollectionBehavior` : Triggered when the window collection ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~253-~253: Loose punctuation mark.
Context: ...ac.WindowDidUpdateCollectionProperties` : Triggered when the window collection ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~256-~256: Loose punctuation mark.
Context: ...ate events.Mac.WindowDidUpdateShadow : Triggered when the window shadow upda...
(UNLIKELY_OPENING_PUNCTUATION)
[grammar] ~257-~257: Did you mean “shadows”?
Context: ...teShadow: Triggered when the window shadow updates events.Mac.WindowDidUpdateTit...
(WRB_DT_NN_VB)
[uncategorized] ~259-~259: Loose punctuation mark.
Context: ...ates events.Mac.WindowDidUpdateTitle : Triggered when the window title updat...
(UNLIKELY_OPENING_PUNCTUATION)
[grammar] ~260-~260: Did you mean “titles”?
Context: ...ateTitle: Triggered when the window title updates events.Mac.WindowDidUpdateToo...
(WRB_DT_NN_VB)
[uncategorized] ~262-~262: Loose punctuation mark.
Context: ...es events.Mac.WindowDidUpdateToolbar : Triggered when the window toolbar upd...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~265-~265: Loose punctuation mark.
Context: ... events.Mac.WindowDidUpdateVisibility : Triggered when the window visibility ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~268-~268: Loose punctuation mark.
Context: ...updates events.Mac.WindowShouldClose : Triggered when the window should clos...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~271-~271: Loose punctuation mark.
Context: ...close events.Mac.WindowWillBecomeKey : Triggered when the window will become...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~274-~274: Loose punctuation mark.
Context: ... key events.Mac.WindowWillBecomeMain : Triggered when the window will become...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~277-~277: Loose punctuation mark.
Context: ...main events.Mac.WindowWillBeginSheet : Triggered when the window will begin ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~280-~280: Loose punctuation mark.
Context: ...vents.Mac.WindowWillChangeOrderingMode` : Triggered when the window will change...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~283-~283: Loose punctuation mark.
Context: ...ring mode events.Mac.WindowWillClose : Triggered when the window will close ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~286-~286: Loose punctuation mark.
Context: ...e events.Mac.WindowWillDeminiaturize : Triggered when the window will demini...
(UNLIKELY_OPENING_PUNCTUATION)
[grammar] ~287-~287: Did you mean “wills”?
Context: ...iaturize: Triggered when the window will deminiaturize events.Mac.WindowWillEn...
(WRB_DT_NN_VB)
[uncategorized] ~289-~289: Loose punctuation mark.
Context: ... events.Mac.WindowWillEnterFullScreen : Triggered when the window will enter ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~292-~292: Loose punctuation mark.
Context: ...ents.Mac.WindowWillEnterVersionBrowser` : Triggered when the window will enter ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~295-~295: Loose punctuation mark.
Context: ... events.Mac.WindowWillExitFullScreen : Triggered when the window will exit f...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~298-~298: Loose punctuation mark.
Context: ...vents.Mac.WindowWillExitVersionBrowser` : Triggered when the window will exit v...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~301-~301: Loose punctuation mark.
Context: ...n browser events.Mac.WindowWillFocus : Triggered when the window will focus ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~304-~304: Loose punctuation mark.
Context: ...cus events.Mac.WindowWillMiniaturize : Triggered when the window will miniat...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~307-~307: Loose punctuation mark.
Context: ...iniaturize events.Mac.WindowWillMove : Triggered when the window will move ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~310-~310: Loose punctuation mark.
Context: ... events.Mac.WindowWillOrderOffScreen : Triggered when the window will order ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~313-~313: Loose punctuation mark.
Context: ...n events.Mac.WindowWillOrderOnScreen : Triggered when the window will order ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~316-~316: Loose punctuation mark.
Context: ...een events.Mac.WindowWillResignMain` : Triggered when the window will resign...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~319-~319: Loose punctuation mark.
Context: ...ign main events.Mac.WindowWillResize : Triggered when the window will resize...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~322-~322: Loose punctuation mark.
Context: ... resize events.Mac.WindowWillUnfocus : Triggered when the window will unfocu...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~325-~325: Loose punctuation mark.
Context: ...unfocus events.Mac.WindowWillUpdate` : Triggered when the window will update...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~328-~328: Loose punctuation mark.
Context: ...ate events.Mac.WindowWillUpdateAlpha : Triggered when the window will update...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~331-~331: Loose punctuation mark.
Context: ...Mac.WindowWillUpdateCollectionBehavior` : Triggered when the window will update...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~334-~334: Loose punctuation mark.
Context: ...c.WindowWillUpdateCollectionProperties` : Triggered when the window will update...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~337-~337: Loose punctuation mark.
Context: ...es events.Mac.WindowWillUpdateShadow : Triggered when the window will update...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~340-~340: Loose punctuation mark.
Context: ...dow events.Mac.WindowWillUpdateTitle : Triggered when the window will update...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~343-~343: Loose punctuation mark.
Context: ...e events.Mac.WindowWillUpdateToolbar : Triggered when the window will update...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~346-~346: Loose punctuation mark.
Context: ...events.Mac.WindowWillUpdateVisibility : Triggered when the window will update...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~349-~349: Loose punctuation mark.
Context: ...events.Mac.WindowWillUseStandardFrame : Triggered when the window will use st...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~352-~352: Loose punctuation mark.
Context: ...c.WebviewDidStartProvisionalNavigation` : Triggered when the webview starts a p...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~355-~355: Loose punctuation mark.
Context: ...ServerRedirectForProvisionalNavigation` : Triggered when the webview receives a...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~358-~358: Loose punctuation mark.
Context: ...events.Mac.WebviewDidFinishNavigation : Triggered when the webview finishes n...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~361-~361: Loose punctuation mark.
Context: ...events.Mac.WebviewDidCommitNavigation : Triggered when the webview commits na...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~364-~364: Loose punctuation mark.
Context: ... events.Mac.WindowFileDraggingEntered : Triggered when files are dragged into...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~367-~367: Loose punctuation mark.
Context: ...events.Mac.WindowFileDraggingPerformed` : Triggered when files are dragged in t...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~370-~370: Loose punctuation mark.
Context: ... events.Mac.WindowFileDraggingExited : Triggered when files are dragged out ...
(UNLIKELY_OPENING_PUNCTUATION)
| `events.Linux.WindowLoadChanged` | ||
| : Triggered when the window load changes | ||
|
|
||
| `events.Linux.WindowDeleteEvent` | ||
| : Triggered when the window is deleted | ||
|
|
||
| `events.Linux.WindowDidMove` | ||
| : Triggered when the window is moved | ||
|
|
||
| `events.Linux.WindowDidResize` | ||
| : Triggered when the window is resized | ||
|
|
||
| `events.Linux.WindowFocusIn` | ||
| : Triggered when the window gains focus | ||
|
|
||
| `events.Linux.WindowFocusOut` | ||
| : Triggered when the window loses focus | ||
|
|
There was a problem hiding this comment.
💡 Codebase verification
Based on the source code analysis, I can now provide a clear response about these events:
Enhance event descriptions with implementation details
The source code reveals:
-
WindowLoadChanged: This event is triggered when a web page finishes loading in the window. It's used to:- Execute custom JavaScript code specified in options
- Execute core runtime JavaScript
- Apply custom CSS styles
-
WindowDeleteEvent: This event is triggered when the window is about to be deleted/closed. It:- Emits a common
WindowClosingevent - Can be used to handle cleanup before window closure
- Emits a common
Suggested documentation updates:
`events.Linux.WindowLoadChanged`
-: Triggered when the window load changes
+: Triggered when a web page finishes loading in the window. Used to execute custom JS/CSS and initialize the runtime.
`events.Linux.WindowDeleteEvent`
-: Triggered when the window is deleted
+: Triggered when the window is about to be closed. Emits a WindowClosing event that can be handled for cleanup.🔗 Analysis chain
Clarify WindowLoadChanged and WindowDeleteEvent behaviors.
Some event descriptions need more clarity:
- WindowLoadChanged: The current description doesn't explain what constitutes a "load change"
- WindowDeleteEvent: It's unclear whether this event is cancelable (can prevent window deletion)
Let's verify if these events are documented in the source code:
Consider enhancing the descriptions:
`events.Linux.WindowLoadChanged`
-: Triggered when the window load changes
+: Triggered when the window's loading state changes (e.g., during navigation or resource loading)
`events.Linux.WindowDeleteEvent`
-: Triggered when the window is deleted
+: Triggered when the window is about to be deleted. Return `false` from the event handler to cancel the deletion.Let me analyze the source code to understand the behavior of these events. Let me search for their implementations:
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Search for event definitions and comments in source code
rg -A 5 "WindowLoadChanged|WindowDeleteEvent"
Length of output: 150754
Script:
#!/bin/bash
# Search for WindowLoadChanged implementation
rg -A 10 "WindowLoadChanged.*\{"
# Search for WindowDeleteEvent implementation
rg -A 10 "WindowDeleteEvent.*\{"
# Search for any additional context around these events
rg -B 2 -A 2 "WindowLoadChanged|WindowDeleteEvent" v3/pkg/application/
Length of output: 290707
🧰 Tools
🪛 LanguageTool
[uncategorized] ~13-~13: Loose punctuation mark.
Context: ...vents events.Linux.WindowLoadChanged : Triggered when the window load change...
(UNLIKELY_OPENING_PUNCTUATION)
[grammar] ~14-~14: Did you mean “loads”?
Context: ...dChanged: Triggered when the window load changes events.Linux.WindowDeleteEven...
(WRB_DT_NN_VB)
[uncategorized] ~16-~16: Loose punctuation mark.
Context: ...anges events.Linux.WindowDeleteEvent : Triggered when the window is deleted ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~19-~19: Loose punctuation mark.
Context: ...s deleted events.Linux.WindowDidMove : Triggered when the window is moved `...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~22-~22: Loose punctuation mark.
Context: ...s moved events.Linux.WindowDidResize : Triggered when the window is resized ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~25-~25: Loose punctuation mark.
Context: ...s resized events.Linux.WindowFocusIn : Triggered when the window gains focus...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~28-~28: Loose punctuation mark.
Context: ...ns focus events.Linux.WindowFocusOut : Triggered when the window loses focus...
(UNLIKELY_OPENING_PUNCTUATION)
| `events.Windows.WebviewNavigationCompleted` | ||
| : Triggered when the webview navigation is completed | ||
|
|
||
| `events.Windows.WindowInactive` | ||
| : Triggered when the window is inactive | ||
|
|
||
| `events.Windows.WindowActive` | ||
| : Triggered when the window is active | ||
|
|
||
| `events.Windows.ClickActive` | ||
| : Triggered when the window is activated via a click | ||
|
|
||
| `events.Windows.MaximiseActive` | ||
| : Triggered when the window is maximised | ||
|
|
||
| `events.Windows.UnMaximise` | ||
| : Triggered when the window is unmaximised | ||
|
|
||
| `events.Windows.Fullscreen` | ||
| : Triggered when the window is set to fullscreen | ||
|
|
||
| `events.Windows.UnFullscreen` | ||
| : Triggered when the window is exited from fullscreene | ||
|
|
||
| `events.Windows.WindowRestore` | ||
| : Triggered when the window is restored | ||
|
|
||
| `events.Windows.WindowMinimise` | ||
| : Triggered when the window is minimised | ||
|
|
||
| `events.Windows.WindowUnminimise` | ||
| : Triggered when the window is unminimised | ||
|
|
||
| `events.Windows.WindowClose` | ||
| : Triggered before the window closes | ||
| `events.Windows.WindowSetFocus` | ||
| : Triggered when the window gains keyboard focus | ||
|
|
||
| `events.Windows.WindowKillFocus` | ||
| : Triggered when the window loses keyboard focus | ||
|
|
||
| `events.Windows.WindowDragDrop` | ||
| : Triggered when files are dropped on the window | ||
|
|
||
| `events.Windows.WindowDragEnter` | ||
| : Triggered when a drag enters the window | ||
|
|
||
| `events.Windows.WindowDragLeave` | ||
| : Triggered when a drag leaves the window | ||
|
|
||
| `events.Windows.WindowDragOver` | ||
| : Triggered when a drag is over the window | ||
|
|
||
| `events.Windows.WindowDidMove` | ||
| : Triggered after a window has moved |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Consider standardizing event naming patterns.
The event names use inconsistent patterns. For better maintainability and clarity, consider standardizing the naming:
- Window-related events should consistently start with "Window" prefix
- Actions should be consistently positioned (prefix vs suffix)
Consider renaming these events:
-`events.Windows.MaximiseActive`
+`events.Windows.WindowMaximize`
-`events.Windows.UnMaximise`
+`events.Windows.WindowUnmaximize`
-`events.Windows.Fullscreen`
+`events.Windows.WindowFullscreen`
-`events.Windows.UnFullscreen`
+`events.Windows.WindowUnfullscreen`
-`events.Windows.ClickActive`
+`events.Windows.WindowClickActivate`📝 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.
| `events.Windows.WebviewNavigationCompleted` | |
| : Triggered when the webview navigation is completed | |
| `events.Windows.WindowInactive` | |
| : Triggered when the window is inactive | |
| `events.Windows.WindowActive` | |
| : Triggered when the window is active | |
| `events.Windows.ClickActive` | |
| : Triggered when the window is activated via a click | |
| `events.Windows.MaximiseActive` | |
| : Triggered when the window is maximised | |
| `events.Windows.UnMaximise` | |
| : Triggered when the window is unmaximised | |
| `events.Windows.Fullscreen` | |
| : Triggered when the window is set to fullscreen | |
| `events.Windows.UnFullscreen` | |
| : Triggered when the window is exited from fullscreene | |
| `events.Windows.WindowRestore` | |
| : Triggered when the window is restored | |
| `events.Windows.WindowMinimise` | |
| : Triggered when the window is minimised | |
| `events.Windows.WindowUnminimise` | |
| : Triggered when the window is unminimised | |
| `events.Windows.WindowClose` | |
| : Triggered before the window closes | |
| `events.Windows.WindowSetFocus` | |
| : Triggered when the window gains keyboard focus | |
| `events.Windows.WindowKillFocus` | |
| : Triggered when the window loses keyboard focus | |
| `events.Windows.WindowDragDrop` | |
| : Triggered when files are dropped on the window | |
| `events.Windows.WindowDragEnter` | |
| : Triggered when a drag enters the window | |
| `events.Windows.WindowDragLeave` | |
| : Triggered when a drag leaves the window | |
| `events.Windows.WindowDragOver` | |
| : Triggered when a drag is over the window | |
| `events.Windows.WindowDidMove` | |
| : Triggered after a window has moved | |
| `events.Windows.WebviewNavigationCompleted` | |
| : Triggered when the webview navigation is completed | |
| `events.Windows.WindowInactive` | |
| : Triggered when the window is inactive | |
| `events.Windows.WindowActive` | |
| : Triggered when the window is active | |
| `events.Windows.WindowClickActivate` | |
| : Triggered when the window is activated via a click | |
| `events.Windows.WindowMaximize` | |
| : Triggered when the window is maximised | |
| `events.Windows.WindowUnmaximize` | |
| : Triggered when the window is unmaximised | |
| `events.Windows.WindowFullscreen` | |
| : Triggered when the window is set to fullscreen | |
| `events.Windows.WindowUnfullscreen` | |
| : Triggered when the window is exited from fullscreene | |
| `events.Windows.WindowRestore` | |
| : Triggered when the window is restored | |
| `events.Windows.WindowMinimise` | |
| : Triggered when the window is minimised | |
| `events.Windows.WindowUnminimise` | |
| : Triggered when the window is unminimised | |
| `events.Windows.WindowClose` | |
| : Triggered before the window closes | |
| `events.Windows.WindowSetFocus` | |
| : Triggered when the window gains keyboard focus | |
| `events.Windows.WindowKillFocus` | |
| : Triggered when the window loses keyboard focus | |
| `events.Windows.WindowDragDrop` | |
| : Triggered when files are dropped on the window | |
| `events.Windows.WindowDragEnter` | |
| : Triggered when a drag enters the window | |
| `events.Windows.WindowDragLeave` | |
| : Triggered when a drag leaves the window | |
| `events.Windows.WindowDragOver` | |
| : Triggered when a drag is over the window | |
| `events.Windows.WindowDidMove` | |
| : Triggered after a window has moved |
🧰 Tools
🪛 LanguageTool
[uncategorized] ~25-~25: Loose punctuation mark.
Context: ...nts.Windows.WebviewNavigationCompleted` : Triggered when the webview navigation...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~28-~28: Loose punctuation mark.
Context: ...pleted events.Windows.WindowInactive : Triggered when the window is inactive...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~31-~31: Loose punctuation mark.
Context: ...inactive events.Windows.WindowActive : Triggered when the window is active ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~34-~34: Loose punctuation mark.
Context: ...is active events.Windows.ClickActive : Triggered when the window is activate...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~37-~37: Loose punctuation mark.
Context: ... click events.Windows.MaximiseActive : Triggered when the window is maximise...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~40-~40: Loose punctuation mark.
Context: ... maximised events.Windows.UnMaximise : Triggered when the window is unmaximi...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~43-~43: Loose punctuation mark.
Context: ...nmaximised events.Windows.Fullscreen : Triggered when the window is set to f...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~46-~46: Loose punctuation mark.
Context: ...llscreen events.Windows.UnFullscreen : Triggered when the window is exited f...
(UNLIKELY_OPENING_PUNCTUATION)
[style] ~47-~47: This phrase is redundant. Consider writing “exited”.
Context: ...creen: Triggered when the window is exited from fullscreene events.Windows.WindowRest...
(EXIT_FROM)
[uncategorized] ~49-~49: Loose punctuation mark.
Context: ...screene events.Windows.WindowRestore : Triggered when the window is restored...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~52-~52: Loose punctuation mark.
Context: ...stored events.Windows.WindowMinimise : Triggered when the window is minimise...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~55-~55: Loose punctuation mark.
Context: ...ised events.Windows.WindowUnminimise : Triggered when the window is unminimi...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~58-~58: Loose punctuation mark.
Context: ...minimised events.Windows.WindowClose : Triggered before the window closes `e...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~63-~63: Loose punctuation mark.
Context: ...focus events.Windows.WindowKillFocus : Triggered when the window loses keybo...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~66-~66: Loose punctuation mark.
Context: ... focus events.Windows.WindowDragDrop : Triggered when files are dropped on t...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~69-~69: Loose punctuation mark.
Context: ...indow events.Windows.WindowDragEnter : Triggered when a drag enters the wind...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~72-~72: Loose punctuation mark.
Context: ...indow events.Windows.WindowDragLeave : Triggered when a drag leaves the wind...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~75-~75: Loose punctuation mark.
Context: ...window events.Windows.WindowDragOver : Triggered when a drag is over the win...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~78-~78: Loose punctuation mark.
Context: ... window events.Windows.WindowDidMove : Triggered after a window has moved
(UNLIKELY_OPENING_PUNCTUATION)
|
|
||
| ```go | ||
| // Disable window closing by canceling the event | ||
| window.RegisterHook(events.Common.WindowClosing, func(e *application.WindowEvent) { |
There was a problem hiding this comment.
Use consistent method naming pattern
For consistency with other window event examples, use RegisterWindowEventHook instead of RegisterHook.
-window.RegisterHook(events.Common.WindowClosing, func(e *application.WindowEvent) {
+window.RegisterWindowEventHook(events.Common.WindowClosing, func(e *application.WindowEvent) {📝 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.
| window.RegisterHook(events.Common.WindowClosing, func(e *application.WindowEvent) { | |
| window.RegisterWindowEventHook(events.Common.WindowClosing, func(e *application.WindowEvent) { |
|
|
||
| ```go | ||
| // Notification of system theme change | ||
| application.OnApplicationEvent(events.Common.ThemeChanged, func(event *application.ApplicationEvent) { |
There was a problem hiding this comment.
Use consistent method naming pattern
For consistency with other examples, use RegisterApplicationEventHook instead of OnApplicationEvent.
-application.OnApplicationEvent(events.Common.ThemeChanged, func(event *application.ApplicationEvent) {
+application.RegisterApplicationEventHook(events.Common.ThemeChanged, func(event *application.ApplicationEvent) {📝 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.
| application.OnApplicationEvent(events.Common.ThemeChanged, func(event *application.ApplicationEvent) { | |
| application.RegisterApplicationEventHook(events.Common.ThemeChanged, func(event *application.ApplicationEvent) { |
| `events.Mac.WindowDidOrderOffScreen` | ||
| : Triggered when the window is ordered off-screen | ||
|
|
||
| `events.Mac.WindowDidOrderOnScreen` | ||
| : Triggered when the window is ordered on screen | ||
|
|
There was a problem hiding this comment.
Fix formatting inconsistencies.
There are several formatting issues to address:
- Inconsistent hyphenation of "off-screen"
- Extra backtick at the end of some descriptions (e.g., line 314, 365)
- Inconsistent spacing after some event definitions
Apply these corrections:
-: Triggered when the window is ordered off screen
+: Triggered when the window is ordered off-screen
-: Triggered when the window will order on screen`
+: Triggered when the window will order on-screen
-: Triggered when files are dragged into the window`
+: Triggered when files are dragged into the windowAlso applies to: 310-315, 364-366
🧰 Tools
🪛 LanguageTool
[uncategorized] ~229-~229: Loose punctuation mark.
Context: ...d events.Mac.WindowDidOrderOffScreen : Triggered when the window is ordered ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~232-~232: Loose punctuation mark.
Context: ...en events.Mac.WindowDidOrderOnScreen : Triggered when the window is ordered ...
(UNLIKELY_OPENING_PUNCTUATION)
|
Awesome stuff!! |
Adds
API/Eventsto the documentation with examples of how to use Event Hooks as well as Custom EventsSummary by CodeRabbit
New Features
Documentation
Bug Fixes