Installations
npm install vue-picture-input-kxtremeDeveloper Guide
BETA
Typescript
No
Module System
CommonJS
Node Version
9.2.1
NPM Version
5.5.1
Score
67.7
Supply Chain
99.2
Quality
75.2
Maintenance
100
Vulnerability
100
License
Releases
4
Contributors
21
Unable to fetch Contributors
Languages
2
Vue
JavaScript
Vue (96.5%)
JavaScript (3.5%)
Developer
alessiomaffeis
Download Statistics
Total Downloads
1,075
Last Day
1
Last Week
7
Last Month
10
Last Year
91
GitHub Statistics
887 Stars
300 Commits
156 Forks
21 Watching
4 Branches
21 Contributors
Bundle Size
870.00 B
Minified
385.00 B
Minified + Gzipped
Maintainers
1
Package Meta Information
Latest Version
2.1.7
Package Id
vue-picture-input-kxtreme@2.1.7
Unpacked Size
164.13 kB
Size
46.99 kB
File Count
9
NPM Version
5.5.1
Node Version
9.2.1
Total Downloads
Cumulative downloads
Total Downloads
1,075
Last day
0%
1
Compared to previous day
Last week
0%
7
Compared to previous week
Last month
42.9%
10
Compared to previous month
Last year
-14.2%
91
Compared to previous year
Daily Downloads
Weekly Downloads
Monthly Downloads
Yearly Downloads
Versions
vue-picture-input
Mobile-friendly picture file input Vue.js component with image preview, drag and drop, EXIF orientation, and more.
Installation
npm
1npm install --save vue-picture-input
yarn
1yarn add vue-picture-input
Usage
1<template> 2 <div class="hello"> 3 <picture-input 4 ref="pictureInput" 5 @change="onChange" 6 width="600" 7 height="600" 8 margin="16" 9 accept="image/jpeg,image/png" 10 size="10" 11 buttonClass="btn" 12 :customStrings="{ 13 upload: '<h1>Bummer!</h1>', 14 drag: 'Drag a 😺 GIF or GTFO' 15 }"> 16 </picture-input> 17 </div> 18</template>
1<script> 2import PictureInput from 'vue-picture-input' 3 4export default { 5 name: 'app', 6 data () { 7 return { 8 } 9 }, 10 components: { 11 PictureInput 12 }, 13 methods: { 14 onChange (image) { 15 console.log('New picture selected!') 16 if (image) { 17 console.log('Picture loaded.') 18 this.image = image 19 } else { 20 console.log('FileReader API not supported: use the <form>, Luke!') 21 } 22 } 23 } 24} 25</script>
You can also use it directly in the browser through unpkg's CDN (or jsDelivr):
1<!DOCTYPE html> 2<html> 3<head> 4 <script src="https://unpkg.com/vue"></script> 5 <script src="https://unpkg.com/vue-picture-input"></script> 6 <title>In the browser!</title> 7</head> 8<body> 9 <div id="app"> 10 <p>{{ message }}</p> 11 <picture-input></picture-input> 12 </div> 13 <script> 14 var app = new Vue({ 15 el: '#app', 16 data: { 17 message: 'Hello Vue!' 18 }, 19 components: { 20 'picture-input': PictureInput 21 } 22 }) 23 </script> 24</body> 25</html>
Example project
Try it on CodeSandbox: https://codesandbox.io/s/github/alessiomaffeis/vue-picture-input-example
Props
- width, height: (pixels, optional) the maximum width and height of the preview container. The picture will be resized and centered to cover this area. If not specified, the preview container will expand to full width, 1:1 square ratio.
- crop: (boolean, optional) set :crop="false" if you wish to disable cropping. The image will be resized and centered in order to be fully contained in the preview container. Default value: true.
- margin: (pixels, optional) the margin around the preview container. Default value: 0.
- radius: (percentage, optional) The border-radius value for the container. Set radius="50" to get a circular container. Default value: 0.
- plain: (boolean, optional) Set :plain="true" to remove the inner border and text. Default value: false.
- accept: (media type, optional) the accepted image type(s), e.g. image/jpeg, image/gif, etc. Default value: 'image/*'.
- size: (MB, optional) the maximum accepted file size in megabytes.
- removable: (boolean, optional) set :removable="true" if you want to display a "Remove Photo" button. Default value: false.
- hideChangeButton: (boolean, optional) set :hideChangeButton="true" if you want to hide the "Change Photo" button. Default value: false.
- id, name: (string, optional) the id and name attributes of the HTML input element.
- buttonClass: (string, optional) the class which will be applied to the 'Change Photo' button. Default value: 'btn btn-primary button'.
- removeButtonClass: (string, optional) the class which will be applied to the 'Remove Photo' button. Default value: 'btn btn-secondary button secondary'.
- prefill: (image url or File object, optional) use this to specify the path to a default image (or a File object) to prefill the input with. Default value: empty.
- prefillOptions: (object, optional) use this if you prefill with a data uri scheme to specify a file name and a media or file type:
fileName: (string, optional) the file name
fileType: (string, optional) the file type of the image, i.e. "png", or
mediaType: (string, optional) the media type of the image, i.e. "image/png"
- toggleAspectRatio: (boolean, optional) set :toggleAspectRatio="true" to show a button for toggling the canvas aspect ratio (Landscape/Portrait) on a non-square canvas. Default value: false.
- autoToggleAspectRatio: (boolean, optional) set :autoToggleAspectRatio="true" to enable automatic canvas aspect ratio change to match the selected picture's. Default value: false.
- changeOnClick: (boolean, optional) set :changeOnClick="true" to open image selector when user click on the image. Default value: true.
- aspectButtonClass: (string, optional) the class which will be applied to the 'Landscape/Portrait' button. Default value: 'btn btn-secondary button secondary'.
- zIndex: (number, optional) The base z-index value. In case of issues with your layout, change :zIndex="..." to a value that suits you better. Default value: 10000.
- alertOnError: (boolean, optional) Set :alertOnError="false" to disable displaying alerts on attemps to select file with wrong type or too big. Default value: true.
- customStrings: (object, optional) use this to provide one or more custom strings (see the example above). Here are the available strings and their default values:
1{ 2 upload: '<p>Your device does not support file uploading.</p>', // HTML allowed 3 drag: 'Drag an image or <br>click here to select a file', // HTML allowed 4 tap: 'Tap here to select a photo <br>from your gallery', // HTML allowed 5 change: 'Change Photo', // Text only 6 remove: 'Remove Photo', // Text only 7 select: 'Select a Photo', // Text only 8 selected: '<p>Photo successfully selected!</p>', // HTML allowed 9 fileSize: 'The file size exceeds the limit', // Text only 10 fileType: 'This file type is not supported.', // Text only 11 aspect: 'Landscape/Portrait' // Text only 12}
Events
- change: emitted on (successful) picture change (prefill excluded). The image is passed along with the event as a Base64 Data URI string. If you need to access the underlying image from the parent component, add a ref attribute to picture-input (see the example above). You may want to use this.$refs.pictureInput.image (Base64 Data URI string) or this.$refs.pictureInput.file (File Object)
- prefill: emitted on default image prefill.
- remove: emitted on picture remove.
- click: emitted on picture click.
- error: emitted on error, along with an object with type, message, and optional additional parameters.
TODOs
- Client-side resizing and cropping
- Add tests
Contributions
All contributions are welcome, as long as they are within the scope of the project. Please open a new issue before submitting a pull request.
You should follow the Javascript Standard Style guidelines: https://github.com/feross/standard/blob/master/RULES.md#javascript-standard-style
No vulnerabilities found.
Reason
no binaries found in the repo
Reason
license file detected
Details
- Info: project has a license file: LICENSE:0
- Info: FSF or OSI recognized license: MIT License: LICENSE:0
Reason
Found 0/12 approved changesets -- score normalized to 0
Reason
0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
security policy file not detected
Details
- Warn: no security policy file detected
- Warn: no security file to analyze
- Warn: no security file to analyze
- Warn: no security file to analyze
Reason
project is not fuzzed
Details
- Warn: no fuzzer integrations found
Reason
branch protection not enabled on development/release branches
Details
- Warn: branch protection not enabled for branch 'master'
Reason
SAST tool is not run on all commits -- score normalized to 0
Details
- Warn: 0 commits out of 18 are checked with a SAST tool
Reason
37 existing vulnerabilities detected
Details
- Warn: Project is vulnerable to: GHSA-whgm-jr23-g3j9
- Warn: Project is vulnerable to: GHSA-67hx-6x53-jw92
- Warn: Project is vulnerable to: GHSA-qwcr-r2fm-qrc7
- Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg
- Warn: Project is vulnerable to: GHSA-pxg6-pf52-xh8x
- Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275
- 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-rv95-896h-c2vc
- Warn: Project is vulnerable to: GHSA-qw6h-vgh9-j6wx
- Warn: Project is vulnerable to: GHSA-cxjh-pqwp-8mfp
- Warn: Project is vulnerable to: GHSA-c7qv-q95q-8v27
- Warn: Project is vulnerable to: GHSA-78xj-cgh5-2h22
- Warn: Project is vulnerable to: GHSA-2p57-rm9w-gvfp
- Warn: Project is vulnerable to: GHSA-9c47-m6qq-7p4h
- Warn: Project is vulnerable to: GHSA-35jh-r3h4-6jhm
- Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv
- Warn: Project is vulnerable to: GHSA-mwcw-c2x4-8c55
- 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-rp65-9cf3-cjxr
- Warn: Project is vulnerable to: GHSA-9wv6-86v2-598j
- Warn: Project is vulnerable to: GHSA-rhx6-c78j-4q9w
- Warn: Project is vulnerable to: GHSA-7fh5-64p2-3v2j
- Warn: Project is vulnerable to: GHSA-m6fv-jmcg-4jfg
- Warn: Project is vulnerable to: GHSA-cm22-4g7w-348p
- Warn: Project is vulnerable to: GHSA-5j4c-8p2g-v4jx
- Warn: Project is vulnerable to: GHSA-g3ch-rx76-35fx
- Warn: Project is vulnerable to: GHSA-wr3j-pwj9-hqq6
- Warn: Project is vulnerable to: GHSA-3h5v-q93c-6h6q
Score
1.7
/10
Last Scanned on 2025-02-03
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