0.2.2 • Published 11 months ago

rms-vueuppy-cloudinary v0.2.2

Weekly downloads
-
License
-
Repository
github
Last release
11 months ago

rms-vueuppy-cloudinary

rms-vueuppy-cloudinary is the vue js library which utilizes uppy library to upload file to the cloudinary. This library provides the dashboard uploader vue component with different options. This library depends on vue2 and uppy(^3.9.0).

Installation

npm install rms-vueuppy-cloudinary

How to implement example:

import UppyCloudinaryUpload from 'rms-vueuppy-cloudinary';

<UppyCloudinaryUpload btnTriggerClass="btnUpload" preset="" cloudName="" :allowedMetaFields="allowedMetaFieldsArr" @uploaded="uploaded">
     // if you want to pass some icons inside button slot is created
      <!-- <template v-slot:btn-icon>
        <b-icon icon="cloud-upload-alt"
        size="is-medium"></b-icon>
      </template> -->
</UppyCloudinaryUpload>

Props

PropsTypeRequiredDescription
btnTriggerClassStringYesButton class with which uppy dashboard will triggered
presetStringYesYour preset
cloudNameStringYesYour cloudinary cloud name
allowedMetaFieldsArrayOptionaldefault:"file","name","upload_preset"
allowMultipleUploadBatchesBooleanOptionaldefault: false
allowedFileTypesArrayOptionaldefault: 'image/','video/',"image/png'
minNumberOfFilesNumberOptionaldefault: 1
maxNumberOfFilesNumberOptionaldefault:10
maxFileSizeNumberOptionaldefault:40000000
closeModalOnClickOutsideBooleanOptionaldefault: true
closeAfterFinishBooleanOptionaldefault: true
disableModalBooleanOptionaldefault:false, Wheather to show dashboard uploader as popup or inline, for inline closeAfterFinish should be false
tagsArrayOptionaldefault: []
autoProceedBooleanOptionaldefault: false
showProgressDetailsBooleanOptionaldefault:true
buttonTextStringOptionaldefault: "Upload"
buttonClassStringOptionaldefault: "button is-secondary"
debugBooleanOptionaldefault: true

Vue Events

uploaded This events will emit information about uploads.

How to listen to events example?

<!-- eslint-disable vue/no-unused-components -->
<template>
  <div>
    <UppyCloudinaryUpload btnTriggerClass="btnUpload" preset="" cloudName=""  @uploaded="uploaded">
    // if you want to pass some icons inside button slot is created
      <!-- <template v-slot:btn-icon>
        <b-icon icon="cloud-upload-alt"
        size="is-medium"></b-icon>
      </template> -->
    </UppyCloudinaryUpload>
  </div>
</template>

<script>
import UppyCloudinaryUpload from './components/UppyCloudinaryUpload.vue';


  export default {
    name: "App",
    components: { UppyCloudinaryUpload },
    data(){
      return {
        cloudName:'<your cloudinary cloudname',
        preset: '<your preset>'
      }
    },
    methods:{
      uploaded(results){
        console.log("UPLOADED status ",{results});
      }
    }
}
</script>
<style lang="scss" scoped>
</style>