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:
<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: count and count. They are listed as separate rows below. Beside the pair, you can word a count by plural category, with a key written base., the dot being part of the key. The categories are zero, one, two, few, many and other, picked by the language's plural rules:
{
"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., and then the pair. The counted bases are summary (its count is the number of errors), count and count (the count is the number of characters), tab, file (whose pair is file and file), and the assistant lines agent, agent, agent and agent. A plain summary the page sets is used for a count of one too.
The keys
Status lines and the page around the fields
| Key | Default English | Slots | Where it appears |
|---|---|---|---|
submitting | Submitting… | none | The line shown while a submit and its delivery are in flight. |
loading | Loading form… | none | The placeholder shown before the first paint, and while data-source-wait="all" holds the form. |
checking | Checking your answers… | none | The line shown while a journey's check against your server runs. |
server | We could not check your answers. Try again. | none | What a journey says when that check could not reach your server. |
form | This form could not be shown. Check the connection and try again. | none | The alert that takes the form's place when it could not be drawn at all. |
form | Part of this form did not finish loading, so it may not work as expected. | none | The alert shown when part of the form did not finish drawing in time. |
journeys | This form could not be loaded because part of it did not arrive. Check the connection and try again. | none | The alert a form with journeys shows when the journeys file did not load, above the Retry button. |
retry | Try again | none | The Retry button on that alert. |
pdf | The PDF could not be created because part of the form did not load. Check the connection and try again. | none | The alert the form's PDF button shows when the PDF file could not be loaded. |
field | Checking this answer… | none | The note beside a field while a check of its answer runs, where the look has no spinner of its own. |
unknown | Unknown component “” | | What the form draws in place of a component whose type nothing registered. |
unknown | This part of the form cannot be shown: nothing is registered for its component type. Register the plugin that provides it. | none | The explanation under it. |
Required and optional markers, errors
| Key | Default English | Slots | Where it appears |
|---|---|---|---|
required | * | none | The marker after the label of a required field. |
optional | (empty) | none | The marker after the label of an optional field. Empty by default. |
required | (empty) | none | A sentence above the fields that explains the required marker. Empty by default, so nothing is drawn. |
error | (empty) | none | A visually hidden word read before an inline error. Empty by default. |
summary | errors | | The error summary's heading. |
summary | error | | The same heading for one error. |
summary | : | , | One line of the error summary. |
Choices
| Key | Default English | Slots | Where it appears |
|---|---|---|---|
select | Select… | none | A select's empty first option, unless the component has a placeholder of its own. |
options | Loading the choices… | none | The line under a field while its data source has not answered. |
options | The choices could not be loaded. | none | The line under a field when its data source failed. |
options | Showing the first of choices. | , | The line under a field whose list was cut to 5,000 items. |
Files
| Key | Default English | Slots | Where it appears |
|---|---|---|---|
file | Remove | none | A file row's Remove control. |
file | Remove | | The same control's accessible name. |
file | File removed: | | What the field's status region says once a file is removed. |
file | You have selected the file: | | What it says once one file is picked. |
file | You have selected files: | , | What it says once several are picked. |
file | Download | | The title of the link that downloads an embedded file. |
file | No file | none | What a read-only file field says when it holds nothing. |
Dates
| Key | Default English | Slots | Where it appears |
|---|---|---|---|
date | Day | none | The label of a date's day box. |
date | Month | none | The label of its month box. |
date | Year | none | The label of its year box. |
date | Select a month | none | The empty option of a month select. |
Character count
| Key | Default English | Slots | Where it appears |
|---|---|---|---|
count | You can enter up to characters | , , | The limit sentence a screen reader gets with the field's description. |
count | (empty) | , , | What an empty field shows. Empty by default, so the count then reads as the whole limit left. |
count | characters left | , , | The count while typing. |
count | character left | , , | The count when one character is left. |
count | characters over limit | , , | The count past the limit. |
count | character over limit | , , | The count when one character over. |
Steps, pages and journeys
| Key | Default English | Slots | Where it appears |
|---|---|---|---|
step | Step of | , | The progress line of a steps container. |
step | : | none | What a step's heading reads between its tag and its name. Visually hidden. |
step | completed | none | What the indicator says of a step the person has completed. |
step | not completed | none | What it says of a step not completed. |
step | Step | | The name of a step its author left untitled. |
back | Back | none | The Back button of steps and journeys. |
continue | Continue | none | The Continue button. |
submit | Submit | none | The button on the last page of a journey. |
page | Step of | , | The caption over a journey page's heading, unless the journey's progress is none. |
page | The page you asked for is not available yet. This is the nearest page you can open. | none | The 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. |
worked | Worked out from your answers | none | The line under a worked-out value, a read-only copy of a form field that a journey page computes. |
change | Change | none | The link beside each answer on a Check answers page. It opens the page the answer was given on. |
change | Change | | That link's whole name for assistive technology. The words after change are drawn visually hidden. |
not | Not provided | none | A Check answers page's value for an optional question left blank, unless the page leaves such answers out. |
enter | Enter | | 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
| Key | Default English | Slots | Where it appears |
|---|---|---|---|
tabs | Contents | none | The title over a tabs container's list of links where its panels stack. |
tab | errors | | What a tab says of the blocking errors in its panel, for a look whose tabs say it. |
tab | error | | The same for one error. |
tab | Tab | | The name of a tab its author left untitled. |
Data grid
| Key | Default English | Slots | Where it appears |
|---|---|---|---|
data | Add row | none | The Add button. |
data | Remove | none | Each row's Remove button. |
data | Move up | none | Each row's Move up button. |
data | Move down | none | Each row's Move down button. |
data | No rows yet. | none | The line shown in place of the rows when there are none. |
data | Row | | A row's name: the row header, and the error summary's "Row n: Label". |
data | Actions | none | The header of the column that holds the row buttons. |
Notices and the confirmation
| Key | Default English | Slots | Where it appears |
|---|---|---|---|
confirmation | Your form was submitted | none | The title of the built-in confirmation (the confirmation attribute). |
confirmation | Thank you. We have received your answers. | none | Its message. |
confirmation | Reference | none | The label of its reference line. |
notice | Success: | none | The word read to assistive technology before a success notice, never drawn. |
notice | Information: | none | The same for an information notice. |
notice | Warning: | none | The same for a warning notice. |
notice | Error: | none | The same for an error notice. |
Language
| Key | Default English | Slots | Where it appears |
|---|---|---|---|
language | Language | none | The label of the form's own language switcher. |
language | Language selection | none | The hidden heading over language links. |
locale | Form locale | none | The title of the locale select of the engine's form host element, which datum-form. does not include. |
Help and images
| Key | Default English | Slots | Where it appears |
|---|---|---|---|
tooltip | Help | none | The accessible name of the help mark beside a label. |
image | No image URL | none | The caption of an image component with no usable URL. |
Printed form
| Key | Default English | Slots | Where it appears |
|---|---|---|---|
print | Complete only if it applies to you. | none | The note beside a field that prints while a rule hides it, when its author wrote none. |
print | Not answered | none | What a printed answer left empty says. |
print | Page of | , | The page number line at the end of the printed footer, until the form's own footer text replaces it. |
print | Chosen | none | The word a chosen option carries in print. |
print | # | none | The heading of a printed data grid's row number column. |
Toolbar labels of the engine's form host element
| Key | Default English | Slots | Where it appears |
|---|---|---|---|
validate | Validate | none | The Validate button. datum-form. does not include this element; the keys exist for hosts that build with the engine's host element. |
print | Print | none | The Print button. |
print | Answers | none | The Print menu's choice for a record of the answers. The menu shows when the form offers more than one version. |
print | Blank form | none | The Print menu's choice for a blank paper form. |
print | Filled-in form | none | The Print menu's choice for the paper form with the answers written in. |
pdf | PDF | none | The PDF button. |
download | Download PDF | none | The Download PDF button. |
pdf | PDF layout | none | The label of its PDF layout picker. |
Browser assistants
| Key | Default English | Slots | Where it appears |
|---|---|---|---|
agent | Assistant | none | The accessible name of the banner shown while an assistant works on the form. |
agent | An assistant is working on this form: | | The banner's line. |
agent | Stop | none | The banner's Stop button. |
agent | Allow the assistant again | none | The button that lets the assistant carry on after Stop. |
agent | Undo all | none | The Undo all button. |
agent | Dismiss | none | The Dismiss button. |
agent | An assistant started working on this form: . Press Stop to take over. | | What the live region says when an assistant starts. |
agent | The assistant finished: | | What it says when the assistant finishes. |
agent | A saved draft replaced the answers; earlier changes cannot be undone. | none | The ended banner's line when a restored draft replaced the answers, so earlier changes cannot be undone. |
agent | The assistant was stopped; changes were undone | | What it says when the assistant is stopped and its changes were undone. |
agent | The assistant was stopped; change was undone | | The same for one change. |
agent | The assistant paused | none | What it says when the assistant pauses. |
agent | An assistant filled fields | | What it says when the assistant filled fields. |
agent | An assistant filled field | | The same for one field. |
agent | An assistant added rows to | , | What it says when the assistant added rows. |
agent | An assistant added row to | , | The same for one row. |
agent | An assistant removed a row from | | What it says when the assistant removed a row. |
agent | An assistant moved to | | What it says when the assistant moved to another page. |
agent | An assistant switched the form to | | What it says when the assistant switched the language. |
agent | changes by the assistant were undone | | What it says when the person undid the assistant's changes. |
agent | change by the assistant was undone | | The same for one change. |
agent | An assistant submitted the form | none | What it says when the assistant submitted the form. |
agent | An assistant saved your draft | none | What it says when the assistant saved the draft. |
agent | An assistant restored your saved draft | none | What it says when the assistant restored the draft. |
agent | An assistant deleted your saved draft | none | What it says when the assistant deleted the draft. |
agent | An assistant downloaded a PDF of the form | none | What it says when the assistant downloaded a PDF. |
Next
- Where texts are translated for each language: Languages.
- The confirmation these keys word: Submissions and replies.
- The attributes that carry
texts: The form element.