0.0.17 • Published 6 years ago

ecross-avatar v0.0.17

Weekly downloads
2
License
MIT
Repository
github
Last release
6 years ago

image

Installing

$  npm i ecross-avatar --save-dev

Usage

import AvatarCropper from 'ecross-avatar'
<button type="button" class="btn btn-primary" id="set-avatar">Update avatar</button>

<avatar-cropper
    trigger="#set-avatar"
    upload-url="/files/upload"
></avatar-cropper>

Properties

Property NameTypeDescription
triggerString|ElementThe element to trigger avatar pick
upload-urlStringUrl of upload croppped image
upload-form-nameObjectForm name of upload request, default: 'file'
upload-form-dataObjectAdditional form data, default: '{}'
upload-handlerFunctionHandler to replace default upload handler
upload-headersObjectHeaders of upload request, default: {}
mimesStringAllowed image formats, default: image/png, image/gif, image/jpeg, image/bmp, image/x-icon
labelsObjectLabel for buttons, default: { submit: "提交", cancel: "取消"}

Events

  • uploading before submit upload request, params:

  • uploaded after request has finished, params:

    • response object, json parsed from xhr.responseText
    • form object, FormData instance.
    • xhr object, XMLHttpRequest instance.

You can listen these events like this:

<avatar-cropper
    trigger="#set-avatar"
    upload-url="/files/upload"
    @uploading="handleUploading"
    @uploaded="handleUploaded"
></avatar-cropper>
    ...
    methods: {
        ...
        handleUploading(form. xhr) {
            form.append('foo', 'bar')
        },
        handleUploaded(response, form, xhr) {
            // update user avatar attribute
        }
        ...
    }
    ...

License

MIT