capacitor-plugin-camera-custom

v1.0.6

The Camera API provides the ability to take a photo with the camera or choose an existing one from the photo album. For more information about how to use this package see README

Latest version published 3 years ago

License: MIT

NPM

GitHub

Package Health Score

61 / 100

security
No known security issues
popularity
Limited
maintenance
Inactive
community
Active

Explore Similar Packages

Security

No known security issues

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security and license risk for significant versions

All Versions

Version				Vulnerabilities	License Risk
1.0.6	\|	08/2021	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

MIT

Security Policy

Is your project affected by vulnerabilities?

Scan your projects for vulnerabilities. Fix quickly with automated fixes. Get started with Snyk for free.

Get started free

Popularity

Limited

Weekly Downloads (1)

GitHub Stars: 529
Forks: 594
Contributors: 70

Direct Usage Popularity

The npm package capacitor-plugin-camera-custom receives a total of 1 downloads a week. As such, we scored capacitor-plugin-camera-custom popularity level to be Limited.

Based on project statistics from the GitHub repository for the npm package capacitor-plugin-camera-custom, we found that it has been starred 529 times.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Community

Active

Readme.md: Yes
Contributing.md: Yes
Code of Conduct: No
Contributors: 70
Funding: No

With more than 10 contributors for the capacitor-plugin-camera-custom repository, this is possibly a sign for a growing and inviting community.

We found a way for you to contribute to the project! Looks like capacitor-plugin-camera-custom is missing a Code of Conduct.

Embed Package Health Score Badge

Maintenance

Inactive

Commit Frequency

Open Issues: 285
Open PR: 82
Last Release: 3 years ago
Last Commit: 16 days ago

Further analysis of the maintenance status of capacitor-plugin-camera-custom based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Inactive.

An important project maintenance signal to consider for capacitor-plugin-camera-custom is that it hasn't seen any new versions released to npm in the past 12 months, and could be considered as a discontinued project, or that which receives low attention from its maintainers.

As a healthy sign for on-going project maintenance, we found that the GitHub repository had at least 1 pull request or issue interacted with by the community.

Keep your project healthy

Check your package.json

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Node.js Compatibility: not defined

Age: 3 years
Dependencies: 0 Direct
Versions: 5
Install Size: 187 kB
Dist-tags: 1
# of Files: 35
Maintainers: 1
TS Typings: No

capacitor-plugin-camera-custom has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

Readme

@capacitor/camera

The Camera API provides the ability to take a photo with the camera or choose an existing one from the photo album.

Install

npm install @capacitor/camera
npx cap sync

iOS

iOS requires the following usage description be added and filled out for your app in Info.plist:

NSCameraUsageDescription (Privacy - Camera Usage Description)
NSPhotoLibraryAddUsageDescription (Privacy - Photo Library Additions Usage Description)
NSPhotoLibraryUsageDescription (Privacy - Photo Library Usage Description)

Read about Configuring Info.plist in the iOS Guide for more information on setting iOS permissions in Xcode

Android

This API requires the following permissions be added to your AndroidManifest.xml:

The storage permissions are for reading/saving photo files.

Read about Setting Permissions in the Android Guide for more information on setting Android permissions.

Additionally, because the Camera API launches a separate Activity to handle taking the photo, you should listen for appRestoredResult in the App plugin to handle any camera data that was sent in the case your app was terminated by the operating system while the Activity was running.

Variables

This plugin will use the following project variables (defined in your app's variables.gradle file):

$androidxExifInterfaceVersion: version of androidx.exifinterface:exifinterface (default: 1.3.2)
$androidxMaterialVersion: version of com.google.android.material:material (default: 1.3.0)

PWA Notes

PWA Elements are required for Camera plugin to work.

Example

import { Camera, CameraResultType } from '@capacitor/camera';

const takePicture = async () =&gt; {
  const image = await Camera.getPhoto({
    quality: 90,
    allowEditing: true,
    resultType: CameraResultType.Uri
  });

  // image.webPath will contain a path that can be set as an image src.
  // You can access the original file using image.path, which can be
  // passed to the Filesystem API to read the raw data of the image,
  // if desired (or pass resultType: CameraResultType.Base64 to getPhoto)
  var imageUrl = image.webPath;

  // Can be set to the src of an image now
  imageElement.src = imageUrl;
};

API

getPhoto(...)

getPhoto(options: ImageOptions) =&gt; Promise

Prompt the user to pick a photo from an album, or take a new photo with the camera.

Param	Type
`options`	`ImageOptions`

Returns: Promise<Photo>

Since: 1.0.0

checkPermissions()

checkPermissions() =&gt; Promise

Check camera and photo album permissions

Returns: Promise<PermissionStatus>

Since: 1.0.0

requestPermissions(...)

requestPermissions(permissions?: CameraPluginPermissions | undefined) =&gt; Promise

Request camera and photo album permissions

Param	Type
`permissions`	`CameraPluginPermissions`

Returns: Promise<PermissionStatus>

Since: 1.0.0

Interfaces

Photo

Prop	Type	Description	Since
`base64String`	`string`	The base64 encoded string representation of the image, if using CameraResultType.Base64.	1.0.0
`dataUrl`	`string`	The url starting with 'data:image/jpeg;base64,' and the base64 encoded string representation of the image, if using CameraResultType.DataUrl.	1.0.0
`path`	`string`	If using CameraResultType.Uri, the path will contain a full, platform-specific file URL that can be read later using the Filsystem API.	1.0.0
`webPath`	`string`	webPath returns a path that can be used to set the src attribute of an image for efficient loading and rendering.	1.0.0
`exif`	`any`	Exif data, if any, retrieved from the image	1.0.0
`format`	`string`	The format of the image, ex: jpeg, png, gif. iOS and Android only support jpeg. Web supports jpeg and png. gif is only supported if using file input.	1.0.0

ImageOptions

Prop	Type	Description	Default	Since
`quality`	`number`	The quality of image to return as JPEG, from 0-100		1.0.0
`allowEditing`	`boolean`	Whether to allow the user to crop or make small edits (platform specific)		1.0.0
`resultType`	`CameraResultType`	How the data should be returned. Currently, only 'Base64', 'DataUrl' or 'Uri' is supported		1.0.0
`saveToGallery`	`boolean`	Whether to save the photo to the gallery. If the photo was picked from the gallery, it will only be saved if edited.	`: false`	1.0.0
`width`	`number`	The width of the saved image		1.0.0
`height`	`number`	The height of the saved image		1.0.0
`preserveAspectRatio`	`boolean`	This setting has no effect. Picture resizing always preserve aspect ratio.		1.0.0
`correctOrientation`	`boolean`	Whether to automatically rotate the image "up" to correct for orientation in portrait mode	`: true`	1.0.0
`source`	`CameraSource`	The source to get the photo from. By default this prompts the user to select either the photo album or take a photo.	`: CameraSource.Prompt`	1.0.0
`direction`	`CameraDirection`	iOS and Web only: The camera direction.	`: CameraDirection.Rear`	1.0.0
`presentationStyle`	`'fullscreen' \| 'popover'`	iOS only: The presentation style of the Camera.	`: 'fullscreen'`	1.0.0
`webUseInput`	`boolean`	Web only: Whether to use the PWA Element experience or file input. The default is to use PWA Elements if installed and fall back to file input. To always use file input, set this to `true`. Learn more about PWA Elements: https://capacitorjs.com/docs/pwa-elements		1.0.0
`promptLabelHeader`	`string`	Text value to use when displaying the prompt.	`: 'Photo'`	1.0.0
`promptLabelCancel`	`string`	Text value to use when displaying the prompt. iOS only: The label of the 'cancel' button.	`: 'Cancel'`	1.0.0
`promptLabelPhoto`	`string`	Text value to use when displaying the prompt. The label of the button to select a saved image.	`: 'From Photos'`	1.0.0
`promptLabelPicture`	`string`	Text value to use when displaying the prompt. The label of the button to open the camera.	`: 'Take Picture'`	1.0.0

PermissionStatus

Prop	Type
`camera`	`CameraPermissionState`
`photos`	`CameraPermissionState`

CameraPluginPermissions

Prop	Type
`permissions`	`CameraPermissionType[]`

Type Aliases

CameraPermissionState

PermissionState | 'limited'

PermissionState

'prompt' | 'prompt-with-rationale' | 'granted' | 'denied'

CameraPermissionType

'camera' | 'photos'

Enums

CameraResultType

Members	Value
`Uri`	`'uri'`
`Base64`	`'base64'`
`DataUrl`	`'dataUrl'`

CameraSource

Members	Value
`Prompt`	`'PROMPT'`
`Camera`	`'CAMERA'`
`Photos`	`'PHOTOS'`

CameraDirection

Members	Value
`Rear`	`'REAR'`
`Front`	`'FRONT'`

capacitor-plugin-camera-custom development dependencies

@capacitor/android @capacitor/core @capacitor/docgen @capacitor/ios @ionic/eslint-config @ionic/prettier-config @ionic/swiftlint-config eslint prettier prettier-plugin-java rimraf rollup swiftlint typescript

FAQs

What is capacitor-plugin-camera-custom?

The Camera API provides the ability to take a photo with the camera or choose an existing one from the photo album. Visit Snyk Advisor to see a full health score report for capacitor-plugin-camera-custom, including popularity, security, maintenance & community analysis.

Is capacitor-plugin-camera-custom popular?

The npm package capacitor-plugin-camera-custom receives a total of 1 weekly downloads. As such, capacitor-plugin-camera-custom popularity was classified as limited. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is capacitor-plugin-camera-custom well maintained?

We found indications that capacitor-plugin-camera-custom is an Inactive project. See the full package health analysis to learn more about the package maintenance status.

Is capacitor-plugin-camera-custom safe to use?

The npm package capacitor-plugin-camera-custom was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.

Last updated on 18 November-2024, at 14:29 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP

Package Health Score

Explore Similar Packages

Security and license risk for significant versions

Is your project affected by vulnerabilities?

Weekly Downloads (1)

Direct Usage Popularity

Embed Package Health Score Badge

Commit Frequency

Keep your project healthy

Check your package.json

Snyk Vulnerability Scanner

Readme

@capacitor/camera

Install

iOS

Android

Variables

PWA Notes

Example

API

getPhoto(...)

checkPermissions()

requestPermissions(...)

Interfaces

Photo

ImageOptions

PermissionStatus

CameraPluginPermissions

Type Aliases

CameraPermissionState

PermissionState

CameraPermissionType

Enums

CameraResultType

CameraSource

CameraDirection

capacitor-plugin-camera-custom development dependencies

FAQs

What is capacitor-plugin-camera-custom?

Is capacitor-plugin-camera-custom popular?

Is capacitor-plugin-camera-custom well maintained?

Is capacitor-plugin-camera-custom safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Source Code

Open Source

Container

Config

Fix identified vulnerabilities

Monitor for new issues