npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

react-target-popup-modal

v1.0.0

Published

react component for highlighting any element of DOM with optional description which rendering in renderProps

Downloads

3

Readme

react-target-popup-modal

react component for highlighting any element of DOM with optional description which rendering in renderProps.

NOTE

  • the component need to render on top level of app.

NPM JavaScript Style Guide

Install

npm install --save react-target-popup-modal

Usage

import React from 'react';

import {
  TargetPopup,
  TargetPopupRenderWrapper,
} from 'react-target-popup-modal';
import 'react-target-popup-modal/dist/index.css';

const App = () => {
  return (
    <div className='layout'>
      <div className='.some-element' />
      <TargetPopup
        querySelector='.some-element'
        color='#32e23d73'
        padding={20}
        renderElem={(elem) => (
          <TargetPopupRenderWrapper
            node={elem}
            position='TOP'
            distance={distancePX}
            distanceY={distancePercent}
          >
            <p className='paragraph'>Hello! I've rendered on TOP!</p>
          </TargetPopupRenderWrapper>
        )}
      />
    </div>
  );
};

TargetPopup props

| name | type | example values | default | description | | ------------------ | ------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------: | ------------------ | --------------------------------------------------------------------------------------------------------------------------- | | isCanInteractive | boolean | true | true | if false, component just highlighted, but without any interactive events | | querySelector | string | '.className' or '#id' | empty string | pure Javascript selector, that need to find DOMNode in useEffect and call getBoundingClientRect() | | padding | number | 10 or -10 | 0 | Number of pixels, that wil increase or decrease highlighting window | | queryTop | number | -15 or 25 | 0 | Number of pixels, that wil increase or decrease top line of highlighting window | | queryBottom | number | -10 or 20 | 0 | Number of pixels, that wil increase or decrease bottom line of highlighting window | | queryLeft | number | -10 or 20 | 0 | Number of pixels, that wil increase or decrease left line of highlighting window | | queryRight | number | -10 or 20 | 0 | Number of pixels, that wil increase or decrease right line of highlighting window | | queryTopPercent | number | -2 or 1 | 0 | Number of css vh, that wil increase or decrease top line of highlighting window | | queryBottomPercent | number | -5 or 15 | 0 | Number of css vh, that wil increase or decrease bottom line of highlighting window | | queryLeftPercent | number | -12 or 23 | 0 | Number of css vw, that wil increase or decrease left line of highlighting window | | queryRightPercent | number | -10 or 20 | 0 | Number of css vh, that wil increase or decrease right line of highlighting window | | color | string | '#dc1bfeb3' or 'rgba(0, 0, 0, 0.4)' | rgba(0, 0, 0, 0.4) | Background color of popup | | renderElem | JSX.Element or null | (elem) => (Hello! I've rendered on TOP!) | null | It's the renderProp and required function that returns any components, but there parent must be |

TargetPopupRenderWrapper props

| name | type | example values | default | description | | --------- | --------------- | :-------------------------------: | -------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | node | typeof nodeObj | node | node | Required prop, that given from in first argument in renderProp function | | position | string | 'TOP','LEFT','BOTTOM','RIGHT' | Position relatively highlighted window | | distance | number | 10 or -10 | 0 | distance on main axis in pixels (see example for more details) | | distanceY | number | -15 or 25 | 0 | distance on Y axis relatively main axis in css vw or vh if main axis horizontal (see example for more details) | | children | React.ReactNode | I'm rendered component | undefined | Common React children |

License

MIT © Immortal230719