2022-09-09 20:41:18 +00:00
|
|
|
<template>
|
2022-09-12 13:27:56 +00:00
|
|
|
<ClientOnly>
|
2022-09-14 14:26:41 +00:00
|
|
|
<AppDoc name="ImageDemo" :sources="sources" github="image/ImageDemo.vue">
|
|
|
|
|
<h5>Import via Module</h5>
|
|
|
|
|
<pre v-code.script><code>
|
2022-09-09 20:41:18 +00:00
|
|
|
import Image from 'primevue/image';
|
|
|
|
|
|
|
|
|
|
</code></pre>
|
|
|
|
|
|
2022-09-14 14:26:41 +00:00
|
|
|
<h5>Import via CDN</h5>
|
|
|
|
|
<pre v-code><code>
|
2022-09-09 20:41:18 +00:00
|
|
|
<script src="https://unpkg.com/primevue@^3/core/core.min.js"></script>
|
|
|
|
|
<script src="https://unpkg.com/primevue@^3/image/image.min.js"></script>
|
|
|
|
|
|
|
|
|
|
</code></pre>
|
|
|
|
|
|
2022-09-14 14:26:41 +00:00
|
|
|
<h5>Getting Started</h5>
|
|
|
|
|
<p>Image is used as the native <i>img</i> element and supports all properties that the native element has.</p>
|
|
|
|
|
<pre v-code><code>
|
2022-09-09 20:41:18 +00:00
|
|
|
<Image src="image1.png" alt="Image Text" />
|
|
|
|
|
|
|
|
|
|
</code></pre>
|
|
|
|
|
|
2022-09-14 14:26:41 +00:00
|
|
|
<h5>Preview</h5>
|
|
|
|
|
<p>Preview mode displays a modal layer when the image is clicked that provides transformation options such as rotating and zooming.</p>
|
2022-09-09 20:41:18 +00:00
|
|
|
|
2022-09-14 14:26:41 +00:00
|
|
|
<h5>Indicator Templating</h5>
|
|
|
|
|
<p>An eye icon is displayed by default when the image is hovered in preview mode. Use the <i>indicator</i> template for custom content.</p>
|
|
|
|
|
<pre v-code><code>
|
2022-09-09 20:41:18 +00:00
|
|
|
<Image src="image1.png" alt="Image Text">
|
|
|
|
|
<template #indicator>
|
|
|
|
|
Preview Content
|
|
|
|
|
</template>
|
|
|
|
|
</Image>
|
|
|
|
|
|
|
|
|
|
</code></pre>
|
|
|
|
|
|
2022-09-14 14:26:41 +00:00
|
|
|
<h5>Properties</h5>
|
|
|
|
|
<p>Image passes any valid attribute to the underlying img element, additional attribute is the following.</p>
|
|
|
|
|
<div class="doc-tablewrapper">
|
|
|
|
|
<table class="doc-table">
|
|
|
|
|
<thead>
|
|
|
|
|
<tr>
|
|
|
|
|
<th>Name</th>
|
|
|
|
|
<th>Type</th>
|
|
|
|
|
<th>Default</th>
|
|
|
|
|
<th>Description</th>
|
|
|
|
|
</tr>
|
|
|
|
|
</thead>
|
|
|
|
|
<tbody>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>preview</td>
|
|
|
|
|
<td>boolean</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>Controls the preview functionality.</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>imageStyle</td>
|
|
|
|
|
<td>any</td>
|
|
|
|
|
<td>null</td>
|
|
|
|
|
<td>Inline style of the image element.</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>imageClass</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>null</td>
|
|
|
|
|
<td>Style class of the image element.</td>
|
|
|
|
|
</tr>
|
|
|
|
|
</tbody>
|
|
|
|
|
</table>
|
|
|
|
|
</div>
|
2022-09-09 20:41:18 +00:00
|
|
|
|
2022-09-14 14:26:41 +00:00
|
|
|
<h5>Events</h5>
|
|
|
|
|
<p>Any valid event like click and mouseover are passed to the underlying input element. Events below are the additional ones related to the preview functionality.</p>
|
|
|
|
|
<div class="doc-tablewrapper">
|
|
|
|
|
<table class="doc-table">
|
|
|
|
|
<thead>
|
|
|
|
|
<tr>
|
|
|
|
|
<th>Name</th>
|
|
|
|
|
<th>Parameters</th>
|
|
|
|
|
<th>Description</th>
|
|
|
|
|
</tr>
|
|
|
|
|
</thead>
|
|
|
|
|
<tbody>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>show</td>
|
|
|
|
|
<td>-</td>
|
|
|
|
|
<td>Triggered when the preview overlay is shown.</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>hide</td>
|
|
|
|
|
<td>-</td>
|
|
|
|
|
<td>Triggered when the preview overlay is hidden.</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>error</td>
|
|
|
|
|
<td>-</td>
|
|
|
|
|
<td>Triggered when an error occurs while loading an image file.</td>
|
|
|
|
|
</tr>
|
|
|
|
|
</tbody>
|
|
|
|
|
</table>
|
|
|
|
|
</div>
|
2022-09-09 20:41:18 +00:00
|
|
|
|
2022-09-14 14:26:41 +00:00
|
|
|
<h5>Slots</h5>
|
|
|
|
|
<div class="doc-tablewrapper">
|
|
|
|
|
<table class="doc-table">
|
|
|
|
|
<thead>
|
|
|
|
|
<tr>
|
|
|
|
|
<th>Name</th>
|
|
|
|
|
<th>Parameters</th>
|
|
|
|
|
</tr>
|
|
|
|
|
</thead>
|
|
|
|
|
<tbody>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>indicator</td>
|
|
|
|
|
<td>-</td>
|
|
|
|
|
</tr>
|
|
|
|
|
</tbody>
|
|
|
|
|
</table>
|
|
|
|
|
</div>
|
2022-09-09 20:41:18 +00:00
|
|
|
|
2022-09-14 14:26:41 +00:00
|
|
|
<h5>Styling</h5>
|
|
|
|
|
<p>Following is the list of structural style classes, for theming classes visit <nuxt-link to="/theming">theming</nuxt-link> page.</p>
|
|
|
|
|
<div class="doc-tablewrapper">
|
|
|
|
|
<table class="doc-table">
|
|
|
|
|
<thead>
|
|
|
|
|
<tr>
|
|
|
|
|
<th>Name</th>
|
|
|
|
|
<th>Element</th>
|
|
|
|
|
</tr>
|
|
|
|
|
</thead>
|
|
|
|
|
<tbody>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>p-image</td>
|
|
|
|
|
<td>Container element.</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>p-image-preview-container</td>
|
|
|
|
|
<td>Container element with preview enabled.</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>p-image-preview-indicator</td>
|
|
|
|
|
<td>Mask layer over the image when hovered.</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>p-image-preview-icon</td>
|
|
|
|
|
<td>Icon of the preview indicator.</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>p-image-mask</td>
|
|
|
|
|
<td>Preview overlay container.</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>p-image-toolbar</td>
|
|
|
|
|
<td>Transformation options container.</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>p-image-action</td>
|
|
|
|
|
<td>An element inside the toolbar.</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>p-image-preview</td>
|
|
|
|
|
<td>Image element inside the preview overlay.</td>
|
|
|
|
|
</tr>
|
|
|
|
|
</tbody>
|
|
|
|
|
</table>
|
|
|
|
|
</div>
|
2022-09-09 20:41:18 +00:00
|
|
|
|
2022-09-14 14:26:41 +00:00
|
|
|
<h5>Dependencies</h5>
|
|
|
|
|
<p>None.</p>
|
|
|
|
|
</AppDoc>
|
|
|
|
|
</ClientOnly>
|
2022-09-09 20:41:18 +00:00
|
|
|
</template>
|
|
|
|
|
|
|
|
|
|
<script>
|
|
|
|
|
export default {
|
|
|
|
|
data() {
|
|
|
|
|
return {
|
|
|
|
|
sources: {
|
|
|
|
|
'options-api': {
|
|
|
|
|
tabName: 'Options API Source',
|
|
|
|
|
content: `
|
|
|
|
|
<template>
|
|
|
|
|
<div>
|
|
|
|
|
<h5>Basic</h5>
|
|
|
|
|
<Image src="https://www.primefaces.org/wp-content/uploads/2020/05/placeholder.png" alt="Image" width="250" />
|
|
|
|
|
|
|
|
|
|
<h5>Preview</h5>
|
|
|
|
|
<Image src="https://www.primefaces.org/wp-content/uploads/2020/05/placeholder.png" alt="Image" width="250" preview />
|
|
|
|
|
</div>
|
|
|
|
|
</template>
|
|
|
|
|
|
|
|
|
|
<script>
|
|
|
|
|
export default {
|
|
|
|
|
}
|
|
|
|
|
<\\/script>
|
|
|
|
|
`
|
|
|
|
|
},
|
|
|
|
|
'composition-api': {
|
|
|
|
|
tabName: 'Composition API Source',
|
|
|
|
|
content: `
|
|
|
|
|
<template>
|
|
|
|
|
<div>
|
|
|
|
|
<h5>Basic</h5>
|
|
|
|
|
<Image src="https://www.primefaces.org/wp-content/uploads/2020/05/placeholder.png" alt="Image" width="250" />
|
|
|
|
|
|
|
|
|
|
<h5>Preview</h5>
|
|
|
|
|
<Image src="https://www.primefaces.org/wp-content/uploads/2020/05/placeholder.png" alt="Image" width="250" preview />
|
|
|
|
|
</div>
|
|
|
|
|
</template>
|
|
|
|
|
|
|
|
|
|
<script>
|
|
|
|
|
export default {
|
|
|
|
|
}
|
|
|
|
|
<\\/script>`
|
|
|
|
|
},
|
|
|
|
|
'browser-source': {
|
|
|
|
|
tabName: 'Browser Source',
|
|
|
|
|
imports: `<script src="https://unpkg.com/primevue@^3/image/image.min.js"><\\/script>`,
|
|
|
|
|
content: `<div id="app">
|
|
|
|
|
<h5>Basic</h5>
|
|
|
|
|
<p-image src="https://www.primefaces.org/wp-content/uploads/2020/05/placeholder.png" alt="Image" width="250"></p-image>
|
|
|
|
|
|
|
|
|
|
<h5>Preview</h5>
|
|
|
|
|
<p-image src="https://www.primefaces.org/wp-content/uploads/2020/05/placeholder.png" alt="Image" width="250" preview></p-image>
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<script type="module">
|
|
|
|
|
const { createApp } = Vue;
|
|
|
|
|
|
|
|
|
|
const App = {
|
|
|
|
|
components: {
|
|
|
|
|
"p-image": primevue.image
|
|
|
|
|
}
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
createApp(App)
|
|
|
|
|
.use(primevue.config.default)
|
|
|
|
|
.mount("#app");
|
|
|
|
|
<\\/script>`
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
};
|
|
|
|
|
}
|
|
|
|
|
};
|
|
|
|
|
</script>
|
