Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

barcode-scan-js

Package Overview
Dependencies
Maintainers
1
Versions
7
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

barcode-scan-js

JavaScript browser-based scanner keyboard input library for seamless integration of barcode and QR code scanning into web applications

  • 0.0.6
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
0
decreased by-100%
Maintainers
1
Weekly downloads
 
Created
Source

Barcode Scan JavaScript Library

A JavaScript library for integrating barcode and QR code scanning into web applications using a scanner-like keyboard input. This library provides a customizable element, barcode-scan, that can be easily integrated into your web projects.

Features

  • Seamless integration of barcode and QR code scanning into web applications.
  • Customizable configuration for different scanning requirements.
  • Event-driven architecture for handling scan results.
  • Supports specifying minimum and maximum barcode lengths.
  • Ignores specified input elements to prevent interference with user input.

Installation

npm install barcode-scan-js

Usage

  1. Import the library in your HTML file:
<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <title>Barcode Scan Demo</title>
</head>
<body>
    <!-- Add the barcode-scan element -->
    <barcode-scan></barcode-scan>

    <script src="main.js"></script>
</body>
</html>

  1. Use the <barcode-scan> element in your HTML:
<barcode-scan config='{"minLength": 4, "maxLength": 12, "toUpper": true}'></barcode-scan>
  1. Add an event listener in your JavaScript to capture scan results:
// Import the library
import 'barcode-scan-js';

// Get a reference to the barcode-scan element
const barcodeScanner = document.querySelector('barcode-scan');

// Add an event listener to capture scan results
barcodeScanner.addEventListener('scan', (event) => {
  const scanResult = event.detail;
  // Handle the scan result here
  console.log('Scanned Barcode:', scanResult.code);
  console.log('Is Valid:', scanResult.isValid);
  console.log('Time Taken (ms):', scanResult.timeTakenMs);
  console.log('Cleaned Code:', scanResult.cleanedCode);
});

Configuration

The <barcode-scan> element supports the following configuration options:

  • minLength: Minimum length of the scanned barcode (default: 1).
  • maxLength: Maximum length of the scanned barcode (default: 14).
  • codeStartsWith: Start of the barcode string (default: empty string).
  • codeEndsWith: End of the barcode string (default: empty string).
  • scanTimeoutMs: Timeout (in milliseconds) to consider the input as a scan (default: 3000ms).
  • ignoreOverElements: An array of HTML tag names to ignore when scanning (default: ['INPUT']).
  • toUpper: Convert scanned text to uppercase (default: false).

License

This project is licensed under the MIT License - see the LICENSE.md file for details.

Feel free to modify and expand this README to suit your project's specific needs.

Keywords

FAQs

Package last updated on 06 Oct 2023

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc