Feat(initial view) - #909
Open
LivMoeser wants to merge 9 commits into
Open
Conversation
Co-authored-by: joselin.guevarahoppe@dataport.de
LivMoeser
requested review from
czirkelbach,
dopenguin,
oeninghe-dataport,
raschju and
warm-coolguy
as code owners
July 30, 2026 11:19
Collaborator
|
I changed the base branch to |
Collaborator
|
Please add another commit here to trigger the creation of the PR preview @LivMoeser |
dopenguin
removed request for
czirkelbach,
oeninghe-dataport,
raschju and
warm-coolguy
July 30, 2026 15:14
dopenguin
requested changes
Jul 31, 2026
Comment on lines
+1
to
+6
| /** | ||
| * Defines if the geoLocation button is rendered independent or as part of the | ||
| * icon menu. | ||
| * @defaultValue `'independent'` | ||
| */ | ||
|
|
Member
There was a problem hiding this comment.
Suggested change
| /** | |
| * Defines if the geoLocation button is rendered independent or as part of the | |
| * icon menu. | |
| * @defaultValue `'independent'` | |
| */ |
Comment on lines
+11
to
+15
| export interface InitialViewPluginOptions extends PluginOptions { | ||
| renderType?: 'independent' | 'iconMenu' | ||
| startCenter?: [number, number] | ||
| startResolution?: number | ||
| } |
Member
There was a problem hiding this comment.
- InitialView: Add plugin with a button to return to the initial map view #893 describes that the plugin should not receive any additional configuration options beside
renderType. - A similar TSDoc comment for
renderTypelike inGeoLocationPluginOptionsshould be added here. startCenteris a required configuration option. Thus, it can always be retrieved fromcoreStore.configuration.startCenterstartResolutionis an optional configuration option but it has a default value. Thusm it can always safely be retrieved fromcoreStore.configuration.startResolution
Comment on lines
+28
to
+30
| 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' |
Member
There was a problem hiding this comment.
The names should reflect the name of the plugin. Thus, dropping the ReturnTo is the way forward.
| import { useInitialViewStore } from '../store' | ||
| import { PluginId } from '../types' | ||
|
|
||
| const InitialViewStore = useInitialViewStore() |
Member
There was a problem hiding this comment.
Classes, components and types / interfaces are commonly using PascalCase while other variables are using camelCase.
| :hint="$t(($) => $.label.return, { ns: PluginId })" | ||
| icon="kern-icon--home" | ||
| tooltip-position="left" | ||
| @click="onClick" |
Member
There was a problem hiding this comment.
Suggested change
| @click="onClick" | |
| @click="initialViewStore.returnToInitialView" |
As the local function onClick only calls returnToInitialView, this remove bloat.
Comment on lines
+66
to
+71
| enabledPlugins.includes('returnToInitialView') && | ||
| ReturnToInitialView({ | ||
| displayComponent: true, | ||
| layoutTag: 'TOP_RIGHT', | ||
| renderType: 'iconMenu', | ||
| }), |
Member
There was a problem hiding this comment.
If the plugin is supposed to be added to the iconMenu it should be done in L32-46. In that case, that information should be added to the TSDoc comment of createMap in line 101.
| import Fullscreen from '@/plugins/fullscreen' | ||
| import GeoLocation from '@/plugins/geoLocation' | ||
| import IconMenu from '@/plugins/iconMenu' | ||
| import ReturnToInitialView from '@/plugins/initialView' |
Member
There was a problem hiding this comment.
Naming the import InitialView seems more fitting.
| return { | ||
| startCenter, | ||
| startResolution, | ||
| returnToInitialView, |
Member
There was a problem hiding this comment.
Suggested change
| returnToInitialView, | |
| /** @alpha */ | |
| returnToInitialView, |
| iconMenu?: IconMenuPluginOptions | ||
|
|
||
| /** Configuration for iInitialView plugin. */ | ||
| returnToInitialView?: InitialViewPluginOptions |
Member
There was a problem hiding this comment.
Suggested change
| returnToInitialView?: InitialViewPluginOptions | |
| initialView?: InitialViewPluginOptions |
| /** Configuration for iconMenu plugin. */ | ||
| iconMenu?: IconMenuPluginOptions | ||
|
|
||
| /** Configuration for iInitialView plugin. */ |
Member
There was a problem hiding this comment.
Suggested change
| /** Configuration for iInitialView plugin. */ | |
| /** Configuration for initialView plugin. */ |
Co-authored-by: LivMoeser <liv.moeser@dataport.de>
Co-authored-by: LivMoeser <liv.moeser@dataport.de>
Co-authored-by: LivMoeser <liv.moeser@dataport.de>
|
dopenguin
reviewed
Jul 31, 2026
| <PolarIconButton | ||
| :hint="$t(($) => $.label.return, { ns: PluginId })" | ||
| icon="kern-icon--home" | ||
| tooltip-position="left" |
Member
There was a problem hiding this comment.
The tooltipPosition should be based on where it is rendered.
Zoom added the following getter to its store to solve this issue which can be added the same way in the store of this plugin:
const tooltipPosition = computed(() =>
renderType.value === 'independent'
? layoutTag.value.includes('RIGHT')
? 'left'
: 'right'
: coreStore.getPluginStore('iconMenu')?.layoutTag.includes('RIGHT')
? 'left'
: 'right'
) as ComputedRef<'left' | 'right'>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
New One-Button Plugin that returns the map to its initial placing and zoom.
Instructions for local reproduction and review
Relevant tickets, issues, et cetera
#893