freemium-survey-components 1.0.91 → 1.0.92

package/.github/workflows/playwright.yml

@@ -1,27 +1,27 @@
 name: Playwright Tests
 on:
   push:
-    branches: [ main, master ]
+    branches: [main, master]
   pull_request:
-    branches: [ main, master ]
+    branches: [main, master]
 jobs:
   test:
     timeout-minutes: 60
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v2
-    - uses: actions/setup-node@v2
-      with:
-        node-version: '14.x'
-    - name: Install dependencies
-      run: yarn
-    - name: Install Playwright Browsers
-      run: npx playwright install --with-deps
-    - name: Run Playwright tests
-      run: yarn playwright test
-    - uses: actions/upload-artifact@v2
-      if: always()
-      with:
-        name: playwright-report
-        path: playwright-report/
-        retention-days: 30
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v2
+        with:
+          node-version: '14.x'
+      - name: Install dependencies
+        run: yarn
+      - name: Install Playwright Browsers
+        run: npx playwright install --with-deps
+      - name: Run Playwright tests
+        run: yarn playwright test
+      - uses: actions/upload-artifact@v2
+        if: always()
+        with:
+          name: playwright-report
+          path: playwright-report/
+          retention-days: 30

package/.husky/pre-commit

@@ -0,0 +1,4 @@
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+
+npm run check

package/README.md

@@ -23,6 +23,7 @@ Make sure you have the below installed in your app.
 - ChannelPreview : ChannelPreviewProps
 
 ### Types
+
 ```
 type SurveyProps = {
   survey: SurveyType
@@ -50,9 +51,11 @@ type SurveyProps = {
   onAnsweringPrompt: (id: number) => void
 }
 ```
+
 ```
 type ChannelPreviewProps = SurveyProps & { channel: 'whatsapp' | 'instagram' }
 ```
+
 ```
 type WidgetProps = {
   survey: SurveyType
@@ -75,6 +78,7 @@ type WidgetProps = {
   onAnsweringPrompt: (id: number) => void
 }
 ```
+
 ```
 type RangeProps = {
   type_info: {
@@ -100,31 +104,37 @@ type RangeProps = {
 
 ### Usage
 
-
 ```js
-import {Survey} from 'freemium-survey-components'
-  <Survey
-    survey={surveyObjectFromSurveyServ}
-    surveyStyle="card"
-    onSubmit = {async function(data : {[key : string] : string | number | boolean | null | string[]},callback,status : 'PARTIAL' | 'COMPLETE') {
-      await saveToDb(surveyFormData)
-      if(status === 'COMPETE')
+import { Survey } from 'freemium-survey-components';
+<Survey
+  survey={surveyObjectFromSurveyServ}
+  surveyStyle="card"
+  onSubmit={async function (
+    data: { [key: string]: string | number | boolean | null | string[] },
+    callback,
+    status: 'PARTIAL' | 'COMPLETE',
+  ) {
+    await saveToDb(surveyFormData);
+    if (status === 'COMPETE')
       // callback should be executed in the caller once the save is done.
-      callback?.() 
-    }} 
-    // this will get called for every answer selection with status = 'PARTIAL'
-    placeholders = {{
-      '{{account.company_name}}': 'Freshworks',
-      '{{account.account_name}}': 'Freshworks Account',
-    }} 
-    // placeholders to resolve against any such placeholder in question's text
-    preview = {true} 
-    // preview true will not save the response
-    initialPivotAnswer={null} 
-    // pass a number if pivot qn needed to be prefilled  by default
-    onAnsweringPrompt={function(id){ console.log(`Prompt ${id ? 'accepted' : 'rejected'}}`)}}
-  />
+      callback?.();
+  }}
+  // this will get called for every answer selection with status = 'PARTIAL'
+  placeholders={{
+    '{{account.company_name}}': 'Freshworks',
+    '{{account.account_name}}': 'Freshworks Account',
+  }}
+  // placeholders to resolve against any such placeholder in question's text
+  preview={true}
+  // preview true will not save the response
+  initialPivotAnswer={null}
+  // pass a number if pivot qn needed to be prefilled  by default
+  onAnsweringPrompt={function (id) {
+    console.log(`Prompt ${id ? 'accepted' : 'rejected'}}`);
+  }}
+/>;
 ```
+
 ```js
 import {WebInAppSurvey} from 'freemium-survey-components'
   const [isSurveyCompleted,setIsSurveyCompleted] = useState(false)
@@ -142,68 +152,68 @@ import {WebInAppSurvey} from 'freemium-survey-components'
     }}
     unsubscribeUrl={'#'}
     isSurveyCompleted={isSurveyCompleted}
-    children={null} 
-    // if we want render with respect to the widget's fixed 
+    children={null}
+    // if we want render with respect to the widget's fixed
     onAnsweringPrompt={function (id){ console.log(`Prompt ${id ? 'accepted' : 'rejected'}`)}}
         />
 ```
+
 ```js
-import {Range} from 'freemium-survey-components'
-  <Range
-    type_info={{
-      type_variant: 'TEXT',
-      scale_properties: {
-        order: 'ascending',
-        range: [
-          {
-            id: '1',
-            label: 'detractor',
-            min: 1,
-            max: 2,
-          },
-          {
-            id: '2',
-            label: 'passive',
-            min: 3,
-            max: 4,
-          },
-          {
-            id: '3',
-            label: 'promoter',
-            min: 5,
-            max: 10,
-          },
-        ],
-        button_style: {
-          shape: 'rounded',
-          type: 'highlighted',
+import { Range } from 'freemium-survey-components';
+<Range
+  type_info={{
+    type_variant: 'TEXT',
+    scale_properties: {
+      order: 'ascending',
+      range: [
+        {
+          id: '1',
+          label: 'detractor',
+          min: 1,
+          max: 2,
         },
-        labels: {
-          preference: 'edges',
-          values: [
-            'Very dissatisfied',
-            'Very dissatisfied',
-            'Dissatisfied',
-            'Neutral',
-            'Satisfied',
-            'Dissatisfied',
-            'Neutral',
-            'Satisfied',
-            'Dissatisfied',
-            'Satisfied',
-          ],
+        {
+          id: '2',
+          label: 'passive',
+          min: 3,
+          max: 4,
         },
+        {
+          id: '3',
+          label: 'promoter',
+          min: 5,
+          max: 10,
+        },
+      ],
+      button_style: {
+        shape: 'rounded',
+        type: 'highlighted',
+      },
+      labels: {
+        preference: 'edges',
+        values: [
+          'Very dissatisfied',
+          'Very dissatisfied',
+          'Dissatisfied',
+          'Neutral',
+          'Satisfied',
+          'Dissatisfied',
+          'Neutral',
+          'Satisfied',
+          'Dissatisfied',
+          'Satisfied',
+        ],
       },
+    },
     footer_text: 'We look forward to your feedback.',
-    }}
-    value={value}
-    onChangeHandler={function(value: any) {
-      setValue(value)
-    }}
-  />
+  }}
+  value={value}
+  onChangeHandler={function (value: any) {
+    setValue(value);
+  }}
+/>;
 ```
 
-
 ### Rules
 
- - Props (survey,answers) passed to Survey component and WebInAppSurvey component are cached on mount. In order to pass new value, component needs to be remounted.
+- Props (survey,answers) passed to Survey component and WebInAppSurvey component are cached on mount. In order to pass new value, component needs to be remounted.