Repository navigation
docs: add more detail to events doc - #10677
Merged
Merged
Conversation
lizschwab
approved these changes
Nov 11, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The basics
The details
Resolves
Fixes #10524
Proposed Changes
Updates the events doc to include information on setting event groups, using
setRecordUndo, and disabling events. Also mentions that events are registrable and can be swapped.Reason for Changes
Events documentation used to be very minimal, only including information on change listeners and none on using events in your application.
Test Coverage
Documentation
Additional Information
Writing this doc did confirm for me that it'd be nice to have an events codelab or tutorial. Tracking that here: #10676