Skip to main content

Interface: RendererStrings

RendererStrings is the catalog of user-facing strings that the renderer itself provides (the renderer "chrome"), as opposed to text that comes from the Questionnaire resource (e.g. item.text, answerOption.display).

The catalog is intentionally flat so that partial overrides can be merged with a simple shallow spread (see resolveRendererStrings). Every entry must have an English default in defaultRendererStrings.

To localise the renderer, pass a rendererStrings partial catalog in the renderer config (e.g. buildForm({ rendererConfigOptions: { rendererStrings } })). The renderer does not bundle any translations; consuming apps own their translation files (e.g. per-locale JSON) and inject them here. The locale config option does not select strings — it only drives date formatting and calendar localisation.

Properties​

attachFile​

attachFile: string

Attach-file button label/tooltip.

booleanNoLabel​

booleanNoLabel: string

Label for the "false" option of a boolean item.

booleanYesLabel​

booleanYesLabel: string

Label for the "true" option of a boolean item.

clear​

clear: string

Clear-input button label/tooltip.

dateFormat?​

optional dateFormat: string

Optional override for the full-date input/display format, as a dayjs format string (e.g. 'DD.MM.YYYY').

When omitted, the format is derived from the active locale using dayjs' locale data (e.g. de-CH -> DD.MM.YYYY), falling back to 'DD/MM/YYYY' when no locale is set. Set this only to force a specific format regardless of locale.

The format must use DD, MM and YYYY tokens joined by a single separator character. The shorter month-year (MM<sep>YYYY) and year (YYYY) formats and the input-validation separator are derived from it.

dateFullFormatError​

dateFullFormatError: string

Date validation error when the input does not match the full date format. Supports {format}.

dateInvalidError​

dateInvalidError: string

Date validation error when the input is well-formed but not a valid calendar date.

dateMonthOrFullFormatError​

dateMonthOrFullFormatError: string

Date validation error when the input matches neither the month-year nor the full date format. Supports {monthYearFormat} and {format}.

dateSeparatorError​

dateSeparatorError: string

Date validation error when the input uses a different separator than the format. Supports {separator}.

dateTimeDateRequired​

dateTimeDateRequired: string

Validation error shown for a date/time item when the time is set but the date is empty.

dateUnrecognizedError​

dateUnrecognizedError: string

Date validation error when the input matches no supported date format.

dragRow​

dragRow: string

Drag-handle label for reordering table rows.

fetchingResults​

fetchingResults: string

Autocomplete loading text while options are being fetched.

fieldRequired​

fieldRequired: string

Validation error when a required field is empty (fallback if no custom required text is provided).

formSections​

formSections: string

Accessible label for the tab list navigation landmark.

mandatoryField​

mandatoryField: string

Screen-reader-only text marking a required field (rendered next to the asterisk).

maxDecimalPlacesFallback​

maxDecimalPlacesFallback: string

Validation error when a number has too many decimal places (no limit available).

maxDecimalPlacesWithLimit​

maxDecimalPlacesWithLimit: string

Validation error when a number has too many decimal places. Supports {maxDecimalPlaces}.

maxLengthFallback​

maxLengthFallback: string

Validation error when input is longer than the maximum length (no limit available).

maxLengthWithLimit​

maxLengthWithLimit: string

Validation error when input is longer than the maximum length. Supports {maxLength}.

maxQuantityFallback​

maxQuantityFallback: string

Validation error when a quantity is above the maximum (no limit available).

maxQuantityWithLimit​

maxQuantityWithLimit: string

Validation error when a quantity is above the maximum. Supports {maxQuantityValue}.

maxValueFallback​

maxValueFallback: string

Validation error when a value is above the maximum (no limit available).

maxValueWithLimit​

maxValueWithLimit: string

Validation error when a value is above the maximum. Supports {maxValue}.

minLengthFallback​

minLengthFallback: string

Validation error when input is shorter than the minimum length (no limit available).

minLengthWithLimit​

minLengthWithLimit: string

Validation error when input is shorter than the minimum length. Supports {minLength}.

minQuantityFallback​

minQuantityFallback: string

Validation error when a quantity is below the minimum (no limit available).

minQuantityWithLimit​

minQuantityWithLimit: string

Validation error when a quantity is below the minimum. Supports {minQuantityValue}.

minValueFallback​

minValueFallback: string

Validation error when a value is below the minimum (no limit available).

minValueWithLimit​

minValueWithLimit: string

Validation error when a value is below the minimum. Supports {minValue}.

nextPage​

nextPage: string

Next-page navigation button label.

optionsFetchError​

optionsFetchError: string

Shown when a field's options cannot be resolved from the questionnaire or launch context.

optionsUnavailable​

optionsUnavailable: string

Shown when a choice/open-choice field has no options to display.

pageAriaLabel​

pageAriaLabel: string

Accessible label for a page region. Supports {label}.

pickDate​

pickDate: string

Date-picker calendar button label.

previousPage​

previousPage: string

Previous-page navigation button label.

regexMismatch​

regexMismatch: string

Validation error when input fails a regex (no pattern available).

regexMismatchWithExpression​

regexMismatchWithExpression: string

Validation error when input fails a regex, including the pattern. Supports {regex}.

removeFile​

removeFile: string

Remove-file button tooltip.

removeItem​

removeItem: string

Remove-item button label/tooltip (repeats and table rows).

selectAllRows​

selectAllRows: string

Accessible label for a table select-all control. Supports {label}.

selectRow​

selectRow: string

Accessible label for a table row select control. Supports {label}.

somethingWentWrong​

somethingWentWrong: string

Fallback shown when an unsupported group item is encountered.

syncFailed​

syncFailed: string

Repopulate button tooltip shown when syncing an item fails. Supports {item}.

syncSuccessful​

syncSuccessful: string

Repopulate button tooltip after a successful sync.

syncWithServer​

syncWithServer: string

Repopulate button tooltip prompting a sync with the server.

terminologyError​

terminologyError: string

Terminology autocomplete message shown when the value set query fails.

terminologyMinCharacters​

terminologyMinCharacters: string

Terminology autocomplete hint shown when fewer than 2 characters have been typed.

terminologyNoResults​

terminologyNoResults: string

Terminology autocomplete message shown when the query returns no results.

terminologyServerFetchError​

terminologyServerFetchError: string

Shown when the terminology server errors while expanding a value set. Supports {valueSet}.

unableToLoadForm​

unableToLoadForm: string

Fallback shown when a form body fails to load.

unnamedAttachment​

unnamedAttachment: string

Fallback accessible label for an attachment field with no text.

unnamedCheckbox​

unnamedCheckbox: string

Fallback accessible label for a checkbox with no text.

unnamedCheckboxList​

unnamedCheckboxList: string

Fallback accessible label for a checkbox list with no text.

unnamedChoiceDropdown​

unnamedChoiceDropdown: string

Fallback accessible label for a choice dropdown with no text.

unnamedGroup​

unnamedGroup: string

Fallback accessible label for a group with no text.

unnamedItem​

unnamedItem: string

Fallback accessible label for an item with no text, by item type. Supports {type}.

unnamedNestedItem​

unnamedNestedItem: string

Fallback accessible label for a group with nested items and no text.

unnamedOpenLabel​

unnamedOpenLabel: string

Fallback accessible label for an open-label field with no text.

unnamedPage​

unnamedPage: string

Fallback accessible label for a page with no text.

unnamedRadioGroup​

unnamedRadioGroup: string

Fallback accessible label for a radio group with no text.

unnamedSlider​

unnamedSlider: string

Fallback accessible label for a slider with no text.

unnamedTimeField​

unnamedTimeField: string

Fallback accessible label for a time field with no text.

validationUnknownIssue​

validationUnknownIssue: string

Fallback validation error when an input is invalid but no specific issue is available.