Skip to content

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.

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.

GroupWhat it names
pageTitleBrowser tab title.
introThe paragraph under the main title.
startText next to the centre of the map.
periodName for a group of stages: Day, Week, Module.
viewThe focused / full map switch.
stagePositionTop of the stage panel: {period} {periodNumber}, stage {stage} of {total}.
legendLegend card copy.
methoddo, observe, read — leads and titles.
tipThe tip box: label, copy/copied, hint, reveal.
checkpointThe “you’re done when” heading.
pagerPrevious / next / complete buttons.
nodeNode panel copy: back links, “on your route”, alternatives, docs.
refsThe sources section.
goalThe goal and module views.
bigPictureThe intro, the stage bridge and the look-back.
periodOverviewWhat a period gives you.
phasesThe phases of a stage and their buttons.
ariaLandmarks and controls only screen readers hear.
regionThe region view.
kindThe kind view.
sourcesDisplay names for DocLink.source keys (e.g. vendor: 'Official docs').
agentThe assistant: its actions, its answers’ caption, its setup.