Skip to content

Commit

Permalink
add endless scrolling to time overview page
Browse files Browse the repository at this point in the history
  • Loading branch information
Gregor Vostrak authored and Gregor Vostrak committed Mar 27, 2024
1 parent 6911351 commit b141e2e
Show file tree
Hide file tree
Showing 3 changed files with 84 additions and 4 deletions.
5 changes: 3 additions & 2 deletions app/Http/Requests/V1/TimeEntry/TimeEntryIndexRequest.php
Original file line number Diff line number Diff line change
Expand Up @@ -51,15 +51,16 @@ public function rules(): array
'string',
'in:true,false',
],
// Limit the number of returned time entries
// Limit the number of returned time entries (default: 150)
'limit' => [
'integer',
'min:1',
'max:500',
],
// Filter makes sure that only time entries of a whole date are returned
'only_full_dates' => [
'boolean',
'string',
'in:true,false',
],
];
}
Expand Down
49 changes: 47 additions & 2 deletions resources/js/Pages/Time.vue
Original file line number Diff line number Diff line change
@@ -1,17 +1,33 @@
<script setup lang="ts">
import AppLayout from '@/Layouts/AppLayout.vue';
import TimeTracker from '@/Components/TimeTracker.vue';
import { computed, onMounted } from 'vue';
import { computed, onMounted, ref, watch } from 'vue';
import MainContainer from '@/Pages/MainContainer.vue';
import { useTimeEntriesStore } from '@/utils/useTimeEntries';
import { storeToRefs } from 'pinia';
import dayjs from 'dayjs';
import type { TimeEntry } from '@/utils/api';
import TimeEntryRowHeading from '@/Components/Common/TimeEntry/TimeEntryRowHeading.vue';
import TimeEntryRow from '@/Components/Common/TimeEntry/TimeEntryRow.vue';
import { useElementVisibility } from '@vueuse/core';
const timeEntriesStore = useTimeEntriesStore();
const { timeEntries } = storeToRefs(timeEntriesStore);
const { timeEntries, allTimeEntriesLoaded } = storeToRefs(timeEntriesStore);
const loading = ref(false);
const loadMoreContainer = ref<HTMLDivElement | null>(null);
const isLoadMoreVisible = useElementVisibility(loadMoreContainer);
watch(isLoadMoreVisible, async (isVisible) => {
if (
isVisible &&
timeEntries.value.length > 0 &&
!allTimeEntriesLoaded.value
) {
loading.value = true;
await timeEntriesStore.fetchMoreTimeEntries();
}
});
onMounted(async () => {
await timeEntriesStore.fetchTimeEntries();
Expand Down Expand Up @@ -43,5 +59,34 @@ const groupedTimeEntries = computed(() => {
v-for="entry in value"
:time-entry="entry"></TimeEntryRow>
</div>
<div ref="loadMoreContainer">
<div
v-if="loading && !allTimeEntriesLoaded"
class="flex justify-center items-center py-5 text-white font-medium">
<svg
class="animate-spin -ml-1 mr-3 h-5 w-5 text-white"
xmlns="http://www.w3.org/2000/svg"
fill="none"
viewBox="0 0 24 24">
<circle
class="opacity-25"
cx="12"
cy="12"
r="10"
stroke="currentColor"
stroke-width="4"></circle>
<path
class="opacity-75"
fill="currentColor"
d="M4 12a8 8 0 018-8V0C5.373 0 0 5.373 0 12h4zm2 5.291A7.962 7.962 0 014 12H0c0 3.042 1.135 5.824 3 7.938l3-2.647z"></path>
</svg>
<span> Loading more time entries... </span>
</div>
<div
v-else-if="allTimeEntriesLoaded"
class="flex justify-center items-center py-5 text-white font-medium">
All time entries are loaded!
</div>
</div>
</AppLayout>
</template>
34 changes: 34 additions & 0 deletions resources/js/utils/useTimeEntries.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,22 +3,54 @@ import { getCurrentOrganizationId } from '@/utils/useUser';
import { api } from '../../../openapi.json.client';
import { reactive, ref } from 'vue';
import type { TimeEntry } from '@/utils/api';
import dayjs from 'dayjs';

export const useTimeEntriesStore = defineStore('timeEntries', () => {
const timeEntries = ref<TimeEntry[]>(reactive([]));

const allTimeEntriesLoaded = ref(false);

async function fetchTimeEntries() {
const organizationId = getCurrentOrganizationId();
if (organizationId) {
const timeEntriesResponse = await api.getTimeEntries({
params: {
organization: organizationId,
},
queries: {
only_full_dates: true,
},
});
timeEntries.value = timeEntriesResponse.data;
}
}

async function fetchMoreTimeEntries() {
const organizationId = getCurrentOrganizationId();
if (organizationId) {
const latestTimeEntry =
timeEntries.value[timeEntries.value.length - 1];
dayjs(latestTimeEntry.start).utc().format('YYYY-MM-DD');

const timeEntriesResponse = await api.getTimeEntries({
params: {
organization: organizationId,
},
queries: {
only_full_dates: true,
before: dayjs(latestTimeEntry.start).utc().format(),
},
});
if (timeEntriesResponse.data.length > 0) {
timeEntries.value = timeEntries.value.concat(
timeEntriesResponse.data
);
} else {
allTimeEntriesLoaded.value = true;
}
}
}

async function updateTimeEntry(timeEntry: TimeEntry) {
const organizationId = getCurrentOrganizationId();
if (organizationId) {
Expand Down Expand Up @@ -65,5 +97,7 @@ export const useTimeEntriesStore = defineStore('timeEntries', () => {
updateTimeEntry,
createTimeEntry,
deleteTimeEntry,
fetchMoreTimeEntries,
allTimeEntriesLoaded,
};
});

0 comments on commit b141e2e

Please sign in to comment.