feat(TU-20040): Add isClosed to onReady callback payload

Resolves #647
Typeform · Nov 26, 2024 · 1300e26 · 1300e26
1 parent 235ecfe
commit 1300e26
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 7 deletions.
diff --git a/docs/callbacks.md b/docs/callbacks.md
@@ -33,8 +33,10 @@ import { createWidget } from '@typeform/embed'
 import '@typeform/embed/build/css/widget.css'
 
 createWidget('<form-id>', {
-  onReady: ({ formId }) => {
-    console.log(`Form ${formId} is ready`)
+  onReady: ({ formId, isClosed }) => {
+    console.log(
+      `Form ${formId} is ready. ${isClosed ? 'It is closed for new responses.' : 'It is open to new responses.'}`
+    )
   },
 })
 ```
@@ -46,8 +48,10 @@ Or in HTML:
 <script src="//embed.typeform.com/next/embed.js"></script>
 <script>
   // this function needs to be available on global scope (window)
-  function ready({ formId }) {
-    console.log(`Form ${formId} is ready`)
+  function ready({ formId, isClosed }) {
+    console.log(
+      `Form ${formId} is ready. ${isClosed ? 'It is closed for new responses.' : 'It is open to new responses.'}`
+    )
   }
 </script>
 ```

diff --git a/packages/embed/README.md b/packages/embed/README.md
@@ -231,8 +231,8 @@ You can listen to form events by providing callback methods:
 <link rel="stylesheet" href="//embed.typeform.com/next/css/widget.css" />
 <script>
   const { open } = window.tf.createPopup('<form-id>', {
-    onReady: ({ formId }) => {
-      console.log(`Form ${formId} is ready`)
+    onReady: ({ formId, isClosed }) => {
+      console.log(`Form ${formId} is ready. ${isClosed ? 'It is closed for new responses.' : 'It is open to new responses.'}`)
     },
     onStarted: ({ formId, responseId }) => {
       console.log(`Form ${formId} started with response ID ${responseId}`)
@@ -271,6 +271,7 @@ Callback method receive payload object from the form. Each payload contains form
 
 - onReady
   - `formId` (string)
+  - `isClosed` (boolean) indicates [the form is closed for new responses](https://www.typeform.com/help/a/close-your-form-360050913591/)
 - onStarted
   - `formId` (string)
   - `responseId` (string)

diff --git a/packages/embed/src/base/actionable-options.ts b/packages/embed/src/base/actionable-options.ts
@@ -14,11 +14,15 @@ interface WithHeight {
   height: number
 }
 
+interface WithIsClosed {
+  isClosed: boolean
+}
+
 export type ActionableOptions = {
   /**
    * Callback function that will be executed once the typeform is ready.
    */
-  onReady?: (event: WithFormId) => void
+  onReady?: (event: WithFormId & WithIsClosed) => void
   /**
    * Callback function that will be executed once the typeform "submission start" event is fired.
    */