feat(portable-text-editor): determine if selection is made backward

[skogsmaskin]

Description

Add .backward? on EditorSelection to be able to tell if the selection was made backward in the content when returned by PortableTextEditor.getSelection

This is needed in situations where the selection is made backward in the content, but we can only perform a task in the natural order (some for loop on text extractions or similar). By knowing that the selection is made backward, it's then just a matter of switching the anchor and focus points to have it in the natural order.

What to review

That the change looks good.

Testing

Should be covered by a lot of existing tests (see patch that updates them).

Notes for release

• Added a backward property to the EditorSelection of the Portable Text Editor to tell if a selection was made backward in the content.

[vercel]

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

Name	Status	Preview	Comments	Updated (UTC)
performance-studio	✅ Ready (Inspect)	Visit Preview		Feb 21, 2024 10:47am
test-studio	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Feb 21, 2024 10:47am

1 Ignored Deployment

Name	Status	Preview	Comments	Updated (UTC)
studio-workshop	⬜️ Ignored (Inspect)	Visit Preview		Feb 21, 2024 10:47am

[github-actions]

No changes to documentation

[github-actions]

Component Testing Report Updated Feb 21, 2024 10:51 AM (UTC)

File	Status	Duration	Passed	Skipped	Failed
comments/CommentInput.spec.tsx	✅ Passed (Inspect)	36s	15	0	0
formBuilder/ArrayInput.spec.tsx	✅ Passed (Inspect)	6s	3	0	0
formBuilder/inputs/PortableText/Annotations.spec.tsx	✅ Passed (Inspect)	12s	3	0	0
formBuilder/inputs/PortableText/copyPaste/CopyPaste.spec.tsx	✅ Passed (Inspect)	13s	4	2	0
formBuilder/inputs/PortableText/Decorators.spec.tsx	✅ Passed (Inspect)	12s	6	0	0
formBuilder/inputs/PortableText/FocusTracking.spec.tsx	✅ Passed (Inspect)	33s	15	0	0
formBuilder/inputs/PortableText/Input.spec.tsx	❌ Failed (Inspect)	41s	14	0	1
formBuilder/inputs/PortableText/ObjectBlock.spec.tsx	✅ Passed (Inspect)	58s	18	0	0
formBuilder/inputs/PortableText/Styles.spec.tsx	✅ Passed (Inspect)	13s	6	0	0
formBuilder/inputs/PortableText/Toolbar.spec.tsx	✅ Passed (Inspect)	19s	9	0	0

[pedrobonamin]

Is there any test case that we could add in which it covers the backward selection?
Or maybe update some of the current selections and add backward: true to be sure everything works in the same way even with the backward selection.

[skogsmaskin]

Or maybe update some of the current selections and add backward: true to be sure everything works in the same way even with the backward selection.

This is a good idea. I will add it. I think the rest of the tests will make sure that the existing functionality still works as expected.

[hermanwikner]

I wonder if it would be a bit more clear with direction: "forward" | "backward" – what do you think?

[skogsmaskin]

It would be clearer, but then it would also have to be required imo.

The absence of "backward" means it's forward by default.

[skogsmaskin]

Added a new test that will test that getSelection returns the selection with the backward property set to true when the selection is set backward.