hart-estate-widget 2.5.22 → 2.5.23

package/README.md

@@ -44,7 +44,7 @@ const createWidget = async (logoUrl) => {
   const planId = searchParams.get("id");
 
   const planData = await widgetApiHandler.loadWidgetData(planId);
-  const options = { // the parameters you need that are described below in "Parameters"
+  const options = { // the parameters you need
     ...planData.parsed,
     API_URL: WIDGET_API_URL,
     rotationMode: rotationModes.DEFAULT,
@@ -106,18 +106,16 @@ body
 
 
 ## Parameters:
-Here you can see list of accessable options and example of using. There are accessable values of each option below in the block "Types of elements"
 ```js
 {
   // elements  
   tabs: ['rotation', 'panorama'], // included elements
 
   // logo
-  logo: '', // path/link to logo
+  logo: '', // path to logo
   logoUrl: '', // link opened when logo is clicked
 
   // localization
-  // accessable languages are in "Types of elements"
   locale: 'en', // ISO 639 language code
 
   // width/height
@@ -126,11 +124,9 @@ Here you can see list of accessable options and example of using. There are acce
   resizable: true, // automatically resize the widget to the size of the container when the window is resized
 
   // values
-  rotationMode: '', // mode of operation for plan images
+  rotationMode: 'default', // mode of operation for plan images
   panoramaFov: 75, // camera field of view angle for panoramic tour
   enableCameraTransitionBetweenPanoramas: true, // enable / disable camera rotation transition between panoramas (if CameraPoint.Rotation.Yaw is defined in json)
-  instructionVisible: true, // enable / disable modal of instruction in 3D tour
-  autoRotate: false, // enable / disable auto rotation in 3D tour
   primaryCameraPointId: null, // primary camera point id for panorama tour
   floors: [ // array of floors, contains 360° images and panoramic tour data
     {
@@ -148,28 +144,6 @@ Here you can see list of accessable options and example of using. There are acce
     mainText: '#HEX', // text color for buttons, elements contrasting with the main color
   },
 
-  // copyRight: all text in widget
-  dictionaryOverrides: {
-    "create-points": "Create a point", // text for create point
-    "delete-points": "Remove point", // text for delete point
-    "research-plan": "Research plan", // text for research plan
-    "rotate-plan": "Rotate plan", // text for rotate plan
-    "ok": "Ok", // button text
-    "made-by-link": "https://getfloorplan.com/", // watermark link
-    "made-by-text": "getfloorplan.com", // watermark text
-    "instructions-hint-text": "", // additional text on the bottom of instruction modal
-    "floor": "$0 floor" // floor text
-  },
-
-  API_URL: '', // api url
-
-  // branding
-  branding: {
-    company_url: '', // link opened when logo is clicked (more priority than logoUrl)
-    company_name: '', // watermark text (more priority than dictionaryOverrides['made-by-text'])
-    widget_language: 'en', // ISO 639 language code
-    logo_path: '', // path to logo
-    
   // panorama icons
   panoramaIcons: {
     spot: 'URL', // icon for camera points in one room
@@ -200,8 +174,5 @@ floors[0].panorama.type: [
 locale: [
   'ru', // Russian language
   'en', // English language
-  'es', // Spanish language
-  'de', // German language
-  'ja', // Japanese language
 ],
 ```