Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(portable-text-editor): range decorations #5871

Merged
merged 4 commits into from
Mar 1, 2024

Conversation

skogsmaskin
Copy link
Member

@skogsmaskin skogsmaskin commented Feb 28, 2024

Description

This will add support for decorating selections inside the Portable Text Editor with custom components. This can be used for search highlighting, validation, and similar.

What to review

That the feature works as intended.

Testing

You can test the feature by running the Playwright tests with pnpm --filter sanity test:ct --project chromium --debug and commenting out this this test.. This will give you a PT-input to play around with. Se also the Story.

There are a couple of tests both for the PT-Input and Portable Text Editor.

Notes for release

N/A - internal feature for now.

Copy link

vercel bot commented Feb 28, 2024

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

Name Status Preview Comments Updated (UTC)
performance-studio ✅ Ready (Inspect) Visit Preview Mar 1, 2024 3:52pm
test-studio ✅ Ready (Inspect) Visit Preview 💬 Add feedback Mar 1, 2024 3:52pm
1 Ignored Deployment
Name Status Preview Comments Updated (UTC)
studio-workshop ⬜️ Ignored (Inspect) Visit Preview Mar 1, 2024 3:52pm

Copy link
Contributor

Package Documentation Change
@sanity/portable-text-editor +10%
Full Report
@sanity/portable-text-editor
This branch Next branch
23 documented 21 documented
44 not documented 44 not documented
@sanity/migrate
This branch Next branch
17 documented 17 documented
71 not documented 59 not documented
sanity
This branch Next branch
179 documented 179 documented
847 not documented 860 not documented
@sanity/diff
This branch Next branch
13 documented 13 documented
16 not documented 16 not documented
@sanity/block-tools
This branch Next branch
4 documented 4 documented
9 not documented 9 not documented
@sanity/types
This branch Next branch
55 documented 55 documented
233 not documented 239 not documented
sanity/desk
This branch Next branch
84 documented 84 documented
64 not documented 64 not documented
@sanity/mutator
This branch Next branch
7 documented 7 documented
3 not documented 4 not documented
@sanity/cli
This branch Next branch
1 documented 1 documented
31 not documented 31 not documented
sanity/structure
This branch Next branch
2 documented 2 documented
8 not documented 8 not documented
@sanity/util/concurrency-limiter
This branch Next branch
1 documented 1 documented
0 not documented 0 not documented
@sanity/util/legacyDateFormat
This branch Next branch
0 documented 0 documented
4 not documented 5 not documented
@sanity/schema/_internal
This branch Next branch
0 documented 0 documented
12 not documented 12 not documented
@sanity/util/paths
This branch Next branch
1 documented 1 documented
15 not documented 15 not documented
sanity/router
This branch Next branch
17 documented 17 documented
26 not documented 26 not documented
@sanity/schema
This branch Next branch
0 documented 0 documented
2 not documented 2 not documented
sanity/cli
This branch Next branch
2 documented 2 documented
0 not documented 0 not documented
@sanity/vision
This branch Next branch
0 documented 0 documented
3 not documented 3 not documented
@sanity/util/fs
This branch Next branch
0 documented 0 documented
3 not documented 3 not documented
sanity/_internal
This branch Next branch
0 documented 0 documented
1 not documented 1 not documented
@sanity/util/client
This branch Next branch
1 documented 1 documented
0 not documented 0 not documented
@sanity/util/createSafeJsonParser
This branch Next branch
1 documented 1 documented
0 not documented 0 not documented
sanity/_internalBrowser
This branch Next branch
0 documented 0 documented
3 not documented 3 not documented
@sanity/util/content
This branch Next branch
1 documented 1 documented
5 not documented 5 not documented

Copy link
Contributor

github-actions bot commented Feb 28, 2024

Component Testing Report Updated Mar 1, 2024 3:49 PM (UTC)

File Status Duration Passed Skipped Failed
comments/CommentInput.spec.tsx ✅ Passed (Inspect) 32s 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) 12s 4 2 0
formBuilder/inputs/PortableText/Decorators.spec.tsx ✅ Passed (Inspect) 12s 6 0 0
formBuilder/inputs/PortableText/FocusTracking.spec.tsx ✅ Passed (Inspect) 32s 15 0 0
formBuilder/inputs/PortableText/Input.spec.tsx ✅ Passed (Inspect) 1m 0s 15 0 0
formBuilder/inputs/PortableText/ObjectBlock.spec.tsx ✅ Passed (Inspect) 1m 1s 18 0 0
formBuilder/inputs/PortableText/RangeDecoration.spec.tsx ✅ Passed (Inspect) 12s 6 0 0
formBuilder/inputs/PortableText/Styles.spec.tsx ✅ Passed (Inspect) 14s 6 0 0
formBuilder/inputs/PortableText/Toolbar.spec.tsx ✅ Passed (Inspect) 20s 9 0 0

@skogsmaskin skogsmaskin force-pushed the feat/pte-range-decorations branch 2 times, most recently from e21906f to a496ad8 Compare February 28, 2024 21:43
This will add support for decorating selections inside the Portable Text Editor with custom components.

This can be used for search highlighting, validation, and similar.

We will temporarily move the decorations according to use edits, but
it's the consumers responsiblitly to permanently moved them.
This can be done by using the 'onMoved' callback on the decorator,
which will contain the new selection.

Why don't they move on their own? This is because they come from
props and are state managed by the consumer.
@skogsmaskin skogsmaskin marked this pull request as ready for review March 1, 2024 15:44
@skogsmaskin skogsmaskin requested a review from a team March 1, 2024 15:44
@skogsmaskin skogsmaskin requested a review from a team as a code owner March 1, 2024 15:44
@skogsmaskin skogsmaskin requested review from jtpetty and removed request for a team March 1, 2024 15:44
@hermanwikner hermanwikner self-requested a review March 1, 2024 15:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants