Feat(initial view)

examples/snowbox/index.js

@@ -14,6 +14,7 @@
 import pluginFullscreen from '@polar/polar/plugins/fullscreen'
 import pluginGeoLocation from '@polar/polar/plugins/geoLocation'
 import pluginIconMenu from '@polar/polar/plugins/iconMenu'
+import pluginInitialView from '@polar/polar/plugins/initialView'
 import pluginLayerChooser from '@polar/polar/plugins/layerChooser'
 import pluginLoadingIndicator from '@polar/polar/plugins/loadingIndicator'
 import pluginPins from '@polar/polar/plugins/pins'
@@ -93,7 +94,7 @@
 		colorScheme,
 		startCenter: [565874, 5934140],
 		layers: [
 			// TODO: Add internalization to snowbox
 			{
 				id: basemapId,
 				visibility: true,
@@ -500,6 +501,11 @@
 					disabledOnMobile: true,
 					icon: 'kern-icon-fill--assistant-direction',
 				},
+				{
+					plugin: pluginInitialView({
+						renderType: 'iconMenu',
+					}),
+				},
 			],
 			[
 				{

src/client.ts

@@ -15,6 +15,7 @@ import AddressSearch from '@/plugins/addressSearch'
 import Fullscreen from '@/plugins/fullscreen'
 import GeoLocation from '@/plugins/geoLocation'
 import IconMenu from '@/plugins/iconMenu'
+import ReturnToInitialView from '@/plugins/initialView'
 import LayerChooser from '@/plugins/layerChooser'
 import LoadingIndicator from '@/plugins/loadingIndicator'
 import Pins from '@/plugins/pins'
@@ -62,6 +63,12 @@ function addPlugins(map: typeof PolarContainer, enabledPlugins: string[]) {
 				displayComponent: true,
 				layoutTag: 'MIDDLE_MIDDLE',
 			}),
+			enabledPlugins.includes('returnToInitialView') &&
+				ReturnToInitialView({
+					displayComponent: true,
+					layoutTag: 'TOP_RIGHT',
+					renderType: 'iconMenu',
+				}),
 			enabledPlugins.includes('pointerPosition') &&
 				PointerPosition({
 					displayComponent: true,

src/core/types/main.ts

@@ -7,6 +7,7 @@
 import type { FullscreenPluginOptions } from '@/plugins/fullscreen'
 import type { GeoLocationPluginOptions } from '@/plugins/geoLocation'
 import type { IconMenuPluginOptions } from '@/plugins/iconMenu'
+import type { InitialViewPluginOptions } from '@/plugins/initialView'
 import type { LoadingIndicatorOptions } from '@/plugins/loadingIndicator'
 import type { PinsPluginOptions } from '@/plugins/pins'
 import type { PointerPositionPluginOptions } from '@/plugins/pointerPosition'
@@ -316,7 +317,7 @@
 
 	// Plugins are not sorted alphabetical, but listed last.
 	// Remember to sort them alphabetical inside their space.
 	// TODO: Generate this section via types/plugin.ts
 	/* eslint-disable perfectionist/sort-interfaces */
 
 	/** Configuration for addressSearch plugin. */
@@ -343,6 +344,9 @@
 	/** Configuration for iconMenu plugin. */
 	iconMenu?: IconMenuPluginOptions
 
+	/** Configuration for iInitialView plugin. */
+	returnToInitialView?: InitialViewPluginOptions
+
 	/** Configuration for loadingIndicator plugin. */
 	loadingIndicator?: LoadingIndicatorOptions
 

src/core/types/plugin.ts

@@ -25,6 +25,9 @@
 import type { PluginId as IconMenuPluginId } from '@/plugins/iconMenu'
 import type { resourcesEn as IconMenuResources } from '@/plugins/iconMenu/locales'
 import type { useIconMenuStore as IconMenuStore } from '@/plugins/iconMenu/store'
+import type { PluginId as ReturnToInitialViewPluginId } from '@/plugins/initialView'
+import type { resourcesEn as ReturnToInitialViewResources } from '@/plugins/initialView/locales'
+import type { useInitialViewStore as ReturnToInitialViewStore } from '@/plugins/initialView/store'
 import type { PluginId as LayerChooserPluginId } from '@/plugins/layerChooser'
 import type { resourcesEn as LayerChooserResources } from '@/plugins/layerChooser/locales'
 import type { useLayerChooserStore as LayerChooserStore } from '@/plugins/layerChooser/store'
@@ -153,6 +156,7 @@
 	| typeof LoadingIndicatorId
 	| typeof PinsPluginId
 	| typeof PointerPositionPluginId
+	| typeof ReturnToInitialViewPluginId
 	| typeof ReverseGeocoderPluginId
 	| typeof RoutingPluginId
 	| typeof ScalePluginId
@@ -162,7 +166,7 @@
 type GetPluginStore<
 	T extends BundledPluginId,
 	I extends BundledPluginId,
 	// TODO: This fixes the type error, but relaxes type-checking for the plugin store too much.
 	// However, it is not clear if Pinia's type system allows for stronger checks at the moment.
 	// eslint-disable-next-line @typescript-eslint/no-explicit-any
 	S extends PolarPluginStore<any>,
@@ -186,6 +190,11 @@
 			typeof PointerPositionPluginId,
 			typeof PointerPositionStore
 	  >
+	| GetPluginStore<
+			T,
+			typeof ReturnToInitialViewPluginId,
+			typeof ReturnToInitialViewStore
+	  >
 	| GetPluginStore<
 			T,
 			typeof ReverseGeocoderPluginId,
@@ -235,6 +244,11 @@
 			typeof PointerPositionPluginId,
 			typeof PointerPositionResources
 	  >
+	| GetPluginResources<
+			T,
+			typeof ReturnToInitialViewPluginId,
+			typeof ReturnToInitialViewResources
+	  >
 	| GetPluginResources<T, typeof RoutingPluginId, typeof RoutingResources>
 	| GetPluginResources<T, typeof ScalePluginId, typeof ScaleResources>
 	| GetPluginResources<T, typeof ToastPluginId, typeof ToastResources>

src/plugins/initialView/components/ReturnToInitialView.ce.vue

@@ -0,0 +1,21 @@
+<template>
+	<PolarIconButton
+		:hint="$t(($) => $.label.return, { ns: PluginId })"
+		icon="kern-icon--home"
+		tooltip-position="left"
+		@click="onClick"
+	/>
+</template>
+
+<script setup lang="ts">
+import PolarIconButton from '@/components/PolarIconButton.ce.vue'
+
+import { useInitialViewStore } from '../store'
+import { PluginId } from '../types'
+
+const InitialViewStore = useInitialViewStore()
+
+function onClick() {
+	InitialViewStore.returnToInitialView()
+}
+</script>

src/plugins/initialView/index.ts

@@ -0,0 +1,32 @@
+/* eslint-disable tsdoc/syntax */
+/**
+ * @module @polar/polar/plugins/returnToInitialView
+ */
+/* eslint-enable tsdoc/syntax */
+
+import type { PluginContainer, PolarPluginStore } from '@/core'
+import type { InitialViewPluginOptions } from './types'
+
+import component from './components/ReturnToInitialView.ce.vue'
+import locales from './locales'
+import { useInitialViewStore } from './store'
+import { PluginId } from './types'
+
+/**
+ * Creates a plugin which offers a button to return to the map's start view.
+ *
+ * @returns Plugin for use with {@link addPlugin}.
+ */
+export default function pluginInitialView(
+	options: InitialViewPluginOptions = {}
+): PluginContainer {
+	return {
+		id: PluginId,
+		component,
+		locales,
+		storeModule: useInitialViewStore as PolarPluginStore,
+		options,
+	}
+}
+
+export * from './types'

src/plugins/initialView/locales.ts

@@ -0,0 +1,34 @@
+/* eslint-disable tsdoc/syntax */
+/**
+ * @module locales/plugins/returnToInitialView
+ */
+/* eslint-enable tsdoc/syntax */
+
+import type { Locale } from '@/core'
+
+export const resourcesDe = {
+	title: 'Zur Startansicht',
+	label: {
+		return: 'Zurück zur Startansicht',
+	},
+} as const
+
+export const resourcesEn = {
+	title: 'Return to Start View',
+	label: {
+		return: 'Return to start view',
+	},
+} as const
+
+const locales: Locale[] = [
+	{
+		type: 'de',
+		resources: resourcesDe,
+	},
+	{
+		type: 'en',
+		resources: resourcesEn,
+	},
+]
+
+export default locales

src/plugins/initialView/store.ts

@@ -0,0 +1,49 @@
+import { defineStore } from 'pinia'
+import { ref } from 'vue'
+
+import { useCoreStore } from '@/core/stores'
+
+export const useInitialViewStore = defineStore('plugins/initialView', () => {
+	const coreStore = useCoreStore()
+
+	const viewCenter = coreStore.map.getView().getCenter() as
+		[number, number] | undefined
+	const viewResolution = coreStore.map.getView().getResolution()
+
+	const initialCenter = coreStore.configuration.returnToInitialView
+		?.startCenter ??
+		viewCenter ?? [0, 0]
+
+	const initialResolution =
+		coreStore.configuration.returnToInitialView?.startResolution ??
+		viewResolution ??
+		1
+
+	const startCenter = ref(initialCenter)
+	const startResolution = ref(initialResolution)
+
+	function returnToInitialView() {
+		coreStore.map.getView().setCenter(startCenter.value)
+		coreStore.map.getView().setResolution(startResolution.value)
+	}
+
+	function setupPlugin() {
+		const options = coreStore.configuration.returnToInitialView
+		if (options?.startCenter) {
+			startCenter.value = options.startCenter
+		}
+		if (options?.startResolution) {
+			startResolution.value = options.startResolution
+		}
+	}
+
+	function teardownPlugin() {}
+
+	return {
+		startCenter,
+		startResolution,
+		returnToInitialView,
+		setupPlugin,
+		teardownPlugin,
+	}
+})

src/plugins/initialView/types.ts

@@ -0,0 +1,15 @@
+/**
+ * Defines if the geoLocation button is rendered independent or as part of the
+ * icon menu.
+ * @defaultValue `'independent'`
+ */
+
+import type { PluginOptions } from '@/core'
+
+export const PluginId = 'initialView' as const
+
+export interface InitialViewPluginOptions extends PluginOptions {
+	renderType?: 'independent' | 'iconMenu'
+	startCenter?: [number, number]
+	startResolution?: number
+}