Vue Bucket Loader
This Project provides a SSR compatible vue component which can handle file upload / deleting directly to / from a AWS S3 Bucket.
- Yarn or npm
- Vue 2.X.X
$ yarn add @joblocal/vue-bucket-loader
$ npm install @joblocal/vue-bucket-loader
After installing the package you can use it as follows.
|signingUrl||true||String / Function||Provide an endpoint to a backend service which can generate a presignedUrl.|
|beforeUpload||false||Function||Provide a function to add additional checks before your files get uploaded, e.g. MIME-Type checking. Returned File objects are used for upload.|
|allowedFileExtensions||false||Array||Provides possibility to pass specific file extensions.|
|allowedMimeTypes||false||Array||Provides possibility to pass specific MIME type.|
This component provides event-handling for the following cases. To subscribe:
|"add-files-before"||This event will be emitted after a file was added to the input field.||Array|
|"delete-file-before"||This event will be emitted before a file will be removed.||Object|
|"delete-file-succes"||This event will be emitted after a file was successfully uploaded.||Object|
|"delete-file-error"||This event will be emitted after a file was not uploaded.||Object|
File loading state
|"loading"||This file being uploaded.|
|"success"||The file has been successfully added to the bucketloader.|
|"error"||The file was not added due to a server error|
Run this command.
$ yarn install
To make sure that the installation went fine. Run this command.
$ yarn test
To start the development server use
$ yarn start
- Yarn - Dependency Management
- Webpack - Application Bundler
- Jest - Test Runner
Please read through our contributing guidelines. Included are directions for opening issues, coding standards, and feature requests.
- Joblocal GmbH - Initial work - Joblocal
See also the list of contributors who participated in this project.