@solidgate/react-sdk 1.14.0 → 1.15.0

package/README.md

@@ -1,15 +1,58 @@
-# Solid react-sdk
+# Solidgate react-sdk
+
+This repository is a React wrapper for the Solidgate Client Software Development Kit (SDK).
+
+It supports rendering payment forms and resign forms, including custom container elements for <a href="https://docs.solidgate.com/payments/integrate/payment-form/google-pay-button/" target="_blank">Google Pay</a>, <a href="https://docs.solidgate.com/payments/integrate/payment-form/apple-pay-button/" target="_blank">Apple Pay</a>, or <a href="https://docs.solidgate.com/payments/integrate/payment-form/paypal-button/" target="_blank">PayPal</a> buttons.
+
+Check our
+* <a href="https://docs.solidgate.com/" target="_blank">Payment guide</a> to understand business value better
+* <a href="https://api-docs.solidgate.com/" target="_blank">API Reference</a> to find more examples of usage
+
+## Structure
+
+<table style="width: 100%; background: transparent;">
+  <colgroup>
+    <col style="width: 50%;">
+    <col style="width: 50%;">
+  </colgroup>
+  <tr>
+    <th>SDK for React contains</th>
+    <th>Table of contents</th>
+  </tr>
+  <tr>
+    <td>
+      <code>src</code> – main source code<br>
+      <code>public</code> – assets folder<br>
+      <code>playground</code> – example app<br>
+      <code>package.json</code> – project metadata and dependency definitions
+    </td>
+    <td>
+      <a href="https://github.com/solidgate-tech/react-sdk?tab=readme-ov-file#installation">Installation</a><br>
+      <a href="https://github.com/solidgate-tech/react-sdk?tab=readme-ov-file#usage">Usage</a><br>
+      <a href="https://github.com/solidgate-tech/react-sdk?tab=readme-ov-file#development-server">Development server</a><br>
+      <a href="https://github.com/solidgate-tech/react-sdk?tab=readme-ov-file#build">Build</a>
+    </td>
+  </tr>
+</table>
+
+<br>
 
 ## Installation
 
+Run the following command in your React project:
+
 ```
 npm install --save @solidgate/react-sdk
 ```
 
-## Examples
+<br>
+
+## Usage
 
 ### Payment form
 
+Render a <a href="https://docs.solidgate.com/payments/integrate/payment-form/create-your-payment-form/" target="_blank">payment form</a> component in your React project.
+
 ```tsx
 import React from 'react'
 import ReactDOM from 'react-dom';
@@ -100,6 +143,8 @@ ReactDOM.render(<App />, document.body);
 
 ### Resign form
 
+Render a <a href="https://docs.solidgate.com/payments/integrate/payment-form/resign-payment-form/" target="_blank">resign payment form</a> component in your React project.
+
 ```tsx
 const resignRequest = {
   merchant: '<<--YOUR MERCHANT ID-->>',
@@ -157,13 +202,19 @@ function App () {
 }
 ```
 
-## Build
-
-Run ``` npm run build ``` to build the project. The build artifacts will be stored in the dist/ directory.
+<br>
 
-## Development
+## Development server
 
 1. `cd playground`
 2. `npm i`
 3. `npm run start`
-4. Navigate to http://localhost:3000/. 
+4. `Navigate` to http://localhost:3000/
+
+<br>
+
+## Build
+
+Run ``` npm run build ``` to build the project.
+
+The build artifacts will be stored in the `dist/` directory.

package/dist/cjs/components/Payment/Payment.d.ts

@@ -11,9 +11,9 @@ interface PaymentProps extends Partial<ClientSdkEventsProvider> {
     applePayButtonParams?: Omit<InitConfig['applePayButtonParams'], 'containerId'>;
     paypalButtonParams?: Omit<InitConfig['paypalButtonParams'], 'containerId'>;
     onReadyPaymentInstance?: (paymentInstance: ClientSdkInstance) => void;
-    googlePayContainerRef?: RefObject<HTMLDivElement>;
-    applePayContainerRef?: RefObject<HTMLDivElement>;
-    paypalContainerRef?: RefObject<HTMLDivElement>;
+    googlePayContainerRef?: RefObject<HTMLDivElement | null>;
+    applePayContainerRef?: RefObject<HTMLDivElement | null>;
+    paypalContainerRef?: RefObject<HTMLDivElement | null>;
 }
 declare const Payment: {
     (props: PaymentProps): JSX.Element;

package/dist/esm/components/Payment/Payment.d.ts

@@ -11,9 +11,9 @@ interface PaymentProps extends Partial<ClientSdkEventsProvider> {
     applePayButtonParams?: Omit<InitConfig['applePayButtonParams'], 'containerId'>;
     paypalButtonParams?: Omit<InitConfig['paypalButtonParams'], 'containerId'>;
     onReadyPaymentInstance?: (paymentInstance: ClientSdkInstance) => void;
-    googlePayContainerRef?: RefObject<HTMLDivElement>;
-    applePayContainerRef?: RefObject<HTMLDivElement>;
-    paypalContainerRef?: RefObject<HTMLDivElement>;
+    googlePayContainerRef?: RefObject<HTMLDivElement | null>;
+    applePayContainerRef?: RefObject<HTMLDivElement | null>;
+    paypalContainerRef?: RefObject<HTMLDivElement | null>;
 }
 declare const Payment: {
     (props: PaymentProps): JSX.Element;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@solidgate/react-sdk",
   "repository": "https://github.com/solidgate-tech/react-sdk",
-  "version": "1.14.0",
+  "version": "1.15.0",
   "license": "Apache-2.0",
   "author": "Solidgate",
   "description": "Solidgate react sdk loader",
@@ -62,7 +62,7 @@
     "typescript": "^4.4.2"
   },
   "peerDependencies": {
-    "react": "^17.0.2 || ^18.0.0",
-    "react-dom": "^17.0.2 || ^18.0.0"
+    "react": "^17.0.2 || ^18.0.0 || ^19.0.0",
+    "react-dom": "^17.0.2 || ^18.0.0 || ^19.0.0"
   }
 }