Replace shouldDiffDescendants with elementsAreRelated

[12joan]

Description

• Remove shouldDiffDescendants option in favour of elementsAreRelated.

• The elementsAreRelated option controls whether computeDiff treats a given pair of elements as "related" and thus tries to diff them. By default, elements are related if they have the same children OR they differ only in their children. Return null to use the default logic for a pair of elements.

  • Use case: In addition to supporting the same use case as the deprecated shouldDiffDescendants, elementsAreRelated can be used to ensure that computeDiff compares the correct pair of paragraphs.

    For example, by default, computeDiff would compare My slightly modified paragraph. with New paragraph in the following diff.

    - My slightly modified paragraph.
    + New paragraph
    + My slightly modified paragraph!

    If a custom elementsAreRelated function is provided that returns true for mostly similar paragraphs, computeDiff would instead compare My slightly modified paragraph. with My slightly modified paragraph!.

[changeset-bot]

🦋 Changeset detected

Latest commit: a278858

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 3 packages

Name	Type
@udecode/plate-diff	Minor
@udecode/plate	Minor
@udecode/plate-suggestion	Minor

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
plate	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Mar 2, 2024 1:46pm