@forms.expert/sdk 0.1.8 → 0.1.10
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +10 -8
- package/package.json +2 -1
package/README.md
CHANGED
|
@@ -5,7 +5,7 @@ Embeddable forms SDK for submitting forms via the Forms Expert API.
|
|
|
5
5
|
## Installation
|
|
6
6
|
|
|
7
7
|
```bash
|
|
8
|
-
npm install @forms
|
|
8
|
+
npm install @forms.expert/sdk
|
|
9
9
|
```
|
|
10
10
|
|
|
11
11
|
## Quick Start
|
|
@@ -30,7 +30,7 @@ npm install @forms-expert/sdk
|
|
|
30
30
|
### Vanilla JavaScript (Module)
|
|
31
31
|
|
|
32
32
|
```javascript
|
|
33
|
-
import { FormWidget } from '@forms
|
|
33
|
+
import { FormWidget } from '@forms.expert/sdk/vanilla';
|
|
34
34
|
|
|
35
35
|
const widget = new FormWidget(
|
|
36
36
|
{
|
|
@@ -56,7 +56,7 @@ widget.init();
|
|
|
56
56
|
### React
|
|
57
57
|
|
|
58
58
|
```tsx
|
|
59
|
-
import { FormsExpertForm } from '@forms
|
|
59
|
+
import { FormsExpertForm } from '@forms.expert/sdk/react';
|
|
60
60
|
|
|
61
61
|
function ContactPage() {
|
|
62
62
|
return (
|
|
@@ -79,7 +79,7 @@ function ContactPage() {
|
|
|
79
79
|
### React Hook
|
|
80
80
|
|
|
81
81
|
```tsx
|
|
82
|
-
import { useForm, FormsProvider } from '@forms
|
|
82
|
+
import { useForm, FormsProvider } from '@forms.expert/sdk/react';
|
|
83
83
|
|
|
84
84
|
// With provider
|
|
85
85
|
function App() {
|
|
@@ -138,7 +138,7 @@ function ContactForm() {
|
|
|
138
138
|
|
|
139
139
|
```vue
|
|
140
140
|
<script setup>
|
|
141
|
-
import { useForm } from '@forms
|
|
141
|
+
import { useForm } from '@forms.expert/sdk/vue';
|
|
142
142
|
|
|
143
143
|
const form = useForm({
|
|
144
144
|
slug: 'contact',
|
|
@@ -184,7 +184,7 @@ const handleSubmit = async () => {
|
|
|
184
184
|
For programmatic form submission without UI:
|
|
185
185
|
|
|
186
186
|
```typescript
|
|
187
|
-
import { FormsSDK } from '@forms
|
|
187
|
+
import { FormsSDK } from '@forms.expert/sdk';
|
|
188
188
|
|
|
189
189
|
const sdk = new FormsSDK({
|
|
190
190
|
apiKey: 'pk_live_xxxxxxxxxxxx',
|
|
@@ -372,7 +372,7 @@ The form name is rendered as an `<h1>` above the form fields. Visibility is cont
|
|
|
372
372
|
## Error Handling
|
|
373
373
|
|
|
374
374
|
```typescript
|
|
375
|
-
import { FormsError, FormValidationError } from '@forms
|
|
375
|
+
import { FormsError, FormValidationError } from '@forms.expert/sdk';
|
|
376
376
|
|
|
377
377
|
try {
|
|
378
378
|
await sdk.submit('contact', data);
|
|
@@ -420,9 +420,11 @@ import type {
|
|
|
420
420
|
ValidationResponse,
|
|
421
421
|
SubmissionResponse,
|
|
422
422
|
FormsSDKConfig,
|
|
423
|
-
} from '@forms
|
|
423
|
+
} from '@forms.expert/sdk';
|
|
424
424
|
```
|
|
425
425
|
|
|
426
426
|
## License
|
|
427
427
|
|
|
428
428
|
MIT
|
|
429
|
+
|
|
430
|
+
Website: [forms.expert](https://forms.expert)
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@forms.expert/sdk",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.10",
|
|
4
4
|
"description": "Forms SDK for submitting and rendering forms",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"publishConfig": {
|
|
@@ -65,6 +65,7 @@
|
|
|
65
65
|
"url": "https://github.com/forms-expert/sdk/issues"
|
|
66
66
|
},
|
|
67
67
|
"homepage": "https://github.com/forms-expert/sdk/blob/main/README.md",
|
|
68
|
+
"website": "https://forms.expert",
|
|
68
69
|
"files": [
|
|
69
70
|
"dist",
|
|
70
71
|
"README.md"
|