API Scanner

Le scanner ouvre la caméra pour lire un code-barres ou un QR, une fois ou en continu, et renvoie le texte décodé à on_scan.

1 min de lectureMis à jour le 5 octobre 2026Source : docs.frappe.io

À quoi sert le scanner

Frappe s’appuie sur la bibliothèque ouverte Html5-QRCode pour lire des codes-barres, des QR codes et d’autres entrées du même genre avec la caméra de l’appareil.

Créer une instance

javascript

new frappe.ui.Scanner({ ... })

L’instance scanne un ou plusieurs codes.

Option	Effet
`container`	Élément DOM sous lequel le flux vidéo de la caméra s’affiche
`dialog`	Si `true`, le flux s’ouvre dans un dialogue
`multiple`	Si `false`, le scan s’arrête après une lecture réussie
`on_scan`	Rappel qui reçoit la valeur lue

Un seul code

javascript

new frappe.ui.Scanner({
  dialog: true,
  multiple: false,
  on_scan(data) {
    console.log(data.decodedText);
  },
});

Scan continu

javascript

const scanner = new frappe.ui.Scanner({
  dialog: true,
  multiple: true,
  on_scan(data) {
    handle_scanned_barcode(data.decodedText);
  },
});

Le commentaire publié à côté de multiple: true dit « stop after scanning one value ». Le tableau des options, lui, réserve l’arrêt après un scan au cas multiple: false.

Pour arrêter, fermez le dialogue ou appelez scanner.stop_scan().

Point d’attention

Le texte décodé est dans data.decodedText. handle_scanned_barcode est le nom utilisé par l’exemple : la source n’en donne pas le corps.