@solspace/freeform-vue 0.1.17
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/LICENSE +22 -0
- package/README.md +61 -0
- package/dist/components/CaptchaHost.vue.d.ts +9 -0
- package/dist/components/ExtensionHost.vue.d.ts +23 -0
- package/dist/components/FieldRenderer.vue.d.ts +12 -0
- package/dist/components/FormLoader.vue.d.ts +12 -0
- package/dist/components/Freeform.vue.d.ts +24 -0
- package/dist/components/FreeformView.vue.d.ts +10 -0
- package/dist/composables/useFieldExtension.d.ts +3 -0
- package/dist/composables/useFreeform.d.ts +3 -0
- package/dist/index.css +2 -0
- package/dist/index.d.ts +19 -0
- package/dist/index.js +1764 -0
- package/dist/index.js.map +1 -0
- package/dist/renderers/builtin/CalculationField.d.ts +23 -0
- package/dist/renderers/builtin/SignatureField.d.ts +23 -0
- package/dist/renderers/builtin/TableField.d.ts +23 -0
- package/dist/renderers/builtin/fields.d.ts +29 -0
- package/dist/renderers/builtin/index.d.ts +3 -0
- package/dist/renderers/builtin/wrappers.d.ts +825 -0
- package/dist/renderers/resolve.d.ts +3 -0
- package/dist/theme/defaultTheme.d.ts +3 -0
- package/dist/theme/mergeClassNames.d.ts +3 -0
- package/dist/theme/resolveThemeClassNames.d.ts +7 -0
- package/dist/theme/toBemModifier.d.ts +5 -0
- package/dist/types.d.ts +184 -0
- package/dist/utils/securityMeta.d.ts +2 -0
- package/dist/version.d.ts +2 -0
- package/package.json +55 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) Solspace, Inc.
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
|
22
|
+
|
package/README.md
ADDED
|
@@ -0,0 +1,61 @@
|
|
|
1
|
+
# @solspace/freeform-vue
|
|
2
|
+
|
|
3
|
+
Vue 3 adapter for Solspace Freeform headless forms.
|
|
4
|
+
|
|
5
|
+
## Install
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npm install @solspace/freeform-vue @solspace/freeform-core @solspace/freeform-extensions
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
Load the default theme CSS (shared BEM styles from the React default theme package for now):
|
|
12
|
+
|
|
13
|
+
```bash
|
|
14
|
+
npm install @solspace/freeform-theme-default
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
```ts
|
|
18
|
+
import "@solspace/freeform-theme-default/styles.css";
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
## Usage
|
|
22
|
+
|
|
23
|
+
```vue
|
|
24
|
+
<script setup lang="ts">
|
|
25
|
+
import { Freeform } from "@solspace/freeform-vue";
|
|
26
|
+
import { recommendedExtensions } from "@solspace/freeform-extensions";
|
|
27
|
+
|
|
28
|
+
const baseUrl = "https://cms.example.com";
|
|
29
|
+
</script>
|
|
30
|
+
|
|
31
|
+
<template>
|
|
32
|
+
<Freeform
|
|
33
|
+
handle="contact"
|
|
34
|
+
:base-url="baseUrl"
|
|
35
|
+
:extensions="recommendedExtensions"
|
|
36
|
+
/>
|
|
37
|
+
</template>
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
### Headless composable
|
|
41
|
+
|
|
42
|
+
```vue
|
|
43
|
+
<script setup lang="ts">
|
|
44
|
+
import { useFreeform } from "@solspace/freeform-vue";
|
|
45
|
+
|
|
46
|
+
const form = useFreeform({
|
|
47
|
+
handle: "contact",
|
|
48
|
+
baseUrl: "https://cms.example.com",
|
|
49
|
+
});
|
|
50
|
+
</script>
|
|
51
|
+
|
|
52
|
+
<template>
|
|
53
|
+
<div v-if="form.loading">Loading…</div>
|
|
54
|
+
<form v-else @submit.prevent="form.handleSubmit">
|
|
55
|
+
</form>
|
|
56
|
+
</template>
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
## Docs
|
|
60
|
+
|
|
61
|
+
[Getting Started](https://docs.solspace.com/craft/freeform/v5/headless/getting-started/) · [React JS](https://docs.solspace.com/craft/freeform/v5/headless/reactjs/) (API parity; Vue docs coming)
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
import type { ManifestCaptchaSecurity } from "@solspace/freeform-core";
|
|
2
|
+
import type { FreeformRuntime } from "../types.js";
|
|
3
|
+
type __VLS_Props = {
|
|
4
|
+
form: FreeformRuntime;
|
|
5
|
+
captcha: ManifestCaptchaSecurity;
|
|
6
|
+
};
|
|
7
|
+
declare const __VLS_export: import("vue").DefineComponent<__VLS_Props, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<__VLS_Props> & Readonly<{}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
|
|
8
|
+
declare const _default: typeof __VLS_export;
|
|
9
|
+
export default _default;
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
import type { ManifestFieldDefinition } from "@solspace/freeform-core";
|
|
2
|
+
import type { FreeformRuntime } from "../types.js";
|
|
3
|
+
type __VLS_Props = {
|
|
4
|
+
field: ManifestFieldDefinition;
|
|
5
|
+
form: FreeformRuntime;
|
|
6
|
+
class?: string;
|
|
7
|
+
dataAttr: string;
|
|
8
|
+
dataValue?: string;
|
|
9
|
+
hidden?: boolean;
|
|
10
|
+
};
|
|
11
|
+
declare var __VLS_1: {};
|
|
12
|
+
type __VLS_Slots = {} & {
|
|
13
|
+
default?: (props: typeof __VLS_1) => any;
|
|
14
|
+
};
|
|
15
|
+
declare const __VLS_base: import("vue").DefineComponent<__VLS_Props, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<__VLS_Props> & Readonly<{}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
|
|
16
|
+
declare const __VLS_export: __VLS_WithSlots<typeof __VLS_base, __VLS_Slots>;
|
|
17
|
+
declare const _default: typeof __VLS_export;
|
|
18
|
+
export default _default;
|
|
19
|
+
type __VLS_WithSlots<T, S> = T & {
|
|
20
|
+
new (): {
|
|
21
|
+
$slots: S;
|
|
22
|
+
};
|
|
23
|
+
};
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
import type { ManifestFieldDefinition } from "@solspace/freeform-core";
|
|
2
|
+
import type { FreeformRuntime, FreeformVueTheme, RendererOverrides } from "../types.js";
|
|
3
|
+
type __VLS_Props = {
|
|
4
|
+
field: ManifestFieldDefinition;
|
|
5
|
+
form: FreeformRuntime;
|
|
6
|
+
theme: FreeformVueTheme;
|
|
7
|
+
renderers: RendererOverrides;
|
|
8
|
+
allowRawHtml?: boolean;
|
|
9
|
+
};
|
|
10
|
+
declare const __VLS_export: import("vue").DefineComponent<__VLS_Props, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<__VLS_Props> & Readonly<{}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
|
|
11
|
+
declare const _default: typeof __VLS_export;
|
|
12
|
+
export default _default;
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
type __VLS_Props = {
|
|
2
|
+
message?: string;
|
|
3
|
+
loaderClass?: string;
|
|
4
|
+
variant?: "spinner" | "skeleton";
|
|
5
|
+
};
|
|
6
|
+
declare const __VLS_export: import("vue").DefineComponent<__VLS_Props, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<__VLS_Props> & Readonly<{}>, {
|
|
7
|
+
message: string;
|
|
8
|
+
loaderClass: string;
|
|
9
|
+
variant: "spinner" | "skeleton";
|
|
10
|
+
}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
|
|
11
|
+
declare const _default: typeof __VLS_export;
|
|
12
|
+
export default _default;
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
import type { UseFreeformOptions } from "../types.js";
|
|
2
|
+
type __VLS_Props = UseFreeformOptions & {
|
|
3
|
+
class?: string;
|
|
4
|
+
loadingMessage?: string;
|
|
5
|
+
};
|
|
6
|
+
declare const form: import("../types.js").UseFreeformResult;
|
|
7
|
+
type __VLS_Slots = {
|
|
8
|
+
default?: (props: {
|
|
9
|
+
form: typeof form;
|
|
10
|
+
}) => unknown;
|
|
11
|
+
error?: (props: {
|
|
12
|
+
error: Error;
|
|
13
|
+
}) => unknown;
|
|
14
|
+
loading?: () => unknown;
|
|
15
|
+
};
|
|
16
|
+
declare const __VLS_base: import("vue").DefineComponent<__VLS_Props, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<__VLS_Props> & Readonly<{}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
|
|
17
|
+
declare const __VLS_export: __VLS_WithSlots<typeof __VLS_base, __VLS_Slots>;
|
|
18
|
+
declare const _default: typeof __VLS_export;
|
|
19
|
+
export default _default;
|
|
20
|
+
type __VLS_WithSlots<T, S> = T & {
|
|
21
|
+
new (): {
|
|
22
|
+
$slots: S;
|
|
23
|
+
};
|
|
24
|
+
};
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
import type { UseFreeformResult } from "../types.js";
|
|
2
|
+
type __VLS_Props = {
|
|
3
|
+
form: UseFreeformResult & {
|
|
4
|
+
manifest: NonNullable<UseFreeformResult["manifest"]>;
|
|
5
|
+
};
|
|
6
|
+
class?: string;
|
|
7
|
+
};
|
|
8
|
+
declare const __VLS_export: import("vue").DefineComponent<__VLS_Props, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<__VLS_Props> & Readonly<{}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
|
|
9
|
+
declare const _default: typeof __VLS_export;
|
|
10
|
+
export default _default;
|
|
@@ -0,0 +1,3 @@
|
|
|
1
|
+
import type { ManifestFieldDefinition } from "@solspace/freeform-core";
|
|
2
|
+
import type { FreeformRuntime } from "../types.js";
|
|
3
|
+
export declare function useFieldExtension(field: ManifestFieldDefinition, form: FreeformRuntime): import("vue").Ref<HTMLElement | null, HTMLElement | null>;
|
package/dist/index.css
ADDED
|
@@ -0,0 +1,2 @@
|
|
|
1
|
+
.ff-loader-root[data-v-36bcdb81]{color:inherit;gap:1rem;padding:1.25rem 0;display:grid}.ff-loader-skeleton[data-v-36bcdb81]{width:100%}.ff-loader-line[data-v-36bcdb81]{opacity:.12;background-color:currentColor;border-radius:8px;animation:1.4s ease-in-out infinite ff-loader-pulse-36bcdb81}.ff-loader-line--title[data-v-36bcdb81]{width:38%;height:.75rem;margin-bottom:1.25rem}.ff-loader-line--label[data-v-36bcdb81]{width:28%;height:.65rem;margin-bottom:.45rem}.ff-loader-line--input[data-v-36bcdb81]{height:2.5rem}.ff-loader-line--button[data-v-36bcdb81]{width:7rem;height:2.5rem;margin-top:.5rem}.ff-loader-field[data-v-36bcdb81]{margin-bottom:1rem}.ff-loader-spinner[data-v-36bcdb81]{opacity:.85;border:3px solid;border-top-color:#0000;border-radius:50%;width:2rem;height:2rem;animation:.7s linear infinite ff-loader-spin-36bcdb81}.ff-loader-message[data-v-36bcdb81]{opacity:.75;margin:0;font-size:.9rem}@keyframes ff-loader-spin-36bcdb81{to{transform:rotate(360deg)}}@keyframes ff-loader-pulse-36bcdb81{0%,to{opacity:1}50%{opacity:.45}}
|
|
2
|
+
/*$vite$:1*/
|
package/dist/index.d.ts
ADDED
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @solspace/freeform-vue
|
|
3
|
+
*
|
|
4
|
+
* Vue adapter for Freeform headless forms.
|
|
5
|
+
*/
|
|
6
|
+
export type { FieldValue, FreeformManifest, ManifestFieldDefinition, SubmitIntent, SubmitResponse, } from "@solspace/freeform-core";
|
|
7
|
+
export { default as FormLoader } from "./components/FormLoader.vue";
|
|
8
|
+
export { default as Freeform } from "./components/Freeform.vue";
|
|
9
|
+
export { default as FreeformView } from "./components/FreeformView.vue";
|
|
10
|
+
export { useFieldExtension } from "./composables/useFieldExtension.js";
|
|
11
|
+
export { useFreeform } from "./composables/useFreeform.js";
|
|
12
|
+
export { builtinComponents, builtinRenderers, } from "./renderers/builtin/index.js";
|
|
13
|
+
export { resolveFieldRenderer } from "./renderers/resolve.js";
|
|
14
|
+
export { createTheme, defaultTheme } from "./theme/defaultTheme.js";
|
|
15
|
+
export { joinClassNames, mergeClassNames } from "./theme/mergeClassNames.js";
|
|
16
|
+
export { resolveThemeClassNames } from "./theme/resolveThemeClassNames.js";
|
|
17
|
+
export { toBemModifier } from "./theme/toBemModifier.js";
|
|
18
|
+
export type { FreeformProps, FreeformRuntime, FreeformThemeClassNames, FreeformVueTheme, RendererOverrides, UseFreeformOptions, UseFreeformResult, VueFieldRenderer, VueFieldRendererProps, } from "./types.js";
|
|
19
|
+
export { CLIENT_NAME, PACKAGE_VERSION } from "./types.js";
|