From d4c6c67e4289ef63d557da95376e696c6b47ddc5 Mon Sep 17 00:00:00 2001
From: Adrien Montagu <adrienmontagu@gmail.com>
Date: Tue, 17 Dec 2024 17:55:55 +0100
Subject: [PATCH] feat(pagination): Add the default value of page_size from
 options if not specified in formSchema

---
 src/useDatatableUrlSync.ts                    |   4 +-
 src/utils/VDUSTypes.ts                        |   8 +-
 vue3-example/src/App.vue                      |  19 ++-
 .../src/components/SimpleDatatable.vue        | 116 +++++++++---------
 .../src/components/VuetifyDatatable.vue       |  92 +++++++-------
 vue3-example/src/pages/multiple-vuetify.vue   |  16 +++
 vue3-example/typed-router.d.ts                |   1 +
 7 files changed, 137 insertions(+), 119 deletions(-)
 create mode 100644 vue3-example/src/pages/multiple-vuetify.vue

diff --git a/src/useDatatableUrlSync.ts b/src/useDatatableUrlSync.ts
index 1848543..4505d6b 100644
--- a/src/useDatatableUrlSync.ts
+++ b/src/useDatatableUrlSync.ts
@@ -41,9 +41,11 @@ export default function useDatatableUrlSync(route: any, router: any, form: Ref<G
     ordering: [],
     ...options.value
   }
+  // This is just a convenient shortcut. You should speicify the page_size default in formSchema. But as it is already passed in options in the first call we can guess it. As you may pass a non default value on the first call you still can override the formSchema for more complex use case
+  const frontDefaultPageSize = options.value.page_size ?? configurations.serveurDefaultPageSize
   formSchema = {
     page: { type: "integer", default: 1 },
-    page_size: { type: "integer", default: 10 },
+    page_size: { type: "integer", default: frontDefaultPageSize },
     ordering: { type: "arrayString", default: [] },
     ...formSchema || {}
   }
diff --git a/src/utils/VDUSTypes.ts b/src/utils/VDUSTypes.ts
index bbc0794..6495f12 100644
--- a/src/utils/VDUSTypes.ts
+++ b/src/utils/VDUSTypes.ts
@@ -27,15 +27,15 @@ type VDUSConfiguration = {
 }
 
 type VuetifySortArraysObject = {
-  sortBy: Array<string | { key: string; order: 'asc' | 'desc'; }>;
-  sortDesc: Array<boolean>;
+  sortBy: Array<string | { key: string; order: 'asc' | 'desc'; }>; // depending if vuetify 2 or 3
+  sortDesc: Array<boolean>; // not existing in vuetify 3
 }
 
 type VuetifyOptions = {
   page: number;
   itemsPerPage: number;
-  sortBy: Array<string>;
-  sortDesc: Array<boolean>;
+  sortBy: Array<string | { key: string; order: 'asc' | 'desc'; }>; // depending if vuetify 2 or 3
+  sortDesc: Array<boolean>; // not existing in vuetify 3
   groupBy: Array<string>;
   groupDesc: Array<boolean>;
   multiSort: boolean;
diff --git a/vue3-example/src/App.vue b/vue3-example/src/App.vue
index c474628..a8cc158 100644
--- a/vue3-example/src/App.vue
+++ b/vue3-example/src/App.vue
@@ -18,19 +18,18 @@
           <v-list-item
             prepend-icon="mdi-gavel"
             title="Multiple Datatable"
-            to="/multiple-datatable"
+            to="/multiple-vuetify"
           />
         </v-list>
-
-        <template #append>
-          <div class="pa-2">
-            <v-btn block>
-              Logout
-            </v-btn>
-          </div>
-        </template>
       </v-navigation-drawer>
-      <router-view />
+      <v-container class="fill-height">
+        <v-responsive
+          class="align-centerfill-height mx-auto"
+          max-width="900"
+        >
+          <router-view />
+        </v-responsive>
+      </v-container>
     </v-main>
   </v-app>
 </template>
diff --git a/vue3-example/src/components/SimpleDatatable.vue b/vue3-example/src/components/SimpleDatatable.vue
index b30c2e4..c5bdfcc 100644
--- a/vue3-example/src/components/SimpleDatatable.vue
+++ b/vue3-example/src/components/SimpleDatatable.vue
@@ -1,67 +1,65 @@
 <template>
-  <div class="container">
-    <div class="mt-8">
-      Datatable
-    </div>
-    <div class="mt-8 row"> 
-      <div
-        v-for="header in headers"
-        :key="header"
-        class="col width-30 border-right border-bottom"
-      >
-        <p>{{ header }}</p>
-        <BaseOrdering
-          :field="header"
-          :value="options.ordering"
-          @input="(value: string[]) => emitOptions('ordering', value)"
-        />
-      </div>
+  <div class="mt-8">
+    Datatable
+  </div>
+  <div class="mt-8 row"> 
+    <div
+      v-for="header in headers"
+      :key="header"
+      class="col width-30 border-right border-bottom"
+    >
+      <p>{{ header }}</p>
+      <BaseOrdering
+        :field="header"
+        :value="options.ordering"
+        @input="(value: string[]) => emitOptions('ordering', value)"
+      />
     </div>
+  </div>
+  <div
+    v-for="item in currentItems"
+    :key="item[itemKey]"
+    class="row"
+  >
     <div
-      v-for="item in currentItems"
-      :key="item[itemKey]"
-      class="row"
+      v-for="(value, key) in item"
+      :key="key"
+      class="col width-30 border-right"
     >
-      <div
-        v-for="(value, key) in item"
-        :key="key"
-        class="col width-30 border-right"
-      >
-        <p>{{ value }}</p>
-      </div>
+      <p>{{ value }}</p>
     </div>
-    <div class="mt-4 row">
-      <div class="col width-40">
-        <label>Item per page: </label>
-        <select
-          :value="options.page_size"
-          @change="($event) => emitOptions('page_size', parseInt($event.target?.value))"
+  </div>
+  <div class="mt-4 row">
+    <div class="col width-40">
+      <label>Item per page: </label>
+      <select
+        :value="options.page_size"
+        @change="($event) => emitOptions('page_size', parseInt($event.target?.value))"
+      >
+        <option
+          v-for="itemNumber in [5, 10, 20]"
+          :key="itemNumber"
+          :selected="options.page_size === itemNumber"
+          :value="itemNumber"
         >
-          <option
-            v-for="itemNumber in [5, 10, 20]"
-            :key="itemNumber"
-            :selected="options.page_size === itemNumber"
-            :value="itemNumber"
-          >
-            {{ itemNumber }}
-          </option>
-        </select>
-      </div>
+          {{ itemNumber }}
+        </option>
+      </select>
+    </div>
 
-      <div class="col width-40">
-        <button
-          v-if="options.page > 1"
-          @click="emitOptions('page', options.page - 1)"
-        >
-          Prev. page
-        </button>
-        <button
-          v-if="lastVisibleIndex < items.length"
-          @click="emitOptions('page', options.page + 1)"
-        >
-          Next page
-        </button>
-      </div>
+    <div class="col width-40">
+      <button
+        v-if="options.page > 1"
+        @click="emitOptions('page', options.page - 1)"
+      >
+        Prev. page
+      </button>
+      <button
+        v-if="lastVisibleIndex < items.length"
+        @click="emitOptions('page', options.page + 1)"
+      >
+        Next page
+      </button>
     </div>
   </div>
 </template>
@@ -126,10 +124,6 @@ function emitOptions<K extends keyof Options>(optionKey: K, value: Options[K]) {
 </script>
 
 <style scoped>
-.container {
-  width: 600px;
-  margin: auto;
-}
 .row {
   display: flex;
   flex-wrap: wrap;
diff --git a/vue3-example/src/components/VuetifyDatatable.vue b/vue3-example/src/components/VuetifyDatatable.vue
index 8ef29b0..f124459 100644
--- a/vue3-example/src/components/VuetifyDatatable.vue
+++ b/vue3-example/src/components/VuetifyDatatable.vue
@@ -1,50 +1,43 @@
 <template>
-  <v-container class="fill-height">
-    <v-responsive
-      class="align-centerfill-height mx-auto"
-      max-width="900"
-    >
-      <v-row>
-        <v-col cols="12">
-          <v-form>
-            <v-text-field
-              v-model="form.search"
-              label="search"
-            />
-            <v-checkbox
-              v-model="form.is_answered"
-              label="is Answered"
-            />
-          </v-form>
-        </v-col>
-      </v-row>
-      <v-row>
-        <v-col cols="12">
-          <v-card
-            class="py-4"
-            rounded="lg"
-            variant="outlined"
-          >
-            <template #text>
-              <v-data-table 
-                :items="items"
-                :page="vuetifyOptions.page"
-                :items-per-page="vuetifyOptions.itemsPerPage"
-                :sort-by="vuetifyOptions.sortBy"
-                v-model:options="vuetifyOptions"
-              />
-            </template>
-          </v-card>
-        </v-col>
-      </v-row>
-    </v-responsive>
-  </v-container>
+  <v-row>
+    <v-col cols="12">
+      <v-form>
+        <v-text-field
+          v-model="form.search"
+          label="search"
+        />
+        <v-checkbox
+          v-model="form.is_answered"
+          label="is Answered"
+        />
+      </v-form>
+    </v-col>
+  </v-row>
+  <v-row>
+    <v-col cols="12">
+      <v-card
+        class="py-4"
+        rounded="lg"
+        variant="outlined"
+      >
+        <template #text>
+          <v-data-table 
+            v-model:options="vuetifyOptions"
+            :items="items"
+            :page="vuetifyOptions.page"
+            :items-per-page="vuetifyOptions.itemsPerPage"
+            :sort-by="vuetifyOptions.sortBy"
+          />
+        </template>
+      </v-card>
+    </v-col>
+  </v-row>
 </template>
 
 <script setup lang="ts">
 import { ref } from 'vue';
 import useDatatableUrlSync from '../../../src/useDatatableUrlSync';
-import type { GenericDictionnary, VDUSDatatableOptions, VDUSFormSchema } from '../../../src/utils/VDUSTypes';
+import type { GenericDictionnary, VDUSDatatableOptions, VDUSFormSchema, VDUSConfiguration } from '../../../src/utils/VDUSTypes';
 // import useDatatableUrlSync from 'vue-datatable-url-sync';
 // import type { GenericDictionnary, VDUSDatatableOptions, VDUSFormSchema } from 'vue-datatable-url-sync/src/utils/VDUSTypes';
 import fakeData from "../assets/data/data.js";
@@ -56,6 +49,14 @@ type FakeDataItem = {
   is_answered: boolean;
 };
 
+// --------------------- PROPS ------------------------------------
+const props = defineProps({
+  prefix: {
+    type: String,
+    default: ""
+  },
+})
+
 // --------------------- DATA ------------------------------------
 const form = ref<GenericDictionnary>({
   search: "",
@@ -68,10 +69,15 @@ const options = ref<VDUSDatatableOptions>({
   ordering: []
 });
 
+const configurations = ref<VDUSConfiguration>({
+  prefix: props.prefix,
+  serveurDefaultPageSize: 10,
+})
+
 const items = ref<FakeDataItem[]>([]);
 
 const formSchema = ref<VDUSFormSchema>({
-  is_answered: { type: "boolean" }
+  is_answered: { type: "boolean" },
 });
 
 // --------------------- METHODS ------------------------------------
@@ -121,5 +127,5 @@ const fetchDatas = (queryParams: string, queryAsObject: GenericDictionnary) => {
 };
 
 // --------------------- CREATED ------------------------------------
-const {vuetifyOptions} = useDatatableUrlSync(useRoute(), useRouter(), form, fetchDatas, options, formSchema.value);
+const {vuetifyOptions} = useDatatableUrlSync(useRoute(), useRouter(), form, fetchDatas, options, formSchema.value, null, configurations.value);
 </script>
diff --git a/vue3-example/src/pages/multiple-vuetify.vue b/vue3-example/src/pages/multiple-vuetify.vue
new file mode 100644
index 0000000..bca87a3
--- /dev/null
+++ b/vue3-example/src/pages/multiple-vuetify.vue
@@ -0,0 +1,16 @@
+<template>
+  <v-row>
+    <v-col cols="12">
+      <VuetifyDatatable prefix="d1" />
+    </v-col>
+  </v-row>
+  <v-row>
+    <v-col cols="12">
+      <VuetifyDatatable prefix="d2" />
+    </v-col>
+  </v-row>
+</template>
+
+<script lang="ts" setup>
+  //
+</script>
diff --git a/vue3-example/typed-router.d.ts b/vue3-example/typed-router.d.ts
index 2276ba3..8d6a21b 100644
--- a/vue3-example/typed-router.d.ts
+++ b/vue3-example/typed-router.d.ts
@@ -19,6 +19,7 @@ declare module 'vue-router/auto-routes' {
    */
   export interface RouteNamedMap {
     '/': RouteRecordInfo<'/', '/', Record<never, never>, Record<never, never>>,
+    '/multiple-vuetify': RouteRecordInfo<'/multiple-vuetify', '/multiple-vuetify', Record<never, never>, Record<never, never>>,
     '/simple': RouteRecordInfo<'/simple', '/simple', Record<never, never>, Record<never, never>>,
   }
 }