npmpackage.info

Gathering detailed insights and metrics for @rinse/react-html5-camera-photo

@rinse/react-html5-camera-photo

HTML5 camera photo

1.5.3

MIT

JavaScript

15,808 1.7

Installations

npm install @rinse/react-html5-camera-photo

Pull Requests

Open

1

Total

1

Closed

0

Issues

Open

0

Total

0

Closed

0

Releases

1.0.0

Published on 10 Feb 2021

View all 1 releases

Developer

rinse-inc

Developer Guide

BETA

Module System

CommonJS

Min. Node Version

Typescript Support

No

Node Version

14.15.5

NPM Version

6.14.11 Statistics

243 Commits

1 Watching

5 Branches

Updated on 28 Oct 2019

Languages

JavaScript (96.01%)

CSS (2.72%)

HTML (1.27%)

Total Downloads

Cumulative downloads

Total Downloads

15,808

Last day

-94.6%

Compared to previous day

Last week

-14%

Compared to previous week

Last month

33.7%

607

Compared to previous month

Last year

49%

8,927

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Versions

react-html5-camera-photo

The first objective of this package comes from the need to get the same look and feel of a native mobile camera app but with a react component. For those who want to build with their own css and need an abstraction of getUserMedia() take a look of jslib-html5-camera-photo with react.

Requirement

react: >=16.0.0
react-dom: >=16.0.0

LiveDemo

Demo of react-html5-camera-photo

Required Working Environment for getUserMedia()

https or localhost : The getUserMedia() method is only available in secure contexts (https or localhost). If a document isn't loaded in a secure context, the navigator.mediaDevices property is undefined, making access to getUserMedia() impossible. Attempting to access getUserMedia() in this situation will result in a TypeError. See developer.mozilla.org
iOS >= 11 WebRTC issue with webkit (Chrome & Firefox) : Apple restricts WebRTC to Safari only so it mean that you can't use the getUserMedia() with Firefox and Chrome. So getUserMedia() is not supported yet, for "security reasons". See Stackoverflow

Installation

1npm install --save react-html5-camera-photo

1yarn add react-html5-camera-photo

Both Yarn and npm download packages from the npm registry.

Getting started

parameter	Description
onTakePhoto(dataUri):	Event function called when a photo is taken. the dataUri is passed as a parameter.

Minimum ES6 example

1import React, { Component } from 'react';
2import Camera from 'react-html5-camera-photo';
3import 'react-html5-camera-photo/build/css/index.css';
4
5class App extends Component {
6  onTakePhoto (dataUri) {
7    // Do stuff with the dataUri photo...
8    console.log('takePhoto');
9  }
10
11  render () {
12    return (
13      <div className="App">
14        <Camera
15          onTakePhoto = { (dataUri) => { this.onTakePhoto(dataUri); } }
16        />
17      </div>
18    );
19  }
20}
21
22export default App;

API

PropTypes

Properties	Type	Description
onCameraStart(): (optional)	Event	Callback called when the camera is started.
onCameraStop(): (optional)	Event	Callback called when the camera is stopped.
onCameraError(error): (Optional)	Event	Callback called with the error object as parameter when error occur while opening the camera. Often the permission.
onTakePhoto(dataUri): (Optional)	Event	The function called when a photo is taken. the dataUri is passed as a parameter.
onTakePhotoAnimationDone(dataUri): (Optional)	Event	The function called when a photo is taken and the animation is done. the dataUri is passed as a parameter.
idealFacingMode: (Optional) (Dynamic)	String	The ideal facing mode of the camera, `environment` or `user`, the default is the default of the browser. Use `FACING_MODES` constant to get the right string. Example :. FACING_MODES.ENVIRONMENT or FACING_MODES.USER
idealResolution: (Optional) (Dynamic)	Object	Object of the ideal resolution of the camera, `{width: Integer, height: Integer}`, the default is the default of the browser.
isMaxResolution: (Optional) (Dynamic)	Boolean	If is true, the camera will start with his own maximum resolution, the default is false.
isImageMirror: (Optional)	Boolean	If is true, the camera image will be mirror, the default is true.
isSilentMode:(Optional)	Boolean	If is true, the camera do not play click sound when the photo was taken, the default is false.
isFullscreen: (Optional)	Boolean	If is true, the camera image will be set fullscreen to force the maximum width and height of the viewport, the default is false.
isDisplayStartCameraError: (Optional)	Boolean	If is true, if the camera start with error, it will show the error between h1 tag on the top of the component. Useful to notify the user about permission error, the default is true.
sizeFactor: (Optional)	Number	Number of the factor resolution. Example, a sizeFactor of `1` get the same resolution of the camera while sizeFactor of `0.5` get the half resolution of the camera. The sizeFactor can be between range of `]0, 1]` and the default value is `1`.
imageType:: (Optional)	String	String used to get the desired image type between `jpg` or `png`. to specify the imageType use the constant IMAGE_TYPES, for example to specify jpg format use IMAGE_TYPES.JPG. The default imageType is `png`. Use `IMAGE_TYPES` constant to get the right image type Example:. IMAGE_TYPES.JPG or IMAGE_TYPES.PNG
imageCompression:: (Optional)	Number	Number used to get the desired compression when `jpg` is selected. choose a compression between `[0, 1]`, 1 is maximum, 0 is minimum. The default value imageCompression is `0.92`.

Dynamic : If the prop is dynamic, it mean that you can change that prop dynamically without umount the component (removing it). You can do it by a setState() inside the parent component. Checkout the demo example: ./src/demo/AppWithDynamicProperties.js

Example of closing the camera and image preview after take a photo

Probably the typical usage of using this component is to preview the image and close the camera after take a photo. You can take a look of all the code including the ImagePreview component here : ./src/demo/AppWithImagePreview

1import React, { Component } from 'react';
2import Camera from 'react-html5-camera-photo';
3import 'react-html5-camera-photo/build/css/index.css';
4
5import ImagePreview from './ImagePreview'; // source code : ./src/demo/AppWithImagePreview/ImagePreview
6
7class App extends Component {
8  constructor (props, context) {
9    super(props, context);
10    this.state = { dataUri: null };
11    this.onTakePhotoAnimationDone = this.onTakePhotoAnimationDone.bind(this);
12  }
13
14  onTakePhotoAnimationDone (dataUri) {
15    console.log('takePhoto');
16    this.setState({ dataUri });
17  }
18
19  render () {
20    return (
21      <div className="App">
22        {
23          (this.state.dataUri)
24            ? <ImagePreview dataUri={this.state.dataUri} />
25            : <Camera onTakePhotoAnimationDone = {this.onTakePhotoAnimationDone} />
26        }
27      </div>
28    );
29  }
30}
31
32export default App;

Example with all props used

1import React, { Component } from 'react';
2import Camera, { FACING_MODES, IMAGE_TYPES } from 'react-html5-camera-photo';
3import 'react-html5-camera-photo/build/css/index.css';
4
5class App extends Component {
6  onTakePhoto (dataUri) {
7    // Do stuff with the photo...
8    console.log('takePhoto');
9  }
10
11  onTakePhotoAnimationDone (dataUri) {
12    // Do stuff with the photo...
13    console.log('takePhoto');
14  }
15
16  onCameraError (error) {
17    console.error('onCameraError', error);
18  }
19
20  onCameraStart (stream) {
21    console.log('onCameraStart');
22  }
23
24  onCameraStop () {
25    console.log('onCameraStop');
26  }
27
28  render () {
29    return (
30      <div className="App">
31        <Camera
32          onTakePhoto = { (dataUri) => { this.onTakePhoto(dataUri); } }
33          onTakePhotoAnimationDone = { (dataUri) => { this.onTakePhotoAnimationDone(dataUri); } }
34          onCameraError = { (error) => { this.onCameraError(error); } }
35          idealFacingMode = {FACING_MODES.ENVIRONMENT}
36          idealResolution = {{width: 640, height: 480}}
37          imageType = {IMAGE_TYPES.JPG}
38          imageCompression = {0.97}
39          isMaxResolution = {false}
40          isImageMirror = {false}
41          isSilentMode = {true}
42          isDisplayStartCameraError = {true}
43          isFullscreen = {true}
44          sizeFactor = {1}
45          onCameraStart = { (stream) => { this.onCameraStart(stream); } }
46          onCameraStop = { () => { this.onCameraStop(); } }
47        />
48      </div>
49    );
50  }
51}
52
53export default App;

Bug report (issues)

Before sending a bug report of camera error, make sure that getUserMedia() is supported by your browser. Please test your camera on : DetectRTC | Is WebRTC Supported In Your Browser? If the System has Webcam is supported, please send the screenshot of the first 7 first rows of the table.

FAQ

What if i want to improve the code or add functionalities?

Please take a look into the CONTRIBUTING.md

No vulnerabilities found.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

License

Determines if the project has defined a license.

0

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

SAST

Determines if the project uses static code analysis.

0

Maintained

Determines if the project is "actively maintained".

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Reason

123 existing vulnerabilities detected

Details

Warn: Project is vulnerable to: GHSA-6chw-6frg-f759
Warn: Project is vulnerable to: GHSA-v88g-cgmw-v5xw
Warn: Project is vulnerable to: GHSA-whgm-jr23-g3j9
Warn: Project is vulnerable to: GHSA-93q8-gq69-wqmw
Warn: Project is vulnerable to: GHSA-fwr7-v2mv-hh25
Warn: Project is vulnerable to: GHSA-67hx-6x53-jw92
Warn: Project is vulnerable to: GHSA-qwcr-r2fm-qrc7
Warn: Project is vulnerable to: GHSA-cwfw-4gq5-mrqx
Warn: Project is vulnerable to: GHSA-g95f-p29q-9xw4
Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg
Warn: Project is vulnerable to: GHSA-x9w5-v3q2-3rhw
Warn: Project is vulnerable to: GHSA-257v-vj4p-3w2h
Warn: Project is vulnerable to: GHSA-pxg6-pf52-xh8x
Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275
Warn: Project is vulnerable to: GHSA-gxpj-cx7g-858c
Warn: Project is vulnerable to: GHSA-w573-4hg7-7wgq
Warn: Project is vulnerable to: GHSA-3wcq-x3mq-6r9p
Warn: Project is vulnerable to: GHSA-ff7x-qrg7-qggm
Warn: Project is vulnerable to: GHSA-vh7m-p724-62c2
Warn: Project is vulnerable to: GHSA-r9p9-mrjm-926w
Warn: Project is vulnerable to: GHSA-434g-2637-qmqr
Warn: Project is vulnerable to: GHSA-49q7-c7j4-3p7m
Warn: Project is vulnerable to: GHSA-977x-g7h5-7qgw
Warn: Project is vulnerable to: GHSA-f7q4-pwc6-w24p
Warn: Project is vulnerable to: GHSA-fc9h-whq2-v747
Warn: Project is vulnerable to: GHSA-4gmj-3p3h-gm8h
Warn: Project is vulnerable to: GHSA-6h5x-7c5m-7cr7
Warn: Project is vulnerable to: GHSA-rv95-896h-c2vc
Warn: Project is vulnerable to: GHSA-qw6h-vgh9-j6wx
Warn: Project is vulnerable to: GHSA-74fj-2j2h-c42q
Warn: Project is vulnerable to: GHSA-pw2r-vq6v-hr8c
Warn: Project is vulnerable to: GHSA-jchw-25xp-jwwc
Warn: Project is vulnerable to: GHSA-cxjh-pqwp-8mfp
Warn: Project is vulnerable to: GHSA-8r6j-v8pm-fqw3
Warn: Project is vulnerable to: MAL-2023-462
Warn: Project is vulnerable to: GHSA-8mmm-9v2q-x3f9
Warn: Project is vulnerable to: GHSA-pfrx-2q88-qq97
Warn: Project is vulnerable to: GHSA-2cf5-4w76-r9qv
Warn: Project is vulnerable to: GHSA-3cqr-58rm-57f8
Warn: Project is vulnerable to: GHSA-g9r4-xpmj-mj65
Warn: Project is vulnerable to: GHSA-q2c6-c6pm-g3gh
Warn: Project is vulnerable to: GHSA-765h-qjxv-5f44
Warn: Project is vulnerable to: GHSA-f2jv-r9rf-7988
Warn: Project is vulnerable to: GHSA-43f8-2h32-f4cj
Warn: Project is vulnerable to: GHSA-pfq8-rq6v-vf5m
Warn: Project is vulnerable to: GHSA-6x33-pw7p-hmpq
Warn: Project is vulnerable to: GHSA-c7qv-q95q-8v27
Warn: Project is vulnerable to: GHSA-qqgx-2p2h-9c37
Warn: Project is vulnerable to: GHSA-78xj-cgh5-2h22
Warn: Project is vulnerable to: GHSA-2p57-rm9w-gvfp
Warn: Project is vulnerable to: GHSA-7r28-3m3f-r2pr
Warn: Project is vulnerable to: GHSA-r8j5-h5cx-65gg
Warn: Project is vulnerable to: GHSA-2pr6-76vf-7546
Warn: Project is vulnerable to: GHSA-8j8c-7jfh-h6hx
Warn: Project is vulnerable to: GHSA-896r-f27r-55mw
Warn: Project is vulnerable to: GHSA-9c47-m6qq-7p4h
Warn: Project is vulnerable to: GHSA-6c8f-qphg-qjgp
Warn: Project is vulnerable to: GHSA-76p3-8jx3-jpfq
Warn: Project is vulnerable to: GHSA-3rfm-jhwj-7488
Warn: Project is vulnerable to: GHSA-hhq3-ff78-jv3g
Warn: Project is vulnerable to: GHSA-p6mc-m468-83gw
Warn: Project is vulnerable to: GHSA-29mw-wpgm-hmr9
Warn: Project is vulnerable to: GHSA-35jh-r3h4-6jhm
Warn: Project is vulnerable to: GHSA-4xcv-9jjx-gfj3
Warn: Project is vulnerable to: GHSA-7wpw-2hjm-89gp
Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv
Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3
Warn: Project is vulnerable to: GHSA-vh95-rmgr-6w4m / GHSA-xvch-5gv4-984h
Warn: Project is vulnerable to: GHSA-92xj-mqp7-vmcj
Warn: Project is vulnerable to: GHSA-wxgw-qj99-44c2
Warn: Project is vulnerable to: GHSA-5rrq-pxf6-6jx5
Warn: Project is vulnerable to: GHSA-8fr3-hfg3-gpgp
Warn: Project is vulnerable to: GHSA-gf8q-jrpm-jvxq
Warn: Project is vulnerable to: GHSA-2r2c-g63r-vccr
Warn: Project is vulnerable to: GHSA-cfm4-qjh2-4765
Warn: Project is vulnerable to: GHSA-x4jg-mjrx-434g
Warn: Project is vulnerable to: GHSA-5fw9-fq32-wv5p
Warn: Project is vulnerable to: GHSA-rp65-9cf3-cjxr
Warn: Project is vulnerable to: GHSA-hj48-42vr-x3v9
Warn: Project is vulnerable to: GHSA-9wv6-86v2-598j
Warn: Project is vulnerable to: GHSA-566m-qj78-rww5
Warn: Project is vulnerable to: GHSA-7fh5-64p2-3v2j
Warn: Project is vulnerable to: GHSA-hrpp-h998-j3pp
Warn: Project is vulnerable to: GHSA-5q6m-3h65-w53x
Warn: Project is vulnerable to: GHSA-p8p7-x288-28g6
Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw
Warn: Project is vulnerable to: GHSA-m6fv-jmcg-4jfg
Warn: Project is vulnerable to: GHSA-h9rv-jmmf-4pgx
Warn: Project is vulnerable to: GHSA-hxcc-f52p-wc94
Warn: Project is vulnerable to: GHSA-cm22-4g7w-348p
Warn: Project is vulnerable to: GHSA-g4rg-993r-mgx7
Warn: Project is vulnerable to: GHSA-c9g6-9335-x697
Warn: Project is vulnerable to: GHSA-vx3p-948g-6vhq
Warn: Project is vulnerable to: GHSA-3jfq-g458-7qm9
Warn: Project is vulnerable to: GHSA-r628-mhmh-qjhw
Warn: Project is vulnerable to: GHSA-9r2w-394v-53qc
Warn: Project is vulnerable to: GHSA-5955-9wpr-37jh
Warn: Project is vulnerable to: GHSA-qq89-hq3f-393p
Warn: Project is vulnerable to: GHSA-f5x3-32g6-xq36
Warn: Project is vulnerable to: GHSA-jgrx-mgxx-jf9v
Warn: Project is vulnerable to: GHSA-72xf-g2v4-qvf3
Warn: Project is vulnerable to: GHSA-7p7h-4mm5-852v
Warn: Project is vulnerable to: GHSA-3329-pjwv-fjpg
Warn: Project is vulnerable to: GHSA-p6j9-7xhc-rhwp
Warn: Project is vulnerable to: GHSA-89gv-h8wf-cg8r
Warn: Project is vulnerable to: GHSA-gcv8-gh4r-25x6
Warn: Project is vulnerable to: GHSA-gmv4-r438-p67f
Warn: Project is vulnerable to: GHSA-8h2f-7jc4-7m3m
Warn: Project is vulnerable to: GHSA-3vjf-82ff-p4r3
Warn: Project is vulnerable to: GHSA-g694-m8vq-gv9h
Warn: Project is vulnerable to: GHSA-9m6j-fcg5-2442
Warn: Project is vulnerable to: GHSA-hh27-ffr2-f2jc
Warn: Project is vulnerable to: GHSA-rqff-837h-mm52
Warn: Project is vulnerable to: GHSA-8v38-pw62-9cw2
Warn: Project is vulnerable to: GHSA-hgjh-723h-mx2j
Warn: Project is vulnerable to: GHSA-jf5r-8hm2-f872
Warn: Project is vulnerable to: GHSA-wr3j-pwj9-hqq6
Warn: Project is vulnerable to: GHSA-cf66-xwfp-gvc4
Warn: Project is vulnerable to: GHSA-g78m-2chm-r7qv
Warn: Project is vulnerable to: GHSA-c4w7-xm78-47vh
Warn: Project is vulnerable to: GHSA-p9pc-299p-vxgp
Warn: Project is vulnerable to: GHSA-62gr-4qp9-h98f
Warn: Project is vulnerable to: GHSA-f52g-6jhx-586p

Score

1.7

/10

Last Scanned on 2024-11-18

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More

@rinse/react-html5-camera-photo

Installations

Pull Requests

1

1

0

Issues

0

0

0

Releases

Developer

Developer Guide

CommonJS

No

14.15.5

6.14.11

Statistics

Languages

Total Downloads

15,808

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

Peer Dependencies

Dev Dependencies

react-html5-camera-photo

Requirement

LiveDemo

Required Working Environment for getUserMedia()

Installation

Getting started

API

PropTypes

Example of closing the camera and image preview after take a photo

Example with all props used

Bug report (issues)

FAQ

10

10

0

0

0

0

0

0

0

0

1.7

/10