@layers-app/editor 0.0.17-editor-01 → 0.0.17-editor-03

package/README.md

@@ -149,12 +149,12 @@ Use **StylesProvider** to add styling to your HTML content.
 
 ## Image upload
 
-To start working with image uploads, use the **fetchUploadImage** function, which takes three parameters: **file**, **success**, and **error**. After successfully uploading the image to your service, you should call the **success** function and pass two required arguments: the **URL** of the image and its **ID**.
+To start working with image uploads, use the **fetchUploadMedia** function, which takes three parameters: **file**, **success**, and **error**. After successfully uploading the image to your service, you should call the **success** function and pass two required arguments: the **URL** of the image and its **ID**.
 
 ```
-  const fetchUploadImage = async (
+  const fetchUploadMedia = async (
     file: File,
-    success: (url: string, id: string) => void,
+    success: (url: string, id: string, data?: object) => void,
     error?: (error?: Error) => void
   ) => {
     const formData = new FormData();
@@ -189,16 +189,16 @@ To start working with image uploads, use the **fetchUploadImage** function, whic
 
 <Editor
   ...props
-  fetchUploadImage={fetchUploadImage}
+  fetchUploadMedia={fetchUploadMedia}
 />
 ```
 
 ## Image Deletion
 
-To have greater control over image deletion, pass an optional function **fetchDeleteImage** to the editor, which accepts three parameters: **id**, **success**, and **error**. After successfully deleting the image from your service, the **success** function should be called.
+To have greater control over image deletion, pass an optional function **fetchDeleteMedia** to the editor, which accepts three parameters: **id**, **success**, and **error**. After successfully deleting the image from your service, the **success** function should be called.
 
 ```
-  const fetchDeleteImage = async (
+  const fetchDeleteMedia = async (
     id: string,
     success: () => void,
     error?: (error?: Error) => void
@@ -230,8 +230,8 @@ To have greater control over image deletion, pass an optional function **fetchDe
 
 <Editor
   ...props
-   fetchUploadImage={fetchUploadImage}
-   fetchDeleteImage={fetchUploadImage}
+   fetchUploadMedia={fetchUploadMedia}
+   fetchDeleteMedia={fetchUploadMedia}
 />
 ```
 
@@ -281,7 +281,7 @@ Dropzone.Idle is visible when the user is not dragging any file into the drop zo
 
 <Editor
   ...props
-   fetchUploadImage={fetchUploadImage}
+   fetchUploadMedia={fetchUploadMedia}
    contentModalUploadImage={Content}
    maxImageSize={5}
    maxImageSizeError={() => {}}
@@ -356,8 +356,8 @@ outputFormat?: 'html' | 'json' - The outputFormat property defines whether we wa
 initialContent: string | object - The initial content for the editor.
 maxHeight?: number - Sets the height of the editor. The default is 100%.
 mode?: 'simple' | 'default' | 'full' | 'editor' - The editor mode. Depending on the chosen mode, functionality may be restricted or extended. The default is default.
-fetchUploadImage?: (file: File, success: (url: string, id: string, error?: (error?: Error) => void) => void) - Function to upload an image to your service.
-fetchDeleteImage?: (id: string, success: () => void, error?: (error?: Error) => void) - Helper function to delete an image.
+fetchUploadMedia?: (file: File, success: (url: string, id: string, error?: (error?: Error) => void) => void) - Function to upload an image to your service.
+fetchDeleteMedia?: (id: string, success: () => void, error?: (error?: Error) => void) - Helper function to delete an image.
 maxImageSize?: number - The maximum image size in megabytes.
 contentModalUploadImage?: React.FunctionComponent - A React component to replace content in DropZone.
 maxImageSizeError?: () => void - A function that is called if the image exceeds the maxImageSize.