Text.decorations assumes that ranges in decorations[] are for current node

Do you want to request a feature or report a bug?

Bug

What’s the current behavior?

Ranges returned from decorate function are always applied to current node even if they do not intersect. In this example there is only one decoration which should only apply to the first text node, since decoration path is [0, 0]

Sandbox: https://codesandbox.io/s/slate-reproductions-ch9e4 Slate: 0.57 Browser: Chrome OS: Windows

What’s the expected behavior?

If the decoration range is outside current node, it should not be applied.

Comments

This issue seems to be related to #3352 . Based on my dive into slate code I see two possible solutions:

1. Adjust how slate-react Children components treats result of decorate(). It looks like decorations prop is filtered using Range.intersection, but decorate() array is not. Merging ds with decorations and then filtering should solve this issue.
2. Make Text.decorations, which cuts up a node into leaves, aware of node’s range. This should make filter on Children component unnecessary.

It seems to me that second option is a more generic solution.

[BetaAI]

@ianstormtaylor Let me know which solution you prefer, or how you would like to handle this, and I’ll do a PR.

[zwily]

When I implemented annotations, I was surprised that the ranges I returned were being applied in weird places, until I started filtering them based on the path of the node supplied to the decorate function:

  ([, path], editor) => {
    let ranges = [];
    for (let [, ann] of Object.entries(editor.annotations)) {
      if (
        !Range.isCollapsed(ann) &&
        Path.compare(ann.anchor.path, path) === 0
      ) {
        ranges.push(ann);
      } else if (Range.isCollapsed(ann) && Path.equals(ann.anchor.path, path)) {
        ranges.push({
          ...ann,
          collapsed: true,
        });
      }
    }

    return ranges;
  }

(The collapsed check is because I do some different rendering on collapsed ranges.)

I may not be understanding this bug completely, but is my approach not also a workaround or am I going to get bitten down the road?