Fix issue #20: Add notes to a map

This commit is contained in:
Gitea OpenCode Agent
2026-10-14 14:46:58 +00:00
parent 9d9738b2b4
commit ba84e10525
16 changed files with 922 additions and 14 deletions

View File

@@ -120,6 +120,9 @@ function handleCampaignEntryUpdated({ entityType, entry }) {
if (!list) return;
list.value = list.value.map((current) => current._id === entry._id ? entry : current)
.sort((a, b) => a.name.localeCompare(b.name));
// The anchored map is this very entry (its pins changed, say): write it back without touching
// the pane, so switching back from the notes still shows what is on the map.
if (entityType === 'map' && AnchoredMap.value?._id === entry._id) AnchoredMap.value = entry;
}
const campaignId = computed(() => {

View File

@@ -1,7 +1,11 @@
<script setup>
import { computed, onBeforeUnmount, onMounted, ref, watch } from 'vue';
import { CreateWindow } from '@/services/Windows';
import { getBaseUrl } from '~/services/Server';
import { computed, nextTick, onBeforeUnmount, onMounted, ref, watch } from 'vue';
import { useI18n } from 'vue-i18n';
import { ClearWindow, CreateWindow, GetFirstWindowId } from '@/services/Windows';
import { HideContextMenu, ShowContextMenu } from '~/services/ContextMenu';
import { BuildNoteOptions, OptionLabel, ToImagePoint, ToScreenPoint } from '~/services/MapPins';
import { DisplayToast } from '~/services/Toaster';
import Server, { getBaseUrl } from '~/services/Server';
import { emitter } from '~/services/Emitter';
import { useCampaignService } from '~/services/Campaign.js';
@@ -141,6 +145,135 @@ function handleMapUpdated({ entityType, entry }) {
if (imageChanged) imageSize.value = { width: 0, height: 0 };
}
// --- Notes pinned onto the map ---
// Right clicking the map pins one of the campaign notes at that spot, and clicking the marker reads
// it in a window of its own.
const { t } = useI18n();
const noteOptions = ref([]);
const pins = computed(() => map.value?.pins ?? []);
const labelByNoteId = computed(() => new Map(noteOptions.value.map((option) => [option.value, option.label])));
// What the pin helpers need to know about the current view to translate between image and screen.
function viewState() {
return { zoom: zoom.value, pan: pan.value, width: imageSize.value.width, height: imageSize.value.height };
}
function pinStyle(pin) {
const point = ToScreenPoint(pin, viewState());
return { left: `${point.x}px`, top: `${point.y}px` };
}
function pinLabel(pin) {
return labelByNoteId.value.get(String(pin?.note)) ?? '';
}
// Every note of the campaign, so notes living in a folder can be pinned too and every marker can
// say which note it is.
async function fetchPinnableNotes() {
if (!campaignId.value) {
noteOptions.value = [];
return;
}
try {
const response = await Server().get('/note/all', { params: { campaign: campaignId.value } });
noteOptions.value = response.data.status === 'ok'
? BuildNoteOptions(response.data.notes, response.data.folders)
: [];
} catch (error) {
noteOptions.value = [];
}
}
function onMapContextMenu(event) {
// A pin marks a spot on the image, so there is nothing to pin while the map has no image.
const bounds = viewport.value?.getBoundingClientRect();
if (!imageUrl.value || !bounds) return;
// Reaching a submenu moves the mouse away from the spot, so it is kept for the menu actions.
const spot = ToImagePoint({ x: event.clientX - bounds.left, y: event.clientY - bounds.top }, viewState());
if (!spot) return;
if (!noteOptions.value.length) {
ShowContextMenu([{ name: t('campaigns.map.pins.none'), action: () => HideContextMenu() }]);
return;
}
ShowContextMenu([{
name: t('campaigns.map.pins.add'),
icon: '/icons/iconoir/regular/map-pin-plus.svg',
context: noteOptions.value.map((option) => ({
name: option.label,
icon: '/icons/iconoir/regular/notes.svg',
action: () => { HideContextMenu(); savePin(option.value, spot); }
}))
}]);
}
function onPinContextMenu(pin) {
ShowContextMenu([
{
name: t('campaigns.map.pins.open'),
icon: '/icons/iconoir/regular/notes.svg',
action: () => { HideContextMenu(); openPinnedNote(pin); }
},
{ divider: true },
{
name: t('campaigns.map.pins.remove'),
icon: '/icons/iconoir/regular/map-pin-xmark.svg',
action: () => { HideContextMenu(); removePin(pin); }
}
]);
}
async function savePin(noteId, spot) {
await updatePins('/map/pin', { id: map.value?._id, note: noteId, x: spot.x, y: spot.y });
}
async function removePin(pin) {
await updatePins('/map/unpin', { id: map.value?._id, pin: pin?._id });
}
// Both pin changes answer with the whole map, which keeps the sidebar entry and the anchored map in
// step with what is on screen.
async function updatePins(route, body) {
if (!body.id) return;
try {
const response = await Server().post(route, body);
if (response.data.status !== 'ok') {
DisplayToast('red', t('campaigns.map.pins.error'), 3000);
return;
}
map.value = { ...response.data.map };
emitter.emit('campaign-entry-updated', { entityType: 'map', entry: response.data.map });
} catch (error) {
DisplayToast('red', t('campaigns.map.pins.error'), 3000);
}
}
async function openPinnedNote(pin) {
if (!pin?.note) return;
// One window reads the pinned notes; opening another one replaces it, like the character sheet.
const existingWindowId = GetFirstWindowId('pinned_note');
if (existingWindowId !== undefined) ClearWindow({ id: existingWindowId });
await nextTick();
CreateWindow('pinned_note', { note: pin.note });
}
// The backend drops the pins of a note along with it; the markers on this open map follow at once.
function handlePinnedNoteDeleted(noteKey) {
if (!pins.value.length) return;
const remaining = map.value.pins.filter((pin) => String(pin.note) !== String(noteKey));
if (remaining.length !== map.value.pins.length) map.value = { ...map.value, pins: remaining };
}
function handlePinnedNoteRenamed({ key, title }) {
const option = noteOptions.value.find((current) => current.value === String(key));
if (!option) return;
option.title = title;
option.label = OptionLabel(option);
}
// A different map was anchored while this pane was already mounted.
watch(() => props.map, (incoming, previous) => {
if (incoming === previous) return;
@@ -148,12 +281,22 @@ watch(() => props.map, (incoming, previous) => {
imageSize.value = { width: 0, height: 0 };
});
watch(campaignId, () => {
noteOptions.value = [];
fetchPinnableNotes();
});
onMounted(() => {
emitter.on('campaign-entry-updated', handleMapUpdated);
emitter.on('delete-note', handlePinnedNoteDeleted);
emitter.on('title-updated', handlePinnedNoteRenamed);
fetchPinnableNotes();
});
onBeforeUnmount(() => {
emitter.off('campaign-entry-updated', handleMapUpdated);
emitter.off('delete-note', handlePinnedNoteDeleted);
emitter.off('title-updated', handlePinnedNoteRenamed);
});
</script>
@@ -198,10 +341,28 @@ onBeforeUnmount(() => {
@pointermove="onPointerMove"
@pointerup="onPointerUp"
@pointercancel="onPointerUp"
@contextmenu.prevent="onMapContextMenu"
>
<template v-if="imageUrl">
<img class="map-image" :src="imageUrl" :style="stageStyle" :alt="map?.name" draggable="false" @load="onImageLoaded">
<div class="map-grid" :style="gridStyle" aria-hidden="true"></div>
<div class="map-pins">
<button
v-for="pin in pins"
:key="pin._id"
class="map-pin"
type="button"
:style="pinStyle(pin)"
:title="pinLabel(pin) || $t('campaigns.map.pins.open')"
:aria-label="pinLabel(pin) || $t('campaigns.map.pins.open')"
@pointerdown.stop
@click="openPinnedNote(pin)"
@contextmenu.stop.prevent="onPinContextMenu(pin)"
>
<img class="pin-icon" src="/icons/iconoir/solid/pin.svg" alt="" aria-hidden="true">
<span class="pin-label">{{ pinLabel(pin) }}</span>
</button>
</div>
</template>
<div v-else class="map-empty">
{{ $t('campaigns.map.no-image') }}
@@ -227,6 +388,22 @@ onBeforeUnmount(() => {
.map-viewport.dragging { cursor: grabbing; }
.map-image { position: absolute; top: 0; left: 0; max-width: none; transform-origin: top left; user-select: none; }
.map-grid { position: absolute; top: 0; left: 0; opacity: .55; pointer-events: none; }
/* Pins live in image pixels but are drawn in screen space (see ToScreenPoint), so the overlay stays
unscaled and their markers are readable at every zoom. Only the markers catch the mouse. */
.map-pins { position: absolute; inset: 0; pointer-events: none; }
.map-pin {
position: absolute; transform: translate(-50%, -100%); pointer-events: auto;
display: flex; align-items: center; gap: 4px; margin: 0; padding: 3px 6px;
border: 1px solid var(--color-link); border-radius: 7px;
background: var(--color-background-soft); color: var(--color-text);
font-size: 11px; cursor: pointer; box-shadow: 0px 0px 6px -1px rgba(0,0,0,0.55);
}
.map-pin:hover { background: var(--color-button-hover); }
.map-pin:focus-visible { outline: 1px solid var(--color-link); }
.pin-icon { width: 12px; height: 12px; filter: invert(var(--color-icon-invert)); }
/* The note's name only when it is asked for: a map full of labels is a map nobody can read. */
.pin-label { display: none; max-width: 200px; overflow: hidden; text-overflow: ellipsis; white-space: nowrap; }
.map-pin:hover .pin-label, .map-pin:focus-visible .pin-label { display: inline; }
.map-empty { width: 100%; height: 100%; display: flex; flex-direction: column; align-items: center; justify-content: center; gap: 8px; font-size: 13px; opacity: .8; }
.map-edit { border: 1px solid var(--color-border); border-radius: 7px; padding: 6px 11px; background: var(--color-background-soft); color: var(--color-text); font-size: 12px; cursor: pointer; }
.map-edit:hover { background: var(--color-button-hover); }

View File

@@ -0,0 +1,122 @@
<script setup>
import { createApp, onBeforeUnmount, onMounted, ref } from 'vue';
import { SetupHandle, SetSize, ResetPosition, ClearWindow, Top } from '@/services/Windows';
import WindowHandle from './partials/WindowHandle.vue';
import { GetWidget, ParseMarkdown } from '~/services/Marker';
import Server from '~/services/Server';
// The note a map pin points at (see MapViewerPane.vue). The note is fetched here instead of being
// carried over from the map, so a pin works whatever the note column shows and always reads fresh.
const props = defineProps(['data']);
const id = props.data.id;
const noteId = props.data.note;
const handle = ref(null);
const wrapper = ref(null);
const renderedContent = ref(null);
const note = ref(null);
const displayText = ref('');
const loading = ref(true);
const failed = ref(false);
// Widgets mounted over this note, kept to unmount them again the way Note.vue does: re-rendering
// would otherwise leave the apps of the nodes it replaced behind.
const mountedApps = [];
function unmountWidgets() {
for (const app of mountedApps) {
try {
app.unmount();
} catch (error) {
// The container may already be off the DOM; ignore and drop it all the same.
}
}
mountedApps.length = 0;
}
function mountWidgets() {
const root = renderedContent.value;
if (!root) return;
['display', 'inline'].forEach((widgetType) => {
root.querySelectorAll('.vue-component-' + widgetType).forEach((el) => {
const widget = GetWidget(widgetType, el.dataset.component);
if (!widget) return;
try {
const app = createApp(widget, { content: el.dataset.content });
app.config.errorHandler = (error) => console.error('Widget error', el.dataset.component, error);
app.mount(el);
mountedApps.push(app);
} catch (error) {
console.error('Failed to mount widget', el.dataset.component, error);
}
});
});
}
async function fetchNote() {
loading.value = true;
failed.value = false;
try {
const response = await Server().get(`/note/retrieve/${noteId}`);
if (response.data.status !== 'ok' || !response.data.note) {
failed.value = true;
return;
}
note.value = response.data.note;
unmountWidgets();
displayText.value = ParseMarkdown(response.data.note.content ?? '');
setTimeout(() => mountWidgets(), 0);
} catch (error) {
failed.value = true;
} finally {
loading.value = false;
}
}
onMounted(() => {
Top(wrapper);
SetupHandle(id, handle);
SetSize(id, {
width: Math.max(360, Math.min(720, window.innerWidth - 24)),
height: Math.max(360, Math.min(720, window.innerHeight - 32))
});
ResetPosition(id, 'center');
fetchNote();
});
onBeforeUnmount(() => {
unmountWidgets();
ClearWindow({ type: 'pinned_note' });
});
</script>
<template>
<div class="window-wrapper pinned-note-window" :id="'window-wrapper-' + id" ref="wrapper">
<WindowHandle :window="id" ref="handle" />
<div class="body">
<div v-if="loading" class="note-state">{{ $t('campaigns.states.loading') }}</div>
<div v-else-if="failed" class="note-state">{{ $t('campaigns.map.pins.note-error') }}</div>
<template v-else>
<h1 v-if="note.title" class="note-title">{{ note.title }}</h1>
<div ref="renderedContent" class="note-content" v-html="displayText"></div>
</template>
</div>
</div>
</template>
<style scoped>
.window-wrapper { display: flex; align-items: center; flex-direction: column; }
/* Stretch so the outer margin insets the content instead of overflowing the window. */
.body {
flex: 1;
min-height: 0;
align-self: stretch;
box-sizing: border-box;
margin: 10px;
padding: 8px;
overflow-y: auto;
}
.note-title { margin: 0 0 10px; font-family: MrEavesRemake; overflow-wrap: anywhere; }
.note-state { padding: 10px; font-size: 13px; opacity: .8; }
.note-content :deep(img) { max-width: 100%; height: auto; display: block; }
</style>