Merge pull request #6632 from primefaces/v4.2.0-form

PrimeVue Forms
primefaces · Oct 24, 2024 · d33ed12 · d33ed12
2 parents 69d0407 + 593523b
commit d33ed12
Show file tree

Hide file tree

Showing 220 changed files with 11,889 additions and 2,115 deletions.
diff --git a/apps/showcase/assets/menu/menu.json b/apps/showcase/assets/menu/menu.json
@@ -497,6 +497,12 @@
                 }
             ]
         },
+        {
+            "name": "Forms",
+            "icon": "pi pi-check-circle",
+            "to": "/forms",
+            "badge": "NEW"
+        },
         {
             "name": "Pass Through",
             "icon": "pi pi-directions",

diff --git a/apps/showcase/components/doc/DocApiSection.vue b/apps/showcase/components/doc/DocApiSection.vue
@@ -69,7 +69,7 @@ export default {
                     interfaces = this.findOtherInterfaces(values, docName);
                 }
 
-                const types = APIDocs[moduleName]['types'];
+                const types = APIDocs[moduleName]?.['types'];
 
                 const services = modelValues; // (TerminalService && ConfirmationService && ToastService)
 

diff --git a/apps/showcase/components/doc/codeeditor/templates.js b/apps/showcase/components/doc/codeeditor/templates.js
@@ -16,6 +16,7 @@ const core_dependencies = {
     primevue: pkg.version || PrimeVue.version || 'latest',
     '@primevue/themes': pkg.version || PrimeVue.version || 'latest',
     '@primevue/auto-import-resolver': pkg.version || PrimeVue.version || 'latest',
+    '@primevue/form': pkg.version || PrimeVue.version || 'latest',
     primeicons: app_dependencies['primeicons'] || 'latest',
     tailwindcss: app_dependencies['tailwindcss'] || 'latest',
     autoprefixer: app_dependencies['autoprefixer'] || 'latest',

diff --git a/apps/showcase/components/landing/samples/CustomersApp.vue b/apps/showcase/components/landing/samples/CustomersApp.vue
@@ -248,7 +248,6 @@ export default {
             selectedRows: []
         };
     },
-
     methods: {
         displayPopover(event) {
             this.hidePopover();

diff --git a/apps/showcase/doc/autocomplete/FormsDoc.vue b/apps/showcase/doc/autocomplete/FormsDoc.vue
@@ -0,0 +1,202 @@
+<template>
+    <DocSectionText v-bind="$attrs">
+        <p>AutoComplete can be used with the <NuxtLink to="/forms">PrimeVue Forms</NuxtLink> library.</p>
+    </DocSectionText>
+    <div class="card flex justify-center">
+        <Form v-slot="$form" :resolver="resolver" :initialValues="initialValues" @submit="onFormSubmit" class="flex justify-center flex-col gap-4 w-full md:w-56">
+            <div class="flex flex-col gap-2">
+                <AutoComplete name="country" optionLabel="name" :suggestions="filteredCountries" @complete="search" fluid />
+                <Message v-if="$form.country?.invalid" severity="error">{{ $form.country.error?.message }}</Message>
+            </div>
+            <Button type="submit" severity="secondary" label="Submit" />
+        </Form>
+    </div>
+    <DocSectionCode :code="code" :dependencies="{ zod: '3.23.8' }" />
+</template>
+
+<script>
+import { CountryService } from '@/service/CountryService';
+import { zodResolver } from '@primevue/form/resolvers';
+import { z } from 'zod';
+
+export default {
+    data() {
+        return {
+            initialValues: {
+                country: { name: '' }
+            },
+            countries: null,
+            filteredCountries: null,
+            resolver: zodResolver(
+                z.object({
+                    country: z.union([
+                        z.object({
+                            name: z.string().min(1, 'Country required.')
+                        }),
+                        z.any().refine((val) => false, { message: 'Country required.' })
+                    ])
+                })
+            ),
+            code: {
+                basic: `
+<Form v-slot="$form" :resolver="resolver" :initialValues="initialValues" @submit="onFormSubmit" class="flex justify-center flex-col gap-4 w-full md:w-56">
+    <div class="flex flex-col gap-2">
+        <AutoComplete name="country" optionLabel="name" :suggestions="filteredCountries" @complete="search" />
+        <Message v-if="$form.country?.invalid" severity="error">{{ $form.country.error?.message }}</Message>
+    </div>
+    <Button type="submit" severity="secondary" label="Submit" />
+</Form>
+`,
+                options: `
+<template>
+    <div class="card flex justify-center">
+        <Form v-slot="$form" :resolver="resolver" :initialValues="initialValues" @submit="onFormSubmit" class="flex justify-center flex-col gap-4 w-full md:w-56">
+            <div class="flex flex-col gap-2">
+                <AutoComplete name="country" optionLabel="name" :suggestions="filteredCountries" @complete="search" />
+                <Message v-if="$form.country?.invalid" severity="error">{{ $form.country.error?.message }}</Message>
+            </div>
+            <Button type="submit" severity="secondary" label="Submit" />
+        </Form>
+        <Toast />
+    </div>
+</template>
+
+<script>
+import { CountryService } from '@/service/CountryService';
+import { zodResolver } from '@primevue/form/resolvers';
+import { z } from 'zod';
+
+export default {
+    data() {
+        return {
+            initialValues: {
+                country: { name: '' }
+            },
+            countries: null,
+            filteredCountries: null,
+            resolver: zodResolver(
+                z.object({
+                    country: z.union([
+                        z.object({
+                            name: z.string().min(1, 'Country required.')
+                        }),
+                        z.any().refine((val) => false, { message: 'Country required.' })
+                    ])
+                })
+            )
+        }
+    },
+    mounted() {
+        CountryService.getCountries().then((data) => (this.countries = data));
+    },
+    methods: {
+        search(event) {
+            setTimeout(() => {
+                if (!event.query.trim().length) {
+                    this.filteredCountries = [...this.countries];
+                } else {
+                    this.filteredCountries = this.countries.filter((country) => {
+                        return country.name.toLowerCase().startsWith(event.query.toLowerCase());
+                    });
+                }
+            }, 250);
+        },
+        onFormSubmit({ valid }) {
+            if (valid) {
+                this.$toast.add({ severity: 'success', summary: 'Form is submitted.', life: 3000 });
+            }
+        }
+    }
+}
+<\/script>
+
+`,
+                composition: `
+<template>
+    <div class="card flex justify-center">
+        <Form v-slot="$form" :resolver="resolver" :initialValues="initialValues" @submit="onFormSubmit" class="flex justify-center flex-col gap-4 w-full md:w-56">
+            <div class="flex flex-col gap-2">
+                <AutoComplete name="country" optionLabel="name" :suggestions="filteredCountries" @complete="search" />
+                <Message v-if="$form.country?.invalid" severity="error">{{ $form.country.error?.message }}</Message>
+            </div>
+            <Button type="submit" severity="secondary" label="Submit" />
+        </Form>
+        <Toast />
+    </div>
+</template>
+
+<script setup>
+import { ref, onMounted } from "vue";
+import { zodResolver } from '@primevue/form/resolvers';
+import { useToast } from "primevue/usetoast";
+import { z } from 'zod';
+import { CountryService } from "@/service/CountryService";
+
+onMounted(() => {
+    CountryService.getCountries().then((data) => (countries.value = data));
+});
+
+const initialValues = ref({
+    country: { name: '' }
+});
+const resolver = ref(
+zodResolver(
+    z.object({
+        country: z.union([
+            z.object({
+                name: z.string().min(1, 'Country required.')
+            }),
+            z.any().refine((val) => false, { message: 'Country required.' })
+        ])
+    })
+));
+const countries = ref();
+const selectedCountry = ref();
+const filteredCountries = ref();
+const toast = useToast();
+
+const search = (event) => {
+    setTimeout(() => {
+        if (!event.query.trim().length) {
+            filteredCountries.value = [...countries.value];
+        } else {
+            filteredCountries.value = countries.value.filter((country) => {
+                return country.name.toLowerCase().startsWith(event.query.toLowerCase());
+            });
+        }
+    }, 250);
+};
+
+const onFormSubmit = ({ valid }) => {
+    if (valid) {
+        toast.add({ severity: 'success', summary: 'Form is submitted.', life: 3000 });
+    }
+};
+<\/script>
+        `
+            }
+        };
+    },
+    mounted() {
+        CountryService.getCountries().then((data) => (this.countries = data));
+    },
+    methods: {
+        search(event) {
+            setTimeout(() => {
+                if (!event.query.trim().length) {
+                    this.filteredCountries = [...this.countries];
+                } else {
+                    this.filteredCountries = this.countries.filter((country) => {
+                        return country.name.toLowerCase().startsWith(event.query.toLowerCase());
+                    });
+                }
+            }, 250);
+        },
+        onFormSubmit({ valid }) {
+            if (valid) {
+                this.$toast.add({ severity: 'success', summary: 'Form is submitted.', life: 3000 });
+            }
+        }
+    }
+};
+</script>