@reactour/popover

v1.2.0

<img alt="Reactour" title="Reactour" src="https://raw.githubusercontent.com/elrumordelaluz/reactour/main/packages/popover/logo.svg" width="400"> A popover positioned based on certain values For more information about how to use this package see README

Latest version published 5 months ago

License: MIT

NPM

GitHub

Package Health Score

85 / 100

security
No known security issues
popularity
Popular
maintenance
Sustainable
community
Active

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.1.2	\|	06/2024		0 C 0 H 0 M 0 L	0 H 0 M 0 L
1.2.0	\|	06/2024	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L
0.5.0	\|	07/2022		0 C 0 H 0 M 0 L	0 H 0 M 0 L
0.4.1	\|	04/2022		0 C 0 H 0 M 0 L	0 H 0 M 0 L
0.3.0	\|	10/2021		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

Popular

Weekly Downloads (50,370)

GitHub Stars: 3.85K
Forks: 350
Contributors: 50

Direct Usage Popularity

The npm package @reactour/popover receives a total of 50,370 downloads a week. As such, we scored @reactour/popover popularity level to be Popular.

Based on project statistics from the GitHub repository for the npm package @reactour/popover, we found that it has been starred 3,850 times.

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

Community

Active

Readme.md: Yes
Contributing.md: Yes
Code of Conduct: Yes
Contributors: 50
Funding: Yes

With more than 10 contributors for the @reactour/popover repository, this is possibly a sign for a growing and inviting community.

Embed Package Health Score Badge

Maintenance

Sustainable

Commit Frequency

Open Issues: 64
Open PR: 7
Last Release: 5 months ago
Last Commit: 1 month ago

Further analysis of the maintenance status of @reactour/popover based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Sustainable.

We found that @reactour/popover demonstrates a positive version release cadence with at least one new version released in the past 12 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: 3 years
Dependencies: 1 Direct
Versions: 18
Install Size: 22.6 kB
Dist-tags: 1
# of Files: 8
Maintainers: 1
TS Typings: Yes

@reactour/popover 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

A popover positioned based on certain values

Documentation

https://docs.react.tours/popover

Install

npm i -S @reactour/popover
# or
yarn add @reacmask/popover

Usage

import { Popover } from '@reactour/popover'

function App() {
  const sizes = {
    bottom: 0,
    left: 0,
  }

  return (
    &lt;&gt;
      {/* ... */}
      
    
  )
}

`Popover`

`sizes: RectResult`

Type details

type RectResult = {
  width?: number
  height?: number
  top?: number
  left?: number
  bottom?: number
  right?: number
}

Object containing size and position informations of where to position the Popover

`position?: Position`

Type details

type Position =
  | 'top'
  | 'right'
  | 'bottom'
  | 'left'
  | 'center'
  | [number, number]
  | ((postionsProps: PositionProps, prevRect: RectResult) =&gt; Position)

type PositionProps = {
  bottom: number
  height: number
  left: number
  right: number
  top: number
  width: number
  windowWidth: number
  windowHeight: number
}

The position for the Popover, fixed in case of [number, number], calculated prefered position in case of string

`padding?: number | number[]`

Extra space to add in Popover position calculations. Useful when calculating space from Element bounding rect and want to add more space.

Single number sets same space for all sides, otherwise an Array sets [x, y] or [top, x, bottom] or [top, right, bottom, left].

`styles?: StylesObj`

Prop to customize styles for the different parts of the Mask using a function that allows to extend the base styles an take advantage of some state props.

`className?: string`

Class to apply to the Popover

Style keys and props available

key	props
`popover`	`position`, `verticalAlign`, `horizontalAlign`, `helperRect`, `targetRect`

`refresher?: any`

Any value that if changed, updates rect calculations

Example

const styles = {
  popover: (base) =&gt; ({
    ...base,
    boxShadow: '0 0 3em rgba(0, 0, 0, 0.5)',
    backgroundColor: '#dedede',
  }),
}

@reactour/popover dependencies

@reactour/utils

@reactour/popover development dependencies

@reactour/tsconfig @types/react @types/react-dom config react tsup typescript

FAQs

What is @reactour/popover?

A popover positioned based on certain values . Visit Snyk Advisor to see a full health score report for @reactour/popover, including popularity, security, maintenance & community analysis.

Is @reactour/popover popular?

The npm package @reactour/popover receives a total of 50,370 weekly downloads. As such, @reactour/popover popularity was classified as a popular. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is @reactour/popover well maintained?

We found indications that @reactour/popover maintenance is sustainable demonstrating some project activity. We saw a total of 50 open source contributors collaborating on the project. See the full package health analysis to learn more about the package maintenance status.

Is @reactour/popover safe to use?

The npm package @reactour/popover 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 17 November-2024, at 16:50 (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