mirror of
https://git.joinfirefish.org/firefish/firefish.git
synced 2024-05-19 17:11:12 +02:00
536 lines
12 KiB
Vue
536 lines
12 KiB
Vue
<template>
|
|
<transition
|
|
:name="defaultStore.state.animation ? 'fade' : ''"
|
|
mode="out-in"
|
|
>
|
|
<MkLoading v-if="fetching" />
|
|
|
|
<MkError v-else-if="error" @retry="init()" />
|
|
|
|
<div v-else-if="empty" key="_empty_" class="empty">
|
|
<slot name="empty">
|
|
<div class="_fullinfo">
|
|
<img
|
|
src="/static-assets/badges/info.webp"
|
|
class="_ghost"
|
|
alt="Error"
|
|
/>
|
|
<div>{{ i18n.ts.nothing }}</div>
|
|
</div>
|
|
</slot>
|
|
</div>
|
|
|
|
<div v-else ref="rootEl" class="list">
|
|
<div
|
|
v-show="pagination.reversed && more"
|
|
key="_more_"
|
|
class="cxiknjgy _gap"
|
|
>
|
|
<MkButton
|
|
v-if="!moreFetching"
|
|
class="button"
|
|
:disabled="moreFetching"
|
|
:style="{ cursor: moreFetching ? 'wait' : 'pointer' }"
|
|
primary
|
|
@click="fetchMoreAhead"
|
|
>
|
|
{{ i18n.ts.loadMore }}
|
|
</MkButton>
|
|
<MkLoading v-else class="loading" />
|
|
</div>
|
|
<slot :items="items"></slot>
|
|
<div
|
|
v-show="!pagination.reversed && more"
|
|
key="_more_"
|
|
class="cxiknjgy _gap"
|
|
>
|
|
<MkButton
|
|
v-if="!moreFetching"
|
|
v-appear="
|
|
defaultStore.state.enableInfiniteScroll &&
|
|
!disableAutoLoad
|
|
? fetchMore
|
|
: null
|
|
"
|
|
class="button"
|
|
:disabled="moreFetching"
|
|
:style="{ cursor: moreFetching ? 'wait' : 'pointer' }"
|
|
primary
|
|
@click="fetchMore"
|
|
>
|
|
{{ i18n.ts.loadMore }}
|
|
</MkButton>
|
|
<MkLoading v-else class="loading" />
|
|
</div>
|
|
</div>
|
|
</transition>
|
|
</template>
|
|
|
|
<script lang="ts" setup generic="E extends PagingKey">
|
|
import type { ComponentPublicInstance, ComputedRef } from "vue";
|
|
import {
|
|
computed,
|
|
isRef,
|
|
onActivated,
|
|
onDeactivated,
|
|
ref,
|
|
unref,
|
|
watch,
|
|
} from "vue";
|
|
import type { Endpoints, TypeUtils } from "firefish-js";
|
|
import * as os from "@/os";
|
|
import {
|
|
getScrollContainer,
|
|
getScrollPosition,
|
|
isTopVisible,
|
|
onScrollTop,
|
|
} from "@/scripts/scroll";
|
|
import MkButton from "@/components/MkButton.vue";
|
|
import { i18n } from "@/i18n";
|
|
import { defaultStore } from "@/store";
|
|
|
|
/**
|
|
* ref type of MkPagination<E>
|
|
* Due to Vue's incomplete type support for generic components,
|
|
* we have to manually maintain this type instead of
|
|
* using `InstanceType<typeof MkPagination>`
|
|
*/
|
|
export type MkPaginationType<
|
|
E extends PagingKey,
|
|
Item = Endpoints[E]["res"][number],
|
|
> = ComponentPublicInstance & {
|
|
items: Item[];
|
|
queue: Item[];
|
|
backed: boolean;
|
|
reload: () => Promise<void>;
|
|
refresh: () => Promise<void>;
|
|
prepend: (item: Item) => Promise<void>;
|
|
append: (item: Item) => Promise<void>;
|
|
removeItem: (finder: (item: Item) => boolean) => boolean;
|
|
updateItem: (id: string, replacer: (old: Item) => Item) => boolean;
|
|
};
|
|
|
|
export type PagingKeyOf<T> = TypeUtils.EndpointsOf<T[]>;
|
|
// biome-ignore lint/suspicious/noExplicitAny: Used Intentionally
|
|
export type PagingKey = PagingKeyOf<any>;
|
|
|
|
export interface Paging<E extends PagingKey = PagingKey> {
|
|
endpoint: E;
|
|
limit: number;
|
|
params?: Endpoints[E]["req"] | ComputedRef<Endpoints[E]["req"]>;
|
|
|
|
/**
|
|
* 検索APIのような、ページング不可なエンドポイントを利用する場合
|
|
* (そのようなAPIをこの関数で使うのは若干矛盾してるけど)
|
|
*/
|
|
noPaging?: boolean;
|
|
|
|
/**
|
|
* items 配列の中身を逆順にする(新しい方が最後)
|
|
*/
|
|
reversed?: boolean;
|
|
|
|
/**
|
|
* For not-reversed, not-offsetMode,
|
|
* Sort by id in ascending order
|
|
*/
|
|
ascending?: boolean;
|
|
|
|
offsetMode?: boolean;
|
|
}
|
|
|
|
export type PagingOf<T> = Paging<TypeUtils.EndpointsOf<T[]>>;
|
|
|
|
const SECOND_FETCH_LIMIT = 30;
|
|
|
|
const props = withDefaults(
|
|
defineProps<{
|
|
pagination: Paging<E>;
|
|
disableAutoLoad?: boolean;
|
|
displayLimit?: number;
|
|
}>(),
|
|
{
|
|
displayLimit: 30,
|
|
},
|
|
);
|
|
|
|
const slots = defineSlots<{
|
|
default(props: { items: Item[] }): unknown;
|
|
empty(props: Record<string, never>): never;
|
|
}>();
|
|
|
|
const emit = defineEmits<{
|
|
(ev: "queue", count: number): void;
|
|
(ev: "status", hasError: boolean): void;
|
|
}>();
|
|
|
|
type Param = Endpoints[E]["req"] | Record<string, never>;
|
|
type Item = Endpoints[E]["res"][number];
|
|
|
|
const rootEl = ref<HTMLElement>();
|
|
const items = ref<Item[]>([]);
|
|
const queue = ref<Item[]>([]);
|
|
const offset = ref(0);
|
|
const fetching = ref(true);
|
|
const moreFetching = ref(false);
|
|
const more = ref(false);
|
|
const backed = ref(false); // 遡り中か否か
|
|
const isBackTop = ref(false);
|
|
const empty = computed(() => items.value.length === 0);
|
|
const error = ref(false);
|
|
|
|
const init = async (): Promise<void> => {
|
|
queue.value = [];
|
|
fetching.value = true;
|
|
|
|
const params = props.pagination.params ? unref(props.pagination.params) : {};
|
|
await os
|
|
.api(props.pagination.endpoint, {
|
|
...params,
|
|
limit: props.pagination.noPaging
|
|
? props.pagination.limit || 10
|
|
: (props.pagination.limit || 10) + 1,
|
|
...(props.pagination.ascending
|
|
? {
|
|
// An initial value smaller than all possible ids must be filled in here.
|
|
sinceId: "0",
|
|
}
|
|
: {}),
|
|
})
|
|
.then(
|
|
(res: Item[]) => {
|
|
for (let i = 0; i < res.length; i++) {
|
|
const item = res[i];
|
|
if (props.pagination.reversed) {
|
|
if (i === res.length - 2) item._shouldInsertAd_ = true;
|
|
} else {
|
|
if (i === 3) item._shouldInsertAd_ = true;
|
|
}
|
|
}
|
|
if (
|
|
!props.pagination.noPaging &&
|
|
res.length > (props.pagination.limit || 10)
|
|
) {
|
|
res.pop();
|
|
items.value = props.pagination.reversed ? res.toReversed() : res;
|
|
more.value = true;
|
|
} else {
|
|
items.value = props.pagination.reversed ? res.toReversed() : res;
|
|
more.value = false;
|
|
}
|
|
offset.value = res.length;
|
|
error.value = false;
|
|
fetching.value = false;
|
|
},
|
|
(_err) => {
|
|
error.value = true;
|
|
fetching.value = false;
|
|
},
|
|
);
|
|
};
|
|
|
|
const reload = (): Promise<void> => {
|
|
items.value = [];
|
|
return init();
|
|
};
|
|
|
|
const refresh = async (): Promise<void> => {
|
|
const params = props.pagination.params ? unref(props.pagination.params) : {};
|
|
await os
|
|
.api(props.pagination.endpoint, {
|
|
...params,
|
|
limit: items.value.length + 1,
|
|
offset: 0,
|
|
})
|
|
.then(
|
|
(res: Item[]) => {
|
|
const ids = items.value.reduce(
|
|
(a, b) => {
|
|
a[b.id] = true;
|
|
return a;
|
|
},
|
|
{} as Record<string, boolean>,
|
|
);
|
|
|
|
for (let i = 0; i < res.length; i++) {
|
|
const item = res[i];
|
|
if (!updateItem(item.id, (_old) => item)) {
|
|
append(item);
|
|
}
|
|
delete ids[item.id];
|
|
}
|
|
|
|
for (const id in ids) {
|
|
removeItem((i) => i.id === id);
|
|
}
|
|
},
|
|
(_err) => {
|
|
error.value = true;
|
|
fetching.value = false;
|
|
},
|
|
);
|
|
};
|
|
|
|
const fetchMore = async (): Promise<void> => {
|
|
if (
|
|
!more.value ||
|
|
fetching.value ||
|
|
moreFetching.value ||
|
|
items.value.length === 0
|
|
)
|
|
return;
|
|
moreFetching.value = true;
|
|
backed.value = true;
|
|
const params = props.pagination.params ? unref(props.pagination.params) : {};
|
|
await os
|
|
.api(props.pagination.endpoint, {
|
|
...params,
|
|
limit: SECOND_FETCH_LIMIT + 1,
|
|
...(props.pagination.offsetMode
|
|
? {
|
|
offset: offset.value,
|
|
}
|
|
: props.pagination.reversed
|
|
? {
|
|
sinceId: items.value[0].id,
|
|
}
|
|
: props.pagination.ascending
|
|
? {
|
|
sinceId: items.value[items.value.length - 1].id,
|
|
}
|
|
: {
|
|
untilId: items.value[items.value.length - 1].id,
|
|
}),
|
|
})
|
|
.then(
|
|
(res: Item[]) => {
|
|
for (let i = 0; i < res.length; i++) {
|
|
const item = res[i];
|
|
if (props.pagination.reversed) {
|
|
if (i === res.length - 9) item._shouldInsertAd_ = true;
|
|
} else {
|
|
if (i === 10) item._shouldInsertAd_ = true;
|
|
}
|
|
}
|
|
if (res.length > SECOND_FETCH_LIMIT) {
|
|
res.pop();
|
|
items.value = props.pagination.reversed
|
|
? res.toReversed().concat(items.value)
|
|
: items.value.concat(res);
|
|
more.value = true;
|
|
} else {
|
|
items.value = props.pagination.reversed
|
|
? res.toReversed().concat(items.value)
|
|
: items.value.concat(res);
|
|
more.value = false;
|
|
}
|
|
offset.value += res.length;
|
|
moreFetching.value = false;
|
|
},
|
|
(_err) => {
|
|
moreFetching.value = false;
|
|
},
|
|
);
|
|
};
|
|
|
|
const fetchMoreAhead = async (): Promise<void> => {
|
|
if (
|
|
!more.value ||
|
|
fetching.value ||
|
|
moreFetching.value ||
|
|
items.value.length === 0
|
|
)
|
|
return;
|
|
moreFetching.value = true;
|
|
const params = props.pagination.params ? unref(props.pagination.params) : {};
|
|
await os
|
|
.api(props.pagination.endpoint, {
|
|
...params,
|
|
limit: SECOND_FETCH_LIMIT + 1,
|
|
...(props.pagination.offsetMode
|
|
? {
|
|
offset: offset.value,
|
|
}
|
|
: props.pagination.reversed
|
|
? {
|
|
untilId: items.value[0].id,
|
|
}
|
|
: {
|
|
sinceId: items.value[items.value.length - 1].id,
|
|
}),
|
|
})
|
|
.then(
|
|
(res: Item[]) => {
|
|
if (res.length > SECOND_FETCH_LIMIT) {
|
|
res.pop();
|
|
items.value = props.pagination.reversed
|
|
? res.toReversed().concat(items.value)
|
|
: items.value.concat(res);
|
|
more.value = true;
|
|
} else {
|
|
items.value = props.pagination.reversed
|
|
? res.toReversed().concat(items.value)
|
|
: items.value.concat(res);
|
|
more.value = false;
|
|
}
|
|
offset.value += res.length;
|
|
moreFetching.value = false;
|
|
},
|
|
(_err) => {
|
|
moreFetching.value = false;
|
|
},
|
|
);
|
|
};
|
|
|
|
const prepend = (item: Item): void => {
|
|
if (props.pagination.reversed) {
|
|
if (rootEl.value) {
|
|
const container = getScrollContainer(rootEl.value);
|
|
if (container == null) {
|
|
// TODO?
|
|
} else {
|
|
const pos = getScrollPosition(rootEl.value);
|
|
const viewHeight = container.clientHeight;
|
|
const height = container.scrollHeight;
|
|
const isBottom = pos + viewHeight > height - 32;
|
|
if (isBottom) {
|
|
// オーバーフローしたら古いアイテムは捨てる
|
|
if (items.value.length >= props.displayLimit) {
|
|
// このやり方だとVue 3.2以降アニメーションが動かなくなる
|
|
// items.value = items.value.slice(-props.displayLimit);
|
|
while (items.value.length >= props.displayLimit) {
|
|
items.value.shift();
|
|
}
|
|
more.value = true;
|
|
}
|
|
}
|
|
}
|
|
}
|
|
items.value.push(item);
|
|
// TODO
|
|
} else {
|
|
// 初回表示時はunshiftだけでOK
|
|
if (!rootEl.value) {
|
|
items.value.unshift(item);
|
|
return;
|
|
}
|
|
|
|
const isTop =
|
|
isBackTop.value ||
|
|
(document.body.contains(rootEl.value) && isTopVisible(rootEl.value));
|
|
|
|
if (isTop) {
|
|
// Prepend the item
|
|
items.value.unshift(item);
|
|
|
|
// オーバーフローしたら古いアイテムは捨てる
|
|
if (items.value.length >= props.displayLimit) {
|
|
// このやり方だとVue 3.2以降アニメーションが動かなくなる
|
|
// this.items = items.value.slice(0, props.displayLimit);
|
|
while (items.value.length >= props.displayLimit) {
|
|
items.value.pop();
|
|
}
|
|
more.value = true;
|
|
}
|
|
} else {
|
|
queue.value.push(item);
|
|
onScrollTop(rootEl.value, () => {
|
|
for (const queueItem of queue.value) {
|
|
prepend(queueItem);
|
|
}
|
|
queue.value = [];
|
|
});
|
|
}
|
|
}
|
|
};
|
|
|
|
const append = (item: Item): void => {
|
|
items.value.push(item);
|
|
};
|
|
|
|
const removeItem = (finder: (item: Item) => boolean): boolean => {
|
|
const i = items.value.findIndex(finder);
|
|
if (i === -1) {
|
|
return false;
|
|
}
|
|
|
|
items.value.splice(i, 1);
|
|
return true;
|
|
};
|
|
|
|
const updateItem = (id: Item["id"], replacer: (old: Item) => Item): boolean => {
|
|
const i = items.value.findIndex((item) => item.id === id);
|
|
if (i === -1) {
|
|
return false;
|
|
}
|
|
|
|
items.value[i] = replacer(items.value[i]);
|
|
return true;
|
|
};
|
|
|
|
if (props.pagination.params && isRef<Param>(props.pagination.params)) {
|
|
watch(props.pagination.params, init, { deep: true });
|
|
}
|
|
|
|
watch(
|
|
queue,
|
|
(a, b) => {
|
|
if (a.length === 0 && b.length === 0) return;
|
|
emit("queue", queue.value.length);
|
|
},
|
|
{ deep: true },
|
|
);
|
|
|
|
watch(error, (n, o) => {
|
|
if (n === o) return;
|
|
emit("status", n);
|
|
});
|
|
|
|
init();
|
|
|
|
onActivated(() => {
|
|
isBackTop.value = false;
|
|
});
|
|
|
|
onDeactivated(() => {
|
|
isBackTop.value = window.scrollY === 0;
|
|
});
|
|
|
|
defineExpose({
|
|
items,
|
|
queue,
|
|
backed,
|
|
reload,
|
|
refresh,
|
|
prepend,
|
|
append,
|
|
removeItem,
|
|
updateItem,
|
|
});
|
|
</script>
|
|
|
|
<style lang="scss" scoped>
|
|
.fade-enter-active,
|
|
.fade-leave-active {
|
|
transition: opacity 0.125s ease;
|
|
}
|
|
.fade-enter-from,
|
|
.fade-leave-to {
|
|
opacity: 0;
|
|
}
|
|
|
|
.cxiknjgy {
|
|
> .button {
|
|
margin-left: auto;
|
|
margin-right: auto;
|
|
}
|
|
}
|
|
.list > :deep(._button) {
|
|
margin-inline: auto;
|
|
margin-bottom: 16px;
|
|
&:last-of-type:not(:first-child) {
|
|
margin-top: 16px;
|
|
}
|
|
}
|
|
</style>
|