elk/components/common/CommonPaginator.vue

121 lines
3.3 KiB
Vue
Raw Normal View History

<script setup lang="ts" generic="T, O, U = T">
2022-11-27 06:16:02 +00:00
// @ts-expect-error missing types
import { DynamicScroller } from 'vue-virtual-scroller'
import 'vue-virtual-scroller/dist/vue-virtual-scroller.css'
2024-01-09 08:56:15 +00:00
import type { mastodon } from 'masto'
import type { UnwrapRef } from 'vue'
2022-11-16 16:11:08 +00:00
2022-12-27 22:18:16 +00:00
const {
paginator,
stream,
keyProp = 'id',
virtualScroller = false,
preprocess,
endMessage = true,
2022-12-27 22:18:16 +00:00
} = defineProps<{
2024-01-09 08:56:15 +00:00
paginator: mastodon.Paginator<T[], O>
keyProp?: keyof T
2022-11-28 13:14:27 +00:00
virtualScroller?: boolean
2024-01-09 08:56:15 +00:00
stream?: mastodon.streaming.Subscription
preprocess?: (items: (U | T)[]) => U[]
endMessage?: boolean | string
2022-11-16 16:11:08 +00:00
}>()
2022-11-17 07:35:42 +00:00
2022-11-27 08:54:00 +00:00
defineSlots<{
default: (props: {
items: U[]
item: U
index: number
2022-11-27 08:54:00 +00:00
active?: boolean
older: U
newer: U // newer is undefined when index === 0
}) => void
items: (props: {
items: UnwrapRef<U[]>
}) => void
updater: (props: {
number: number
update: () => void
}) => void
loading: (props: object) => void
2023-07-05 06:33:41 +00:00
done: (props: { items: U[] }) => void
2022-11-27 08:54:00 +00:00
}>()
const { t } = useI18n()
const nuxtApp = useNuxtApp()
const { items, prevItems, update, state, endAnchor, error } = usePaginator(paginator, $$(stream), preprocess)
nuxtApp.hook('elk-logo:click', () => {
update()
nuxtApp.$scrollToTop()
})
function createEntry(item: any) {
items.value = [...items.value, preprocess?.([item]) ?? item]
}
function updateEntry(item: any) {
const id = item[keyProp]
const index = items.value.findIndex(i => (i as any)[keyProp] === id)
if (index > -1)
items.value = [...items.value.slice(0, index), preprocess?.([item]) ?? item, ...items.value.slice(index + 1)]
}
function removeEntry(entryId: any) {
items.value = items.value.filter(i => (i as any)[keyProp] !== entryId)
}
defineExpose({ createEntry, removeEntry, updateEntry })
2022-11-16 16:11:08 +00:00
</script>
<template>
2022-11-17 07:35:42 +00:00
<div>
<slot v-if="prevItems.length" name="updater" v-bind="{ number: prevItems.length, update }" />
2022-11-30 00:47:54 +00:00
<slot name="items" :items="items">
<template v-if="virtualScroller">
<DynamicScroller
2022-12-27 22:18:16 +00:00
v-slot="{ item, active, index }"
2022-11-30 00:47:54 +00:00
:items="items"
:min-item-size="200"
:key-field="keyProp"
page-mode
>
2022-12-27 22:18:16 +00:00
<slot
2023-05-29 11:46:45 +00:00
v-bind="{ key: item[keyProp] }"
2022-12-27 22:18:16 +00:00
:item="item"
:active="active"
:older="items[index + 1] as U"
:newer="items[index - 1] as U"
:index="index"
:items="items as U[]"
2022-12-27 22:18:16 +00:00
/>
2022-11-30 00:47:54 +00:00
</DynamicScroller>
</template>
<template v-else>
<slot
v-for="item, index of items"
2023-05-29 11:46:45 +00:00
v-bind="{ key: item[keyProp as keyof U] }"
:item="item as U"
:older="items[index + 1] as U"
:newer="items[index - 1] as U"
:index="index"
:items="items as U[]"
2022-11-30 00:47:54 +00:00
/>
</template>
</slot>
2022-11-17 07:35:42 +00:00
<div ref="endAnchor" />
2022-11-27 05:02:19 +00:00
<slot v-if="state === 'loading'" name="loading">
<TimelineSkeleton />
2022-11-27 05:02:19 +00:00
</slot>
2023-07-05 06:33:41 +00:00
<slot v-else-if="state === 'done' && endMessage !== false" name="done" :items="items as U[]">
<div p5 text-secondary italic text-center>
{{ t(typeof endMessage === 'string' && items.length <= 0 ? endMessage : 'common.end_of_list') }}
</div>
</slot>
<div v-else-if="state === 'error'" p5 text-secondary>
{{ t('common.error') }}: {{ error }}
2022-11-17 07:35:42 +00:00
</div>
2022-11-16 16:11:08 +00:00
</div>
</template>