Package Health Score

56 / 100

security
No known security issues
popularity
Limited
maintenance
Inactive
community
Limited

Security

No known security issues

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

Security and license risk for significant versions

Version				Vulnerabilities	License Risk
5.1.1	\|	05/2024		0 C 0 H 0 M 0 L	0 H 0 M 0 L
5.0.0	\|	08/2022		0 C 0 H 0 M 0 L	0 H 0 M 0 L
4.0.0	\|	08/2018	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L
3.0.0	\|	03/2018		0 C 0 H 0 M 0 L	0 H 0 M 0 L
2.0.0	\|	08/2017		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 (566)

GitHub Stars: 163
Forks: 43
Contributors: 5

Direct Usage Popularity

The npm package ol-popup receives a total of 566 downloads a week. As such, we scored ol-popup popularity level to be Limited.

Based on project statistics from the GitHub repository for the npm package ol-popup, we found that it has been starred 163 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: 5
Funding: No

This project has seen only 10 or less contributors.

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

Embed Package Health Score Badge

Maintenance

Inactive

Commit Frequency

Open Issues: 6
Open PR: 11
Last Release: 6 months ago
Last Commit: 6 months ago

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

We found that ol-popup demonstrates a positive version release cadence with at least one new version released in the past 12 months.

In the past month we didn't find any pull request activity or change in issues status has been detected for the GitHub repository.

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: 7 years
Dependencies: 0 Direct
Versions: 7
Install Size: 25.7 kB
Dist-tags: 1
# of Files: 21
Maintainers: 1
TS Typings: No

ol-popup 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

OpenLayers Popup

Basic popup overlay for an 'ol' map. By default the map is centred so that the popup is entirely visible.

Compatible with OpenLayers version 5, 6, 7, 8 and 9 (see note in Install - Parcel, Webpack etc. regarding installing the appropriate version of ol-popup for OpenLayers).

Examples

The examples demonstrate usage and can be viewed online thanks to raw.githack.com:

Basic usage
- Create a popup instance, show it on single-click specifying the content
DOM Events
- Handle DOM events triggered by interacting with elements within the popup content
Scroll
- Controlling popup dimensions and scrolling overflowing content
Multiple popups
- Add a new popup each time the maps is clicked
ESM build
- To use the popup with the ol package and a module bundler such as Vite, Parcel, Webpack etc. see ol-popup sandbox.

The source for all examples can be found in examples.

Install

Browser

JS

Load ol-popup.js after OpenLayers. The popup overlay is available as Popup or ol.Overlay.Popup.

CSS

ESM

NPM package: ol-popup.

JS

Install the package via npm

npm install ol-popup --save

⚠️ If you're using the ol package prior to v5 you'll need to install ol-popup@v3.0.0.

CSS

The CSS file ol-popup.css can be found in ./node_modules/ol-popup/src

API

Popup
- Parameters
- show
  - Parameters
- hide
- isOpened

Popup

Extends Overlay

OpenLayers Popup Overlay. See the examples for usage. Styling can be done via CSS.

Parameters

opt_options ol_Overlay_Options? OpenLayers Overlay options, defaults to {autoPan: {animation: {duration: 250}}}

show

Show the popup.

Parameters

coord ol_coordinate_Coordinate Where to anchor the popup.
html (String | HTMLElement) String or element of HTML to display within the popup.

Returns Popup The Popup instance

hide

Hide the popup.

Returns Popup The Popup instance

isOpened

Indicates if the popup is in open state

Returns Boolean Whether the popup instance is open

Contributing

Contributions are welcome, please create an issue first to discuss any potential contributions.

Updating README.md

The API section of the README.md is generated from the JSDoc comments in the source code. To update the API docs edit the comments in the code then run:

npm run doc

In order to use the doc npm script you will need to install the devDependencies:

npm install --only=dev

License

MIT (c) Matt Walker.

Credit

Based on an example by Tim Schaub posted on the OL3-Dev list.

Also see

If you find the popup useful you might also like the ol-layerswitcher.

ol-popup development dependencies

rollup rollup-plugin-commonjs rollup-plugin-node-resolve documentation typescript

FAQs

What is ol-popup?

Popup overlay for OpenLayers. Visit Snyk Advisor to see a full health score report for ol-popup, including popularity, security, maintenance & community analysis.

Is ol-popup popular?

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

Is ol-popup well maintained?

We found indications that ol-popup is an Inactive project. See the full package health analysis to learn more about the package maintenance status.

Is ol-popup safe to use?

The npm package ol-popup 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 12 November-2024, at 11:45 (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

Security and license risk for significant versions

Is your project affected by vulnerabilities?

Weekly Downloads (566)

Direct Usage Popularity

Embed Package Health Score Badge

Commit Frequency

Keep your project healthy

Check your package.json

Snyk Vulnerability Scanner

Readme

OpenLayers Popup

Examples

Install

Browser

JS

CSS

ESM

JS

CSS

API

Table of Contents

Popup

Parameters

show

Parameters

hide

isOpened

Contributing

Updating README.md

License

Credit

Also see

ol-popup development dependencies

FAQs

What is ol-popup?

Is ol-popup popular?

Is ol-popup well maintained?

Is ol-popup 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