Home Explore Help
Sign In
SMusatov
/
quill
mirror of https://github.com/quilljs/quill.git
1
0
Fork 0
Files
Branch: develop
Branches Tags
quill
/
packages
/
website
/
content
/
guides
/
upgrading-to-2-0.mdx

upgrading-to-2-0.mdx 2.8 KB
Permalink History Raw

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758 
  1. ---
    2. 

  2. title: Upgrading to 2.0
    3. 

  3. ---
    4. 

  4. 

  5. Quill has been significantly modernized. Leveraging the latest browser-supported APIs, Quill now delivers a more efficient and reliable editing experience.
    6. 

  6. 

  7. ## Quill
    8. 

  8. 

  9. The Quill repository has been rewritten in TypeScript, providing an official TypeScript definition file.
    10. 

  10. 

  11. - If you have `@types/quill` installed, uninstall it, as it is no longer needed
    12. 

  12. - SVG icons are now inlined in the source code, eliminating the need to set up loaders for .svg files in your bundler.
    13. 

  13. 

  14. ### Options
    15. 

  15. 

  16. - `strict` *removed*
    17. 

  17. 

  18.     Previously some changes that were small in practice (renames) but would warrant a semver major bump would be hidden under this configuration.
    19. 

  19.     This ended up being more confusing than helpful as we will no longer make use of this.
    20. 

  20. 

  21. - `registry` - added to allow multiple editors with different formats to coexist on the same page. [Learn more](/docs/registries).
    22. 

  22. - `formats` *removed* - `registry` is now strictly more powerful and safer.
    23. 

  23. 

  24. - `scrollingContainer` *removed*
    25. 

  25. 

  26.     Quill will now automatically detect the scrollable ancestor, eliminating the need to provide this option. This new behavior is more robust and works seamlessly with nested scrollable elements.
    27. 

  27. 

  28. ## Clipboard
    29. 

  29. 

  30. - `convert` - API changed to include both HTML and text and previous functionality is broken into multiple method calls (`convert`, `onCapturePaste`) to allow more surface to hook into.
    31. 

  31. - `onCapturePaste` - Added
    32. 

  32. 

  33. ### Configuration
    34. 

  34. 

  35. - `matchVisual` *removed* - Previously there was a choice between using visual or semantic interpretation of pasted whitespace; now just the semantic interpretation is used. Visual matching was expensive, requiring the DOM renderer which is no longer available in the new clipboard rewrite.
    36. 

  36. - `pasteHTML` *removed* - Deprecated alias to `dangerouslyPasteHTML`.
    37. 

  37. 

  38. ## Keyboard
    39. 

  39. 

  40. - Binding `key` is no longer case insensitive. To support bindings like `key: '@'`, modifiers are taken into account so the shift modifier will affect case sensitivity.
    41. 

  41. - Binding `key` now supports an array of keys to easily bind to multiple shortcuts.
    42. 

  42. - Native keyboard event object is now also passed into handlers.
    43. 

  43. 

  44. ## Parchment
    45. 

  45. 

  46. - All lists use `<ol>` instead of both `<ul>` and `<ol>` allowing better nesting between the two. Copied content will generate the correct semantic markup for paste into other applications.
    47. 

  47. - Code block markup now uses `<div>` to better support syntax highlighting.
    48. 

  48. - Static `register` method added to allow dependent chains of registration.
    49. 

  49. - Static `formats` method now passes in `scroll`.
    50. 

  50. - Blot constructor now requires `scroll` to be passed in.
    51. 

  51. 

  52. ## Delta
    53. 

  53. 

  54. - Support for the deprecated delta format, where embeds had integer values and list attributes had different keys, is now removed
    55. 

  55. 

  56. ## Browser
    57. 

  57. 

  58. - Internet Explorer support is dropped.
    59.