@wannaby/wanna-ui - npm Package Compare versions

Comparing version 2.5.0-alpha.0 to 2.5.0-alpha.1

package.json

 {
   "name": "@wannaby/wanna-ui",
   "description": "Wanna WEB-AR Preview component",
-  "version": "2.5.0-alpha.0",
+  "version": "2.5.0-alpha.1",
   "main": "./index.js",
@@ -12,7 +12,7 @@ "dependencies": {
     "qrcode.react": "1.0.1",
-    "ramda": "0.27.1",
+    "ramda": "0.28.0",
     "react-device-detect": "1.17.0",
     "react-lottie": "1.2.3",
     "swiper": "6.8.1",
-    "ua-parser-js": "0.7.28"
+    "ua-parser-js": "1.0.33"
   },
@@ -19,0 +19,0 @@ "peerDependencies": {

README.md

@@ -192,18 +192,16 @@ # WANNA 3D Viewer for Handbags: Getting Started
 
-WANNA UI component can inform you of the user's actions in the 3D Viewer window and allow you to navigate the 3D Viewer. These events will be handled by WANNA UI, but you may want to add something on your side: for example, display an additional message when the user clicks on the dimension button to display the size rulers.
+WANNA UI component can inform you of the user's actions and SDK events happening in the 3D Viewer window. These events will be handled by WANNA UI (except `onHeaderBackClick`). However, you can use the callback functions described below to implement your own logic in addition to what WANNA SDK already does.
 
-**Note:** The "back" button will only be displayed in the 3D Viewer UI if you set the `onHeaderBackClick` callback in the component props.
-
 Implement the callback functions WANNA UI will call in different situations, and pass them to the corresponding props.
 
 - Handle the user's actions while viewing the model:
-	- `onHeaderBackClick` — the user clicks the "back" button
-	- `onModel3dPoiChanged` — the user switches to a different point of interest view
-	- `onModel3dShowReferences` — the user requests the dimension rulers to be displayed
+	- `onHeaderBackClick` — the user clicks the "back" button.<br />**Note:** The "back" button will only be displayed in the 3D Viewer UI if you do implement this callback.
+	- `onModel3dPoiChanged` — the user switches to a different point of interest view.
+	- `onModel3dShowReferences` — the user requests the dimension rulers to be displayed.
 - Handle events during model loading:
-	- `onModelLoadingSuccess` — the model is loaded successfully
-	- `onModelLoading` — the model loading is in progress
+	- `onModelLoadingSuccess` — the model is loaded successfully.<br />**Note:** This event is raised when the model data is successfully downloaded, but it doesn't guarantee that the model has been already rendered on the view.
+	- `onModelLoading` — the model loading is in progress.
 - Handle errors:
-	- `onError` — general errors
-	- `onModelLoadingFail` — model loading failure
+	- `onError` — general errors.
+	- `onModelLoadingFail` — model loading failure.
 
@@ -236,3 +234,3 @@ ## Component reference
 | onModelLoadingFail      | `(modelId) => void`                                                    | Called when the model loading fails.                                                                     |
-| onModelLoadingSuccess   | `(modelId) => void`                                                    | Called when the model loading succeeds.                                                                  |
+| onModelLoadingSuccess   | `(modelId) => void`                                                    | Called when the model is successfully downloaded, though not necessarily already rendered in the view.   |
 | onModelLoading          | `(modelId) => void`                                                    | Called when model loading starts.                                                                        |
@@ -239,0 +237,0 @@ | onHeaderBackClick       | `() => void`                                                           | Called when the user clicks the "back" button in the header. If you don't set this callback, no "back" button will be displayed in 3D Viewer UI. |

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Unidentified License

License

(Experimental) Something that seems like a license was found, but its contents could not be matched with a known license.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

1608879

increased by3.41%

Number of package files

7

increased by16.67%

Worsened metrics

Number of low license alerts

2

increased by100%

Lines of code

156

decreased by-3.11%

Number of lines in readme file

397

decreased by-0.5%

Dependency changes

• + Addedramda@0.28.0(transitive)

• + Addedua-parser-js@0.7.391.0.33(transitive)

• - Removedramda@0.27.1(transitive)

• - Removedua-parser-js@0.7.28(transitive)

• Updatedramda@0.28.0

• Updatedua-parser-js@1.0.33