@fuzzco/super-image
v1.1.3
Published
All-in-one image component for Vue.
Downloads
3
Readme
All-in-one image component for Vue. Demo
npm i @fuzzco/super-image
Register component in Vue, then:
<template>
<main>
<!-- place a square image in a 16:9 aspect ratio -->
<super-image src="//placehold.it/300x300" aspect="56.25" />
<!-- use raw HTML for contents -->
<super-image :html="imgHtml" />
</main>
</template>
<script>
export default {
data() {
return {
imgHtml: '<img src="//placehold.it/300x300">'
}
}
}
</script>
Options
| Prop | Type | Default | Notes |
| ----------------------- | ----------------- | ----------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| alt
| String | none | |
| aspect
| [String, Number] | none | Manually-defined aspect ratio of image. Overrides aspect ratio calculated by width
and height
props. |
| color
| String | transparent | |
| fill-space
| Boolean | false | |
| fit
| String | cover
| cover
or contain
. |
| height
| [String, Number] | none | Manually-defined height of image in px. |
| html
| String | none | Raw HTML to drop into super-image wrapper. |
| loop
| Boolean | true | |
| no-image-after-canvas
| Boolean | false | Only applies if use-canvas
is true. Prevents placement of image after canvas. Generally best to leave false
, since placing the image after the canvas should increase accessibility and make for better SEO. |
| poster
| [String, Boolean] | none | |
| respect-max
| Boolean | false | |
| src
| String | none | Source URL. |
| use-canvas
| Boolean | false | Whether or not to render the image with a canvas instead of an img
element. Allows for easier image manipulation. Currently does not support video or fit
properties. Places an opacity: 0; pointer-events: none;
img
element above the canvas unless no-image-after-canvas
set to true
. |
| video-src
| [String, Boolean] | none | |
| width
} | [String, Number] | none | Manually-defined width of image in px. |
Events
| Name | Parameters | Notes |
| ------- | ---------------------- | ------------------------------------------------- |
| ended
| (event: video event)
| Event emitted by video (if provided) upon ending. |