KDS-1416 Migrate RTE & Co #4255
Conversation
🦋 Changeset detectedLatest commit: b275bcf The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
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 |
| <Canvas of={RichTextEditorStories.DefaultValue} /> | ||
|
|
||
| #### Malformed Content | ||
| If your default value does not conform correctly, the RTE will throw an error. |
There was a problem hiding this comment.
We could also callout the onDataError callback that's available to consumers if they want to catch and handle malformed data
|
|
||
| type Story = StoryObj<typeof meta> | ||
|
|
||
| export const Playground: Story = { |
There was a problem hiding this comment.
Potential improvement later is to add a drop down for controls to let our consumer add items to the toolbar in the playground story
| parameters: { | ||
| docs: { | ||
| canvas: { | ||
| sourceState: "shown", |
There was a problem hiding this comment.
One call out that Dale mentioned a while back was that when he first used the RTE, it was that it wasn't clear to him that handleOnChange would need to setter with editorState.toJSON().doc.content.
Something we could either document later or expose in the source code of the canvas
There was a problem hiding this comment.
I can do a hardcode here again 👍
|
|
||
| ## API | ||
|
|
||
| <DocsStory of={RichTextEditorStories.Controls} /> |
There was a problem hiding this comment.
Would be good to circle back later and add more to this in terms of current controls available and how to handle grouping
|
Might pause this and wait for the RTT to be migrated first, then we won't be shipping a massive RTE and the peer dep wouldn't be necessary |
Why
Migrate RichTextEditor, RichTextContent, EditableRichTextContent from
kaizen-legacyNotes
@cultureamp/rich-text-toolkitadded as an optional Peer Dep, meaning consumers can choose not to install the package if they do not use RTE. This does break the circular dependency as we are no longer trying to bundle RTT, however Ideally we would want to move towards removing this peer dep altogether.