Cette bibliothèque utilise instascan-umd
au lieu d' instascan
comme dépendance individuelle. Si vous effectuez une mise à niveau vers des versions plus récentes, vous devez installer istascan-umd
.
npm
npm install react-instascan react instascan-umd --save
fil
yarn add react-instascan react instascan-umd
Utiliser unpkg CDN
< script type =" application/javascript " src =" https://unpkg.com/react-instascan/dist/main.js " > </ script >
Pour utiliser cette bibliothèque, vous avez besoin d'au moins :
React Instascan expose deux composants : caméras et scanner .
Avec ESModules :
import { Cameras , Scanner } from "react-instascan" ;
ou avec CommonsJS :
const { Cameras , Scanner } = require ( "react-instascan" ) ;
Le composant "Caméras" avec un accessoire de rendu et récupérera les caméras disponibles sur votre appareil.
Le composant Scanner reçoit comme accessoires la caméra et un VideoHTMLElement comme élément enfant. Ensuite, il appellera l'écouteur onScan lors de la lecture d'un code. D'autres types d'événements sont également disponibles (consultez le tableau API) :
< Cameras >
{ cameras => (
< div >
< h1 > Scan the code! < / h1 >
< Scanner camera = { cameras [ 0 ] } onScan = { onScan } >
< video style = { { width : 400 , height : 400 } } / >
< / Scanner >
< / div >
) }
< / Cameras >
nom | taper | description |
---|---|---|
caméra | objet | Objet caméra renvoyé par <Camera /> |
choix | objet | Mêmes options que Instascan.Scanner |
arrêt | booléen | Si stop est vrai, la caméra s'arrête et vice-versa |
surScan | fonction | Émis lorsqu'un code QR est scanné à l'aide de l'appareil photo en mode continu |
au démarrage | fonction | Appelé lorsque la caméra est active et que la numérisation a commencé |
à l'arrêt | fonction | Appelé lorsque la caméra et la numérisation sont arrêtées |
surActif | fonction | Émis lorsque le scanner devient actif à la suite d'un arrêt devenant faux ou lorsque l'onglet gagne le focus |
activéInactif | fonction | Émis lorsque le scanner devient inactif à la suite d'un arrêt de devenir vrai ou d'une perte de focus de l'onglet |
Pour plus de détails, consultez l'API Instascan
Bien que ce projet soit accompagné d'un exemple simple, vous souhaiterez peut-être utiliser ce code directement sur votre code pour tester et corriger d'éventuels bugs. Pour cela, vous pouvez simplement lier ce package
yarn link
Accédez à la racine de votre projet (où se trouve le package.json
de votre application), puis utilisez la version liée :
yarn link react-instascan
Maintenant, démarrez simplement le processus de construction en mode surveillance et vous verrez les changements en temps réel dans votre projet.
yarn build --watch
Pour plus d'informations sur la contribution, consultez les directives de CONTRIBUTION
Ce projet est sous licence MIT