vertumnus
/
primevue-mirror
mirror of https://github.com/primefaces/primevue.git
1
0
Fork 0
Code Packages Releases Activity

Api docs for image

pull/1533/head
Cagatay Civici 2021-08-31 10:47:54 +03:00
parent 928e98034e
commit ed8dbcb7da
2 changed files with 44 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
api-generator/components/image.js Normal file
View File

@ -0,0 +1,36 @@
const ImageProps = [
{
name: "preview",
type: "boolean",
default: "false",
description: "Controls the preview functionality."
}
];
const ImageEvents = [
{
name: "show",
description: "Triggered when the preview overlay is shown."
},
{
name: "hide",
description: "Triggered when the preview overlay is hidden."
}
];
const ImageSlots = [
{
name: "indicator",
description: "Custom content for the preview indicator"
}-
];
module.exports = {
image: {
name: "Image",
description: "Displays an image with preview and tranformation options.",
props: ImageProps,
events: ImageEvents,
slots: ImageSlots
}
};

16
src/views/image/ImageDoc.vue
View File

@ -107,35 +107,35 @@ import Image from 'primevue/image';
<tbody>
<tr>
<td>p-image</td>
<td>Container element</td>
<td>Container element.</td>
</tr>
<tr>
<td>p-image-preview-container</td>
<td>Container element with preview enabled</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>
<td>Mask layer over the image when hovered.</td>
</tr>
<tr>
<td>p-image-preview-icon</td>
<td>Icon of the preview indicator</td>
<td>Icon of the preview indicator.</td>
</tr>
<tr>
<td>p-image-mask</td>
<td>Preview overlay container</td>
<td>Preview overlay container.</td>
</tr>
<tr>
<td>p-image-toolbar</td>
<td>Transformation options container</td>
<td>Transformation options container.</td>
</tr>
<tr>
<td>p-image-action</td>
<td>An element inside the toolbar</td>
<td>An element inside the toolbar.</td>
</tr>
<tr>
<td>p-image-preview</td>
<td>Image element inside the preview overlay</td>
<td>Image element inside the preview overlay.</td>
</tr>
</tbody>
</table>