Lecteur de codes-barres

GitHub npm crates.io

API Reference

Permet à votre application mobile d’utiliser l’appareil photo pour scanner des codes QR, EAN-13 et d’autres types de codes-barres.

Plates-formes prises en charge

This plugin requires a Rust version of at least 1.77.2

Platform	Level	Notes
windows
linux
macos
android
ios

Configuration

Installez le plugin de lecteur de codes-barres pour commencer.

Automatique

Utilisez le gestionnaire de paquets de votre projet pour ajouter la dépendance :

npm

npm run tauri add barcode-scanner

yarn

yarn run tauri add barcode-scanner

pnpm

pnpm tauri add barcode-scanner

deno

deno task tauri add barcode-scanner

bun

bun tauri add barcode-scanner

cargo

cargo tauri add barcode-scanner

Manuel

1. Exécutez la commande suivante dans le dossier src-tauri pour ajouter le plugin aux dépendances du projet dans Cargo.toml :

   cargo add tauri-plugin-barcode-scanner --target 'cfg(any(target_os = "android", target_os = "ios"))'

2. Modifiez lib.rs pour initialiser le plugin :

   src-tauri/src/lib.rs

   #[cfg_attr(mobile, tauri::mobile_entry_point)]
   pub fn run() {
       tauri::Builder::default()
           .setup(|app| {
               #[cfg(mobile)]
               app.handle().plugin(tauri_plugin_barcode_scanner::init());
               Ok(())
           })
           .run(tauri::generate_context!())
           .expect("error while running tauri application");
   }

3. Installez les liaisons JavaScript Guest en utilisant votre gestionnaire de paquets JavaScript préféré :

   npm

   npm install @tauri-apps/plugin-barcode-scanner

   yarn

   yarn add @tauri-apps/plugin-barcode-scanner

   pnpm

   pnpm add @tauri-apps/plugin-barcode-scanner

   deno

   deno add npm:@tauri-apps/plugin-barcode-scanner

   bun

   bun add @tauri-apps/plugin-barcode-scanner

Configuration

Sur iOS, le plugin de lecteur de codes-barres nécessite la valeur de propriété NSCameraUsageDescription, qui doit décrire pourquoi votre application a besoin d’utiliser l’appareil photo.

Dans le fichier src-tauri/Info.ios.plist, ajoutez l’extrait suivant :

src-tauri/Info.ios.plist

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
  <dict>
    <key>NSCameraUsageDescription</key>
    <string>Lire les codes QR</string>
  </dict>
</plist>

Utilisation

Le plugin de lecteur de codes-barres est disponible en JavaScript.

import { scan, Format } from '@tauri-apps/plugin-barcode-scanner';
// lors de l'utilisation de `"withGlobalTauri": true`, vous pouvez utiliser
// const { scan, Format } = window.__TAURI__.barcodeScanner;

// `windowed: true` définit en fait la webview comme transparente
// au lieu d'ouvrir une vue séparée pour l'appareil photo
// assurez-vous que votre interface utilisateur est prête à montrer ce qui est en dessous avec un élément transparent
scan({ windowed: true, formats: [Format.QRCode] });

Permissions

Par défaut, toutes les commandes et portées de plugin potentiellement dangereuses sont bloquées et inaccessibles. Vous devez modifier les permissions dans votre configuration capabilities pour les activer.

Consultez la Vue d’ensemble des capacités pour plus d’informations et le guide étape par étape pour utiliser les permissions de plugin.

src-tauri/capabilities/mobile.json

{
  "$schema": "../gen/schemas/mobile-schema.json",
  "identifier": "mobile-capability",
  "windows": ["main"],
  "platforms": ["iOS", "android"],
  "permissions": ["barcode-scanner:allow-scan", "barcode-scanner:allow-cancel"]
}

Default Permission

This permission set configures which barcode scanning features are by default exposed.

Granted Permissions

It allows all barcode related features.

This default permission set includes the following:

• allow-cancel
• allow-check-permissions
• allow-open-app-settings
• allow-request-permissions
• allow-scan
• allow-vibrate

Permission Table

Identifier	Description
barcode-scanner:allow-cancel	Enables the cancel command without any pre-configured scope.
barcode-scanner:deny-cancel	Denies the cancel command without any pre-configured scope.
barcode-scanner:allow-check-permissions	Enables the check_permissions command without any pre-configured scope.
barcode-scanner:deny-check-permissions	Denies the check_permissions command without any pre-configured scope.
barcode-scanner:allow-open-app-settings	Enables the open_app_settings command without any pre-configured scope.
barcode-scanner:deny-open-app-settings	Denies the open_app_settings command without any pre-configured scope.
barcode-scanner:allow-request-permissions	Enables the request_permissions command without any pre-configured scope.
barcode-scanner:deny-request-permissions	Denies the request_permissions command without any pre-configured scope.
barcode-scanner:allow-scan	Enables the scan command without any pre-configured scope.
barcode-scanner:deny-scan	Denies the scan command without any pre-configured scope.
barcode-scanner:allow-vibrate	Enables the vibrate command without any pre-configured scope.
barcode-scanner:deny-vibrate	Denies the vibrate command without any pre-configured scope.