feat: add rtf functionality #560
Conversation
|
Warning: Component files have been updated but no migrations have been added. See https://github.com/yext/visual-editor/blob/main/packages/visual-editor/src/components/migrations/README.md for more information. |
asanehisa
requested review from
colton-demetriou,
benlife5,
mkilpatrick and
briantstephan
and removed request for
colton-demetriou
packages/visual-editor/src/editor/TranslatableRichTextField.tsx
Outdated
Show resolved
Hide resolved
packages/visual-editor/src/editor/TranslatableRichTextField.tsx
Outdated
Show resolved
Hide resolved
…itor into rtf-functionality
|
Does this work with translations? Aka if you change locale then you can have a different rtf? |
Yup it does! |
packages/visual-editor/src/editor/TranslatableRichTextField.tsx
Outdated
Show resolved
Hide resolved
packages/visual-editor/src/editor/TranslatableRichTextField.tsx
Outdated
Show resolved
Hide resolved
packages/visual-editor/src/internal/puck/constant-value-fields/TextList.tsx
Outdated
Show resolved
Hide resolved
| if (payload.locale && payload.rtfJson) { | ||
| handleNewValue(payload.rtfJson, payload.locale, payload.rtfHtml); | ||
| } else { | ||
| // Fallback for backward compatibility |
There was a problem hiding this comment.
Once Storm is deployed it will always send the new payload right? If so then you shouldn't need any fallback.
| try { | ||
| if (!translatableRichText) return ""; | ||
|
|
||
| if ( |
There was a problem hiding this comment.
There's this if condition, the one below, and then the logic in isRichText which also checks if the type is an object like on line 55. Can this be simplified to just check if translatableRichText is a map, grab the locale, and then always call toStringOrElement which happens in both of these conditions?
| return value ?? ""; | ||
|
|
||
| // Ensure we only return strings | ||
| if (typeof value === "string") { |
There was a problem hiding this comment.
Hmm, we can't migrate the strings to rtf because we don't know the formatting and that happens in Storm, right? But now the rtf fields from Storm that we're going to render are always the html version so can't we just always pretend it's a string we need to render? Or is this to support the json version from the document because Spruce hasn't switch it over yet?
Basically I'm trying to see if we can simplify a lot of the crazy logic in here. Is that possible? If not now, will it be possible at some point, and if so, what is needed to do that?
Slightly adjusted code to better match alpha changes (alpha changes not out yet) but having these visual-editor changes with no alpha changes works fine (works as string).
Screen.Recording.2025-06-25.at.3.17.53.PM.mov