Labels
labels changes the interface words shown to the learner. Every label has an English default, so
most maps only need to replace a few words—for example, period: 'Week' for a week-long route.
Placeholders in {braces} are filled by the renderer; keep them when you rewrite the sentence.
export default defineMap({ // … labels: { period: 'Week', intro: 'Everything you will meet in your first week.', tip: { label: 'Ask Copilot' }, },});Nested groups are merged one level deep. Setting tip.label keeps the other default tip labels;
setting tip: { label: 'Ask Copilot' } replaces only that leaf.
Groups
Section titled “Groups”The table names each top-level group. Most maps only need to change the audience-facing terms such
as period, intro or tip; use a nested group when its default words do not fit your audience.
| Group | What it names |
|---|---|
pageTitle | Browser tab title. |
intro | The paragraph under the main title. |
start | Text next to the centre of the map. |
period | Name for a group of stages: Day, Week, Module. |
view | The focused / full map switch. |
stagePosition | Top of the stage panel: {period} {periodNumber}, stage {stage} of {total}. |
legend | Legend card copy. |
method | do, observe, read — leads and titles. |
tip | The tip box: label, copy/copied, hint, reveal. |
checkpoint | The “you’re done when” heading. |
pager | Previous / next / complete buttons. |
node | Node panel copy: back links, “on your route”, alternatives, docs. |
refs | The sources section. |
goal | The goal and module views. |
bigPicture | The intro, the stage bridge and the look-back. |
periodOverview | What a period gives you. |
phases | The phases of a stage and their buttons. |
aria | Landmarks and controls only screen readers hear. |
region | The region view. |
kind | The kind view. |
sources | Display names for DocLink.source keys (e.g. vendor: 'Official docs'). |
agent | The assistant: its actions, its answers’ caption, its setup. |