Merge pull request #312 from lyra/fix/renderElements-provisional-types

fix(docs): example + types update
lyra · Oct 19, 2023 · b319a9d · b319a9d
2 parents 16a6748 + cc9349a
commit b319a9d
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -124,11 +124,11 @@ const endPoint = '~~CHANGE_ME_ENDPOINT~~';
 /* Load the remote library and get the KR object */
 const { KR } = await KRGlue.loadLibrary(endPoint, publicKey) 
 /* Setting configuration */
-await KR.setFormConfig({ 'kr-language': 'en-US' }))
+await KR.setFormConfig({ 'kr-language': 'en-US' })
 /* Attach a payment form to a given DOM selector */
-const { result } = await KR.attachForm('#myPaymentForm'))
+const { result } = await KR.attachForm('#myPaymentForm')
 /* Show the payment form */
-await KR.showForm(result.formId));
+await KR.showForm(result.formId);
 ```
 > **Note**
 > 

diff --git a/index.d.ts b/index.d.ts
@@ -62,6 +62,13 @@ declare interface KR {
   attachForm: (
     formSelector: string
   ) => Promise<{ KR: KR; result: { formId: string } }>
+  /**
+   * Renders KR  in the given selector or HTML element.
+   * @param $elements - Form query selector or HTML element or array of HTML elements or undefined
+   */
+  renderElements: (
+    $elements: string | HTMLElement | Array<HTMLElement> | undefined
+  ) => Promise<void>
   /**
    * Show form.
    * @param formId - Form id