image-salon-sdk 1.0.7 → 1.0.9

package/README.md

@@ -0,0 +1,92 @@
+# image-salon-sdk
+
+library to upload images
+
+# Installation
+
+```bash
+npm install image-salon-sdk
+```
+
+```javascript
+import ImageSalon, { ImageUploadResponse } from "image-salon-sdk";
+```
+
+# React implementation
+
+```typescript jsx
+const imageSalon = new ImageSalon({
+  folderName: "livestream-cms",
+  handleUpload: () => {
+    handleImageUpload();
+  },
+});
+
+useEffect(() => {
+  imageSalon._init();
+  imageSalon.create({
+    imageUploadMainContainerId: "example",
+  });
+}, []);
+
+const handleImageUpload = () => {
+  imageSalon._upload().then((res: ImageUploadResponse[]) => {
+    // rest of the code
+  });
+};
+
+return <div id="example" />;
+```
+
+# Svelte implementation
+
+```typescript svelte
+---
+**NOTE**
+server-side rendering needs to be disabled
+---
+
+import {onMount} from "svelte"
+
+onMount(() => {
+		if (typeof window === undefined || typeof document === undefined) return;
+		imageSalon._init();
+		imageSalon.create({
+			imageUploadMainContainerId: 'image-upload-main'
+		});
+	});
+```
+
+parameters for ImageUpload class
+
+```typescript
+folderName: string; // folder name to upload file
+handleUpload: () => void; //callback to handle upload event on click.
+```
+
+parameters for create method
+
+```typescript
+imageUploadMainContainerId: string; //id of the container where you want to load message snippet.
+```
+
+upload response
+
+```typescript
+key: string;
+name: string;
+folderName: string;
+nestedFolderName: string;
+url: string;
+thumborUrl: string;
+proxyUrl: string;
+type: number;
+metadata: {
+  height: number;
+  width: number;
+  backgroundColor: string;
+  aspectRatio: number;
+}
+```
+
+# React implementation

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "image-salon-sdk",
-  "version": "1.0.7",
+  "version": "1.0.9",
   "license": "ISC",
   "type": "module",
   "files": [