Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

React Events: core API documentation follow-up #15506

Merged
merged 1 commit into from
Apr 26, 2019
Merged

React Events: core API documentation follow-up #15506

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 13 additions & 5 deletions packages/react-events/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ Called after an Event Component in mounted.

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

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

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

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

### isTargetWithinEventResponderScope(target: Element): boolean

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

### releaseOwnership(): boolean

Returns `true` if the instance released ownership of the responder.
Returns `true` if the instance released ownership of the Event Component instance.

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

Remove the root event types added with `addRootEventTypes`.

### requestGlobalOwnership(): boolean

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

### requestResponderOwnership(): boolean

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

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

Expand Down