panzoom-core

v1.8.1

Library for pan and zoom with possibility to moving, resizing and selecting elements inside For more information about how to use this package see README

Latest version published 28 days ago

License: MIT

NPM

GitHub

Package Health Score

67 / 100

security
No known security issues
popularity
Limited
maintenance
Healthy
community
Limited

Explore Similar Packages

Security

No known security issues

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security and license risk for significant versions

All Versions

Version				Vulnerabilities	License Risk
1.8.1	\|	10/2024		0 C 0 H 0 M 0 L	0 H 0 M 0 L
1.7.0	\|	03/2024		0 C 0 H 0 M 0 L	0 H 0 M 0 L
1.6.0	\|	03/2024		0 C 0 H 0 M 0 L	0 H 0 M 0 L
1.5.0	\|	01/2024		0 C 0 H 0 M 0 L	0 H 0 M 0 L
1.2.5	\|	07/2023	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

MIT

Security Policy

Is your project affected by vulnerabilities?

Scan your projects for vulnerabilities. Fix quickly with automated fixes. Get started with Snyk for free.

Get started free

Popularity

Limited

Weekly Downloads (333)

GitHub Stars: 6
Forks: 2
Contributors: 3

Direct Usage Popularity

The npm package panzoom-core receives a total of 333 downloads a week. As such, we scored panzoom-core popularity level to be Limited.

Based on project statistics from the GitHub repository for the npm package panzoom-core, we found that it has been starred 6 times.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Community

Limited

Readme.md: Yes
Contributing.md: No
Code of Conduct: No
Contributors: 3
Funding: No

This project has seen only 10 or less contributors.

We found a way for you to contribute to the project! Looks like panzoom-core is missing a Code of Conduct.

Embed Package Health Score Badge

Maintenance

Healthy

Commit Frequency

Open Issues: 1
Open PR: 1
Last Release: 28 days ago
Last Commit: 28 days ago

Further analysis of the maintenance status of panzoom-core based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Healthy.

We found that panzoom-core demonstrates a positive version release cadence with at least one new version released in the past 3 months.

As a healthy sign for on-going project maintenance, we found that the GitHub repository had at least 1 pull request or issue interacted with by the community.

Keep your project healthy

Check your package.json

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Node.js Compatibility: not defined

Age: 2 years
Dependencies: 0 Direct
Versions: 35
Install Size: 91.5 kB
Dist-tags: 1
# of Files: 10
Maintainers: 1
TS Typings: No

panzoom-core has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

Readme

panzoom-core

Library for pan and zoom with possibility to moving, resizing and selecting elements inside.

"Preview"

Demo

https://codesandbox.io/s/quiet-snow-qldnic
https://codesandbox.io/s/black-sound-vn77k9 (map with pin)
https://codesandbox.io/s/young-darkness-igcf67 (example from above)
https://codesandbox.io/s/gifted-pine-dhw9m6 (selecting elements)
https://codesandbox.io/s/festive-matsumoto-ccskw0 (Tic Tac Toe)
Library react-web-builder
Library react-grid-panzoom
Library @sasza/react-panzoom
Library react-drawing

Installation

npm install panzoom-core

Options

Name		Default	Description
boundary	{ top, right, bottom left, parent } `\|` bool	false	top, right, bottom, left - numbers in px. can be used as expression like: `{ top: 'childHeight - containerHeight - 100px' }`
disabledUserSelect	bool	false	prevent css select as text etc
disabled	bool	false	disabling pan and zoom
disabledElements	bool	false	disabling moving elements
disabledMove	bool	false	disabling move
disabledZoom	bool	false	disabling zoom
height	string/number	100%	height of child container
onContainerChange	func	null	event on move/zoom
onContainerClick	func	null	event on mousedown/touchdown
onContainerPositionChange	func	null	event on position change
onContainerZoomChange	func	null	event on zoom change
onElementsChange	func	null	callback invoked when elements change position
selecting	bool	false	switches to selecting mode, see `selecting`
width	string/number	100%	width of child container
zoomInitial	number	1	initial zoom value
zoomMax	number	5	maximum zoom
zoomMin	number	0.3	minimum zoom
zoomSpeed	number	1	zoom speed on wheel event

API

import initializePanZoom from 'panzoom-core'

const node = document.querySelector('[data-id="panzoom"]')
const panZoom = initializePanZoom(node, options)

<div>
  <div data-id="panzoom"> </div>
</div>

panzoom methods:

Function	Description
setOptions(options)	Setting options for panzoom
addElement(node: HTMLDivElement, elementOptions: ElementOptions) => ElementApi	Adding new element to moving
move(x:number, y:number)	Add x and y in px to current offset. Returns current position {x, y}
getElements()	Returns map of elements
getPosition()	Returns current position {x, y}
setPosition(x:number, y:number)	Set offset position of pan
getZoom():number	Returns current zoom
setZoom(zoom:number)	Sets zoom
zoomIn(zoom:number)	Add to current zoom, could be also negative number (it will work like zoomOut)
zoomOut(zoom:number)	Sub from current zoom
childNode	Returns passed node
reset()	Reset to (0, 0, 0)
destroy()	Unmounting panzoom element

Elements

"Preview"

import initializePanZoom from 'panzoom-core'

const node = document.querySelector('[data-id="panzoom"]')
const panZoom = initializePanZoom(node, options)

const elementA = panZoom.addElement(
  document.querySelector('[data-id="element-a"]'),
  { id: 'a' },
)
const elementB = panZoom.addElement(
  document.querySelector('[data-id="element-b"]'),
  { id: 'b', x: 100, y: 100 },
)

<div>
  <div data-id="panzoom">
    <div data-id="element-a">test</div>
    <div data-id="element-b">move me</div>
  </div>
</div>

Element properties

Name		Default	Description
id *	string/id	undefined	Unique ID of element
className	string	undefined	Class name for element
disabled	bool	false	Disabling element
draggableSelector	string	undefined	Selector for dragging element
family	string	undefined	Name of element's family, all of elements are connected during moving
followers	Array\	[]	Similar to family, but for specified ids of elements
onClick	func	null	Event on element's click
onMouseUp	func	null	Event on element's mouse up
x	number	0	x position of element
y	number	0	y position of element

* - is required

Selecting

import initializePanZoom from 'panzoom-core'

// ...
const panZoom = initializePanZoom(node, { selecting: true })

// to disable:
panZoom.setOptions({ selecting: false })

"Preview"

Installing for development

pnpm i

Testing

pnpm test

Examples

pnpm dev

FAQs

What is panzoom-core?

Library for pan and zoom with possibility to moving, resizing and selecting elements inside. Visit Snyk Advisor to see a full health score report for panzoom-core, including popularity, security, maintenance & community analysis.

Is panzoom-core popular?

The npm package panzoom-core receives a total of 333 weekly downloads. As such, panzoom-core popularity was classified as limited. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is panzoom-core well maintained?

We found that panzoom-core demonstrated a healthy version release cadence and project activity. It has a community of 3 open source contributors collaborating on the project. See the full package health analysis to learn more about the package maintenance status.

Is panzoom-core safe to use?

The npm package panzoom-core was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.

Last updated on 21 November-2024, at 11:08 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP

Package Health Score

Explore Similar Packages

Security and license risk for significant versions

Is your project affected by vulnerabilities?

Weekly Downloads (333)

Direct Usage Popularity

Embed Package Health Score Badge

Commit Frequency

Keep your project healthy

Check your package.json

Snyk Vulnerability Scanner

Readme

panzoom-core

Demo

Installation

Options

API

Elements

Element properties

Selecting

Installing for development

Testing

Examples

panzoom-core development dependencies

FAQs

What is panzoom-core?

Is panzoom-core popular?

Is panzoom-core well maintained?

Is panzoom-core safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Source Code

Open Source

Container

Config

Fix identified vulnerabilities

Monitor for new issues