fix:changed value props to initialValue, to indicate the component is…

… an uncontrolled component
ogheneovo12 · Dec 16, 2023 · dd43130 · dd43130
1 parent 17924d2
commit dd43130
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 5 deletions.
diff --git a/src/lib/components/DocumentEditor/document-editor.stories.tsx b/src/lib/components/DocumentEditor/document-editor.stories.tsx
@@ -10,7 +10,7 @@ const meta: Meta<typeof DocumentEditor> = {
   title: 'DocumentEditor',
   component: DocumentEditor,
   args: {
-    value: initialEditorValue,
+    initialValue: initialEditorValue,
     onChange: (val: Descendant[]) => console.log(val),
     componentBlocks: {},
     documentFeatures: defaultDocumentFeatures,
@@ -25,7 +25,7 @@ const Template: StoryFn<typeof DocumentEditor> = (args: DocumentEditorProps) =>
 export const MainEditor = Template.bind({})
 // More on args: https://storybook.js.org/docs/react/writing-stories/args
 MainEditor.args = {
-  value: initialEditorValue,
+  initialValue: initialEditorValue,
   onChange: (val: Descendant[]) => console.log(val),
   componentBlocks: {},
   documentFeatures: defaultDocumentFeatures,

diff --git a/src/lib/components/DocumentEditor/index.tsx b/src/lib/components/DocumentEditor/index.tsx
@@ -167,15 +167,15 @@ export function createDocumentEditor(
 
 export type DocumentEditorProps = {
   onChange: undefined | ((value: Descendant[]) => void)
-  value: Descendant[]
+  initialValue: Descendant[]
   componentBlocks: Record<string, ComponentBlock>
   documentFeatures: DocumentFeatures
   initialExpanded?: boolean
 } & Omit<EditableProps, 'value' | 'onChange'>
 
 export function DocumentEditor({
   onChange,
-  value,
+  initialValue,
   componentBlocks,
   documentFeatures,
   initialExpanded = false,
@@ -199,7 +199,7 @@ export function DocumentEditor({
         componentBlocks={componentBlocks}
         documentFeatures={documentFeatures}
         editor={editor}
-        value={value}
+        value={initialValue}
         onChange={(value) => {
           onChange?.(value)
           // this fixes a strange issue in Safari where the selection stays inside of the editor