Merge pull request 'Add hints for clips, antennas, lists, and timelines' (#10226) from Freeplay/calckey:hints into develop

Reviewed-on: https://codeberg.org/calckey/calckey/pulls/10226

locales/en-US.yml

@@ -83,6 +83,7 @@ exportRequested: "You've requested an export. This may take a while. It will be
   \ to your Drive once completed."
 importRequested: "You've requested an import. This may take a while."
 lists: "Lists"
+listsDesc: "Lists let you create timelines with specified users. They can be accessed from the timelines page."
 noLists: "You don't have any lists"
 note: "Post"
 notes: "Posts"
@@ -405,6 +406,7 @@ avoidMultiCaptchaConfirm: "Using multiple Captcha systems may cause interference
   \ them. Would you like to disable the other Captcha systems currently active? If\
   \ you would like them to stay enabled, press cancel."
 antennas: "Antennas"
+antennasDesc: "Antennas display new posts matching the criteria you set!\n They can be accessed from the timelines page."
 manageAntennas: "Manage Antennas"
 name: "Name"
 antennaSource: "Antenna source"
@@ -686,6 +688,7 @@ logs: "Logs"
 delayed: "Delayed"
 database: "Database"
 channel: "Channels"
+channelFederationWarn: "Channels do not yet federate to other servers"
 create: "Create"
 notificationSetting: "Notification settings"
 notificationSettingDesc: "Select the types of notification to display."
@@ -771,6 +774,7 @@ pageLikedCount: "Number of received Page likes"
 contact: "Contact"
 useSystemFont: "Use the system's default font"
 clips: "Clips"
+clipsDesc: "Clips are like share-able categorized bookmarks. You can create clips from the menu of individual posts."
 experimentalFeatures: "Experimental features"
 developer: "Developer"
 makeExplorable: "Make account visible in \"Explore\""

packages/client/src/components/MkInfo.vue

@@ -1,21 +1,39 @@
 <template>
-	<div class="fpezltsf" :class="{ warn }">
+	<div v-if="visible" class="info" :class="{ warn, card }">
 		<i v-if="warn" class="ph-warning ph-bold ph-lg"></i>
-		<i v-else class="ph-info ph-bold ph-lg"></i>
+		<i v-else class="ph-bold ph-lg" :class="icon ? `ph-${icon}` : 'ph-info'"></i>
 		<slot></slot>
+		<button v-if="closeable" class="_button close" @click.stop="close">
+			<i class="ph-x ph-bold ph-lg"></i>
+		</button>
 	</div>
 </template>
 
 <script lang="ts" setup>
-import {} from "vue";
+import { ref } from "vue";
+
+const visible = ref(true);
 
 defineProps<{
+	icon?: string;
 	warn?: boolean;
+	card?: boolean;
+	closeable?: boolean;
 }>();
+
+const emit = defineEmits<{
+	(ev: "close"): void;
+}>();
+
+function close() {
+	visible.value = false;
+	emit("close");
+}
+
 </script>
 
 <style lang="scss" scoped>
-.fpezltsf {
+.info {
 	padding: 16px;
 	font-size: 90%;
 	background: var(--infoBg);
@@ -27,8 +45,34 @@ defineProps<{
 		color: var(--infoWarnFg);
 	}
 
+	&.card {
+		background: var(--panel);
+		color: var(--fg);
+		padding: 48px;
+		font-size: 1em;
+		text-align: center;
+		> i {
+			display: block;
+			font-size: 4em;
+			margin: 0;
+		}
+		> :deep(*) {
+			margin-inline: auto;
+		}
+		> :deep(:not(:last-child)) {
+			margin-bottom: 20px;
+		}
+		> :deep(p) {
+			max-width: 30em;
+		}
+	}
+
 	> i {
 		margin-right: 4px;
 	}
+	> .close {
+		margin-left: auto;
+		float: right;
+	}
 }
 </style>

packages/client/src/components/MkPagination.vue

@@ -17,7 +17,7 @@
 			</slot>
 		</div>
 
-		<div v-else ref="rootEl">
+		<div v-else ref="rootEl" class="list">
 			<div
 				v-show="pagination.reversed && more"
 				key="_more_"
@@ -487,4 +487,11 @@ defineExpose({
 		margin-right: auto;
 	}
 }
+.list > :deep(._button) {
+	margin-inline: auto;
+	margin-bottom: 16px;
+	&:last-of-type:not(:first-child) {
+		margin-top: 16px;
+	}
+}
 </style>

packages/client/src/components/MkTimeline.vue

@@ -1,4 +1,11 @@
 <template>
+	<MkInfo v-if="tlHint && !tlHintClosed" :closeable="true" class="_gap" @close="closeHint"> 
+		<I18n
+			:src="tlHint"
+		>
+			<template #icon></template>
+		</I18n>
+	</MkInfo>
 	<XNotes
 		ref="tlComponent"
 		:no-gap="!$store.state.showGapBetweenNotesInTimeline"
@@ -10,10 +17,13 @@
 <script lang="ts" setup>
 import { ref, computed, provide, onUnmounted } from "vue";
 import XNotes from "@/components/MkNotes.vue";
+import MkInfo from "@/components/MkInfo.vue";
 import * as os from "@/os";
 import { stream } from "@/stream";
 import * as sound from "@/scripts/sound";
 import { $i } from "@/account";
+import { i18n } from "@/i18n";
+import { defaultStore } from "@/store";
 
 const props = defineProps<{
 	src: string;
@@ -64,6 +74,9 @@ let query;
 let connection;
 let connection2;
 
+let tlHint;
+let tlHintClosed;
+
 if (props.src === "antenna") {
 	endpoint = "antennas/notes";
 	query = {
@@ -81,22 +94,37 @@ if (props.src === "antenna") {
 	connection2 = stream.useChannel("main");
 	connection2.on("follow", onChangeFollowing);
 	connection2.on("unfollow", onChangeFollowing);
+
+	tlHint = i18n.ts._tutorial.step5_3;
+	tlHintClosed = defaultStore.state.tlHomeHintClosed;
 } else if (props.src === "local") {
 	endpoint = "notes/local-timeline";
 	connection = stream.useChannel("localTimeline");
 	connection.on("note", prepend);
+
+	tlHint = i18n.ts._tutorial.step5_4;
+	tlHintClosed = defaultStore.state.tlLocalHintClosed;
 } else if (props.src === "recommended") {
 	endpoint = "notes/recommended-timeline";
 	connection = stream.useChannel("recommendedTimeline");
 	connection.on("note", prepend);
+
+	tlHint = i18n.ts._tutorial.step5_6;
+	tlHintClosed = defaultStore.state.tlRecommendedHintClosed;
 } else if (props.src === "social") {
 	endpoint = "notes/hybrid-timeline";
 	connection = stream.useChannel("hybridTimeline");
 	connection.on("note", prepend);
+
+	tlHint = i18n.ts._tutorial.step5_5;
+	tlHintClosed = defaultStore.state.tlSocialHintClosed;
 } else if (props.src === "global") {
 	endpoint = "notes/global-timeline";
 	connection = stream.useChannel("globalTimeline");
 	connection.on("note", prepend);
+
+	tlHint = i18n.ts._tutorial.step5_7;
+	tlHintClosed = defaultStore.state.tlGlobalHintClosed;
 } else if (props.src === "mentions") {
 	endpoint = "notes/mentions";
 	connection = stream.useChannel("main");
@@ -135,6 +163,26 @@ if (props.src === "antenna") {
 	connection.on("note", prepend);
 }
 
+function closeHint() {
+	switch (props.src) {
+		case 'home':
+			defaultStore.set("tlHomeHintClosed", true);
+			break;
+		case 'local':
+			defaultStore.set("tlLocalHintClosed", true);
+			break;
+		case 'recommended':
+			defaultStore.set("tlRecommendedHintClosed", true);
+			break;
+		case 'social':
+			defaultStore.set("tlSocialHintClosed", true);
+			break;
+		case 'global':
+			defaultStore.set("tlGlobalHintClosed", true);
+			break;
+	}
+}
+
 const pagination = {
 	endpoint: endpoint,
 	limit: 10,

packages/client/src/pages/channels.vue

@@ -7,6 +7,7 @@
 				:tabs="headerTabs"
 		/></template>
 		<MkSpacer :content-max="700">
+			<MkInfo class="_gap" :warn="true">{{ i18n.ts.channelFederationWarn }}</MkInfo>
 			<swiper
 				:round-lengths="true"
 				:touch-angle="25"
@@ -119,6 +120,7 @@ import MkInput from "@/components/form/input.vue";
 import MkRadios from "@/components/form/radios.vue";
 import MkButton from "@/components/MkButton.vue";
 import MkFolder from "@/components/MkFolder.vue";
+import MkInfo from "@/components/MkInfo.vue";
 import { useRouter } from "@/router";
 import { definePageMetadata } from "@/scripts/page-metadata";
 import { deviceKind } from "@/scripts/device-kind";

packages/client/src/pages/my-antennas/create.vue

@@ -1,7 +1,9 @@
 <template>
+	<MkSpacer :content-max="700">
 		<div class="geegznzt">
 			<XAntenna :antenna="draft" @created="onAntennaCreated" />
 		</div>
+	</MkSpacer>
 </template>
 
 <script lang="ts" setup>

packages/client/src/pages/my-antennas/index.vue

@@ -8,6 +8,12 @@
 		/></template>
 		<MkSpacer :content-max="700">
 			<div class="ieepwinx">
+				<MkInfo
+					class="_gap"
+					:icon="'flying-saucer'"
+					:card="true"
+				>
+					<p>{{ i18n.ts.antennasDesc }}</p>
 					<MkButton
 						:link="true"
 						to="/my/antennas/create"
@@ -16,13 +22,13 @@
 						><i class="ph-plus ph-bold ph-lg"></i>
 						{{ i18n.ts.add }}</MkButton
 					>
-
+				</MkInfo>
 				<div class="">
 					<MkPagination
-						v-slot="{ items }"
 						ref="list"
 						:pagination="pagination"
 					>
+						<template #default="{ items }">
 							<div v-for="antenna in items" :key="antenna.id">
 								<MkA
 									class="uopelskx"
@@ -45,6 +51,7 @@
 									<div class="name">{{ antenna.name }}</div>
 								</MkA>
 							</div>
+						</template>
 					</MkPagination>
 				</div>
 			</div>
@@ -56,6 +63,7 @@
 import { onActivated, onDeactivated, ref } from "vue";
 import MkPagination from "@/components/MkPagination.vue";
 import MkButton from "@/components/MkButton.vue";
+import MkInfo from "@/components/MkInfo.vue";
 import { i18n } from "@/i18n";
 import { definePageMetadata } from "@/scripts/page-metadata";
 
@@ -101,10 +109,6 @@ definePageMetadata({
 
 <style lang="scss" scoped>
 .ieepwinx {
-	> .add {
-		margin: 0 auto 16px auto;
-	}
-
 	.uopelskx {
 		float: left;
 		min-width: 25px;

packages/client/src/pages/my-clips/index.vue

@@ -8,17 +8,20 @@
 		/></template>
 		<MkSpacer :content-max="700">
 			<div class="qtcaoidl">
-				<MkButton primary class="add" @click="create"
-					><i class="ph-plus ph-bold ph-lg"></i>
-					{{ i18n.ts.add }}</MkButton
-				>
-
 				<MkPagination
-					v-slot="{ items }"
 					ref="pagingComponent"
 					:pagination="pagination"
 					class="list"
 				>
+					<template #empty>
+						<MkInfo
+							:icon="'paperclip'"
+							:card="true"
+						>
+							<p>{{ i18n.ts.clipsDesc }}</p>
+						</MkInfo>
+					</template>
+					<template #default="{ items }">
 						<MkA
 							v-for="item in items"
 							:key="item.id"
@@ -30,6 +33,7 @@
 								{{ item.description }}
 							</div>
 						</MkA>
+					</template>
 				</MkPagination>
 			</div>
 		</MkSpacer>
@@ -40,6 +44,7 @@
 import {} from "vue";
 import MkPagination from "@/components/MkPagination.vue";
 import MkButton from "@/components/MkButton.vue";
+import MkInfo from "@/components/MkInfo.vue";
 import * as os from "@/os";
 import { i18n } from "@/i18n";
 import { definePageMetadata } from "@/scripts/page-metadata";
@@ -100,10 +105,6 @@ definePageMetadata({
 
 <style lang="scss" scoped>
 .qtcaoidl {
-	> .add {
-		margin: 0 auto 16px auto;
-	}
-
 	> .list {
 		> .item {
 			display: block;

packages/client/src/pages/my-lists/index.vue

@@ -8,16 +8,17 @@
 		/></template>
 		<MkSpacer :content-max="700">
 			<div class="qkcjvfiv">
-				<div class="buttonWrapper">
+				<MkInfo
+					class="_gap"
+					:icon="'list-bullets'"
+					:card="true"
+				>
+					<p>{{ i18n.ts.listsDesc }}</p>
 					<MkButton primary class="add" @click="create"
 						><i class="ph-plus ph-bold ph-lg"></i>
 						{{ i18n.ts.createList }}</MkButton
 					>
-					<MkButton @click="deleteAll"
-						><i class="ph-trash ph-bold ph-lg"></i>
-						{{ i18n.ts.deleteAll }}</MkButton
-					>
-				</div>
+				</MkInfo>
 
 				<MkPagination
 					v-slot="{ items }"
@@ -34,6 +35,10 @@
 						<div class="name">{{ list.name }}</div>
 						<MkAvatars :user-ids="list.userIds" />
 					</MkA>
+					<MkButton @click="deleteAll"
+						><i class="ph-trash ph-bold ph-lg"></i>
+						{{ i18n.ts.deleteAll }}</MkButton
+					>
 				</MkPagination>
 			</div>
 		</MkSpacer>
@@ -45,6 +50,7 @@ import {} from "vue";
 import MkPagination from "@/components/MkPagination.vue";
 import MkButton from "@/components/MkButton.vue";
 import MkAvatars from "@/components/MkAvatars.vue";
+import MkInfo from "@/components/MkInfo.vue";
 import * as os from "@/os";
 import { i18n } from "@/i18n";
 import { definePageMetadata } from "@/scripts/page-metadata";
@@ -92,15 +98,6 @@ definePageMetadata({
 
 <style lang="scss" scoped>
 .qkcjvfiv {
-	> .buttonWrapper {
-		display: grid;
-		justify-content: center;
-
-		> .add {
-			margin: 0 auto var(--margin) auto;
-		}
-	}
-
 	> .lists {
 		> .list {
 			display: block;

packages/client/src/store.ts

@@ -26,6 +26,26 @@ export const defaultStore = markRaw(
 			where: "account",
 			default: 0,
 		},
+		tlHomeHintClosed: {
+			where: "device",
+			default: false,
+		},
+		tlLocalHintClosed: {
+			where: "device",
+			default: false,
+		},
+		tlRecommendedHintClosed: {
+			where: "device",
+			default: false,
+		},
+		tlSocialHintClosed: {
+			where: "device",
+			default: false,
+		},
+		tlGlobalHintClosed: {
+			where: "device",
+			default: false,
+		},
 		keepCw: {
 			where: "account",
 			default: true,

packages/client/src/style.scss

@@ -303,6 +303,9 @@ hr {
 
 ._gap {
 	margin: var(--margin) 0;
+	&:first-child {
+		margin-top: 0;
+	}
 }
 
 // TODO: 廃止