@bigbinary/neeto-payments-frontend 1.1.0 → 1.2.0

package/README.md

@@ -141,7 +141,7 @@ This hook is used to generate the `stripePromise` object to be passed to the str
 Example usage
 
 ```js
-  const stripeAccountIdentifier = "acct_1Mtqtz2e5McIywz4"
+  const stripeAccountIdentifier = "acct_1Mtqtz2e5McIywz4";
   const stripePromise = useStripePromise(stripeAccountIdentifier);
   ...
   <Elements stripe={stripePromise}>
@@ -149,6 +149,32 @@ Example usage
   </Elements>
 
 ```
+
+### 4. `PaymentKindRestrictionAlert` component
+
+#### Props
+
+1. **isOpen**: To specify whether the Stripe connect restriction alert should be
+   opened or closed.
+
+2. **paymentKind**: To specify the type of Stripe payment kind for rendering
+   related content to alert either as "standard" or "platform". If Stripe
+   Standard is connected the alert shall forbid Stripe Platform connect and vice
+   versa.
+
+3. **onClose**: Handler function that is triggered when the disconnect button is
+   clicked.
+
+Example usage
+
+```js
+<PaymentKindRestrictionAlert
+  isOpen={isStripePlatformConnectedAlertOpen}
+  paymentKind="standard"
+  onClose={() => setIsStripePlatformConnectedAlertOpen(false)}
+/>
+```
+
 ## Other References
 
 - [Development instructions](./docs/general/development-instructions.md)