Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

TokenDescription
labelTranslationsLabel text on scanner button with multi-language support
dialogTitleTranslationsTitle text in scan dialog with multi-language support
alternativeInputLabelTranslationsLabel for manual input field in dialog with multi-language support
confirmButtonLabelTranslationsLabel text for the confirmation button in dialog with multi-language support
closeDialogOnSuccessAuto-closes dialog after a successful scan
hiddenControls whether the component is visible in the form
saveInLocalStoragePersists scanned value in local storage across sessions
defaultValueSets an initial value used when form is reset
readonlyDisplays value but disables scanning
dataFieldField name for submitting form data
controlsRequestTypeDefines how data is sent in HTTP request (BODY, HEADER, PATH)
authorizationDisablePolicy set defining when scanner is disabled
eventsConfigurable component events
ON_INIT (Events)Event triggered when component is initialized
ON_DESTROY (Events)Event triggered when component is removed from DOM
ON_SCAN_START (Events)Event triggered when user activates scanner
ON_SCAN_SUCCESS (Events)Event triggered when a code is successfully scanned
ON_SCAN_ERROR (Events)Event triggered when an error occurs during scanning
dataTestIdIdentifier for automated testing

...

  • Figma: https://www.figma.com/design/yck1tcUXgdQ5aYX6iUAwrO/GE---Astronaut-Design-System?node-id=15534-397394&t=ftfrOGkPzlG2GaTo-1
  • Live style guide: tba

Guidelines

Usage

  • Capture QR/bar/visual codes with a clear CTA. Set the button text via labelTranslations (e.g., “Scan code”).
  • Provide a manual fallback in the dialog. Configure alternativeInputLabelTranslations and confirmButtonLabelTranslations.
  • Control presence within the form. Toggle visibility using hidden.

...