Skip to content

The form's own words ​

The form says some things in its own voice: the Submitting line, the error summary heading, the Back and Continue buttons, the data grid's Add row, the character count. These are not the definition's labels and not validation messages. Every one has a key, an English default and, where it carries a number or a name, slots. This page lists them all. The texts attribute and property change them.

The value format ​

texts is an object from key to text. A text is a plain string, or an object with a default and a word per language:

html
<datum-form src="/forms/intake.json" texts='{
  "submitting": { "default": "Sending your answers…", "locales": { "fr": "Envoi de vos réponses…" } },
  "back": "Previous"
}'></datum-form>

The attribute takes the object as JSON. The texts property takes the object itself. The locales entry for a language is found by its exact tag, then by its primary language (fr for fr-CA), then the default is used. A key the object does not hold keeps its other wording. The order every source is read in is under Where a word comes from.

A slot is written with double braces, and is filled when the text is drawn: " characters left". A slot the key does not provide is left as written. The builder's own texts use single braces; those are a different table.

The keys are the ones below. A key that is not on this page and that nothing words is shown as the key itself, so a mistyped key shows on the page instead of vanishing. A design-system binding may read keys of its own through the same object.

Counted texts ​

A few texts depend on a number. Each has two keys, a general one and one for a count of one: countLeft and countLeftOne. They are listed as separate rows below. Beside the pair, you can word a count by plural category, with a key written base.category, the dot being part of the key. The categories are zero, one, two, few, many and other, picked by the language's plural rules:

json
{
  "countLeft.one": { "default": "{{n}} character to go", "locales": { "fr": "Encore {{n}} caractère" } },
  "countLeft.other": { "default": "{{n}} characters to go", "locales": { "fr": "Encore {{n}} caractères" } }
}

A category with no key reads base.other, and then the pair. The counted bases are summaryHeading (its count is the number of errors), countLeft and countOver (the count is the number of characters), tabHasErrors, fileAnnounced (whose pair is fileAnnounced and fileAnnouncedMany), and the assistant lines agentStopped, agentFilled, agentRowsAdded and agentUndone. A plain summaryHeading the page sets is used for a count of one too.

The keys ​

Status lines and the page around the fields ​

KeyDefault EnglishSlotsWhere it appears
submittingSubmitting…noneThe line shown while a submit and its delivery are in flight.
loadingLoading form…noneThe placeholder shown before the first paint, and while data-source-wait="all" holds the form.
checkingChecking your answers…noneThe line shown while a journey's check against your server runs.
serverUnavailableWe could not check your answers. Try again.noneWhat a journey says when that check could not reach your server.
formNotShownThis form could not be shown. Check the connection and try again.noneThe alert that takes the form's place when it could not be drawn at all.
formPartlyShownPart of this form did not finish loading, so it may not work as expected.noneThe alert shown when part of the form did not finish drawing in time.
journeysUnavailableThis form could not be loaded because part of it did not arrive. Check the connection and try again.noneThe alert a form with journeys shows when the journeys file did not load, above the Retry button.
retryTry againnoneThe Retry button on that alert.
pdfUnavailableThe PDF could not be created because part of the form did not load. Check the connection and try again.noneThe alert the form's PDF button shows when the PDF file could not be loaded.
fieldPendingChecking this answer…noneThe note beside a field while a check of its answer runs, where the look has no spinner of its own.
unknownComponentUnknown component “”What the form draws in place of a component whose type nothing registered.
unknownComponentHintThis part of the form cannot be shown: nothing is registered for its component type. Register the plugin that provides it.noneThe explanation under it.

Required and optional markers, errors ​

KeyDefault EnglishSlotsWhere it appears
required*noneThe marker after the label of a required field.
optional(empty)noneThe marker after the label of an optional field. Empty by default.
requiredNote(empty)noneA sentence above the fields that explains the required marker. Empty by default, so nothing is drawn.
errorPrefix(empty)noneA visually hidden word read before an inline error. Empty by default.
summaryHeading errorsThe error summary's heading.
summaryHeadingOne errorThe same heading for one error.
summaryEntry: , One line of the error summary.

Choices ​

KeyDefault EnglishSlotsWhere it appears
selectEmptySelect…noneA select's empty first option, unless the component has a placeholder of its own.
optionsLoadingLoading the choices…noneThe line under a field while its data source has not answered.
optionsFailedThe choices could not be loaded.noneThe line under a field when its data source failed.
optionsTruncatedShowing the first of choices., The line under a field whose list was cut to 5,000 items.

Files ​

KeyDefault EnglishSlotsWhere it appears
fileRemoveRemovenoneA file row's Remove control.
fileRemoveFileRemove The same control's accessible name.
fileRemovedFile removed: What the field's status region says once a file is removed.
fileAnnouncedYou have selected the file: What it says once one file is picked.
fileAnnouncedManyYou have selected files: , What it says once several are picked.
fileDownloadDownload The title of the link that downloads an embedded file.
fileNoneNo filenoneWhat a read-only file field says when it holds nothing.

Dates ​

KeyDefault EnglishSlotsWhere it appears
dateDayDaynoneThe label of a date's day box.
dateMonthMonthnoneThe label of its month box.
dateYearYearnoneThe label of its year box.
dateSelectMonthSelect a monthnoneThe empty option of a month select.

Character count ​

KeyDefault EnglishSlotsWhere it appears
countUpToYou can enter up to characters, , The limit sentence a screen reader gets with the field's description.
countEmpty(empty), , What an empty field shows. Empty by default, so the count then reads as the whole limit left.
countLeft characters left, , The count while typing.
countLeftOne character left, , The count when one character is left.
countOver characters over limit, , The count past the limit.
countOverOne character over limit, , The count when one character over.

Steps, pages and journeys ​

KeyDefault EnglishSlotsWhere it appears
stepOfStep of , The progress line of a steps container.
stepTagSeparator: noneWhat a step's heading reads between its tag and its name. Visually hidden.
stepCompletedcompletednoneWhat the indicator says of a step the person has completed.
stepNotCompletednot completednoneWhat it says of a step not completed.
stepFallbackStep The name of a step its author left untitled.
backBacknoneThe Back button of steps and journeys.
continueContinuenoneThe Continue button.
submitSubmitnoneThe button on the last page of a journey.
pageOfStep of , The caption over a journey page's heading, unless the journey's progress is none.
pageRedirectedThe page you asked for is not available yet. This is the nearest page you can open.noneThe line a journey page draws when the page asked for with page was not open to the answers and the person was put on the nearest page they can reach.
workedOutWorked out from your answersnoneThe line under a worked-out value, a read-only copy of a form field that a journey page computes.
changeChangenoneThe link beside each answer on a Check answers page. It opens the page the answer was given on.
changeHiddenChange That link's whole name for assistive technology. The words after change are drawn visually hidden.
notProvidedNot providednoneA Check answers page's value for an optional question left blank, unless the page leaves such answers out.
enterAnswerEnter The link that takes the place of a required answer not given, on a Check answers page. It opens the page that asks it.

Tabs ​

KeyDefault EnglishSlotsWhere it appears
tabsContentsContentsnoneThe title over a tabs container's list of links where its panels stack.
tabHasErrors errorsWhat a tab says of the blocking errors in its panel, for a look whose tabs say it.
tabHasErrorsOne errorThe same for one error.
tabFallbackTab The name of a tab its author left untitled.

Data grid ​

KeyDefault EnglishSlotsWhere it appears
dataGridAddAdd rownoneThe Add button.
dataGridRemoveRemovenoneEach row's Remove button.
dataGridMoveUpMove upnoneEach row's Move up button.
dataGridMoveDownMove downnoneEach row's Move down button.
dataGridEmptyNo rows yet.noneThe line shown in place of the rows when there are none.
dataGridRowRow A row's name: the row header, and the error summary's "Row n: Label".
dataGridActionsActionsnoneThe header of the column that holds the row buttons.

Notices and the confirmation ​

KeyDefault EnglishSlotsWhere it appears
confirmationTitleYour form was submittednoneThe title of the built-in confirmation (the confirmation attribute).
confirmationMessageThank you. We have received your answers.noneIts message.
confirmationReferenceReferencenoneThe label of its reference line.
noticeSuccessSuccess: noneThe word read to assistive technology before a success notice, never drawn.
noticeInfoInformation: noneThe same for an information notice.
noticeWarningWarning: noneThe same for a warning notice.
noticeErrorError: noneThe same for an error notice.

Language ​

KeyDefault EnglishSlotsWhere it appears
languageSwitcherLanguagenoneThe label of the form's own language switcher.
languageSelectionLanguage selectionnoneThe hidden heading over language links.
localeLabelForm localenoneThe title of the locale select of the engine's form host element, which datum-form.js does not include.

Help and images ​

KeyDefault EnglishSlotsWhere it appears
tooltipHelpHelpnoneThe accessible name of the help mark beside a label.
imageEmptyNo image URLnoneThe caption of an image component with no usable URL.

Printed form ​

KeyDefault EnglishSlotsWhere it appears
printOnlyIfComplete only if it applies to you.noneThe note beside a field that prints while a rule hides it, when its author wrote none.
printEmptyNot answerednoneWhat a printed answer left empty says.
printPageNumberPage of , The page number line at the end of the printed footer, until the form's own footer text replaces it.
printChosenChosennoneThe word a chosen option carries in print.
printRowNumber#noneThe heading of a printed data grid's row number column.

Toolbar labels of the engine's form host element ​

KeyDefault EnglishSlotsWhere it appears
validateLabelValidatenoneThe Validate button. datum-form.js does not include this element; the keys exist for hosts that build with the engine's host element.
printLabelPrintnoneThe Print button.
printAnswersAnswersnoneThe Print menu's choice for a record of the answers. The menu shows when the form offers more than one version.
printBlankBlank formnoneThe Print menu's choice for a blank paper form.
printFilledFilled-in formnoneThe Print menu's choice for the paper form with the answers written in.
pdfLabelPDFnoneThe PDF button.
downloadPdfLabelDownload PDFnoneThe Download PDF button.
pdfLayoutLabelPDF layoutnoneThe label of its PDF layout picker.

Browser assistants ​

KeyDefault EnglishSlotsWhere it appears
agentBannerLabelAssistantnoneThe accessible name of the banner shown while an assistant works on the form.
agentBannerAn assistant is working on this form: The banner's line.
agentStopStopnoneThe banner's Stop button.
agentAllowAgainAllow the assistant againnoneThe button that lets the assistant carry on after Stop.
agentUndoAllUndo allnoneThe Undo all button.
agentDismissDismissnoneThe Dismiss button.
agentSessionStartedAn assistant started working on this form: . Press Stop to take over.What the live region says when an assistant starts.
agentSessionEndedThe assistant finished: What it says when the assistant finishes.
agentSessionEndedAfterRestoreA saved draft replaced the answers; earlier changes cannot be undone.noneThe ended banner's line when a restored draft replaced the answers, so earlier changes cannot be undone.
agentStoppedThe assistant was stopped; changes were undoneWhat it says when the assistant is stopped and its changes were undone.
agentStoppedOneThe assistant was stopped; change was undoneThe same for one change.
agentPausedThe assistant pausednoneWhat it says when the assistant pauses.
agentFilledAn assistant filled fieldsWhat it says when the assistant filled fields.
agentFilledOneAn assistant filled fieldThe same for one field.
agentRowsAddedAn assistant added rows to , What it says when the assistant added rows.
agentRowsAddedOneAn assistant added row to , The same for one row.
agentRowRemovedAn assistant removed a row from What it says when the assistant removed a row.
agentMovedAn assistant moved to What it says when the assistant moved to another page.
agentLanguageAn assistant switched the form to What it says when the assistant switched the language.
agentUndone changes by the assistant were undoneWhat it says when the person undid the assistant's changes.
agentUndoneOne change by the assistant was undoneThe same for one change.
agentSubmittedAn assistant submitted the formnoneWhat it says when the assistant submitted the form.
agentDraftSavedAn assistant saved your draftnoneWhat it says when the assistant saved the draft.
agentDraftRestoredAn assistant restored your saved draftnoneWhat it says when the assistant restored the draft.
agentDraftClearedAn assistant deleted your saved draftnoneWhat it says when the assistant deleted the draft.
agentPdfDownloadedAn assistant downloaded a PDF of the formnoneWhat it says when the assistant downloaded a PDF.

Next ​

MIT licence. Your forms, your data, your keys.