elk/components/common/CommonPaginator.vue

102 lines
2.6 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'
2023-01-06 18:50:31 +00:00
import type { Paginator, WsEvents } from 'masto'
2022-11-16 16:11:08 +00:00
2022-12-27 22:18:16 +00:00
const {
paginator,
stream,
keyProp = 'id',
virtualScroller = false,
eventType = 'update',
buffer = 10,
2022-12-27 22:18:16 +00:00
preprocess,
} = defineProps<{
paginator: Paginator<T[], O>
keyProp?: keyof T
2022-11-28 13:14:27 +00:00
virtualScroller?: boolean
stream?: Promise<WsEvents>
eventType?: 'notification' | 'update'
// When preprocess is used, buffer is the number of items that will be hidden
// until the next pagination to avoid border effect between pages when reordering
// and grouping items
buffer?: number
preprocess?: (items: T[]) => U[]
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: {
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
}
items: {
items: U[]
2022-11-27 08:54:00 +00:00
}
updater: {
number: number
update: () => void
}
2022-11-27 08:54:00 +00:00
loading: {}
done: {}
2022-11-27 08:54:00 +00:00
}>()
const { t } = useI18n()
2022-12-27 17:47:05 +00:00
const { items, prevItems, update, state, endAnchor, error } = usePaginator(paginator, stream, eventType, preprocess)
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
:key="item[keyProp]"
2022-12-27 22:18:16 +00:00
:item="item"
:active="active"
:older="items[index + 1]"
:newer="items[index - 1]"
:index="index"
:items="items"
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"
:key="(item as any)[keyProp]"
2022-11-30 00:47:54 +00:00
:item="item"
:older="items[index + 1]"
:newer="items[index - 1]"
:index="index"
:items="items"
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>
<slot v-else-if="state === 'done'" name="done">
<div p5 text-secondary italic text-center>
{{ t('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>