npm.io
1.6.0 • Published 2 months ago

@dreamworld/dw-image

Licence
ISC
Version
1.6.0
Deps
2
Size
15 kB
Vulns
0
Weekly
0

dw-image

A WebComponent to show zoomable image on documentation & blog sites.

Behaviours

  • Auto compute height or width based on auto property, give another value as a css of element.
  • When user click on image, then image open in dialog using zoomSrc property. if zoomSrc is not available then use src property to show image in dialog.
  • If you want to disable the above zoomable behaviour then disableZoom property passed as a true.

Examples

  • Default example

      <dw-image src='https://picsum.photos/id/237/200/300' zoom-src='https://picsum.photos/id/237/1000/1000'></dw-image>
      <!-- In this above case you give a height css property as an element. -->
      dw-image {
        width: 200px;
      }
  • Auto width

      <dw-image auto='width' src='https://picsum.photos/id/237/200/300' zoom-src='https://picsum.photos/id/237/1000/1000'></dw-image>
  • Auto none

      <dw-image auto='none' src='https://picsum.photos/id/237/200/300' zoom-src='https://picsum.photos/id/237/1000/1000'></dw-image>
      <!-- In this above case you give a height css property as an element. -->
      dw-image {
        height: 200px;
      }
  • Disabled zoomable behaviour and open link click on image.

      <a href="https://www.google.com/">
        <dw-image src='https://picsum.photos/id/237/200/300' disable-zoom></dw-image>
      </a>

Properties

Property Attribute Type Description
auto auto string Auto compute css property name.
Default value: height
Possible value: height, width, none.
disableZoom disable-zoom boolean Disabled zoom behaviour when this value is true.
src src string Image path/source.
title title string Image title.
zoomSrc zoom-src string Zoomable image path.

Keywords