Skip to content

Commit

Permalink
Add migration guide for 2.0
Browse files Browse the repository at this point in the history
  • Loading branch information
luin committed Jan 22, 2024
1 parent bc32729 commit 8c745ed
Show file tree
Hide file tree
Showing 3 changed files with 21 additions and 143 deletions.
132 changes: 0 additions & 132 deletions packages/website/content/guides/upgrading-to-1-0.mdx

This file was deleted.

24 changes: 19 additions & 5 deletions packages/website/content/guides/upgrading-to-2-0.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,29 @@
title: Upgrading to 2.0
---

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

## Quill

- `strict` *removed* - Previously some changes that were small in practice (renames) but would warrant a semver major bump would be hidden under this configuration. This ended up being more confusing than helpful as we will no longer make use of this.
- `registry` - added to allow multiple editors with different formats to coexist on the same page.
The Quill repository has been rewritten in TypeScript, providing an official TypeScript definition file.

- If you have `@types/quill` installed, uninstall it, as it is no longer needed
- SVG icons are now inlined in the source code, eliminating the need to set up loaders for .svg files in your bundler.

### Options

- `strict` *removed*

Previously some changes that were small in practice (renames) but would warrant a semver major bump would be hidden under this configuration.
This ended up being more confusing than helpful as we will no longer make use of this.

- `registry` - added to allow multiple editors with different formats to coexist on the same page. [Learn more](/docs/registries).
- `formats` *removed* - `registry` is now strictly more powerful and safer.

- `scrollingContainer` *removed*

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.

## Clipboard

- `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.
Expand Down Expand Up @@ -40,5 +55,4 @@ In progress

## Browser

- Quill builds now use `babel-env` to determine the right level of transpiling and polyfilling.
- IE11 support is dropped build size reduced ~25% as a result.
- Internet Explorer support is dropped.
8 changes: 2 additions & 6 deletions packages/website/src/data/guides.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -27,13 +27,9 @@ const items = [
title: 'Comparison with Other Rich Text Editors',
url: '/guides/comparison-with-other-rich-text-editors',
},
// {
// title: 'Upgrading to 2.0',
// url: '/guides/upgrading-to-2-0',
// },
{
title: 'Upgrading to 1.0',
url: '/guides/upgrading-to-1-0',
title: 'Upgrading to 2.0',
url: '/guides/upgrading-to-2-0',
},
];

Expand Down

0 comments on commit 8c745ed

Please sign in to comment.