feat(extensions)!: Overwrite built-in List/Ordered toggle functions with a smartToggle option
#620
Conversation
This file contains 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
…ith a `smartToggle` option BREAKING CHANGE: The `smartToggleBulletList` and `smartToggleOrderedList` commands were renamed to have the same name as the built-in toggle functions so that they can easily be used by the default keyboard shortcuts without having to change the `addKeyboardShortcuts` function. The `BulletList` and `OrderedList` extensions now take an additional option, `smartToggle` (default: `false`), that indicates whether hard breaks should be replaced by paragraphs before toggling the selection into a bullet/ordered list, or not.
✅ Deploy Preview for doist-typist ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
gnapse
approved these changes
Jan 18, 2024
doistbot
added a commit
that referenced
this pull request
Jan 18, 2024
## [3.0.0](v2.3.1...v3.0.0) (2024-01-18) ### ⚠ BREAKING CHANGES * **extensions:** The `smartToggleBulletList` and `smartToggleOrderedList` commands were renamed to have the same name as the built-in toggle functions so that they can easily be used by the default keyboard shortcuts without having to change the `addKeyboardShortcuts` function. The `BulletList` and `OrderedList` extensions now take an additional option, `smartToggle` (default: `false`), that indicates whether hard breaks should be replaced by paragraphs before toggling the selection into a bullet/ordered list, or not. ### Features * **extensions:** Overwrite built-in List/Ordered toggle functions with a `smartToggle` option ([#620](#620)) ([059da61](059da61))
|
🎉 This PR is included in version 3.0.0 🎉 The release is available on: Your semantic-release bot 📦🚀 |
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.
Overview
While updating our apps with
v2.3.1, I realized that keyboard shortcuts were not using the newsmartToggle*Listcommands, which prompted this PR.This basically rewrites the extensions to overwrite the built-in
toggle*Listfunctions, where we replace hard breaks with paragraphs based on thesmartToggleoption that can now be passed into thebulletListandorderedListextensions. By default, this value isfalseand hard breaks are NOT replaced (just like the default and built-in behaviour), otherwise, iftrue, hard breaks are replaced with paragraphs, thus "smartly toggling" paragraphs/lines into bullet/ordered lists.PR Checklist
Test plan
Rich-text → DefaultstoryBullet ListorOrdered Listbuttons in the editor toolbarMod-Shift+7to toggle the selection into an ordered listMod-Shift+8to toggle the selection into a bullet listNote
Modis usuallyCtrlon Windows, andCmdon macOS.