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

Allow control of Slate's event handler execution in custom event handler API #4299

Merged
merged 10 commits into from
Jun 1, 2021
Merged

Allow control of Slate's event handler execution in custom event handler API #4299

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
afb7ddc
Add shouldTreatEventAsHandled option to custom event handlers
jell-byte May 27, 2021
7dbbe7c
Add changeset entry
jell-byte May 27, 2021
d7204c5
Simplify shouldTreatEventAsHandled check
georgberecz May 30, 2021
bf3c5f2
Change from patch to minor
jell-byte May 30, 2021
2c2b4c2
Add documentation for event handling behavior
jell-byte May 30, 2021
1c2a568
Apply suggestions for documentation adjustment
georgberecz Jun 1, 2021
a825832
Remove useCallback from example
jell-byte Jun 1, 2021
c9df05f
Add overwrite logic to isDOMEventHandled
jell-byte Jun 1, 2021
6cf1505
Update slate-react.md
clauderic Jun 1, 2021
5ac9d88
Update and rename chilly-gifts-dance.md to override-event-handlers.md
clauderic Jun 1, 2021
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
5 changes: 5 additions & 0 deletions .changeset/chilly-gifts-dance.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'slate-react': patch
Copy link
Collaborator

Choose a reason for hiding this comment

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

I think this should be a minor bump as it introduces new functionality rather than just a fix

---

Allow custom event handlers on Editable component to return boolean flag to specify whether the event can be treated as being handled
13 changes: 10 additions & 3 deletions packages/slate-react/src/components/editable.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1191,14 +1191,21 @@ export const isEventHandled = <
EventType extends React.SyntheticEvent<unknown, unknown>
>(
event: EventType,
handler?: (event: EventType) => void
handler?: (event: EventType) => void | boolean
) => {
if (!handler) {
return false
}
// The custom event handler may return a boolean to specify whether the event
// shall be treated as being handled or not.
const shouldTreatEventAsHandled = handler(event)

handler(event)
return event.isDefaultPrevented() || event.isPropagationStopped()
return (
(shouldTreatEventAsHandled === true ||
event.isDefaultPrevented() ||
event.isPropagationStopped()) &&
shouldTreatEventAsHandled !== false
)
}

Copy link
Collaborator

Choose a reason for hiding this comment

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

Should the isDOMEventHandled method be updated as well?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Ha, very good point! I initially thought it shouldn't, but after having another look at the code I feel like it actually should behave the same way to stay consistent and not confuse people. I will adjust it.

/**
Expand Down