Skip to content

Commit c4d1dcb

Browse files
authored
React Events: core API documentation followup (#15506)
1 parent 41ef196 commit c4d1dcb

File tree

1 file changed

+13
-5
lines changed

1 file changed

+13
-5
lines changed

packages/react-events/README.md

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ Called after an Event Component in mounted.
7171

7272
### onOwnershipChange?: (context: ResponderContext, props, state)
7373

74-
Called when responder ownership is granted or terminated for an Event Component instance.
74+
Called when ownership is granted or terminated (either globally or for the responder) for an Event Component instance.
7575

7676
### onRootEvent?: (event: ResponderEvent, context: ResponderContext, props, state)
7777

@@ -148,23 +148,31 @@ Returns `true` is the target element is within the subtree of the Event Componen
148148

149149
### isTargetWithinEventResponderScope(target: Element): boolean
150150

151-
Returns `true` is the target element is within the current responder.
151+
Returns `true` is the target element is within the current Event Component instance's responder. If the target element
152+
is within the scope of the same responder, but owned by another Event Component instance, this will return `false`.
152153

153154
### releaseOwnership(): boolean
154155

155-
Returns `true` if the instance released ownership of the responder.
156+
Returns `true` if the instance released ownership of the Event Component instance.
156157

157158
### removeRootEventTypes(eventTypes: Array<ResponderEventType>)
158159

159160
Remove the root event types added with `addRootEventTypes`.
160161

161162
### requestGlobalOwnership(): boolean
162163

163-
Request ownership of the global responder.
164+
The current Event Component instance can request global ownership of the event system. When an Event Component instance
165+
has global ownership, only that instance and its responder are active. To release ownership to other event responders,
166+
either `releaseOwnership()` must be called or the Event Component instance that had global ownership must be
167+
unmounted. Calling `requestGlobalOwnership` also returns `true`/`false` if the request was successful.
164168

165169
### requestResponderOwnership(): boolean
166170

167-
Request ownership of the responder.
171+
The current Event Component instance can request responder ownership within the event system. When an Event Component
172+
instance has responder ownership, all other Event Component instances that have the same responder as the Event Component
173+
instance will no longer be active. To release ownership to other event responders, either `releaseOwnership()` must be
174+
called or the Event Component instance that had global ownership must be unmounted. Calling `requestResponderOwnership`
175+
also returns `true`/`false` if the request was successful.
168176

169177
### setTimeout(func: () => void, delay: number): Symbol
170178

0 commit comments

Comments
 (0)