A lightweight TypeScript library for image zooming, as seen on Medium.
A running demonstration can be found here.
zoom.ts easily plugs into your application and starts listening to zoom events
as soon as the DOM is ready. The library accounts for just 4kB of bandwidth once
gzipped and requires no third-party libraries.
Holding either the ⌘ or Ctrl key will open the image in a new tab when clicked. Zoomed images can be dismissed either by clicking the image, scrolling away, or pressing Esc.
Install the package via npm:
npm install --save zoom.ts
Then you can either link the JavaScript distribution file to have
zoom.ts listen on your webpage, or you can configure and include the library
itself your existing application.
To include and configure the library yourself, you will need to first @import
the stylesheet. Remember to define any overrides before
importing the stylesheet, for example:
$zoom-overlay-background-color: blue; // change overlay background to blue
$zoom-transition-duration: 1000; // slow down the transitions
@import '~zoom.ts/style';
Next you will need to import the library itself. In the example below, when
the document is ready the library will start by adding an event listener
that responds to click events on images marked as zoomable.
import { ready } from 'zoom.ts/lib/Document';
import { startListening } from 'zoom.ts/lib/Zoom';
ready(document, () => {
startListening();
console.log('zoom.ts started');
});
zoom__element to your <img>.<img> in a block-level element with a class of zoom (e.g.
<figure class="zoom">)data-width and data-height
attributes to the wrapper element.data-src attribute
to the wrapper element (e.g. <figure class="zoom" data-src="img/big-image.jpg">).<!DOCTYPE html>
<html>
<body>
<figure class="zoom" data-width="3500" data-height="2333" data-src="img/forest-full.jpg">
<img class="zoom__element" src="img/forest.jpg">
</figure>
<script type="text/javascript" src="dist/zoom.js"></script>
</body>
</html>
The following scripts are configured to run via npm:
npm start
http://localhost:8080npm run build
./dist directory.npm run dist
./dist directory.npm run clean
./dist directory.Bug reports and pull requests are welcome on GitHub.
This project is available under the terms of the ISC license. See the
LICENSE file for the copyright information and licensing terms.
FAQs
A lightweight TypeScript library for image zooming, as seen on Medium.
The npm package zoom.ts receives a total of 0 weekly downloads. As such, zoom.ts popularity was classified as not popular.
We found that zoom.ts demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
A malicious npm package disguised as a WhatsApp client is exploiting authentication flows with a remote kill switch to exfiltrate data and destroy files.
Security News
PyPI now supports digital attestations, enhancing security and trust by allowing package maintainers to verify the authenticity of Python packages.
Security News
GitHub removed 27 malicious pull requests attempting to inject harmful code across multiple open source repositories, in another round of low-effort attacks.