条形码扫描器

GitHub npm crates.io

API 参考

允许您的移动应用程序使用相机扫描二维码、EAN-13 和其他类型的条形码。

支持的平台

此插件需要至少 1.77.2 的 Rust 版本

平台	级别	注释
windows
linux
macos
android
ios

设置

安装 barcode-scanner 插件即可开始使用。

自动

使用您的项目包管理器添加依赖项

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

手动

1. 在 src-tauri 文件夹中运行以下命令，将插件添加到 Cargo.toml 项目的依赖项中

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

2. 修改 lib.rs 以初始化插件

   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. 使用您首选的 JavaScript 包管理器安装 JavaScript Guest 绑定

   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

配置

在 iOS 上，条形码扫描器插件需要 NSCameraUsageDescription 信息属性列表值，该值应描述您的应用为何需要使用相机。

在 src-tauri/Info.ios.plist 文件中，添加以下代码段

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>Read QR codes</string>
  </dict>
</plist>

用法

条形码扫描器插件在 JavaScript 中可用。

import { scan, Format } from '@tauri-apps/plugin-barcode-scanner';
// when using `"withGlobalTauri": true`, you may use
// const { scan, Format } = window.__TAURI__.barcodeScanner;

// `windowed: true` actually sets the webview to transparent
// instead of opening a separate view for the camera
// make sure your user interface is ready to show what is underneath with a transparent element
scan({ windowed: true, formats: [Format.QRCode] });

权限

默认情况下，所有潜在危险的插件命令和作用域都被阻止且无法访问。您必须修改 capabilities 配置中的权限才能启用这些。

有关更多信息，请参阅功能概述，并参阅使用插件权限的分步指南。

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"]
}

默认权限

此权限集配置默认情况下公开哪些条形码扫描功能。

已授予的权限

它允许所有条形码相关的功能。

此默认权限集包括以下内容

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

权限表

标识符	描述
barcode-scanner:allow-cancel	启用 cancel 命令，无需任何预配置的作用域。
barcode-scanner:deny-cancel	拒绝 cancel 命令，无需任何预配置的作用域。
barcode-scanner:allow-check-permissions	启用 check_permissions 命令，无需任何预配置的作用域。
barcode-scanner:deny-check-permissions	拒绝 check_permissions 命令，无需任何预配置的作用域。
barcode-scanner:allow-open-app-settings	启用 open_app_settings 命令，无需任何预配置的作用域。
barcode-scanner:deny-open-app-settings	拒绝 open_app_settings 命令，无需任何预配置的作用域。
barcode-scanner:allow-request-permissions	启用 request_permissions 命令，无需任何预配置的作用域。
barcode-scanner:deny-request-permissions	拒绝 request_permissions 命令，无需任何预配置的作用域。
barcode-scanner:allow-scan	启用 scan 命令，无需任何预配置的作用域。
barcode-scanner:deny-scan	拒绝 scan 命令，无需任何预配置的作用域。
barcode-scanner:allow-vibrate	启用 vibrate 命令，无需任何预配置的作用域。
barcode-scanner:deny-vibrate	拒绝 vibrate 命令，无需任何预配置的作用域。