Socket
Socket
Sign inDemoInstall

use-scan-detection

Package Overview
Dependencies
Maintainers
1
Versions
9
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

use-scan-detection

A react hook for detecting barcode scanner input.


Version published
Weekly downloads
1.8K
decreased by-3.66%
Maintainers
1
Weekly downloads
 
Created
Source

useScanDetection

npm downloads

A react hook for detecting barcode scanners in the DOM.

Installation

npm i use-scan-detection

Usage

useScanDetection({
    onComplete: (code) => { console.log(code) }
});

Parameters

Parameters are supplied by a config object:

ParameterDescription
averageWaitTimeAverage time between characters in milliseconds. Used to determine if input is from keyboard or a scanner. Defaults to 50.
timeToEvaluateTime to evaluate the buffer after each character.
startCharacterOptional. Character that barcode scanner prefixes input with. Buffer only starts if this character is read first.
endCharacterOptional. Character that barcode scanner suffixes input with. Buffer is evaluated early if this character is read. Defaults to line return and escape.
onCompleteFunction that is called when a complete barcode is scanned. Function is called with a single string which is the complete code.
onErrorOptional. Function that is called when an incomplete barcode is scanned. Function is called with a single string which is the incomplete code.
minLengthMinimum number of characters for a barcode to successfully read. Should be greater than 0. Defaults to 1.
ignoreIfFocusOnOptional. DOM element that if focused prevents codes from being read.
stopPropagationWhether to call stopPropagation on each key event. Defaults to false.
preventDefaultWhether to call preventDefault on each key event. Defaults to false.
containerDOM element to listen for keydown events in. Defaults to document.

Return

This hook returns nothing.

Example

import React, { useState } from 'react';
import useScanDetection from 'use-scan-detection';

const Input = () => {
    const [value, setValue] = useState("");

    useScanDetection({
        onComplete: setValue,
        minLength: 13 // EAN13
    });

    return (
        <input 
            value={value} 
            type="text"
        />
    );
};

export default Input

License

MIT Licensed

Keywords

FAQs

Package last updated on 30 Oct 2019

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